diff --git a/.annotation_safe_list.yml b/.annotation_safe_list.yml index e91fe39cd613..4c93795458ff 100644 --- a/.annotation_safe_list.yml +++ b/.annotation_safe_list.yml @@ -105,58 +105,10 @@ enterprise.HistoricalEnterpriseCustomerCatalog: enterprise.HistoricalEnterpriseCustomerEntitlement: ".. no_pii:": "No PII" -# Via edx-ora2, these can be removed once the models are annotated for real -assessment.Assessment: - ".. no_pii:": "No PII" -assessment.AssessmentFeedback: - ".. no_pii:": "No PII" -assessment.AssessmentFeedbackOption: - ".. no_pii:": "No PII" -assessment.AssessmentPart: - ".. no_pii:": "No PII" -assessment.Criterion: - ".. no_pii:": "No PII" -assessment.CriterionOption: - ".. no_pii:": "No PII" -assessment.PeerWorkflow: - ".. no_pii:": "No PII" -assessment.PeerWorkflowItem: - ".. no_pii:": "No PII" -assessment.Rubric: - ".. no_pii:": "No PII" -assessment.StaffWorkflow: - ".. no_pii:": "No PII" -assessment.StudentTrainingWorkflow: - ".. no_pii:": "No PII" -assessment.StudentTrainingWorkflowItem: - ".. no_pii:": "No PII" -assessment.TrainingExample: - ".. no_pii:": "No PII" -workflow.AssessmentWorkflow: - ".. no_pii:": "No PII" -workflow.AssessmentWorkflowCancellation: - ".. no_pii:": "No PII" -workflow.AssessmentWorkflowStep: - ".. no_pii:": "No PII" - # Via edx-celeryutils celery_utils.ChordData: ".. no_pii:": "No PII" -# Via completion XBlock -completion.BlockCompletion: - ".. no_pii:": "No PII" - -# Via django_notify (required / installed by wiki) -django_notify.Notification: - ".. no_pii:": "No PII" -django_notify.NotificationType: - ".. no_pii:": "No PII" -django_notify.Settings: - ".. no_pii:": "No PII" -django_notify.Subscription: - ".. no_pii:": "No PII" - # Via django-openid-auth https://github.com/edx/django-openid-auth django_openid_auth.Association: ".. no_pii:": "No PII" @@ -203,42 +155,12 @@ edx_name_affirmation.HistoricalVerifiedName: ".. pii_types:": "name" ".. pii_retirement:": "local_api" -# Via VAL -edxval.CourseVideo: - ".. no_pii:": "No PII" -edxval.EncodedVideo: - ".. no_pii:": "No PII" -edxval.Profile: - ".. no_pii:": "No PII" -edxval.ThirdPartyTranscriptCredentialsState: - ".. no_pii:": "No PII" -edxval.TranscriptPreference: - ".. no_pii:": "No PII" -edxval.Video: - ".. no_pii:": "No PII" -edxval.VideoImage: - ".. no_pii:": "No PII" -edxval.VideoTranscript: - ".. no_pii:": "No PII" - # Via PyLTI1p3 lti1p3_tool_config.LtiTool: ".. no_pii:": "No PII" lti1p3_tool_config.LtiToolKey: ".. no_pii:": "No PII" -# Via Milestones -milestones.CourseContentMilestone: - ".. no_pii:": "No PII" -milestones.CourseMilestone: - ".. no_pii:": "No PII" -milestones.Milestone: - ".. no_pii:": "No PII" -milestones.MilestoneRelationshipType: - ".. no_pii:": "No PII" -milestones.UserMilestone: - ".. no_pii:": "No PII" - # Via Django OAuth2 Provider https://github.com/edx/django-oauth2-provider oauth2.Client: ".. no_pii:": "No PII" @@ -289,12 +211,6 @@ oauth_provider.Token: ".. pii_types:": external_service, password ".. pii_retirement:": retained -# Via edx-organizations -organizations.Organization: - ".. no_pii:": "No PII" -organizations.OrganizationCourse: - ".. no_pii:": "No PII" - # Via Problem Builder XBlock problem_builder.Answer: ".. no_pii:": "No PII" @@ -321,30 +237,10 @@ social_django.UserSocialAuth: splash.SplashConfig: ".. no_pii:": "No PII" -# Via edx-submissions -submissions.Score: - ".. no_pii:": "No PII" -submissions.ScoreAnnotation: - ".. no_pii:": "No PII" -submissions.ScoreSummary: - ".. no_pii:": "No PII" -submissions.StudentItem: - ".. no_pii:": "No PII" -submissions.Submission: - ".. no_pii:": "No PII" -submissions.TeamSubmission: - ".. no_pii:": "No PII" - # Via sorl-thumbnail https://github.com/jazzband/sorl-thumbnail thumbnail.KVStore: ".. no_pii:": "No PII" -# Via django-user-tasks -user_tasks.UserTaskArtifact: - ".. no_pii:": "No PII" -user_tasks.UserTaskStatus: - ".. no_pii:": "No PII" - # Via waffle waffle.Flag: ".. no_pii:": "No PII" @@ -353,22 +249,198 @@ waffle.Sample: waffle.Switch: ".. no_pii:": "No PII" -# Via django-wiki https://github.com/openedx/django-wiki -wiki.Article: +# Additional non-local or generated models requiring safelist coverage +agreements.HistoricalUserAgreement: + ".. no_pii:": "No PII" +assessment.HistoricalSharedFileUpload: + ".. no_pii:": "No PII" +casbin_adapter.CasbinRule: + ".. no_pii:": "No PII" +channel_integration.ApiResponseRecord: + ".. no_pii:": "No PII" +channel_integration.GenericEnterpriseCustomerPluginConfiguration: + ".. no_pii:": "No PII" +channel_integration.IntegratedChannelAPIRequestLogs: + ".. no_pii:": "No PII" +channel_integration.OrphanedContentTransmissions: + ".. no_pii:": "No PII" +edx_proctoring.HistoricalProctoredExam: + ".. no_pii:": "No PII" +edx_proctoring.HistoricalProctoredExamStudentAttempt: + ".. no_pii:": "No PII" +enterprise.HistoricalDefaultEnterpriseEnrollmentIntention: + ".. no_pii:": "No PII" +enterprise.HistoricalDefaultEnterpriseEnrollmentRealization: + ".. no_pii:": "No PII" +enterprise.HistoricalEnterpriseCourseEntitlement: + ".. no_pii:": "No PII" +enterprise.HistoricalEnterpriseCustomerInviteKey: ".. no_pii:": "No PII" -wiki.ArticleForObject: +enterprise.HistoricalEnterpriseCustomerSsoConfiguration: ".. no_pii:": "No PII" -wiki.ArticlePlugin: +enterprise.HistoricalEnterpriseCustomerUser: ".. no_pii:": "No PII" -wiki.ArticleRevision: +enterprise.HistoricalEnterpriseGroup: ".. no_pii:": "No PII" -wiki.ReusablePlugin: +enterprise.HistoricalEnterpriseGroupMembership: ".. no_pii:": "No PII" -wiki.RevisionPlugin: +enterprise.HistoricalLearnerCreditEnterpriseCourseEnrollment: ".. no_pii:": "No PII" -wiki.RevisionPluginRevision: +enterprise.HistoricalLicensedEnterpriseCourseEnrollment: ".. no_pii:": "No PII" -wiki.SimplePlugin: +enterprise.HistoricalPendingEnrollment: ".. no_pii:": "No PII" -wiki.URLPath: +enterprise.HistoricalPendingEnterpriseCustomerAdminUser: + ".. pii:": "Contains pending enterprise admin email address." + ".. pii_types:": "email_address" + ".. pii_retirement:": "consumer_api" +enterprise.HistoricalPendingEnterpriseCustomerUser: + ".. pii:": "Contains pending enterprise learner email address." + ".. pii_types:": "email_address" + ".. pii_retirement:": "consumer_api" +enterprise.HistoricalSystemWideEnterpriseUserRoleAssignment: + ".. no_pii:": "No PII" +forum.AbuseFlagger: + ".. no_pii:": "No PII" +forum.Comment: + ".. pii:": "Forum comments may contain user-generated content and usernames." + ".. pii_types:": "username, biography" + ".. pii_retirement:": "local_api" +forum.CommentThread: + ".. pii:": "Forum thread content may include user-generated text and usernames." + ".. pii_types:": "username, biography" + ".. pii_retirement:": "local_api" +forum.CourseStat: + ".. no_pii:": "No PII" +forum.EditHistory: + ".. pii:": "Forum edit history stores user-generated text and author identifiers." + ".. pii_types:": "username, biography" + ".. pii_retirement:": "local_api" +forum.ForumUser: + ".. pii:": "Forum profile links and username data." + ".. pii_types:": "username" + ".. pii_retirement:": "local_api" +forum.HistoricalAbuseFlagger: + ".. no_pii:": "No PII" +forum.LastReadTime: + ".. no_pii:": "No PII" +forum.MongoContent: + ".. no_pii:": "No PII" +forum.ReadState: + ".. no_pii:": "No PII" +forum.Subscription: + ".. no_pii:": "No PII" +forum.UserVote: + ".. no_pii:": "No PII" +lti_consumer.Lti1p3Passport: + ".. pii:": "Stores third-party LTI service credentials and identifiers." + ".. pii_types:": "password, external_service" + ".. pii_retirement:": "retained" +oel_collections.Collection: + ".. no_pii:": "No PII" +oel_components.Component: + ".. no_pii:": "No PII" +oel_publishing.Container: + ".. no_pii:": "No PII" +oel_publishing.DraftChangeLog: + ".. no_pii:": "No PII" +oel_publishing.DraftChangeLogRecord: + ".. no_pii:": "No PII" +oel_publishing.LearningPackage: + ".. no_pii:": "No PII" +oel_publishing.PublishableEntity: + ".. no_pii:": "No PII" +oel_tagging.ObjectTag: + ".. no_pii:": "No PII" +oel_tagging.Tag: + ".. no_pii:": "No PII" +oel_tagging.TagImportTask: + ".. no_pii:": "No PII" +oel_tagging.Taxonomy: + ".. no_pii:": "No PII" +openedx_catalog.CatalogCourse: + ".. no_pii:": "No PII" +openedx_catalog.CourseRun: + ".. no_pii:": "No PII" +openedx_content.Collection: + ".. no_pii:": "No PII" +openedx_content.CollectionPublishableEntity: + ".. no_pii:": "No PII" +openedx_content.Component: + ".. no_pii:": "No PII" +openedx_content.ComponentType: ".. no_pii:": "No PII" +openedx_content.ComponentVersion: + ".. no_pii:": "No PII" +openedx_content.ComponentVersionMedia: + ".. no_pii:": "No PII" +openedx_content.Container: + ".. no_pii:": "No PII" +openedx_content.ContainerType: + ".. no_pii:": "No PII" +openedx_content.ContainerVersion: + ".. no_pii:": "No PII" +openedx_content.Draft: + ".. no_pii:": "No PII" +openedx_content.EntityList: + ".. no_pii:": "No PII" +openedx_content.EntityListRow: + ".. no_pii:": "No PII" +openedx_content.LearningPackage: + ".. no_pii:": "No PII" +openedx_content.Media: + ".. no_pii:": "No PII" +openedx_content.MediaType: + ".. no_pii:": "No PII" +openedx_content.PublishLog: + ".. no_pii:": "No PII" +openedx_content.PublishLogRecord: + ".. no_pii:": "No PII" +openedx_content.PublishableEntity: + ".. no_pii:": "No PII" +openedx_content.PublishableEntityVersion: + ".. no_pii:": "No PII" +openedx_content.PublishableEntityVersionDependency: + ".. no_pii:": "No PII" +openedx_content.Published: + ".. no_pii:": "No PII" +openedx_content.Section: + ".. no_pii:": "No PII" +openedx_content.SectionVersion: + ".. no_pii:": "No PII" +openedx_content.Subsection: + ".. no_pii:": "No PII" +openedx_content.SubsectionVersion: + ".. no_pii:": "No PII" +openedx_content.Unit: + ".. no_pii:": "No PII" +openedx_content.UnitVersion: + ".. no_pii:": "No PII" +organizations.HistoricalOrganization: + ".. no_pii:": "No PII" +organizations.HistoricalOrganizationCourse: + ".. no_pii:": "No PII" +push_notifications.APNSDevice: + ".. pii:": "Contains mobile push tokens tied to users/devices." + ".. pii_types:": "external_service" + ".. pii_retirement:": "local_api" +push_notifications.GCMDevice: + ".. pii:": "Contains mobile push tokens tied to users/devices." + ".. pii_types:": "external_service" + ".. pii_retirement:": "local_api" +push_notifications.WNSDevice: + ".. pii:": "Contains mobile push tokens tied to users/devices." + ".. pii_types:": "external_service" + ".. pii_retirement:": "local_api" +push_notifications.WebPushDevice: + ".. pii:": "Contains web push endpoint/subscription data tied to users/devices." + ".. pii_types:": "external_service" + ".. pii_retirement:": "local_api" +submissions.ExternalGraderDetail: + ".. no_pii:": "No PII" +submissions.SubmissionFile: + ".. no_pii:": "No PII" +support.HistoricalUserSocialAuth: + ".. pii:": "Historical social auth linkage to third-party identity providers." + ".. pii_types:": "external_service" + ".. pii_retirement:": "local_api" diff --git a/.github/renovate.json5 b/.github/renovate.json5 index edd326558c61..beada3ff3ec2 100644 --- a/.github/renovate.json5 +++ b/.github/renovate.json5 @@ -1,45 +1,50 @@ { extends: [ - 'config:recommended', - 'schedule:weekly', - ':automergeLinters', - ':automergeMinor', - ':automergeTesters', - ':enableVulnerabilityAlerts', - ':semanticCommits', - ':updateNotScheduled', + 'config:recommended', // Renovate base defaults: dependency dashboard, monorepo grouping, sane PR limits + 'schedule:weekly', // Only open new PRs once a week + ':automergeLinters', // Automerge linter updates (eslint, prettier, etc.) + ':automergeTesters', // Automerge test runner updates (jest, mocha, etc.) + ':enableVulnerabilityAlerts', // Open security PRs immediately, ignoring the weekly schedule + ':semanticCommits', // Use conventional commit format (fix(deps):, chore(deps):) + ':updateNotScheduled', // Allow vulnerability fixes to bypass the weekly schedule ], + + // Never auto-rebase PRs; let humans decide when to rebase + rebaseWhen: 'never', + + // Wait 3 days after a release before opening a PR, giving time for early bugs and + // potentially malicious releases (e.g. supply chain attacks) to be detected + minimumReleaseAge: '3 days', + + // Only manage npm dependencies + enabledManagers: [ + 'npm', + ], + + // Only create PRs during Eastern time (aligns with the weekly schedule) + timezone: 'America/New_York', + + // Cap the number of open Renovate PRs at any one time + prConcurrentLimit: 3, + + // Packages with known breaking changes or no active maintainer + ignoreDeps: [ + 'karma-spec-reporter', + ], + packageRules: [ { - matchDepTypes: [ - 'devDependencies', - ], - matchUpdateTypes: [ - 'lockFileMaintenance', - 'minor', - 'patch', - 'pin', + // Automerge minor and patch updates for @edx and @openedx scoped packages; + // these are maintained by the same org so breakage is caught upstream + matchPackageNames: [ + '/@edx/', + '/@openedx/', ], - automerge: true, - }, - { matchUpdateTypes: [ 'minor', 'patch', ], automerge: true, - matchPackageNames: [ - '/@edx/', - '/@openedx/', - ], }, ], - ignoreDeps: [ - 'karma-spec-reporter', - ], - timezone: 'America/New_York', - prConcurrentLimit: 3, - enabledManagers: [ - 'npm', - ], } diff --git a/.github/workflows/add-quarterly-ticket-to-check-constraints.yml b/.github/workflows/add-quarterly-ticket-to-check-constraints.yml new file mode 100644 index 000000000000..00ec08c65cea --- /dev/null +++ b/.github/workflows/add-quarterly-ticket-to-check-constraints.yml @@ -0,0 +1,26 @@ +name: Create quarterly issues for GitHub audit +on: + schedule: + - cron: 0 0 1 1,4,7,10 * + workflow_dispatch: {} + +env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + +jobs: + create_issue: + name: Create quarterly constraint check issue + runs-on: ubuntu-latest + permissions: + issues: write + steps: + - run: | + # Platform constraints audit + new_issue_url=$(gh issue create --repo "openedx/openedx-platform" \ + --title "Quarterly audit of openedx-platform constraints" \ + --label "code health" \ + --body "It is time to perform the quartely audit of constrained dependencies in \`openedx-platform\`. The goal is to remove any constraints that are no longer necessary to proactively prevent version conflicts and keep us up to date with security patches. The playbook for performing the audit can be found [here](https://openedx.atlassian.net/wiki/spaces/AC/pages/6340968449/Quarterly+Platform+Constraints+Audit).") + echo "NEW_ISSUE_URL=$new_issue_url" >> $GITHUB_ENV + + - name: Comment on issue + run: gh issue comment $NEW_ISSUE_URL --body "@openedx/wg-maintenance-openedx-platform-oncall heads up on this request" diff --git a/.github/workflows/check-consistent-dependencies.yml b/.github/workflows/check-consistent-dependencies.yml index cef731a7d175..a84ef40bbcab 100644 --- a/.github/workflows/check-consistent-dependencies.yml +++ b/.github/workflows/check-consistent-dependencies.yml @@ -46,7 +46,7 @@ jobs: - uses: actions/setup-python@v6 if: ${{ env.RELEVANT == 'true' }} with: - python-version: '3.11' + python-version: '3.12' - name: "Recompile requirements" if: ${{ env.RELEVANT == 'true' }} diff --git a/.github/workflows/ci-static-analysis.yml b/.github/workflows/ci-static-analysis.yml index a5ab117acdfc..94fb9e863d87 100644 --- a/.github/workflows/ci-static-analysis.yml +++ b/.github/workflows/ci-static-analysis.yml @@ -11,7 +11,7 @@ jobs: strategy: matrix: python-version: - - "3.11" + - "3.12" os: ["ubuntu-24.04"] steps: diff --git a/.github/workflows/compile-python-requirements.yml b/.github/workflows/compile-python-requirements.yml index 1da50b9b6bdd..fe8fdc6ff542 100644 --- a/.github/workflows/compile-python-requirements.yml +++ b/.github/workflows/compile-python-requirements.yml @@ -26,7 +26,7 @@ jobs: - name: Set up Python environment uses: actions/setup-python@v6 with: - python-version: "3.11" + python-version: "3.12" - name: Run make compile-requirements env: diff --git a/.github/workflows/js-tests.yml b/.github/workflows/js-tests.yml index 42a6a6cfb057..dd21d12e3d25 100644 --- a/.github/workflows/js-tests.yml +++ b/.github/workflows/js-tests.yml @@ -16,7 +16,7 @@ jobs: os: [ubuntu-latest] node-version: [20] python-version: - - "3.11" + - "3.12" steps: - uses: actions/checkout@v6 @@ -73,7 +73,7 @@ jobs: npm run test - name: Save Job Artifacts - uses: actions/upload-artifact@v6 + uses: actions/upload-artifact@v7 with: name: Build-Artifacts path: | diff --git a/.github/workflows/lint-imports.yml b/.github/workflows/lint-imports.yml index 2debc4cb1028..8b119d31e6b5 100644 --- a/.github/workflows/lint-imports.yml +++ b/.github/workflows/lint-imports.yml @@ -19,7 +19,7 @@ jobs: - name: Set up Python uses: actions/setup-python@v6 with: - python-version: "3.11" + python-version: "3.12" - name: Install system requirements run: sudo apt update && sudo apt install -y libxmlsec1-dev diff --git a/.github/workflows/migrations-check.yml b/.github/workflows/migrations-check.yml index c63b5ef02fba..20540fb43906 100644 --- a/.github/workflows/migrations-check.yml +++ b/.github/workflows/migrations-check.yml @@ -16,7 +16,7 @@ jobs: matrix: os: [ubuntu-24.04] python-version: - - "3.11" + - "3.12" # 'pinned' is used to install the latest patch version of Django # within the global constraint i.e. Django==4.2.8 in current case # because we have global constraint of Django<4.2 diff --git a/.github/workflows/pylint-checks.yml b/.github/workflows/pylint-checks.yml index 03160b77a7e4..91141c0c29ed 100644 --- a/.github/workflows/pylint-checks.yml +++ b/.github/workflows/pylint-checks.yml @@ -21,7 +21,7 @@ jobs: - module-name: openedx-1 path: "openedx/core/types/ openedx/core/djangoapps/ace_common/ openedx/core/djangoapps/agreements/ openedx/core/djangoapps/api_admin/ openedx/core/djangoapps/auth_exchange/ openedx/core/djangoapps/bookmarks/ openedx/core/djangoapps/cache_toolbox/ openedx/core/djangoapps/catalog/ openedx/core/djangoapps/ccxcon/ openedx/core/djangoapps/commerce/ openedx/core/djangoapps/common_initialization/ openedx/core/djangoapps/common_views/ openedx/core/djangoapps/config_model_utils/ openedx/core/djangoapps/content/ openedx/core/djangoapps/content_libraries/ openedx/core/djangoapps/content_staging/ openedx/core/djangoapps/contentserver/ openedx/core/djangoapps/cookie_metadata/ openedx/core/djangoapps/cors_csrf/ openedx/core/djangoapps/course_apps/ openedx/core/djangoapps/course_date_signals/ openedx/core/djangoapps/course_groups/ openedx/core/djangoapps/courseware_api/ openedx/core/djangoapps/crawlers/ openedx/core/djangoapps/credentials/ openedx/core/djangoapps/credit/ openedx/core/djangoapps/dark_lang/ openedx/core/djangoapps/debug/ openedx/core/djangoapps/discussions/ openedx/core/djangoapps/django_comment_common/ openedx/core/djangoapps/embargo/ openedx/core/djangoapps/enrollments/ openedx/core/djangoapps/external_user_ids/ openedx/core/djangoapps/zendesk_proxy/ openedx/core/djangolib/ openedx/core/lib/ openedx/core/djangoapps/course_live/" - module-name: openedx-2 - path: "openedx/core/djangoapps/geoinfo/ openedx/core/djangoapps/header_control/ openedx/core/djangoapps/heartbeat/ openedx/core/djangoapps/lang_pref/ openedx/core/djangoapps/models/ openedx/core/djangoapps/monkey_patch/ openedx/core/djangoapps/oauth_dispatch/ openedx/core/djangoapps/olx_rest_api/ openedx/core/djangoapps/password_policy/ openedx/core/djangoapps/plugin_api/ openedx/core/djangoapps/plugins/ openedx/core/djangoapps/profile_images/ openedx/core/djangoapps/programs/ openedx/core/djangoapps/safe_sessions/ openedx/core/djangoapps/schedules/ openedx/core/djangoapps/service_status/ openedx/core/djangoapps/session_inactivity_timeout/ openedx/core/djangoapps/signals/ openedx/core/djangoapps/site_configuration/ openedx/core/djangoapps/system_wide_roles/ openedx/core/djangoapps/theming/ openedx/core/djangoapps/user_api/ openedx/core/djangoapps/user_authn/ openedx/core/djangoapps/util/ openedx/core/djangoapps/verified_track_content/ openedx/core/djangoapps/video_config/ openedx/core/djangoapps/video_pipeline/ openedx/core/djangoapps/waffle_utils/ openedx/core/djangoapps/xblock/ openedx/core/djangoapps/xmodule_django/ openedx/core/tests/ openedx/features/ openedx/testing/ openedx/tests/ openedx/envs/ openedx/core/djangoapps/notifications/ openedx/core/djangoapps/staticfiles/ openedx/core/djangoapps/content_tagging/" + path: "openedx/core/djangoapps/geoinfo/ openedx/core/djangoapps/header_control/ openedx/core/djangoapps/heartbeat/ openedx/core/djangoapps/lang_pref/ openedx/core/djangoapps/models/ openedx/core/djangoapps/monkey_patch/ openedx/core/djangoapps/oauth_dispatch/ openedx/core/djangoapps/olx_rest_api/ openedx/core/djangoapps/password_policy/ openedx/core/djangoapps/plugin_api/ openedx/core/djangoapps/plugins/ openedx/core/djangoapps/profile_images/ openedx/core/djangoapps/programs/ openedx/core/djangoapps/safe_sessions/ openedx/core/djangoapps/schedules/ openedx/core/djangoapps/service_status/ openedx/core/djangoapps/session_inactivity_timeout/ openedx/core/djangoapps/signals/ openedx/core/djangoapps/site_configuration/ openedx/core/djangoapps/system_wide_roles/ openedx/core/djangoapps/theming/ openedx/core/djangoapps/user_api/ openedx/core/djangoapps/user_authn/ openedx/core/djangoapps/util/ openedx/core/djangoapps/verified_track_content/ openedx/core/djangoapps/video_config/ openedx/core/djangoapps/video_pipeline/ openedx/core/djangoapps/waffle_utils/ openedx/core/djangoapps/xblock/ openedx/core/djangoapps/xmodule_django/ openedx/core/tests/ openedx/features/ openedx/testing/ openedx/tests/ openedx/envs/ openedx/core/djangoapps/notifications/ openedx/core/djangoapps/staticfiles/ openedx/core/djangoapps/content_tagging/ openedx/core/djangoapps/authz/" - module-name: common path: "common" - module-name: cms @@ -40,7 +40,7 @@ jobs: - name: Set up Python uses: actions/setup-python@v6 with: - python-version: 3.11 + python-version: 3.12 - name: Get pip cache dir id: pip-cache-dir diff --git a/.github/workflows/quality-checks.yml b/.github/workflows/quality-checks.yml index b70587eda5f7..b57b713eb93a 100644 --- a/.github/workflows/quality-checks.yml +++ b/.github/workflows/quality-checks.yml @@ -16,7 +16,7 @@ jobs: matrix: os: [ubuntu-24.04] python-version: - - "3.11" + - "3.12" node-version: [20] steps: @@ -78,14 +78,14 @@ jobs: PIP_SRC: ${{ runner.temp }} TARGET_BRANCH: ${{ github.base_ref }} run: | - make pycodestyle + ruff check --output-format=github . make xsslint make pii_check make check_keywords - name: Save Job Artifacts if: always() - uses: actions/upload-artifact@v6 + uses: actions/upload-artifact@v7 with: name: Build-Artifacts path: | diff --git a/.github/workflows/semgrep.yml b/.github/workflows/semgrep.yml index 557ba0227c5d..c201f30aa799 100644 --- a/.github/workflows/semgrep.yml +++ b/.github/workflows/semgrep.yml @@ -20,7 +20,7 @@ jobs: matrix: os: ["ubuntu-latest"] python-version: - - "3.11" + - "3.12" steps: - uses: actions/checkout@v6 diff --git a/.github/workflows/static-assets-check.yml b/.github/workflows/static-assets-check.yml index ae9b57879c9f..41159e3526c5 100644 --- a/.github/workflows/static-assets-check.yml +++ b/.github/workflows/static-assets-check.yml @@ -15,7 +15,7 @@ jobs: matrix: os: [ubuntu-24.04] python-version: - - "3.11" + - "3.12" node-version: [20] npm-version: [10.7.x] mongo-version: @@ -71,6 +71,13 @@ jobs: - name: Install Limited Python Deps for Build run: | + # Install pip-tools.txt first to pin setuptools<82 before installing + # assets.txt. setuptools 82+ removed pkg_resources, which pyfilesystem2 + # (fs) still uses for namespace package declarations. The constraints.txt + # pin covers full installs, but this step only installs assets.txt so we + # pre-install pip-tools.txt to ensure setuptools 81.x is in place. + # See: https://github.com/PyFilesystem/pyfilesystem2/issues/577 + pip install -r requirements/pip-tools.txt pip install -r requirements/edx/assets.txt - name: Add node_modules bin to $Path @@ -98,7 +105,6 @@ jobs: env: LMS_CFG: lms/envs/minimal.yml CMS_CFG: lms/envs/minimal.yml - DJANGO_SETTINGS_MODULE: lms.envs.production run: | - ./manage.py lms collectstatic --noinput - ./manage.py cms collectstatic --noinput + DJANGO_SETTINGS_MODULE=lms.envs.production ./manage.py lms collectstatic --noinput + DJANGO_SETTINGS_MODULE=cms.envs.production ./manage.py cms collectstatic --noinput diff --git a/.github/workflows/unit-test-shards.json b/.github/workflows/unit-test-shards.json index cb9beeb3c6bf..0f26c1be11b0 100644 --- a/.github/workflows/unit-test-shards.json +++ b/.github/workflows/unit-test-shards.json @@ -2,167 +2,169 @@ "lms-1": { "settings": "lms.envs.test", "paths": [ - "lms/djangoapps/branding/", - "lms/djangoapps/bulk_email/", - "lms/djangoapps/bulk_enroll/", - "lms/djangoapps/bulk_user_retirement/", - "lms/djangoapps/ccx/", - "lms/djangoapps/certificates/", - "lms/djangoapps/commerce/" + "lms/djangoapps/discussion/rest_api/" ] }, "lms-2": { "settings": "lms.envs.test", "paths": [ + "lms/djangoapps/ccx/", + "lms/djangoapps/commerce/", "lms/djangoapps/course_api/", - "lms/djangoapps/course_blocks/", - "lms/djangoapps/course_goals/", - "lms/djangoapps/course_home_api/", "lms/djangoapps/course_wiki/", - "lms/djangoapps/coursewarehistoryextended/", - "lms/djangoapps/debug/" + "lms/djangoapps/discussion/notification_prefs/", + "lms/djangoapps/instructor_task/", + "lms/djangoapps/ora_staff_grader/", + "lms/djangoapps/survey/", + "lms/djangoapps/teams/", + "lms/djangoapps/verify_student/" ] }, "lms-3": { "settings": "lms.envs.test", "paths": [ - "lms/djangoapps/courseware/" + "lms/djangoapps/branding/", + "lms/djangoapps/bulk_enroll/", + "lms/djangoapps/courseware/", + "lms/djangoapps/instructor_analytics/", + "lms/djangoapps/learner_dashboard/", + "lms/djangoapps/lti_provider/", + "lms/djangoapps/program_enrollments/" ] }, "lms-4": { "settings": "lms.envs.test", "paths": [ - "lms/djangoapps/discussion/", - "lms/djangoapps/edxnotes/", - "lms/djangoapps/experiments/" - ] - }, - "lms-5": { - "settings": "lms.envs.test", - "paths": [ - "lms/djangoapps/gating/", + "lms/djangoapps/bulk_user_retirement/", + "lms/djangoapps/course_blocks/", + "lms/djangoapps/course_goals/", + "lms/djangoapps/course_home_api/", + "lms/djangoapps/coursewarehistoryextended/", + "lms/djangoapps/discussion/tests/", + "lms/djangoapps/experiments/", "lms/djangoapps/grades/", "lms/djangoapps/instructor/", - "lms/djangoapps/instructor_analytics/" + "lms/djangoapps/mfe_config_api/", + "lms/djangoapps/staticbook/", + "lms/lib/" ] }, - "lms-6": { + "lms-5": { "settings": "lms.envs.test", "paths": [ - "lms/djangoapps/instructor_task/", - "lms/djangoapps/learner_dashboard/", + "lms/djangoapps/bulk_email/", + "lms/djangoapps/certificates/", + "lms/djangoapps/debug/", + "lms/djangoapps/discussion/django_comment_client/", + "lms/djangoapps/edxnotes/", + "lms/djangoapps/gating/", "lms/djangoapps/learner_home/", "lms/djangoapps/lms_initialization/", "lms/djangoapps/lms_xblock/", - "lms/djangoapps/lti_provider/", "lms/djangoapps/mailing/", "lms/djangoapps/mobile_api/", "lms/djangoapps/monitoring/", - "lms/djangoapps/ora_staff_grader/", - "lms/djangoapps/program_enrollments/", "lms/djangoapps/rss_proxy/", "lms/djangoapps/static_template_view/", - "lms/djangoapps/staticbook/", "lms/djangoapps/support/", - "lms/djangoapps/survey/", - "lms/djangoapps/teams/", "lms/djangoapps/tests/", "lms/djangoapps/user_tours/", - "lms/djangoapps/verify_student/", - "lms/djangoapps/mfe_config_api/", "lms/envs/", - "lms/lib/", "lms/tests.py" ] }, - "openedx-1-with-lms": { + "shared-with-lms-1": { "settings": "lms.envs.test", "paths": [ - "openedx/core/djangoapps/ace_common/", - "openedx/core/djangoapps/cors_csrf/", + "common/djangoapps/", "openedx/core/djangoapps/agreements/", "openedx/core/djangoapps/api_admin/", + "openedx/core/djangoapps/authz/", + "openedx/core/djangoapps/cache_toolbox/", + "openedx/core/djangoapps/ccxcon/", + "openedx/core/djangoapps/content/", + "openedx/core/djangoapps/content_libraries/", + "openedx/core/djangoapps/course_apps/", + "openedx/core/djangoapps/credentials/", + "openedx/core/djangoapps/credit/", + "openedx/core/djangoapps/dark_lang/", + "openedx/core/djangoapps/django_comment_common/", + "openedx/core/djangoapps/embargo/", + "openedx/core/djangoapps/header_control/", + "openedx/core/djangoapps/heartbeat/", + "openedx/core/djangoapps/models/", + "openedx/core/djangoapps/notifications/", + "openedx/core/djangoapps/oauth_dispatch/", + "openedx/core/djangoapps/safe_sessions/", + "openedx/core/djangoapps/schedules/", + "openedx/core/djangoapps/user_api/", + "openedx/core/djangoapps/util/", + "openedx/core/djangoapps/video_pipeline/", + "openedx/core/djangoapps/waffle_utils/", + "openedx/core/djangoapps/xblock/", + "openedx/core/tests/", + "openedx/features/", + "openedx/tests/" + ] + }, + "shared-with-lms-2": { + "settings": "lms.envs.test", + "paths": [ + "openedx/core/djangoapps/ace_common/", "openedx/core/djangoapps/auth_exchange/", "openedx/core/djangoapps/bookmarks/", - "openedx/core/djangoapps/cache_toolbox/", "openedx/core/djangoapps/catalog/", - "openedx/core/djangoapps/ccxcon/", "openedx/core/djangoapps/commerce/", "openedx/core/djangoapps/common_initialization/", "openedx/core/djangoapps/common_views/", "openedx/core/djangoapps/config_model_utils/", - "openedx/core/djangoapps/content/", - "openedx/core/djangoapps/content_libraries/", "openedx/core/djangoapps/contentserver/", "openedx/core/djangoapps/cookie_metadata/", - "openedx/core/djangoapps/course_apps/", + "openedx/core/djangoapps/cors_csrf/", "openedx/core/djangoapps/course_date_signals/", "openedx/core/djangoapps/course_groups/", + "openedx/core/djangoapps/course_live/", "openedx/core/djangoapps/courseware_api/", "openedx/core/djangoapps/crawlers/", - "openedx/core/djangoapps/credentials/", - "openedx/core/djangoapps/credit/", - "openedx/core/djangoapps/course_live/", - "openedx/core/djangoapps/dark_lang/", "openedx/core/djangoapps/debug/", "openedx/core/djangoapps/discussions/", - "openedx/core/djangoapps/django_comment_common/", - "openedx/core/djangoapps/embargo/", "openedx/core/djangoapps/enrollments/", - "openedx/core/djangoapps/external_user_ids/" - ] - }, - "openedx-2-with-lms": { - "settings": "lms.envs.test", - "paths": [ + "openedx/core/djangoapps/external_user_ids/", "openedx/core/djangoapps/geoinfo/", - "openedx/core/djangoapps/header_control/", - "openedx/core/djangoapps/heartbeat/", "openedx/core/djangoapps/lang_pref/", - "openedx/core/djangoapps/models/", "openedx/core/djangoapps/monkey_patch/", - "openedx/core/djangoapps/notifications/", - "openedx/core/djangoapps/oauth_dispatch/", "openedx/core/djangoapps/olx_rest_api/", "openedx/core/djangoapps/password_policy/", "openedx/core/djangoapps/plugin_api/", "openedx/core/djangoapps/plugins/", "openedx/core/djangoapps/profile_images/", "openedx/core/djangoapps/programs/", - "openedx/core/djangoapps/safe_sessions/", - "openedx/core/djangoapps/schedules/", "openedx/core/djangoapps/service_status/", "openedx/core/djangoapps/session_inactivity_timeout/", "openedx/core/djangoapps/signals/", "openedx/core/djangoapps/site_configuration/", "openedx/core/djangoapps/system_wide_roles/", "openedx/core/djangoapps/theming/", - "openedx/core/djangoapps/user_api/", "openedx/core/djangoapps/user_authn/", - "openedx/core/djangoapps/util/", "openedx/core/djangoapps/verified_track_content/", "openedx/core/djangoapps/video_config/", - "openedx/core/djangoapps/video_pipeline/", - "openedx/core/djangoapps/waffle_utils/", - "openedx/core/djangoapps/xblock/", "openedx/core/djangoapps/xmodule_django/", "openedx/core/djangoapps/zendesk_proxy/", "openedx/core/djangolib/", "openedx/core/lib/", - "openedx/core/tests/", - "openedx/features/", "openedx/testing/", - "openedx/tests/" + "xmodule/" ] }, - "openedx-1-with-cms": { + "shared-with-cms-1": { "settings": "cms.envs.test", "paths": [ + "common/djangoapps/", "openedx/core/djangoapps/ace_common/", - "openedx/core/djangoapps/cors_csrf/", "openedx/core/djangoapps/agreements/", "openedx/core/djangoapps/api_admin/", "openedx/core/djangoapps/auth_exchange/", + "openedx/core/djangoapps/authz/", "openedx/core/djangoapps/bookmarks/", "openedx/core/djangoapps/cache_toolbox/", "openedx/core/djangoapps/catalog/", @@ -174,8 +176,10 @@ "openedx/core/djangoapps/content/", "openedx/core/djangoapps/content_libraries/", "openedx/core/djangoapps/content_staging/", + "openedx/core/djangoapps/content_tagging/", "openedx/core/djangoapps/contentserver/", "openedx/core/djangoapps/cookie_metadata/", + "openedx/core/djangoapps/cors_csrf/", "openedx/core/djangoapps/course_apps/", "openedx/core/djangoapps/course_date_signals/", "openedx/core/djangoapps/course_groups/", @@ -189,13 +193,7 @@ "openedx/core/djangoapps/django_comment_common/", "openedx/core/djangoapps/embargo/", "openedx/core/djangoapps/enrollments/", - "openedx/core/djangoapps/external_user_ids/" - ] - }, - "openedx-2-with-cms": { - "settings": "cms.envs.test", - "paths": [ - "openedx/core/djangoapps/content_tagging/", + "openedx/core/djangoapps/external_user_ids/", "openedx/core/djangoapps/geoinfo/", "openedx/core/djangoapps/header_control/", "openedx/core/djangoapps/heartbeat/", @@ -228,7 +226,8 @@ "openedx/core/djangoapps/xmodule_django/", "openedx/core/djangoapps/zendesk_proxy/", "openedx/core/lib/", - "openedx/tests/" + "openedx/tests/", + "xmodule/" ] }, "cms-1": { @@ -238,8 +237,8 @@ "cms/djangoapps/cms_user_tasks/", "cms/djangoapps/course_creators/", "cms/djangoapps/export_course_metadata/", - "cms/djangoapps/modulestore_migrator/", "cms/djangoapps/models/", + "cms/djangoapps/modulestore_migrator/", "cms/djangoapps/pipeline_js/", "cms/djangoapps/xblock_config/", "cms/envs/", @@ -251,29 +250,5 @@ "paths": [ "cms/djangoapps/contentstore/" ] - }, - "common-with-lms": { - "settings": "lms.envs.test", - "paths": [ - "common/djangoapps/" - ] - }, - "common-with-cms": { - "settings": "cms.envs.test", - "paths": [ - "common/djangoapps/" - ] - }, - "xmodule-with-lms": { - "settings": "lms.envs.test", - "paths": [ - "xmodule/" - ] - }, - "xmodule-with-cms": { - "settings": "cms.envs.test", - "paths": [ - "xmodule/" - ] } } diff --git a/.github/workflows/unit-tests.yml b/.github/workflows/unit-tests.yml index 4d857c7b97a1..777af3491eb6 100644 --- a/.github/workflows/unit-tests.yml +++ b/.github/workflows/unit-tests.yml @@ -8,6 +8,7 @@ on: push: branches: - master + - release/* concurrency: # We only need to be running tests for the latest commit on each PR @@ -22,29 +23,24 @@ jobs: strategy: matrix: python-version: - - "3.11" - "3.12" django-version: - "pinned" - # When updating the shards, remember to make the same changes in - # .github/workflows/unit-tests-gh-hosted.yml shard_name: - "lms-1" - "lms-2" - "lms-3" - "lms-4" - "lms-5" - - "lms-6" - - "openedx-1-with-lms" - - "openedx-2-with-lms" - - "openedx-1-with-cms" - - "openedx-2-with-cms" + - "shared-with-lms-1" + - "shared-with-lms-2" + # Note: The shared-with-cms-1 shard is currently a subset of both + # shared-with-lms-1 and shared-with-lms-2. Some shared tests are + # not run -with-cms at all. + # https://github.com/openedx/openedx-platform/issues/38355 + - "shared-with-cms-1" - "cms-1" - "cms-2" - - "common-with-lms" - - "common-with-cms" - - "xmodule-with-lms" - - "xmodule-with-cms" mongo-version: - "7.0" os-version: @@ -57,18 +53,18 @@ jobs: # # We're testing the older version of Ubuntu and running the xmodule tests since those rely on many # dependent complex libraries and will hopefully catch most issues quickly. - include: - - shard_name: "xmodule-with-cms" - python-version: "3.11" - django-version: "pinned" - mongo-version: "7.0" - os-version: "ubuntu-22.04" - - shard_name: "xmodule-with-lms" - python-version: "3.11" - django-version: "pinned" - mongo-version: "7.0" - os-version: "ubuntu-22.04" - + # + # include: + # - shard_name: "xmodule-with-cms" + # python-version: "3.12" + # django-version: "pinned" + # mongo-version: "7.0" + # os-version: "ubuntu-24.04" + # - shard_name: "xmodule-with-lms" + # python-version: "3.12" + # django-version: "pinned" + # mongo-version: "7.0" + # os-version: "ubuntu-24.04" steps: - name: checkout repo uses: actions/checkout@v6 @@ -116,11 +112,25 @@ jobs: shell: bash run: | echo "unit_test_paths=$(python scripts/unit_test_shards_parser.py --shard-name=${{ matrix.shard_name }} )" >> $GITHUB_ENV + if [[ "${{ github.ref }}" == "refs/heads/master" ]]; then + echo "report_log_arg=--report-log=reports/pytest-report-${{ matrix.shard_name }}.jsonl" >> $GITHUB_ENV + else + echo "report_log_arg=" >> $GITHUB_ENV + fi - name: run tests shell: bash run: | - python -Wd -m pytest -p no:randomly --ds=${{ env.settings_path }} ${{ env.unit_test_paths }} --cov=. + python -Wd -m pytest -p no:randomly --ds=${{ env.settings_path }} ${{ env.unit_test_paths }} --cov=. \ + ${{ env.report_log_arg }} + + - name: Upload pytest timing report + if: github.ref == 'refs/heads/master' + uses: actions/upload-artifact@v7 + with: + name: pytest-report-${{ matrix.shard_name }}-${{ matrix.python-version }}-${{ matrix.django-version }}-${{ matrix.mongo-version }}-${{ matrix.os-version }} + path: reports/pytest-report-${{ matrix.shard_name }}.jsonl + overwrite: true - name: rename warnings json file if: success() @@ -131,7 +141,7 @@ jobs: - name: save pytest warnings json file if: success() - uses: actions/upload-artifact@v6 + uses: actions/upload-artifact@v7 with: name: pytest-warnings-json-${{ matrix.shard_name }}-${{ matrix.python-version }}-${{ matrix.django-version }}-${{ matrix.mongo-version }}-${{ matrix.os-version }} path: | @@ -143,7 +153,7 @@ jobs: mv reports/.coverage reports/${{ matrix.shard_name }}_${{ matrix.python-version }}_${{ matrix.django-version }}_${{ matrix.mongo-version }}_${{ matrix.os-version }}.coverage - name: Upload coverage - uses: actions/upload-artifact@v6 + uses: actions/upload-artifact@v7 with: name: coverage-${{ matrix.shard_name }}-${{ matrix.python-version }}-${{ matrix.django-version }}-${{ matrix.mongo-version }}-${{ matrix.os-version }} path: reports/${{ matrix.shard_name }}_${{ matrix.python-version }}_${{ matrix.django-version }}_${{ matrix.mongo-version }}_${{ matrix.os-version }}.coverage @@ -156,7 +166,7 @@ jobs: - name: Setup Python uses: actions/setup-python@v6 with: - python-version: 3.11 + python-version: 3.12 - name: install system requirements run: | @@ -230,7 +240,7 @@ jobs: steps: - uses: actions/checkout@v6 - name: collect pytest warnings files - uses: actions/download-artifact@v7 + uses: actions/download-artifact@v8 with: pattern: pytest-warnings-json-* merge-multiple: true @@ -245,7 +255,7 @@ jobs: - name: save warning report if: success() - uses: actions/upload-artifact@v6 + uses: actions/upload-artifact@v7 with: name: pytest-warning-report-html path: | @@ -257,14 +267,14 @@ jobs: needs: [compile-warnings-report] steps: - name: Merge Pytest Warnings JSON Artifacts - uses: actions/upload-artifact/merge@v6 + uses: actions/upload-artifact/merge@v7 with: name: pytest-warnings-json pattern: pytest-warnings-json-* delete-merged: true - name: Merge Coverage Artifacts - uses: actions/upload-artifact/merge@v6 + uses: actions/upload-artifact/merge@v7 with: name: coverage pattern: coverage-* @@ -278,7 +288,7 @@ jobs: strategy: matrix: python-version: - - 3.11 + - 3.12 steps: - name: Checkout repo uses: actions/checkout@v6 @@ -289,7 +299,7 @@ jobs: python-version: ${{ matrix.python-version }} - name: Download all artifacts - uses: actions/download-artifact@v7 + uses: actions/download-artifact@v8 with: pattern: coverage-* merge-multiple: true diff --git a/.github/workflows/upgrade-one-python-dependency.yml b/.github/workflows/upgrade-one-python-dependency.yml index 36a6b361887f..fc4610baf49d 100644 --- a/.github/workflows/upgrade-one-python-dependency.yml +++ b/.github/workflows/upgrade-one-python-dependency.yml @@ -39,7 +39,7 @@ jobs: - name: Set up Python environment uses: actions/setup-python@v6 with: - python-version: "3.11" + python-version: "3.12" - name: Update any pinned dependencies env: diff --git a/.gitignore b/.gitignore index 57e4ed34104d..069d8ebe3635 100644 --- a/.gitignore +++ b/.gitignore @@ -13,6 +13,7 @@ lms/envs/private.py cms/envs/private.py .venv/ CLAUDE.md +.claude/ AGENTS.md # end-noclean diff --git a/.pii_annotations.yml b/.pii_annotations.yml index 9000115a253e..5f0f822b584d 100644 --- a/.pii_annotations.yml +++ b/.pii_annotations.yml @@ -1,7 +1,7 @@ source_path: ./ report_path: pii_report safelist_path: .annotation_safe_list.yml -coverage_target: 85.3 +coverage_target: 100.0 # See OEP-30 for more information on these values and what they mean: # https://open-edx-proposals.readthedocs.io/en/latest/oep-0030-arch-pii-markup-and-auditing.html#docstring-annotations annotations: diff --git a/.readthedocs.yaml b/.readthedocs.yaml index fdef59eb56b2..fef9e3c2a9d2 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -3,13 +3,17 @@ version: 2 build: os: "ubuntu-lts-latest" tools: - python: "3.11" + python: "3.12" sphinx: configuration: docs/conf.py python: install: + # Need to install this to set the correct version of steuptools for now + # because it is needed by fs + # See https://github.com/openedx/openedx-platform/issues/38068 for details. + - requirements: "requirements/pip-tools.txt" - requirements: "requirements/edx/doc.txt" - method: pip path: . diff --git a/Makefile b/Makefile index 2ca7fbc5848e..98931cb608d2 100644 --- a/Makefile +++ b/Makefile @@ -171,22 +171,20 @@ xsslint: ## check xss for quality issuest --config=scripts.xsslint_config \ --thresholds=scripts/xsslint_thresholds.json -pycodestyle: ## check python files for quality issues - pycodestyle . +ruff: ## check python files with ruff + ruff check . ## Re-enable --lint flag when this issue https://github.com/openedx/edx-platform/issues/35775 is resolved pii_check: ## check django models for pii annotations DJANGO_SETTINGS_MODULE=cms.envs.test \ code_annotations django_find_annotations \ --config_file .pii_annotations.yml \ - --app_name cms \ --coverage \ --lint DJANGO_SETTINGS_MODULE=lms.envs.test \ code_annotations django_find_annotations \ --config_file .pii_annotations.yml \ - --app_name lms \ --coverage \ --lint diff --git a/README.rst b/README.rst index b315cdcbf2b6..1e404c53dd49 100644 --- a/README.rst +++ b/README.rst @@ -78,7 +78,7 @@ OS: Interpreters/Tools: -* Python 3.11 or 3.12 +* Python 3.12 * Node: See the ``.nvmrc`` file in this repository. @@ -230,6 +230,23 @@ running at the given ports. - localhost:1997 - ACCOUNT_MICROFRONTEND_URL +Security Deployment Requirements +******************************** + +Some platform features require a **shared** Django cache backend (Redis or +Memcached) to function correctly across multiple LMS nodes: + +* **LTI Provider** — OAuth nonce replay protection stores seen nonces in the + Django ``default`` cache. A per-process backend (e.g. ``LocMemCache``) will + not detect replays that arrive on a different node. See + `lms/djangoapps/lti_provider/README.rst`_ for details. + +Tutor-based deployments satisfy this requirement automatically. For bare-metal +or custom deployments, verify that ``CACHES['default']`` points at a shared +Redis or Memcached instance before enabling these features. + +.. _lms/djangoapps/lti_provider/README.rst: lms/djangoapps/lti_provider/README.rst + License ******* @@ -293,6 +310,11 @@ Code of Conduct Please read the `Community Code of Conduct`_ for interacting with this repository. +AI Contribution Policy +********************** + +Note that contributions are expected to follow the Open edX `AI Contribution Policy`_. + Reporting Security Issues ************************* @@ -302,6 +324,7 @@ security@openedx.org. .. _individual contributor agreement: https://openedx.org/cla .. _CONTRIBUTING: https://github.com/openedx/.github/blob/master/CONTRIBUTING.md .. _Community Code of Conduct: https://openedx.org/code-of-conduct/ +.. _AI Contribution Policy: https://github.com/openedx/.github/blob/master/AI_POLICY.md People ****** diff --git a/cms/__init__.py b/cms/__init__.py index f9ed0bb3cea1..ff320dad9248 100644 --- a/cms/__init__.py +++ b/cms/__init__.py @@ -1,9 +1,9 @@ +# ruff: noqa: I001 """ Celery needs to be loaded when the cms modules are so that task registration and discovery can work correctly. Import sorting is intentionally disabled in this module. -isort:skip_file """ @@ -21,4 +21,4 @@ # This will make sure the app is always imported when Django starts so # that shared_task will use this app, and also ensures that the celery # singleton is always configured for the CMS. -from .celery import APP as CELERY_APP # lint-amnesty, pylint: disable=wrong-import-position +from .celery import APP as CELERY_APP # pylint: disable=wrong-import-position # noqa: F401 diff --git a/cms/celery.py b/cms/celery.py index a7166feb1c27..fbcfe36e4e8c 100644 --- a/cms/celery.py +++ b/cms/celery.py @@ -16,4 +16,4 @@ # Set the default Django settings module for the 'celery' program # and then instantiate the Celery singleton. os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'cms.envs.production') -from openedx.core.lib.celery import APP # pylint: disable=wrong-import-position,unused-import +from openedx.core.lib.celery import APP # pylint: disable=wrong-import-position,unused-import # noqa: F401 diff --git a/cms/conftest.py b/cms/conftest.py index 131ea8e04831..270b45d57cad 100644 --- a/cms/conftest.py +++ b/cms/conftest.py @@ -1,3 +1,4 @@ +# ruff: noqa: I001 """ Studio unit test configuration and fixtures. @@ -13,7 +14,7 @@ from openedx.core.pytest_hooks import DeferPlugin # Patch the xml libs before anything else. -from openedx.core.lib.safe_lxml import defuse_xml_libs # isort:skip +from openedx.core.lib.safe_lxml import defuse_xml_libs # must patch xml libs before other imports execute defuse_xml_libs() @@ -27,7 +28,7 @@ def pytest_configure(config): logging.info("pytest did not register json_report correctly") -@pytest.fixture(autouse=True, scope='function') +@pytest.fixture(autouse=True, scope='function') # noqa: PT003 def _django_clear_site_cache(): """ pytest-django uses this fixture to automatically clear the Site object @@ -39,4 +40,4 @@ def _django_clear_site_cache(): clearing mechanism actually works. So override this fixture to not mess with what has been working for us so far. """ - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass diff --git a/cms/djangoapps/api/__init__.py b/cms/djangoapps/api/__init__.py index 41903687689c..7cac77010d3c 100644 --- a/cms/djangoapps/api/__init__.py +++ b/cms/djangoapps/api/__init__.py @@ -1 +1 @@ -# lint-amnesty, pylint: disable=missing-module-docstring +# pylint: disable=missing-module-docstring diff --git a/cms/djangoapps/api/urls.py b/cms/djangoapps/api/urls.py index 8fd8495647b6..7c41fb966233 100644 --- a/cms/djangoapps/api/urls.py +++ b/cms/djangoapps/api/urls.py @@ -3,8 +3,7 @@ """ -from django.urls import include -from django.urls import path +from django.urls import include, path app_name = 'cms.djangoapps.api' diff --git a/cms/djangoapps/api/v1/serializers/course_runs.py b/cms/djangoapps/api/v1/serializers/course_runs.py index 36598b025073..0f73de5f3c76 100644 --- a/cms/djangoapps/api/v1/serializers/course_runs.py +++ b/cms/djangoapps/api/v1/serializers/course_runs.py @@ -13,7 +13,7 @@ from cms.djangoapps.contentstore.views.course import create_new_course, get_course_and_check_access, rerun_course from common.djangoapps.student.models import CourseAccessRole from openedx.core.lib.courses import course_image_url -from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order IMAGE_TYPES = { 'image/jpeg': 'jpg', @@ -23,7 +23,7 @@ log = logging.getLogger(__name__) -class CourseAccessRoleSerializer(serializers.ModelSerializer): # lint-amnesty, pylint: disable=missing-class-docstring +class CourseAccessRoleSerializer(serializers.ModelSerializer): # pylint: disable=missing-class-docstring user = serializers.SlugRelatedField(slug_field='username', queryset=User.objects.all()) class Meta: @@ -31,21 +31,21 @@ class Meta: fields = ('user', 'role',) -class CourseRunScheduleSerializer(serializers.Serializer): # lint-amnesty, pylint: disable=abstract-method +class CourseRunScheduleSerializer(serializers.Serializer): # pylint: disable=abstract-method start = serializers.DateTimeField() end = serializers.DateTimeField() enrollment_start = serializers.DateTimeField(allow_null=True, required=False) enrollment_end = serializers.DateTimeField(allow_null=True, required=False) -class CourseRunTeamSerializer(serializers.Serializer): # lint-amnesty, pylint: disable=abstract-method, missing-class-docstring +class CourseRunTeamSerializer(serializers.Serializer): # pylint: disable=abstract-method, missing-class-docstring def to_internal_value(self, data): """Overriding this to support deserialization, for write operations.""" for member in data: try: User.objects.get(username=member['user']) except User.DoesNotExist: - raise serializers.ValidationError( # lint-amnesty, pylint: disable=raise-missing-from + raise serializers.ValidationError( # pylint: disable=raise-missing-from # noqa: B904 _('Course team user does not exist') ) @@ -61,10 +61,10 @@ def get_attribute(self, instance): return instance -class CourseRunTeamSerializerMixin(serializers.Serializer): # lint-amnesty, pylint: disable=abstract-method, missing-class-docstring +class CourseRunTeamSerializerMixin(serializers.Serializer): # pylint: disable=abstract-method, missing-class-docstring team = CourseRunTeamSerializer(required=False) - def update_team(self, instance, team): # lint-amnesty, pylint: disable=missing-function-docstring + def update_team(self, instance, team): # pylint: disable=missing-function-docstring # Existing data should remain intact when performing a partial update. if not self.partial: CourseAccessRole.objects.filter(course_id=instance.id).delete() @@ -81,7 +81,7 @@ def update_team(self, instance, team): # lint-amnesty, pylint: disable=missing- ) -class CourseRunImageField(serializers.ImageField): # lint-amnesty, pylint: disable=missing-class-docstring +class CourseRunImageField(serializers.ImageField): # pylint: disable=missing-class-docstring def get_attribute(self, instance): return course_image_url(instance) @@ -92,7 +92,7 @@ def to_representation(self, value): return request.build_absolute_uri(value) -class CourseRunPacingTypeField(serializers.ChoiceField): # lint-amnesty, pylint: disable=missing-class-docstring +class CourseRunPacingTypeField(serializers.ChoiceField): # pylint: disable=missing-class-docstring def to_representation(self, value): return 'self_paced' if value else 'instructor_paced' @@ -100,7 +100,7 @@ def to_internal_value(self, data): return data == 'self_paced' -class CourseRunImageSerializer(serializers.Serializer): # lint-amnesty, pylint: disable=abstract-method, missing-class-docstring +class CourseRunImageSerializer(serializers.Serializer): # pylint: disable=abstract-method, missing-class-docstring # We set an empty default to prevent the parent serializer from attempting # to save this value to the Course object. card_image = CourseRunImageField(source='course_image', default=empty) @@ -115,13 +115,13 @@ def update(self, instance, validated_data): return instance -class CourseRunSerializerCommonFieldsMixin(serializers.Serializer): # lint-amnesty, pylint: disable=abstract-method +class CourseRunSerializerCommonFieldsMixin(serializers.Serializer): # pylint: disable=abstract-method schedule = CourseRunScheduleSerializer(source='*', required=False) pacing_type = CourseRunPacingTypeField(source='self_paced', required=False, choices=((False, 'instructor_paced'), (True, 'self_paced'),)) -class CourseRunSerializer(CourseRunSerializerCommonFieldsMixin, CourseRunTeamSerializerMixin, serializers.Serializer): # lint-amnesty, pylint: disable=abstract-method, missing-class-docstring +class CourseRunSerializer(CourseRunSerializerCommonFieldsMixin, CourseRunTeamSerializerMixin, serializers.Serializer): # pylint: disable=abstract-method, missing-class-docstring id = serializers.CharField(read_only=True) title = serializers.CharField(source='display_name') images = CourseRunImageSerializer(source='*', required=False) @@ -139,7 +139,7 @@ def update(self, instance, validated_data): return instance -class CourseRunCreateSerializer(CourseRunSerializer): # lint-amnesty, pylint: disable=missing-class-docstring +class CourseRunCreateSerializer(CourseRunSerializer): # pylint: disable=missing-class-docstring org = serializers.CharField(source='id.org') number = serializers.CharField(source='id.course') run = serializers.CharField(source='id.run') @@ -155,7 +155,7 @@ def create(self, validated_data): return instance -class CourseRunRerunSerializer(CourseRunSerializerCommonFieldsMixin, CourseRunTeamSerializerMixin, # lint-amnesty, pylint: disable=abstract-method, missing-class-docstring +class CourseRunRerunSerializer(CourseRunSerializerCommonFieldsMixin, CourseRunTeamSerializerMixin, # pylint: disable=abstract-method, missing-class-docstring serializers.Serializer): title = serializers.CharField(source='display_name', required=False) number = serializers.CharField(source='id.course', required=False) @@ -171,7 +171,7 @@ def validate(self, attrs): with store.default_store('split'): new_course_run_key = store.make_course_key(course_run_key.org, number, run) except InvalidKeyError: - raise serializers.ValidationError( # lint-amnesty, pylint: disable=raise-missing-from + raise serializers.ValidationError( # pylint: disable=raise-missing-from # noqa: B904 'Invalid key supplied. Ensure there are no special characters in the Course Number.' ) if store.has_course(new_course_run_key, ignore_case=True): @@ -200,7 +200,7 @@ def update(self, instance, validated_data): return course_run -class CourseCloneSerializer(serializers.Serializer): # lint-amnesty, pylint: disable=abstract-method, missing-class-docstring +class CourseCloneSerializer(serializers.Serializer): # pylint: disable=abstract-method, missing-class-docstring source_course_id = serializers.CharField() destination_course_id = serializers.CharField() diff --git a/cms/djangoapps/api/v1/tests/test_serializers/test_course_runs.py b/cms/djangoapps/api/v1/tests/test_serializers/test_course_runs.py index c648b2e5b875..4ff5ea4f0016 100644 --- a/cms/djangoapps/api/v1/tests/test_serializers/test_course_runs.py +++ b/cms/djangoapps/api/v1/tests/test_serializers/test_course_runs.py @@ -2,6 +2,7 @@ import datetime + import ddt import pytz from django.test import RequestFactory @@ -9,15 +10,17 @@ from common.djangoapps.student.roles import CourseInstructorRole, CourseStaffRole from common.djangoapps.student.tests.factories import UserFactory from openedx.core.lib.courses import course_image_url -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + ModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order from ...serializers.course_runs import CourseRunSerializer from ..utils import serialize_datetime @ddt.ddt -class CourseRunSerializerTests(ModuleStoreTestCase): # lint-amnesty, pylint: disable=missing-class-docstring +class CourseRunSerializerTests(ModuleStoreTestCase): # pylint: disable=missing-class-docstring def setUp(self): super().setUp() diff --git a/cms/djangoapps/api/v1/tests/test_views/test_course_runs.py b/cms/djangoapps/api/v1/tests/test_views/test_course_runs.py index 78261a421424..57bda92f2355 100644 --- a/cms/djangoapps/api/v1/tests/test_views/test_course_runs.py +++ b/cms/djangoapps/api/v1/tests/test_views/test_course_runs.py @@ -2,7 +2,7 @@ import datetime -from unittest.mock import patch # lint-amnesty, pylint: disable=unused-import +from unittest.mock import patch # pylint: disable=unused-import # noqa: F401 import ddt import pytz @@ -16,12 +16,17 @@ from common.djangoapps.student.models import CourseAccessRole from common.djangoapps.student.tests.factories import TEST_PASSWORD, AdminFactory, UserFactory from openedx.core.lib.courses import course_image_url -from xmodule.contentstore.content import StaticContent # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.contentstore.django import contentstore # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.exceptions import NotFoundError # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory, ToyCourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.contentstore.content import StaticContent # pylint: disable=wrong-import-order +from xmodule.contentstore.django import contentstore # pylint: disable=wrong-import-order +from xmodule.exceptions import NotFoundError # pylint: disable=wrong-import-order +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + ModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import ( # pylint: disable=wrong-import-order + CourseFactory, + ToyCourseFactory, +) from ...serializers.course_runs import CourseRunSerializer from ..utils import serialize_datetime @@ -261,15 +266,15 @@ def test_create(self, pacing_type, expected_self_paced_value): data = self.get_course_run_data(user, start, end, pacing_type, role) response = self.client.post(self.list_url, data, format='json') - self.assertEqual(response.status_code, 201) + self.assertEqual(response.status_code, 201) # noqa: PT009 course_run_key = CourseKey.from_string(response.data['id']) course_run = modulestore().get_course(course_run_key) - self.assertEqual(course_run.display_name, data['title']) - self.assertEqual(course_run.id.org, data['org']) - self.assertEqual(course_run.id.course, data['number']) - self.assertEqual(course_run.id.run, data['run']) - self.assertEqual(course_run.self_paced, expected_self_paced_value) + self.assertEqual(course_run.display_name, data['title']) # noqa: PT009 + self.assertEqual(course_run.id.org, data['org']) # noqa: PT009 + self.assertEqual(course_run.id.course, data['number']) # noqa: PT009 + self.assertEqual(course_run.id.run, data['run']) # noqa: PT009 + self.assertEqual(course_run.self_paced, expected_self_paced_value) # noqa: PT009 self.assert_course_run_schedule(course_run, start, end) self.assert_access_role(course_run, user, role) self.assert_course_access_role_count(course_run, 1) @@ -285,8 +290,8 @@ def test_create_with_invalid_course_team(self): data = self.get_course_run_data(user, start, end, 'self-paced') data['team'] = [{'user': 'invalid-username'}] response = self.client.post(self.list_url, data, format='json') - self.assertEqual(response.status_code, 400) - self.assertEqual(response.data.get('team'), ['Course team user does not exist']) + self.assertEqual(response.status_code, 400) # noqa: PT009 + self.assertEqual(response.data.get('team'), ['Course team user does not exist']) # noqa: PT009 def test_images_upload(self): # http://www.django-rest-framework.org/api-guide/parsers/#fileuploadparser @@ -331,7 +336,7 @@ def test_rerun(self, pacing_type, expected_self_paced_value, number): original_course_run = ToyCourseFactory() add_organization({ 'name': 'Test Organization', - 'short_name': original_course_run.id.org, # lint-amnesty, pylint: disable=no-member + 'short_name': original_course_run.id.org, # pylint: disable=no-member 'description': 'Testing Organization Description', }) start = datetime.datetime.now(pytz.UTC).replace(microsecond=0) @@ -339,7 +344,7 @@ def test_rerun(self, pacing_type, expected_self_paced_value, number): user = UserFactory() role = 'instructor' run = '3T2017' - url = reverse('api:v1:course_run-rerun', kwargs={'pk': str(original_course_run.id)}) # lint-amnesty, pylint: disable=no-member + url = reverse('api:v1:course_run-rerun', kwargs={'pk': str(original_course_run.id)}) # pylint: disable=no-member data = { 'run': run, 'schedule': { @@ -369,16 +374,16 @@ def test_rerun(self, pacing_type, expected_self_paced_value, number): if number: assert course_run.id.course == number - assert course_run.id.course != original_course_run.id.course # lint-amnesty, pylint: disable=no-member + assert course_run.id.course != original_course_run.id.course # pylint: disable=no-member else: - assert course_run.id.course == original_course_run.id.course # lint-amnesty, pylint: disable=no-member + assert course_run.id.course == original_course_run.id.course # pylint: disable=no-member self.assert_course_run_schedule(course_run, start, end) self.assert_access_role(course_run, user, role) self.assert_course_access_role_count(course_run, 1) course_orgs = get_course_organizations(course_run_key) - self.assertEqual(len(course_orgs), 1) - self.assertEqual(course_orgs[0]['short_name'], original_course_run.id.org) # lint-amnesty, pylint: disable=no-member + self.assertEqual(len(course_orgs), 1) # noqa: PT009 + self.assertEqual(course_orgs[0]['short_name'], original_course_run.id.org) # pylint: disable=no-member # noqa: PT009 def test_rerun_duplicate_run(self): course_run = ToyCourseFactory() @@ -412,7 +417,7 @@ def test_clone_course(self): } response = self.client.post(url, data, format='json') assert response.status_code == 201 - self.assertEqual(response.data, {"message": "Course cloned successfully."}) + self.assertEqual(response.data, {"message": "Course cloned successfully."}) # noqa: PT009 def test_clone_course_with_missing_source_id(self): url = reverse('api:v1:course_run-clone') @@ -421,7 +426,7 @@ def test_clone_course_with_missing_source_id(self): } response = self.client.post(url, data, format='json') assert response.status_code == 400 - self.assertEqual(response.data, {'source_course_id': ['This field is required.']}) + self.assertEqual(response.data, {'source_course_id': ['This field is required.']}) # noqa: PT009 def test_clone_course_with_missing_dest_id(self): url = reverse('api:v1:course_run-clone') @@ -430,7 +435,7 @@ def test_clone_course_with_missing_dest_id(self): } response = self.client.post(url, data, format='json') assert response.status_code == 400 - self.assertEqual(response.data, {'destination_course_id': ['This field is required.']}) + self.assertEqual(response.data, {'destination_course_id': ['This field is required.']}) # noqa: PT009 def test_clone_course_with_nonexistent_source_course(self): url = reverse('api:v1:course_run-clone') diff --git a/cms/djangoapps/api/v1/tests/utils.py b/cms/djangoapps/api/v1/tests/utils.py index 1684e018dd1c..b0933e84749c 100644 --- a/cms/djangoapps/api/v1/tests/utils.py +++ b/cms/djangoapps/api/v1/tests/utils.py @@ -1,3 +1,3 @@ -# lint-amnesty, pylint: disable=missing-module-docstring +# pylint: disable=missing-module-docstring def serialize_datetime(d): return d.strftime('%Y-%m-%dT%H:%M:%S.%fZ') diff --git a/cms/djangoapps/api/v1/views/course_runs.py b/cms/djangoapps/api/v1/views/course_runs.py index 31c30d2d139a..28b9edc58ace 100644 --- a/cms/djangoapps/api/v1/views/course_runs.py +++ b/cms/djangoapps/api/v1/views/course_runs.py @@ -15,11 +15,11 @@ CourseRunCreateSerializer, CourseRunImageSerializer, CourseRunRerunSerializer, - CourseRunSerializer + CourseRunSerializer, ) -class CourseRunViewSet(viewsets.GenericViewSet): # lint-amnesty, pylint: disable=missing-class-docstring +class CourseRunViewSet(viewsets.GenericViewSet): # pylint: disable=missing-class-docstring lookup_value_regex = settings.COURSE_KEY_REGEX permission_classes = (permissions.IsAdminUser,) serializer_class = CourseRunSerializer @@ -29,7 +29,7 @@ def get_object(self): lookup_url_kwarg = self.lookup_url_kwarg or self.lookup_field assert lookup_url_kwarg in self.kwargs, ( - 'Expected view %s to be called with a URL keyword argument ' + 'Expected view %s to be called with a URL keyword argument ' # noqa: UP031 'named "%s". Fix your URL conf, or set the `.lookup_field` ' 'attribute on the view correctly.' % (self.__class__.__name__, lookup_url_kwarg) @@ -42,18 +42,18 @@ def get_object(self): raise Http404 - def list(self, request, *args, **kwargs): # lint-amnesty, pylint: disable=unused-argument + def list(self, request, *args, **kwargs): # pylint: disable=unused-argument course_runs, __ = _accessible_courses_iter(request) page = self.paginate_queryset(list(course_runs)) serializer = self.get_serializer(page, many=True) return self.get_paginated_response(serializer.data) - def retrieve(self, request, *args, **kwargs): # lint-amnesty, pylint: disable=unused-argument + def retrieve(self, request, *args, **kwargs): # pylint: disable=unused-argument course_run = self.get_object() serializer = self.get_serializer(course_run) return Response(serializer.data) - def update(self, request, *args, **kwargs): # lint-amnesty, pylint: disable=missing-function-docstring, unused-argument + def update(self, request, *args, **kwargs): # pylint: disable=missing-function-docstring, unused-argument course_run = self.get_object() partial = kwargs.pop('partial', False) @@ -66,7 +66,7 @@ def partial_update(self, request, *args, **kwargs): kwargs['partial'] = True return self.update(request, *args, **kwargs) - def create(self, request, *args, **kwargs): # lint-amnesty, pylint: disable=unused-argument + def create(self, request, *args, **kwargs): # pylint: disable=unused-argument serializer = CourseRunCreateSerializer(data=request.data, context=self.get_serializer_context()) serializer.is_valid(raise_exception=True) serializer.save() @@ -77,7 +77,7 @@ def create(self, request, *args, **kwargs): # lint-amnesty, pylint: disable=unu methods=['post', 'put'], parser_classes=(parsers.FormParser, parsers.MultiPartParser,), serializer_class=CourseRunImageSerializer) - def images(self, request, *args, **kwargs): # lint-amnesty, pylint: disable=missing-function-docstring, unused-argument + def images(self, request, *args, **kwargs): # pylint: disable=missing-function-docstring, unused-argument course_run = self.get_object() serializer = CourseRunImageSerializer(course_run, data=request.data, context=self.get_serializer_context()) serializer.is_valid(raise_exception=True) @@ -85,7 +85,7 @@ def images(self, request, *args, **kwargs): # lint-amnesty, pylint: disable=mis return Response(serializer.data) @action(detail=True, methods=['post']) - def rerun(self, request, *args, **kwargs): # lint-amnesty, pylint: disable=missing-function-docstring, unused-argument + def rerun(self, request, *args, **kwargs): # pylint: disable=missing-function-docstring, unused-argument course_run = self.get_object() serializer = CourseRunRerunSerializer(course_run, data=request.data, context=self.get_serializer_context()) serializer.is_valid(raise_exception=True) @@ -94,7 +94,7 @@ def rerun(self, request, *args, **kwargs): # lint-amnesty, pylint: disable=miss return Response(serializer.data, status=status.HTTP_201_CREATED) @action(detail=False, methods=['post']) - def clone(self, request, *args, **kwargs): # lint-amnesty, pylint: disable=unused-argument + def clone(self, request, *args, **kwargs): # pylint: disable=unused-argument """ **Use Case** diff --git a/cms/djangoapps/cms_user_tasks/apps.py b/cms/djangoapps/cms_user_tasks/apps.py index c4ac938c6e5d..390fa453db58 100644 --- a/cms/djangoapps/cms_user_tasks/apps.py +++ b/cms/djangoapps/cms_user_tasks/apps.py @@ -17,4 +17,4 @@ def ready(self): """ Connect signal handlers. """ - from . import signals # pylint: disable=unused-import + from . import signals # pylint: disable=unused-import # noqa: F401 diff --git a/cms/djangoapps/cms_user_tasks/tests.py b/cms/djangoapps/cms_user_tasks/tests.py index 8a9bc5532101..9e4f91cb4979 100644 --- a/cms/djangoapps/cms_user_tasks/tests.py +++ b/cms/djangoapps/cms_user_tasks/tests.py @@ -77,7 +77,7 @@ class TestUserTasks(APITestCase): """ @classmethod - def setUpTestData(cls): # lint-amnesty, pylint: disable=super-method-not-called + def setUpTestData(cls): # pylint: disable=super-method-not-called cls.user = UserFactory.create(username='test_user', email='test@example.com', password='password') cls.status = UserTaskStatus.objects.create( user=cls.user, task_id=str(uuid4()), task_class='test_rest_api.sample_task', name='SampleTask 2', @@ -151,7 +151,7 @@ class TestUserTaskStopped(APITestCase): """ @classmethod - def setUpTestData(cls): # lint-amnesty, pylint: disable=super-method-not-called + def setUpTestData(cls): # pylint: disable=super-method-not-called cls.user = UserFactory.create(username='test_user', email='test@example.com', password='password') cls.status = UserTaskStatus.objects.create( user=cls.user, task_id=str(uuid4()), task_class='test_rest_api.sample_task', name='SampleTask 2', @@ -176,15 +176,15 @@ def create_olx_validation_artifact(self): def assert_msg_subject(self, msg): """Verify that msg subject is in expected format.""" - subject = "{platform_name} {studio_name}: Task Status Update".format( + subject = "{platform_name} {studio_name}: Task Status Update".format( # noqa: UP032 platform_name=settings.PLATFORM_NAME, studio_name=settings.STUDIO_NAME ) - self.assertEqual(msg.subject, subject) + self.assertEqual(msg.subject, subject) # noqa: PT009 def assert_msg_body_fragments(self, msg, body_fragments): """Verify that email body contains expected fragments""" for fragment in body_fragments: - self.assertIn(fragment, msg.body) + self.assertIn(fragment, msg.body) # noqa: PT009 def test_email_sent_with_site(self): """ @@ -201,7 +201,7 @@ def test_email_sent_with_site(self): reverse('usertaskstatus-detail', args=[self.status.uuid]) ] - self.assertEqual(len(mail.outbox), 1) + self.assertEqual(len(mail.outbox), 1) # noqa: PT009 msg = mail.outbox[0] @@ -216,7 +216,7 @@ def test_email_not_sent_with_libary_import_task(self): end_of_task_status.name = "bulk_migrate_from_modulestore" user_task_stopped.send(sender=UserTaskStatus, status=end_of_task_status) - self.assertEqual(len(mail.outbox), 0) + self.assertEqual(len(mail.outbox), 0) # noqa: PT009 def test_email_not_sent_with_libary_content_update(self): """ @@ -229,7 +229,7 @@ def test_email_not_sent_with_libary_content_update(self): end_of_task_status.name = "updating block-v1:course+type@library_content+block@uuid from library" user_task_stopped.send(sender=UserTaskStatus, status=end_of_task_status) - self.assertEqual(len(mail.outbox), 0) + self.assertEqual(len(mail.outbox), 0) # noqa: PT009 def test_email_not_sent_with_legacy_libary_content_ref_update(self): """ @@ -239,7 +239,7 @@ def test_email_not_sent_with_legacy_libary_content_ref_update(self): end_of_task_status.name = "Updating legacy library content blocks references of course-v1:UNIX+UN1+2025_T4" user_task_stopped.send(sender=UserTaskStatus, status=end_of_task_status) - self.assertEqual(len(mail.outbox), 0) + self.assertEqual(len(mail.outbox), 0) # noqa: PT009 def test_email_sent_with_olx_validations_with_config_enabled(self): """ @@ -258,7 +258,7 @@ def test_email_sent_with_olx_validations_with_config_enabled(self): user_task_stopped.send(sender=UserTaskStatus, status=self.status) msg = mail.outbox[0] - self.assertEqual(len(mail.outbox), 1) + self.assertEqual(len(mail.outbox), 1) # noqa: PT009 self.assert_msg_subject(msg) self.assert_msg_body_fragments(msg, body_fragments_with_validation) @@ -277,8 +277,8 @@ def test_email_sent_with_olx_validations_with_default_config(self): msg = mail.outbox[0] # Verify olx validation is not enabled out of the box. - self.assertFalse(settings.FEATURES.get('ENABLE_COURSE_OLX_VALIDATION')) - self.assertEqual(len(mail.outbox), 1) + self.assertFalse(settings.FEATURES.get('ENABLE_COURSE_OLX_VALIDATION')) # noqa: PT009 + self.assertEqual(len(mail.outbox), 1) # noqa: PT009 self.assert_msg_subject(msg) self.assert_msg_body_fragments(msg, body_fragments) @@ -298,11 +298,11 @@ def test_email_sent_with_olx_validations_with_bypass_flag(self): user_task_stopped.send(sender=UserTaskStatus, status=self.status) - self.assertEqual(len(mail.outbox), 1) + self.assertEqual(len(mail.outbox), 1) # noqa: PT009 msg = mail.outbox[0] self.assert_msg_subject(msg) self.assert_msg_body_fragments(msg, body_fragments) - self.assertNotIn("Here are some validations we found with your course content.", msg.body) + self.assertNotIn("Here are some validations we found with your course content.", msg.body) # noqa: PT009 def test_email_not_sent_for_child(self): """ @@ -312,7 +312,7 @@ def test_email_not_sent_for_child(self): user=self.user, task_id=str(uuid4()), task_class='test_rest_api.sample_task', name='SampleTask 2', total_steps=5, parent=self.status) user_task_stopped.send(sender=UserTaskStatus, status=child_status) - self.assertEqual(len(mail.outbox), 0) + self.assertEqual(len(mail.outbox), 0) # noqa: PT009 def test_email_sent_without_site(self): """ @@ -325,7 +325,7 @@ def test_email_sent_without_site(self): "Sign in to view the details of your task or download any files created." ] - self.assertEqual(len(mail.outbox), 1) + self.assertEqual(len(mail.outbox), 1) # noqa: PT009 msg = mail.outbox[0] self.assert_msg_subject(msg) @@ -342,7 +342,7 @@ def test_email_retries(self): with mock.patch('cms.djangoapps.cms_user_tasks.tasks.send_task_complete_email.retry') as mock_retry: user_task_stopped.send(sender=UserTaskStatus, status=self.status) - self.assertTrue(mock_retry.called) + self.assertTrue(mock_retry.called) # noqa: PT009 def test_queue_email_failure(self): logger = logging.getLogger("cms.djangoapps.cms_user_tasks.signals") @@ -354,5 +354,5 @@ def test_queue_email_failure(self): {'error_response': 'error occurred'}, {'operation_name': 'test'} ) user_task_stopped.send(sender=UserTaskStatus, status=self.status) - self.assertTrue(mock_delay.called) - self.assertEqual(hdlr.messages['error'][0], 'Unable to queue send_task_complete_email') + self.assertTrue(mock_delay.called) # noqa: PT009 + self.assertEqual(hdlr.messages['error'][0], 'Unable to queue send_task_complete_email') # noqa: PT009 diff --git a/cms/djangoapps/contentstore/api/__init__.py b/cms/djangoapps/contentstore/api/__init__.py index da36a1afe4d8..bbd94880dad0 100644 --- a/cms/djangoapps/contentstore/api/__init__.py +++ b/cms/djangoapps/contentstore/api/__init__.py @@ -1,2 +1,2 @@ """Contentstore API""" -from .views.utils import course_author_access_required, get_ready_to_migrate_legacy_library_content_blocks +from .views.utils import course_author_access_required, get_ready_to_migrate_legacy_library_content_blocks # noqa: F401 diff --git a/cms/djangoapps/contentstore/api/tests/base.py b/cms/djangoapps/contentstore/api/tests/base.py index a169c431e419..086ac06ac5fb 100644 --- a/cms/djangoapps/contentstore/api/tests/base.py +++ b/cms/djangoapps/contentstore/api/tests/base.py @@ -5,11 +5,10 @@ from django.urls import reverse from rest_framework.test import APITestCase -from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase -from xmodule.modulestore.tests.factories import CourseFactory, BlockFactory -from common.djangoapps.student.tests.factories import StaffFactory -from common.djangoapps.student.tests.factories import UserFactory +from common.djangoapps.student.tests.factories import StaffFactory, UserFactory +from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase +from xmodule.modulestore.tests.factories import BlockFactory, CourseFactory # pylint: disable=unused-variable @@ -18,6 +17,8 @@ class BaseCourseViewTest(SharedModuleStoreTestCase, APITestCase): Base test class for course data views. """ view_name = None # The name of the view to use in reverse() call in self.get_url() + course_key_arg_name = 'course_id' + extra_request_args = {} @classmethod def setUpClass(cls): @@ -65,7 +66,7 @@ def initialize_course(cls, course): parent_location=cls.section.location, category="sequential", ) - unit2 = BlockFactory.create( + unit2 = BlockFactory.create( # noqa: F841 parent_location=cls.subsection2.location, category="vertical", ) @@ -86,9 +87,10 @@ def get_url(self, course_id): """ Helper function to create the url """ + args = { + self.course_key_arg_name: course_id, + } return reverse( self.view_name, - kwargs={ - 'course_id': course_id - } + kwargs= args | self.extra_request_args ) diff --git a/cms/djangoapps/contentstore/api/tests/test_import.py b/cms/djangoapps/contentstore/api/tests/test_import.py index 0f989a8151c0..74236d8f5c54 100644 --- a/cms/djangoapps/contentstore/api/tests/test_import.py +++ b/cms/djangoapps/contentstore/api/tests/test_import.py @@ -12,12 +12,11 @@ from rest_framework import status from rest_framework.test import APITestCase from user_tasks.models import UserTaskStatus + +from common.djangoapps.student.tests.factories import StaffFactory, UserFactory from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase from xmodule.modulestore.tests.factories import CourseFactory -from common.djangoapps.student.tests.factories import StaffFactory -from common.djangoapps.student.tests.factories import UserFactory - class CourseImportViewTest(SharedModuleStoreTestCase, APITestCase): """ @@ -74,7 +73,7 @@ def test_anonymous_import_fails(self): """ with open(self.good_tar_fullpath, 'rb') as fp: resp = self.client.post(self.get_url(self.course_key), {'course_data': fp}, format='multipart') - self.assertEqual(resp.status_code, status.HTTP_401_UNAUTHORIZED) + self.assertEqual(resp.status_code, status.HTTP_401_UNAUTHORIZED) # noqa: PT009 def test_student_import_fails(self): """ @@ -83,7 +82,7 @@ def test_student_import_fails(self): self.client.login(username=self.student.username, password=self.password) with open(self.good_tar_fullpath, 'rb') as fp: resp = self.client.post(self.get_url(self.course_key), {'course_data': fp}, format='multipart') - self.assertEqual(resp.status_code, status.HTTP_403_FORBIDDEN) + self.assertEqual(resp.status_code, status.HTTP_403_FORBIDDEN) # noqa: PT009 def test_staff_with_access_import_succeeds(self): """ @@ -92,7 +91,7 @@ def test_staff_with_access_import_succeeds(self): self.client.login(username=self.staff.username, password=self.password) with open(self.good_tar_fullpath, 'rb') as fp: resp = self.client.post(self.get_url(self.course_key), {'course_data': fp}, format='multipart') - self.assertEqual(resp.status_code, status.HTTP_200_OK) + self.assertEqual(resp.status_code, status.HTTP_200_OK) # noqa: PT009 def test_staff_has_no_access_import_fails(self): """ @@ -101,7 +100,7 @@ def test_staff_has_no_access_import_fails(self): self.client.login(username=self.staff.username, password=self.password) with open(self.good_tar_fullpath, 'rb') as fp: resp = self.client.post(self.get_url(self.restricted_course_key), {'course_data': fp}, format='multipart') - self.assertEqual(resp.status_code, status.HTTP_403_FORBIDDEN) + self.assertEqual(resp.status_code, status.HTTP_403_FORBIDDEN) # noqa: PT009 def test_student_get_status_fails(self): """ @@ -109,14 +108,14 @@ def test_student_get_status_fails(self): """ self.client.login(username=self.student.username, password=self.password) resp = self.client.get(self.get_url(self.course_key), {'task_id': '1234', 'filename': self.good_tar_filename}) - self.assertEqual(resp.status_code, status.HTTP_403_FORBIDDEN) + self.assertEqual(resp.status_code, status.HTTP_403_FORBIDDEN) # noqa: PT009 def test_anonymous_get_status_fails(self): """ Test that an anonymous user cannot access the API and an error is received. """ resp = self.client.get(self.get_url(self.course_key), {'task_id': '1234', 'filename': self.good_tar_filename}) - self.assertEqual(resp.status_code, status.HTTP_401_UNAUTHORIZED) + self.assertEqual(resp.status_code, status.HTTP_401_UNAUTHORIZED) # noqa: PT009 def test_staff_get_status_succeeds(self): """ @@ -127,13 +126,13 @@ def test_staff_get_status_succeeds(self): self.client.login(username=self.staff.username, password=self.password) with open(self.good_tar_fullpath, 'rb') as fp: resp = self.client.post(self.get_url(self.course_key), {'course_data': fp}, format='multipart') - self.assertEqual(resp.status_code, status.HTTP_200_OK) + self.assertEqual(resp.status_code, status.HTTP_200_OK) # noqa: PT009 resp = self.client.get( self.get_url(self.course_key), {'task_id': resp.data['task_id'], 'filename': self.good_tar_filename}, format='multipart' ) - self.assertEqual(resp.data['state'], UserTaskStatus.SUCCEEDED) + self.assertEqual(resp.data['state'], UserTaskStatus.SUCCEEDED) # noqa: PT009 def test_staff_no_access_get_status_fails(self): """ @@ -144,7 +143,7 @@ def test_staff_no_access_get_status_fails(self): self.client.login(username=self.staff.username, password=self.password) with open(self.good_tar_fullpath, 'rb') as fp: resp = self.client.post(self.get_url(self.course_key), {'course_data': fp}, format='multipart') - self.assertEqual(resp.status_code, status.HTTP_200_OK) + self.assertEqual(resp.status_code, status.HTTP_200_OK) # noqa: PT009 task_id = resp.data['task_id'] resp = self.client.get( @@ -152,7 +151,7 @@ def test_staff_no_access_get_status_fails(self): {'task_id': task_id, 'filename': self.good_tar_filename}, format='multipart' ) - self.assertEqual(resp.data['state'], UserTaskStatus.SUCCEEDED) + self.assertEqual(resp.data['state'], UserTaskStatus.SUCCEEDED) # noqa: PT009 self.client.logout() @@ -162,7 +161,7 @@ def test_staff_no_access_get_status_fails(self): {'task_id': task_id, 'filename': self.good_tar_filename}, format='multipart' ) - self.assertEqual(resp.status_code, status.HTTP_403_FORBIDDEN) + self.assertEqual(resp.status_code, status.HTTP_403_FORBIDDEN) # noqa: PT009 def test_course_task_mismatch_get_status_fails(self): """ @@ -173,7 +172,7 @@ def test_course_task_mismatch_get_status_fails(self): self.client.login(username=self.staff.username, password=self.password) with open(self.good_tar_fullpath, 'rb') as fp: resp = self.client.post(self.get_url(self.course_key), {'course_data': fp}, format='multipart') - self.assertEqual(resp.status_code, status.HTTP_200_OK) + self.assertEqual(resp.status_code, status.HTTP_200_OK) # noqa: PT009 task_id = resp.data['task_id'] resp = self.client.get( @@ -181,4 +180,4 @@ def test_course_task_mismatch_get_status_fails(self): {'task_id': task_id, 'filename': self.good_tar_filename}, format='multipart' ) - self.assertEqual(resp.status_code, status.HTTP_403_FORBIDDEN) + self.assertEqual(resp.status_code, status.HTTP_403_FORBIDDEN) # noqa: PT009 diff --git a/cms/djangoapps/contentstore/api/tests/test_quality.py b/cms/djangoapps/contentstore/api/tests/test_quality.py index 8625cbeb55e5..0efab43972f6 100644 --- a/cms/djangoapps/contentstore/api/tests/test_quality.py +++ b/cms/djangoapps/contentstore/api/tests/test_quality.py @@ -2,8 +2,12 @@ Tests for the course import API views """ - +from openedx_authz.constants.roles import COURSE_DATA_RESEARCHER, COURSE_STAFF from rest_framework import status +from rest_framework.test import APIClient + +from common.djangoapps.student.tests.factories import UserFactory +from openedx.core.djangoapps.authz.tests.mixins import CourseAuthzTestMixin from .base import BaseCourseViewTest @@ -17,7 +21,7 @@ class CourseQualityViewTest(BaseCourseViewTest): def test_staff_succeeds(self): self.client.login(username=self.staff.username, password=self.password) resp = self.client.get(self.get_url(self.course_key), {'all': 'true'}) - self.assertEqual(resp.status_code, status.HTTP_200_OK) + self.assertEqual(resp.status_code, status.HTTP_200_OK) # noqa: PT009 expected_data = { 'units': { 'num_blocks': { @@ -61,9 +65,69 @@ def test_staff_succeeds(self): }, 'is_self_paced': True, } - self.assertDictEqual(resp.data, expected_data) + self.assertDictEqual(resp.data, expected_data) # noqa: PT009 def test_student_fails(self): self.client.login(username=self.student.username, password=self.password) resp = self.client.get(self.get_url(self.course_key)) - self.assertEqual(resp.status_code, status.HTTP_403_FORBIDDEN) + self.assertEqual(resp.status_code, status.HTTP_403_FORBIDDEN) # noqa: PT009 + + +class CourseQualityAuthzTest(CourseAuthzTestMixin, BaseCourseViewTest): + """ + Tests Course Quality API authorization using openedx-authz. + The endpoint uses COURSES_VIEW_COURSE permission. + """ + + view_name = "courses_api:course_quality" + authz_roles_to_assign = [COURSE_STAFF.external_key] + + def test_authorized_user_can_access(self): + """User with COURSE_STAFF role can access.""" + resp = self.authorized_client.get(self.get_url(self.course_key)) + self.assertEqual(resp.status_code, status.HTTP_200_OK) # noqa: PT009 + + def test_unauthorized_user_cannot_access(self): + """User without role cannot access.""" + resp = self.unauthorized_client.get(self.get_url(self.course_key)) + self.assertEqual(resp.status_code, status.HTTP_403_FORBIDDEN) # noqa: PT009 + + def test_role_scoped_to_course(self): + """Authorization should only apply to the assigned course.""" + other_course = self.store.create_course("OtherOrg", "OtherCourse", "Run", self.staff.id) + + resp = self.authorized_client.get(self.get_url(other_course.id)) + self.assertEqual(resp.status_code, status.HTTP_403_FORBIDDEN) # noqa: PT009 + + def test_staff_user_allowed_via_legacy(self): + """ + Staff users should still pass through legacy fallback. + """ + self.client.login(username=self.staff.username, password=self.password) + + resp = self.client.get(self.get_url(self.course_key)) + self.assertEqual(resp.status_code, status.HTTP_200_OK) # noqa: PT009 + + def test_superuser_allowed(self): + """Superusers should always be allowed.""" + superuser = UserFactory(is_superuser=True) + + client = APIClient() + client.force_authenticate(user=superuser) + + resp = client.get(self.get_url(self.course_key)) + self.assertEqual(resp.status_code, status.HTTP_200_OK) # noqa: PT009 + + def test_non_staff_user_cannot_access(self): + """ + User without permissions should be denied. + This case validates that a non-staff user cannot access even + if they have course author access to the course. + """ + non_staff_user = UserFactory() + non_staff_client = APIClient() + self.add_user_to_role(non_staff_user, COURSE_DATA_RESEARCHER.external_key) + non_staff_client.force_authenticate(user=non_staff_user) + + resp = non_staff_client.get(self.get_url(self.course_key)) + self.assertEqual(resp.status_code, status.HTTP_403_FORBIDDEN) # noqa: PT009 diff --git a/cms/djangoapps/contentstore/api/tests/test_validation.py b/cms/djangoapps/contentstore/api/tests/test_validation.py index 8bf8e19b626c..a34faf516219 100644 --- a/cms/djangoapps/contentstore/api/tests/test_validation.py +++ b/cms/djangoapps/contentstore/api/tests/test_validation.py @@ -11,12 +11,15 @@ from django.contrib.auth import get_user_model from django.test.utils import override_settings from django.urls import reverse +from openedx_authz.constants.roles import COURSE_DATA_RESEARCHER, COURSE_EDITOR, COURSE_STAFF from rest_framework import status -from rest_framework.test import APITestCase +from rest_framework.test import APIClient, APITestCase +from cms.djangoapps.contentstore.api.tests.base import BaseCourseViewTest from common.djangoapps.course_modes.models import CourseMode from common.djangoapps.course_modes.tests.factories import CourseModeFactory from common.djangoapps.student.tests.factories import StaffFactory, UserFactory +from openedx.core.djangoapps.authz.tests.mixins import CourseAuthoringAuthzTestMixin, CourseAuthzTestMixin from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase from xmodule.modulestore.tests.factories import BlockFactory, CourseFactory @@ -93,7 +96,7 @@ def get_url(self, course_id): def test_student_fails(self): self.client.login(username=self.student.username, password=self.password) resp = self.client.get(self.get_url(self.course_key)) - self.assertEqual(resp.status_code, status.HTTP_403_FORBIDDEN) + self.assertEqual(resp.status_code, status.HTTP_403_FORBIDDEN) # noqa: PT009 @ddt.data( (False, False), @@ -113,7 +116,7 @@ def test_staff_succeeds(self, certs_html_view, with_modes): ) self.client.login(username=self.staff.username, password=self.password) resp = self.client.get(self.get_url(self.course_key), {'all': 'true'}) - self.assertEqual(resp.status_code, status.HTTP_200_OK) + self.assertEqual(resp.status_code, status.HTTP_200_OK) # noqa: PT009 expected_data = { 'assignments': { 'total_number': 1, @@ -145,7 +148,7 @@ def test_staff_succeeds(self, certs_html_view, with_modes): }, 'is_self_paced': True, } - self.assertDictEqual(resp.data, expected_data) + self.assertDictEqual(resp.data, expected_data) # noqa: PT009 class TestMigrationViewSetCreate(SharedModuleStoreTestCase, APITestCase): @@ -244,7 +247,7 @@ def test_create_update_reference_success(self, mock_block, mock_user_task_status mock_auth.assert_called_once() - @patch('cms.djangoapps.contentstore.api.views.utils.has_course_author_access') + @patch('openedx.core.djangoapps.authz.decorators.user_has_course_permission') @patch('xmodule.library_content_block.LegacyLibraryContentBlock.is_ready_to_migrate_to_v2') def test_list_ready_to_update_reference_success(self, mock_block, mock_auth): """ @@ -267,8 +270,166 @@ def test_list_ready_to_update_reference_success(self, mock_block, mock_auth): assert response.status_code == status.HTTP_200_OK data = response.json() - self.assertListEqual(data, [ + self.assertListEqual(data, [ # noqa: PT009 {'usage_key': str(self.block1.location)}, {'usage_key': str(self.block2.location)}, ]) mock_auth.assert_called_once() + + +class CourseValidationAuthzTest(CourseAuthzTestMixin, BaseCourseViewTest): + """ + Tests Course Validation API authorization using openedx-authz. + The endpoint uses COURSES_VIEW_COURSE permission. + """ + + view_name = "courses_api:course_validation" + authz_roles_to_assign = [COURSE_STAFF.external_key] + + def test_authorized_user_can_access(self): + """ + User with COURSE_STAFF role should be allowed via AuthZ. + """ + resp = self.authorized_client.get(self.get_url(self.course_key)) + + self.assertEqual(resp.status_code, status.HTTP_200_OK) # noqa: PT009 + + def test_unauthorized_user_cannot_access(self): + """ + User without permissions should be denied. + """ + resp = self.unauthorized_client.get(self.get_url(self.course_key)) + + self.assertEqual(resp.status_code, status.HTTP_403_FORBIDDEN) # noqa: PT009 + + def test_role_scoped_to_course(self): + """ + Authorization should only apply to the assigned course scope. + """ + other_course = self.store.create_course( + "OtherOrg", + "OtherCourse", + "Run", + self.staff.id, + ) + + resp = self.authorized_client.get(self.get_url(other_course.id)) + + self.assertEqual(resp.status_code, status.HTTP_403_FORBIDDEN) # noqa: PT009 + + def test_staff_user_allowed_via_legacy(self): + """ + Course staff should pass through legacy fallback when AuthZ denies. + """ + self.client.login(username=self.staff.username, password=self.password) + + resp = self.client.get(self.get_url(self.course_key)) + + self.assertEqual(resp.status_code, status.HTTP_200_OK) # noqa: PT009 + + def test_superuser_allowed(self): + """ + Superusers should always be allowed through legacy fallback. + """ + superuser = UserFactory(is_superuser=True) + + client = APIClient() + client.force_authenticate(user=superuser) + + resp = client.get(self.get_url(self.course_key)) + + self.assertEqual(resp.status_code, status.HTTP_200_OK) # noqa: PT009 + + def test_non_staff_user_cannot_access(self): + """ + User without permissions should be denied. + This case validates that a non-staff user cannot access even + if they have course author access to the course. + """ + non_staff_user = UserFactory() + non_staff_client = APIClient() + self.add_user_to_role(non_staff_user, COURSE_DATA_RESEARCHER.external_key) + non_staff_client.force_authenticate(user=non_staff_user) + + resp = non_staff_client.get(self.get_url(self.course_key)) + self.assertEqual(resp.status_code, status.HTTP_403_FORBIDDEN) # noqa: PT009 + + +class TestMigrationViewSetCreateAuthz( + CourseAuthoringAuthzTestMixin, + SharedModuleStoreTestCase, + APITestCase, +): + """ + AuthZ tests for: + /api/courses/v1/migrate_legacy_content_blocks// + """ + + @classmethod + def setUpClass(cls): + super().setUpClass() + + cls.course = CourseFactory.create( + display_name='test course', + run="Testing_course", + ) + cls.course_key = cls.course.id + + cls.initialize_course(cls.course) + + @classmethod + def initialize_course(cls, course): + """Sets up test course structure.""" + section = BlockFactory.create( + parent_location=course.location, + category="chapter", + ) + subsection = BlockFactory.create( + parent_location=section.location, + category="sequential", + ) + unit = BlockFactory.create( + parent_location=subsection.location, + category="vertical", + ) + BlockFactory.create( + parent_location=unit.location, + category="library_content", + ) + + def url(self): + return f"/api/courses/v1/migrate_legacy_content_blocks/{self.course_key}/" + + # ---- GET (list) ---- + + def test_authorized_user_can_list_blocks(self): + """Authorized user can list migratable blocks.""" + self.add_user_to_role_in_course( + self.authorized_user, + COURSE_EDITOR.external_key, + self.course.id, + ) + + response = self.authorized_client.get(self.url()) + + assert response.status_code == status.HTTP_200_OK + + def test_unauthorized_user_cannot_list_blocks(self): + """Unauthorized user should receive 403.""" + response = self.unauthorized_client.get(self.url()) + + assert response.status_code == status.HTTP_403_FORBIDDEN + + # ---- elevated users ---- + + def test_staff_user_can_access_without_authz_role(self): + """Staff user bypasses AuthZ.""" + response = self.staff_client.get(self.url()) + + assert response.status_code == status.HTTP_200_OK + + def test_superuser_can_access_without_authz_role(self): + """Superuser bypasses AuthZ.""" + response = self.super_client.get(self.url()) + + assert response.status_code in [status.HTTP_200_OK, status.HTTP_201_CREATED] diff --git a/cms/djangoapps/contentstore/api/views/course_import.py b/cms/djangoapps/contentstore/api/views/course_import.py index 3027b1926d0f..f2f8f168df50 100644 --- a/cms/djangoapps/contentstore/api/views/course_import.py +++ b/cms/djangoapps/contentstore/api/views/course_import.py @@ -155,7 +155,7 @@ def post(self, request, course_key): }) except Exception as e: log.exception(f'Course import {course_key}: Unknown error in import') - raise self.api_error( + raise self.api_error( # noqa: B904 status_code=status.HTTP_500_INTERNAL_SERVER_ERROR, developer_message=str(e), error_code='internal_error' @@ -177,7 +177,7 @@ def get(self, request, course_key): }) except Exception as e: log.exception(str(e)) - raise self.api_error( + raise self.api_error( # noqa: B904 status_code=status.HTTP_500_INTERNAL_SERVER_ERROR, developer_message=str(e), error_code='internal_error' diff --git a/cms/djangoapps/contentstore/api/views/course_quality.py b/cms/djangoapps/contentstore/api/views/course_quality.py index b301f5ac1420..123fc1ea0d0f 100644 --- a/cms/djangoapps/contentstore/api/views/course_quality.py +++ b/cms/djangoapps/contentstore/api/views/course_quality.py @@ -1,19 +1,22 @@ -# lint-amnesty, pylint: disable=missing-module-docstring +# pylint: disable=missing-module-docstring import logging import time import numpy as np from edxval.api import get_course_videos_qset +from openedx_authz.constants.permissions import COURSES_VIEW_COURSE from rest_framework.generics import GenericAPIView from rest_framework.response import Response from scipy import stats +from openedx.core.djangoapps.authz.constants import LegacyAuthoringPermission +from openedx.core.djangoapps.authz.decorators import authz_permission_required from openedx.core.lib.api.view_utils import DeveloperErrorViewMixin, view_auth_classes from openedx.core.lib.cache_utils import request_cached from openedx.core.lib.graph_traversals import traverse_pre_order -from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order -from .utils import course_author_access_required, get_bool_param +from .utils import get_bool_param log = logging.getLogger(__name__) @@ -82,7 +85,7 @@ class CourseQualityView(DeveloperErrorViewMixin, GenericAPIView): # does not specify a serializer class. swagger_schema = None - @course_author_access_required + @authz_permission_required(COURSES_VIEW_COURSE.identifier, LegacyAuthoringPermission.READ) def get(self, request, course_key): """ Returns validation information for the given course. @@ -132,7 +135,7 @@ def _execute_method_and_log_time(log_time, func, *args): return Response(response) - def _required_course_depth(self, request, all_requested): # lint-amnesty, pylint: disable=missing-function-docstring + def _required_course_depth(self, request, all_requested): # pylint: disable=missing-function-docstring if get_bool_param(request, 'units', all_requested): # The num_blocks metric for "units" requires retrieving all blocks in the graph. return None @@ -155,7 +158,7 @@ def _sections_quality(self, course): highlights_enabled=True, # used to be controlled by a waffle switch, now just always enabled ) - def _subsections_quality(self, course, request): # lint-amnesty, pylint: disable=missing-function-docstring + def _subsections_quality(self, course, request): # pylint: disable=missing-function-docstring subsection_unit_dict = self._get_subsections_and_units(course, request) num_block_types_per_subsection_dict = {} for subsection_key, unit_dict in subsection_unit_dict.items(): @@ -171,7 +174,7 @@ def _subsections_quality(self, course, request): # lint-amnesty, pylint: disabl num_block_types=self._stats_dict(list(num_block_types_per_subsection_dict.values())), ) - def _units_quality(self, course, request): # lint-amnesty, pylint: disable=missing-function-docstring + def _units_quality(self, course, request): # pylint: disable=missing-function-docstring subsection_unit_dict = self._get_subsections_and_units(course, request) num_leaf_blocks_per_unit = [ unit_info['num_leaf_blocks'] @@ -183,7 +186,7 @@ def _units_quality(self, course, request): # lint-amnesty, pylint: disable=miss num_blocks=self._stats_dict(num_leaf_blocks_per_unit), ) - def _videos_quality(self, course): # lint-amnesty, pylint: disable=missing-function-docstring + def _videos_quality(self, course): # pylint: disable=missing-function-docstring video_blocks_in_course = modulestore().get_items(course.id, qualifiers={'category': 'video'}) video_durations = [cv.video.duration for cv in get_course_videos_qset(course.id)] @@ -229,7 +232,7 @@ def _get_sections(cls, course): return cls._get_all_children(course) @classmethod - def _get_all_children(cls, parent): # lint-amnesty, pylint: disable=missing-function-docstring + def _get_all_children(cls, parent): # pylint: disable=missing-function-docstring store = modulestore() children = [store.get_item(child_usage_key) for child_usage_key in cls._get_children(parent)] visible_children = [ @@ -244,14 +247,14 @@ def _get_visible_children(cls, parent): return visible_chidren @classmethod - def _get_children(cls, parent): # lint-amnesty, pylint: disable=missing-function-docstring + def _get_children(cls, parent): # pylint: disable=missing-function-docstring if not hasattr(parent, 'children'): return [] else: return parent.children @classmethod - def _get_leaf_blocks(cls, unit): # lint-amnesty, pylint: disable=missing-function-docstring + def _get_leaf_blocks(cls, unit): # pylint: disable=missing-function-docstring def leaf_filter(block): return ( block.location.block_type not in ('chapter', 'sequential', 'vertical') and @@ -260,7 +263,7 @@ def leaf_filter(block): return list(traverse_pre_order(unit, cls._get_visible_children, leaf_filter)) - def _stats_dict(self, data): # lint-amnesty, pylint: disable=missing-function-docstring + def _stats_dict(self, data): # pylint: disable=missing-function-docstring if not data: return dict( min=None, diff --git a/cms/djangoapps/contentstore/api/views/course_validation.py b/cms/djangoapps/contentstore/api/views/course_validation.py index d3565fc1688d..668431fa0e50 100644 --- a/cms/djangoapps/contentstore/api/views/course_validation.py +++ b/cms/djangoapps/contentstore/api/views/course_validation.py @@ -1,10 +1,11 @@ -# lint-amnesty, pylint: disable=missing-module-docstring +# pylint: disable=missing-module-docstring import logging import dateutil import edx_api_doc_tools as apidocs from edx_rest_framework_extensions.auth.jwt.authentication import JwtAuthentication from edx_rest_framework_extensions.auth.session.authentication import SessionAuthenticationAllowInactiveUser +from openedx_authz.constants.permissions import COURSES_VIEW_COURSE from pytz import UTC from rest_framework import serializers, status from rest_framework.generics import GenericAPIView @@ -16,11 +17,13 @@ from cms.djangoapps.contentstore.tasks import migrate_course_legacy_library_blocks_to_item_bank from cms.djangoapps.contentstore.views.certificates import CertificateManager from common.djangoapps.util.proctoring import requires_escalation_email +from openedx.core.djangoapps.authz.constants import LegacyAuthoringPermission +from openedx.core.djangoapps.authz.decorators import authz_permission_required from openedx.core.lib.api.authentication import BearerAuthenticationAllowInactiveUser from openedx.core.lib.api.serializers import StatusSerializerWithUuid from openedx.core.lib.api.view_utils import DeveloperErrorViewMixin, view_auth_classes -from xmodule.course_metadata_utils import DEFAULT_GRADING_POLICY # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.course_metadata_utils import DEFAULT_GRADING_POLICY # pylint: disable=wrong-import-order +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order from .utils import course_author_access_required, get_bool_param, get_ready_to_migrate_legacy_library_content_blocks @@ -80,7 +83,7 @@ class CourseValidationView(DeveloperErrorViewMixin, GenericAPIView): # does not specify a serializer class. swagger_schema = None - @course_author_access_required + @authz_permission_required(COURSES_VIEW_COURSE.identifier, LegacyAuthoringPermission.READ) def get(self, request, course_key): """ Returns validation information for the given course. @@ -133,7 +136,7 @@ def _dates_validation(self, course): has_end_date=course.end is not None, ) - def _assignments_validation(self, course, request): # lint-amnesty, pylint: disable=missing-function-docstring + def _assignments_validation(self, course, request): # pylint: disable=missing-function-docstring assignments, visible_assignments = self._get_assignments(course) assignments_with_dates = [ a for a in visible_assignments if a.due @@ -241,7 +244,7 @@ def _updates_validation(self, course, request): has_update=len(updates) > 0, ) - def _get_assignments(self, course): # lint-amnesty, pylint: disable=missing-function-docstring + def _get_assignments(self, course): # pylint: disable=missing-function-docstring store = modulestore() sections = [store.get_item(section_usage_key) for section_usage_key in course.children] assignments = [ @@ -268,7 +271,7 @@ def _get_open_responses(self, course, graded_only): oras = modulestore().get_items(course.id, qualifiers={'category': 'openassessment'}) return oras if not graded_only else [ora for ora in oras if ora.graded] - def _has_date_before_start(self, ora, start): # lint-amnesty, pylint: disable=missing-function-docstring + def _has_date_before_start(self, ora, start): # pylint: disable=missing-function-docstring if ora.submission_start: if dateutil.parser.parse(ora.submission_start).replace(tzinfo=UTC) < start: return True @@ -285,7 +288,7 @@ def _has_date_before_start(self, ora, start): # lint-amnesty, pylint: disable=m return False - def _has_date_after_end(self, ora, end): # lint-amnesty, pylint: disable=missing-function-docstring + def _has_date_after_end(self, ora, end): # pylint: disable=missing-function-docstring if ora.submission_start: if dateutil.parser.parse(ora.submission_start).replace(tzinfo=UTC) > end: return True @@ -304,7 +307,7 @@ def _has_date_after_end(self, ora, end): # lint-amnesty, pylint: disable=missin def _has_start_date(self, course): return not course.start_date_is_still_default - def _has_grading_policy(self, course): # lint-amnesty, pylint: disable=missing-function-docstring + def _has_grading_policy(self, course): # pylint: disable=missing-function-docstring grading_policy_formatted = {} default_grading_policy_formatted = {} @@ -361,7 +364,7 @@ class CourseLegacyLibraryContentSerializer(serializers.Serializer): usage_key = serializers.CharField() -class CourseLegacyLibraryContentMigratorView(StatusViewSet): +class CourseLegacyLibraryContentMigratorView(DeveloperErrorViewMixin, StatusViewSet): """ This endpoint is used for migrating legacy library content to the new item bank block library v2. """ @@ -381,7 +384,7 @@ class CourseLegacyLibraryContentMigratorView(StatusViewSet): 401: "The requester is not authenticated.", }, ) - @course_author_access_required + @authz_permission_required(COURSES_VIEW_COURSE.identifier, LegacyAuthoringPermission.WRITE) def list(self, _, course_key): # pylint: disable=arguments-differ """ Returns all legacy library content blocks ready to be migrated to new item bank block. diff --git a/cms/djangoapps/contentstore/api/views/utils.py b/cms/djangoapps/contentstore/api/views/utils.py index 5d7dd8ff06d1..57d3ae30497b 100644 --- a/cms/djangoapps/contentstore/api/views/utils.py +++ b/cms/djangoapps/contentstore/api/views/utils.py @@ -14,7 +14,7 @@ from openedx.core.lib.api.view_utils import DeveloperErrorViewMixin, view_auth_classes from openedx.core.lib.cache_utils import request_cached from xmodule.library_content_block import LegacyLibraryContentBlock -from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order @view_auth_classes() @@ -120,7 +120,7 @@ def course_author_access_required(view): Usage:: @course_author_access_required def my_view(request, course_key): - # Some functionality ... + # Some functionality... """ def _wrapper_view(self, request, course_id, *args, **kwargs): """ diff --git a/cms/djangoapps/contentstore/apps.py b/cms/djangoapps/contentstore/apps.py index a1ff02e4cabc..93818066a3ee 100644 --- a/cms/djangoapps/contentstore/apps.py +++ b/cms/djangoapps/contentstore/apps.py @@ -20,4 +20,4 @@ def ready(self): """ # Can't import models at module level in AppConfigs, and models get # included from the signal handlers - from .signals import handlers # pylint: disable=unused-import + from .signals import handlers # pylint: disable=unused-import # noqa: F401 diff --git a/cms/djangoapps/contentstore/asset_storage_handlers.py b/cms/djangoapps/contentstore/asset_storage_handlers.py index 2489be61bae3..6c84311b4574 100644 --- a/cms/djangoapps/contentstore/asset_storage_handlers.py +++ b/cms/djangoapps/contentstore/asset_storage_handlers.py @@ -17,25 +17,32 @@ from django.views.decorators.csrf import ensure_csrf_cookie from django.views.decorators.http import require_http_methods, require_POST from opaque_keys.edx.keys import AssetKey, CourseKey +from openedx_authz.constants.permissions import ( + COURSES_CREATE_FILES, + COURSES_DELETE_FILES, + COURSES_EDIT_FILES, + COURSES_VIEW_FILES, +) +from openedx_filters.content_authoring.filters import LMSPageURLRequested from pymongo import ASCENDING, DESCENDING -from common.djangoapps.student.auth import has_course_author_access from common.djangoapps.util.date_utils import get_default_time_display from common.djangoapps.util.json_request import JsonResponse +from openedx.core.djangoapps.authz.constants import LegacyAuthoringPermission +from openedx.core.djangoapps.authz.decorators import user_has_course_permission from openedx.core.djangoapps.contentserver.caching import del_cached_content from openedx.core.djangoapps.site_configuration import helpers as configuration_helpers from openedx.core.djangoapps.user_api.models import UserPreference -from openedx_filters.content_authoring.filters import LMSPageURLRequested -from xmodule.contentstore.content import StaticContent # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.contentstore.django import contentstore # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.exceptions import NotFoundError # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.exceptions import ItemNotFoundError # lint-amnesty, pylint: disable=wrong-import-order +from openedx.core.toggles import enable_authz_course_authoring +from xmodule.contentstore.content import StaticContent # pylint: disable=wrong-import-order +from xmodule.contentstore.django import contentstore # pylint: disable=wrong-import-order +from xmodule.exceptions import NotFoundError # pylint: disable=wrong-import-order +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order +from xmodule.modulestore.exceptions import ItemNotFoundError # pylint: disable=wrong-import-order from .exceptions import AssetNotFoundException, AssetSizeTooLargeException from .utils import get_files_uploads_url, get_response_format, request_response_format_is_json - REQUEST_DEFAULTS = { 'page': 0, 'page_size': 50, @@ -73,8 +80,8 @@ def handle_assets(request, course_key_string=None, asset_key_string=None): json: delete an asset ''' course_key = CourseKey.from_string(course_key_string) - if not has_course_author_access(request.user, course_key): - raise PermissionDenied() + # Enforce file permissions. + _authz_enforce_file_permissions(request, course_key) response_format = get_response_format(request) if request_response_format_is_json(request, response_format): @@ -91,12 +98,60 @@ def handle_assets(request, course_key_string=None, asset_key_string=None): return HttpResponseNotFound() +def _authz_enforce_file_permissions(request, course_key): + """ + Enforce permissions for file operations in asset handler. + When the authz.enable_course_authoring flag is enabled for the specified course, + This function enforces the appropriate file permission depending on request content. + When the flag is disabled, it enforces the legacy has_studio_write_access permission. + """ + # Enforce permission to view files. + # This is the minimum permission needed for handling assets. + if not user_has_course_permission( + request.user, + COURSES_VIEW_FILES.identifier, + course_key, + LegacyAuthoringPermission.WRITE + ): + raise PermissionDenied() + + if enable_authz_course_authoring(course_key): + # Check create, edit and delete permissions for AuthZ-enabled courses. + if request.method in ('PUT', 'POST'): + permission = ( + COURSES_CREATE_FILES.identifier + if 'file' in request.FILES + else COURSES_EDIT_FILES.identifier + ) + + if not user_has_course_permission( + request.user, + permission, + course_key, + LegacyAuthoringPermission.WRITE + ): + raise PermissionDenied() + + if request.method == 'DELETE' and not user_has_course_permission( + request.user, + COURSES_DELETE_FILES.identifier, + course_key, + LegacyAuthoringPermission.WRITE + ): + raise PermissionDenied() + + def get_asset_usage_path_json(request, course_key, asset_key_string): """ Get a list of units with ancestors that use given asset. """ course_key = CourseKey.from_string(course_key) - if not has_course_author_access(request.user, course_key): + if not user_has_course_permission( + request.user, + COURSES_VIEW_FILES.identifier, + course_key, + LegacyAuthoringPermission.WRITE + ): raise PermissionDenied() asset_location = AssetKey.from_string(asset_key_string) if asset_key_string else None usage_locations = _get_asset_usage_path(course_key, [{'asset_key': asset_location}]) @@ -214,7 +269,7 @@ def _assets_json(request, course_key): assets_usage_locations_map = _get_asset_usage_path(course_key, assets) - if request_options['requested_page'] > 0 and first_asset_to_display_index >= total_count and total_count > 0: # lint-amnesty, pylint: disable=chained-comparison + if request_options['requested_page'] > 0 and first_asset_to_display_index >= total_count and total_count > 0: # pylint: disable=chained-comparison _update_options_to_requery_final_page(query_options, total_count) current_page = query_options['current_page'] first_asset_to_display_index = _get_first_asset_index(current_page, requested_page_size) @@ -275,7 +330,7 @@ def _get_error_if_invalid_parameters(requested_filter): if invalid_filters: error_message = { 'error_code': 'invalid_asset_type_filter', - 'developer_message': 'The asset_type parameter to the request is invalid. ' + 'developer_message': 'The asset_type parameter to the request is invalid. ' # noqa: UP032 'The {} filters are not described in the settings.FILES_AND_UPLOAD_TYPE_FILTERS ' 'dictionary.'.format(invalid_filters) } @@ -536,7 +591,7 @@ def _upload_asset(request, course_key): }) -def _get_error_if_course_does_not_exist(course_key): # lint-amnesty, pylint: disable=missing-function-docstring +def _get_error_if_course_does_not_exist(course_key): # pylint: disable=missing-function-docstring try: modulestore().get_course(course_key) except ItemNotFoundError: @@ -544,7 +599,7 @@ def _get_error_if_course_does_not_exist(course_key): # lint-amnesty, pylint: di return HttpResponseBadRequest() -def _get_file_metadata_as_dictionary(upload_file): # lint-amnesty, pylint: disable=missing-function-docstring +def _get_file_metadata_as_dictionary(upload_file): # pylint: disable=missing-function-docstring # compute a 'filename' which is similar to the location formatting; we're # using the 'filename' nomenclature since we're using a FileSystem paradigm # here; we're just imposing the Location string formatting expectations to @@ -672,15 +727,15 @@ def delete_asset(course_key, asset_key): del_cached_content(content.location) -def _check_existence_and_get_asset_content(asset_key): # lint-amnesty, pylint: disable=missing-function-docstring +def _check_existence_and_get_asset_content(asset_key): # pylint: disable=missing-function-docstring try: content = contentstore().find(asset_key) return content except NotFoundError: - raise AssetNotFoundException # lint-amnesty, pylint: disable=raise-missing-from + raise AssetNotFoundException # pylint: disable=raise-missing-from # noqa: B904 -def _delete_thumbnail(thumbnail_location, course_key, asset_key): # lint-amnesty, pylint: disable=missing-function-docstring +def _delete_thumbnail(thumbnail_location, course_key, asset_key): # pylint: disable=missing-function-docstring if thumbnail_location is not None: # We are ignoring the value of the thumbnail_location-- we only care whether diff --git a/cms/djangoapps/contentstore/config/waffle.py b/cms/djangoapps/contentstore/config/waffle.py index 40d11817667e..d0f6033022e5 100644 --- a/cms/djangoapps/contentstore/config/waffle.py +++ b/cms/djangoapps/contentstore/config/waffle.py @@ -13,12 +13,12 @@ LOG_PREFIX = 'Studio: ' # Switches -ENABLE_ACCESSIBILITY_POLICY_PAGE = WaffleSwitch( # lint-amnesty, pylint: disable=toggle-missing-annotation +ENABLE_ACCESSIBILITY_POLICY_PAGE = WaffleSwitch( # pylint: disable=toggle-missing-annotation f'{WAFFLE_NAMESPACE}.enable_policy_page', __name__ ) # TODO: After removing this flag, add a migration to remove waffle flag in a follow-up deployment. -ENABLE_CHECKLISTS_QUALITY = CourseWaffleFlag( # lint-amnesty, pylint: disable=toggle-missing-annotation +ENABLE_CHECKLISTS_QUALITY = CourseWaffleFlag( # pylint: disable=toggle-missing-annotation f'{WAFFLE_NAMESPACE}.enable_checklists_quality', __name__, LOG_PREFIX ) diff --git a/cms/djangoapps/contentstore/core/course_optimizer_provider.py b/cms/djangoapps/contentstore/core/course_optimizer_provider.py index 134329992cfe..434d8729e77e 100644 --- a/cms/djangoapps/contentstore/core/course_optimizer_provider.py +++ b/cms/djangoapps/contentstore/core/course_optimizer_provider.py @@ -11,7 +11,7 @@ CourseLinkCheckTask, CourseLinkUpdateTask, LinkState, - extract_content_URLs_from_course + extract_content_URLs_from_course, ) from cms.djangoapps.contentstore.utils import create_course_info_usage_key, get_previous_run_course_key from cms.djangoapps.contentstore.xblock_storage_handlers.view_handlers import get_xblock diff --git a/cms/djangoapps/contentstore/core/tests/test_course_optimizer_provider.py b/cms/djangoapps/contentstore/core/tests/test_course_optimizer_provider.py index 0780848dfda9..d4d1a8d6ee63 100644 --- a/cms/djangoapps/contentstore/core/tests/test_course_optimizer_provider.py +++ b/cms/djangoapps/contentstore/core/tests/test_course_optimizer_provider.py @@ -11,7 +11,7 @@ _create_dto_recursive, _update_node_tree_and_dictionary, generate_broken_links_descriptor, - sort_course_sections + sort_course_sections, ) from cms.djangoapps.contentstore.tasks import LinkState, extract_content_URLs_from_course from cms.djangoapps.contentstore.tests.utils import CourseTestCase @@ -73,7 +73,7 @@ def test_update_node_tree_and_dictionary_returns_node_tree(self): self.mock_block, 'example_link', LinkState.LOCKED, {}, {} ) - self.assertEqual(expected_tree, result_tree) + self.assertEqual(expected_tree, result_tree) # noqa: PT009 def test_update_node_tree_and_dictionary_returns_dictionary(self): """ @@ -104,7 +104,7 @@ def test_update_node_tree_and_dictionary_returns_dictionary(self): self.mock_block, 'example_link', LinkState.LOCKED, {}, {} ) - self.assertEqual(expected_dictionary, result_dictionary) + self.assertEqual(expected_dictionary, result_dictionary) # noqa: PT009 def test_create_dto_recursive_returns_for_empty_node(self): """ @@ -112,7 +112,7 @@ def test_create_dto_recursive_returns_for_empty_node(self): Function should return None when given empty node tree and empty dictionary. """ expected = _create_dto_recursive({}, {}) - self.assertEqual(None, expected) + self.assertEqual(None, expected) # noqa: PT009 def test_create_dto_recursive_returns_for_leaf_node(self): """ @@ -159,7 +159,7 @@ def test_create_dto_recursive_returns_for_leaf_node(self): } } expected = _create_dto_recursive(mock_node_tree, mock_dictionary) - self.assertEqual(expected_result, expected) + self.assertEqual(expected_result, expected) # noqa: PT009 def test_create_dto_recursive_returns_for_full_tree(self): """ @@ -231,7 +231,7 @@ def test_create_dto_recursive_returns_for_full_tree(self): } expected = _create_dto_recursive(mock_node_tree, mock_dictionary) - self.assertEqual(expected_result, expected) + self.assertEqual(expected_result, expected) # noqa: PT009 @mock.patch('cms.djangoapps.contentstore.core.course_optimizer_provider.modulestore', autospec=True) def test_returns_unchanged_data_if_no_course_blocks(self, mock_modulestore): @@ -306,7 +306,7 @@ def test_sorts_sections_correctly(self, mock_modulestore): {"id": "section3", "name": "Bonus"}, {"id": "section1", "name": "Intro"}, ] - self.assertEqual(result["LinkCheckOutput"]["sections"], expected_sections) + self.assertEqual(result["LinkCheckOutput"]["sections"], expected_sections) # noqa: PT009 def test_prev_run_link_detection(self): """Test the core logic of separating previous run links from regular links.""" @@ -330,7 +330,7 @@ def test_prev_run_link_detection(self): for url, expected_match in test_cases: with self.subTest(url=url, expected=expected_match): result = contains_course_reference(url, previous_course_key) - self.assertEqual( + self.assertEqual( # noqa: PT009 result, expected_match, f"URL '{url}' should {'match' if expected_match else 'not match'} previous course", @@ -362,7 +362,7 @@ def test_enhanced_url_detection_edge_cases(self): with self.subTest(content=content): urls = extract_content_URLs_from_course(content) for expected_url in expected_urls: - self.assertIn( + self.assertIn( # noqa: PT009 expected_url, urls, f"Should find '{expected_url}' in content: {content}", @@ -459,19 +459,19 @@ def test_course_updates_and_custom_pages_structure(self): ) # Verify top-level structure - self.assertIn("sections", result) - self.assertIn("course_updates", result) - self.assertIn("custom_pages", result) - self.assertNotIn("handouts", result) + self.assertIn("sections", result) # noqa: PT009 + self.assertIn("course_updates", result) # noqa: PT009 + self.assertIn("custom_pages", result) # noqa: PT009 + self.assertNotIn("handouts", result) # noqa: PT009 # Course updates should include both updates and handouts - self.assertGreaterEqual( + self.assertGreaterEqual( # noqa: PT009 len(result["course_updates"]), 1, "Should have course updates/handouts", ) # Custom pages should have custom pages data - self.assertGreaterEqual( + self.assertGreaterEqual( # noqa: PT009 len(result["custom_pages"]), 1, "Should have custom pages" ) diff --git a/cms/djangoapps/contentstore/course_group_config.py b/cms/djangoapps/contentstore/course_group_config.py index a6babd0a0c2f..0c9b40c4a14e 100644 --- a/cms/djangoapps/contentstore/course_group_config.py +++ b/cms/djangoapps/contentstore/course_group_config.py @@ -12,18 +12,25 @@ from cms.djangoapps.contentstore.utils import reverse_usage_url from common.djangoapps.util.db import MYSQL_MAX_INT, generate_int_id from lms.lib.utils import get_parent_unit + # Re-exported for backward compatibility - other modules import these from here from openedx.core.djangoapps.course_groups.constants import ( # pylint: disable=unused-import COHORT_SCHEME, CONTENT_GROUP_CONFIGURATION_DESCRIPTION, CONTENT_GROUP_CONFIGURATION_NAME, - ENROLLMENT_SCHEME, + ENROLLMENT_SCHEME, # noqa: F401 RANDOM_SCHEME, ) from openedx.core.djangoapps.course_groups.partition_scheme import get_cohorted_user_partition -from xmodule.partitions.partitions import MINIMUM_UNUSED_PARTITION_ID, ReadOnlyUserPartitionError, UserPartition # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.partitions.partitions_service import get_all_partitions_for_course # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.split_test_block import get_split_user_partitions # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.partitions.partitions import ( # pylint: disable=wrong-import-order + MINIMUM_UNUSED_PARTITION_ID, + ReadOnlyUserPartitionError, + UserPartition, +) +from xmodule.partitions.partitions_service import ( + get_all_partitions_for_course, # pylint: disable=wrong-import-order +) +from xmodule.split_test_block import get_split_user_partitions # pylint: disable=wrong-import-order MINIMUM_GROUP_ID = MINIMUM_UNUSED_PARTITION_ID @@ -34,7 +41,7 @@ class GroupConfigurationsValidationError(Exception): """ An error thrown when a group configurations input is invalid. """ - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass class GroupConfiguration: @@ -60,7 +67,7 @@ def parse(json_string): try: configuration = json.loads(json_string.decode("utf-8")) except ValueError: - raise GroupConfigurationsValidationError(_("invalid JSON")) # lint-amnesty, pylint: disable=raise-missing-from + raise GroupConfigurationsValidationError(_("invalid JSON")) # pylint: disable=raise-missing-from # noqa: B904 configuration["version"] = UserPartition.VERSION return configuration @@ -109,7 +116,7 @@ def get_user_partition(self): try: return UserPartition.from_json(self.configuration) except ReadOnlyUserPartitionError: - raise GroupConfigurationsValidationError(_("unable to load this type of group configuration")) # lint-amnesty, pylint: disable=raise-missing-from + raise GroupConfigurationsValidationError(_("unable to load this type of group configuration")) # pylint: disable=raise-missing-from # noqa: B904 @staticmethod def _get_usage_dict(course, unit, block, scheme_name=None): diff --git a/cms/djangoapps/contentstore/course_info_model.py b/cms/djangoapps/contentstore/course_info_model.py index e8a359d80564..59a0d6a8fe72 100644 --- a/cms/djangoapps/contentstore/course_info_model.py +++ b/cms/djangoapps/contentstore/course_info_model.py @@ -19,11 +19,11 @@ from django.http import HttpResponseBadRequest from django.utils.translation import gettext as _ -from cms.djangoapps.contentstore.utils import track_course_update_event, send_course_update_notification +from cms.djangoapps.contentstore.utils import send_course_update_notification, track_course_update_event from openedx.core.lib.xblock_utils import get_course_update_items -from xmodule.html_block import CourseInfoBlock # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.exceptions import ItemNotFoundError # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.html_block import CourseInfoBlock # pylint: disable=wrong-import-order +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order +from xmodule.modulestore.exceptions import ItemNotFoundError # pylint: disable=wrong-import-order # # This should be in a class which inherits from XModuleDescriptor log = logging.getLogger(__name__) diff --git a/cms/djangoapps/contentstore/courseware_index.py b/cms/djangoapps/contentstore/courseware_index.py index b7b74992035a..e5b8c5ce0df9 100644 --- a/cms/djangoapps/contentstore/courseware_index.py +++ b/cms/djangoapps/contentstore/courseware_index.py @@ -15,9 +15,9 @@ from cms.djangoapps.contentstore.course_group_config import GroupConfiguration from common.djangoapps.course_modes.models import CourseMode from openedx.core.lib.courses import course_image_url, course_organization_image_url -from xmodule.annotator_mixin import html_to_text # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.library_tools import normalize_key_for_search # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore import ModuleStoreEnum # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.annotator_mixin import html_to_text # pylint: disable=wrong-import-order +from xmodule.library_tools import normalize_key_for_search # pylint: disable=wrong-import-order +from xmodule.modulestore import ModuleStoreEnum # pylint: disable=wrong-import-order # REINDEX_AGE is the default amount of time that we look back for changes # that might have happened. If we are provided with a time at which the @@ -114,7 +114,7 @@ def remove_deleted_items(cls, searcher, structure_key, exclude_items): searcher.remove(result_ids) @classmethod - def index(cls, modulestore, structure_key, triggered_at=None, reindex_age=REINDEX_AGE, timeout=INDEXING_REQUEST_TIMEOUT): # lint-amnesty, pylint: disable=line-too-long, too-many-statements + def index(cls, modulestore, structure_key, triggered_at=None, reindex_age=REINDEX_AGE, timeout=INDEXING_REQUEST_TIMEOUT): # pylint: disable=line-too-long, too-many-statements """ Process course for indexing @@ -185,7 +185,7 @@ def prepare_item_index(item, skip_index=False, groups_usage_info=None): item_content_groups = None - if item.category == "split_test": # lint-amnesty, pylint: disable=too-many-nested-blocks + if item.category == "split_test": # pylint: disable=too-many-nested-blocks split_partition = item.get_selected_partition() for split_test_child in item.get_children(): if split_partition: @@ -313,7 +313,7 @@ def fetch_group_usage(cls, modulestore, structure): # pylint: disable=unused-ar """ return None - @classmethod + @classmethod # noqa: B027 def supplemental_index_information(cls, modulestore, structure): """ Perform any supplemental indexing given that the structure object has @@ -326,7 +326,7 @@ def supplemental_index_information(cls, modulestore, structure): Returns: None """ - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass @classmethod def supplemental_fields(cls, item): # pylint: disable=unused-argument @@ -669,7 +669,7 @@ def _get_location_info(cls, normalized_structure_key): return {"course": str(normalized_structure_key), "org": normalized_structure_key.org} @classmethod - def remove_deleted_items(cls, structure_key): # lint-amnesty, pylint: disable=arguments-differ + def remove_deleted_items(cls, structure_key): # pylint: disable=arguments-differ """ Remove item from Course About Search_index """ searcher = SearchEngine.get_search_engine(cls.INDEX_NAME) if not searcher: diff --git a/cms/djangoapps/contentstore/debug_file_uploader.py b/cms/djangoapps/contentstore/debug_file_uploader.py index e9546abd24cb..f8a540e2c831 100644 --- a/cms/djangoapps/contentstore/debug_file_uploader.py +++ b/cms/djangoapps/contentstore/debug_file_uploader.py @@ -6,7 +6,7 @@ from django.core.files.uploadhandler import FileUploadHandler -class DebugFileUploader(FileUploadHandler): # lint-amnesty, pylint: disable=missing-class-docstring +class DebugFileUploader(FileUploadHandler): # pylint: disable=missing-class-docstring def __init__(self, request=None): super().__init__(request) self.count = 0 diff --git a/cms/djangoapps/contentstore/exams.py b/cms/djangoapps/contentstore/exams.py index 8a4ddc09425e..384dd1041e7a 100644 --- a/cms/djangoapps/contentstore/exams.py +++ b/cms/djangoapps/contentstore/exams.py @@ -33,7 +33,7 @@ def register_exams(course_key): course = modulestore().get_course(course_key) if course is None: - raise ItemNotFoundError("Course {} does not exist", str(course_key)) # lint-amnesty, pylint: disable=raising-format-tuple + raise ItemNotFoundError("Course {} does not exist", str(course_key)) # pylint: disable=raising-format-tuple # get all sequences, since they can be marked as timed/proctored exams _timed_exams = modulestore().get_items( @@ -58,7 +58,7 @@ def register_exams(course_key): for timed_exam in timed_exams: location = str(timed_exam.location) msg = ( - 'Found {location} as an exam in course structure.'.format( + 'Found {location} as an exam in course structure.'.format( # noqa: UP032 location=location ) ) diff --git a/cms/djangoapps/contentstore/git_export_utils.py b/cms/djangoapps/contentstore/git_export_utils.py index e0ac80a4627f..1d94fea81198 100644 --- a/cms/djangoapps/contentstore/git_export_utils.py +++ b/cms/djangoapps/contentstore/git_export_utils.py @@ -10,13 +10,15 @@ from urllib.parse import urlparse from django.conf import settings -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.utils import timezone from django.utils.translation import gettext_lazy as _ +from opaque_keys.edx.locator import LibraryLocator, LibraryLocatorV2 +from openedx.core.djangoapps.content_libraries.api import extract_library_v2_zip_to_dir from xmodule.contentstore.django import contentstore from xmodule.modulestore.django import modulestore -from xmodule.modulestore.xml_exporter import export_course_to_xml +from xmodule.modulestore.xml_exporter import CourseLocator, export_course_to_xml, export_library_to_xml log = logging.getLogger(__name__) @@ -66,10 +68,28 @@ def cmd_log(cmd, cwd): return output -def export_to_git(course_id, repo, user='', rdir=None): - """Export a course to git.""" +def export_to_git(context_key, repo, user='', rdir=None): + """ + Export a course or library to git. + + Args: + context_key: LearningContextKey for the content to export + repo (str): Git repository URL + user (str): Optional username for git commit identity + rdir (str): Optional custom directory name for the repository + + Raises: + GitExportError: For various git operation failures + """ # pylint: disable=too-many-statements + # Validate context_key type and determine export function and content type label + if not isinstance(context_key, (LibraryLocatorV2, LibraryLocator, CourseLocator)): + raise TypeError( + f"{context_key!r} for git export must be LibraryLocatorV2, LibraryLocator, " + f"or CourseLocator, not {type(context_key)}" + ) + if not GIT_REPO_EXPORT_DIR: raise GitExportError(GitExportError.NO_EXPORT_DIR) @@ -128,15 +148,31 @@ def export_to_git(course_id, repo, user='', rdir=None): log.exception('Failed to pull git repository: %r', ex.output) raise GitExportError(GitExportError.CANNOT_PULL) from ex - # export course as xml before commiting and pushing + # export content as xml (or zip for v2 libraries) before commiting and pushing root_dir = os.path.dirname(rdirp) - course_dir = os.path.basename(rdirp).rsplit('.git', 1)[0] + content_dir = os.path.basename(rdirp).rsplit('.git', 1)[0] + + content_type_label = "course" if context_key.is_course else "library" + + is_library_v2 = isinstance(context_key, LibraryLocatorV2) + if is_library_v2: + # V2 libraries use backup API with zip extraction + content_export_func = extract_library_v2_zip_to_dir + elif isinstance(context_key, LibraryLocator): + content_export_func = export_library_to_xml + else: + content_export_func = export_course_to_xml + try: - export_course_to_xml(modulestore(), contentstore(), course_id, - root_dir, course_dir) - except (OSError, AttributeError): - log.exception('Failed export to xml') - raise GitExportError(GitExportError.XML_EXPORT_FAIL) # lint-amnesty, pylint: disable=raise-missing-from + if is_library_v2: + content_export_func(context_key, root_dir, content_dir, user) + else: + # V1 libraries and courses: use XML export (no user parameter) + content_export_func(modulestore(), contentstore(), context_key, + root_dir, content_dir) + except (OSError, AttributeError) as ex: + log.exception('Failed to export %s', content_type_label) + raise GitExportError(GitExportError.XML_EXPORT_FAIL) from ex # Get current branch if not already set if not branch: @@ -160,9 +196,7 @@ def export_to_git(course_id, repo, user='', rdir=None): ident = GIT_EXPORT_DEFAULT_IDENT time_stamp = timezone.now() cwd = os.path.abspath(rdirp) - commit_msg = "Export from Studio at {time_stamp}".format( - time_stamp=time_stamp, - ) + commit_msg = f"Export {content_type_label} from Studio at {time_stamp}" try: cmd_log(['git', 'config', 'user.email', ident['email']], cwd) cmd_log(['git', 'config', 'user.name', ident['name']], cwd) @@ -180,3 +214,10 @@ def export_to_git(course_id, repo, user='', rdir=None): except subprocess.CalledProcessError as ex: log.exception('Error running git push command: %r', ex.output) raise GitExportError(GitExportError.CANNOT_PUSH) from ex + + log.info( + '%s %s exported to git repository %s successfully', + content_type_label.capitalize(), + context_key, + repo, + ) diff --git a/cms/djangoapps/contentstore/helpers.py b/cms/djangoapps/contentstore/helpers.py index 9bfab1f1f385..93d71ce811bb 100644 --- a/cms/djangoapps/contentstore/helpers.py +++ b/cms/djangoapps/contentstore/helpers.py @@ -6,44 +6,45 @@ Only Studio-specfic helper functions should be added here. Platform-wide Python APIs should be added to an appropriate api.py file instead. """ + from __future__ import annotations + import json import logging import pathlib +import re import urllib -from lxml import etree from mimetypes import guess_type -import re -from attrs import frozen, Factory -from django.core.files.base import ContentFile +from attrs import Factory, frozen from django.conf import settings from django.contrib.auth import get_user_model +from django.core.files.base import ContentFile from django.utils.translation import gettext as _ +from edxval.api import create_external_video, create_or_update_video_transcript +from lxml import etree from opaque_keys.edx.keys import CourseKey, UsageKey from opaque_keys.edx.locator import DefinitionLocator, LocalId -from openedx.core.djangoapps.content_tagging.types import TagValuesByObjectIdDict from xblock.core import XBlock from xblock.fields import ScopeIds from xblock.runtime import IdGenerator -from xmodule.contentstore.content import StaticContent -from xmodule.contentstore.django import contentstore -from xmodule.exceptions import NotFoundError -from xmodule.modulestore.django import modulestore -from xmodule.xml_block import XmlMixin -from openedx.core.djangoapps.video_config.transcripts_utils import Transcript, build_components_import_path -from edxval.api import ( - create_external_video, - create_or_update_video_transcript, -) +import openedx.core.djangoapps.content_staging.api as content_staging_api +import openedx.core.djangoapps.content_tagging.api as content_tagging_api from cms.djangoapps.models.settings.course_grading import CourseGradingModel from cms.lib.xblock.upstream_sync import UpstreamLink, UpstreamLinkException from cms.lib.xblock.upstream_sync_block import fetch_customizable_fields_from_block -from openedx.core.djangoapps.site_configuration import helpers as configuration_helpers -import openedx.core.djangoapps.content_staging.api as content_staging_api -import openedx.core.djangoapps.content_tagging.api as content_tagging_api +from openedx.core.djangoapps.content_staging.api import StagedContentID from openedx.core.djangoapps.content_staging.data import LIBRARY_SYNC_PURPOSE +from openedx.core.djangoapps.content_tagging.types import TagValuesByObjectIdDict +from openedx.core.djangoapps.site_configuration import helpers as configuration_helpers +from openedx.core.djangoapps.video_config.transcripts_utils import Transcript, build_components_import_path +from openedx.core.types import AuthUser as UserType +from xmodule.contentstore.content import StaticContent +from xmodule.contentstore.django import contentstore +from xmodule.exceptions import NotFoundError +from xmodule.modulestore.django import modulestore +from xmodule.xml_block import XmlMixin from .utils import reverse_course_url, reverse_library_url, reverse_usage_url @@ -229,7 +230,7 @@ def xblock_type_display_name(xblock, default_display_name=None): return _('Problem Bank') component_class = XBlock.load_class(category) if hasattr(component_class, 'display_name') and component_class.display_name.default: - return _(component_class.display_name.default) # lint-amnesty, pylint: disable=translation-of-non-string + return _(component_class.display_name.default) # pylint: disable=translation-of-non-string else: return default_display_name @@ -282,7 +283,10 @@ def create_usage(self, def_id) -> UsageKey: def create_definition(self, block_type, slug=None) -> DefinitionLocator: """ Generate a new definition_id for an XBlock """ # Note: Split modulestore will detect this temporary ID and create a new definition ID when the XBlock is saved. - return DefinitionLocator(block_type, LocalId(block_type)) + # FIXME: The DefinitionLocator technically only accepts an ObjectId (or a str representing an ObjectId), but + # this code relies on passing a LocalId and having it save the LocalId object as its `definition_id`. We should + # either change this in the future or update DefinitionLocator to support LocalId-typed definition IDs. + return DefinitionLocator(block_type, LocalId(block_type)) # type: ignore[arg-type] @frozen @@ -314,7 +318,7 @@ def _rewrite_static_asset_references(downstream_xblock: XBlock, substitutions: d def _insert_static_files_into_downstream_xblock( - downstream_xblock: XBlock, staged_content_id: int, request + downstream_xblock: XBlock, staged_content_id: StagedContentID, request ) -> StaticFileNotices: """ Gets static files from staged content, and inserts them into the downstream XBlock. @@ -454,7 +458,7 @@ def _fetch_and_set_upstream_link( copied_from_block: str, copied_from_version_num: int, temp_xblock: XBlock, - user: User + user: UserType, ): """ Fetch and set upstream link for the given xblock which is being pasted. This function handles following cases: @@ -505,8 +509,18 @@ def _fetch_and_set_upstream_link( # temp_xblock.display_name == temp_xblock.upstream_display_name # temp_xblock.data == temp_xblock.upstream_data # for html blocks # Even then we want to set `downstream_customized` value to avoid overriding user customisations on sync - downstream_customized = temp_xblock.xml_attributes.get("downstream_customized", '[]') - temp_xblock.downstream_customized = json.loads(downstream_customized) + downstream_customized = getattr(temp_xblock, "downstream_customized", []) + # XmlMixin blocks expose raw XML attrs on `xml_attributes`; other blocks (e.g. DnD) + # may not have this attribute, but still have parsed downstream_customized field. + xml_attributes = getattr(temp_xblock, "xml_attributes", None) + if isinstance(xml_attributes, dict): + raw_downstream_customized = xml_attributes.get("downstream_customized") + if isinstance(raw_downstream_customized, str): + downstream_customized = json.loads(raw_downstream_customized) + elif isinstance(raw_downstream_customized, list): + downstream_customized = raw_downstream_customized + if hasattr(temp_xblock, "downstream_customized"): + temp_xblock.downstream_customized = downstream_customized def _import_xml_node_to_parent( @@ -515,7 +529,7 @@ def _import_xml_node_to_parent( # The modulestore we're using store, # The user who is performing this operation - user: User, + user: UserType, # Hint to use as usage ID (block_id) for the new XBlock slug_hint: str | None = None, # Content tags applied to the source XBlock(s) @@ -637,7 +651,7 @@ def _import_xml_node_to_parent( def _import_files_into_course( course_key: CourseKey, - staged_content_id: int, + staged_content_id: StagedContentID, static_files: list[content_staging_api.StagedContentFileData], usage_key: UsageKey, ) -> tuple[StaticFileNotices, dict[str, str]]: @@ -687,7 +701,7 @@ def _import_files_into_course( pass # This file already exists; no action needed. else: conflicting_files.append(file_data_obj.filename) - except Exception: # lint-amnesty, pylint: disable=broad-except + except Exception: # pylint: disable=broad-except error_files.append(file_data_obj.filename) log.exception(f"Failed to import Files & Uploads file {file_data_obj.filename}") @@ -702,7 +716,7 @@ def _import_files_into_course( def _import_file_into_course( course_key: CourseKey, - staged_content_id: int, + staged_content_id: StagedContentID, file_data_obj: content_staging_api.StagedContentFileData, usage_key: UsageKey, ) -> tuple[bool | None, dict]: @@ -762,7 +776,7 @@ def _import_file_into_course( def _import_transcripts( block: XBlock, - staged_content_id: int, + staged_content_id: StagedContentID, static_files: list[content_staging_api.StagedContentFileData], ): """ diff --git a/cms/djangoapps/contentstore/management/commands/backfill_course_outlines.py b/cms/djangoapps/contentstore/management/commands/backfill_course_outlines.py index 99718ce0dd67..04c10f477fff 100644 --- a/cms/djangoapps/contentstore/management/commands/backfill_course_outlines.py +++ b/cms/djangoapps/contentstore/management/commands/backfill_course_outlines.py @@ -12,10 +12,7 @@ from django.core.management.base import BaseCommand from openedx.core.djangoapps.content.course_overviews.models import CourseOverview -from openedx.core.djangoapps.content.learning_sequences.api import ( - get_course_keys_with_outlines, - key_supports_outlines, -) +from openedx.core.djangoapps.content.learning_sequences.api import get_course_keys_with_outlines, key_supports_outlines from ...tasks import update_outline_from_modulestore_task diff --git a/cms/djangoapps/contentstore/management/commands/backfill_course_tabs.py b/cms/djangoapps/contentstore/management/commands/backfill_course_tabs.py index 768c3a53f7ac..c2d8a187eb2b 100644 --- a/cms/djangoapps/contentstore/management/commands/backfill_course_tabs.py +++ b/cms/djangoapps/contentstore/management/commands/backfill_course_tabs.py @@ -12,11 +12,11 @@ import logging from django.core.management.base import BaseCommand -from xmodule.tabs import CourseTabList -from xmodule.modulestore import ModuleStoreEnum -from xmodule.modulestore.django import modulestore from cms.djangoapps.contentstore.models import BackfillCourseTabsConfig +from xmodule.modulestore import ModuleStoreEnum +from xmodule.modulestore.django import modulestore +from xmodule.tabs import CourseTabList logger = logging.getLogger(__name__) diff --git a/cms/djangoapps/contentstore/management/commands/backfill_orgs_and_org_courses.py b/cms/djangoapps/contentstore/management/commands/backfill_orgs_and_org_courses.py index cba7ab452b0a..f8a122488c26 100644 --- a/cms/djangoapps/contentstore/management/commands/backfill_orgs_and_org_courses.py +++ b/cms/djangoapps/contentstore/management/commands/backfill_orgs_and_org_courses.py @@ -5,13 +5,13 @@ For full context, see: https://github.com/openedx/edx-organizations/blob/master/docs/decisions/0001-phase-in-db-backed-organizations-to-all.rst """ -from typing import Dict, List, Set, Tuple +from typing import Dict, List, Set, Tuple # noqa: UP035 from django.core.management import BaseCommand, CommandError from organizations import api as organizations_api from openedx.core.djangoapps.content.course_overviews.models import CourseOverview -from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order class Command(BaseCommand): @@ -151,9 +151,9 @@ def handle(self, *args, **options): def confirm_changes( - options: Dict[str, str], - orgs: List[dict], - org_courseid_pairs: List[Tuple[dict, str]], + options: Dict[str, str], # noqa: UP006 + orgs: List[dict], # noqa: UP006 + org_courseid_pairs: List[Tuple[dict, str]], # noqa: UP006 ) -> bool: """ Should we apply the changes to the database? @@ -192,8 +192,8 @@ def confirm_changes( def bulk_add_data( - orgs: List[dict], - org_courseid_pairs: List[Tuple[dict, str]], + orgs: List[dict], # noqa: UP006 + org_courseid_pairs: List[Tuple[dict, str]], # noqa: UP006 dry_run: bool, activate: bool, ): @@ -246,7 +246,7 @@ def bulk_add_data( print("------------------------------------------------------") -def find_orgslug_courseid_pairs() -> Set[Tuple[str, str]]: +def find_orgslug_courseid_pairs() -> Set[Tuple[str, str]]: # noqa: UP006 """ Returns the unique pairs of (organization short name, course run key string) from the CourseOverviews table, which should contain all course runs in the @@ -266,7 +266,7 @@ def find_orgslug_courseid_pairs() -> Set[Tuple[str, str]]: } -def find_orgslug_libraryid_pairs() -> Set[Tuple[str, str]]: +def find_orgslug_libraryid_pairs() -> Set[Tuple[str, str]]: # noqa: UP006 """ Returns the unique pairs of (organization short name, content library key string) from the modulestore. diff --git a/cms/djangoapps/contentstore/management/commands/clean_cert_name.py b/cms/djangoapps/contentstore/management/commands/clean_cert_name.py index 087a3a4a7245..9c4e761c5b46 100644 --- a/cms/djangoapps/contentstore/management/commands/clean_cert_name.py +++ b/cms/djangoapps/contentstore/management/commands/clean_cert_name.py @@ -158,14 +158,14 @@ def _display(self, results): col_format = "| {{:>{}}} |" self.stdout.write(id_format.format(""), ending='') - for header, width in zip(headers, col_widths): + for header, width in zip(headers, col_widths): # noqa: B905 self.stdout.write(col_format.format(width).format(header), ending='') self.stdout.write('') for idx, result in enumerate(results): self.stdout.write(id_format.format(idx), ending='') - for col, width in zip(result, col_widths): + for col, width in zip(result, col_widths): # noqa: B905 self.stdout.write(col_format.format(width).format(str(col)), ending='') self.stdout.write("") diff --git a/cms/djangoapps/contentstore/management/commands/cleanup_assets.py b/cms/djangoapps/contentstore/management/commands/cleanup_assets.py index ed6b0568b761..3d93c3cac001 100644 --- a/cms/djangoapps/contentstore/management/commands/cleanup_assets.py +++ b/cms/djangoapps/contentstore/management/commands/cleanup_assets.py @@ -32,8 +32,8 @@ def handle(self, *args, **options): # Remove all redundant Mac OS metadata files assets_deleted = content_store.remove_redundant_content_for_courses() success = True - except Exception as err: # lint-amnesty, pylint: disable=broad-except - log.info("=" * 30 + "> failed to cleanup") # lint-amnesty, pylint: disable=logging-not-lazy + except Exception as err: # pylint: disable=broad-except + log.info("=" * 30 + "> failed to cleanup") # pylint: disable=logging-not-lazy log.info("Error:") log.info(err) diff --git a/cms/djangoapps/contentstore/management/commands/compare_course_index_entries.py b/cms/djangoapps/contentstore/management/commands/compare_course_index_entries.py index bbb5bd79fe65..fb7e2d714175 100644 --- a/cms/djangoapps/contentstore/management/commands/compare_course_index_entries.py +++ b/cms/djangoapps/contentstore/management/commands/compare_course_index_entries.py @@ -1,10 +1,12 @@ """A Command to determine if the Mongo active_versions and Django course_index tables are out of sync""" import logging -from django.core.management.base import BaseCommand + from django.conf import settings +from django.core.management.base import BaseCommand from opaque_keys.edx.locator import CourseLocator + from common.djangoapps.split_modulestore_django.models import SplitModulestoreCourseIndex -from xmodule.modulestore.split_mongo.mongo_connection import MongoPersistenceBackend, DjangoFlexPersistenceBackend +from xmodule.modulestore.split_mongo.mongo_connection import DjangoFlexPersistenceBackend, MongoPersistenceBackend logger = logging.getLogger(__name__) diff --git a/cms/djangoapps/contentstore/management/commands/create_course.py b/cms/djangoapps/contentstore/management/commands/create_course.py index 9ff8b0abca5c..d30de0339315 100644 --- a/cms/djangoapps/contentstore/management/commands/create_course.py +++ b/cms/djangoapps/contentstore/management/commands/create_course.py @@ -5,13 +5,13 @@ from datetime import datetime, timedelta -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.core.management.base import BaseCommand, CommandError from cms.djangoapps.contentstore.management.commands.utils import user_from_str from cms.djangoapps.contentstore.views.course import create_new_course_in_store -from xmodule.modulestore import ModuleStoreEnum # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.exceptions import DuplicateCourseError # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore import ModuleStoreEnum # pylint: disable=wrong-import-order +from xmodule.modulestore.exceptions import DuplicateCourseError # pylint: disable=wrong-import-order MODULESTORE_CHOICES = (ModuleStoreEnum.Type.mongo, ModuleStoreEnum.Type.split) @@ -52,7 +52,7 @@ def get_user(self, user): try: user_object = user_from_str(user) except User.DoesNotExist: - raise CommandError(f"No user {user} found.") # lint-amnesty, pylint: disable=raise-missing-from + raise CommandError(f"No user {user} found.") # pylint: disable=raise-missing-from # noqa: B904 return user_object def handle(self, *args, **options): diff --git a/cms/djangoapps/contentstore/management/commands/delete_course.py b/cms/djangoapps/contentstore/management/commands/delete_course.py index 7e9e053443f2..f4cadc98787c 100644 --- a/cms/djangoapps/contentstore/management/commands/delete_course.py +++ b/cms/djangoapps/contentstore/management/commands/delete_course.py @@ -8,9 +8,9 @@ from opaque_keys.edx.keys import CourseKey from cms.djangoapps.contentstore.utils import delete_course -from xmodule.contentstore.django import contentstore # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore import ModuleStoreEnum # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.contentstore.django import contentstore # pylint: disable=wrong-import-order +from xmodule.modulestore import ModuleStoreEnum # pylint: disable=wrong-import-order +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order from .prompt import query_yes_no @@ -67,12 +67,12 @@ def handle(self, *args, **options): course_key = str(options['course_key']) course_key = CourseKey.from_string(course_key) except InvalidKeyError: - raise CommandError('Invalid course_key: {}'.format(options['course_key'])) # lint-amnesty, pylint: disable=raise-missing-from + raise CommandError('Invalid course_key: {}'.format(options['course_key'])) # pylint: disable=raise-missing-from # noqa: B904 if not modulestore().get_course(course_key): raise CommandError('Course not found: {}'.format(options['course_key'])) - print('Preparing to delete course %s from module store....' % options['course_key']) + print('Preparing to delete course %s from module store....' % options['course_key']) # noqa: UP031 if query_yes_no(f'Are you sure you want to delete course {course_key}?', default='no'): if query_yes_no('Are you sure? This action cannot be undone!', default='no'): @@ -80,6 +80,6 @@ def handle(self, *args, **options): if options['remove_assets']: contentstore().delete_all_course_assets(course_key) - print(f'Deleted assets for course {course_key}') # lint-amnesty, pylint: disable=too-many-format-args + print(f'Deleted assets for course {course_key}') # pylint: disable=too-many-format-args print(f'Deleted course {course_key}') diff --git a/cms/djangoapps/contentstore/management/commands/delete_orphans.py b/cms/djangoapps/contentstore/management/commands/delete_orphans.py index 1994adcde90f..dd0b7b7f296d 100644 --- a/cms/djangoapps/contentstore/management/commands/delete_orphans.py +++ b/cms/djangoapps/contentstore/management/commands/delete_orphans.py @@ -6,7 +6,7 @@ from opaque_keys.edx.keys import CourseKey from cms.djangoapps.contentstore.xblock_storage_handlers.view_handlers import delete_orphans -from xmodule.modulestore import ModuleStoreEnum # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore import ModuleStoreEnum # pylint: disable=wrong-import-order class Command(BaseCommand): @@ -25,7 +25,7 @@ def handle(self, *args, **options): try: course_key = CourseKey.from_string(options['course_id']) except InvalidKeyError: - raise CommandError("Invalid course key.") # lint-amnesty, pylint: disable=raise-missing-from + raise CommandError("Invalid course key.") # pylint: disable=raise-missing-from # noqa: B904 if options['commit']: print('Deleting orphans from the course:') diff --git a/cms/djangoapps/contentstore/management/commands/delete_v1_libraries.py b/cms/djangoapps/contentstore/management/commands/delete_v1_libraries.py index b9a4368f6d6b..15d41d094b35 100644 --- a/cms/djangoapps/contentstore/management/commands/delete_v1_libraries.py +++ b/cms/djangoapps/contentstore/management/commands/delete_v1_libraries.py @@ -3,16 +3,13 @@ import logging from textwrap import dedent +from celery import group from django.core.management import BaseCommand, CommandError - from opaque_keys.edx.keys import CourseKey from opaque_keys.edx.locator import LibraryLocator -from xmodule.modulestore.django import modulestore - -from celery import group - from cms.djangoapps.contentstore.tasks import delete_v1_library +from xmodule.modulestore.django import modulestore from .prompt import query_yes_no @@ -65,7 +62,7 @@ def _parse_library_key(self, raw_value): raise CommandError(f"Argument {raw_value} is not a library key") return result - def handle(self, *args, **options): # lint-amnesty, pylint: disable=unused-argument + def handle(self, *args, **options): # pylint: disable=unused-argument """Parse args and generate tasks for deleting content.""" if (not options['library_ids'] and not options['all']) or (options['library_ids'] and options['all']): diff --git a/cms/djangoapps/contentstore/management/commands/edit_course_tabs.py b/cms/djangoapps/contentstore/management/commands/edit_course_tabs.py index 529d2f881e2f..0daeb0bc08be 100644 --- a/cms/djangoapps/contentstore/management/commands/edit_course_tabs.py +++ b/cms/djangoapps/contentstore/management/commands/edit_course_tabs.py @@ -1,4 +1,4 @@ -# lint-amnesty, pylint: disable=missing-module-docstring +# pylint: disable=missing-module-docstring ### ### Script for editing the course's tabs ### @@ -38,7 +38,7 @@ def print_course(course): # {u'type': u'progress', u'name': u'Progress'}] -class Command(BaseCommand): # lint-amnesty, pylint: disable=missing-class-docstring +class Command(BaseCommand): # pylint: disable=missing-class-docstring help = """See and edit a course's tabs list. Only supports insertion and deletion. Move and rename etc. can be done with a delete followed by an insert. The tabs are numbered starting with 1. @@ -98,4 +98,4 @@ def handle(self, *args, **options): tabs.primitive_insert(course, num - 1, tab_type, name) # -1 as above except ValueError as e: # Cute: translate to CommandError so the CLI error prints nicely. - raise CommandError(e) # lint-amnesty, pylint: disable=raise-missing-from + raise CommandError(e) # pylint: disable=raise-missing-from # noqa: B904 diff --git a/cms/djangoapps/contentstore/management/commands/export.py b/cms/djangoapps/contentstore/management/commands/export.py index 68f35826905a..5654089b4be2 100644 --- a/cms/djangoapps/contentstore/management/commands/export.py +++ b/cms/djangoapps/contentstore/management/commands/export.py @@ -32,10 +32,10 @@ def handle(self, *args, **options): try: course_key = CourseKey.from_string(options['course_id']) except InvalidKeyError: - raise CommandError("Invalid course_key: '%s'." % options['course_id']) # lint-amnesty, pylint: disable=raise-missing-from + raise CommandError("Invalid course_key: '%s'." % options['course_id']) # pylint: disable=raise-missing-from # noqa: B904, UP031 if not modulestore().get_course(course_key): - raise CommandError("Course with %s key not found." % options['course_id']) + raise CommandError("Course with %s key not found." % options['course_id']) # noqa: UP031 output_path = options['output_path'] diff --git a/cms/djangoapps/contentstore/management/commands/export_content_library.py b/cms/djangoapps/contentstore/management/commands/export_content_library.py index b56c172e374e..db1b36664f89 100644 --- a/cms/djangoapps/contentstore/management/commands/export_content_library.py +++ b/cms/djangoapps/contentstore/management/commands/export_content_library.py @@ -12,7 +12,7 @@ from opaque_keys.edx.locator import LibraryLocator from cms.djangoapps.contentstore import tasks -from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order class Command(BaseCommand): @@ -34,7 +34,7 @@ def handle(self, *args, **options): try: library_key = CourseKey.from_string(options['library_id']) except InvalidKeyError: - raise CommandError('Invalid library ID: "{}".'.format(options['library_id'])) # lint-amnesty, pylint: disable=raise-missing-from + raise CommandError('Invalid library ID: "{}".'.format(options['library_id'])) # pylint: disable=raise-missing-from # noqa: B904 if not isinstance(library_key, LibraryLocator): raise CommandError('Argument "{}" is not a library key'.format(options['library_id'])) @@ -50,7 +50,7 @@ def handle(self, *args, **options): # Generate archive using the handy tasks implementation tarball = tasks.create_export_tarball(library, library_key, {}, None) except Exception as e: - raise CommandError(f'Failed to export "{library_key}" with "{e}"') # lint-amnesty, pylint: disable=raise-missing-from + raise CommandError(f'Failed to export "{library_key}" with "{e}"') # pylint: disable=raise-missing-from # noqa: B904 with tarball: # Save generated archive with keyed filename prefix, suffix, n = str(library_key).replace(':', '+'), '.tar.gz', 0 diff --git a/cms/djangoapps/contentstore/management/commands/export_olx.py b/cms/djangoapps/contentstore/management/commands/export_olx.py index 68b291c01342..cc6d20b2bac5 100644 --- a/cms/djangoapps/contentstore/management/commands/export_olx.py +++ b/cms/djangoapps/contentstore/management/commands/export_olx.py @@ -47,9 +47,9 @@ def handle(self, *args, **options): try: course_key = CourseKey.from_string(course_id) except InvalidKeyError: - raise CommandError("Unparsable course_id") # lint-amnesty, pylint: disable=raise-missing-from + raise CommandError("Unparsable course_id") # pylint: disable=raise-missing-from # noqa: B904 except IndexError: - raise CommandError("Insufficient arguments") # lint-amnesty, pylint: disable=raise-missing-from + raise CommandError("Insufficient arguments") # pylint: disable=raise-missing-from # noqa: B904 filename = options['output'] pipe_results = False diff --git a/cms/djangoapps/contentstore/management/commands/force_publish.py b/cms/djangoapps/contentstore/management/commands/force_publish.py index bacf496f68ed..986ddec2f115 100644 --- a/cms/djangoapps/contentstore/management/commands/force_publish.py +++ b/cms/djangoapps/contentstore/management/commands/force_publish.py @@ -36,7 +36,7 @@ def handle(self, *args, **options): try: course_key = CourseKey.from_string(options['course_key']) except InvalidKeyError: - raise CommandError("Invalid course key.") # lint-amnesty, pylint: disable=raise-missing-from + raise CommandError("Invalid course key.") # pylint: disable=raise-missing-from # noqa: B904 if not modulestore().get_course(course_key): raise CommandError("Course not found.") diff --git a/cms/djangoapps/contentstore/management/commands/generate_courses.py b/cms/djangoapps/contentstore/management/commands/generate_courses.py index 935dfe014f32..e1865b468a48 100644 --- a/cms/djangoapps/contentstore/management/commands/generate_courses.py +++ b/cms/djangoapps/contentstore/management/commands/generate_courses.py @@ -6,16 +6,16 @@ import json import logging -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.core.management.base import BaseCommand, CommandError from xblock.fields import Date from cms.djangoapps.contentstore.management.commands.utils import user_from_str from cms.djangoapps.contentstore.views.course import create_new_course_in_store from openedx.core.djangoapps.credit.models import CreditProvider -from xmodule.course_block import CourseFields # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.exceptions import DuplicateCourseError # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.tabs import CourseTabList # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.course_block import CourseFields # pylint: disable=wrong-import-order +from xmodule.modulestore.exceptions import DuplicateCourseError # pylint: disable=wrong-import-order +from xmodule.tabs import CourseTabList # pylint: disable=wrong-import-order logger = logging.getLogger(__name__) @@ -33,9 +33,9 @@ def handle(self, *args, **options): try: courses = json.loads(options["courses_json"])["courses"] except ValueError: - raise CommandError("Invalid JSON object") # lint-amnesty, pylint: disable=raise-missing-from + raise CommandError("Invalid JSON object") # pylint: disable=raise-missing-from # noqa: B904 except KeyError: - raise CommandError("JSON object is missing courses list") # lint-amnesty, pylint: disable=raise-missing-from + raise CommandError("JSON object is missing courses list") # pylint: disable=raise-missing-from # noqa: B904 for course_settings in courses: # Validate course @@ -51,7 +51,7 @@ def handle(self, *args, **options): try: user = user_from_str(user_email) except User.DoesNotExist: - logger.warning(user_email + " user does not exist") # lint-amnesty, pylint: disable=logging-not-lazy + logger.warning(user_email + " user does not exist") # pylint: disable=logging-not-lazy logger.warning("Can't create course, proceeding to next course") continue fields = self._process_course_fields(course_settings["fields"]) @@ -101,7 +101,7 @@ def _process_course_fields(self, fields): if field not in all_fields: # field does not exist as a CourseField del fields[field] - logger.info(field + "is not a valid CourseField") # lint-amnesty, pylint: disable=logging-not-lazy + logger.info(field + "is not a valid CourseField") # pylint: disable=logging-not-lazy elif fields[field] is None: # field is unset del fields[field] @@ -112,7 +112,7 @@ def _process_course_fields(self, fields): fields[field] = Date().from_json(date_json) logger.info(field + " has been set to " + date_json) except Exception: # pylint: disable=broad-except - logger.info("The date string could not be parsed for " + field) # lint-amnesty, pylint: disable=logging-not-lazy + logger.info("The date string could not be parsed for " + field) # pylint: disable=logging-not-lazy del fields[field] elif field in course_tab_list_fields: # Generate CourseTabList object from the json value @@ -121,15 +121,15 @@ def _process_course_fields(self, fields): fields[field] = CourseTabList().from_json(course_tab_list_json) logger.info(field + " has been set to " + course_tab_list_json) except Exception: # pylint: disable=broad-except - logger.info("The course tab list string could not be parsed for " + field) # lint-amnesty, pylint: disable=logging-not-lazy + logger.info("The course tab list string could not be parsed for " + field) # pylint: disable=logging-not-lazy del fields[field] else: # CourseField is valid and has been set - logger.info(field + " has been set to " + str(fields[field])) # lint-amnesty, pylint: disable=logging-not-lazy + logger.info(field + " has been set to " + str(fields[field])) # pylint: disable=logging-not-lazy for field in all_fields: if field not in fields: - logger.info(field + " has not been set") # lint-amnesty, pylint: disable=logging-not-lazy + logger.info(field + " has not been set") # pylint: disable=logging-not-lazy return fields def _course_is_valid(self, course): @@ -146,7 +146,7 @@ def _course_is_valid(self, course): ] for setting in required_course_settings: if setting not in course: - logger.warning("Course json is missing " + setting) # lint-amnesty, pylint: disable=logging-not-lazy + logger.warning("Course json is missing " + setting) # pylint: disable=logging-not-lazy is_valid = False # Check fields settings @@ -156,7 +156,7 @@ def _course_is_valid(self, course): if "fields" in course: for setting in required_field_settings: if setting not in course["fields"]: - logger.warning("Fields json is missing " + setting) # lint-amnesty, pylint: disable=logging-not-lazy + logger.warning("Fields json is missing " + setting) # pylint: disable=logging-not-lazy is_valid = False return is_valid diff --git a/cms/djangoapps/contentstore/management/commands/git_export.py b/cms/djangoapps/contentstore/management/commands/git_export.py index d422cbe2b1fc..1ab30080f801 100644 --- a/cms/djangoapps/contentstore/management/commands/git_export.py +++ b/cms/djangoapps/contentstore/management/commands/git_export.py @@ -50,7 +50,7 @@ def handle(self, *args, **options): try: course_key = CourseKey.from_string(options['course_loc']) except InvalidKeyError: - raise CommandError(str(git_export_utils.GitExportError.BAD_COURSE)) # lint-amnesty, pylint: disable=raise-missing-from + raise CommandError(str(git_export_utils.GitExportError.BAD_COURSE)) # pylint: disable=raise-missing-from # noqa: B904 try: git_export_utils.export_to_git( @@ -60,4 +60,4 @@ def handle(self, *args, **options): options.get('rdir', None) ) except git_export_utils.GitExportError as ex: - raise CommandError(str(ex)) # lint-amnesty, pylint: disable=raise-missing-from + raise CommandError(str(ex)) # pylint: disable=raise-missing-from # noqa: B904 diff --git a/cms/djangoapps/contentstore/management/commands/import.py b/cms/djangoapps/contentstore/management/commands/import.py index 346f10d933b1..d77634f50b34 100644 --- a/cms/djangoapps/contentstore/management/commands/import.py +++ b/cms/djangoapps/contentstore/management/commands/import.py @@ -6,11 +6,11 @@ from django.core.management.base import BaseCommand from openedx.core.djangoapps.django_comment_common.utils import are_permissions_roles_seeded, seed_permissions_roles -from xmodule.contentstore.django import contentstore # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore import ModuleStoreEnum # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.django import SignalHandler, modulestore # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.xml_importer import import_course_from_xml # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.util.sandboxing import DEFAULT_PYTHON_LIB_FILENAME # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.contentstore.django import contentstore # pylint: disable=wrong-import-order +from xmodule.modulestore import ModuleStoreEnum # pylint: disable=wrong-import-order +from xmodule.modulestore.django import SignalHandler, modulestore # pylint: disable=wrong-import-order +from xmodule.modulestore.xml_importer import import_course_from_xml # pylint: disable=wrong-import-order +from xmodule.util.sandboxing import DEFAULT_PYTHON_LIB_FILENAME # pylint: disable=wrong-import-order class Command(BaseCommand): @@ -49,7 +49,7 @@ def handle(self, *args, **options): do_import_python_lib = do_import_static or not options.get('nopythonlib', False) python_lib_filename = options.get('python_lib_filename') - output = ( + output = ( # noqa: UP032 "Importing...\n" " data_dir={data}, source_dirs={courses}\n" " Importing static content? {import_static}\n" diff --git a/cms/djangoapps/contentstore/management/commands/import_content_library.py b/cms/djangoapps/contentstore/management/commands/import_content_library.py index 7d2a64825a31..7ee14ca16054 100644 --- a/cms/djangoapps/contentstore/management/commands/import_content_library.py +++ b/cms/djangoapps/contentstore/management/commands/import_content_library.py @@ -7,7 +7,7 @@ import os from django.conf import settings -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.core.exceptions import SuspiciousOperation from django.core.management.base import BaseCommand, CommandError from lxml import etree @@ -16,11 +16,11 @@ from cms.djangoapps.contentstore.utils import add_instructor from openedx.core.lib.extract_archive import safe_extractall -from xmodule.contentstore.django import contentstore # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore import ModuleStoreEnum # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.exceptions import DuplicateCourseError # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.xml_importer import import_library_from_xml # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.contentstore.django import contentstore # pylint: disable=wrong-import-order +from xmodule.modulestore import ModuleStoreEnum # pylint: disable=wrong-import-order +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order +from xmodule.modulestore.exceptions import DuplicateCourseError # pylint: disable=wrong-import-order +from xmodule.modulestore.xml_importer import import_library_from_xml # pylint: disable=wrong-import-order class Command(BaseCommand): diff --git a/cms/djangoapps/contentstore/management/commands/prompt.py b/cms/djangoapps/contentstore/management/commands/prompt.py index b53be18c9ec7..51512c304690 100644 --- a/cms/djangoapps/contentstore/management/commands/prompt.py +++ b/cms/djangoapps/contentstore/management/commands/prompt.py @@ -30,7 +30,7 @@ def query_yes_no(question, default="yes"): elif default == "no": prompt = " [y/N] " else: - raise ValueError("invalid default answer: '%s'" % default) + raise ValueError("invalid default answer: '%s'" % default) # noqa: UP031 while True: sys.stdout.write(question + prompt) diff --git a/cms/djangoapps/contentstore/management/commands/recreate_upstream_links.py b/cms/djangoapps/contentstore/management/commands/recreate_upstream_links.py index a0f04bb279e9..7234f21ed3ce 100644 --- a/cms/djangoapps/contentstore/management/commands/recreate_upstream_links.py +++ b/cms/djangoapps/contentstore/management/commands/recreate_upstream_links.py @@ -75,7 +75,7 @@ def handle(self, *args, **options): should_process_all = options['all'] force = options['force'] replace = options['replace'] - time_now = datetime.now(tz=timezone.utc) + time_now = datetime.now(tz=timezone.utc) # noqa: UP017 if not courses and not should_process_all: raise CommandError('Either --course or --all argument should be provided.') diff --git a/cms/djangoapps/contentstore/management/commands/reindex_course.py b/cms/djangoapps/contentstore/management/commands/reindex_course.py index 0bd52b6cc16e..73e2346ab547 100644 --- a/cms/djangoapps/contentstore/management/commands/reindex_course.py +++ b/cms/djangoapps/contentstore/management/commands/reindex_course.py @@ -2,12 +2,12 @@ import logging +from datetime import date, datetime from textwrap import dedent from time import time -from datetime import date, datetime -from django.core.management import BaseCommand, CommandError from django.conf import settings +from django.core.management import BaseCommand, CommandError from elasticsearch import exceptions from opaque_keys import InvalidKeyError from opaque_keys.edx.keys import CourseKey @@ -15,7 +15,7 @@ from search.search_engine_base import SearchEngine from cms.djangoapps.contentstore.courseware_index import CourseAboutSearchIndexer, CoursewareSearchIndexer -from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order from .prompt import query_yes_no @@ -60,7 +60,7 @@ def _parse_course_key(self, raw_value): try: result = CourseKey.from_string(raw_value) except InvalidKeyError: - raise CommandError("Invalid course_key: '%s'." % raw_value) # lint-amnesty, pylint: disable=raise-missing-from + raise CommandError("Invalid course_key: '%s'." % raw_value) # pylint: disable=raise-missing-from # noqa: B904, UP031 if not isinstance(result, CourseLocator): raise CommandError(f"Argument {raw_value} is not a course key") @@ -83,7 +83,7 @@ def handle(self, *args, **options): # pylint: disable=too-many-statements course_option_flag_option = index_all_courses_option or active_option or inclusion_date_option if (not course_ids and not course_option_flag_option) or (course_ids and course_option_flag_option): - raise CommandError(( + raise CommandError(( # noqa: UP034 "reindex_course requires one or more s" " OR the --all, --active, --setup, or --from_inclusion_date flags." )) @@ -172,7 +172,7 @@ def handle(self, *args, **options): # pylint: disable=too-many-statements t = time() - start remaining = total - success - len(errors) logging.warning(f'{success} courses reindexed in {t:.1f} seconds. {remaining} remaining...') - except Exception as exc: # lint-amnesty, pylint: disable=broad-except + except Exception as exc: # pylint: disable=broad-except errors.append(course_key) logging.exception('Error indexing course %s due to the error: %s.', course_key, exc) diff --git a/cms/djangoapps/contentstore/management/commands/reindex_library.py b/cms/djangoapps/contentstore/management/commands/reindex_library.py index cf352576f6be..a1707c49845a 100644 --- a/cms/djangoapps/contentstore/management/commands/reindex_library.py +++ b/cms/djangoapps/contentstore/management/commands/reindex_library.py @@ -8,7 +8,7 @@ from opaque_keys.edx.locator import LibraryLocator from cms.djangoapps.contentstore.courseware_index import LibrarySearchIndexer -from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order from .prompt import query_yes_no diff --git a/cms/djangoapps/contentstore/management/commands/replace_v1_lib_refs_with_v2_in_courses.py b/cms/djangoapps/contentstore/management/commands/replace_v1_lib_refs_with_v2_in_courses.py index 6c19a89cf3ff..b9698607608f 100644 --- a/cms/djangoapps/contentstore/management/commands/replace_v1_lib_refs_with_v2_in_courses.py +++ b/cms/djangoapps/contentstore/management/commands/replace_v1_lib_refs_with_v2_in_courses.py @@ -3,18 +3,18 @@ edits all xblocks in courses which refer to the v1 library to point to the v2 library. """ -import logging import csv +import logging -from django.core.management import BaseCommand, CommandError from celery import group +from django.core.management import BaseCommand, CommandError -from openedx.core.djangoapps.content.course_overviews.models import CourseOverview from cms.djangoapps.contentstore.tasks import ( replace_all_library_source_blocks_ids_for_course, + undo_all_library_source_blocks_ids_for_course, validate_all_library_source_blocks_ids_for_course, - undo_all_library_source_blocks_ids_for_course ) +from openedx.core.djangoapps.content.course_overviews.models import CourseOverview log = logging.getLogger(__name__) @@ -62,7 +62,7 @@ def replace_all_library_source_blocks_ids(self, v1_to_v2_lib_map): def validate(self, v1_to_v2_lib_map): """ Validate that replace_all_library_source_blocks_ids was successful""" course_id_strings = list(CourseOverview.get_all_course_keys()) - tasks = group(validate_all_library_source_blocks_ids_for_course.s(course_id, v1_to_v2_lib_map) for course_id in course_id_strings) # lint-amnesty, pylint: disable=line-too-long + tasks = group(validate_all_library_source_blocks_ids_for_course.s(course_id, v1_to_v2_lib_map) for course_id in course_id_strings) # pylint: disable=line-too-long results = tasks.apply_async() validation = set() @@ -107,7 +107,7 @@ def handle(self, *args, **kwargs): file_path = kwargs['file_path'] v1_to_v2_lib_map = {} try: - with open(file_path, 'r', encoding='utf-8') as csvfile: + with open(file_path, 'r', encoding='utf-8') as csvfile: # noqa: UP015 if not file_path.endswith('.csv'): raise CommandError('Invalid file format. Only CSV files are supported.') @@ -124,7 +124,7 @@ def handle(self, *args, **kwargs): except FileNotFoundError: log.error("File not found at '%s'.", {file_path}) - except Exception as e: # lint-amnesty, pylint: disable=broad-except + except Exception as e: # pylint: disable=broad-except log.error("An error occurred: %s", {str(e)}) if kwargs['validate']: diff --git a/cms/djangoapps/contentstore/management/commands/sync_courses.py b/cms/djangoapps/contentstore/management/commands/sync_courses.py index 3fa3a4aede61..12c4c0f48796 100644 --- a/cms/djangoapps/contentstore/management/commands/sync_courses.py +++ b/cms/djangoapps/contentstore/management/commands/sync_courses.py @@ -5,15 +5,15 @@ import logging from textwrap import dedent -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.core.management.base import BaseCommand, CommandError from opaque_keys.edx.keys import CourseKey from cms.djangoapps.contentstore.management.commands.utils import user_from_str from cms.djangoapps.contentstore.views.course import create_new_course_in_store from openedx.core.djangoapps.catalog.utils import get_course_runs -from xmodule.modulestore import ModuleStoreEnum # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.exceptions import DuplicateCourseError # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore import ModuleStoreEnum # pylint: disable=wrong-import-order +from xmodule.modulestore.exceptions import DuplicateCourseError # pylint: disable=wrong-import-order logger = logging.getLogger(__name__) @@ -36,7 +36,7 @@ def get_user(self, user): try: user_object = user_from_str(user) except User.DoesNotExist: - raise CommandError(f"No user {user} found.") # lint-amnesty, pylint: disable=raise-missing-from + raise CommandError(f"No user {user} found.") # pylint: disable=raise-missing-from # noqa: B904 return user_object def handle(self, *args, **options): diff --git a/cms/djangoapps/contentstore/management/commands/tests/test_backfill_course_outlines.py b/cms/djangoapps/contentstore/management/commands/tests/test_backfill_course_outlines.py index 53a6c3b5571a..51b85dacd85b 100644 --- a/cms/djangoapps/contentstore/management/commands/tests/test_backfill_course_outlines.py +++ b/cms/djangoapps/contentstore/management/commands/tests/test_backfill_course_outlines.py @@ -6,8 +6,13 @@ from openedx.core.djangoapps.content.course_overviews.models import CourseOverview from openedx.core.djangoapps.content.learning_sequences.api import get_course_keys_with_outlines -from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory, BlockFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + SharedModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import ( # pylint: disable=wrong-import-order + BlockFactory, + CourseFactory, +) from ....outlines import update_outline_from_modulestore diff --git a/cms/djangoapps/contentstore/management/commands/tests/test_backfill_course_tabs.py b/cms/djangoapps/contentstore/management/commands/tests/test_backfill_course_tabs.py index a83eb621b30e..7d72020e1bd0 100644 --- a/cms/djangoapps/contentstore/management/commands/tests/test_backfill_course_tabs.py +++ b/cms/djangoapps/contentstore/management/commands/tests/test_backfill_course_tabs.py @@ -5,12 +5,12 @@ import ddt from django.core.management import call_command + +from cms.djangoapps.contentstore.models import BackfillCourseTabsConfig from xmodule.modulestore import ModuleStoreEnum from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase from xmodule.modulestore.tests.factories import CourseFactory -from cms.djangoapps.contentstore.models import BackfillCourseTabsConfig - @ddt.ddt class BackfillCourseTabsTest(ModuleStoreTestCase): @@ -140,7 +140,7 @@ def test_command_logs_exception_on_error(self, mock_logger): updated_course = CourseFactory() updated_course.tabs = [tab for tab in updated_course.tabs if tab.type != 'dates'] self.update_course(updated_course, ModuleStoreEnum.UserID.test) - updated_course_tabs_before = updated_course.tabs + updated_course_tabs_before = updated_course.tabs # noqa: F841 with mock.patch( 'lms.djangoapps.ccx.modulestore.CCXModulestoreWrapper.update_item', side_effect=[ValueError, None] diff --git a/cms/djangoapps/contentstore/management/commands/tests/test_backfill_orgs_and_org_courses.py b/cms/djangoapps/contentstore/management/commands/tests/test_backfill_orgs_and_org_courses.py index 57deafadae7d..43d011a130eb 100644 --- a/cms/djangoapps/contentstore/management/commands/tests/test_backfill_orgs_and_org_courses.py +++ b/cms/djangoapps/contentstore/management/commands/tests/test_backfill_orgs_and_org_courses.py @@ -12,12 +12,14 @@ add_organization_course, get_organization_by_short_name, get_organization_courses, - get_organizations + get_organizations, ) from openedx.core.djangoapps.content.course_overviews.tests.factories import CourseOverviewFactory -from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import LibraryFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + SharedModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import LibraryFactory # pylint: disable=wrong-import-order from .. import backfill_orgs_and_org_courses @@ -239,5 +241,5 @@ def test_conflicting_arguments(self): """ Test that calling the command with both "--dry" and "--apply" raises an exception. """ - with self.assertRaises(CommandError): + with self.assertRaises(CommandError): # noqa: PT027 call_command("backfill_orgs_and_org_courses", "--dry", "--apply") diff --git a/cms/djangoapps/contentstore/management/commands/tests/test_clean_stale_certificate_availability_dates.py b/cms/djangoapps/contentstore/management/commands/tests/test_clean_stale_certificate_availability_dates.py index 42b3ca408aa2..6cd722d34d67 100644 --- a/cms/djangoapps/contentstore/management/commands/tests/test_clean_stale_certificate_availability_dates.py +++ b/cms/djangoapps/contentstore/management/commands/tests/test_clean_stale_certificate_availability_dates.py @@ -3,8 +3,8 @@ """ from datetime import datetime, timedelta -from django.core.management import CommandError, call_command import pytz +from django.core.management import CommandError, call_command from cms.djangoapps.contentstore.models import CleanStaleCertificateAvailabilityDatesConfig from openedx.core.lib.courses import get_course_by_id @@ -89,7 +89,7 @@ def test_remove_certificate_available_date_from_instructor_paced_course_expect_e "date can be adjusted via Studio in the UI. Aborting operation." ) - with self.assertRaises(CommandError) as error: + with self.assertRaises(CommandError) as error: # noqa: PT027 call_command( "clean_stale_certificate_available_dates", "--course-runs", @@ -109,7 +109,7 @@ def test_remove_certificate_available_date_with_args_from_database(self): expected_error_message = ( "CleanStaleCertificateAvailabilityDatesConfig is disabled, but --args-from-database was requested." ) - with self.assertRaises(CommandError) as error: + with self.assertRaises(CommandError) as error: # noqa: PT027 call_command("clean_stale_certificate_available_dates", "--args-from-database") assert str(error.exception) == expected_error_message @@ -133,7 +133,7 @@ def test_remove_certificate_available_date_with_args_from_database(self): config.enabled = False config.save() - with self.assertRaises(CommandError) as disabled_error: + with self.assertRaises(CommandError) as disabled_error: # noqa: F841, PT027 call_command("clean_stale_certificate_available_dates", "--args-from-database") assert str(error.exception) == expected_error_message diff --git a/cms/djangoapps/contentstore/management/commands/tests/test_cleanup_assets.py b/cms/djangoapps/contentstore/management/commands/tests/test_cleanup_assets.py index e31d566543fe..d5850c065f71 100644 --- a/cms/djangoapps/contentstore/management/commands/tests/test_cleanup_assets.py +++ b/cms/djangoapps/contentstore/management/commands/tests/test_cleanup_assets.py @@ -5,6 +5,7 @@ from unittest import skip + from django.conf import settings from django.core.management import call_command from opaque_keys.edx.keys import CourseKey @@ -55,12 +56,12 @@ def test_export_all_courses(self): ) course = self.module_store.get_course(CourseKey.from_string('/'.join(['edX', 'course_ignore', '2014_Fall']))) - self.assertIsNotNone(course) + self.assertIsNotNone(course) # noqa: PT009 # check that there are two assets ['example.txt', '.example.txt'] in contentstore for imported course all_assets, count = self.content_store.get_all_content_for_course(course.id) - self.assertEqual(count, 2) - self.assertEqual({asset['_id']['name'] for asset in all_assets}, {'.example.txt', 'example.txt'}) + self.assertEqual(count, 2) # noqa: PT009 + self.assertEqual({asset['_id']['name'] for asset in all_assets}, {'.example.txt', 'example.txt'}) # noqa: PT009 # manually add redundant assets (file ".DS_Store" and filename starts with "._") course_filter = course.id.make_asset_key("asset", None) @@ -74,13 +75,13 @@ def test_export_all_courses(self): # check that now course has four assets all_assets, count = self.content_store.get_all_content_for_course(course.id) - self.assertEqual(count, 4) - self.assertEqual( + self.assertEqual(count, 4) # noqa: PT009 + self.assertEqual( # noqa: PT009 {asset['_id']['name'] for asset in all_assets}, {'.example.txt', 'example.txt', '._example_test.txt', '.DS_Store'} ) # now call asset_cleanup command and check that there is only two proper assets in contentstore for the course call_command('cleanup_assets') all_assets, count = self.content_store.get_all_content_for_course(course.id) - self.assertEqual(count, 2) - self.assertEqual({asset['_id']['name'] for asset in all_assets}, {'.example.txt', 'example.txt'}) + self.assertEqual(count, 2) # noqa: PT009 + self.assertEqual({asset['_id']['name'] for asset in all_assets}, {'.example.txt', 'example.txt'}) # noqa: PT009 diff --git a/cms/djangoapps/contentstore/management/commands/tests/test_create_course.py b/cms/djangoapps/contentstore/management/commands/tests/test_create_course.py index f821c8a6d561..60d1d473f6e3 100644 --- a/cms/djangoapps/contentstore/management/commands/tests/test_create_course.py +++ b/cms/djangoapps/contentstore/management/commands/tests/test_create_course.py @@ -16,26 +16,26 @@ class TestArgParsing(TestCase): """ Tests for parsing arguments for the `create_course` management command """ - def setUp(self): # lint-amnesty, pylint: disable=useless-super-delegation + def setUp(self): # pylint: disable=useless-super-delegation super().setUp() def test_no_args(self): errstring = "Error: the following arguments are required: modulestore, user, org, number, run" - with self.assertRaisesRegex(CommandError, errstring): + with self.assertRaisesRegex(CommandError, errstring): # noqa: PT027 call_command('create_course') def test_invalid_store(self): - with self.assertRaises(CommandError): + with self.assertRaises(CommandError): # noqa: PT027 call_command('create_course', "foo", "user@foo.org", "org", "course", "run") def test_nonexistent_user_id(self): errstring = "No user 99 found" - with self.assertRaisesRegex(CommandError, errstring): + with self.assertRaisesRegex(CommandError, errstring): # noqa: PT027 call_command('create_course', "split", "99", "org", "course", "run") def test_nonexistent_user_email(self): errstring = "No user fake@example.com found" - with self.assertRaisesRegex(CommandError, errstring): + with self.assertRaisesRegex(CommandError, errstring): # noqa: PT027 call_command('create_course', "mongo", "fake@example.com", "org", "course", "run") @@ -52,12 +52,12 @@ def test_all_stores_user_email(self): "org", "course", "run", "dummy-course-name" ) new_key = modulestore().make_course_key("org", "course", "run") - self.assertTrue( + self.assertTrue( # noqa: PT009 modulestore().has_course(new_key), f"Could not find course in {ModuleStoreEnum.Type.split}" ) # pylint: disable=protected-access - self.assertEqual( + self.assertEqual( # noqa: PT009 ModuleStoreEnum.Type.split, modulestore()._get_modulestore_for_courselike(new_key).get_modulestore_type() ) @@ -83,7 +83,7 @@ def test_duplicate_course(self): stderr=out ) expected = "Course already exists" - self.assertIn(out.getvalue().strip(), expected) + self.assertIn(out.getvalue().strip(), expected) # noqa: PT009 def test_get_course_with_different_case(self): """ @@ -107,10 +107,10 @@ def test_get_course_with_different_case(self): self.user.id ) course = self.store.get_course(lowercase_course_id) - self.assertIsNotNone(course, 'Course not found using lowercase course key.') - self.assertEqual(str(course.id), str(lowercase_course_id)) + self.assertIsNotNone(course, 'Course not found using lowercase course key.') # noqa: PT009 + self.assertEqual(str(course.id), str(lowercase_course_id)) # noqa: PT009 # Verify store does not return course with different case. uppercase_course_id = self.store.make_course_key(org.upper(), number.upper(), run.upper()) course = self.store.get_course(uppercase_course_id) - self.assertIsNone(course, 'Course should not be accessed with uppercase course id.') + self.assertIsNone(course, 'Course should not be accessed with uppercase course id.') # noqa: PT009 diff --git a/cms/djangoapps/contentstore/management/commands/tests/test_delete_course.py b/cms/djangoapps/contentstore/management/commands/tests/test_delete_course.py index ccdcde990135..504c5ac06291 100644 --- a/cms/djangoapps/contentstore/management/commands/tests/test_delete_course.py +++ b/cms/djangoapps/contentstore/management/commands/tests/test_delete_course.py @@ -6,15 +6,15 @@ from unittest import mock from django.core.management import CommandError, call_command + +from common.djangoapps.student.roles import CourseInstructorRole +from common.djangoapps.student.tests.factories import UserFactory from xmodule.contentstore.content import StaticContent from xmodule.contentstore.django import contentstore from xmodule.modulestore.django import modulestore from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase from xmodule.modulestore.tests.factories import CourseFactory -from common.djangoapps.student.roles import CourseInstructorRole -from common.djangoapps.student.tests.factories import UserFactory - class DeleteCourseTests(ModuleStoreTestCase): """ @@ -25,18 +25,18 @@ class DeleteCourseTests(ModuleStoreTestCase): def test_invalid_course_key(self): course_run_key = 'foo/TestX/TS01/2015_Q7' expected_error_message = 'Invalid course_key: ' + course_run_key - with self.assertRaisesRegex(CommandError, expected_error_message): + with self.assertRaisesRegex(CommandError, expected_error_message): # noqa: PT027 call_command('delete_course', course_run_key) def test_course_not_found(self): course_run_key = 'TestX/TS01/2015_Q7' expected_error_message = 'Course not found: ' + course_run_key - with self.assertRaisesRegex(CommandError, expected_error_message): + with self.assertRaisesRegex(CommandError, expected_error_message): # noqa: PT027 call_command('delete_course', course_run_key) def test_asset_and_course_deletion(self): course_run = CourseFactory() - self.assertIsNotNone(modulestore().get_course(course_run.id)) + self.assertIsNotNone(modulestore().get_course(course_run.id)) # noqa: PT009 store = contentstore() asset_key = course_run.id.make_asset_key('asset', 'test.txt') diff --git a/cms/djangoapps/contentstore/management/commands/tests/test_delete_orphans.py b/cms/djangoapps/contentstore/management/commands/tests/test_delete_orphans.py index 75650d41dcb2..0108bf4fd559 100644 --- a/cms/djangoapps/contentstore/management/commands/tests/test_delete_orphans.py +++ b/cms/djangoapps/contentstore/management/commands/tests/test_delete_orphans.py @@ -4,8 +4,8 @@ from django.core.management import CommandError, call_command from cms.djangoapps.contentstore.tests.test_orphan import TestOrphanBase -from xmodule.modulestore import ModuleStoreEnum # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore import ModuleStoreEnum # pylint: disable=wrong-import-order +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order class TestDeleteOrphan(TestOrphanBase): @@ -18,7 +18,7 @@ def test_no_args(self): Test delete_orphans command with no arguments """ errstring = 'Error: the following arguments are required: course_id' - with self.assertRaisesRegex(CommandError, errstring): + with self.assertRaisesRegex(CommandError, errstring): # noqa: PT027 call_command('delete_orphans') def test_delete_orphans_no_commit(self): @@ -28,10 +28,10 @@ def test_delete_orphans_no_commit(self): """ course = self.create_course_with_orphans(ModuleStoreEnum.Type.split) call_command('delete_orphans', str(course.id)) - self.assertTrue(self.store.has_item(course.id.make_usage_key('html', 'multi_parent_html'))) - self.assertTrue(self.store.has_item(course.id.make_usage_key('vertical', 'OrphanVert'))) - self.assertTrue(self.store.has_item(course.id.make_usage_key('chapter', 'OrphanChapter'))) - self.assertTrue(self.store.has_item(course.id.make_usage_key('html', 'OrphanHtml'))) + self.assertTrue(self.store.has_item(course.id.make_usage_key('html', 'multi_parent_html'))) # noqa: PT009 + self.assertTrue(self.store.has_item(course.id.make_usage_key('vertical', 'OrphanVert'))) # noqa: PT009 + self.assertTrue(self.store.has_item(course.id.make_usage_key('chapter', 'OrphanChapter'))) # noqa: PT009 + self.assertTrue(self.store.has_item(course.id.make_usage_key('html', 'OrphanHtml'))) # noqa: PT009 def test_delete_orphans_commit(self): """ @@ -43,12 +43,12 @@ def test_delete_orphans_commit(self): call_command('delete_orphans', str(course.id), '--commit') # make sure this block wasn't deleted - self.assertTrue(self.store.has_item(course.id.make_usage_key('html', 'multi_parent_html'))) + self.assertTrue(self.store.has_item(course.id.make_usage_key('html', 'multi_parent_html'))) # noqa: PT009 # and make sure that these were - self.assertFalse(self.store.has_item(course.id.make_usage_key('vertical', 'OrphanVert'))) - self.assertFalse(self.store.has_item(course.id.make_usage_key('chapter', 'OrphanChapter'))) - self.assertFalse(self.store.has_item(course.id.make_usage_key('html', 'OrphanHtml'))) + self.assertFalse(self.store.has_item(course.id.make_usage_key('vertical', 'OrphanVert'))) # noqa: PT009 + self.assertFalse(self.store.has_item(course.id.make_usage_key('chapter', 'OrphanChapter'))) # noqa: PT009 + self.assertFalse(self.store.has_item(course.id.make_usage_key('html', 'OrphanHtml'))) # noqa: PT009 def test_delete_orphans_published_branch_split(self): """ @@ -69,14 +69,14 @@ def test_delete_orphans_published_branch_split(self): # now all orphans should be deleted self.assertOrphanCount(course.id, 0) self.assertOrphanCount(published_branch, 0) - self.assertNotIn(orphan, self.store.get_items(published_branch)) + self.assertNotIn(orphan, self.store.get_items(published_branch)) # noqa: PT009 # we should have one fewer item in the published branch of the course - self.assertEqual( + self.assertEqual( # noqa: PT009 len(items_in_published) - 1, len(self.store.get_items(published_branch)), ) # and the same amount of items in the draft branch of the course - self.assertEqual( + self.assertEqual( # noqa: PT009 len(items_in_draft_preferred), len(self.store.get_items(course.id)), ) @@ -111,6 +111,6 @@ def create_split_course_with_published_orphan(self): # there should be one in published self.assertOrphanCount(course.id, 0) self.assertOrphanCount(published_branch, 1) - self.assertIn(orphan.location, [x.location for x in self.store.get_items(published_branch)]) + self.assertIn(orphan.location, [x.location for x in self.store.get_items(published_branch)]) # noqa: PT009 return course, orphan diff --git a/cms/djangoapps/contentstore/management/commands/tests/test_export.py b/cms/djangoapps/contentstore/management/commands/tests/test_export.py index b467fd558f09..d4c7a8fbcc1c 100644 --- a/cms/djangoapps/contentstore/management/commands/tests/test_export.py +++ b/cms/djangoapps/contentstore/management/commands/tests/test_export.py @@ -24,7 +24,7 @@ def test_no_args(self): Test export command with no arguments """ errstring = "Error: the following arguments are required: course_id, output_path" - with self.assertRaisesRegex(CommandError, errstring): + with self.assertRaisesRegex(CommandError, errstring): # noqa: PT027 call_command('export') @@ -49,13 +49,13 @@ def test_export_course_with_directory_name(self): """ course = CourseFactory.create(default_store=ModuleStoreEnum.Type.split) course_id = str(course.id) - self.assertTrue( + self.assertTrue( # noqa: PT009 modulestore().has_course(course.id), f"Could not find course in {ModuleStoreEnum.Type.split}" ) # Test `export` management command with invalid course_id errstring = "Invalid course_key: 'InvalidCourseID'." - with self.assertRaisesRegex(CommandError, errstring): + with self.assertRaisesRegex(CommandError, errstring): # noqa: PT027 call_command('export', "InvalidCourseID", self.temp_dir_1) # Test `export` management command with correct course_id @@ -67,5 +67,5 @@ def test_course_key_not_found(self): Test export command with a valid course key that doesn't exist """ errstring = "Course with x/y/z key not found." - with self.assertRaisesRegex(CommandError, errstring): + with self.assertRaisesRegex(CommandError, errstring): # noqa: PT027 call_command('export', "x/y/z", self.temp_dir_1) diff --git a/cms/djangoapps/contentstore/management/commands/tests/test_export_all_courses.py b/cms/djangoapps/contentstore/management/commands/tests/test_export_all_courses.py index 5c01abde69ab..9cf658d0ba83 100644 --- a/cms/djangoapps/contentstore/management/commands/tests/test_export_all_courses.py +++ b/cms/djangoapps/contentstore/management/commands/tests/test_export_all_courses.py @@ -8,10 +8,12 @@ from unittest import skip from cms.djangoapps.contentstore.management.commands.export_all_courses import export_courses_to_output_path -from xmodule.modulestore import ModuleStoreEnum # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore import ModuleStoreEnum # pylint: disable=wrong-import-order +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + ModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order @skip("OldMongo Deprecation") @@ -25,7 +27,7 @@ class ExportAllCourses(ModuleStoreTestCase): def setUp(self): """ Common setup. """ super().setUp() - self.store = modulestore()._get_modulestore_by_type(ModuleStoreEnum.Type.mongo) # lint-amnesty, pylint: disable=protected-access + self.store = modulestore()._get_modulestore_by_type(ModuleStoreEnum.Type.mongo) # pylint: disable=protected-access self.temp_dir = mkdtemp() self.addCleanup(shutil.rmtree, self.temp_dir) self.first_course = CourseFactory.create( @@ -41,8 +43,8 @@ def test_export_all_courses(self): """ # check that both courses exported successfully courses, failed_export_courses = export_courses_to_output_path(self.temp_dir) - self.assertEqual(len(courses), 2) - self.assertEqual(len(failed_export_courses), 0) + self.assertEqual(len(courses), 2) # noqa: PT009 + self.assertEqual(len(failed_export_courses), 0) # noqa: PT009 # manually make second course faulty and check that it fails on export second_course_id = self.second_course.id @@ -51,6 +53,6 @@ def test_export_all_courses(self): {'$set': {'metadata.tags': 'crash'}} ) courses, failed_export_courses = export_courses_to_output_path(self.temp_dir) - self.assertEqual(len(courses), 2) - self.assertEqual(len(failed_export_courses), 1) - self.assertEqual(failed_export_courses[0], str(second_course_id)) + self.assertEqual(len(courses), 2) # noqa: PT009 + self.assertEqual(len(failed_export_courses), 1) # noqa: PT009 + self.assertEqual(failed_export_courses[0], str(second_course_id)) # noqa: PT009 diff --git a/cms/djangoapps/contentstore/management/commands/tests/test_export_olx.py b/cms/djangoapps/contentstore/management/commands/tests/test_export_olx.py index 8f5505ede5c1..e8c001a2469f 100644 --- a/cms/djangoapps/contentstore/management/commands/tests/test_export_olx.py +++ b/cms/djangoapps/contentstore/management/commands/tests/test_export_olx.py @@ -12,13 +12,12 @@ from django.core.management import CommandError, call_command from path import Path as path +from openedx.core.djangoapps.content_tagging.tests.test_objecttag_export_helpers import TaggedCourseMixin from xmodule.modulestore import ModuleStoreEnum from xmodule.modulestore.django import modulestore from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase from xmodule.modulestore.tests.factories import CourseFactory -from openedx.core.djangoapps.content_tagging.tests.test_objecttag_export_helpers import TaggedCourseMixin - class TestArgParsingCourseExportOlx(unittest.TestCase): """ @@ -29,7 +28,7 @@ def test_no_args(self): Test export command with no arguments """ errstring = "Error: the following arguments are required: course_id" - with self.assertRaisesRegex(CommandError, errstring): + with self.assertRaisesRegex(CommandError, errstring): # noqa: PT027 call_command('export_olx') @@ -43,7 +42,7 @@ def test_invalid_course_key(self): Test export command with an invalid course key. """ errstring = "Unparsable course_id" - with self.assertRaisesRegex(CommandError, errstring): + with self.assertRaisesRegex(CommandError, errstring): # noqa: PT027 call_command('export_olx', 'InvalidCourseID') def test_course_key_not_found(self): @@ -51,13 +50,13 @@ def test_course_key_not_found(self): Test export command with a valid course key that doesn't exist. """ errstring = "Invalid course_id" - with self.assertRaisesRegex(CommandError, errstring): + with self.assertRaisesRegex(CommandError, errstring): # noqa: PT027 call_command('export_olx', 'x/y/z') def create_dummy_course(self, store_type): """Create small course.""" course = CourseFactory.create(default_store=store_type) - self.assertTrue( + self.assertTrue( # noqa: PT009 modulestore().has_course(course.id), f"Could not find course in {store_type}" ) @@ -66,17 +65,17 @@ def create_dummy_course(self, store_type): def check_export_file(self, tar_file, course_key, with_tags=False): """Check content of export file.""" names = tar_file.getnames() - dirname = "{0.org}-{0.course}-{0.run}".format(course_key) - self.assertIn(dirname, names) + dirname = "{0.org}-{0.course}-{0.run}".format(course_key) # noqa: UP032 + self.assertIn(dirname, names) # noqa: PT009 # Check if some of the files are present, without being exhaustive. - self.assertIn(f"{dirname}/about", names) - self.assertIn(f"{dirname}/about/overview.html", names) - self.assertIn(f"{dirname}/assets/assets.xml", names) - self.assertIn(f"{dirname}/policies", names) + self.assertIn(f"{dirname}/about", names) # noqa: PT009 + self.assertIn(f"{dirname}/about/overview.html", names) # noqa: PT009 + self.assertIn(f"{dirname}/assets/assets.xml", names) # noqa: PT009 + self.assertIn(f"{dirname}/policies", names) # noqa: PT009 if with_tags: - self.assertIn(f"{dirname}/tags.csv", names) + self.assertIn(f"{dirname}/tags.csv", names) # noqa: PT009 else: - self.assertNotIn(f"{dirname}/tags.csv", names) + self.assertNotIn(f"{dirname}/tags.csv", names) # noqa: PT009 def test_export_course(self): test_course_key = self.create_dummy_course(ModuleStoreEnum.Type.split) diff --git a/cms/djangoapps/contentstore/management/commands/tests/test_fix_not_found.py b/cms/djangoapps/contentstore/management/commands/tests/test_fix_not_found.py index b9372d15204b..e17ea55ee98f 100644 --- a/cms/djangoapps/contentstore/management/commands/tests/test_fix_not_found.py +++ b/cms/djangoapps/contentstore/management/commands/tests/test_fix_not_found.py @@ -7,7 +7,7 @@ from xmodule.modulestore import ModuleStoreEnum from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase -from xmodule.modulestore.tests.factories import CourseFactory, BlockFactory +from xmodule.modulestore.tests.factories import BlockFactory, CourseFactory class TestFixNotFound(ModuleStoreTestCase): @@ -20,7 +20,7 @@ def test_no_args(self): """ msg = "Error: the following arguments are required: course_id" - with self.assertRaisesRegex(CommandError, msg): + with self.assertRaisesRegex(CommandError, msg): # noqa: PT027 call_command('fix_not_found') def test_fix_not_found(self): @@ -38,13 +38,13 @@ def test_fix_not_found(self): # the course block should now point to two children, one of which # doesn't actually exist - self.assertEqual(len(course.children), 2) - self.assertIn(dangling_pointer, course.children) + self.assertEqual(len(course.children), 2) # noqa: PT009 + self.assertIn(dangling_pointer, course.children) # noqa: PT009 call_command("fix_not_found", str(course.id)) # make sure the dangling pointer was removed from # the course block's children course = self.store.get_course(course.id) - self.assertEqual(len(course.children), 1) - self.assertNotIn(dangling_pointer, course.children) + self.assertEqual(len(course.children), 1) # noqa: PT009 + self.assertNotIn(dangling_pointer, course.children) # noqa: PT009 diff --git a/cms/djangoapps/contentstore/management/commands/tests/test_force_publish.py b/cms/djangoapps/contentstore/management/commands/tests/test_force_publish.py index ea16707d7eb8..cd5a4b675dde 100644 --- a/cms/djangoapps/contentstore/management/commands/tests/test_force_publish.py +++ b/cms/djangoapps/contentstore/management/commands/tests/test_force_publish.py @@ -9,9 +9,15 @@ from cms.djangoapps.contentstore.management.commands.force_publish import Command from cms.djangoapps.contentstore.management.commands.utils import get_course_versions -from xmodule.modulestore import ModuleStoreEnum # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase, SharedModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory, BlockFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore import ModuleStoreEnum # pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( # pylint: disable=wrong-import-order + ModuleStoreTestCase, + SharedModuleStoreTestCase, +) +from xmodule.modulestore.tests.factories import ( # pylint: disable=wrong-import-order + BlockFactory, + CourseFactory, +) class TestForcePublish(SharedModuleStoreTestCase): @@ -31,7 +37,7 @@ def test_no_args(self): """ errstring = "Error: the following arguments are required: course_key" - with self.assertRaisesRegex(CommandError, errstring): + with self.assertRaisesRegex(CommandError, errstring): # noqa: PT027 call_command('force_publish') def test_invalid_course_key(self): @@ -39,7 +45,7 @@ def test_invalid_course_key(self): Test 'force_publish' command with invalid course key """ errstring = "Invalid course key." - with self.assertRaisesRegex(CommandError, errstring): + with self.assertRaisesRegex(CommandError, errstring): # noqa: PT027 call_command('force_publish', 'TestX/TS01') def test_too_many_arguments(self): @@ -47,7 +53,7 @@ def test_too_many_arguments(self): Test 'force_publish' command with more than 2 arguments """ errstring = "Error: unrecognized arguments: invalid-arg" - with self.assertRaisesRegex(CommandError, errstring): + with self.assertRaisesRegex(CommandError, errstring): # noqa: PT027 call_command('force_publish', str(self.course.id), '--commit', 'invalid-arg') def test_course_key_not_found(self): @@ -55,7 +61,7 @@ def test_course_key_not_found(self): Test 'force_publish' command with non-existing course key """ errstring = "Course not found." - with self.assertRaisesRegex(CommandError, errstring): + with self.assertRaisesRegex(CommandError, errstring): # noqa: PT027 call_command('force_publish', 'course-v1:org+course+run') @@ -85,7 +91,7 @@ def test_force_publish(self): ) # verify that course has changes. - self.assertTrue(self.store.has_changes(self.store.get_item(self.course.location))) + self.assertTrue(self.store.has_changes(self.store.get_item(self.course.location))) # noqa: PT009 # get draft and publish branch versions versions = get_course_versions(str(self.course.id)) @@ -93,7 +99,7 @@ def test_force_publish(self): published_version = versions['published-branch'] # verify that draft and publish point to different versions - self.assertNotEqual(draft_version, published_version) + self.assertNotEqual(draft_version, published_version) # noqa: PT009 with mock.patch('cms.djangoapps.contentstore.management.commands.force_publish.query_yes_no') as patched_yes_no: patched_yes_no.return_value = True @@ -102,7 +108,7 @@ def test_force_publish(self): call_command('force_publish', str(self.course.id), '--commit') # verify that course has no changes - self.assertFalse(self.store.has_changes(self.store.get_item(self.course.location))) + self.assertFalse(self.store.has_changes(self.store.get_item(self.course.location))) # noqa: PT009 # get new draft and publish branch versions versions = get_course_versions(str(self.course.id)) @@ -110,8 +116,8 @@ def test_force_publish(self): new_published_version = versions['published-branch'] # verify that the draft branch didn't change while the published branch did - self.assertEqual(draft_version, new_draft_version) - self.assertNotEqual(published_version, new_published_version) + self.assertEqual(draft_version, new_draft_version) # noqa: PT009 + self.assertNotEqual(published_version, new_published_version) # noqa: PT009 # verify that draft and publish point to same versions now - self.assertEqual(new_draft_version, new_published_version) + self.assertEqual(new_draft_version, new_published_version) # noqa: PT009 diff --git a/cms/djangoapps/contentstore/management/commands/tests/test_generate_courses.py b/cms/djangoapps/contentstore/management/commands/tests/test_generate_courses.py index aa3abf777682..e5398a5e6313 100644 --- a/cms/djangoapps/contentstore/management/commands/tests/test_generate_courses.py +++ b/cms/djangoapps/contentstore/management/commands/tests/test_generate_courses.py @@ -34,7 +34,7 @@ def test_generate_course_in_stores(self, mock_logger): arg = json.dumps(settings) call_command("generate_courses", arg) key = modulestore().make_course_key("test-course-generator", "1", "1") - self.assertTrue(modulestore().has_course(key)) + self.assertTrue(modulestore().has_course(key)) # noqa: PT009 mock_logger.info.assert_any_call("Created course-v1:test-course-generator+1+1") mock_logger.info.assert_any_call("announcement has been set to 2010-04-20T20:08:21.634121") mock_logger.info.assert_any_call("display_name has been set to test-course") @@ -43,7 +43,7 @@ def test_invalid_json(self): """ Test that providing an invalid JSON object will result in the appropriate command error """ - with self.assertRaisesRegex(CommandError, "Invalid JSON object"): + with self.assertRaisesRegex(CommandError, "Invalid JSON object"): # noqa: PT027 arg = "invalid_json" call_command("generate_courses", arg) @@ -51,7 +51,7 @@ def test_missing_courses_list(self): """ Test that a missing list of courses in json will result in the appropriate command error """ - with self.assertRaisesRegex(CommandError, "JSON object is missing courses list"): + with self.assertRaisesRegex(CommandError, "JSON object is missing courses list"): # noqa: PT027 settings = {} arg = json.dumps(settings) call_command("generate_courses", arg) diff --git a/cms/djangoapps/contentstore/management/commands/tests/test_git_export.py b/cms/djangoapps/contentstore/management/commands/tests/test_git_export.py index 8a2334b34375..bb8aa136f72e 100644 --- a/cms/djangoapps/contentstore/management/commands/tests/test_git_export.py +++ b/cms/djangoapps/contentstore/management/commands/tests/test_git_export.py @@ -9,13 +9,14 @@ import subprocess import unittest from io import StringIO +from unittest.mock import patch from uuid import uuid4 from django.conf import settings from django.core.management import call_command from django.core.management.base import CommandError from django.test.utils import override_settings -from opaque_keys.edx.locator import CourseLocator +from opaque_keys.edx.locator import CourseLocator, LibraryLocator, LibraryLocatorV2 import cms.djangoapps.contentstore.git_export_utils as git_export_utils from cms.djangoapps.contentstore.git_export_utils import GitExportError @@ -24,7 +25,7 @@ FEATURES_WITH_EXPORT_GIT = settings.FEATURES.copy() FEATURES_WITH_EXPORT_GIT['ENABLE_EXPORT_GIT'] = True TEST_DATA_CONTENTSTORE = copy.deepcopy(settings.CONTENTSTORE) -TEST_DATA_CONTENTSTORE['DOC_STORE_CONFIG']['db'] = 'test_xcontent_%s' % uuid4().hex +TEST_DATA_CONTENTSTORE['DOC_STORE_CONFIG']['db'] = 'test_xcontent_%s' % uuid4().hex # noqa: UP031 @override_settings(CONTENTSTORE=TEST_DATA_CONTENTSTORE) @@ -34,6 +35,9 @@ class TestGitExport(CourseTestCase): Excercise the git_export django management command with various inputs. """ + LIBRARY_V2_KEY = LibraryLocatorV2(org='TestOrg', slug='test-lib') + LIBRARY_V1_KEY = LibraryLocator(org='TestOrg', library='test-lib') + def setUp(self): """ Create/reinitialize bare repo and folders needed @@ -44,7 +48,7 @@ def setUp(self): os.mkdir(git_export_utils.GIT_REPO_EXPORT_DIR) self.addCleanup(shutil.rmtree, git_export_utils.GIT_REPO_EXPORT_DIR) - self.bare_repo_dir = '{}/data/test_bare.git'.format( + self.bare_repo_dir = '{}/data/test_bare.git'.format( # noqa: UP032 os.path.abspath(settings.TEST_ROOT)) if not os.path.isdir(self.bare_repo_dir): os.mkdir(self.bare_repo_dir) @@ -57,7 +61,7 @@ def test_command(self): Test that the command interface works. Ignore stderr for clean test output. """ - with self.assertRaisesRegex(CommandError, 'Error: unrecognized arguments:*'): + with self.assertRaisesRegex(CommandError, 'Error: unrecognized arguments:*'): # noqa: PT027 call_command('git_export', 'blah', 'blah', 'blah', stderr=StringIO()) with self.assertRaisesMessage( @@ -67,23 +71,23 @@ def test_command(self): call_command('git_export', stderr=StringIO()) # Send bad url to get course not exported - with self.assertRaisesRegex(CommandError, str(GitExportError.URL_BAD)): + with self.assertRaisesRegex(CommandError, str(GitExportError.URL_BAD)): # noqa: PT027 call_command('git_export', 'foo/bar/baz', 'silly', stderr=StringIO()) # Send bad course_id to get course not exported - with self.assertRaisesRegex(CommandError, str(GitExportError.BAD_COURSE)): + with self.assertRaisesRegex(CommandError, str(GitExportError.BAD_COURSE)): # noqa: PT027 call_command('git_export', 'foo/bar:baz', 'silly', stderr=StringIO()) def test_error_output(self): """ Verify that error output is actually resolved as the correct string """ - with self.assertRaisesRegex(CommandError, str(GitExportError.BAD_COURSE)): + with self.assertRaisesRegex(CommandError, str(GitExportError.BAD_COURSE)): # noqa: PT027 call_command( 'git_export', 'foo/bar:baz', 'silly' ) - with self.assertRaisesRegex(CommandError, str(GitExportError.URL_BAD)): + with self.assertRaisesRegex(CommandError, str(GitExportError.URL_BAD)): # noqa: PT027 call_command( 'git_export', 'foo/bar/baz', 'silly' ) @@ -93,13 +97,13 @@ def test_bad_git_url(self): Test several bad URLs for validation """ course_key = CourseLocator('org', 'course', 'run') - with self.assertRaisesRegex(GitExportError, str(GitExportError.URL_BAD)): + with self.assertRaisesRegex(GitExportError, str(GitExportError.URL_BAD)): # noqa: PT027 git_export_utils.export_to_git(course_key, 'Sillyness') - with self.assertRaisesRegex(GitExportError, str(GitExportError.URL_BAD)): + with self.assertRaisesRegex(GitExportError, str(GitExportError.URL_BAD)): # noqa: PT027 git_export_utils.export_to_git(course_key, 'example.com:edx/notreal') - with self.assertRaisesRegex(GitExportError, str(GitExportError.URL_NO_AUTH)): + with self.assertRaisesRegex(GitExportError, str(GitExportError.URL_NO_AUTH)): # noqa: PT027 git_export_utils.export_to_git(course_key, 'http://blah') def test_bad_git_repos(self): @@ -107,23 +111,23 @@ def test_bad_git_repos(self): Test invalid git repos """ test_repo_path = f'{git_export_utils.GIT_REPO_EXPORT_DIR}/test_repo' - self.assertFalse(os.path.isdir(test_repo_path)) + self.assertFalse(os.path.isdir(test_repo_path)) # noqa: PT009 course_key = CourseLocator('foo', 'blah', '100-') # Test bad clones - with self.assertRaisesRegex(GitExportError, str(GitExportError.CANNOT_PULL)): + with self.assertRaisesRegex(GitExportError, str(GitExportError.CANNOT_PULL)): # noqa: PT027 git_export_utils.export_to_git( course_key, 'https://user:blah@example.com/test_repo.git') - self.assertFalse(os.path.isdir(test_repo_path)) + self.assertFalse(os.path.isdir(test_repo_path)) # noqa: PT009 # Setup good repo with bad course to test xml export - with self.assertRaisesRegex(GitExportError, str(GitExportError.XML_EXPORT_FAIL)): + with self.assertRaisesRegex(GitExportError, str(GitExportError.XML_EXPORT_FAIL)): # noqa: PT027 git_export_utils.export_to_git( course_key, f'file://{self.bare_repo_dir}') # Test bad git remote after successful clone - with self.assertRaisesRegex(GitExportError, str(GitExportError.CANNOT_PULL)): + with self.assertRaisesRegex(GitExportError, str(GitExportError.CANNOT_PULL)): # noqa: PT027 git_export_utils.export_to_git( course_key, 'https://user:blah@example.com/r.git') @@ -153,7 +157,7 @@ def test_git_ident(self): cwd = os.path.abspath(git_export_utils.GIT_REPO_EXPORT_DIR / 'test_bare') git_log = subprocess.check_output(['git', 'log', '-1', '--format=%an|%ae'], cwd=cwd).decode('utf-8') - self.assertEqual(expect_string, git_log) + self.assertEqual(expect_string, git_log) # noqa: PT009 # Make changes to course so there is something to commit self.populate_course() @@ -162,13 +166,13 @@ def test_git_ident(self): f'file://{self.bare_repo_dir}', self.user.username ) - expect_string = '{}|{}\n'.format( + expect_string = '{}|{}\n'.format( # noqa: UP032 self.user.username, self.user.email, ) git_log = subprocess.check_output( ['git', 'log', '-1', '--format=%an|%ae'], cwd=cwd).decode('utf-8') - self.assertEqual(expect_string, git_log) + self.assertEqual(expect_string, git_log) # noqa: PT009 def test_no_change(self): """ @@ -179,6 +183,55 @@ def test_no_change(self): f'file://{self.bare_repo_dir}' ) - with self.assertRaisesRegex(GitExportError, str(GitExportError.CANNOT_COMMIT)): + with self.assertRaisesRegex(GitExportError, str(GitExportError.CANNOT_COMMIT)): # noqa: PT027 git_export_utils.export_to_git( self.course.id, f'file://{self.bare_repo_dir}') + + @patch('cms.djangoapps.contentstore.git_export_utils.cmd_log', return_value=b'main') + @patch('cms.djangoapps.contentstore.git_export_utils.extract_library_v2_zip_to_dir') + def test_library_v2_export_selects_correct_function(self, mock_extract, mock_cmd_log): + """ + When ``export_to_git`` is given a LibraryLocatorV2 key it must call + ``extract_library_v2_zip_to_dir`` and must not call the v1 XML export + functions (``export_library_to_xml`` or ``export_course_to_xml``). + cmd_log is mocked so no real git subprocess or repo state is needed. + """ + mock_extract.return_value = None + repo_url = f'file://{self.bare_repo_dir}' + + with patch('cms.djangoapps.contentstore.git_export_utils.export_course_to_xml') as mock_course_xml, \ + patch('cms.djangoapps.contentstore.git_export_utils.export_library_to_xml') as mock_lib_xml: + git_export_utils.export_to_git(self.LIBRARY_V2_KEY, repo_url, self.user.username) + + assert mock_extract.call_args[0][0] == self.LIBRARY_V2_KEY + mock_course_xml.assert_not_called() + mock_lib_xml.assert_not_called() + + @patch('cms.djangoapps.contentstore.git_export_utils.cmd_log', return_value=b'main') + @patch('cms.djangoapps.contentstore.git_export_utils.export_library_to_xml') + def test_library_v1_export_selects_correct_function(self, mock_lib_xml, mock_cmd_log): + """ + When ``export_to_git`` is given a LibraryLocator (v1) key it must call + ``export_library_to_xml`` and must not call ``extract_library_v2_zip_to_dir``. + cmd_log is mocked so no real git subprocess or repo state is needed. + """ + mock_lib_xml.return_value = None + repo_url = f'file://{self.bare_repo_dir}' + + with patch('cms.djangoapps.contentstore.git_export_utils.extract_library_v2_zip_to_dir') as mock_v2, \ + patch('cms.djangoapps.contentstore.git_export_utils.export_course_to_xml') as mock_course_xml: + git_export_utils.export_to_git(self.LIBRARY_V1_KEY, repo_url, self.user.username) + + assert mock_lib_xml.called + mock_v2.assert_not_called() + mock_course_xml.assert_not_called() + + @patch('cms.djangoapps.contentstore.git_export_utils.extract_library_v2_zip_to_dir', + side_effect=OSError('disk full')) + def test_library_v2_export_failure_raises_xml_export_fail(self, mock_extract): + """ + If ``extract_library_v2_zip_to_dir`` raises, ``export_to_git`` should + wrap it in ``GitExportError.XML_EXPORT_FAIL``. + """ + with self.assertRaisesRegex(GitExportError, str(GitExportError.XML_EXPORT_FAIL)): # noqa: PT027 + git_export_utils.export_to_git(self.LIBRARY_V2_KEY, f'file://{self.bare_repo_dir}') diff --git a/cms/djangoapps/contentstore/management/commands/tests/test_import.py b/cms/djangoapps/contentstore/management/commands/tests/test_import.py index 5b90973b0463..b8a77e628220 100644 --- a/cms/djangoapps/contentstore/management/commands/tests/test_import.py +++ b/cms/djangoapps/contentstore/management/commands/tests/test_import.py @@ -11,8 +11,10 @@ from path import Path as path from openedx.core.djangoapps.django_comment_common.utils import are_permissions_roles_seeded -from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + ModuleStoreTestCase, # pylint: disable=wrong-import-order +) class TestImport(ModuleStoreTestCase): @@ -20,11 +22,11 @@ class TestImport(ModuleStoreTestCase): Unit tests for importing a course from command line """ - def create_course_xml(self, content_dir, course_id): # lint-amnesty, pylint: disable=missing-function-docstring + def create_course_xml(self, content_dir, course_id): # pylint: disable=missing-function-docstring directory = tempfile.mkdtemp(dir=content_dir) os.makedirs(os.path.join(directory, "course")) with open(os.path.join(directory, "course.xml"), "w+") as f: - f.write(''.format(course_id)) + f.write(''.format(course_id)) # noqa: UP032 with open(os.path.join(directory, "course", f"{course_id.run}.xml"), "w+") as f: f.write('') @@ -53,9 +55,9 @@ def test_forum_seed(self): """ Tests that forum roles were created with import. """ - self.assertFalse(are_permissions_roles_seeded(self.base_course_key)) + self.assertFalse(are_permissions_roles_seeded(self.base_course_key)) # noqa: PT009 call_command('import', self.content_dir, self.good_dir) - self.assertTrue(are_permissions_roles_seeded(self.base_course_key)) + self.assertTrue(are_permissions_roles_seeded(self.base_course_key)) # noqa: PT009 def test_truncated_course_with_url(self): """ @@ -67,8 +69,8 @@ def test_truncated_course_with_url(self): # Load up base course and verify it is available call_command('import', self.content_dir, self.good_dir) store = modulestore() - self.assertIsNotNone(store.get_course(self.base_course_key)) + self.assertIsNotNone(store.get_course(self.base_course_key)) # noqa: PT009 # Now load up the course with a similar course_id and verify it loads call_command('import', self.content_dir, self.course_dir) - self.assertIsNotNone(store.get_course(self.truncated_key)) + self.assertIsNotNone(store.get_course(self.truncated_key)) # noqa: PT009 diff --git a/cms/djangoapps/contentstore/management/commands/tests/test_reindex_courses.py b/cms/djangoapps/contentstore/management/commands/tests/test_reindex_courses.py index 6d14b4a339f2..6c733d0501a9 100644 --- a/cms/djangoapps/contentstore/management/commands/tests/test_reindex_courses.py +++ b/cms/djangoapps/contentstore/management/commands/tests/test_reindex_courses.py @@ -1,16 +1,22 @@ """ Tests for course reindex command """ +from datetime import datetime, timedelta from unittest import mock import ddt from django.core.management import CommandError, call_command + from cms.djangoapps.contentstore.management.commands.reindex_course import Command as ReindexCommand -from xmodule.modulestore import ModuleStoreEnum # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory, LibraryFactory # lint-amnesty, pylint: disable=wrong-import-order -from datetime import datetime, timedelta +from xmodule.modulestore import ModuleStoreEnum # pylint: disable=wrong-import-order +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + ModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import ( # pylint: disable=wrong-import-order + CourseFactory, + LibraryFactory, +) @ddt.ddt @@ -60,25 +66,25 @@ def _build_calls(self, *courses): def test_given_no_arguments_raises_command_error(self): """ Test that raises CommandError for incorrect arguments """ - with self.assertRaisesRegex(CommandError, ".* requires one or more *"): + with self.assertRaisesRegex(CommandError, ".* requires one or more *"): # noqa: PT027 call_command('reindex_course') @ddt.data('qwerty', 'invalid_key', 'xblockv1:qwerty') def test_given_invalid_course_key_raises_not_found(self, invalid_key): """ Test that raises InvalidKeyError for invalid keys """ err_string = f"Invalid course_key: '{invalid_key}'" - with self.assertRaisesRegex(CommandError, err_string): + with self.assertRaisesRegex(CommandError, err_string): # noqa: PT027 call_command('reindex_course', invalid_key) def test_given_library_key_raises_command_error(self): """ Test that raises CommandError if library key is passed """ - with self.assertRaisesRegex(CommandError, ".* is not a course key"): + with self.assertRaisesRegex(CommandError, ".* is not a course key"): # noqa: PT027 call_command('reindex_course', str(self._get_lib_key(self.first_lib))) - with self.assertRaisesRegex(CommandError, ".* is not a course key"): + with self.assertRaisesRegex(CommandError, ".* is not a course key"): # noqa: PT027 call_command('reindex_course', str(self._get_lib_key(self.second_lib))) - with self.assertRaisesRegex(CommandError, ".* is not a course key"): + with self.assertRaisesRegex(CommandError, ".* is not a course key"): # noqa: PT027 call_command( 'reindex_course', str(self.second_course.id), @@ -90,11 +96,11 @@ def test_given_id_list_indexes_courses(self): with mock.patch(self.REINDEX_PATH_LOCATION) as patched_index, \ mock.patch(self.MODULESTORE_PATCH_LOCATION, mock.Mock(return_value=self.store)): call_command('reindex_course', str(self.first_course.id)) - self.assertEqual(patched_index.mock_calls, self._build_calls(self.first_course)) + self.assertEqual(patched_index.mock_calls, self._build_calls(self.first_course)) # noqa: PT009 patched_index.reset_mock() call_command('reindex_course', str(self.second_course.id)) - self.assertEqual(patched_index.mock_calls, self._build_calls(self.second_course)) + self.assertEqual(patched_index.mock_calls, self._build_calls(self.second_course)) # noqa: PT009 patched_index.reset_mock() call_command( @@ -103,7 +109,7 @@ def test_given_id_list_indexes_courses(self): str(self.second_course.id) ) expected_calls = self._build_calls(self.first_course, self.second_course) - self.assertEqual(patched_index.mock_calls, expected_calls) + self.assertEqual(patched_index.mock_calls, expected_calls) # noqa: PT009 def test_given_all_key_prompts_and_reindexes_all_courses(self): """ Test that reindexes all courses when --all key is given and confirmed """ @@ -117,7 +123,7 @@ def test_given_all_key_prompts_and_reindexes_all_courses(self): expected_calls = self._build_calls( self.first_course, self.second_course, self.third_course, self.fourth_course ) - self.assertCountEqual(patched_index.mock_calls, expected_calls) + self.assertCountEqual(patched_index.mock_calls, expected_calls) # noqa: PT009 def test_given_all_key_prompts_and_reindexes_all_courses_cancelled(self): """ Test that does not reindex anything when --all key is given and cancelled """ @@ -140,7 +146,7 @@ def test_given_active_key_prompt(self): call_command('reindex_course', active=True) expected_calls = self._build_calls(self.first_course, self.fourth_course) - self.assertCountEqual(patched_index.mock_calls, expected_calls) + self.assertCountEqual(patched_index.mock_calls, expected_calls) # noqa: PT009 @mock.patch.dict( 'django.conf.settings.FEATURES', @@ -156,4 +162,4 @@ def test_given_from_inclusion_date_key_prompt(self): call_command('reindex_course', from_inclusion_date=True) expected_calls = self._build_calls(self.first_course, self.second_course) - self.assertCountEqual(patched_index.mock_calls, expected_calls) + self.assertCountEqual(patched_index.mock_calls, expected_calls) # noqa: PT009 diff --git a/cms/djangoapps/contentstore/management/commands/tests/test_reindex_library.py b/cms/djangoapps/contentstore/management/commands/tests/test_reindex_library.py index d5013cf69462..3147060cb651 100644 --- a/cms/djangoapps/contentstore/management/commands/tests/test_reindex_library.py +++ b/cms/djangoapps/contentstore/management/commands/tests/test_reindex_library.py @@ -9,10 +9,15 @@ from cms.djangoapps.contentstore.courseware_index import SearchIndexingError from cms.djangoapps.contentstore.management.commands.reindex_library import Command as ReindexCommand -from xmodule.modulestore import ModuleStoreEnum # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory, LibraryFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore import ModuleStoreEnum # pylint: disable=wrong-import-order +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + ModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import ( # pylint: disable=wrong-import-order + CourseFactory, + LibraryFactory, +) @ddt.ddt @@ -52,24 +57,24 @@ def _build_calls(self, *libraries): def test_given_no_arguments_raises_command_error(self): """ Test that raises CommandError for incorrect arguments """ - with self.assertRaisesRegex(CommandError, ".* requires one or more *"): + with self.assertRaisesRegex(CommandError, ".* requires one or more *"): # noqa: PT027 call_command('reindex_library') @ddt.data('qwerty', 'invalid_key', 'xblock-v1:qwe+rty') def test_given_invalid_lib_key_raises_not_found(self, invalid_key): """ Test that raises InvalidKeyError for invalid keys """ - with self.assertRaises(InvalidKeyError): + with self.assertRaises(InvalidKeyError): # noqa: PT027 call_command('reindex_library', invalid_key) def test_given_course_key_raises_command_error(self): """ Test that raises CommandError if course key is passed """ - with self.assertRaisesRegex(CommandError, ".* is not a library key"): + with self.assertRaisesRegex(CommandError, ".* is not a library key"): # noqa: PT027 call_command('reindex_library', str(self.first_course.id)) - with self.assertRaisesRegex(CommandError, ".* is not a library key"): + with self.assertRaisesRegex(CommandError, ".* is not a library key"): # noqa: PT027 call_command('reindex_library', str(self.second_course.id)) - with self.assertRaisesRegex(CommandError, ".* is not a library key"): + with self.assertRaisesRegex(CommandError, ".* is not a library key"): # noqa: PT027 call_command( 'reindex_library', str(self.second_course.id), @@ -81,11 +86,11 @@ def test_given_id_list_indexes_libraries(self): with mock.patch(self.REINDEX_PATH_LOCATION) as patched_index, \ mock.patch(self.MODULESTORE_PATCH_LOCATION, mock.Mock(return_value=self.store)): call_command('reindex_library', str(self._get_lib_key(self.first_lib))) - self.assertEqual(patched_index.mock_calls, self._build_calls(self.first_lib)) + self.assertEqual(patched_index.mock_calls, self._build_calls(self.first_lib)) # noqa: PT009 patched_index.reset_mock() call_command('reindex_library', str(self._get_lib_key(self.second_lib))) - self.assertEqual(patched_index.mock_calls, self._build_calls(self.second_lib)) + self.assertEqual(patched_index.mock_calls, self._build_calls(self.second_lib)) # noqa: PT009 patched_index.reset_mock() call_command( @@ -94,7 +99,7 @@ def test_given_id_list_indexes_libraries(self): str(self._get_lib_key(self.second_lib)) ) expected_calls = self._build_calls(self.first_lib, self.second_lib) - self.assertEqual(patched_index.mock_calls, expected_calls) + self.assertEqual(patched_index.mock_calls, expected_calls) # noqa: PT009 def test_given_all_key_prompts_and_reindexes_all_libraries(self): """ Test that reindexes all libraries when --all key is given and confirmed """ @@ -106,7 +111,7 @@ def test_given_all_key_prompts_and_reindexes_all_libraries(self): patched_yes_no.assert_called_once_with(ReindexCommand.CONFIRMATION_PROMPT, default='no') expected_calls = self._build_calls(self.first_lib, self.second_lib) - self.assertCountEqual(patched_index.mock_calls, expected_calls) + self.assertCountEqual(patched_index.mock_calls, expected_calls) # noqa: PT009 def test_given_all_key_prompts_and_reindexes_all_libraries_cancelled(self): """ Test that does not reindex anything when --all key is given and cancelled """ @@ -124,5 +129,5 @@ def test_fail_fast_if_reindex_fails(self): with mock.patch(self.REINDEX_PATH_LOCATION) as patched_index: patched_index.side_effect = SearchIndexingError("message", []) - with self.assertRaises(SearchIndexingError): + with self.assertRaises(SearchIndexingError): # noqa: PT027 call_command('reindex_library', str(self._get_lib_key(self.second_lib))) diff --git a/cms/djangoapps/contentstore/management/commands/tests/test_reset_course_content.py b/cms/djangoapps/contentstore/management/commands/tests/test_reset_course_content.py index 73a00f36b3c9..843a2795507a 100644 --- a/cms/djangoapps/contentstore/management/commands/tests/test_reset_course_content.py +++ b/cms/djangoapps/contentstore/management/commands/tests/test_reset_course_content.py @@ -21,15 +21,15 @@ class TestCommand(TestCase): """ def test_bad_course_id(self): - with self.assertRaises(InvalidKeyError): + with self.assertRaises(InvalidKeyError): # noqa: PT027 call_command("reset_course_content", "not_a_course_id", "0123456789abcdef01234567") def test_wrong_length_version_guid(self): - with self.assertRaises(CommandError): + with self.assertRaises(CommandError): # noqa: PT027 call_command("reset_course_content", "course-v1:a+b+c", "0123456789abcdef") def test_non_hex_version_guid(self): - with self.assertRaises(CommandError): + with self.assertRaises(CommandError): # noqa: PT027 call_command("reset_course_content", "course-v1:a+b+c", "0123456789abcdefghijklmn") @mock.patch.object(MixedModuleStore, "reset_course_to_version") diff --git a/cms/djangoapps/contentstore/management/commands/tests/test_sync_courses.py b/cms/djangoapps/contentstore/management/commands/tests/test_sync_courses.py index 6894bc49556f..915c57fefb40 100644 --- a/cms/djangoapps/contentstore/management/commands/tests/test_sync_courses.py +++ b/cms/djangoapps/contentstore/management/commands/tests/test_sync_courses.py @@ -11,9 +11,11 @@ from common.djangoapps.student.tests.factories import UserFactory from openedx.core.djangoapps.catalog.tests.factories import CourseRunFactory from openedx.core.djangoapps.content.course_overviews.models import CourseOverview -from xmodule.modulestore import ModuleStoreEnum # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore import ModuleStoreEnum # pylint: disable=wrong-import-order +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + ModuleStoreTestCase, # pylint: disable=wrong-import-order +) COMMAND_MODULE = 'cms.djangoapps.contentstore.management.commands.sync_courses' @@ -33,9 +35,9 @@ def setUp(self): def _validate_courses(self): for run in self.catalog_course_runs: - course_key = CourseKey.from_string(run.get('key')) # lint-amnesty, pylint: disable=no-member - self.assertTrue(modulestore().has_course(course_key)) - CourseOverview.objects.get(id=run.get('key')) # lint-amnesty, pylint: disable=no-member + course_key = CourseKey.from_string(run.get('key')) # pylint: disable=no-member + self.assertTrue(modulestore().has_course(course_key)) # noqa: PT009 + CourseOverview.objects.get(id=run.get('key')) # pylint: disable=no-member def test_courses_sync(self, mock_catalog_course_runs): mock_catalog_course_runs.return_value = self.catalog_course_runs @@ -63,7 +65,7 @@ def test_duplicate_courses_skipped(self, mock_catalog_course_runs): with LogCapture() as capture: call_command('sync_courses', self.user.email) - expected_message = "Course already exists for {}, {}, {}. Skipping".format( + expected_message = "Course already exists for {}, {}, {}. Skipping".format( # noqa: UP032 course_key.org, course_key.course, course_key.run, @@ -75,4 +77,4 @@ def test_duplicate_courses_skipped(self, mock_catalog_course_runs): self._validate_courses() course = modulestore().get_course(course_key) - self.assertEqual(course.display_name, initial_display_name) + self.assertEqual(course.display_name, initial_display_name) # noqa: PT009 diff --git a/cms/djangoapps/contentstore/management/commands/utils.py b/cms/djangoapps/contentstore/management/commands/utils.py index be697e030670..01fc3ad6bf7e 100644 --- a/cms/djangoapps/contentstore/management/commands/utils.py +++ b/cms/djangoapps/contentstore/management/commands/utils.py @@ -3,7 +3,7 @@ """ -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from opaque_keys.edx.keys import CourseKey from xmodule.modulestore.django import modulestore diff --git a/cms/djangoapps/contentstore/management/commands/xlint.py b/cms/djangoapps/contentstore/management/commands/xlint.py index d7e93d44de0a..24e0abd05e68 100644 --- a/cms/djangoapps/contentstore/management/commands/xlint.py +++ b/cms/djangoapps/contentstore/management/commands/xlint.py @@ -27,7 +27,7 @@ def handle(self, *args, **options): data_dir = options['data_dir'] source_dirs = options['source_dirs'] - print("Importing. Data_dir={data}, source_dirs={courses}".format( + print("Importing. Data_dir={data}, source_dirs={courses}".format( # noqa: UP032 data=data_dir, courses=source_dirs)) diff --git a/cms/djangoapps/contentstore/migrations/0001_squashed_0015_switch_to_openedx_content.py b/cms/djangoapps/contentstore/migrations/0001_squashed_0015_switch_to_openedx_content.py index f65c9a8cd3b0..d33c265979c5 100644 --- a/cms/djangoapps/contentstore/migrations/0001_squashed_0015_switch_to_openedx_content.py +++ b/cms/djangoapps/contentstore/migrations/0001_squashed_0015_switch_to_openedx_content.py @@ -1,11 +1,12 @@ # Generated by Django 5.2.10 on 2026-01-30 01:23 +import uuid + import django.db.migrations.operations.special import django.db.models.deletion import opaque_keys.edx.django.models -import openedx_learning.lib.fields -import openedx_learning.lib.validators -import uuid +import openedx_django_lib.fields +import openedx_django_lib.validators from django.conf import settings from django.db import migrations, models @@ -107,8 +108,8 @@ class Migration(migrations.Migration): ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), ('context_key', opaque_keys.edx.django.models.CourseKeyField(help_text='Linking status for course context key', max_length=255, unique=True)), ('status', models.CharField(choices=[('pending', 'Pending'), ('processing', 'Processing'), ('failed', 'Failed'), ('completed', 'Completed')], help_text='Status of links in given learning context/course.', max_length=20)), - ('created', models.DateTimeField(validators=[openedx_learning.lib.validators.validate_utc_datetime])), - ('updated', models.DateTimeField(validators=[openedx_learning.lib.validators.validate_utc_datetime])), + ('created', models.DateTimeField(validators=[openedx_django_lib.validators.validate_utc_datetime])), + ('updated', models.DateTimeField(validators=[openedx_django_lib.validators.validate_utc_datetime])), ], options={ 'verbose_name': 'Learning Context Links status', @@ -121,13 +122,13 @@ class Migration(migrations.Migration): ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), ('uuid', models.UUIDField(default=uuid.uuid4, editable=False, unique=True, verbose_name='UUID')), ('upstream_usage_key', opaque_keys.edx.django.models.UsageKeyField(help_text='Upstream block usage key, this value cannot be null and useful to track upstream library blocks that do not exist yet', max_length=255)), - ('upstream_context_key', openedx_learning.lib.fields.MultiCollationCharField(db_collations={'mysql': 'utf8mb4_bin', 'sqlite': 'BINARY'}, db_index=True, help_text='Upstream context key i.e., learning_package/library key', max_length=500)), + ('upstream_context_key', openedx_django_lib.fields.MultiCollationCharField(db_collations={'mysql': 'utf8mb4_bin', 'sqlite': 'BINARY'}, db_index=True, help_text='Upstream context key i.e., learning_package/library key', max_length=500)), ('downstream_usage_key', opaque_keys.edx.django.models.UsageKeyField(max_length=255, unique=True)), ('downstream_context_key', opaque_keys.edx.django.models.CourseKeyField(db_index=True, max_length=255)), ('version_synced', models.IntegerField()), ('version_declined', models.IntegerField(blank=True, null=True)), - ('created', models.DateTimeField(validators=[openedx_learning.lib.validators.validate_utc_datetime])), - ('updated', models.DateTimeField(validators=[openedx_learning.lib.validators.validate_utc_datetime])), + ('created', models.DateTimeField(validators=[openedx_django_lib.validators.validate_utc_datetime])), + ('updated', models.DateTimeField(validators=[openedx_django_lib.validators.validate_utc_datetime])), ('upstream_block', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='links', to='openedx_content.component')), ], options={ @@ -140,13 +141,13 @@ class Migration(migrations.Migration): fields=[ ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), ('uuid', models.UUIDField(default=uuid.uuid4, editable=False, unique=True, verbose_name='UUID')), - ('upstream_context_key', openedx_learning.lib.fields.MultiCollationCharField(db_collations={'mysql': 'utf8mb4_bin', 'sqlite': 'BINARY'}, db_index=True, help_text='Upstream context key i.e., learning_package/library key', max_length=500)), + ('upstream_context_key', openedx_django_lib.fields.MultiCollationCharField(db_collations={'mysql': 'utf8mb4_bin', 'sqlite': 'BINARY'}, db_index=True, help_text='Upstream context key i.e., learning_package/library key', max_length=500)), ('downstream_usage_key', opaque_keys.edx.django.models.UsageKeyField(max_length=255, unique=True)), ('downstream_context_key', opaque_keys.edx.django.models.CourseKeyField(db_index=True, max_length=255)), ('version_synced', models.IntegerField()), ('version_declined', models.IntegerField(blank=True, null=True)), - ('created', models.DateTimeField(validators=[openedx_learning.lib.validators.validate_utc_datetime])), - ('updated', models.DateTimeField(validators=[openedx_learning.lib.validators.validate_utc_datetime])), + ('created', models.DateTimeField(validators=[openedx_django_lib.validators.validate_utc_datetime])), + ('updated', models.DateTimeField(validators=[openedx_django_lib.validators.validate_utc_datetime])), ('upstream_container_key', opaque_keys.edx.django.models.ContainerKeyField(help_text='Upstream block key (e.g. lct:...), this value cannot be null and is useful to track upstream library blocks that do not exist yet or were deleted.', max_length=255)), ('upstream_container', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='links', to='openedx_content.container')), ], diff --git a/cms/djangoapps/contentstore/migrations/0007_backfillcoursetabsconfig.py b/cms/djangoapps/contentstore/migrations/0007_backfillcoursetabsconfig.py index 2123798d83e8..235373267153 100644 --- a/cms/djangoapps/contentstore/migrations/0007_backfillcoursetabsconfig.py +++ b/cms/djangoapps/contentstore/migrations/0007_backfillcoursetabsconfig.py @@ -1,8 +1,8 @@ # Generated by Django 3.2.12 on 2022-03-18 13:49 +import django.db.models.deletion from django.conf import settings from django.db import migrations, models -import django.db.models.deletion class Migration(migrations.Migration): diff --git a/cms/djangoapps/contentstore/migrations/0008_cleanstalecertificateavailabilitydatesconfig.py b/cms/djangoapps/contentstore/migrations/0008_cleanstalecertificateavailabilitydatesconfig.py index 50187a8cac54..034c8fbbdc13 100644 --- a/cms/djangoapps/contentstore/migrations/0008_cleanstalecertificateavailabilitydatesconfig.py +++ b/cms/djangoapps/contentstore/migrations/0008_cleanstalecertificateavailabilitydatesconfig.py @@ -1,8 +1,8 @@ # Generated by Django 3.2.13 on 2022-07-11 17:08 +import django.db.models.deletion from django.conf import settings from django.db import migrations, models -import django.db.models.deletion class Migration(migrations.Migration): diff --git a/cms/djangoapps/contentstore/migrations/0009_learningcontextlinksstatus_publishableentitylink.py b/cms/djangoapps/contentstore/migrations/0009_learningcontextlinksstatus_publishableentitylink.py index 84b80cd63359..9f32a904eb6b 100644 --- a/cms/djangoapps/contentstore/migrations/0009_learningcontextlinksstatus_publishableentitylink.py +++ b/cms/djangoapps/contentstore/migrations/0009_learningcontextlinksstatus_publishableentitylink.py @@ -4,8 +4,8 @@ import django.db.models.deletion import opaque_keys.edx.django.models -import openedx_learning.lib.fields -import openedx_learning.lib.validators +import openedx_django_lib.fields +import openedx_django_lib.validators from django.db import migrations, models @@ -39,8 +39,8 @@ class Migration(migrations.Migration): max_length=20, ), ), - ('created', models.DateTimeField(validators=[openedx_learning.lib.validators.validate_utc_datetime])), - ('updated', models.DateTimeField(validators=[openedx_learning.lib.validators.validate_utc_datetime])), + ('created', models.DateTimeField(validators=[openedx_django_lib.validators.validate_utc_datetime])), + ('updated', models.DateTimeField(validators=[openedx_django_lib.validators.validate_utc_datetime])), ], options={ 'verbose_name': 'Learning Context Links status', @@ -61,7 +61,7 @@ class Migration(migrations.Migration): ), ( 'upstream_context_key', - openedx_learning.lib.fields.MultiCollationCharField( + openedx_django_lib.fields.MultiCollationCharField( db_collations={'mysql': 'utf8mb4_bin', 'sqlite': 'BINARY'}, db_index=True, help_text='Upstream context key i.e., learning_package/library key', @@ -72,8 +72,8 @@ class Migration(migrations.Migration): ('downstream_context_key', opaque_keys.edx.django.models.CourseKeyField(db_index=True, max_length=255)), ('version_synced', models.IntegerField()), ('version_declined', models.IntegerField(blank=True, null=True)), - ('created', models.DateTimeField(validators=[openedx_learning.lib.validators.validate_utc_datetime])), - ('updated', models.DateTimeField(validators=[openedx_learning.lib.validators.validate_utc_datetime])), + ('created', models.DateTimeField(validators=[openedx_django_lib.validators.validate_utc_datetime])), + ('updated', models.DateTimeField(validators=[openedx_django_lib.validators.validate_utc_datetime])), ( 'upstream_block', models.ForeignKey( diff --git a/cms/djangoapps/contentstore/migrations/0010_container_link_models.py b/cms/djangoapps/contentstore/migrations/0010_container_link_models.py index 8d42ad96145d..9ec26d84edf8 100644 --- a/cms/djangoapps/contentstore/migrations/0010_container_link_models.py +++ b/cms/djangoapps/contentstore/migrations/0010_container_link_models.py @@ -3,8 +3,8 @@ import django.db.models.deletion import opaque_keys.edx.django.models -import openedx_learning.lib.fields -import openedx_learning.lib.validators +import openedx_django_lib.fields +import openedx_django_lib.validators from django.db import migrations, models @@ -40,13 +40,13 @@ class Migration(migrations.Migration): fields=[ ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), ('uuid', models.UUIDField(default=uuid.uuid4, editable=False, unique=True, verbose_name='UUID')), - ('upstream_context_key', openedx_learning.lib.fields.MultiCollationCharField(db_collations={'mysql': 'utf8mb4_bin', 'sqlite': 'BINARY'}, db_index=True, help_text='Upstream context key i.e., learning_package/library key', max_length=500)), + ('upstream_context_key', openedx_django_lib.fields.MultiCollationCharField(db_collations={'mysql': 'utf8mb4_bin', 'sqlite': 'BINARY'}, db_index=True, help_text='Upstream context key i.e., learning_package/library key', max_length=500)), ('downstream_usage_key', opaque_keys.edx.django.models.UsageKeyField(max_length=255, unique=True)), ('downstream_context_key', opaque_keys.edx.django.models.CourseKeyField(db_index=True, max_length=255)), ('version_synced', models.IntegerField()), ('version_declined', models.IntegerField(blank=True, null=True)), - ('created', models.DateTimeField(validators=[openedx_learning.lib.validators.validate_utc_datetime])), - ('updated', models.DateTimeField(validators=[openedx_learning.lib.validators.validate_utc_datetime])), + ('created', models.DateTimeField(validators=[openedx_django_lib.validators.validate_utc_datetime])), + ('updated', models.DateTimeField(validators=[openedx_django_lib.validators.validate_utc_datetime])), ('upstream_container_key', opaque_keys.edx.django.models.ContainerKeyField(help_text='Upstream block key (e.g. lct:...), this value cannot be null and is useful to track upstream library blocks that do not exist yet or were deleted.', max_length=255)), ('upstream_container', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='links', to='oel_publishing.container')), ], diff --git a/cms/djangoapps/contentstore/migrations/0011_enable_markdown_editor_flag_by_default.py b/cms/djangoapps/contentstore/migrations/0011_enable_markdown_editor_flag_by_default.py index 491ae0e4224a..266bcdf9db3a 100644 --- a/cms/djangoapps/contentstore/migrations/0011_enable_markdown_editor_flag_by_default.py +++ b/cms/djangoapps/contentstore/migrations/0011_enable_markdown_editor_flag_by_default.py @@ -1,8 +1,6 @@ from django.db import migrations -from cms.djangoapps.contentstore.toggles import ( - ENABLE_REACT_MARKDOWN_EDITOR -) +from cms.djangoapps.contentstore.toggles import ENABLE_REACT_MARKDOWN_EDITOR def create_flag(apps, schema_editor): diff --git a/cms/djangoapps/contentstore/migrations/0012_componentlink_top_level_parent_and_more.py b/cms/djangoapps/contentstore/migrations/0012_componentlink_top_level_parent_and_more.py index 02f94f4b6593..e7f3fd688d8b 100644 --- a/cms/djangoapps/contentstore/migrations/0012_componentlink_top_level_parent_and_more.py +++ b/cms/djangoapps/contentstore/migrations/0012_componentlink_top_level_parent_and_more.py @@ -1,7 +1,7 @@ # Generated by Django 4.2.23 on 2025-08-04 18:56 -from django.db import migrations, models import django.db.models.deletion +from django.db import migrations, models class Migration(migrations.Migration): diff --git a/cms/djangoapps/contentstore/models.py b/cms/djangoapps/contentstore/models.py index a4f2ce3c6119..3021f513a10f 100644 --- a/cms/djangoapps/contentstore/models.py +++ b/cms/djangoapps/contentstore/models.py @@ -15,13 +15,14 @@ from opaque_keys.edx.django.models import ContainerKeyField, CourseKeyField, UsageKeyField from opaque_keys.edx.keys import CourseKey, UsageKey from opaque_keys.edx.locator import LibraryContainerLocator -from openedx_learning.api.authoring import get_published_version -from openedx_learning.api.authoring_models import Component, Container -from openedx_learning.lib.fields import ( - immutable_uuid_field, - key_field, - manual_date_time_field, -) +from openedx_content.api import get_published_version +from openedx_content.models_api import Component, Container + +try: + from openedx_django_lib.fields import immutable_uuid_field, manual_date_time_field, ref_field +except ImportError: # pragma: no cover - runtime compatibility shim for different openedx_django_lib versions + from openedx_django_lib.fields import immutable_uuid_field, manual_date_time_field + from openedx_django_lib.fields import key_field as ref_field logger = logging.getLogger(__name__) @@ -91,15 +92,15 @@ class EntityLinkBase(models.Model): """ uuid = immutable_uuid_field() # Search by library/upstream context key - upstream_context_key = key_field( + upstream_context_key = ref_field( help_text=_("Upstream context key i.e., learning_package/library key"), db_index=True, ) # A downstream entity can only link to single upstream entity # whereas an entity can be upstream for multiple downstream entities. - downstream_usage_key = UsageKeyField(max_length=255, unique=True) + downstream_usage_key = UsageKeyField(unique=True) # Search by course/downstream key - downstream_context_key = CourseKeyField(max_length=255, db_index=True) + downstream_context_key = CourseKeyField(db_index=True) # This is present if the creation of this link is a consequence of # importing a container that has one or more levels of children. # This represents the parent (container) in the top level @@ -131,7 +132,7 @@ def published_at(self) -> str | None: """ raise NotImplementedError - class Meta: + class Meta: # noqa: DJ012 abstract = True @classmethod @@ -143,6 +144,8 @@ class ComponentLink(EntityLinkBase): """ This represents link between any two publishable entities or link between publishable entity and a course XBlock. It helps in tracking relationship between XBlocks imported from libraries and used in different courses. + + .. no_pii: """ upstream_block = models.ForeignKey( Component, @@ -152,7 +155,6 @@ class ComponentLink(EntityLinkBase): blank=True, ) upstream_usage_key = UsageKeyField( - max_length=255, help_text=_( "Upstream block usage key, this value cannot be null" " and useful to track upstream library blocks that do not exist yet" @@ -270,7 +272,7 @@ def update_or_create( Update or create entity link. This will only update `updated` field if something has changed. """ if not created: - created = datetime.now(tz=timezone.utc) + created = datetime.now(tz=timezone.utc) # noqa: UP017 top_level_parent = None if top_level_parent_usage_key is not None: try: @@ -315,6 +317,8 @@ class ContainerLink(EntityLinkBase): """ This represents link between any two publishable entities or link between publishable entity and a course xblock. It helps in tracking relationship between xblocks imported from libraries and used in different courses. + + .. no_pii: """ upstream_container = models.ForeignKey( Container, @@ -324,7 +328,6 @@ class ContainerLink(EntityLinkBase): blank=True, ) upstream_container_key = ContainerKeyField( - max_length=255, help_text=_( "Upstream block key (e.g. lct:...), this value cannot be null " "and is useful to track upstream library blocks that do not exist yet " @@ -491,7 +494,7 @@ def _annotate_query_with_ready_to_sync(cls, query_set: QuerySet["EntityLinkBase" @classmethod def update_or_create( cls, - upstream_container_id: int | None, + upstream_container_id: Container.ID | None, /, upstream_container_key: LibraryContainerLocator, upstream_context_key: str, @@ -507,7 +510,7 @@ def update_or_create( Update or create entity link. This will only update `updated` field if something has changed. """ if not created: - created = datetime.now(tz=timezone.utc) + created = datetime.now(tz=timezone.utc) # noqa: UP017 top_level_parent = None if top_level_parent_usage_key is not None: try: @@ -562,9 +565,10 @@ class LearningContextLinksStatus(models.Model): """ This table stores current processing status of upstream-downstream links in ComponentLink table for a course or a learning context. + + .. no_pii: """ context_key = CourseKeyField( - max_length=255, # Single entry for a learning context or course unique=True, help_text=_("Linking status for course context key"), @@ -596,7 +600,7 @@ def get_or_create(cls, context_key: str, created: datetime | None = None) -> "Le LearningContextLinksStatus object """ if not created: - created = datetime.now(tz=timezone.utc) + created = datetime.now(tz=timezone.utc) # noqa: UP017 status, _ = cls.objects.get_or_create( context_key=context_key, defaults={ @@ -616,5 +620,5 @@ def update_status( Updates entity links processing status of given learning context. """ self.status = status - self.updated = updated or datetime.now(tz=timezone.utc) + self.updated = updated or datetime.now(tz=timezone.utc) # noqa: UP017 self.save() diff --git a/cms/djangoapps/contentstore/outlines.py b/cms/djangoapps/contentstore/outlines.py index 72d5c4f257f0..e31860377a59 100644 --- a/cms/djangoapps/contentstore/outlines.py +++ b/cms/djangoapps/contentstore/outlines.py @@ -4,7 +4,7 @@ learning_sequences at publish time. """ from datetime import timezone -from typing import List, Tuple +from typing import List, Tuple # noqa: UP035 from edx_django_utils.monitoring import function_trace, set_custom_attribute @@ -16,10 +16,10 @@ CourseSectionData, CourseVisibility, ExamData, - VisibilityData + VisibilityData, ) -from xmodule.modulestore import ModuleStoreEnum # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore import ModuleStoreEnum # pylint: disable=wrong-import-order +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order def _remove_version_info(usage_key): @@ -321,7 +321,7 @@ def _make_section_data(section, unique_sequences): @function_trace('get_outline_from_modulestore') -def get_outline_from_modulestore(course_key) -> Tuple[CourseOutlineData, List[ContentErrorData]]: +def get_outline_from_modulestore(course_key) -> Tuple[CourseOutlineData, List[ContentErrorData]]: # noqa: UP006 """ Return a CourseOutlineData and list of ContentErrorData for param:course_key @@ -352,7 +352,7 @@ def get_outline_from_modulestore(course_key) -> Tuple[CourseOutlineData, List[Co # maps to UTC), but for consistency, we're going to use the standard # python timezone.utc (which is what the learning_sequence app will # return from MySQL). They will compare as equal. - published_at=course.subtree_edited_on.replace(tzinfo=timezone.utc), + published_at=course.subtree_edited_on.replace(tzinfo=timezone.utc), # noqa: UP017 # .course_version is a BSON obj, so we convert to str (MongoDB- # specific objects don't go into CourseOutlineData). diff --git a/cms/djangoapps/contentstore/proctoring.py b/cms/djangoapps/contentstore/proctoring.py index bd33049006c4..7e00327eeea7 100644 --- a/cms/djangoapps/contentstore/proctoring.py +++ b/cms/djangoapps/contentstore/proctoring.py @@ -16,7 +16,7 @@ get_exam_by_content_id, remove_review_policy, update_exam, - update_review_policy + update_review_policy, ) from edx_proctoring.exceptions import ProctoredExamNotFoundException, ProctoredExamReviewPolicyNotFoundException @@ -41,7 +41,7 @@ def register_special_exams(course_key): course = modulestore().get_course(course_key) if course is None: - raise ItemNotFoundError("Course {} does not exist", str(course_key)) # lint-amnesty, pylint: disable=raising-format-tuple + raise ItemNotFoundError("Course {} does not exist", str(course_key)) # pylint: disable=raising-format-tuple if not course.enable_proctored_exams and not course.enable_timed_exams: # likewise if course does not have these features turned on @@ -70,7 +70,7 @@ def register_special_exams(course_key): # add/update any exam entries in edx-proctoring for timed_exam in timed_exams: msg = ( - 'Found {location} as a timed-exam in course structure. Inspecting...'.format( + 'Found {location} as a timed-exam in course structure. Inspecting...'.format( # noqa: UP032 location=str(timed_exam.location) ) ) diff --git a/cms/djangoapps/contentstore/rest_api/serializers/__init__.py b/cms/djangoapps/contentstore/rest_api/serializers/__init__.py index 9d207ee767ea..0f2da7e95365 100644 --- a/cms/djangoapps/contentstore/rest_api/serializers/__init__.py +++ b/cms/djangoapps/contentstore/rest_api/serializers/__init__.py @@ -1,4 +1,4 @@ """ Serializers for all contentstore API versions """ -from .common import StrictSerializer +from .common import StrictSerializer # noqa: F401 diff --git a/cms/djangoapps/contentstore/rest_api/urls.py b/cms/djangoapps/contentstore/rest_api/urls.py index 7296f7bb9858..af2694bfbbc5 100644 --- a/cms/djangoapps/contentstore/rest_api/urls.py +++ b/cms/djangoapps/contentstore/rest_api/urls.py @@ -2,8 +2,7 @@ Contentstore API URLs. """ -from django.urls import path -from django.urls import include +from django.urls import include, path from .v0 import urls as v0_urls from .v1 import urls as v1_urls diff --git a/cms/djangoapps/contentstore/rest_api/v0/__init__.py b/cms/djangoapps/contentstore/rest_api/v0/__init__.py index 4ceefe6ead69..90b9707d8612 100644 --- a/cms/djangoapps/contentstore/rest_api/v0/__init__.py +++ b/cms/djangoapps/contentstore/rest_api/v0/__init__.py @@ -2,11 +2,8 @@ Views for v0 contentstore API. """ -from cms.djangoapps.contentstore.rest_api.v0.views.assets import ( +from cms.djangoapps.contentstore.rest_api.v0.views.assets import ( # noqa: F401 AssetsCreateRetrieveView, - AssetsUpdateDestroyView -) -from cms.djangoapps.contentstore.rest_api.v0.views.xblock import ( - XblockView, - XblockCreateView + AssetsUpdateDestroyView, ) +from cms.djangoapps.contentstore.rest_api.v0.views.xblock import XblockCreateView, XblockView # noqa: F401 diff --git a/cms/djangoapps/contentstore/rest_api/v0/serializers/__init__.py b/cms/djangoapps/contentstore/rest_api/v0/serializers/__init__.py index 171f746be438..65e71ea67cb5 100644 --- a/cms/djangoapps/contentstore/rest_api/v0/serializers/__init__.py +++ b/cms/djangoapps/contentstore/rest_api/v0/serializers/__init__.py @@ -1,10 +1,14 @@ """ Serializers for v0 contentstore API. """ -from .advanced_settings import AdvancedSettingsFieldSerializer, CourseAdvancedSettingsSerializer -from .assets import AssetSerializer -from .authoring_grading import CourseGradingModelSerializer -from .course_optimizer import LinkCheckSerializer -from .tabs import CourseTabSerializer, CourseTabUpdateSerializer, TabIDLocatorSerializer -from .transcripts import TranscriptSerializer, YoutubeTranscriptCheckSerializer, YoutubeTranscriptUploadSerializer -from .xblock import XblockSerializer +from .advanced_settings import AdvancedSettingsFieldSerializer, CourseAdvancedSettingsSerializer # noqa: F401 +from .assets import AssetSerializer # noqa: F401 +from .authoring_grading import CourseGradingModelSerializer # noqa: F401 +from .course_optimizer import LinkCheckSerializer # noqa: F401 +from .tabs import CourseTabSerializer, CourseTabUpdateSerializer, TabIDLocatorSerializer # noqa: F401 +from .transcripts import ( # noqa: F401 + TranscriptSerializer, + YoutubeTranscriptCheckSerializer, + YoutubeTranscriptUploadSerializer, +) +from .xblock import XblockSerializer # noqa: F401 diff --git a/cms/djangoapps/contentstore/rest_api/v0/serializers/advanced_settings.py b/cms/djangoapps/contentstore/rest_api/v0/serializers/advanced_settings.py index 152ca95be341..a17c625a0fe0 100644 --- a/cms/djangoapps/contentstore/rest_api/v0/serializers/advanced_settings.py +++ b/cms/djangoapps/contentstore/rest_api/v0/serializers/advanced_settings.py @@ -1,23 +1,15 @@ """ Serializers for course advanced settings""" -from typing import Type, Dict as DictType +from typing import Dict as DictType # noqa: UP035 +from typing import Type # noqa: UP035 from django.utils.translation import gettext_lazy as _ from rest_framework import serializers from rest_framework.fields import Field as SerializerField -from xblock.fields import ( - Boolean, - Date, - DateTime, - Dict, - Field as XBlockField, - Float, - Integer, - List, - String, -) -from xmodule.course_block import CourseFields, EmailString +from xblock.fields import Boolean, Date, DateTime, Dict, Float, Integer, List, String +from xblock.fields import Field as XBlockField from cms.djangoapps.models.settings.course_metadata import CourseMetadata +from xmodule.course_block import CourseFields, EmailString # Maps xblock fields to their corresponding Django Rest Framework serializer field XBLOCK_DRF_FIELD_MAP = [ @@ -59,7 +51,7 @@ class CourseAdvancedSettingsSerializer(serializers.Serializer): # pylint: disab """ @staticmethod - def _get_drf_field_type_from_xblock_field(xblock_field: XBlockField) -> Type[SerializerField]: + def _get_drf_field_type_from_xblock_field(xblock_field: XBlockField) -> Type[SerializerField]: # noqa: UP006 """ Return the corresponding DRF Serializer field for an XBlock field. @@ -75,7 +67,7 @@ def _get_drf_field_type_from_xblock_field(xblock_field: XBlockField) -> Type[Ser return drf_type return serializers.JSONField - def get_fields(self) -> DictType[str, SerializerField]: + def get_fields(self) -> DictType[str, SerializerField]: # noqa: UP006 """ Return the fields for this serializer. diff --git a/cms/djangoapps/contentstore/rest_api/v0/serializers/assets.py b/cms/djangoapps/contentstore/rest_api/v0/serializers/assets.py index 7ecb473d1ade..d8015baad71b 100644 --- a/cms/djangoapps/contentstore/rest_api/v0/serializers/assets.py +++ b/cms/djangoapps/contentstore/rest_api/v0/serializers/assets.py @@ -2,6 +2,7 @@ API Serializers for assets """ from rest_framework import serializers + from cms.djangoapps.contentstore.rest_api.serializers.common import StrictSerializer diff --git a/cms/djangoapps/contentstore/rest_api/v0/serializers/tabs.py b/cms/djangoapps/contentstore/rest_api/v0/serializers/tabs.py index ad6c1d645e57..ce5eb1589c22 100644 --- a/cms/djangoapps/contentstore/rest_api/v0/serializers/tabs.py +++ b/cms/djangoapps/contentstore/rest_api/v0/serializers/tabs.py @@ -1,11 +1,11 @@ """ Serializers for course tabs """ -from typing import Dict +from typing import Dict # noqa: UP035 from django.utils.translation import gettext_lazy as _ from rest_framework import serializers -from xmodule.tabs import CourseTab from openedx.core.lib.api.serializers import UsageKeyField +from xmodule.tabs import CourseTab class CourseTabSerializer(serializers.Serializer): # pylint: disable=abstract-method @@ -41,7 +41,7 @@ class CourseTabSerializer(serializers.Serializer): # pylint: disable=abstract-m help_text=_("Additional settings specific to the tab"), ) - def to_representation(self, instance: CourseTab) -> Dict: + def to_representation(self, instance: CourseTab) -> Dict: # noqa: UP006 """ Returns a dict representation of a ``CourseTab`` that contains more data than its ``to_json`` method. @@ -74,7 +74,7 @@ class TabIDLocatorSerializer(serializers.Serializer): # pylint: disable=abstrac tab_id = serializers.CharField(required=False, help_text=_("ID of tab to update")) tab_locator = UsageKeyField(required=False, help_text=_("Location (Usage Key) of tab to update")) - def validate(self, attrs: Dict) -> Dict: + def validate(self, attrs: Dict) -> Dict: # noqa: UP006 """ Validates that either the ``tab_id`` or ``tab_locator`` are specified, but not both. diff --git a/cms/djangoapps/contentstore/rest_api/v0/serializers/transcripts.py b/cms/djangoapps/contentstore/rest_api/v0/serializers/transcripts.py index d0cb92e9060e..269d6057041e 100644 --- a/cms/djangoapps/contentstore/rest_api/v0/serializers/transcripts.py +++ b/cms/djangoapps/contentstore/rest_api/v0/serializers/transcripts.py @@ -2,6 +2,7 @@ API Serializers for transcripts """ from rest_framework import serializers + from cms.djangoapps.contentstore.rest_api.serializers.common import StrictSerializer diff --git a/cms/djangoapps/contentstore/rest_api/v0/serializers/xblock.py b/cms/djangoapps/contentstore/rest_api/v0/serializers/xblock.py index e95a76e91899..48ef9f82d580 100644 --- a/cms/djangoapps/contentstore/rest_api/v0/serializers/xblock.py +++ b/cms/djangoapps/contentstore/rest_api/v0/serializers/xblock.py @@ -2,6 +2,7 @@ API Serializers for xblocks """ from rest_framework import serializers + from cms.djangoapps.contentstore.rest_api.serializers.common import StrictSerializer # The XblockSerializer is designed to be scalable and generic. As such, its structure diff --git a/cms/djangoapps/contentstore/rest_api/v0/tests/test_advanced_settings.py b/cms/djangoapps/contentstore/rest_api/v0/tests/test_advanced_settings.py index 765246258bf2..8c6392109eb2 100644 --- a/cms/djangoapps/contentstore/rest_api/v0/tests/test_advanced_settings.py +++ b/cms/djangoapps/contentstore/rest_api/v0/tests/test_advanced_settings.py @@ -2,13 +2,23 @@ Tests for the course advanced settings API. """ import json +from unittest.mock import patch +import casbin import ddt +import pkg_resources from django.test import override_settings from django.urls import reverse from milestones.tests.utils import MilestonesTestCaseMixin +from openedx_authz.api.users import assign_role_to_user_in_scope +from openedx_authz.constants.roles import COURSE_STAFF +from openedx_authz.engine.enforcer import AuthzEnforcer +from openedx_authz.engine.utils import migrate_policy_between_enforcers +from rest_framework.test import APIClient from cms.djangoapps.contentstore.tests.utils import CourseTestCase +from common.djangoapps.student.tests.factories import UserFactory +from openedx.core import toggles as core_toggles @ddt.ddt @@ -91,3 +101,105 @@ def test_disabled_fetch_all_query_param(self, setting, excluded_field): with override_settings(FEATURES={setting: False}): resp = self.client.get(self.url, {"fetch_all": 0}) assert excluded_field not in resp.data + + +@patch.object(core_toggles.AUTHZ_COURSE_AUTHORING_FLAG, 'is_enabled', return_value=True) +class AdvancedSettingsAuthzTest(CourseTestCase): + """ + Tests for AdvancedCourseSettingsView authorization with openedx-authz. + + These tests enable the AUTHZ_COURSE_AUTHORING_FLAG by default. + """ + + def setUp(self): + super().setUp() + self._seed_database_with_policies() + self.url = reverse( + "cms.djangoapps.contentstore:v0:course_advanced_settings", + kwargs={"course_id": self.course.id}, + ) + + # Create test users + self.authorized_user = UserFactory() + self.unauthorized_user = UserFactory() + + # Assign role to authorized user + assign_role_to_user_in_scope( + self.authorized_user.username, + COURSE_STAFF.external_key, + str(self.course.id) + ) + AuthzEnforcer.get_enforcer().load_policy() + + # Create API clients and force_authenticate + self.authorized_client = APIClient() + self.authorized_client.force_authenticate(user=self.authorized_user) + self.unauthorized_client = APIClient() + self.unauthorized_client.force_authenticate(user=self.unauthorized_user) + + def tearDown(self): + super().tearDown() + AuthzEnforcer.get_enforcer().clear_policy() + + @classmethod + def _seed_database_with_policies(cls): + """Seed the database with policies from the policy file.""" + global_enforcer = AuthzEnforcer.get_enforcer() + global_enforcer.load_policy() + model_path = pkg_resources.resource_filename("openedx_authz.engine", "config/model.conf") + policy_path = pkg_resources.resource_filename("openedx_authz.engine", "config/authz.policy") + migrate_policy_between_enforcers( + source_enforcer=casbin.Enforcer(model_path, policy_path), + target_enforcer=global_enforcer, + ) + + def test_authorized_for_specific_course(self, mock_flag): + """User authorized for specific course can access.""" + response = self.authorized_client.get(self.url) + self.assertEqual(response.status_code, 200) # noqa: PT009 + + def test_unauthorized_for_specific_course(self, mock_flag): + """User without authorization for specific course cannot access.""" + response = self.unauthorized_client.get(self.url) + self.assertEqual(response.status_code, 403) # noqa: PT009 + + def test_unauthorized_for_different_course(self, mock_flag): + """User authorized for one course cannot access another course.""" + other_course = self.store.create_course("OtherOrg", "OtherCourse", "Run", self.user.id) + other_url = reverse( + "cms.djangoapps.contentstore:v0:course_advanced_settings", + kwargs={"course_id": other_course.id}, + ) + response = self.authorized_client.get(other_url) + self.assertEqual(response.status_code, 403) # noqa: PT009 + + def test_staff_authorized_by_default(self, mock_flag): + """Staff users are authorized by default.""" + response = self.client.get(self.url) + self.assertEqual(response.status_code, 200) # noqa: PT009 + + def test_superuser_authorized_by_default(self, mock_flag): + """Superusers are authorized by default.""" + superuser = UserFactory(is_superuser=True, is_staff=False) + superuser_client = APIClient() + superuser_client.force_authenticate(user=superuser) + response = superuser_client.get(self.url) + self.assertEqual(response.status_code, 200) # noqa: PT009 + + def test_patch_authorized_for_specific_course(self, mock_flag): + """User authorized for specific course can PATCH.""" + response = self.authorized_client.patch( + self.url, + {"display_name": {"value": "Test"}}, + content_type="application/json" + ) + self.assertEqual(response.status_code, 200) # noqa: PT009 + + def test_patch_unauthorized_for_specific_course(self, mock_flag): + """User without authorization for specific course cannot PATCH.""" + response = self.unauthorized_client.patch( + self.url, + {"display_name": {"value": "Test"}}, + content_type="application/json" + ) + self.assertEqual(response.status_code, 403) # noqa: PT009 diff --git a/cms/djangoapps/contentstore/rest_api/v0/tests/test_assets.py b/cms/djangoapps/contentstore/rest_api/v0/tests/test_assets.py index 3772dbb64e77..23959f6264b9 100644 --- a/cms/djangoapps/contentstore/rest_api/v0/tests/test_assets.py +++ b/cms/djangoapps/contentstore/rest_api/v0/tests/test_assets.py @@ -5,17 +5,16 @@ not the underlying Xblock service. It checks that the assets_handler method of the Xblock service is called with the expected parameters. """ -from unittest.mock import patch, MagicMock +from unittest.mock import MagicMock, patch from django.core.files import File from django.http import JsonResponse from django.urls import reverse from rest_framework import status from rest_framework.test import APITestCase -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase from cms.djangoapps.contentstore.tests.test_utils import AuthorizeStaffTestCase - +from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase ASSET_KEY_STRING = "asset-v1:dede+aba+weagi+type@asset+block@_0e37192a-42c4-441e-a3e1-8e40ec304e2e.jpg" mock_image = MagicMock(file=File) @@ -161,7 +160,7 @@ def assert_assets_handler_called(self, *, mock_handle_assets, response): mock_handle_assets.assert_called_once() passed_args = mock_handle_assets.call_args[0][0] - course_id = self.get_course_key_string() + course_id = self.get_course_key_string() # noqa: F841 assert passed_args.data.get("file").name == mock_image.name assert passed_args.method == "POST" @@ -204,7 +203,7 @@ def assert_assets_handler_called(self, *, mock_handle_assets, response): mock_handle_assets.assert_called_once() passed_args = mock_handle_assets.call_args[0][0] - course_id = self.get_course_key_string() + course_id = self.get_course_key_string() # noqa: F841 assert passed_args.data.get("locked") is True assert passed_args.method == "PUT" diff --git a/cms/djangoapps/contentstore/rest_api/v0/tests/test_authoring_grading.py b/cms/djangoapps/contentstore/rest_api/v0/tests/test_authoring_grading.py new file mode 100644 index 000000000000..fbca4a6aedf2 --- /dev/null +++ b/cms/djangoapps/contentstore/rest_api/v0/tests/test_authoring_grading.py @@ -0,0 +1,119 @@ +""" +Unit tests for authoring grading views. +""" +import json + +from openedx_authz.constants.roles import COURSE_DATA_RESEARCHER, COURSE_STAFF +from rest_framework import status +from rest_framework.test import APIClient + +from cms.djangoapps.contentstore.api.tests.base import BaseCourseViewTest +from common.djangoapps.student.tests.factories import UserFactory +from openedx.core.djangoapps.authz.tests.mixins import CourseAuthzTestMixin + + +class AuthoringGradingViewAuthzTest(CourseAuthzTestMixin, BaseCourseViewTest): + """ + Tests Authoring Grading configuration API authorization using openedx-authz. + The endpoint uses the COURSES_EDIT_GRADING_SETTINGS permission. + """ + + view_name = "cms.djangoapps.contentstore:v0:cms_api_update_grading" + authz_roles_to_assign = [COURSE_STAFF.external_key] + post_data = json.dumps({ + "graders": [ + { + "type": "Homework", + "min_count": 1, + "drop_count": 0, + "short_label": "", + "weight": 100, + "id": 0 + } + ], + "grade_cutoffs": { + "A": 0.75, + "B": 0.63, + "C": 0.57, + "D": 0.5 + }, + "grace_period": { + "hours": 12, + "minutes": 0 + }, + "minimum_grade_credit": 0.7, + "is_credit_course": True + }) + + def test_authorized_user_can_access_post(self): + """User with COURSE_STAFF role can access.""" + resp = self.authorized_client.post( + self.get_url(self.course_key), + data=self.post_data, + content_type="application/json" + ) + self.assertEqual(resp.status_code, status.HTTP_200_OK) # noqa: PT009 + + def test_unauthorized_user_cannot_access_post(self): + """User without role cannot access.""" + resp = self.unauthorized_client.post( + self.get_url(self.course_key), + data=self.post_data, + content_type="application/json" + ) + self.assertEqual(resp.status_code, status.HTTP_403_FORBIDDEN) # noqa: PT009 + + def test_role_scoped_to_course_post(self): + """Authorization should only apply to the assigned course.""" + other_course = self.store.create_course("OtherOrg", "OtherCourse", "Run", self.staff.id) + + resp = self.authorized_client.post( + self.get_url(other_course.id), + data=self.post_data, + content_type="application/json" + ) + self.assertEqual(resp.status_code, status.HTTP_403_FORBIDDEN) # noqa: PT009 + + def test_staff_user_allowed_via_legacy_post(self): + """ + Staff users should still pass through legacy fallback. + """ + self.client.login(username=self.staff.username, password=self.password) + + resp = self.client.post( + self.get_url(self.course_key), + data=self.post_data, + content_type="application/json" + ) + self.assertEqual(resp.status_code, status.HTTP_200_OK) # noqa: PT009 + + def test_superuser_allowed_post(self): + """Superusers should always be allowed.""" + superuser = UserFactory(is_superuser=True) + + client = APIClient() + client.force_authenticate(user=superuser) + + resp = client.post( + self.get_url(self.course_key), + data=self.post_data, + content_type="application/json" + ) + self.assertEqual(resp.status_code, status.HTTP_200_OK) # noqa: PT009 + + def test_non_staff_user_cannot_access_post(self): + """ + User without required permissions should be denied. + This case validates that a non-staff user doesn't get access. + """ + non_staff_user = UserFactory() + non_staff_client = APIClient() + self.add_user_to_role(non_staff_user, COURSE_DATA_RESEARCHER.external_key) + non_staff_client.force_authenticate(user=non_staff_user) + + resp = non_staff_client.post( + self.get_url(self.course_key), + data=self.post_data, + content_type="application/json" + ) + self.assertEqual(resp.status_code, status.HTTP_403_FORBIDDEN) # noqa: PT009 diff --git a/cms/djangoapps/contentstore/rest_api/v0/tests/test_course_optimizer.py b/cms/djangoapps/contentstore/rest_api/v0/tests/test_course_optimizer.py index 14d5a20fb41b..475c60c32403 100644 --- a/cms/djangoapps/contentstore/rest_api/v0/tests/test_course_optimizer.py +++ b/cms/djangoapps/contentstore/rest_api/v0/tests/test_course_optimizer.py @@ -2,10 +2,10 @@ Unit tests for course optimizer """ from django.test import TestCase -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase from django.urls import reverse from cms.djangoapps.contentstore.tests.test_utils import AuthorizeStaffTestCase +from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase class TestGetLinkCheckStatus(AuthorizeStaffTestCase, ModuleStoreTestCase, TestCase): @@ -30,14 +30,14 @@ def test_produces_4xx_when_invalid_course_id(self): Test course_id validation ''' response = self.make_request(course_id='invalid_course_id') - self.assertIn(response.status_code, range(400, 500)) + self.assertIn(response.status_code, range(400, 500)) # noqa: PT009 def test_produces_4xx_when_additional_kwargs(self): ''' Test additional kwargs validation ''' response = self.make_request(course_id=self.course.id, malicious_kwarg='malicious_kwarg') - self.assertIn(response.status_code, range(400, 500)) + self.assertIn(response.status_code, range(400, 500)) # noqa: PT009 class TestPostLinkCheck(AuthorizeStaffTestCase, ModuleStoreTestCase, TestCase): @@ -62,18 +62,18 @@ def test_produces_4xx_when_invalid_course_id(self): Test course_id validation ''' response = self.make_request(course_id='invalid_course_id') - self.assertIn(response.status_code, range(400, 500)) + self.assertIn(response.status_code, range(400, 500)) # noqa: PT009 def test_produces_4xx_when_additional_kwargs(self): ''' Test additional kwargs validation ''' response = self.make_request(course_id=self.course.id, malicious_kwarg='malicious_kwarg') - self.assertIn(response.status_code, range(400, 500)) + self.assertIn(response.status_code, range(400, 500)) # noqa: PT009 def test_produces_4xx_when_unexpected_data(self): ''' Test validation when request contains unexpected data ''' response = self.make_request(course_id=self.course.id, data={'unexpected_data': 'unexpected_data'}) - self.assertIn(response.status_code, range(400, 500)) + self.assertIn(response.status_code, range(400, 500)) # noqa: PT009 diff --git a/cms/djangoapps/contentstore/rest_api/v0/tests/test_course_rerun_link_update.py b/cms/djangoapps/contentstore/rest_api/v0/tests/test_course_rerun_link_update.py index fa1489545f29..64206571248f 100644 --- a/cms/djangoapps/contentstore/rest_api/v0/tests/test_course_rerun_link_update.py +++ b/cms/djangoapps/contentstore/rest_api/v0/tests/test_course_rerun_link_update.py @@ -86,8 +86,8 @@ def test_post_update_all_links_success(self): data = {"action": "all"} response = self.make_post_request(data=data) - self.assertEqual(response.status_code, 200) - self.assertIn("status", response.json()) + self.assertEqual(response.status_code, 200) # noqa: PT009 + self.assertIn("status", response.json()) # noqa: PT009 mock_task.delay.assert_called_once() def test_post_update_single_links_success(self): @@ -113,8 +113,8 @@ def test_post_update_single_links_success(self): } response = self.make_post_request(data=data) - self.assertEqual(response.status_code, 200) - self.assertIn("status", response.json()) + self.assertEqual(response.status_code, 200) # noqa: PT009 + self.assertIn("status", response.json()) # noqa: PT009 mock_task.delay.assert_called_once() def test_post_update_missing_action_returns_400(self): @@ -126,9 +126,9 @@ def test_post_update_missing_action_returns_400(self): data = {} response = self.make_post_request(data=data) - self.assertEqual(response.status_code, 400) - self.assertIn("error", response.json()) - self.assertIn("action", response.json()["error"]) + self.assertEqual(response.status_code, 400) # noqa: PT009 + self.assertIn("error", response.json()) # noqa: PT009 + self.assertIn("action", response.json()["error"]) # noqa: PT009 def test_error_handling_workflow(self): """Test error handling in the complete workflow""" @@ -142,11 +142,11 @@ def test_error_handling_workflow(self): data = {"action": "all"} response = self.make_post_request(data=data) - self.assertEqual(response.status_code, 200) + self.assertEqual(response.status_code, 200) # noqa: PT009 # Step 2: Check failed status with patch(self.task_status_patch) as mock_status: - with patch(self.user_task_artifact_patch) as mock_artifact: + with patch(self.user_task_artifact_patch) as mock_artifact: # noqa: F841 mock_task_status = Mock() mock_task_status.state = UserTaskStatus.FAILED mock_status.return_value = mock_task_status @@ -154,7 +154,7 @@ def test_error_handling_workflow(self): status_url = self.get_status_url(self.course.id) status_response = self.client.get(status_url) - self.assertEqual(status_response.status_code, 200) + self.assertEqual(status_response.status_code, 200) # noqa: PT009 status_data = status_response.json() - self.assertEqual(status_data["status"], "Failed") - self.assertEqual(status_data["results"], []) + self.assertEqual(status_data["status"], "Failed") # noqa: PT009 + self.assertEqual(status_data["results"], []) # noqa: PT009 diff --git a/cms/djangoapps/contentstore/rest_api/v0/tests/test_tabs.py b/cms/djangoapps/contentstore/rest_api/v0/tests/test_tabs.py index 5e83c9313617..46a804662c5e 100644 --- a/cms/djangoapps/contentstore/rest_api/v0/tests/test_tabs.py +++ b/cms/djangoapps/contentstore/rest_api/v0/tests/test_tabs.py @@ -8,10 +8,10 @@ import ddt from django.urls import reverse -from xmodule.modulestore.tests.factories import BlockFactory -from xmodule.tabs import CourseTabList from cms.djangoapps.contentstore.tests.utils import CourseTestCase +from xmodule.modulestore.tests.factories import BlockFactory +from xmodule.tabs import CourseTabList @ddt.ddt diff --git a/cms/djangoapps/contentstore/rest_api/v0/tests/test_tabs_permissions.py b/cms/djangoapps/contentstore/rest_api/v0/tests/test_tabs_permissions.py new file mode 100644 index 000000000000..4fcbe453fff2 --- /dev/null +++ b/cms/djangoapps/contentstore/rest_api/v0/tests/test_tabs_permissions.py @@ -0,0 +1,109 @@ +""" +Integration tests verifying authz permissions for v0 tabs REST API views. +""" +from urllib.parse import urlencode + +from django.urls import reverse +from openedx_authz.constants.roles import COURSE_AUDITOR, COURSE_LIMITED_STAFF, COURSE_STAFF +from rest_framework.test import APIClient + +from cms.djangoapps.contentstore.tests.utils import CourseTestCase +from common.djangoapps.student.tests.factories import UserFactory +from openedx.core.djangoapps.authz.tests.mixins import CourseAuthoringAuthzTestMixin + + +class TabsV0AuthzTest(CourseAuthoringAuthzTestMixin, CourseTestCase): + """ + Integration tests for v0 tabs API authz permissions. + """ + + def setUp(self): + super().setUp() + self.list_url = reverse( + 'cms.djangoapps.contentstore:v0:course_tab_list', + kwargs={'course_id': self.course.id}, + ) + self.settings_url = reverse( + 'cms.djangoapps.contentstore:v0:course_tab_settings', + kwargs={'course_id': self.course.id}, + ) + self.reorder_url = reverse( + 'cms.djangoapps.contentstore:v0:course_tab_reorder', + kwargs={'course_id': self.course.id}, + ) + + # --- CourseTabListView (GET) - requires courses.view_pages_and_resources --- + + def test_staff_can_list_tabs(self): + self.add_user_to_role_in_course(self.authorized_user, COURSE_STAFF.external_key, self.course.id) + resp = self.authorized_client.get(self.list_url) + assert resp.status_code == 200 + + def test_auditor_can_list_tabs(self): + self.add_user_to_role_in_course(self.authorized_user, COURSE_AUDITOR.external_key, self.course.id) + resp = self.authorized_client.get(self.list_url) + assert resp.status_code == 200 + + def test_limited_staff_cannot_list_tabs(self): + self.add_user_to_role_in_course(self.authorized_user, COURSE_LIMITED_STAFF.external_key, self.course.id) + resp = self.authorized_client.get(self.list_url) + assert resp.status_code == 403 + + def test_unauthorized_cannot_list_tabs(self): + resp = self.unauthorized_client.get(self.list_url) + assert resp.status_code == 403 + + # --- CourseTabSettingsView (POST) - requires courses.manage_pages_and_resources --- + + def test_staff_can_update_tab_settings(self): + """Asserts not-403 rather than 200 because the minimal payload may fail validation.""" + self.add_user_to_role_in_course(self.authorized_user, COURSE_STAFF.external_key, self.course.id) + resp = self.authorized_client.post( + f'{self.settings_url}?{urlencode({"tab_id": "wiki"})}', + data={'is_hidden': True}, + format='json', + ) + assert resp.status_code != 403 + + def test_auditor_cannot_update_tab_settings(self): + self.add_user_to_role_in_course(self.authorized_user, COURSE_AUDITOR.external_key, self.course.id) + resp = self.authorized_client.post( + f'{self.settings_url}?{urlencode({"tab_id": "wiki"})}', + data={'is_hidden': True}, + format='json', + ) + assert resp.status_code == 403 + + def test_unauthorized_cannot_update_tab_settings(self): + resp = self.unauthorized_client.post( + f'{self.settings_url}?{urlencode({"tab_id": "wiki"})}', + data={'is_hidden': True}, + format='json', + ) + assert resp.status_code == 403 + + # --- CourseTabReorderView (POST) - requires courses.manage_pages_and_resources --- + + def test_staff_can_reorder_tabs(self): + """Asserts not-403 rather than 200 because the empty tab list may fail validation.""" + self.add_user_to_role_in_course(self.authorized_user, COURSE_STAFF.external_key, self.course.id) + resp = self.authorized_client.post(self.reorder_url, data=[], format='json') + assert resp.status_code != 403 + + def test_auditor_cannot_reorder_tabs(self): + self.add_user_to_role_in_course(self.authorized_user, COURSE_AUDITOR.external_key, self.course.id) + resp = self.authorized_client.post(self.reorder_url, data=[], format='json') + assert resp.status_code == 403 + + def test_unauthorized_cannot_reorder_tabs(self): + resp = self.unauthorized_client.post(self.reorder_url, data=[], format='json') + assert resp.status_code == 403 + + # --- Superuser bypass --- + + def test_superuser_can_list_tabs(self): + superuser = UserFactory(is_superuser=True) + client = APIClient() + client.force_authenticate(user=superuser) + resp = client.get(self.list_url) + assert resp.status_code == 200 diff --git a/cms/djangoapps/contentstore/rest_api/v0/tests/test_xblock.py b/cms/djangoapps/contentstore/rest_api/v0/tests/test_xblock.py index 512c92f6ffe9..f192e39c757a 100644 --- a/cms/djangoapps/contentstore/rest_api/v0/tests/test_xblock.py +++ b/cms/djangoapps/contentstore/rest_api/v0/tests/test_xblock.py @@ -4,15 +4,14 @@ It checks that the xblock_handler method of the Xblock service is called with the expected parameters. """ from unittest.mock import patch -from django.http import JsonResponse +from django.http import JsonResponse from django.urls import reverse from rest_framework import status from rest_framework.test import APITestCase -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase from cms.djangoapps.contentstore.tests.test_utils import AuthorizeStaffTestCase - +from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase TEST_LOCATOR = "block-v1:dede+aba+weagi+type@problem+block@ba6327f840da49289fb27a9243913478" VERSION = "v0" diff --git a/cms/djangoapps/contentstore/rest_api/v0/urls.py b/cms/djangoapps/contentstore/rest_api/v0/urls.py index 974d1b98a0c4..65d45a98126d 100644 --- a/cms/djangoapps/contentstore/rest_api/v0/urls.py +++ b/cms/djangoapps/contentstore/rest_api/v0/urls.py @@ -1,7 +1,7 @@ """ Contenstore API v0 URLs. """ from django.conf import settings -from django.urls import re_path, path +from django.urls import path, re_path from openedx.core.constants import COURSE_ID_PATTERN @@ -19,10 +19,10 @@ TranscriptView, YoutubeTranscriptCheckView, YoutubeTranscriptUploadView, + assets, + authoring_videos, + xblock, ) -from .views import assets -from .views import authoring_videos -from .views import xblock app_name = "v0" diff --git a/cms/djangoapps/contentstore/rest_api/v0/views/__init__.py b/cms/djangoapps/contentstore/rest_api/v0/views/__init__.py index 5714754b191e..9d9be33f97ff 100644 --- a/cms/djangoapps/contentstore/rest_api/v0/views/__init__.py +++ b/cms/djangoapps/contentstore/rest_api/v0/views/__init__.py @@ -1,9 +1,14 @@ """ Views for v0 contentstore API. """ -from .advanced_settings import AdvancedCourseSettingsView -from .api_heartbeat import APIHeartBeatView -from .authoring_grading import AuthoringGradingView -from .course_optimizer import LinkCheckStatusView, LinkCheckView, RerunLinkUpdateStatusView, RerunLinkUpdateView -from .tabs import CourseTabListView, CourseTabReorderView, CourseTabSettingsView -from .transcripts import TranscriptView, YoutubeTranscriptCheckView, YoutubeTranscriptUploadView +from .advanced_settings import AdvancedCourseSettingsView # noqa: F401 +from .api_heartbeat import APIHeartBeatView # noqa: F401 +from .authoring_grading import AuthoringGradingView # noqa: F401 +from .course_optimizer import ( # noqa: F401 + LinkCheckStatusView, + LinkCheckView, + RerunLinkUpdateStatusView, + RerunLinkUpdateView, +) +from .tabs import CourseTabListView, CourseTabReorderView, CourseTabSettingsView # noqa: F401 +from .transcripts import TranscriptView, YoutubeTranscriptCheckView, YoutubeTranscriptUploadView # noqa: F401 diff --git a/cms/djangoapps/contentstore/rest_api/v0/views/advanced_settings.py b/cms/djangoapps/contentstore/rest_api/v0/views/advanced_settings.py index 7516bba37228..e7baf54b375d 100644 --- a/cms/djangoapps/contentstore/rest_api/v0/views/advanced_settings.py +++ b/cms/djangoapps/contentstore/rest_api/v0/views/advanced_settings.py @@ -1,20 +1,21 @@ """ API Views for course advanced settings """ -from django import forms import edx_api_doc_tools as apidocs +from django import forms from opaque_keys.edx.keys import CourseKey from rest_framework.exceptions import ValidationError from rest_framework.request import Request from rest_framework.response import Response from rest_framework.views import APIView -from xmodule.modulestore.django import modulestore -from cms.djangoapps.models.settings.course_metadata import CourseMetadata from cms.djangoapps.contentstore.api.views.utils import get_bool_param -from common.djangoapps.student.auth import has_studio_read_access, has_studio_write_access +from cms.djangoapps.models.settings.course_metadata import CourseMetadata +from common.djangoapps.student.auth import check_course_advanced_settings_access from openedx.core.lib.api.view_utils import DeveloperErrorViewMixin, verify_course_exists, view_auth_classes -from ..serializers import CourseAdvancedSettingsSerializer +from xmodule.modulestore.django import modulestore + from ....views.course import update_course_advanced_settings +from ..serializers import CourseAdvancedSettingsSerializer @view_auth_classes(is_authenticated=True) @@ -115,7 +116,7 @@ def get(self, request: Request, course_id: str): if not filter_query_data.is_valid(): raise ValidationError(filter_query_data.errors) course_key = CourseKey.from_string(course_id) - if not has_studio_read_access(request.user, course_key): + if not check_course_advanced_settings_access(request.user, course_key, access_type='read'): self.permission_denied(request) course_block = modulestore().get_course(course_key) fetch_all = get_bool_param(request, 'fetch_all', True) @@ -184,7 +185,7 @@ def patch(self, request: Request, course_id: str): along with all the course's settings similar to a ``GET`` request. """ course_key = CourseKey.from_string(course_id) - if not has_studio_write_access(request.user, course_key): + if not check_course_advanced_settings_access(request.user, course_key, access_type='write'): self.permission_denied(request) course_block = modulestore().get_course(course_key) updated_data = update_course_advanced_settings(course_block, request.data, request.user) diff --git a/cms/djangoapps/contentstore/rest_api/v0/views/api_heartbeat.py b/cms/djangoapps/contentstore/rest_api/v0/views/api_heartbeat.py index f322f2360939..78aa655f652a 100644 --- a/cms/djangoapps/contentstore/rest_api/v0/views/api_heartbeat.py +++ b/cms/djangoapps/contentstore/rest_api/v0/views/api_heartbeat.py @@ -1,9 +1,10 @@ """ View For Getting the Status of The Authoring API """ import edx_api_doc_tools as apidocs -from rest_framework.views import APIView +from rest_framework import status from rest_framework.request import Request from rest_framework.response import Response -from rest_framework import status +from rest_framework.views import APIView + from openedx.core.lib.api.view_utils import DeveloperErrorViewMixin, view_auth_classes @@ -32,13 +33,13 @@ def get(self, request: Request): **Response Values** If the request is successful, an HTTP 200 "OK" response is returned. - The HTTP 200 response contains a single dict with the "authoring_api_enabled" value "True". + The HTTP 200 response contains a single dict with the "content_api_enabled" value "True". **Example Response** ```json { - "authoring_api_enabled": "True" + "content_api_enabled": "True" } ``` """ diff --git a/cms/djangoapps/contentstore/rest_api/v0/views/assets.py b/cms/djangoapps/contentstore/rest_api/v0/views/assets.py index a7a495256514..868614951fc4 100644 --- a/cms/djangoapps/contentstore/rest_api/v0/views/assets.py +++ b/cms/djangoapps/contentstore/rest_api/v0/views/assets.py @@ -2,20 +2,19 @@ Public rest API endpoints for the CMS API Assets. """ import logging -from rest_framework.generics import CreateAPIView, RetrieveAPIView, UpdateAPIView, DestroyAPIView -from django.views.decorators.csrf import csrf_exempt -from openedx.core.lib.api.view_utils import DeveloperErrorViewMixin, view_auth_classes -from common.djangoapps.util.json_request import expect_json_in_class_view +from django.views.decorators.csrf import csrf_exempt +from rest_framework.generics import CreateAPIView, DestroyAPIView, RetrieveAPIView, UpdateAPIView +from rest_framework.parsers import FormParser, JSONParser, MultiPartParser from cms.djangoapps.contentstore.api import course_author_access_required - from cms.djangoapps.contentstore.asset_storage_handlers import handle_assets +from common.djangoapps.util.json_request import expect_json_in_class_view +from openedx.core.lib.api.parsers import TypedFileUploadParser +from openedx.core.lib.api.view_utils import DeveloperErrorViewMixin, view_auth_classes from ..serializers.assets import AssetSerializer from .utils import validate_request_with_serializer -from rest_framework.parsers import (MultiPartParser, FormParser, JSONParser) -from openedx.core.lib.api.parsers import TypedFileUploadParser log = logging.getLogger(__name__) diff --git a/cms/djangoapps/contentstore/rest_api/v0/views/authoring_grading.py b/cms/djangoapps/contentstore/rest_api/v0/views/authoring_grading.py index ef965bc3d4c8..db3fffd17fa7 100644 --- a/cms/djangoapps/contentstore/rest_api/v0/views/authoring_grading.py +++ b/cms/djangoapps/contentstore/rest_api/v0/views/authoring_grading.py @@ -2,14 +2,17 @@ import edx_api_doc_tools as apidocs from opaque_keys.edx.keys import CourseKey +from openedx_authz.constants.permissions import COURSES_EDIT_GRADING_SETTINGS from rest_framework.request import Request from rest_framework.response import Response from rest_framework.views import APIView from cms.djangoapps.models.settings.course_grading import CourseGradingModel -from common.djangoapps.student.auth import has_studio_read_access +from openedx.core.djangoapps.authz.constants import LegacyAuthoringPermission +from openedx.core.djangoapps.authz.decorators import authz_permission_required from openedx.core.djangoapps.credit.tasks import update_credit_course_requirements from openedx.core.lib.api.view_utils import DeveloperErrorViewMixin, verify_course_exists, view_auth_classes + from ..serializers import CourseGradingModelSerializer @@ -31,7 +34,10 @@ class AuthoringGradingView(DeveloperErrorViewMixin, APIView): }, ) @verify_course_exists() - def post(self, request: Request, course_id: str): + # Please note: previous legacy permisison was checking for has_studio_read_access + # So we are using LegacyAuthoringPermission.READ to keep compatibility + @authz_permission_required(COURSES_EDIT_GRADING_SETTINGS.identifier, LegacyAuthoringPermission.READ) + def post(self, request: Request, course_key: CourseKey): """ Update a course's grading. @@ -75,11 +81,6 @@ def post(self, request: Request, course_id: str): If the request is successful, an HTTP 200 "OK" response is returned, """ - course_key = CourseKey.from_string(course_id) - - if not has_studio_read_access(request.user, course_key): - self.permission_denied(request) - if 'minimum_grade_credit' in request.data: update_credit_course_requirements.delay(str(course_key)) diff --git a/cms/djangoapps/contentstore/rest_api/v0/views/authoring_videos.py b/cms/djangoapps/contentstore/rest_api/v0/views/authoring_videos.py index f97bf7a98d16..5a7563c2372e 100644 --- a/cms/djangoapps/contentstore/rest_api/v0/views/authoring_videos.py +++ b/cms/djangoapps/contentstore/rest_api/v0/views/authoring_videos.py @@ -2,32 +2,24 @@ Public rest API endpoints for the Authoring API video assets. """ import logging -from rest_framework.generics import ( - CreateAPIView, - RetrieveAPIView, - DestroyAPIView -) -from rest_framework.parsers import (MultiPartParser, FormParser) -from django.views.decorators.csrf import csrf_exempt -from openedx.core.lib.api.view_utils import DeveloperErrorViewMixin, view_auth_classes -from openedx.core.lib.api.parsers import TypedFileUploadParser -from common.djangoapps.util.json_request import expect_json_in_class_view - -from ....api import course_author_access_required +from django.views.decorators.csrf import csrf_exempt +from rest_framework.generics import CreateAPIView, DestroyAPIView, RetrieveAPIView +from rest_framework.parsers import FormParser, MultiPartParser +from cms.djangoapps.contentstore.rest_api.v1.serializers import VideoImageSerializer, VideoUploadSerializer from cms.djangoapps.contentstore.video_storage_handlers import ( - handle_videos, + enabled_video_features, get_video_encodings_download, handle_video_images, - enabled_video_features -) -from cms.djangoapps.contentstore.rest_api.v1.serializers import ( - VideoUploadSerializer, - VideoImageSerializer, + handle_videos, ) -from .utils import validate_request_with_serializer +from common.djangoapps.util.json_request import expect_json_in_class_view +from openedx.core.lib.api.parsers import TypedFileUploadParser +from openedx.core.lib.api.view_utils import DeveloperErrorViewMixin, view_auth_classes +from ....api import course_author_access_required +from .utils import validate_request_with_serializer log = logging.getLogger(__name__) diff --git a/cms/djangoapps/contentstore/rest_api/v0/views/course_optimizer.py b/cms/djangoapps/contentstore/rest_api/v0/views/course_optimizer.py index bd37ae837916..9b012d918e06 100644 --- a/cms/djangoapps/contentstore/rest_api/v0/views/course_optimizer.py +++ b/cms/djangoapps/contentstore/rest_api/v0/views/course_optimizer.py @@ -15,19 +15,15 @@ sort_course_sections, ) from cms.djangoapps.contentstore.rest_api.v0.serializers.course_optimizer import ( + CourseRerunLinkUpdateRequestSerializer, CourseRerunLinkUpdateStatusSerializer, LinkCheckSerializer, - CourseRerunLinkUpdateRequestSerializer, ) from cms.djangoapps.contentstore.tasks import check_broken_links, update_course_rerun_links from cms.djangoapps.contentstore.toggles import enable_course_optimizer_check_prev_run_links from common.djangoapps.student.auth import has_course_author_access, has_studio_read_access from common.djangoapps.util.json_request import JsonResponse -from openedx.core.lib.api.view_utils import ( - DeveloperErrorViewMixin, - verify_course_exists, - view_auth_classes, -) +from openedx.core.lib.api.view_utils import DeveloperErrorViewMixin, verify_course_exists, view_auth_classes @view_auth_classes(is_authenticated=True) diff --git a/cms/djangoapps/contentstore/rest_api/v0/views/tabs.py b/cms/djangoapps/contentstore/rest_api/v0/views/tabs.py index 968af2246aa3..e1b9401cd0f9 100644 --- a/cms/djangoapps/contentstore/rest_api/v0/views/tabs.py +++ b/cms/djangoapps/contentstore/rest_api/v0/views/tabs.py @@ -3,17 +3,23 @@ import edx_api_doc_tools as apidocs from django.utils.translation import gettext_lazy as _ from opaque_keys.edx.keys import CourseKey +from openedx_authz.constants.permissions import ( + COURSES_MANAGE_PAGES_AND_RESOURCES, + COURSES_VIEW_PAGES_AND_RESOURCES, +) from rest_framework import status from rest_framework.request import Request from rest_framework.response import Response from rest_framework.views import APIView + +from openedx.core.djangoapps.authz.constants import LegacyAuthoringPermission +from openedx.core.djangoapps.authz.decorators import user_has_course_permission +from openedx.core.lib.api.view_utils import DeveloperErrorViewMixin, verify_course_exists, view_auth_classes from xmodule.modulestore.django import modulestore from xmodule.modulestore.exceptions import ItemNotFoundError -from common.djangoapps.student.auth import has_studio_read_access, has_studio_write_access -from openedx.core.lib.api.view_utils import DeveloperErrorViewMixin, verify_course_exists, view_auth_classes -from ..serializers import CourseTabSerializer, CourseTabUpdateSerializer, TabIDLocatorSerializer from ....views.tabs import edit_tab_handler, get_course_tabs, reorder_tabs_handler +from ..serializers import CourseTabSerializer, CourseTabUpdateSerializer, TabIDLocatorSerializer @view_auth_classes(is_authenticated=True) @@ -78,7 +84,12 @@ def get(self, request: Request, course_id: str) -> Response: ``` """ course_key = CourseKey.from_string(course_id) - if not has_studio_read_access(request.user, course_key): + if not user_has_course_permission( + request.user, + COURSES_VIEW_PAGES_AND_RESOURCES.identifier, + course_key, + LegacyAuthoringPermission.READ, + ): self.permission_denied(request) course_block = modulestore().get_course(course_key) @@ -149,7 +160,12 @@ def post(self, request: Request, course_id: str) -> Response: without any content. """ course_key = CourseKey.from_string(course_id) - if not has_studio_write_access(request.user, course_key): + if not user_has_course_permission( + request.user, + COURSES_MANAGE_PAGES_AND_RESOURCES.identifier, + course_key, + LegacyAuthoringPermission.WRITE, + ): self.permission_denied(request) tab_id_locator = TabIDLocatorSerializer(data=request.query_params) @@ -221,7 +237,12 @@ def post(self, request: Request, course_id: str) -> Response: without any content. """ course_key = CourseKey.from_string(course_id) - if not has_studio_write_access(request.user, course_key): + if not user_has_course_permission( + request.user, + COURSES_MANAGE_PAGES_AND_RESOURCES.identifier, + course_key, + LegacyAuthoringPermission.WRITE, + ): self.permission_denied(request) course_block = modulestore().get_course(course_key) diff --git a/cms/djangoapps/contentstore/rest_api/v0/views/transcripts.py b/cms/djangoapps/contentstore/rest_api/v0/views/transcripts.py index 3344fdbd1f43..11c33d7e5a81 100644 --- a/cms/djangoapps/contentstore/rest_api/v0/views/transcripts.py +++ b/cms/djangoapps/contentstore/rest_api/v0/views/transcripts.py @@ -2,28 +2,24 @@ Public rest API endpoints for the CMS API video assets. """ import logging -from rest_framework.generics import ( - CreateAPIView, - RetrieveAPIView, - DestroyAPIView -) -from django.views.decorators.csrf import csrf_exempt -from openedx.core.lib.api.view_utils import DeveloperErrorViewMixin, view_auth_classes -from common.djangoapps.util.json_request import expect_json_in_class_view +from django.views.decorators.csrf import csrf_exempt +from rest_framework.generics import CreateAPIView, DestroyAPIView, RetrieveAPIView +from rest_framework.parsers import FormParser, MultiPartParser from cms.djangoapps.contentstore.api import course_author_access_required -from cms.djangoapps.contentstore.views.transcripts_ajax import check_transcripts, replace_transcripts +from cms.djangoapps.contentstore.rest_api.v0.views.utils import validate_request_with_serializer from cms.djangoapps.contentstore.transcript_storage_handlers import ( - upload_transcript, delete_video_transcript_or_404, handle_transcript_download, + upload_transcript, ) -from ..serializers import TranscriptSerializer, YoutubeTranscriptCheckSerializer, YoutubeTranscriptUploadSerializer -from rest_framework.parsers import (MultiPartParser, FormParser) +from cms.djangoapps.contentstore.views.transcripts_ajax import check_transcripts, replace_transcripts +from common.djangoapps.util.json_request import expect_json_in_class_view from openedx.core.lib.api.parsers import TypedFileUploadParser +from openedx.core.lib.api.view_utils import DeveloperErrorViewMixin, view_auth_classes -from cms.djangoapps.contentstore.rest_api.v0.views.utils import validate_request_with_serializer +from ..serializers import TranscriptSerializer, YoutubeTranscriptCheckSerializer, YoutubeTranscriptUploadSerializer log = logging.getLogger(__name__) diff --git a/cms/djangoapps/contentstore/rest_api/v0/views/utils.py b/cms/djangoapps/contentstore/rest_api/v0/views/utils.py index 7175b76c7c26..288c8957bae8 100644 --- a/cms/djangoapps/contentstore/rest_api/v0/views/utils.py +++ b/cms/djangoapps/contentstore/rest_api/v0/views/utils.py @@ -2,6 +2,7 @@ Utilities for the REST API views. """ from functools import wraps + from django.http import HttpResponseBadRequest diff --git a/cms/djangoapps/contentstore/rest_api/v0/views/xblock.py b/cms/djangoapps/contentstore/rest_api/v0/views/xblock.py index 8e678ae845e0..79217971bb67 100644 --- a/cms/djangoapps/contentstore/rest_api/v0/views/xblock.py +++ b/cms/djangoapps/contentstore/rest_api/v0/views/xblock.py @@ -2,19 +2,18 @@ Public rest API endpoints for the CMS API. """ import logging -from rest_framework.generics import RetrieveUpdateDestroyAPIView, CreateAPIView -from django.views.decorators.csrf import csrf_exempt -from openedx.core.lib.api.view_utils import DeveloperErrorViewMixin, view_auth_classes -from common.djangoapps.util.json_request import expect_json_in_class_view +from django.views.decorators.csrf import csrf_exempt +from rest_framework.generics import CreateAPIView, RetrieveUpdateDestroyAPIView from cms.djangoapps.contentstore.api import course_author_access_required from cms.djangoapps.contentstore.xblock_storage_handlers import view_handlers +from common.djangoapps.util.json_request import expect_json_in_class_view +from openedx.core.lib.api.view_utils import DeveloperErrorViewMixin, view_auth_classes from ..serializers import XblockSerializer from .utils import validate_request_with_serializer - log = logging.getLogger(__name__) handle_xblock = view_handlers.handle_xblock diff --git a/cms/djangoapps/contentstore/rest_api/v1/mixins.py b/cms/djangoapps/contentstore/rest_api/v1/mixins.py index 3ac4795680ff..18f1d66149d5 100644 --- a/cms/djangoapps/contentstore/rest_api/v1/mixins.py +++ b/cms/djangoapps/contentstore/rest_api/v1/mixins.py @@ -33,8 +33,8 @@ def test_permissions_unauthenticated(self): self.client.logout() response = self.client.get(self.url) error = self.get_and_check_developer_response(response) - self.assertEqual(error, "Authentication credentials were not provided.") - self.assertEqual(response.status_code, status.HTTP_401_UNAUTHORIZED) + self.assertEqual(error, "Authentication credentials were not provided.") # noqa: PT009 + self.assertEqual(response.status_code, status.HTTP_401_UNAUTHORIZED) # noqa: PT009 @patch.dict("django.conf.settings.FEATURES", {"DISABLE_ADVANCED_SETTINGS": True}) def test_permissions_unauthorized(self): @@ -44,8 +44,8 @@ def test_permissions_unauthorized(self): client, _ = self.create_non_staff_authed_user_client() response = client.get(self.url) error = self.get_and_check_developer_response(response) - self.assertEqual(error, "You do not have permission to perform this action.") - self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN) + self.assertEqual(error, "You do not have permission to perform this action.") # noqa: PT009 + self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN) # noqa: PT009 class ContainerHandlerMixin: diff --git a/cms/djangoapps/contentstore/rest_api/v1/serializers/__init__.py b/cms/djangoapps/contentstore/rest_api/v1/serializers/__init__.py index f96cb9adeaa8..26403f734775 100644 --- a/cms/djangoapps/contentstore/rest_api/v1/serializers/__init__.py +++ b/cms/djangoapps/contentstore/rest_api/v1/serializers/__init__.py @@ -1,28 +1,28 @@ """ Serializers for v1 contentstore API. """ -from .certificates import CourseCertificatesSerializer -from .course_details import CourseDetailsSerializer -from .course_index import CourseIndexSerializer -from .course_rerun import CourseRerunSerializer -from .course_team import CourseTeamSerializer -from .course_waffle_flags import CourseWaffleFlagsSerializer -from .grading import CourseGradingModelSerializer, CourseGradingSerializer -from .group_configurations import CourseGroupConfigurationsSerializer -from .home import StudioHomeSerializer, CourseHomeTabSerializer, LibraryTabSerializer +from .certificates import CourseCertificatesSerializer # noqa: F401 +from .course_details import CourseDetailsSerializer # noqa: F401 +from .course_index import CourseIndexSerializer # noqa: F401 +from .course_rerun import CourseRerunSerializer # noqa: F401 +from .course_team import CourseTeamSerializer # noqa: F401 +from .course_waffle_flags import CourseWaffleFlagsSerializer # noqa: F401 +from .grading import CourseGradingModelSerializer, CourseGradingSerializer # noqa: F401 +from .group_configurations import CourseGroupConfigurationsSerializer # noqa: F401 +from .home import CourseHomeTabSerializer, LibraryTabSerializer, StudioHomeSerializer # noqa: F401 from .proctoring import ( - LimitedProctoredExamSettingsSerializer, - ProctoredExamConfigurationSerializer, - ProctoredExamSettingsSerializer, - ProctoringErrorsSerializer, + LimitedProctoredExamSettingsSerializer, # noqa: F401 + ProctoredExamConfigurationSerializer, # noqa: F401 + ProctoredExamSettingsSerializer, # noqa: F401 + ProctoringErrorsSerializer, # noqa: F401 ) -from .settings import CourseSettingsSerializer -from .textbooks import CourseTextbooksSerializer -from .vertical_block import ContainerHandlerSerializer, ContainerChildrenSerializer +from .settings import CourseSettingsSerializer # noqa: F401 +from .textbooks import CourseTextbooksSerializer # noqa: F401 +from .vertical_block import ContainerChildrenSerializer, ContainerHandlerSerializer # noqa: F401 from .videos import ( - CourseVideosSerializer, - VideoDownloadSerializer, - VideoImageSerializer, - VideoUploadSerializer, - VideoUsageSerializer, + CourseVideosSerializer, # noqa: F401 + VideoDownloadSerializer, # noqa: F401 + VideoImageSerializer, # noqa: F401 + VideoUploadSerializer, # noqa: F401 + VideoUsageSerializer, # noqa: F401 ) diff --git a/cms/djangoapps/contentstore/rest_api/v1/serializers/course_details.py b/cms/djangoapps/contentstore/rest_api/v1/serializers/course_details.py index fbcf2aca72f4..eec4dc11f38a 100644 --- a/cms/djangoapps/contentstore/rest_api/v1/serializers/course_details.py +++ b/cms/djangoapps/contentstore/rest_api/v1/serializers/course_details.py @@ -53,6 +53,7 @@ class CourseDetailsSerializer(serializers.Serializer): pre_requisite_courses = serializers.ListField(child=CourseKeyField()) run = serializers.CharField() self_paced = serializers.BooleanField() + has_changes = serializers.BooleanField() short_description = serializers.CharField(allow_blank=True) start_date = serializers.DateTimeField() subtitle = serializers.CharField(allow_blank=True) diff --git a/cms/djangoapps/contentstore/rest_api/v1/serializers/course_waffle_flags.py b/cms/djangoapps/contentstore/rest_api/v1/serializers/course_waffle_flags.py index 2d0785459069..8610bd18b8f7 100644 --- a/cms/djangoapps/contentstore/rest_api/v1/serializers/course_waffle_flags.py +++ b/cms/djangoapps/contentstore/rest_api/v1/serializers/course_waffle_flags.py @@ -5,6 +5,7 @@ from rest_framework import serializers from cms.djangoapps.contentstore import toggles +from openedx.core import toggles as core_toggles class CourseWaffleFlagsSerializer(serializers.Serializer): @@ -20,6 +21,7 @@ class CourseWaffleFlagsSerializer(serializers.Serializer): use_new_import_page = serializers.SerializerMethodField() use_new_export_page = serializers.SerializerMethodField() use_new_files_uploads_page = serializers.SerializerMethodField() + use_new_pdf_editor = serializers.SerializerMethodField() use_new_video_uploads_page = serializers.SerializerMethodField() use_new_course_outline_page = serializers.SerializerMethodField() use_new_unit_page = serializers.SerializerMethodField() @@ -31,6 +33,7 @@ class CourseWaffleFlagsSerializer(serializers.Serializer): use_react_markdown_editor = serializers.SerializerMethodField() use_video_gallery_flow = serializers.SerializerMethodField() enable_course_optimizer_check_prev_run_links = serializers.SerializerMethodField() + enable_authz_course_authoring = serializers.SerializerMethodField() def get_course_key(self): """ @@ -64,24 +67,33 @@ def get_use_new_custom_pages(self, obj): def get_use_new_schedule_details_page(self, obj): """ - Method to get the use_new_schedule_details_page switch + Method to indicate whether we should use the new schedule details page. + + This used to be based on a waffle flag but the flag is being removed so we + default it to true for now until we can remove the need for it from the consumers + of this serializer and the related APIs. + + See https://github.com/openedx/edx-platform/issues/36275 """ - course_key = self.get_course_key() - return toggles.use_new_schedule_details_page(course_key) + return True def get_use_new_advanced_settings_page(self, obj): """ Method to get the use_new_advanced_settings_page switch """ - course_key = self.get_course_key() - return toggles.use_new_advanced_settings_page(course_key) + return True def get_use_new_grading_page(self, obj): """ - Method to get the use_new_grading_page switch + Method to indicate whether we should use the new grading page. + + This used to be based on a waffle flag but the flag is being removed so we + default it to true for now until we can remove the need for it from the consumers + of this serializer and the related APIs. + + See https://github.com/openedx/edx-platform/issues/36275 """ - course_key = self.get_course_key() - return toggles.use_new_grading_page(course_key) + return True def get_use_new_updates_page(self, obj): """ @@ -99,15 +111,13 @@ def get_use_new_import_page(self, obj): """ Method to get the use_new_import_page switch """ - course_key = self.get_course_key() - return toggles.use_new_import_page(course_key) + return True def get_use_new_export_page(self, obj): """ Method to get the use_new_export_page switch """ - course_key = self.get_course_key() - return toggles.use_new_export_page(course_key) + return True def get_use_new_files_uploads_page(self, obj): """ @@ -118,9 +128,20 @@ def get_use_new_files_uploads_page(self, obj): """ return True + def get_use_new_pdf_editor(self, obj): + """ + Method to get the use_new_pdf_editor switch + """ + return toggles.use_new_pdf_editor() + def get_use_new_video_uploads_page(self, obj): """ - Method to get the use_new_video_uploads_page switch + Method to get the use_new_video_uploads_page switch. + + This is off by default because the video uploads page requires the edX + video pipeline which is not available to the open source community. + + See https://github.com/openedx/openedx-platform/issues/37972 """ course_key = self.get_course_key() return toggles.use_new_video_uploads_page(course_key) @@ -146,15 +167,13 @@ def get_use_new_course_team_page(self, obj): """ Method to get the use_new_course_team_page switch """ - course_key = self.get_course_key() - return toggles.use_new_course_team_page(course_key) + return True def get_use_new_certificates_page(self, obj): """ Method to get the use_new_certificates_page switch """ - course_key = self.get_course_key() - return toggles.use_new_certificates_page(course_key) + return True def get_use_new_textbooks_page(self, obj): """ @@ -172,8 +191,7 @@ def get_use_new_group_configurations_page(self, obj): """ Method to get the use_new_group_configurations_page switch """ - course_key = self.get_course_key() - return toggles.use_new_group_configurations_page(course_key) + return True def get_enable_course_optimizer(self, obj): """ @@ -201,3 +219,10 @@ def get_enable_course_optimizer_check_prev_run_links(self, obj): """ course_key = self.get_course_key() return toggles.enable_course_optimizer_check_prev_run_links(course_key) + + def get_enable_authz_course_authoring(self, obj): + """ + Method to get the authz.enable_course_authoring waffle flag + """ + course_key = self.get_course_key() + return core_toggles.enable_authz_course_authoring(course_key) diff --git a/cms/djangoapps/contentstore/rest_api/v1/serializers/vertical_block.py b/cms/djangoapps/contentstore/rest_api/v1/serializers/vertical_block.py index eb4f333e170a..a12b8922557b 100644 --- a/cms/djangoapps/contentstore/rest_api/v1/serializers/vertical_block.py +++ b/cms/djangoapps/contentstore/rest_api/v1/serializers/vertical_block.py @@ -5,10 +5,7 @@ from django.urls import reverse from rest_framework import serializers -from cms.djangoapps.contentstore.helpers import ( - xblock_studio_url, - xblock_type_display_name, -) +from cms.djangoapps.contentstore.helpers import xblock_studio_url, xblock_type_display_name from openedx.core.djangoapps.content_tagging.toggles import is_tagging_feature_disabled @@ -125,7 +122,7 @@ class UpstreamLinkSerializer(serializers.Serializer): error_message = serializers.CharField(allow_null=True) ready_to_sync = serializers.BooleanField() downstream_customized = serializers.ListField(child=serializers.CharField(), allow_empty=True) - has_top_level_parent = serializers.BooleanField() + top_level_parent_key = serializers.CharField(allow_null=True) ready_to_sync_children = UpstreamChildrenInfoSerializer(many=True, required=False) diff --git a/cms/djangoapps/contentstore/rest_api/v1/serializers/videos.py b/cms/djangoapps/contentstore/rest_api/v1/serializers/videos.py index bd85fdb77220..11620eb9c353 100644 --- a/cms/djangoapps/contentstore/rest_api/v1/serializers/videos.py +++ b/cms/djangoapps/contentstore/rest_api/v1/serializers/videos.py @@ -2,6 +2,7 @@ API Serializers for videos """ from rest_framework import serializers + from cms.djangoapps.contentstore.rest_api.serializers.common import StrictSerializer diff --git a/cms/djangoapps/contentstore/rest_api/v1/views/__init__.py b/cms/djangoapps/contentstore/rest_api/v1/views/__init__.py index d4fcfd5f2e3f..7654c9e0befc 100644 --- a/cms/djangoapps/contentstore/rest_api/v1/views/__init__.py +++ b/cms/djangoapps/contentstore/rest_api/v1/views/__init__.py @@ -1,22 +1,18 @@ """ Views for v1 contentstore API. """ -from .certificates import CourseCertificatesView -from .course_details import CourseDetailsView -from .course_index import ContainerChildrenView, CourseIndexView -from .course_rerun import CourseRerunView -from .course_team import CourseTeamView -from .course_waffle_flags import CourseWaffleFlagsView -from .grading import CourseGradingView -from .group_configurations import CourseGroupConfigurationsView -from .help_urls import HelpUrlsView -from .home import HomePageCoursesView, HomePageLibrariesView, HomePageView -from .proctoring import ProctoredExamSettingsView, ProctoringErrorsView -from .settings import CourseSettingsView -from .textbooks import CourseTextbooksView -from .vertical_block import ContainerHandlerView, vertical_container_children_redirect_view -from .videos import ( - CourseVideosView, - VideoDownloadView, - VideoUsageView, -) +from .certificates import CourseCertificatesView # noqa: F401 +from .course_details import CourseDetailsView # noqa: F401 +from .course_index import ContainerChildrenView, CourseIndexView # noqa: F401 +from .course_rerun import CourseRerunView # noqa: F401 +from .course_team import CourseTeamView # noqa: F401 +from .course_waffle_flags import CourseWaffleFlagsView # noqa: F401 +from .grading import CourseGradingView # noqa: F401 +from .group_configurations import CourseGroupConfigurationsView # noqa: F401 +from .help_urls import HelpUrlsView # noqa: F401 +from .home import HomePageCoursesView, HomePageLibrariesView, HomePageView # noqa: F401 +from .proctoring import ProctoredExamSettingsView, ProctoringErrorsView # noqa: F401 +from .settings import CourseSettingsView # noqa: F401 +from .textbooks import CourseTextbooksView # noqa: F401 +from .vertical_block import ContainerHandlerView, vertical_container_children_redirect_view # noqa: F401 +from .videos import CourseVideosView, VideoDownloadView, VideoUsageView # noqa: F401 diff --git a/cms/djangoapps/contentstore/rest_api/v1/views/certificates.py b/cms/djangoapps/contentstore/rest_api/v1/views/certificates.py index db93d65da68a..43069553a067 100644 --- a/cms/djangoapps/contentstore/rest_api/v1/views/certificates.py +++ b/cms/djangoapps/contentstore/rest_api/v1/views/certificates.py @@ -2,20 +2,16 @@ import edx_api_doc_tools as apidocs from opaque_keys.edx.keys import CourseKey +from openedx_authz.constants.permissions import COURSES_MANAGE_CERTIFICATES from rest_framework.request import Request from rest_framework.response import Response from rest_framework.views import APIView +from cms.djangoapps.contentstore.rest_api.v1.serializers import CourseCertificatesSerializer from cms.djangoapps.contentstore.utils import get_certificates_context -from cms.djangoapps.contentstore.rest_api.v1.serializers import ( - CourseCertificatesSerializer, -) -from common.djangoapps.student.auth import has_studio_write_access -from openedx.core.lib.api.view_utils import ( - DeveloperErrorViewMixin, - verify_course_exists, - view_auth_classes, -) +from openedx.core.djangoapps.authz.constants import LegacyAuthoringPermission +from openedx.core.djangoapps.authz.decorators import user_has_course_permission +from openedx.core.lib.api.view_utils import DeveloperErrorViewMixin, verify_course_exists, view_auth_classes from xmodule.modulestore.django import modulestore @@ -96,7 +92,12 @@ def get(self, request: Request, course_id: str): course_key = CourseKey.from_string(course_id) store = modulestore() - if not has_studio_write_access(request.user, course_key): + if not user_has_course_permission( + request.user, + COURSES_MANAGE_CERTIFICATES.identifier, + course_key, + LegacyAuthoringPermission.WRITE + ): self.permission_denied(request) with store.bulk_operations(course_key): diff --git a/cms/djangoapps/contentstore/rest_api/v1/views/course_details.py b/cms/djangoapps/contentstore/rest_api/v1/views/course_details.py index d5ccf3c6165e..2bb9c571d2fd 100644 --- a/cms/djangoapps/contentstore/rest_api/v1/views/course_details.py +++ b/cms/djangoapps/contentstore/rest_api/v1/views/course_details.py @@ -2,18 +2,95 @@ import edx_api_doc_tools as apidocs from django.core.exceptions import ValidationError -from common.djangoapps.util.json_request import JsonResponseBadRequest from opaque_keys.edx.keys import CourseKey +from openedx_authz.constants.permissions import ( + COURSES_EDIT_DETAILS, + COURSES_EDIT_SCHEDULE, + COURSES_VIEW_SCHEDULE_AND_DETAILS, +) from rest_framework.request import Request from rest_framework.response import Response from rest_framework.views import APIView -from common.djangoapps.student.auth import has_studio_read_access + +from common.djangoapps.util.json_request import JsonResponseBadRequest +from openedx.core.djangoapps.authz.constants import LegacyAuthoringPermission +from openedx.core.djangoapps.authz.decorators import user_has_course_permission from openedx.core.djangoapps.models.course_details import CourseDetails from openedx.core.lib.api.view_utils import DeveloperErrorViewMixin, verify_course_exists, view_auth_classes from xmodule.modulestore.django import modulestore -from ..serializers import CourseDetailsSerializer from ....utils import update_course_details +from ..serializers import CourseDetailsSerializer + + +def _classify_update(payload: dict, course_key: CourseKey) -> tuple[bool, bool]: + """ + Determine whether the payload is updating schedule fields, detail fields, or both + for the course identified by course_key. + + Returns: + (is_schedule_update, is_details_update) + """ + + # Define which fields are considered schedule fields. + # Any field not in this set that is being updated will be considered a details update. + schedule_fields = frozenset( + {"start_date", "end_date", "enrollment_start", "enrollment_end", "certificate_available_date"} + ) + + # Define which fields are date fields to ensure proper comparison after parsing. + # At this time, all schedule fields are also date fields, but this is defined separately for clarity + # and in case this changes in the future. + date_fields = frozenset( + {"start_date", "end_date", "enrollment_start", "enrollment_end", "certificate_available_date"} + ) + + course_details = CourseDetails.fetch(course_key) + + is_schedule_update = False + is_details_update = False + + serializer = CourseDetailsSerializer() + + for field, payload_value in payload.items(): + # Early exit for efficiency + if is_schedule_update and is_details_update: + break + + # Ignore unknown fields if needed + if field not in serializer.fields: + continue + + current_value = getattr(course_details, field, None) + + if field in date_fields: + # For date fields, we need to parse the payload value to compare it with the current value + try: + # Convert payload value to internal value for accurate comparison + # on date fields + if payload_value is not None: + payload_value = serializer.fields[field].to_internal_value(payload_value) + except ValidationError as exc: + raise ValidationError( + f"Invalid date format for field {field}: {payload_value}" + ) from exc + + # Check schedule fields + if field in schedule_fields: + if is_schedule_update: + # Already classified as schedule update, no need to check again + continue + if payload_value != current_value: + is_schedule_update = True + else: + # Any non-schedule field counts as details update + if is_details_update: + # Already classified as details update, no need to check again + continue + if payload_value != current_value: + is_details_update = True + + return is_schedule_update, is_details_update @view_auth_classes(is_authenticated=True) @@ -98,7 +175,12 @@ def get(self, request: Request, course_id: str): ``` """ course_key = CourseKey.from_string(course_id) - if not has_studio_read_access(request.user, course_key): + if not user_has_course_permission( + request.user, + COURSES_VIEW_SCHEDULE_AND_DETAILS.identifier, + course_key, + LegacyAuthoringPermission.READ + ): self.permission_denied(request) course_details = CourseDetails.fetch(course_key) @@ -141,7 +223,26 @@ def put(self, request: Request, course_id: str): along with all the course's details similar to a ``GET`` request. """ course_key = CourseKey.from_string(course_id) - if not has_studio_read_access(request.user, course_key): + is_schedule_update, is_details_update = _classify_update(request.data, course_key) + + if not is_schedule_update and not is_details_update: + # No updatable fields provided in the request + is_details_update = True # To trigger permission check and return 403 if user cannot edit details + + if is_schedule_update and not user_has_course_permission( + request.user, + COURSES_EDIT_SCHEDULE.identifier, + course_key, + LegacyAuthoringPermission.READ + ): + self.permission_denied(request) + + if is_details_update and not user_has_course_permission( + request.user, + COURSES_EDIT_DETAILS.identifier, + course_key, + LegacyAuthoringPermission.READ + ): self.permission_denied(request) course_block = modulestore().get_course(course_key) diff --git a/cms/djangoapps/contentstore/rest_api/v1/views/course_index.py b/cms/djangoapps/contentstore/rest_api/v1/views/course_index.py index 42b5b1e9d78d..f95c4e23e895 100644 --- a/cms/djangoapps/contentstore/rest_api/v1/views/course_index.py +++ b/cms/djangoapps/contentstore/rest_api/v1/views/course_index.py @@ -5,17 +5,15 @@ import edx_api_doc_tools as apidocs from django.conf import settings from opaque_keys.edx.keys import CourseKey +from openedx_authz.constants.permissions import COURSES_VIEW_COURSE +from rest_framework.fields import BooleanField from rest_framework.request import Request from rest_framework.response import Response from rest_framework.views import APIView -from rest_framework.fields import BooleanField from cms.djangoapps.contentstore.config.waffle import CUSTOM_RELATIVE_DATES from cms.djangoapps.contentstore.rest_api.v1.mixins import ContainerHandlerMixin -from cms.djangoapps.contentstore.rest_api.v1.serializers import ( - CourseIndexSerializer, - ContainerChildrenSerializer, -) +from cms.djangoapps.contentstore.rest_api.v1.serializers import ContainerChildrenSerializer, CourseIndexSerializer from cms.djangoapps.contentstore.utils import ( get_course_index_context, get_user_partition_info, @@ -25,10 +23,10 @@ ) from cms.djangoapps.contentstore.xblock_storage_handlers.view_handlers import get_xblock from cms.lib.xblock.upstream_sync import UpstreamLink -from common.djangoapps.student.auth import has_studio_read_access +from openedx.core.djangoapps.authz.decorators import LegacyAuthoringPermission, user_has_course_permission from openedx.core.lib.api.view_utils import DeveloperErrorViewMixin, verify_course_exists, view_auth_classes -from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.exceptions import ItemNotFoundError # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order +from xmodule.modulestore.exceptions import ItemNotFoundError # pylint: disable=wrong-import-order @view_auth_classes(is_authenticated=True) @@ -104,7 +102,12 @@ def get(self, request: Request, course_id: str): """ course_key = CourseKey.from_string(course_id) - if not has_studio_read_access(request.user, course_key): + if not user_has_course_permission( + request.user, + COURSES_VIEW_COURSE.identifier, + course_key, + LegacyAuthoringPermission.READ + ): self.permission_denied(request) course_index_context = get_course_index_context(request, course_key) course_index_context.update({ diff --git a/cms/djangoapps/contentstore/rest_api/v1/views/course_rerun.py b/cms/djangoapps/contentstore/rest_api/v1/views/course_rerun.py index fe39858c5380..dbec4b0b8441 100644 --- a/cms/djangoapps/contentstore/rest_api/v1/views/course_rerun.py +++ b/cms/djangoapps/contentstore/rest_api/v1/views/course_rerun.py @@ -6,8 +6,8 @@ from rest_framework.response import Response from rest_framework.views import APIView -from cms.djangoapps.contentstore.utils import get_course_rerun_context from cms.djangoapps.contentstore.rest_api.v1.serializers import CourseRerunSerializer +from cms.djangoapps.contentstore.utils import get_course_rerun_context from common.djangoapps.student.roles import GlobalStaff from openedx.core.lib.api.view_utils import DeveloperErrorViewMixin, verify_course_exists, view_auth_classes from xmodule.modulestore.django import modulestore diff --git a/cms/djangoapps/contentstore/rest_api/v1/views/grading.py b/cms/djangoapps/contentstore/rest_api/v1/views/grading.py index 9275fecb58ab..a27cfd144a56 100644 --- a/cms/djangoapps/contentstore/rest_api/v1/views/grading.py +++ b/cms/djangoapps/contentstore/rest_api/v1/views/grading.py @@ -3,19 +3,21 @@ import edx_api_doc_tools as apidocs from django.conf import settings from opaque_keys.edx.keys import CourseKey +from openedx_authz.constants.permissions import COURSES_EDIT_GRADING_SETTINGS, COURSES_VIEW_GRADING_SETTINGS from rest_framework.request import Request from rest_framework.response import Response from rest_framework.views import APIView from cms.djangoapps.models.settings.course_grading import CourseGradingModel -from common.djangoapps.student.auth import has_studio_read_access +from openedx.core.djangoapps.authz.constants import LegacyAuthoringPermission +from openedx.core.djangoapps.authz.decorators import authz_permission_required from openedx.core.djangoapps.credit.api import is_credit_course from openedx.core.djangoapps.credit.tasks import update_credit_course_requirements from openedx.core.lib.api.view_utils import DeveloperErrorViewMixin, verify_course_exists, view_auth_classes from xmodule.modulestore.django import modulestore -from ..serializers import CourseGradingModelSerializer, CourseGradingSerializer from ....utils import get_course_grading +from ..serializers import CourseGradingModelSerializer, CourseGradingSerializer @view_auth_classes(is_authenticated=True) @@ -36,7 +38,8 @@ class CourseGradingView(DeveloperErrorViewMixin, APIView): }, ) @verify_course_exists() - def get(self, request: Request, course_id: str): + @authz_permission_required(COURSES_VIEW_GRADING_SETTINGS.identifier, LegacyAuthoringPermission.READ) + def get(self, request: Request, course_key: CourseKey): """ Get an object containing course grading settings with model. @@ -90,11 +93,6 @@ def get(self, request: Request, course_id: str): } ``` """ - course_key = CourseKey.from_string(course_id) - - if not has_studio_read_access(request.user, course_key): - self.permission_denied(request) - with modulestore().bulk_operations(course_key): credit_eligibility_enabled = settings.FEATURES.get("ENABLE_CREDIT_ELIGIBILITY", False) show_credit_eligibility = is_credit_course(course_key) and credit_eligibility_enabled @@ -118,13 +116,16 @@ def get(self, request: Request, course_id: str): }, ) @verify_course_exists() - def post(self, request: Request, course_id: str): + # Please note: previous legacy permisison was checking for has_studio_read_access + # So we are using LegacyAuthoringPermission.READ to keep compatibility + @authz_permission_required(COURSES_EDIT_GRADING_SETTINGS.identifier, LegacyAuthoringPermission.READ) + def post(self, request: Request, course_key: CourseKey): """ Update a course's grading. **Example Request** - PUT /api/contentstore/v1/course_grading/{course_id} + POST /api/contentstore/v1/course_grading/{course_id} **POST Parameters** @@ -162,11 +163,6 @@ def post(self, request: Request, course_id: str): If the request is successful, an HTTP 200 "OK" response is returned, """ - course_key = CourseKey.from_string(course_id) - - if not has_studio_read_access(request.user, course_key): - self.permission_denied(request) - if 'minimum_grade_credit' in request.data: update_credit_course_requirements.delay(str(course_key)) diff --git a/cms/djangoapps/contentstore/rest_api/v1/views/group_configurations.py b/cms/djangoapps/contentstore/rest_api/v1/views/group_configurations.py index 49fc76850d6e..4de2dd8a16b7 100644 --- a/cms/djangoapps/contentstore/rest_api/v1/views/group_configurations.py +++ b/cms/djangoapps/contentstore/rest_api/v1/views/group_configurations.py @@ -2,20 +2,16 @@ import edx_api_doc_tools as apidocs from opaque_keys.edx.keys import CourseKey +from openedx_authz.constants.permissions import COURSES_MANAGE_GROUP_CONFIGURATIONS from rest_framework.request import Request from rest_framework.response import Response from rest_framework.views import APIView +from cms.djangoapps.contentstore.rest_api.v1.serializers import CourseGroupConfigurationsSerializer from cms.djangoapps.contentstore.utils import get_group_configurations_context -from cms.djangoapps.contentstore.rest_api.v1.serializers import ( - CourseGroupConfigurationsSerializer, -) -from common.djangoapps.student.auth import has_studio_read_access -from openedx.core.lib.api.view_utils import ( - DeveloperErrorViewMixin, - verify_course_exists, - view_auth_classes, -) +from openedx.core.djangoapps.authz.constants import LegacyAuthoringPermission +from openedx.core.djangoapps.authz.decorators import authz_permission_required +from openedx.core.lib.api.view_utils import DeveloperErrorViewMixin, verify_course_exists, view_auth_classes from xmodule.modulestore.django import modulestore @@ -39,7 +35,11 @@ class CourseGroupConfigurationsView(DeveloperErrorViewMixin, APIView): }, ) @verify_course_exists() - def get(self, request: Request, course_id: str): + @authz_permission_required( + authz_permission=COURSES_MANAGE_GROUP_CONFIGURATIONS.identifier, + legacy_permission=LegacyAuthoringPermission.READ + ) + def get(self, request: Request, course_key: CourseKey): """ Get an object containing course's settings group configurations. @@ -139,12 +139,8 @@ def get(self, request: Request, course_id: str): } ``` """ - course_key = CourseKey.from_string(course_id) store = modulestore() - if not has_studio_read_access(request.user, course_key): - self.permission_denied(request) - with store.bulk_operations(course_key): course = modulestore().get_course(course_key) group_configurations_context = get_group_configurations_context(course, store) diff --git a/cms/djangoapps/contentstore/rest_api/v1/views/help_urls.py b/cms/djangoapps/contentstore/rest_api/v1/views/help_urls.py index 09798485a37f..bb18b227ee9a 100644 --- a/cms/djangoapps/contentstore/rest_api/v1/views/help_urls.py +++ b/cms/djangoapps/contentstore/rest_api/v1/views/help_urls.py @@ -3,6 +3,7 @@ from rest_framework.request import Request from rest_framework.response import Response from rest_framework.views import APIView + from openedx.core.lib.api.view_utils import view_auth_classes from ....utils import get_help_urls diff --git a/cms/djangoapps/contentstore/rest_api/v1/views/proctoring.py b/cms/djangoapps/contentstore/rest_api/v1/views/proctoring.py index f654ab874fad..0c4ea92898fd 100644 --- a/cms/djangoapps/contentstore/rest_api/v1/views/proctoring.py +++ b/cms/djangoapps/contentstore/rest_api/v1/views/proctoring.py @@ -1,8 +1,8 @@ """ API Views for proctored exam settings and proctoring error """ import copy -from django.conf import settings import edx_api_doc_tools as apidocs +from django.conf import settings from opaque_keys.edx.keys import CourseKey from rest_framework import status from rest_framework.exceptions import NotFound @@ -10,17 +10,17 @@ from rest_framework.response import Response from rest_framework.views import APIView -from cms.djangoapps.contentstore.views.course import get_course_and_check_access from cms.djangoapps.contentstore.utils import get_proctored_exam_settings_url +from cms.djangoapps.contentstore.views.course import get_course_and_check_access from cms.djangoapps.models.settings.course_metadata import CourseMetadata -from common.djangoapps.student.auth import has_studio_advanced_settings_access -from xmodule.course_block import ( - get_available_providers, - get_requires_escalation_email_providers, -) # lint-amnesty, pylint: disable=wrong-import-order +from common.djangoapps.student.auth import check_course_advanced_settings_access from openedx.core.djangoapps.course_apps.toggles import exams_ida_enabled from openedx.core.lib.api.view_utils import DeveloperErrorViewMixin, verify_course_exists, view_auth_classes -from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.course_block import ( # pylint: disable=wrong-import-order + get_available_providers, + get_requires_escalation_email_providers, +) +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order from ..serializers import ( LimitedProctoredExamSettingsSerializer, @@ -260,7 +260,9 @@ def get(self, request: Request, course_id: str) -> Response: ``` """ course_key = CourseKey.from_string(course_id) - if not has_studio_advanced_settings_access(request.user): + if not check_course_advanced_settings_access( + request.user, course_key, access_type='feature_restricted' + ): self.permission_denied(request) course_block = modulestore().get_course(course_key) diff --git a/cms/djangoapps/contentstore/rest_api/v1/views/settings.py b/cms/djangoapps/contentstore/rest_api/v1/views/settings.py index fbb05cba4de2..d5f24fe81ddb 100644 --- a/cms/djangoapps/contentstore/rest_api/v1/views/settings.py +++ b/cms/djangoapps/contentstore/rest_api/v1/views/settings.py @@ -3,17 +3,19 @@ import edx_api_doc_tools as apidocs from django.conf import settings from opaque_keys.edx.keys import CourseKey +from openedx_authz.constants.permissions import COURSES_VIEW_COURSE from rest_framework.request import Request from rest_framework.response import Response from rest_framework.views import APIView -from common.djangoapps.student.auth import has_studio_read_access from lms.djangoapps.certificates.api import can_show_certificate_available_date_field +from openedx.core.djangoapps.authz.constants import LegacyAuthoringPermission +from openedx.core.djangoapps.authz.decorators import user_has_course_permission from openedx.core.lib.api.view_utils import DeveloperErrorViewMixin, verify_course_exists, view_auth_classes from xmodule.modulestore.django import modulestore -from ..serializers import CourseSettingsSerializer from ....utils import get_course_settings +from ..serializers import CourseSettingsSerializer @view_auth_classes(is_authenticated=True) @@ -99,7 +101,12 @@ def get(self, request: Request, course_id: str): ``` """ course_key = CourseKey.from_string(course_id) - if not has_studio_read_access(request.user, course_key): + if not user_has_course_permission( + request.user, + COURSES_VIEW_COURSE.identifier, + course_key, + LegacyAuthoringPermission.READ + ): self.permission_denied(request) with modulestore().bulk_operations(course_key): diff --git a/cms/djangoapps/contentstore/rest_api/v1/views/tests/test_certificates.py b/cms/djangoapps/contentstore/rest_api/v1/views/tests/test_certificates.py index db9d1dacca90..9ae3ba84d8bc 100644 --- a/cms/djangoapps/contentstore/rest_api/v1/views/tests/test_certificates.py +++ b/cms/djangoapps/contentstore/rest_api/v1/views/tests/test_certificates.py @@ -2,10 +2,12 @@ Unit tests for the course's certificate. """ from django.urls import reverse +from openedx_authz.constants.roles import COURSE_EDITOR, COURSE_STAFF from rest_framework import status from cms.djangoapps.contentstore.tests.utils import CourseTestCase from cms.djangoapps.contentstore.views.tests.test_certificates import HelperMethods +from openedx.core.djangoapps.authz.tests.mixins import CourseAuthoringAuthzTestMixin from ...mixins import PermissionAccessMixin @@ -29,10 +31,42 @@ def test_success_response(self): self._add_course_certificates(count=2, signatory_count=2) response = self.client.get(self.url) response_data = response.data - self.assertEqual(response.status_code, status.HTTP_200_OK) - self.assertEqual(len(response_data["certificates"]), 2) - self.assertEqual(len(response_data["certificates"][0]["signatories"]), 2) - self.assertEqual(len(response_data["certificates"][1]["signatories"]), 2) - self.assertEqual(response_data["course_number_override"], self.course.display_coursenumber) - self.assertEqual(response_data["course_title"], self.course.display_name_with_default) - self.assertEqual(response_data["course_number"], self.course.number) + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 + self.assertEqual(len(response_data["certificates"]), 2) # noqa: PT009 + self.assertEqual(len(response_data["certificates"][0]["signatories"]), 2) # noqa: PT009 + self.assertEqual(len(response_data["certificates"][1]["signatories"]), 2) # noqa: PT009 + self.assertEqual(response_data["course_number_override"], self.course.display_coursenumber) # noqa: PT009 + self.assertEqual(response_data["course_title"], self.course.display_name_with_default) # noqa: PT009 + self.assertEqual(response_data["course_number"], self.course.number) # noqa: PT009 + + +class CourseCertificatesAuthzViewTest( + CourseAuthoringAuthzTestMixin, CourseTestCase, PermissionAccessMixin, HelperMethods + ): + """ + Tests for CourseCertificatesView with AuthZ enabled. + """ + + def setUp(self): + super().setUp() + self.url = reverse( + "cms.djangoapps.contentstore:v1:certificates", + kwargs={"course_id": self.course.id}, + ) + + def test_authorized_user_can_access(self): + """User with COURSE_STAFF role can access.""" + self._add_course_certificates(count=2, signatory_count=2) + self.add_user_to_role_in_course(self.authorized_user, COURSE_STAFF.external_key, self.course.id) + resp = self.authorized_client.get(self.url) + self.assertEqual(resp.status_code, status.HTTP_200_OK) # noqa: PT009 + + def test_non_staff_user_cannot_access(self): + """ + User without permissions should be denied. + This case validates that a non-staff user cannot access. + """ + self._add_course_certificates(count=2, signatory_count=2) + self.add_user_to_role_in_course(self.authorized_user, COURSE_EDITOR.external_key, self.course.id) + resp = self.authorized_client.get(self.url) + self.assertEqual(resp.status_code, status.HTTP_403_FORBIDDEN) # noqa: PT009 diff --git a/cms/djangoapps/contentstore/rest_api/v1/views/tests/test_course_details.py b/cms/djangoapps/contentstore/rest_api/v1/views/tests/test_course_details.py index cbc2fdc98c3f..d6f404be9a8b 100644 --- a/cms/djangoapps/contentstore/rest_api/v1/views/tests/test_course_details.py +++ b/cms/djangoapps/contentstore/rest_api/v1/views/tests/test_course_details.py @@ -2,13 +2,18 @@ Unit tests for course details views. """ import json -from unittest.mock import patch +from unittest.mock import MagicMock, patch import ddt from django.urls import reverse +from openedx_authz.constants.roles import COURSE_EDITOR, COURSE_STAFF from rest_framework import status +from rest_framework.test import APIClient +from cms.djangoapps.contentstore.rest_api.v1.views.course_details import _classify_update from cms.djangoapps.contentstore.tests.utils import CourseTestCase +from openedx.core.djangoapps.authz.tests.mixins import CourseAuthoringAuthzTestMixin +from xmodule.modulestore.django import SignalHandler from ...mixins import PermissionAccessMixin @@ -33,18 +38,24 @@ def test_put_permissions_unauthenticated(self): self.client.logout() response = self.client.put(self.url) error = self.get_and_check_developer_response(response) - self.assertEqual(error, "Authentication credentials were not provided.") - self.assertEqual(response.status_code, status.HTTP_401_UNAUTHORIZED) + self.assertEqual(error, "Authentication credentials were not provided.") # noqa: PT009 + self.assertEqual(response.status_code, status.HTTP_401_UNAUTHORIZED) # noqa: PT009 def test_put_permissions_unauthorized(self): """ Test that an error is returned if the user is unauthorised. """ client, _ = self.create_non_staff_authed_user_client() - response = client.put(self.url) + pre_requisite_course_keys = [str(self.course.id), "invalid_key"] + request_data = {"pre_requisite_courses": pre_requisite_course_keys} + response = client.put( + path=self.url, + data=json.dumps(request_data), + content_type="application/json", + ) error = self.get_and_check_developer_response(response) - self.assertEqual(error, "You do not have permission to perform this action.") - self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN) + self.assertEqual(error, "You do not have permission to perform this action.") # noqa: PT009 + self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN) # noqa: PT009 @patch.dict("django.conf.settings.FEATURES", {"ENABLE_PREREQUISITE_COURSES": True}) def test_put_invalid_pre_requisite_course(self): @@ -55,8 +66,8 @@ def test_put_invalid_pre_requisite_course(self): data=json.dumps(request_data), content_type="application/json", ) - self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST) - self.assertEqual(response.json()["error"], "Invalid prerequisite course key") + self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST) # noqa: PT009 + self.assertEqual(response.json()["error"], "Invalid prerequisite course key") # noqa: PT009 def test_put_course_details(self): request_data = { @@ -110,4 +121,483 @@ def test_put_course_details(self): data=json.dumps(request_data), content_type="application/json", ) - self.assertEqual(response.status_code, status.HTTP_200_OK) + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 + + def test_put_emits_course_published_signal_once(self): + """ + Verify that a single PUT to the course details API emits the + course_published signal exactly once. + + The bulk_operations context inside update_from_json coalesces all + individual update_item / delete_item calls into a single signal + emission. Without it, each call would fire its own signal. + """ + signal_handler = MagicMock() + SignalHandler.course_published.connect(signal_handler) + try: + request_data = { + "overview": "

Updated overview

", + "short_description": "Updated short description", + "effort": "3 hours/week", + "language": "en", + "intro_video": None, + } + # ModuleStoreTestCase disables all signals by default; re-enable + # course_published for this test so we can assert on its emission. + with SignalHandler.course_published.for_state(is_enabled=True): + response = self.client.put( + path=self.url, + data=json.dumps(request_data), + content_type="application/json", + ) + assert response.status_code == status.HTTP_200_OK + signal_handler.assert_called_once() + finally: + SignalHandler.course_published.disconnect(signal_handler) + + +@ddt.ddt +class CourseDetailsAuthzViewTest(CourseAuthoringAuthzTestMixin, CourseTestCase): + """ + Tests for CourseDetailsView using AuthZ permissions. + """ + + def setUp(self): + super().setUp() + self.url = reverse( + "cms.djangoapps.contentstore:v1:course_details", + kwargs={"course_id": self.course.id}, + ) + self.request_data = { + "about_sidebar_html": "", + "banner_image_name": "images_course_image.jpg", + "banner_image_asset_path": "/asset-v1:edX+E2E-101+course+type@asset+block@images_course_image.jpg", + "certificate_available_date": "2029-01-02T00:00:00Z", + "certificates_display_behavior": "end", + "course_id": "E2E-101", + "course_image_asset_path": "/static/studio/images/pencils.jpg", + "course_image_name": "bar_course_image_name", + "description": "foo_description", + "duration": "", + "effort": None, + "end_date": "2023-08-01T01:30:00Z", + "enrollment_end": "2023-05-30T01:00:00Z", + "enrollment_start": "2023-05-29T01:00:00Z", + "entrance_exam_enabled": "", + "entrance_exam_id": "", + "entrance_exam_minimum_score_pct": "50", + "intro_video": None, + "language": "creative-commons: ver=4.0 BY NC ND", + "learning_info": ["foo", "bar"], + "license": "creative-commons: ver=4.0 BY NC ND", + "org": "edX", + "overview": '
', + "pre_requisite_courses": [], + "run": "course", + "self_paced": None, + "short_description": "", + "start_date": "2023-06-01T01:30:00Z", + "subtitle": "", + "syllabus": None, + "title": "", + "video_thumbnail_image_asset_path": "/asset-v1:edX+E2E-101+course+type@asset+block@images_course_image.jpg", + "video_thumbnail_image_name": "images_course_image.jpg", + "instructor_info": { + "instructors": [ + { + "name": "foo bar", + "title": "title", + "organization": "org", + "image": "image", + "bio": "", + } + ] + }, + } + + def test_put_permissions_unauthenticated(self): + """ + Test that an error is returned in the absence of auth credentials. + """ + client = APIClient() # no auth + response = client.put(self.url) + + self.assertEqual(response.status_code, status.HTTP_401_UNAUTHORIZED) # noqa: PT009 + + def test_put_permissions_unauthorized(self): + """ + Test that an error is returned if the user is unauthorised. + """ + response = self.unauthorized_client.put( + path=self.url, + data=json.dumps(self.request_data), + content_type="application/json", + ) + + self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN) # noqa: PT009 + + def test_get_course_details_authorized(self): + """ + Authorized user with COURSE_EDITOR role can access course details. + """ + self.add_user_to_role_in_course( + self.authorized_user, + COURSE_EDITOR.external_key, + self.course.id + ) + + response = self.authorized_client.get(self.url) + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 + + def test_get_course_details_unauthorized(self): + """ + Unauthorized user should receive 403. + """ + response = self.unauthorized_client.get(self.url) + self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN) # noqa: PT009 + + def test_get_course_details_staff_user(self): + """ + Django staff user should bypass AuthZ and access course details. + """ + response = self.staff_client.get(self.url) + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 + + def test_get_course_details_super_user(self): + """ + Superuser should bypass AuthZ and access course details. + """ + response = self.super_client.get(self.url) + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 + + @ddt.data( + # No changes + ({}, (False, False)), + ( + {"certificates_display_behavior": "end"}, # same value as existing course detail + (False, False), + ), + + # Schedule-only fields + ({"start_date": "2023-01-01"}, (True, False)), + ({"end_date": "2023-02-01"}, (True, False)), + ({"enrollment_start": "2023-01-01"}, (True, False)), + ({"enrollment_end": "2023-01-10"}, (True, False)), + + # Details-only fields + ({"title": "New Title"}, (False, True)), + ({"description": "New description"}, (False, True)), + ({"short_description": "Short"}, (False, True)), + ({"overview": "

HTML

"}, (False, True)), + + # Mixed fields + ( + {"title": "New Title", "start_date": "2023-01-01"}, + (True, True) + ), + + # Non-updatable / irrelevant fields + ({"random_field": "value"}, (False, False)), + ) + @ddt.unpack + def test_classify_update(self, payload, expected): + result = _classify_update(payload, self.course.id) + self.assertEqual(result, expected) # noqa: PT009 + + def test_classyfy_update_with_get_request(self): + """ + GET request with no changes should not be classified as schedule or details update. + """ + # Get the current status of the course details to use + # as the basis for the update request + self.add_user_to_role_in_course( + self.authorized_user, + COURSE_EDITOR.external_key, + self.course.id + ) + response = self.authorized_client.get(self.url) + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 + current_course_details = response.json() + # This field is flagged as a details update because of a type mismatch: + # the GET response returns an invalid string, while the stored value has a different type. + # As a result, the equality check fails even though the values are logically the same. + current_course_details["certificates_display_behavior"] = "end" + + expected = (False, False) + result = _classify_update(current_course_details, self.course.id) + self.assertEqual(result, expected) # noqa: PT009 + + def test_course_editor_can_edit_course_details(self): + """ + User with COURSE_EDITOR role can update course details. + COURSE_EDITOR does not have permission to edit schedule fields. + """ + + self.add_user_to_role_in_course( + self.authorized_user, + COURSE_EDITOR.external_key, + self.course.id + ) + + # Get the current status of the course details to use + # as the basis for the update request + response = self.authorized_client.get(self.url) + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 + current_course_details = response.json() + # This field is flagged as a details update because of a type mismatch: + # the GET response returns an invalid string, while the stored value has a different type. + # As a result, the equality check fails even though the values are logically the same. + current_course_details["certificates_display_behavior"] = "end" + + # Update the course details with new values, + # keeping schedule fields the same to ensure we are only + # testing edit details permission + current_course_details["title"] = "Updated Title" + + response = self.authorized_client.put( + path=self.url, + data=json.dumps(current_course_details), + content_type="application/json", + ) + + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 + + def test_course_staff_can_edit_course_schedule(self): + """ + User with COURSE_STAFF role can update course schedule. + Only COURSE_STAFF and COURSE_ADMIN can edit schedule related fields. + """ + self.add_user_to_role_in_course( + self.authorized_user, + COURSE_STAFF.external_key, + self.course.id + ) + + # Get the current status of the course details to use + # as the basis for the update request + response = self.authorized_client.get(self.url) + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 + current_course_details = response.json() + # This field is flagged as a details update because of a type mismatch: + # the GET response returns an invalid string, while the stored value has a different type. + # As a result, the equality check fails even though the values are logically the same. + current_course_details["certificates_display_behavior"] = "end" + + # Update the course details with new values, + # changing schedule fields to ensure we are only + # testing edit schedule permission + current_course_details["end_date"] = "2023-08-01T01:30:00Z" + + response = self.authorized_client.put( + path=self.url, + data=json.dumps(current_course_details), + content_type="application/json", + ) + + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 + + def test_course_editor_cannot_edit_course_schedule(self): + """ + User with COURSE_EDITOR role cannot update course schedule. + Only COURSE_STAFF and COURSE_ADMIN can edit schedule-related fields. + """ + self.add_user_to_role_in_course( + self.authorized_user, + COURSE_EDITOR.external_key, + self.course.id + ) + + # Get the current status of the course details to use + # as the basis for the update request + response = self.authorized_client.get(self.url) + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 + current_course_details = response.json() + # This field is flagged as a details update because of a type mismatch: + # the GET response returns an invalid string, while the stored value has a different type. + # As a result, the equality check fails even though the values are logically the same. + current_course_details["certificates_display_behavior"] = "end" + + # Update the course details with new values, + # changing schedule fields to ensure we are only + # testing edit schedule permission + current_course_details["end_date"] = "2023-08-01T01:30:00Z" + + response = self.authorized_client.put( + path=self.url, + data=json.dumps(current_course_details), + content_type="application/json", + ) + + self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN) # noqa: PT009 + + def test_course_staff_can_edit_course_schedule_and_details(self): + """ + User with COURSE_STAFF role can update course + schedule and details. + """ + self.add_user_to_role_in_course( + self.authorized_user, + COURSE_STAFF.external_key, + self.course.id + ) + + # Get the current status of the course details to use + # as the basis for the update request + response = self.authorized_client.get(self.url) + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 + current_course_details = response.json() + # This field is flagged as a details update because of a type mismatch: + # the GET response returns an invalid string, while the stored value has a different type. + # As a result, the equality check fails even though the values are logically the same. + current_course_details["certificates_display_behavior"] = "end" + + # Update the course details with new values, + # changing schedule and details fields to ensure user + # has permission to edit both + current_course_details["end_date"] = "2023-08-01T01:30:00Z" + current_course_details["title"] = "Updated Title" + + response = self.authorized_client.put( + path=self.url, + data=json.dumps(current_course_details), + content_type="application/json", + ) + + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 + + def test_course_editor_cannot_edit_course_schedule_and_details(self): + """ + User with COURSE_EDITOR role cannot update course + schedule or course details. + """ + self.add_user_to_role_in_course( + self.authorized_user, + COURSE_EDITOR.external_key, + self.course.id + ) + + # Get the current status of the course details to use + # as the basis for the update request + response = self.authorized_client.get(self.url) + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 + current_course_details = response.json() + # This field is flagged as a details update because of a type mismatch: + # the GET response returns an invalid string, while the stored value has a different type. + # As a result, the equality check fails even though the values are logically the same. + current_course_details["certificates_display_behavior"] = "end" + + # Update the course details with new values, + # changing schedule and details fields to ensure user + # has permission to edit both + current_course_details["end_date"] = "2023-08-01T01:30:00Z" + current_course_details["title"] = "Updated Title" + + response = self.authorized_client.put( + path=self.url, + data=json.dumps(current_course_details), + content_type="application/json", + ) + + self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN) # noqa: PT009 + + def test_unauthorized_user_cannot_edit_with_any_change_on_the_payload(self): + """ + An unauthorized user should receive 403 even if the payload contains + no changes that do not require edit permissions. + """ + self.add_user_to_role_in_course( + self.authorized_user, + COURSE_EDITOR.external_key, + self.course.id + ) + + # Get the current status of the course details to use + # as the basis for the update request + response = self.authorized_client.get(self.url) + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 + current_course_details = response.json() + # This field is flagged as a details update because of a type mismatch: + # the GET response returns an invalid string, while the stored value has a different type. + # As a result, the equality check fails even though the values are logically the same. + current_course_details["certificates_display_behavior"] = "end" + + # Update the course details with the same values. + response = self.unauthorized_client.put( + path=self.url, + data=json.dumps(current_course_details), + content_type="application/json", + ) + self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN) # noqa: PT009 + + def test_put_user_without_role_then_added_can_update(self): + """ + Validate dynamic role assignment works for PUT. + """ + # Initially unauthorized + response = self.unauthorized_client.put( + path=self.url, + data=json.dumps(self.request_data), + content_type="application/json", + ) + self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN) # noqa: PT009 + + # Assign role dynamically + self.add_user_to_role_in_course( + self.unauthorized_user, + COURSE_STAFF.external_key, + self.course.id + ) + + response = self.unauthorized_client.put( + path=self.url, + data=json.dumps(self.request_data), + content_type="application/json", + ) + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 + + @patch.dict("django.conf.settings.FEATURES", {"ENABLE_PREREQUISITE_COURSES": True}) + def test_put_invalid_pre_requisite_course_with_authz(self): + """ + Ensure validation still applies under AuthZ. + """ + self.add_user_to_role_in_course( + self.authorized_user, + COURSE_EDITOR.external_key, + self.course.id + ) + + pre_requisite_course_keys = [str(self.course.id), "invalid_key"] + request_data = {"pre_requisite_courses": pre_requisite_course_keys} + + response = self.authorized_client.put( + path=self.url, + data=json.dumps(request_data), + content_type="application/json", + ) + + self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST) # noqa: PT009 + self.assertEqual(response.json()["error"], "Invalid prerequisite course key") # noqa: PT009 + + def test_staff_user_can_update_without_authz_role(self): + """ + Django staff user should bypass AuthZ. + """ + response = self.staff_client.put( + path=self.url, + data=json.dumps(self.request_data), + content_type="application/json", + ) + + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 + + def test_superuser_can_update_without_authz_role(self): + """ + Superuser should bypass AuthZ. + """ + response = self.super_client.put( + path=self.url, + data=json.dumps(self.request_data), + content_type="application/json", + ) + + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 diff --git a/cms/djangoapps/contentstore/rest_api/v1/views/tests/test_course_index.py b/cms/djangoapps/contentstore/rest_api/v1/views/tests/test_course_index.py index 310d0ba80adc..e12c3f6e7770 100644 --- a/cms/djangoapps/contentstore/rest_api/v1/views/tests/test_course_index.py +++ b/cms/djangoapps/contentstore/rest_api/v1/views/tests/test_course_index.py @@ -4,9 +4,9 @@ from django.conf import settings from django.test import RequestFactory from django.urls import reverse -from rest_framework import status - from edx_toggles.toggles.testutils import override_waffle_flag +from openedx_authz.constants.roles import COURSE_EDITOR +from rest_framework import status from cms.djangoapps.contentstore.config.waffle import CUSTOM_RELATIVE_DATES from cms.djangoapps.contentstore.rest_api.v1.mixins import PermissionAccessMixin @@ -14,6 +14,7 @@ from cms.djangoapps.contentstore.utils import get_lms_link_for_item, get_pages_and_resources_url from cms.djangoapps.contentstore.views.course import _course_outline_json from common.djangoapps.student.tests.factories import UserFactory +from openedx.core.djangoapps.authz.tests.mixins import CourseAuthoringAuthzTestMixin from openedx.core.djangoapps.waffle_utils.testutils import WAFFLE_TABLES from xmodule.modulestore.tests.factories import BlockFactory, check_mongo_calls @@ -93,8 +94,8 @@ def test_course_index_response(self): 'created_on': None, } - self.assertEqual(response.status_code, status.HTTP_200_OK) - self.assertDictEqual(expected_response, response.data) + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 + self.assertDictEqual(expected_response, response.data) # noqa: PT009 @override_waffle_flag(CUSTOM_RELATIVE_DATES, active=False) def test_course_index_response_with_show_locators(self): @@ -144,14 +145,14 @@ def test_course_index_response_with_show_locators(self): 'created_on': None, } - self.assertEqual(response.status_code, status.HTTP_200_OK) - self.assertDictEqual(expected_response, response.data) + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 + self.assertDictEqual(expected_response, response.data) # noqa: PT009 def test_course_index_response_with_invalid_course(self): """Check error response for invalid course id""" response = self.client.get(self.url + "1") - self.assertEqual(response.status_code, status.HTTP_404_NOT_FOUND) - self.assertEqual(response.data, { + self.assertEqual(response.status_code, status.HTTP_404_NOT_FOUND) # noqa: PT009 + self.assertEqual(response.data, { # noqa: PT009 "developer_message": f"Unknown course {self.course.id}1", "error_code": "course_does_not_exist" }) @@ -163,3 +164,63 @@ def test_number_of_calls_to_db(self): with self.assertNumQueries(34, table_ignorelist=WAFFLE_TABLES): with check_mongo_calls(3): self.client.get(self.url) + + +class CourseIndexAuthzViewTest(CourseAuthoringAuthzTestMixin, CourseTestCase): + """ + Tests for CourseIndexView using AuthZ permissions. + """ + + def setUp(self): + super().setUp() + self.url = reverse( + "cms.djangoapps.contentstore:v1:course_index", + kwargs={"course_id": self.course.id}, + ) + + def test_authorized_user_can_access_course_index(self): + """Authorized user with COURSE_EDITOR role can access course index.""" + self.add_user_to_role_in_course( + self.authorized_user, + COURSE_EDITOR.external_key, + self.course.id + ) + + response = self.authorized_client.get(self.url) + + assert response.status_code == status.HTTP_200_OK + assert "course_structure" in response.data + + def test_unauthorized_user_cannot_access_course_index(self): + """Unauthorized user should receive 403.""" + response = self.unauthorized_client.get(self.url) + + assert response.status_code == status.HTTP_403_FORBIDDEN + + def test_user_without_role_then_added_can_access(self): + """Validate dynamic role assignment works as expected.""" + response = self.unauthorized_client.get(self.url) + assert response.status_code == status.HTTP_403_FORBIDDEN + + self.add_user_to_role_in_course( + self.unauthorized_user, + COURSE_EDITOR.external_key, + self.course.id + ) + + response = self.unauthorized_client.get(self.url) + assert response.status_code == status.HTTP_200_OK + + def test_staff_user_can_access_without_authz_role(self): + """Django staff user should access without AuthZ role.""" + response = self.staff_client.get(self.url) + + assert response.status_code == status.HTTP_200_OK + assert "course_structure" in response.data + + def test_superuser_can_access_without_authz_role(self): + """Superuser should access without AuthZ role.""" + response = self.super_client.get(self.url) + + assert response.status_code == status.HTTP_200_OK + assert "course_structure" in response.data diff --git a/cms/djangoapps/contentstore/rest_api/v1/views/tests/test_course_rerun.py b/cms/djangoapps/contentstore/rest_api/v1/views/tests/test_course_rerun.py index e25904ad465f..f0e970c41c7c 100644 --- a/cms/djangoapps/contentstore/rest_api/v1/views/tests/test_course_rerun.py +++ b/cms/djangoapps/contentstore/rest_api/v1/views/tests/test_course_rerun.py @@ -4,8 +4,8 @@ from django.urls import reverse from rest_framework import status -from cms.djangoapps.contentstore.tests.utils import CourseTestCase from cms.djangoapps.contentstore.rest_api.v1.mixins import PermissionAccessMixin +from cms.djangoapps.contentstore.tests.utils import CourseTestCase class CourseRerunViewTest(CourseTestCase, PermissionAccessMixin): @@ -32,5 +32,5 @@ def test_course_rerun_response(self): "run": self.course.id.run, } - self.assertEqual(response.status_code, status.HTTP_200_OK) - self.assertDictEqual(expected_response, response.data) + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 + self.assertDictEqual(expected_response, response.data) # noqa: PT009 diff --git a/cms/djangoapps/contentstore/rest_api/v1/views/tests/test_course_team.py b/cms/djangoapps/contentstore/rest_api/v1/views/tests/test_course_team.py index c0abca08196c..2fb46dd47ea9 100644 --- a/cms/djangoapps/contentstore/rest_api/v1/views/tests/test_course_team.py +++ b/cms/djangoapps/contentstore/rest_api/v1/views/tests/test_course_team.py @@ -5,9 +5,9 @@ from django.urls import reverse from rest_framework import status +from cms.djangoapps.contentstore.tests.utils import CourseTestCase from common.djangoapps.student.roles import CourseInstructorRole, CourseStaffRole from common.djangoapps.student.tests.factories import UserFactory -from cms.djangoapps.contentstore.tests.utils import CourseTestCase from ...mixins import PermissionAccessMixin @@ -65,8 +65,8 @@ def test_course_team_response(self): response = self.client.get(self.url) expected_response = self.get_expected_course_data() - self.assertEqual(response.status_code, status.HTTP_200_OK) - self.assertDictEqual(expected_response, response.data) + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 + self.assertDictEqual(expected_response, response.data) # noqa: PT009 def test_users_response(self): """Test the response for users in the course.""" @@ -74,5 +74,5 @@ def test_users_response(self): response = self.client.get(self.url) users_response = [dict(item) for item in response.data["users"]] expected_response = self.get_expected_course_data(instructor, staff) - self.assertEqual(response.status_code, status.HTTP_200_OK) - self.assertListEqual(expected_response["users"], users_response) + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 + self.assertListEqual(expected_response["users"], users_response) # noqa: PT009 diff --git a/cms/djangoapps/contentstore/rest_api/v1/views/tests/test_course_waffle_flags.py b/cms/djangoapps/contentstore/rest_api/v1/views/tests/test_course_waffle_flags.py index f45cc48810d6..39783e191da4 100644 --- a/cms/djangoapps/contentstore/rest_api/v1/views/tests/test_course_waffle_flags.py +++ b/cms/djangoapps/contentstore/rest_api/v1/views/tests/test_course_waffle_flags.py @@ -35,9 +35,11 @@ class CourseWaffleFlagsViewTest(CourseTestCase): "use_new_unit_page": True, "use_new_updates_page": True, "use_new_video_uploads_page": False, + "use_new_pdf_editor": True, "use_react_markdown_editor": False, "use_video_gallery_flow": False, "enable_course_optimizer_check_prev_run_links": False, + "enable_authz_course_authoring": False, } def setUp(self): diff --git a/cms/djangoapps/contentstore/rest_api/v1/views/tests/test_grading.py b/cms/djangoapps/contentstore/rest_api/v1/views/tests/test_grading.py index 6123096048df..bc7bd17e1757 100644 --- a/cms/djangoapps/contentstore/rest_api/v1/views/tests/test_grading.py +++ b/cms/djangoapps/contentstore/rest_api/v1/views/tests/test_grading.py @@ -6,11 +6,16 @@ import ddt from django.urls import reverse +from openedx_authz.constants.roles import COURSE_DATA_RESEARCHER, COURSE_STAFF from rest_framework import status +from rest_framework.test import APIClient +from cms.djangoapps.contentstore.api.tests.base import BaseCourseViewTest from cms.djangoapps.contentstore.tests.utils import CourseTestCase from cms.djangoapps.contentstore.utils import get_proctored_exam_settings_url from cms.djangoapps.models.settings.course_grading import CourseGradingModel +from common.djangoapps.student.tests.factories import UserFactory +from openedx.core.djangoapps.authz.tests.mixins import CourseAuthzTestMixin from openedx.core.djangoapps.credit.tests.factories import CreditCourseFactory from ...mixins import PermissionAccessMixin @@ -45,8 +50,8 @@ def test_course_grading_response(self): "default_grade_designations": ['A', 'B', 'C', 'D'], } - self.assertEqual(response.status_code, status.HTTP_200_OK) - self.assertDictEqual(expected_response, response.data) + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 + self.assertDictEqual(expected_response, response.data) # noqa: PT009 @patch("django.conf.settings.DEFAULT_GRADE_DESIGNATIONS", ['A', 'B']) def test_default_grade_designations_setting(self): @@ -55,8 +60,8 @@ def test_default_grade_designations_setting(self): """ response = self.client.get(self.url) - self.assertEqual(response.status_code, status.HTTP_200_OK) - self.assertEqual(['A', 'B'], response.data["default_grade_designations"]) + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 + self.assertEqual(['A', 'B'], response.data["default_grade_designations"]) # noqa: PT009 @patch.dict("django.conf.settings.FEATURES", {"ENABLE_CREDIT_ELIGIBILITY": True}) def test_credit_eligibility_setting(self): @@ -65,9 +70,9 @@ def test_credit_eligibility_setting(self): """ _ = CreditCourseFactory(course_key=self.course.id, enabled=True) response = self.client.get(self.url) - self.assertEqual(response.status_code, status.HTTP_200_OK) - self.assertTrue(response.data["show_credit_eligibility"]) - self.assertTrue(response.data["is_credit_course"]) + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 + self.assertTrue(response.data["show_credit_eligibility"]) # noqa: PT009 + self.assertTrue(response.data["is_credit_course"]) # noqa: PT009 def test_post_permissions_unauthenticated(self): """ @@ -76,8 +81,8 @@ def test_post_permissions_unauthenticated(self): self.client.logout() response = self.client.post(self.url) error = self.get_and_check_developer_response(response) - self.assertEqual(error, "Authentication credentials were not provided.") - self.assertEqual(response.status_code, status.HTTP_401_UNAUTHORIZED) + self.assertEqual(error, "Authentication credentials were not provided.") # noqa: PT009 + self.assertEqual(response.status_code, status.HTTP_401_UNAUTHORIZED) # noqa: PT009 def test_post_permissions_unauthorized(self): """ @@ -86,8 +91,8 @@ def test_post_permissions_unauthorized(self): client, _ = self.create_non_staff_authed_user_client() response = client.post(self.url) error = self.get_and_check_developer_response(response) - self.assertEqual(error, "You do not have permission to perform this action.") - self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN) + self.assertEqual(error, "You do not have permission to perform this action.") # noqa: PT009 + self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN) # noqa: PT009 @patch( "openedx.core.djangoapps.credit.tasks.update_credit_course_requirements.delay" @@ -115,5 +120,151 @@ def test_post_course_grading(self, mock_update_credit_course_requirements): data=json.dumps(request_data), content_type="application/json", ) - self.assertEqual(response.status_code, status.HTTP_200_OK) + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 mock_update_credit_course_requirements.assert_called_once() + + +class CourseGradingViewAuthzTest(CourseAuthzTestMixin, BaseCourseViewTest): + """ + Tests Course Grading Configuration API authorization using openedx-authz. + The endpoint uses COURSES_VIEW_GRADING_SETTINGS and COURSES_EDIT_GRADING_SETTINGS permissions. + """ + + view_name = "cms.djangoapps.contentstore:v1:course_grading" + authz_roles_to_assign = [COURSE_STAFF.external_key] + post_data = json.dumps({ + "graders": [{ + "type": "Homework", + "min_count": 1, + "drop_count": 0, + "short_label": "", + "weight": 100, + "id": 0 + }], + "grade_cutoffs": {"A": 0.75, "B": 0.63, "C": 0.57, "D": 0.5}, + "grace_period": {"hours": 12, "minutes": 0}, + "minimum_grade_credit": 0.7, + "is_credit_course": False, + }) + + def test_authorized_user_can_access_get(self): + """User with COURSE_STAFF role can access.""" + resp = self.authorized_client.get(self.get_url(self.course_key)) + self.assertEqual(resp.status_code, status.HTTP_200_OK) # noqa: PT009 + + def test_unauthorized_user_cannot_access_get(self): + """User without role cannot access.""" + resp = self.unauthorized_client.get(self.get_url(self.course_key)) + self.assertEqual(resp.status_code, status.HTTP_403_FORBIDDEN) # noqa: PT009 + + def test_role_scoped_to_course_get(self): + """Authorization should only apply to the assigned course.""" + other_course = self.store.create_course("OtherOrg", "OtherCourse", "Run", self.staff.id) + + resp = self.authorized_client.get(self.get_url(other_course.id)) + self.assertEqual(resp.status_code, status.HTTP_403_FORBIDDEN) # noqa: PT009 + + def test_staff_user_allowed_via_legacy_get(self): + """ + Staff users should still pass through legacy fallback. + """ + self.client.login(username=self.staff.username, password=self.password) + + resp = self.client.get(self.get_url(self.course_key)) + self.assertEqual(resp.status_code, status.HTTP_200_OK) # noqa: PT009 + + def test_superuser_allowed_get(self): + """Superusers should always be allowed.""" + superuser = UserFactory(is_superuser=True) + + client = APIClient() + client.force_authenticate(user=superuser) + + resp = client.get(self.get_url(self.course_key)) + self.assertEqual(resp.status_code, status.HTTP_200_OK) # noqa: PT009 + + def test_non_staff_user_cannot_access_get(self): + """ + User without required permissions should be denied. + This case validates that a non-staff user doesn't get access. + """ + non_staff_user = UserFactory() + non_staff_client = APIClient() + self.add_user_to_role(non_staff_user, COURSE_DATA_RESEARCHER.external_key) + non_staff_client.force_authenticate(user=non_staff_user) + + resp = non_staff_client.get(self.get_url(self.course_key)) + self.assertEqual(resp.status_code, status.HTTP_403_FORBIDDEN) # noqa: PT009 + + def test_authorized_user_can_access_post(self): + """User with COURSE_STAFF role can access.""" + resp = self.authorized_client.post( + self.get_url(self.course_key), + data=self.post_data, + content_type="application/json" + ) + self.assertEqual(resp.status_code, status.HTTP_200_OK) # noqa: PT009 + + def test_unauthorized_user_cannot_access_post(self): + """User without role cannot access.""" + resp = self.unauthorized_client.post( + self.get_url(self.course_key), + data=self.post_data, + content_type="application/json" + ) + self.assertEqual(resp.status_code, status.HTTP_403_FORBIDDEN) # noqa: PT009 + + def test_role_scoped_to_course_post(self): + """Authorization should only apply to the assigned course.""" + other_course = self.store.create_course("OtherOrg", "OtherCourse", "Run", self.staff.id) + + resp = self.authorized_client.post( + self.get_url(other_course.id), + data=self.post_data, + content_type="application/json" + ) + self.assertEqual(resp.status_code, status.HTTP_403_FORBIDDEN) # noqa: PT009 + + def test_staff_user_allowed_via_legacy_post(self): + """ + Staff users should still pass through legacy fallback. + """ + self.client.login(username=self.staff.username, password=self.password) + + resp = self.client.post( + self.get_url(self.course_key), + data=self.post_data, + content_type="application/json" + ) + self.assertEqual(resp.status_code, status.HTTP_200_OK) # noqa: PT009 + + def test_superuser_allowed_post(self): + """Superusers should always be allowed.""" + superuser = UserFactory(is_superuser=True) + + client = APIClient() + client.force_authenticate(user=superuser) + + resp = client.post( + self.get_url(self.course_key), + data=self.post_data, + content_type="application/json" + ) + self.assertEqual(resp.status_code, status.HTTP_200_OK) # noqa: PT009 + + def test_non_staff_user_cannot_access_post(self): + """ + User without required permissions should be denied. + This case validates that a non-staff user doesn't get access. + """ + non_staff_user = UserFactory() + non_staff_client = APIClient() + self.add_user_to_role(non_staff_user, COURSE_DATA_RESEARCHER.external_key) + non_staff_client.force_authenticate(user=non_staff_user) + + resp = non_staff_client.post( + self.get_url(self.course_key), + data=self.post_data, + content_type="application/json" + ) + self.assertEqual(resp.status_code, status.HTTP_403_FORBIDDEN) # noqa: PT009 diff --git a/cms/djangoapps/contentstore/rest_api/v1/views/tests/test_group_configurations.py b/cms/djangoapps/contentstore/rest_api/v1/views/tests/test_group_configurations.py index 1cc548378301..3db602dc42f3 100644 --- a/cms/djangoapps/contentstore/rest_api/v1/views/tests/test_group_configurations.py +++ b/cms/djangoapps/contentstore/rest_api/v1/views/tests/test_group_configurations.py @@ -2,16 +2,16 @@ Unit tests for the course's setting group configuration. """ from django.urls import reverse +from openedx_authz.constants.roles import COURSE_DATA_RESEARCHER, COURSE_STAFF from rest_framework import status +from rest_framework.test import APIClient -from cms.djangoapps.contentstore.course_group_config import ( - CONTENT_GROUP_CONFIGURATION_NAME, -) +from cms.djangoapps.contentstore.api.tests.base import BaseCourseViewTest +from cms.djangoapps.contentstore.course_group_config import CONTENT_GROUP_CONFIGURATION_NAME from cms.djangoapps.contentstore.tests.utils import CourseTestCase -from xmodule.partitions.partitions import ( - Group, - UserPartition, -) # lint-amnesty, pylint: disable=wrong-import-order +from common.djangoapps.student.tests.factories import UserFactory +from openedx.core.djangoapps.authz.tests.mixins import CourseAuthzTestMixin +from xmodule.partitions.partitions import Group, UserPartition # pylint: disable=wrong-import-order from ...mixins import PermissionAccessMixin @@ -38,7 +38,7 @@ def test_success_response(self): "First name", "First description", [Group(0, "Group A"), Group(1, "Group B"), Group(2, "Group C")], - ), # lint-amnesty, pylint: disable=line-too-long + ), # pylint: disable=line-too-long ] self.save_course() @@ -47,9 +47,67 @@ def test_success_response(self): self.store.update_item(self.course, self.user.id) response = self.client.get(self.url) - self.assertEqual(len(response.data["all_group_configurations"]), 1) - self.assertEqual(len(response.data["experiment_group_configurations"]), 1) + self.assertEqual(len(response.data["all_group_configurations"]), 1) # noqa: PT009 + self.assertEqual(len(response.data["experiment_group_configurations"]), 1) # noqa: PT009 self.assertContains(response, "First name", count=1) self.assertContains(response, "Group C") self.assertContains(response, CONTENT_GROUP_CONFIGURATION_NAME) - self.assertEqual(response.status_code, status.HTTP_200_OK) + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 + +class CourseGroupConfigurationsAuthzTest(CourseAuthzTestMixin, BaseCourseViewTest): + """ + Tests Course Group Configuration API authorization using openedx-authz. + The endpoint uses COURSES_MANAGE_GROUP_CONFIGURATIONS permission. + """ + + view_name = "cms.djangoapps.contentstore:v1:group_configurations" + authz_roles_to_assign = [COURSE_STAFF.external_key] + + def test_authorized_user_can_access(self): + """User with COURSE_STAFF role can access.""" + resp = self.authorized_client.get(self.get_url(self.course_key)) + self.assertEqual(resp.status_code, status.HTTP_200_OK) # noqa: PT009 + + def test_unauthorized_user_cannot_access(self): + """User without role cannot access.""" + resp = self.unauthorized_client.get(self.get_url(self.course_key)) + self.assertEqual(resp.status_code, status.HTTP_403_FORBIDDEN) # noqa: PT009 + + def test_role_scoped_to_course(self): + """Authorization should only apply to the assigned course.""" + other_course = self.store.create_course("OtherOrg", "OtherCourse", "Run", self.staff.id) + + resp = self.authorized_client.get(self.get_url(other_course.id)) + self.assertEqual(resp.status_code, status.HTTP_403_FORBIDDEN) # noqa: PT009 + + def test_staff_user_allowed_via_legacy(self): + """ + Staff users should still pass through legacy fallback. + """ + self.client.login(username=self.staff.username, password=self.password) + + resp = self.client.get(self.get_url(self.course_key)) + self.assertEqual(resp.status_code, status.HTTP_200_OK) # noqa: PT009 + + def test_superuser_allowed(self): + """Superusers should always be allowed.""" + superuser = UserFactory(is_superuser=True) + + client = APIClient() + client.force_authenticate(user=superuser) + + resp = client.get(self.get_url(self.course_key)) + self.assertEqual(resp.status_code, status.HTTP_200_OK) # noqa: PT009 + + def test_non_staff_user_cannot_access(self): + """ + User without required permissions should be denied. + This case validates that a non-staff user doesn't get access. + """ + non_staff_user = UserFactory() + non_staff_client = APIClient() + self.add_user_to_role(non_staff_user, COURSE_DATA_RESEARCHER.external_key) + non_staff_client.force_authenticate(user=non_staff_user) + + resp = non_staff_client.get(self.get_url(self.course_key)) + self.assertEqual(resp.status_code, status.HTTP_403_FORBIDDEN) # noqa: PT009 diff --git a/cms/djangoapps/contentstore/rest_api/v1/views/tests/test_home.py b/cms/djangoapps/contentstore/rest_api/v1/views/tests/test_home.py index 72d58fa00dfa..ccdd906609a4 100644 --- a/cms/djangoapps/contentstore/rest_api/v1/views/tests/test_home.py +++ b/cms/djangoapps/contentstore/rest_api/v1/views/tests/test_home.py @@ -10,7 +10,7 @@ from django.test import override_settings from django.urls import reverse from opaque_keys.edx.locator import LibraryLocatorV2 -from openedx_learning.api import authoring as authoring_api +from openedx_content import api as content_api from organizations.tests.factories import OrganizationFactory from rest_framework import status @@ -66,8 +66,8 @@ def test_home_page_studio_response(self): """Check successful response content""" response = self.client.get(self.url) - self.assertEqual(response.status_code, status.HTTP_200_OK) - self.assertDictEqual(self.expected_response, response.data) + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 + self.assertDictEqual(self.expected_response, response.data) # noqa: PT009 @override_settings(MEILISEARCH_ENABLED=True) def test_home_page_studio_with_meilisearch_enabled(self): @@ -77,8 +77,8 @@ def test_home_page_studio_with_meilisearch_enabled(self): expected_response = self.expected_response expected_response["libraries_v2_enabled"] = True - self.assertEqual(response.status_code, status.HTTP_200_OK) - self.assertDictEqual(expected_response, response.data) + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 + self.assertDictEqual(expected_response, response.data) # noqa: PT009 @override_settings(ORGANIZATIONS_AUTOCREATE=False) def test_home_page_studio_with_org_autocreate_disabled(self): @@ -88,13 +88,13 @@ def test_home_page_studio_with_org_autocreate_disabled(self): expected_response = self.expected_response expected_response["allow_to_create_new_org"] = False - self.assertEqual(response.status_code, status.HTTP_200_OK) - self.assertDictEqual(expected_response, response.data) + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 + self.assertDictEqual(expected_response, response.data) # noqa: PT009 def test_taxonomy_list_link(self): response = self.client.get(self.url) - self.assertTrue(response.data['taxonomies_enabled']) - self.assertEqual( + self.assertTrue(response.data['taxonomies_enabled']) # noqa: PT009 + self.assertEqual( # noqa: PT009 response.data['taxonomy_list_mfe_url'], f'{settings.COURSE_AUTHORING_MICROFRONTEND_URL}/taxonomies' ) @@ -137,8 +137,8 @@ def test_home_page_response(self): "in_process_course_actions": [], } - self.assertEqual(response.status_code, status.HTTP_200_OK) - self.assertDictEqual(expected_response, response.data) + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 + self.assertDictEqual(expected_response, response.data) # noqa: PT009 def test_home_page_response_with_api_v2(self): """Check successful response content with api v2 modifications. @@ -166,8 +166,8 @@ def test_home_page_response_with_api_v2(self): response = self.client.get(self.url) - self.assertEqual(response.status_code, status.HTTP_200_OK) - self.assertDictEqual(expected_response, response.data) + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 + self.assertDictEqual(expected_response, response.data) # noqa: PT009 @ddt.data( ("active_only", "true", 2, 0), @@ -207,9 +207,9 @@ def test_filter_and_ordering_courses( response = self.client.get(self.url, {filter_key: filter_value}) - self.assertEqual(response.status_code, status.HTTP_200_OK) - self.assertEqual(len(response.data["archived_courses"]), expected_archived_length) - self.assertEqual(len(response.data["courses"]), expected_active_length) + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 + self.assertEqual(len(response.data["archived_courses"]), expected_archived_length) # noqa: PT009 + self.assertEqual(len(response.data["courses"]), expected_active_length) # noqa: PT009 @ddt.data( ("active_only", "true"), @@ -224,8 +224,8 @@ def test_filter_and_ordering_no_courses_staff(self, filter_key, filter_value): response = self.client.get(self.url, {filter_key: filter_value}) - self.assertEqual(len(response.data["courses"]), 0) - self.assertEqual(response.status_code, status.HTTP_200_OK) + self.assertEqual(len(response.data["courses"]), 0) # noqa: PT009 + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 @ddt.data( ("active_only", "true"), @@ -240,8 +240,8 @@ def test_home_page_response_no_courses_non_staff(self, filter_key, filter_value) response = self.non_staff_client.get(self.url, {filter_key: filter_value}) - self.assertEqual(len(response.data["courses"]), 0) - self.assertEqual(response.status_code, status.HTTP_200_OK) + self.assertEqual(len(response.data["courses"]), 0) # noqa: PT009 + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 @ddt.ddt @@ -272,9 +272,9 @@ def setUp(self): self.url = reverse("cms.djangoapps.contentstore:v1:libraries") # Create a collection to migrate this library to collection_key = "test-collection" - authoring_api.create_collection( + content_api.create_collection( learning_package_id=learning_package.id, - key=collection_key, + collection_code=collection_key, title="Test Collection", created_by=self.user.id, ) @@ -329,7 +329,7 @@ def test_home_page_libraries_response(self): 'can_edit': True, 'is_migrated': True, 'migrated_to_title': 'Test Library', - 'migrated_to_key': 'lib:name0:test-key', + 'migrated_to_key': str(self.lib_key_v2), 'migrated_to_collection_key': 'test-collection', 'migrated_to_collection_title': 'Test Collection', }, @@ -347,8 +347,8 @@ def test_home_page_libraries_response(self): ] } - self.assertEqual(response.status_code, status.HTTP_200_OK) - self.assertDictEqual(expected_response, response.json()) + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 + self.assertDictEqual(expected_response, response.json()) # noqa: PT009 # Fetch legacy libraries that were migrated to v2 response = self.client.get(self.url + '?is_migrated=true') @@ -364,15 +364,15 @@ def test_home_page_libraries_response(self): 'can_edit': True, 'is_migrated': True, 'migrated_to_title': 'Test Library', - 'migrated_to_key': 'lib:name0:test-key', + 'migrated_to_key': str(self.lib_key_v2), 'migrated_to_collection_key': 'test-collection', 'migrated_to_collection_title': 'Test Collection', } ], } - self.assertEqual(response.status_code, status.HTTP_200_OK) - self.assertDictEqual(expected_response, response.json()) + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 + self.assertDictEqual(expected_response, response.json()) # noqa: PT009 # Fetch legacy libraries that were not migrated to v2 response = self.client.get(self.url + '?is_migrated=false') @@ -400,5 +400,5 @@ def test_home_page_libraries_response(self): ], } - self.assertEqual(response.status_code, status.HTTP_200_OK) - self.assertDictEqual(expected_response, response.json()) + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 + self.assertDictEqual(expected_response, response.json()) # noqa: PT009 diff --git a/cms/djangoapps/contentstore/rest_api/v1/views/tests/test_proctoring.py b/cms/djangoapps/contentstore/rest_api/v1/views/tests/test_proctoring.py index 9eabf03f1b41..6d84fad453d0 100644 --- a/cms/djangoapps/contentstore/rest_api/v1/views/tests/test_proctoring.py +++ b/cms/djangoapps/contentstore/rest_api/v1/views/tests/test_proctoring.py @@ -13,13 +13,13 @@ from cms.djangoapps.contentstore.tests.test_utils import AuthorizeStaffTestCase from cms.djangoapps.contentstore.tests.utils import CourseTestCase +from openedx.core import toggles as core_toggles from openedx.core.djangoapps.course_apps.toggles import EXAMS_IDA -from xmodule.modulestore.django import ( - modulestore, -) # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.django_utils import ( +from xmodule.course_metadata_utils import DEFAULT_START_DATE +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( # pylint: disable=wrong-import-order ModuleStoreTestCase, -) # lint-amnesty, pylint: disable=wrong-import-order +) from ...mixins import PermissionAccessMixin @@ -60,7 +60,7 @@ def get_expected_response_data( "proctoring_escalation_email": course.proctoring_escalation_email, "create_zendesk_tickets": course.create_zendesk_tickets, }, - "course_start_date": "2030-01-01T00:00:00Z", + "course_start_date": DEFAULT_START_DATE.strftime('%Y-%m-%dT%H:%M:%SZ'), "available_proctoring_providers": ["null"], "requires_escalation_email_providers": [], } @@ -99,7 +99,7 @@ def test_providers_with_disabled_lti(self): "proctoring_escalation_email": self.course.proctoring_escalation_email, "create_zendesk_tickets": self.course.create_zendesk_tickets, }, - "course_start_date": "2030-01-01T00:00:00Z", + "course_start_date": DEFAULT_START_DATE.strftime('%Y-%m-%dT%H:%M:%SZ'), "available_proctoring_providers": ["null"], "requires_escalation_email_providers": [], } @@ -122,7 +122,7 @@ def test_providers_with_enabled_lti(self): "proctoring_escalation_email": self.course.proctoring_escalation_email, "create_zendesk_tickets": self.course.create_zendesk_tickets, }, - "course_start_date": "2030-01-01T00:00:00Z", + "course_start_date": DEFAULT_START_DATE.strftime('%Y-%m-%dT%H:%M:%SZ'), "available_proctoring_providers": ["lti_external", "null"], "requires_escalation_email_providers": ["lti_external"], } @@ -182,7 +182,7 @@ def test_update_exam_settings_200_escalation_email(self): # response is correct assert response.status_code == status.HTTP_200_OK - self.assertDictEqual( + self.assertDictEqual( # noqa: PT009 response.data, { "proctored_exam_settings": { @@ -219,7 +219,7 @@ def test_update_exam_settings_200_no_escalation_email(self): # response is correct assert response.status_code == status.HTTP_200_OK - self.assertDictEqual( + self.assertDictEqual( # noqa: PT009 response.data, { "proctored_exam_settings": { @@ -250,7 +250,7 @@ def test_update_exam_settings_excluded_field(self): # response is correct assert response.status_code == status.HTTP_200_OK - self.assertDictEqual( + self.assertDictEqual( # noqa: PT009 response.data, { "proctored_exam_settings": { @@ -283,7 +283,7 @@ def test_update_exam_settings_invalid_value(self): # response is correct assert response.status_code == status.HTTP_400_BAD_REQUEST - self.assertIn( + self.assertIn( # noqa: PT009 { "proctoring_provider": ( "The selected proctoring provider, notvalidprovider, is not a valid provider. " @@ -350,7 +350,7 @@ def test_nonadmin_with_zendesk_ticket( assert response.status_code == status.HTTP_200_OK if expect_log: logger_string = ( - "create_zendesk_tickets set to {ticket_value} but proctoring " + "create_zendesk_tickets set to {ticket_value} but proctoring " # noqa: UP032 "provider is {provider} for course {course_id}. create_zendesk_tickets " "should be updated for this course.".format( ticket_value=create_zendesk_tickets, @@ -378,7 +378,7 @@ def test_200_for_lti_provider(self): # response is correct assert response.status_code == status.HTTP_200_OK - self.assertDictEqual( + self.assertDictEqual( # noqa: PT009 response.data, { "proctored_exam_settings": { @@ -410,7 +410,7 @@ def test_400_for_disabled_lti(self): # response is correct assert response.status_code == status.HTTP_400_BAD_REQUEST - self.assertIn( + self.assertIn( # noqa: PT009 { "proctoring_provider": ( "The selected proctoring provider, lti_external, is not a valid provider. " @@ -450,6 +450,42 @@ def test_disable_advanced_settings_feature(self, disable_advanced_settings): FEATURES={"DISABLE_ADVANCED_SETTINGS": disable_advanced_settings} ): response = self.non_staff_client.get(self.url) - self.assertEqual( + self.assertEqual( # noqa: PT009 response.status_code, 403 if disable_advanced_settings else 200 ) + + @patch.object(core_toggles.AUTHZ_COURSE_AUTHORING_FLAG, 'is_enabled', return_value=True) + @patch('common.djangoapps.student.auth.authz_api.is_user_allowed') + def test_authz_user_allowed(self, mock_is_user_allowed, mock_flag): + """User with authz permission can access proctoring errors.""" + mock_is_user_allowed.return_value = True + response = self.non_staff_client.get(self.url) + self.assertEqual(response.status_code, 200) # noqa: PT009 + mock_is_user_allowed.assert_called_once() + + @patch.object(core_toggles.AUTHZ_COURSE_AUTHORING_FLAG, 'is_enabled', return_value=True) + @patch('common.djangoapps.student.auth.authz_api.is_user_allowed') + def test_authz_user_not_allowed(self, mock_is_user_allowed, mock_flag): + """User without authz permission cannot access proctoring errors.""" + mock_is_user_allowed.return_value = False + response = self.non_staff_client.get(self.url) + self.assertEqual(response.status_code, 403) # noqa: PT009 + mock_is_user_allowed.assert_called_once() + + @patch.object(core_toggles.AUTHZ_COURSE_AUTHORING_FLAG, 'is_enabled', return_value=True) + @patch('common.djangoapps.student.auth.authz_api.is_user_allowed') + def test_authz_with_disable_advanced_settings_staff_allowed(self, mock_is_user_allowed, mock_flag): + """Staff user can access when DISABLE_ADVANCED_SETTINGS is enabled, bypassing authz.""" + with override_settings(FEATURES={"DISABLE_ADVANCED_SETTINGS": True}): + response = self.client.get(self.url) + self.assertEqual(response.status_code, 200) # noqa: PT009 + mock_is_user_allowed.assert_not_called() + + @patch.object(core_toggles.AUTHZ_COURSE_AUTHORING_FLAG, 'is_enabled', return_value=True) + @patch('common.djangoapps.student.auth.authz_api.is_user_allowed') + def test_authz_with_disable_advanced_settings_non_staff_denied(self, mock_is_user_allowed, mock_flag): + """Non-staff user is denied when DISABLE_ADVANCED_SETTINGS is enabled, bypassing authz.""" + with override_settings(FEATURES={"DISABLE_ADVANCED_SETTINGS": True}): + response = self.non_staff_client.get(self.url) + self.assertEqual(response.status_code, 403) # noqa: PT009 + mock_is_user_allowed.assert_not_called() diff --git a/cms/djangoapps/contentstore/rest_api/v1/views/tests/test_settings.py b/cms/djangoapps/contentstore/rest_api/v1/views/tests/test_settings.py index 15b0992fdf1a..83ee03294790 100644 --- a/cms/djangoapps/contentstore/rest_api/v1/views/tests/test_settings.py +++ b/cms/djangoapps/contentstore/rest_api/v1/views/tests/test_settings.py @@ -6,11 +6,13 @@ import ddt from django.conf import settings from django.urls import reverse +from openedx_authz.constants.roles import COURSE_EDITOR from rest_framework import status from cms.djangoapps.contentstore.tests.utils import CourseTestCase from cms.djangoapps.contentstore.utils import get_proctored_exam_settings_url from common.djangoapps.util.course import get_link_for_about_page +from openedx.core.djangoapps.authz.tests.mixins import CourseAuthoringAuthzTestMixin from openedx.core.djangoapps.credit.tests.factories import CreditCourseFactory from ...mixins import PermissionAccessMixin @@ -57,8 +59,8 @@ def test_course_settings_response(self): "licensing_enabled": False, } - self.assertEqual(response.status_code, status.HTTP_200_OK) - self.assertDictEqual(expected_response, response.data) + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 + self.assertDictEqual(expected_response, response.data) # noqa: PT009 @patch.dict("django.conf.settings.FEATURES", {"ENABLE_CREDIT_ELIGIBILITY": True}) def test_credit_eligibility_setting(self): @@ -67,9 +69,9 @@ def test_credit_eligibility_setting(self): """ _ = CreditCourseFactory(course_key=self.course.id, enabled=True) response = self.client.get(self.url) - self.assertEqual(response.status_code, status.HTTP_200_OK) - self.assertIn("credit_requirements", response.data) - self.assertTrue(response.data["is_credit_course"]) + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 + self.assertIn("credit_requirements", response.data) # noqa: PT009 + self.assertTrue(response.data["is_credit_course"]) # noqa: PT009 @patch.dict( "django.conf.settings.FEATURES", @@ -83,5 +85,80 @@ def test_prerequisite_courses_enabled_setting(self): Make sure if the feature flags are enabled we have updated the dict keys in response. """ response = self.client.get(self.url) - self.assertIn("possible_pre_requisite_courses", response.data) - self.assertEqual(response.status_code, status.HTTP_200_OK) + self.assertIn("possible_pre_requisite_courses", response.data) # noqa: PT009 + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 + + +@ddt.ddt +class CourseSettingsAuthzViewTest(CourseAuthoringAuthzTestMixin, CourseTestCase): + """ + Tests for CourseSettingsView using AuthZ permissions. + """ + + def setUp(self): + super().setUp() + self.url = reverse( + "cms.djangoapps.contentstore:v1:course_settings", + kwargs={"course_id": self.course.id}, + ) + + def test_authorized_user_can_access_course_settings(self): + """Authorized user with COURSE_EDITOR role can access course settings.""" + self.add_user_to_role_in_course(self.authorized_user, COURSE_EDITOR.external_key, self.course.id) + response = self.authorized_client.get(self.url) + + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 + self.assertIn("course_display_name", response.data) # noqa: PT009 + + def test_unauthorized_user_cannot_access_course_settings(self): + """Unauthorized user should receive 403.""" + response = self.unauthorized_client.get(self.url) + + self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN) # noqa: PT009 + + def test_user_without_role_then_added_can_access(self): + """ + Validate dynamic role assignment works as expected. + """ + # Initially unauthorized + response = self.unauthorized_client.get(self.url) + self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN) # noqa: PT009 + + # Assign role dynamically + self.add_user_to_role_in_course( + self.unauthorized_user, + COURSE_EDITOR.external_key, + self.course.id + ) + + response = self.unauthorized_client.get(self.url) + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 + + @patch.dict("django.conf.settings.FEATURES", {"ENABLE_CREDIT_ELIGIBILITY": True}) + def test_credit_eligibility_setting_with_authz(self): + """ + Ensure feature flags still affect response under AuthZ. + """ + _ = CreditCourseFactory(course_key=self.course.id, enabled=True) + + self.add_user_to_role_in_course(self.authorized_user, COURSE_EDITOR.external_key, self.course.id) + response = self.authorized_client.get(self.url) + + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 + self.assertIn("credit_requirements", response.data) # noqa: PT009 + self.assertTrue(response.data["is_credit_course"]) # noqa: PT009 + + def test_staff_user_can_access_without_authz_role(self): + """Django staff user should access course settings without AuthZ role.""" + + response = self.staff_client.get(self.url) + + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 + self.assertIn("course_display_name", response.data) # noqa: PT009 + + def test_superuser_can_access_without_authz_role(self): + """Superuser should access course settings without AuthZ role.""" + response = self.super_client.get(self.url) + + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 + self.assertIn("course_display_name", response.data) # noqa: PT009 diff --git a/cms/djangoapps/contentstore/rest_api/v1/views/tests/test_textbooks.py b/cms/djangoapps/contentstore/rest_api/v1/views/tests/test_textbooks.py index d4dd80f8ab05..26ec42f839a3 100644 --- a/cms/djangoapps/contentstore/rest_api/v1/views/tests/test_textbooks.py +++ b/cms/djangoapps/contentstore/rest_api/v1/views/tests/test_textbooks.py @@ -2,9 +2,12 @@ Unit tests for the course's textbooks. """ from django.urls import reverse -from rest_framework import status +from openedx_authz.constants.roles import COURSE_AUDITOR, COURSE_LIMITED_STAFF, COURSE_STAFF +from rest_framework.test import APIClient from cms.djangoapps.contentstore.tests.utils import CourseTestCase +from common.djangoapps.student.tests.factories import UserFactory +from openedx.core.djangoapps.authz.tests.mixins import CourseAuthoringAuthzTestMixin from ...mixins import PermissionAccessMixin @@ -39,5 +42,44 @@ def test_success_response(self): self.save_course() response = self.client.get(self.url) - self.assertEqual(response.status_code, status.HTTP_200_OK) - self.assertEqual(response.data["textbooks"], expected_textbook) + self.assertEqual(response.status_code, 200) # noqa: PT009 + self.assertEqual(response.data["textbooks"], expected_textbook) # noqa: PT009 + + +class CourseTextbooksAuthzTest(CourseAuthoringAuthzTestMixin, CourseTestCase): + """ + Integration tests for CourseTextbooksView authz permissions. + """ + + def setUp(self): + super().setUp() + self.url = reverse( + "cms.djangoapps.contentstore:v1:textbooks", + kwargs={"course_id": self.course.id}, + ) + + def test_staff_can_view_textbooks(self): + self.add_user_to_role_in_course(self.authorized_user, COURSE_STAFF.external_key, self.course.id) + resp = self.authorized_client.get(self.url) + assert resp.status_code == 200 + + def test_auditor_can_view_textbooks(self): + self.add_user_to_role_in_course(self.authorized_user, COURSE_AUDITOR.external_key, self.course.id) + resp = self.authorized_client.get(self.url) + assert resp.status_code == 200 + + def test_limited_staff_cannot_view_textbooks(self): + self.add_user_to_role_in_course(self.authorized_user, COURSE_LIMITED_STAFF.external_key, self.course.id) + resp = self.authorized_client.get(self.url) + assert resp.status_code == 403 + + def test_unauthorized_cannot_view_textbooks(self): + resp = self.unauthorized_client.get(self.url) + assert resp.status_code == 403 + + def test_superuser_can_view_textbooks(self): + superuser = UserFactory(is_superuser=True) + client = APIClient() + client.force_authenticate(user=superuser) + resp = client.get(self.url) + assert resp.status_code == 200 diff --git a/cms/djangoapps/contentstore/rest_api/v1/views/tests/test_vertical_block.py b/cms/djangoapps/contentstore/rest_api/v1/views/tests/test_vertical_block.py index a7cf3a452627..9ef86157e463 100644 --- a/cms/djangoapps/contentstore/rest_api/v1/views/tests/test_vertical_block.py +++ b/cms/djangoapps/contentstore/rest_api/v1/views/tests/test_vertical_block.py @@ -5,27 +5,17 @@ from urllib.parse import quote from django.urls import reverse -from rest_framework import status from edx_toggles.toggles.testutils import override_waffle_flag +from rest_framework import status from xblock.validation import ValidationMessage from cms.djangoapps.contentstore.tests.utils import CourseTestCase -from openedx.core.djangoapps.content_tagging.toggles import DISABLE_TAGGING_FEATURE from openedx.core.djangoapps.content_libraries.tests import ContentLibrariesRestApiTest -from xmodule.partitions.partitions import ( - ENROLLMENT_TRACK_PARTITION_ID, - Group, - UserPartition, -) -from xmodule.modulestore.django import ( - modulestore, -) # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import ( - BlockFactory, -) # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore import ( - ModuleStoreEnum, -) # lint-amnesty, pylint: disable=wrong-import-order +from openedx.core.djangoapps.content_tagging.toggles import DISABLE_TAGGING_FEATURE +from xmodule.modulestore import ModuleStoreEnum # pylint: disable=wrong-import-order +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order +from xmodule.modulestore.tests.factories import BlockFactory # pylint: disable=wrong-import-order +from xmodule.partitions.partitions import ENROLLMENT_TRACK_PARTITION_ID, Group, UserPartition class BaseXBlockContainer(CourseTestCase, ContentLibrariesRestApiTest): @@ -148,7 +138,7 @@ def test_success_response(self): """ url = self.get_reverse_url(self.vertical.location) response = self.client.get(url) - self.assertEqual(response.status_code, status.HTTP_200_OK) + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 def test_ancestor_xblocks_response(self): """ @@ -194,7 +184,7 @@ def test_ancestor_xblocks_response(self): def sort_key(block): return block.get("title", "") - self.assertEqual( + self.assertEqual( # noqa: PT009 sorted(response_ancestor_xblocks, key=sort_key), sorted(expected_ancestor_xblocks, key=sort_key) ) @@ -208,7 +198,7 @@ def test_not_valid_usage_key_string(self): ) url = self.get_reverse_url(usage_key_string) response = self.client.get(url) - self.assertEqual(response.status_code, status.HTTP_404_NOT_FOUND) + self.assertEqual(response.status_code, status.HTTP_404_NOT_FOUND) # noqa: PT009 class ContainerVerticalViewTest(BaseXBlockContainer): @@ -224,13 +214,13 @@ def test_success_response(self): """ url = self.get_reverse_url(self.vertical.location) response = self.client.get(url) - self.assertEqual(response.status_code, status.HTTP_200_OK) + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 data = response.json() - self.assertEqual(len(data["children"]), 2) - self.assertFalse(data["is_published"]) - self.assertTrue(data["can_paste_component"]) - self.assertEqual(data["display_name"], "Unit") - self.assertEqual(data["upstream_ready_to_sync_children_info"], []) + self.assertEqual(len(data["children"]), 2) # noqa: PT009 + self.assertFalse(data["is_published"]) # noqa: PT009 + self.assertTrue(data["can_paste_component"]) # noqa: PT009 + self.assertEqual(data["display_name"], "Unit") # noqa: PT009 + self.assertEqual(data["upstream_ready_to_sync_children_info"], []) # noqa: PT009 def test_success_response_with_upstream_info(self): """ @@ -238,13 +228,13 @@ def test_success_response_with_upstream_info(self): """ url = self.get_reverse_url(self.vertical.location) response = self.client.get(f"{url}?get_upstream_info=true") - self.assertEqual(response.status_code, status.HTTP_200_OK) + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 data = response.json() - self.assertEqual(len(data["children"]), 2) - self.assertFalse(data["is_published"]) - self.assertTrue(data["can_paste_component"]) - self.assertEqual(data["display_name"], "Unit") - self.assertEqual(data["upstream_ready_to_sync_children_info"], [{ + self.assertEqual(len(data["children"]), 2) # noqa: PT009 + self.assertFalse(data["is_published"]) # noqa: PT009 + self.assertTrue(data["can_paste_component"]) # noqa: PT009 + self.assertEqual(data["display_name"], "Unit") # noqa: PT009 + self.assertEqual(data["upstream_ready_to_sync_children_info"], [{ # noqa: PT009 "id": str(self.html_unit_second.usage_key), "upstream": self.html_block["id"], "block_type": "html", @@ -259,7 +249,7 @@ def test_xblock_is_published(self): self.publish_item(self.store, self.vertical.location) url = self.get_reverse_url(self.vertical.location) response = self.client.get(url) - self.assertTrue(response.data["is_published"]) + self.assertTrue(response.data["is_published"]) # noqa: PT009 def test_children_content(self): """ @@ -323,7 +313,7 @@ def test_children_content(self): "version_declined": None, "error_message": None, "ready_to_sync": True, - "has_top_level_parent": False, + "top_level_parent_key": None, "downstream_customized": [], }, "user_partition_info": expected_user_partition_info, @@ -334,7 +324,7 @@ def test_children_content(self): ] self.maxDiff = None # Using json() shows meaningful diff in case of error - self.assertEqual(response.json()["children"], expected_response) + self.assertEqual(response.json()["children"], expected_response) # noqa: PT009 def test_not_valid_usage_key_string(self): """ @@ -345,7 +335,7 @@ def test_not_valid_usage_key_string(self): ) url = self.get_reverse_url(usage_key_string) response = self.client.get(url) - self.assertEqual(response.status_code, status.HTTP_404_NOT_FOUND) + self.assertEqual(response.status_code, status.HTTP_404_NOT_FOUND) # noqa: PT009 @override_waffle_flag(DISABLE_TAGGING_FEATURE, True) def test_actions_with_turned_off_taxonomy_flag(self): @@ -355,7 +345,7 @@ def test_actions_with_turned_off_taxonomy_flag(self): url = self.get_reverse_url(self.vertical.location) response = self.client.get(url) for children in response.data["children"]: - self.assertFalse(children["actions"]["can_manage_tags"]) + self.assertFalse(children["actions"]["can_manage_tags"]) # noqa: PT009 def test_validation_errors(self): """ @@ -391,7 +381,7 @@ def test_validation_errors(self): children_response = response.data["children"] # Verify that html_unit_first access settings contradict its parent's access settings. - self.assertEqual(children_response[0]["validation_messages"][0]["type"], ValidationMessage.ERROR) + self.assertEqual(children_response[0]["validation_messages"][0]["type"], ValidationMessage.ERROR) # noqa: PT009 # Verify that html_unit_second has no validation messages. - self.assertFalse(children_response[1]["validation_messages"]) + self.assertFalse(children_response[1]["validation_messages"]) # noqa: PT009 diff --git a/cms/djangoapps/contentstore/rest_api/v1/views/tests/test_videos.py b/cms/djangoapps/contentstore/rest_api/v1/views/tests/test_videos.py index 1d086cb9fda0..252a70764dcf 100644 --- a/cms/djangoapps/contentstore/rest_api/v1/views/tests/test_videos.py +++ b/cms/djangoapps/contentstore/rest_api/v1/views/tests/test_videos.py @@ -1,24 +1,29 @@ """ Unit tests for course settings views. """ -from unittest.mock import patch +from datetime import datetime +from unittest.mock import MagicMock, patch import ddt +import pytz from django.conf import settings from django.contrib.staticfiles.storage import staticfiles_storage from django.urls import reverse from edx_toggles.toggles import WaffleSwitch from edx_toggles.toggles.testutils import override_waffle_switch from edxval.api import ( + create_profile, + create_video, get_3rd_party_transcription_plans, get_transcript_credentials_state_for_org, get_transcript_preferences, ) from rest_framework import status +from rest_framework.test import APIClient -from cms.djangoapps.contentstore.video_storage_handlers import get_all_transcript_languages from cms.djangoapps.contentstore.tests.utils import CourseTestCase from cms.djangoapps.contentstore.utils import reverse_course_url +from cms.djangoapps.contentstore.video_storage_handlers import get_all_transcript_languages from ...mixins import PermissionAccessMixin @@ -73,10 +78,10 @@ def test_course_videos_response(self): "pagination_context": {} } - self.assertEqual(response.status_code, status.HTTP_200_OK) - self.assertDictEqual(expected_response, response.data) + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 + self.assertDictEqual(expected_response, response.data) # noqa: PT009 - @override_waffle_switch(WaffleSwitch( # lint-amnesty, pylint: disable=toggle-missing-annotation + @override_waffle_switch(WaffleSwitch( # pylint: disable=toggle-missing-annotation 'videos.video_image_upload_enabled', __name__ ), True) def test_video_image_upload_enabled(self): @@ -84,12 +89,12 @@ def test_video_image_upload_enabled(self): Make sure if the feature flag is enabled we have updated the dict keys in response. """ response = self.client.get(self.url) - self.assertEqual(response.status_code, status.HTTP_200_OK) - self.assertIn("video_image_settings", response.data) + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 + self.assertIn("video_image_settings", response.data) # noqa: PT009 imageSettings = response.data["video_image_settings"] - self.assertIn("video_image_upload_enabled", imageSettings) - self.assertTrue(imageSettings["video_image_upload_enabled"]) + self.assertIn("video_image_upload_enabled", imageSettings) # noqa: PT009 + self.assertTrue(imageSettings["video_image_upload_enabled"]) # noqa: PT009 def test_VideoTranscriptEnabledFlag_enabled(self): """ @@ -98,40 +103,143 @@ def test_VideoTranscriptEnabledFlag_enabled(self): with patch('openedx.core.djangoapps.video_config.models.VideoTranscriptEnabledFlag.feature_enabled') as feature: feature.return_value = True response = self.client.get(self.url) - self.assertIn("is_video_transcript_enabled", response.data) - self.assertTrue(response.data["is_video_transcript_enabled"]) + self.assertIn("is_video_transcript_enabled", response.data) # noqa: PT009 + self.assertTrue(response.data["is_video_transcript_enabled"]) # noqa: PT009 expect_active_preferences = get_transcript_preferences(str(self.course.id)) - self.assertIn("active_transcript_preferences", response.data) - self.assertEqual(expect_active_preferences, response.data["active_transcript_preferences"]) + self.assertIn("active_transcript_preferences", response.data) # noqa: PT009 + self.assertEqual(expect_active_preferences, response.data["active_transcript_preferences"]) # noqa: PT009 expected_credentials = get_transcript_credentials_state_for_org(self.course.id.org) - self.assertIn("transcript_credentials", response.data) - self.assertDictEqual(expected_credentials, response.data["transcript_credentials"]) + self.assertIn("transcript_credentials", response.data) # noqa: PT009 + self.assertDictEqual(expected_credentials, response.data["transcript_credentials"]) # noqa: PT009 transcript_settings = response.data["video_transcript_settings"] expected_plans = get_3rd_party_transcription_plans() - self.assertIn("transcription_plans", transcript_settings) - self.assertDictEqual(expected_plans, transcript_settings["transcription_plans"]) + self.assertIn("transcription_plans", transcript_settings) # noqa: PT009 + self.assertDictEqual(expected_plans, transcript_settings["transcription_plans"]) # noqa: PT009 expected_preference_handler = reverse_course_url( 'transcript_preferences_handler', str(self.course.id) ) - self.assertIn("transcript_preferences_handler_url", transcript_settings) - self.assertEqual(expected_preference_handler, transcript_settings["transcript_preferences_handler_url"]) + self.assertIn("transcript_preferences_handler_url", transcript_settings) # noqa: PT009 + self.assertEqual(expected_preference_handler, transcript_settings["transcript_preferences_handler_url"]) # noqa: PT009 # pylint: disable=line-too-long expected_credentials_handler = reverse_course_url( 'transcript_credentials_handler', str(self.course.id) ) - self.assertIn("transcript_credentials_handler_url", transcript_settings) - self.assertEqual(expected_credentials_handler, transcript_settings["transcript_credentials_handler_url"]) + self.assertIn("transcript_credentials_handler_url", transcript_settings) # noqa: PT009 + self.assertEqual(expected_credentials_handler, transcript_settings["transcript_credentials_handler_url"]) # noqa: PT009 # pylint: disable=line-too-long with patch( 'openedx.core.djangoapps.video_config.toggles.XPERT_TRANSLATIONS_UI.is_enabled' ) as xpertTranslationfeature: xpertTranslationfeature.return_value = True response = self.client.get(self.url) - self.assertIn("is_ai_translations_enabled", response.data) - self.assertTrue(response.data["is_ai_translations_enabled"]) + self.assertIn("is_ai_translations_enabled", response.data) # noqa: PT009 + self.assertTrue(response.data["is_ai_translations_enabled"]) # noqa: PT009 + + +class VideoDownloadViewTest(CourseTestCase): + """ + Tests for VideoDownloadView. + + The download endpoint fetches each requested ``files[].url`` server-side and + returns the bytes inside a zip. Those URLs must therefore be restricted to + the course's own video URLs, otherwise the endpoint is an SSRF primitive + (see GHSA-fpf9-9rpr-jvrx). + """ + + ALLOWED_URL = "http://example.com/profile1/test.mp4" + # An internal address an attacker might try to reach via SSRF. + SSRF_URL = "http://169.254.169.254/latest/meta-data/" + + def setUp(self): + super().setUp() + # reverse() with only course_id resolves to the download route (the + # usage route with the same name additionally requires edx_video_id). + self.url = reverse( + "cms.djangoapps.contentstore:v1:video_usage", + kwargs={"course_id": self.course.id}, + ) + self.api_client = APIClient() + self.api_client.force_authenticate(user=self.user) + create_profile("profile1") + create_video({ + "edx_video_id": "test-video", + "client_video_id": "test.mp4", + "duration": 42.0, + "status": "file_complete", + "courses": [str(self.course.id)], + "created": datetime.now(pytz.utc), + "encoded_videos": [ + { + "profile": "profile1", + "url": self.ALLOWED_URL, + "file_size": 1600, + "bitrate": 100, + }, + ], + }) + + @patch("cms.djangoapps.contentstore.video_storage_handlers.requests.get") + def test_download_allowed_url(self, mock_get): + """A URL that belongs to the course's videos is fetched and zipped.""" + mock_get.return_value = MagicMock( + content=b"video-bytes", + headers={"Content-Type": "video/mp4"}, + ) + response = self.api_client.put( + self.url, + data={"files": [{"url": self.ALLOWED_URL, "name": "test.mp4"}]}, + format="json", + ) + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 + mock_get.assert_called_once_with(self.ALLOWED_URL, allow_redirects=True) + + @patch("cms.djangoapps.contentstore.video_storage_handlers.requests.get") + def test_rejects_url_not_belonging_to_course(self, mock_get): + """ + A URL that is not one of the course's video URLs is rejected before any + server-side request is made (SSRF protection). + """ + response = self.api_client.put( + self.url, + data={"files": [{"url": self.SSRF_URL, "name": "evil.txt"}]}, + format="json", + ) + self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST) # noqa: PT009 + mock_get.assert_not_called() + + @patch("cms.djangoapps.contentstore.video_storage_handlers.requests.get") + def test_rejects_when_any_url_is_disallowed(self, mock_get): + """ + A request mixing an allowed URL with a disallowed one is rejected + outright, without fetching the allowed URL either. + """ + response = self.api_client.put( + self.url, + data={"files": [ + {"url": self.ALLOWED_URL, "name": "test.mp4"}, + {"url": self.SSRF_URL, "name": "evil.txt"}, + ]}, + format="json", + ) + self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST) # noqa: PT009 + mock_get.assert_not_called() + + @patch("cms.djangoapps.contentstore.video_storage_handlers.requests.get") + def test_non_staff_user_denied(self, mock_get): + """A user without studio read access cannot reach the fetch path.""" + __, nonstaff_user = self.create_non_staff_authed_user_client() + client = APIClient() + client.force_authenticate(user=nonstaff_user) + response = client.put( + self.url, + data={"files": [{"url": self.ALLOWED_URL, "name": "test.mp4"}]}, + format="json", + ) + self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN) # noqa: PT009 + mock_get.assert_not_called() diff --git a/cms/djangoapps/contentstore/rest_api/v1/views/textbooks.py b/cms/djangoapps/contentstore/rest_api/v1/views/textbooks.py index 620b40235b73..6fe358a1b80e 100644 --- a/cms/djangoapps/contentstore/rest_api/v1/views/textbooks.py +++ b/cms/djangoapps/contentstore/rest_api/v1/views/textbooks.py @@ -2,20 +2,16 @@ import edx_api_doc_tools as apidocs from opaque_keys.edx.keys import CourseKey +from openedx_authz.constants.permissions import COURSES_VIEW_PAGES_AND_RESOURCES from rest_framework.request import Request from rest_framework.response import Response from rest_framework.views import APIView +from cms.djangoapps.contentstore.rest_api.v1.serializers import CourseTextbooksSerializer from cms.djangoapps.contentstore.utils import get_textbooks_context -from cms.djangoapps.contentstore.rest_api.v1.serializers import ( - CourseTextbooksSerializer, -) -from common.djangoapps.student.auth import has_studio_read_access -from openedx.core.lib.api.view_utils import ( - DeveloperErrorViewMixin, - verify_course_exists, - view_auth_classes, -) +from openedx.core.djangoapps.authz.constants import LegacyAuthoringPermission +from openedx.core.djangoapps.authz.decorators import user_has_course_permission +from openedx.core.lib.api.view_utils import DeveloperErrorViewMixin, verify_course_exists, view_auth_classes from xmodule.modulestore.django import modulestore @@ -80,7 +76,12 @@ def get(self, request: Request, course_id: str): course_key = CourseKey.from_string(course_id) store = modulestore() - if not has_studio_read_access(request.user, course_key): + if not user_has_course_permission( + request.user, + COURSES_VIEW_PAGES_AND_RESOURCES.identifier, + course_key, + LegacyAuthoringPermission.READ, + ): self.permission_denied(request) with store.bulk_operations(course_key): diff --git a/cms/djangoapps/contentstore/rest_api/v1/views/vertical_block.py b/cms/djangoapps/contentstore/rest_api/v1/views/vertical_block.py index 0af99137e9e2..034f57ba31ed 100644 --- a/cms/djangoapps/contentstore/rest_api/v1/views/vertical_block.py +++ b/cms/djangoapps/contentstore/rest_api/v1/views/vertical_block.py @@ -10,16 +10,12 @@ from rest_framework.views import APIView from cms.djangoapps.contentstore.rest_api.v1.mixins import ContainerHandlerMixin -from cms.djangoapps.contentstore.rest_api.v1.serializers import ( - ContainerHandlerSerializer, -) -from cms.djangoapps.contentstore.utils import ( - get_container_handler_context, -) +from cms.djangoapps.contentstore.rest_api.v1.serializers import ContainerHandlerSerializer +from cms.djangoapps.contentstore.utils import get_container_handler_context from cms.djangoapps.contentstore.views.component import _get_item_in_course from openedx.core.lib.api.view_utils import view_auth_classes -from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.exceptions import ItemNotFoundError # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order +from xmodule.modulestore.exceptions import ItemNotFoundError # pylint: disable=wrong-import-order log = logging.getLogger(__name__) diff --git a/cms/djangoapps/contentstore/rest_api/v1/views/videos.py b/cms/djangoapps/contentstore/rest_api/v1/views/videos.py index c41deec0e5da..08d67b7e33cd 100644 --- a/cms/djangoapps/contentstore/rest_api/v1/views/videos.py +++ b/cms/djangoapps/contentstore/rest_api/v1/views/videos.py @@ -1,29 +1,25 @@ """ Public rest API endpoints for contentstore API video assets (outside authoring API) """ -import edx_api_doc_tools as apidocs import logging + +import edx_api_doc_tools as apidocs from opaque_keys.edx.keys import CourseKey from rest_framework.request import Request from rest_framework.response import Response from rest_framework.views import APIView -from openedx.core.lib.api.view_utils import DeveloperErrorViewMixin, view_auth_classes, verify_course_exists -from common.djangoapps.student.auth import has_studio_read_access - -from ....utils import get_course_videos_context - -from cms.djangoapps.contentstore.video_storage_handlers import ( - get_video_usage_path, - create_video_zip, -) +import cms.djangoapps.contentstore.toggles as contentstore_toggles from cms.djangoapps.contentstore.rest_api.v1.serializers import ( CourseVideosSerializer, + VideoDownloadSerializer, VideoUsageSerializer, - VideoDownloadSerializer ) -import cms.djangoapps.contentstore.toggles as contentstore_toggles +from cms.djangoapps.contentstore.video_storage_handlers import create_video_zip, get_video_usage_path +from common.djangoapps.student.auth import has_studio_read_access +from openedx.core.lib.api.view_utils import DeveloperErrorViewMixin, verify_course_exists, view_auth_classes +from ....utils import get_course_videos_context log = logging.getLogger(__name__) toggles = contentstore_toggles diff --git a/cms/djangoapps/contentstore/rest_api/v2/serializers/__init__.py b/cms/djangoapps/contentstore/rest_api/v2/serializers/__init__.py index 4a48fd6395ea..3db7172bdfb9 100644 --- a/cms/djangoapps/contentstore/rest_api/v2/serializers/__init__.py +++ b/cms/djangoapps/contentstore/rest_api/v2/serializers/__init__.py @@ -3,8 +3,8 @@ from cms.djangoapps.contentstore.rest_api.v2.serializers.downstreams import ( ComponentLinksSerializer, ContainerLinksSerializer, + PublishableEntityLinkSerializer, PublishableEntityLinksSummarySerializer, - PublishableEntityLinkSerializer ) from cms.djangoapps.contentstore.rest_api.v2.serializers.home import CourseHomeTabSerializerV2 diff --git a/cms/djangoapps/contentstore/rest_api/v2/views/downstreams.py b/cms/djangoapps/contentstore/rest_api/v2/views/downstreams.py index 16dc977c8af8..8a669a782ed6 100644 --- a/cms/djangoapps/contentstore/rest_api/v2/views/downstreams.py +++ b/cms/djangoapps/contentstore/rest_api/v2/views/downstreams.py @@ -81,20 +81,21 @@ """ import logging +from itertools import chain from attrs import asdict as attrs_asdict -from django.db.models import QuerySet from django.contrib.auth.models import User # pylint: disable=imported-auth-user +from django.db.models import QuerySet from edx_rest_framework_extensions.paginators import DefaultPagination from opaque_keys import InvalidKeyError from opaque_keys.edx.keys import CourseKey, UsageKey -from opaque_keys.edx.locator import LibraryUsageLocatorV2, LibraryContainerLocator, LibraryLocatorV2 -from rest_framework.exceptions import NotFound, ValidationError, PermissionDenied +from opaque_keys.edx.locator import LibraryContainerLocator, LibraryLocatorV2, LibraryUsageLocatorV2 +from openedx_authz.constants.permissions import COURSES_VIEW_COURSE +from rest_framework.exceptions import NotFound, PermissionDenied, ValidationError from rest_framework.fields import BooleanField from rest_framework.request import Request from rest_framework.response import Response from rest_framework.views import APIView -from itertools import chain from xblock.core import XBlock from cms.djangoapps.contentstore.models import ComponentLink, ContainerLink, EntityLinkBase @@ -115,14 +116,12 @@ from cms.lib.xblock.upstream_sync_block import fetch_customizable_fields_from_block from cms.lib.xblock.upstream_sync_container import fetch_customizable_fields_from_container from common.djangoapps.student.auth import has_studio_read_access, has_studio_write_access -from openedx.core.lib.api.view_utils import ( - DeveloperErrorViewMixin, - view_auth_classes, -) +from openedx.core.djangoapps.authz.decorators import LegacyAuthoringPermission, user_has_course_permission from openedx.core.djangoapps.content_libraries import api as lib_api +from openedx.core.djangoapps.video_config.transcripts_utils import clear_transcripts +from openedx.core.lib.api.view_utils import DeveloperErrorViewMixin, view_auth_classes from xmodule.modulestore.django import modulestore from xmodule.modulestore.exceptions import ItemNotFoundError -from openedx.core.djangoapps.video_config.transcripts_utils import clear_transcripts logger = logging.getLogger(__name__) @@ -305,7 +304,12 @@ def get(self, request: _AuthenticatedRequest, course_key_string: str): except InvalidKeyError as exc: raise ValidationError(detail=f"Malformed course key: {course_key_string}") from exc - if not has_studio_read_access(request.user, course_key): + if not user_has_course_permission( + request.user, + COURSES_VIEW_COURSE.identifier, + course_key, + LegacyAuthoringPermission.READ + ): raise PermissionDenied # Gets all links of the Course, using the diff --git a/cms/djangoapps/contentstore/rest_api/v2/views/home.py b/cms/djangoapps/contentstore/rest_api/v2/views/home.py index 9d37684bfd81..404d088b3e3e 100644 --- a/cms/djangoapps/contentstore/rest_api/v2/views/home.py +++ b/cms/djangoapps/contentstore/rest_api/v2/views/home.py @@ -1,16 +1,16 @@ """HomePageCoursesViewV2 APIView for getting content available to the logged in user.""" -import edx_api_doc_tools as apidocs from collections import OrderedDict -from rest_framework.response import Response + +import edx_api_doc_tools as apidocs +from rest_framework.pagination import PageNumberPagination from rest_framework.request import Request +from rest_framework.response import Response from rest_framework.views import APIView -from rest_framework.pagination import PageNumberPagination - -from openedx.core.lib.api.view_utils import view_auth_classes -from cms.djangoapps.contentstore.utils import get_course_context_v2 from cms.djangoapps.contentstore.rest_api.v2.serializers import CourseHomeTabSerializerV2 +from cms.djangoapps.contentstore.utils import get_course_context_v2 +from openedx.core.lib.api.view_utils import view_auth_classes class HomePageCoursesPaginator(PageNumberPagination): diff --git a/cms/djangoapps/contentstore/rest_api/v2/views/tests/test_downstream_sync_integration.py b/cms/djangoapps/contentstore/rest_api/v2/views/tests/test_downstream_sync_integration.py index 9733f9878210..ffa8b0fa7089 100644 --- a/cms/djangoapps/contentstore/rest_api/v2/views/tests/test_downstream_sync_integration.py +++ b/cms/djangoapps/contentstore/rest_api/v2/views/tests/test_downstream_sync_integration.py @@ -7,13 +7,13 @@ from xml.etree import ElementTree import ddt -from opaque_keys.edx.keys import UsageKey from freezegun import freeze_time +from opaque_keys.edx.keys import UsageKey -from openedx.core.djangoapps.content_libraries.tests import ContentLibrariesRestApiTest from cms.djangoapps.contentstore.xblock_storage_handlers.xblock_helpers import get_block_key_string +from openedx.core.djangoapps.content_libraries.tests import ContentLibrariesRestApiTest from xmodule.modulestore.django import modulestore -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase, ImmediateOnCommitMixin +from xmodule.modulestore.tests.django_utils import ImmediateOnCommitMixin, ModuleStoreTestCase from xmodule.modulestore.tests.factories import BlockFactory, CourseFactory @@ -26,7 +26,7 @@ class CourseToLibraryTestCase(ContentLibrariesRestApiTest, ImmediateOnCommitMixi def setUp(self): super().setUp() - self.now = datetime.now(timezone.utc) + self.now = datetime.now(timezone.utc) # noqa: UP017 freezer = freeze_time(self.now) self.addCleanup(freezer.stop) freezer.start() @@ -128,7 +128,7 @@ def _create_block_from_upstream( "library_content_key": upstream_key, }, expect_response=expect_response) - def _update_course_block_fields(self, usage_key: str, fields: dict[str, Any] = None): + def _update_course_block_fields(self, usage_key: str, fields: dict[str, Any] | None = None): """ Update fields of an XBlock """ return self._api('patch', f"/xblock/{usage_key}", { "metadata": fields, @@ -158,9 +158,9 @@ def _get_downstream_links( data["use_top_level_parents"] = str(use_top_level_parents) return self.client.get("/api/contentstore/v2/downstreams/", data=data) - def assertXmlEqual(self, xml_str_a: str, xml_str_b: str) -> bool: + def assertXmlEqual(self, xml_str_a: str, xml_str_b: str) -> None: """ Assert that the given XML strings are equal, ignoring attribute order and some whitespace variations. """ - self.assertEqual( + self.assertEqual( # noqa: PT009 ElementTree.canonicalize(xml_str_a, strip_text=True), ElementTree.canonicalize(xml_str_b, strip_text=True), ) @@ -441,8 +441,8 @@ def test_unit_sync(self): } ] data = downstreams.json() - self.assertEqual(data["count"], 4) - self.assertListEqual(data["results"], expected_downstreams) + self.assertEqual(data["count"], 4) # noqa: PT009 + self.assertListEqual(data["results"], expected_downstreams) # noqa: PT009 # 2️⃣ Now, lets modify the upstream problem 1: self._set_library_block_olx( @@ -594,8 +594,8 @@ def test_unit_sync(self): } ] data = downstreams.json() - self.assertEqual(data["count"], 4) - self.assertListEqual(data["results"], expected_downstreams) + self.assertEqual(data["count"], 4) # noqa: PT009 + self.assertListEqual(data["results"], expected_downstreams) # noqa: PT009 # 3️⃣ Now, add and delete a component upstream_problem3 = self._add_block_to_library( @@ -746,8 +746,8 @@ def test_unit_sync(self): } ] data = downstreams.json() - self.assertEqual(data["count"], 4) - self.assertListEqual(data["results"], expected_downstreams) + self.assertEqual(data["count"], 4) # noqa: PT009 + self.assertListEqual(data["results"], expected_downstreams) # noqa: PT009 # 4️⃣ Now, reorder components self._patch_container_children(self.upstream_unit["id"], [ @@ -879,8 +879,8 @@ def test_unit_sync(self): } ] data = downstreams.json() - self.assertEqual(data["count"], 4) - self.assertListEqual(data["results"], expected_downstreams) + self.assertEqual(data["count"], 4) # noqa: PT009 + self.assertListEqual(data["results"], expected_downstreams) # noqa: PT009 def test_unit_sync_with_modified_downstream(self): """ @@ -1120,8 +1120,8 @@ def test_modified_html_copy_paste(self): }, ] data = downstreams.json() - self.assertEqual(data["count"], 1) - self.assertListEqual(data["results"], expected_downstreams) + self.assertEqual(data["count"], 1) # noqa: PT009 + self.assertListEqual(data["results"], expected_downstreams) # noqa: PT009 # 2️⃣ Now, lets modify the upstream html AND the downstream display_name: self._update_course_block_fields(downstream_html1["locator"], { @@ -1182,8 +1182,8 @@ def test_modified_html_copy_paste(self): }, ] data = downstreams.json() - self.assertEqual(data["count"], 1) - self.assertListEqual(data["results"], expected_downstreams) + self.assertEqual(data["count"], 1) # noqa: PT009 + self.assertListEqual(data["results"], expected_downstreams) # noqa: PT009 # 3️⃣ Now, sync and check the resulting OLX of the downstream diff --git a/cms/djangoapps/contentstore/rest_api/v2/views/tests/test_downstreams.py b/cms/djangoapps/contentstore/rest_api/v2/views/tests/test_downstreams.py index f32d25a6a5b0..149732437215 100644 --- a/cms/djangoapps/contentstore/rest_api/v2/views/tests/test_downstreams.py +++ b/cms/djangoapps/contentstore/rest_api/v2/views/tests/test_downstreams.py @@ -11,7 +11,10 @@ from freezegun import freeze_time from opaque_keys.edx.keys import ContainerKey, UsageKey from opaque_keys.edx.locator import LibraryLocatorV2, LibraryUsageLocatorV2 +from openedx_authz.constants.roles import COURSE_EDITOR +from openedx_content import models_api as content_models from organizations.models import Organization +from rest_framework import status from cms.djangoapps.contentstore.helpers import StaticFileNotices from cms.djangoapps.contentstore.tests.utils import CourseTestCase @@ -21,6 +24,7 @@ from common.djangoapps.student.auth import add_users from common.djangoapps.student.roles import CourseStaffRole from common.djangoapps.student.tests.factories import UserFactory +from openedx.core.djangoapps.authz.tests.mixins import CourseAuthoringAuthzTestMixin from openedx.core.djangoapps.content_libraries import api as lib_api from xmodule.modulestore.django import modulestore from xmodule.modulestore.tests.django_utils import ImmediateOnCommitMixin, SharedModuleStoreTestCase @@ -50,7 +54,7 @@ def _get_upstream_link_good_and_syncable(downstream): version_declined=downstream.upstream_version_declined, error_message=None, downstream_customized=[], - has_top_level_parent=False, + top_level_parent_key=None, upstream_name=downstream.upstream_display_name, ) @@ -69,7 +73,7 @@ def setUp(self): """ # pylint: disable=too-many-statements super().setUp() - self.now = datetime.now(timezone.utc) + self.now = datetime.now(timezone.utc) # noqa: UP017 freezer = freeze_time(self.now) self.addCleanup(freezer.stop) freezer.start() @@ -221,6 +225,11 @@ def setUp(self): self._publish_library_block(self.video_lib_id) self._publish_library_block(self.html_lib_id) + def tearDown(self): + # If we're working with Containers in test cases, we need this line: + content_models.Container.reset_cache() + return super().tearDown() + def _api(self, method, url, data, expect_response): """ Call a REST API @@ -647,7 +656,7 @@ def test_200_single_upstream_container(self): assert data['ready_to_sync'] is True assert len(data['ready_to_sync_children']) == 1 html_block = modulestore().get_item(self.top_level_downstream_html_key) - self.assertDictEqual(data['ready_to_sync_children'][0], { + self.assertDictEqual(data['ready_to_sync_children'][0], { # noqa: PT009 'name': html_block.display_name, 'upstream': str(self.html_lib_id_2), 'block_type': 'html', @@ -864,8 +873,8 @@ def test_200_all_downstreams_for_a_course(self): 'downstream_customized': [], }, ] - self.assertListEqual(data["results"], expected) - self.assertEqual(data["count"], 11) + self.assertListEqual(data["results"], expected) # noqa: PT009 + self.assertEqual(data["count"], 11) # noqa: PT009 def test_permission_denied_with_course_filter(self): self.client.login(username="simple_user", password="password") @@ -958,8 +967,8 @@ def test_200_component_downstreams_for_a_course(self): 'downstream_customized': [], }, ] - self.assertListEqual(data["results"], expected) - self.assertEqual(data["count"], 4) + self.assertListEqual(data["results"], expected) # noqa: PT009 + self.assertEqual(data["count"], 4) # noqa: PT009 def test_200_container_downstreams_for_a_course(self): """ @@ -1101,8 +1110,8 @@ def test_200_container_downstreams_for_a_course(self): 'downstream_customized': [], }, ] - self.assertListEqual(data["results"], expected) - self.assertEqual(data["count"], 7) + self.assertListEqual(data["results"], expected) # noqa: PT009 + self.assertEqual(data["count"], 7) # noqa: PT009 @ddt.data( ('all', 2), @@ -1121,8 +1130,8 @@ def test_200_downstreams_ready_to_sync(self, item_type, expected_count): ) assert response.status_code == 200 data = response.json() - self.assertTrue(all(o["ready_to_sync"] for o in data["results"])) - self.assertEqual(data["count"], expected_count) + self.assertTrue(all(o["ready_to_sync"] for o in data["results"])) # noqa: PT009 + self.assertEqual(data["count"], expected_count) # noqa: PT009 def test_permission_denied_without_filter(self): self.client.login(username="simple_user", password="password") @@ -1139,8 +1148,8 @@ def test_200_component_downstream_context_list(self): data = response.json() expected = [str(self.downstream_video_key)] + [str(key) for key in self.another_video_keys] got = [str(o["downstream_usage_key"]) for o in data["results"]] - self.assertListEqual(got, expected) - self.assertEqual(data["count"], 4) + self.assertListEqual(got, expected) # noqa: PT009 + self.assertEqual(data["count"], 4) # noqa: PT009 def test_200_container_downstream_context_list(self): """ @@ -1152,8 +1161,8 @@ def test_200_container_downstream_context_list(self): data = response.json() expected = [str(self.downstream_unit_key)] got = [str(o["downstream_usage_key"]) for o in data["results"]] - self.assertListEqual(got, expected) - self.assertEqual(data["count"], 1) + self.assertListEqual(got, expected) # noqa: PT009 + self.assertEqual(data["count"], 1) # noqa: PT009 def test_200_get_ready_to_sync_top_level_parents_with_components(self): """ @@ -1174,7 +1183,7 @@ def test_200_get_ready_to_sync_top_level_parents_with_components(self): ) assert response.status_code == 200 data = response.json() - self.assertEqual(data["count"], 4) + self.assertEqual(data["count"], 4) # noqa: PT009 date_format = self.now.isoformat().split("+")[0] + 'Z' # The expected results are @@ -1255,7 +1264,7 @@ def test_200_get_ready_to_sync_top_level_parents_with_components(self): 'downstream_customized': [], }, ] - self.assertListEqual(data["results"], expected) + self.assertListEqual(data["results"], expected) # noqa: PT009 def test_200_get_ready_to_sync_top_level_parents_with_containers(self): """ @@ -1274,7 +1283,7 @@ def test_200_get_ready_to_sync_top_level_parents_with_containers(self): ) assert response.status_code == 200 data = response.json() - self.assertEqual(data["count"], 3) + self.assertEqual(data["count"], 3) # noqa: PT009 date_format = self.now.isoformat().split("+")[0] + 'Z' # The expected results are @@ -1336,7 +1345,7 @@ def test_200_get_ready_to_sync_top_level_parents_with_containers(self): 'downstream_customized': [], }, ] - self.assertListEqual(data["results"], expected) + self.assertListEqual(data["results"], expected) # noqa: PT009 def test_200_get_ready_to_sync_duplicated_top_level_parents(self): """ @@ -1364,7 +1373,7 @@ def test_200_get_ready_to_sync_duplicated_top_level_parents(self): ) assert response.status_code == 200 data = response.json() - self.assertEqual(data["count"], 3) + self.assertEqual(data["count"], 3) # noqa: PT009 date_format = self.now.isoformat().split("+")[0] + 'Z' # The expected results are @@ -1426,7 +1435,7 @@ def test_200_get_ready_to_sync_duplicated_top_level_parents(self): 'downstream_customized': [], }, ] - self.assertListEqual(data["results"], expected) + self.assertListEqual(data["results"], expected) # noqa: PT009 class GetDownstreamSummaryViewTest( @@ -1456,7 +1465,7 @@ def test_200_summary(self): 'total_count': 3, 'last_published_at': self.now.strftime('%Y-%m-%dT%H:%M:%S.%fZ'), }] - self.assertListEqual(data, expected) + self.assertListEqual(data, expected) # noqa: PT009 response = self.call_api(str(self.course.id)) assert response.status_code == 200 data = response.json() @@ -1476,7 +1485,7 @@ def test_200_summary(self): 'total_count': 7, 'last_published_at': self.now.strftime('%Y-%m-%dT%H:%M:%S.%fZ'), }] - self.assertListEqual(data, expected) + self.assertListEqual(data, expected) # noqa: PT009 # Publish Subsection self._update_container(self.top_level_subsection_id, display_name="Subsection 3") @@ -1492,7 +1501,7 @@ def test_200_summary(self): 'total_count': 7, 'last_published_at': self.now.strftime('%Y-%m-%dT%H:%M:%S.%fZ'), }] - self.assertListEqual(data, expected) + self.assertListEqual(data, expected) # noqa: PT009 # Publish Section self._update_container(self.top_level_section_id, display_name="Section 3") @@ -1508,7 +1517,69 @@ def test_200_summary(self): 'total_count': 7, 'last_published_at': self.now.strftime('%Y-%m-%dT%H:%M:%S.%fZ'), }] - self.assertListEqual(data, expected) + self.assertListEqual(data, expected) # noqa: PT009 + + +class GetDownstreamSummaryAuthzViewTest( + CourseAuthoringAuthzTestMixin, + _BaseDownstreamViewTestMixin, + ImmediateOnCommitMixin, + SharedModuleStoreTestCase, +): + """ + AuthZ tests for: + GET /api/contentstore/v2/downstreams//summary + """ + + def call_api(self, client, course_id): # pylint: disable=arguments-differ + return client.get(f"/api/contentstore/v2/downstreams/{course_id}/summary") + + def test_authorized_user_can_access_summary(self): + """Authorized user with COURSE_EDITOR role can access summary.""" + self.add_user_to_role_in_course( + self.authorized_user, + COURSE_EDITOR.external_key, + self.course.id + ) + + response = self.call_api(self.authorized_client, str(self.course.id)) + + assert response.status_code == status.HTTP_200_OK + assert isinstance(response.json(), list) + + def test_unauthorized_user_cannot_access_summary(self): + """Unauthorized user should receive 403.""" + response = self.call_api(self.unauthorized_client, str(self.course.id)) + + assert response.status_code == status.HTTP_403_FORBIDDEN + + def test_user_without_role_then_added_can_access(self): + """Validate dynamic role assignment works.""" + response = self.call_api(self.unauthorized_client, str(self.course.id)) + assert response.status_code == status.HTTP_403_FORBIDDEN + + self.add_user_to_role_in_course( + self.unauthorized_user, + COURSE_EDITOR.external_key, + self.course.id + ) + + response = self.call_api(self.unauthorized_client, str(self.course.id)) + assert response.status_code == status.HTTP_200_OK + + def test_staff_user_can_access_without_authz_role(self): + """Staff user should access without explicit AuthZ role.""" + response = self.call_api(self.staff_client, str(self.course.id)) + + assert response.status_code == status.HTTP_200_OK + assert isinstance(response.json(), list) + + def test_superuser_can_access_without_authz_role(self): + """Superuser should access without explicit AuthZ role.""" + response = self.call_api(self.super_client, str(self.course.id)) + + assert response.status_code == status.HTTP_200_OK + assert isinstance(response.json(), list) class GetDownstreamDeletedUpstream( @@ -1614,4 +1685,4 @@ def test_delete_component_should_be_ready_to_sync(self): 'version_synced': 2, } - self.assertDictEqual(data[0], expected_results) + self.assertDictEqual(data[0], expected_results) # noqa: PT009 diff --git a/cms/djangoapps/contentstore/rest_api/v2/views/tests/test_home.py b/cms/djangoapps/contentstore/rest_api/v2/views/tests/test_home.py index 6a51610ac9f2..eb2d8adb1d51 100644 --- a/cms/djangoapps/contentstore/rest_api/v2/views/tests/test_home.py +++ b/cms/djangoapps/contentstore/rest_api/v2/views/tests/test_home.py @@ -3,10 +3,9 @@ """ from collections import OrderedDict -from datetime import datetime, timedelta +from datetime import datetime, timedelta, timezone import ddt -import pytz from django.conf import settings from django.urls import reverse from rest_framework import status @@ -36,7 +35,7 @@ def setUp(self): display_name="Demo Course (Sample)", id=archived_course_key, org=archived_course_key.org, - end=(datetime.now() - timedelta(days=365)).replace(tzinfo=pytz.UTC), + end=(datetime.now() - timedelta(days=365)).replace(tzinfo=timezone.utc), # noqa: UP017 ) self.non_staff_client, _ = self.create_non_staff_authed_user_client() @@ -94,8 +93,8 @@ def test_home_page_response(self): ('results', expected_data), ]) - self.assertEqual(response.status_code, status.HTTP_200_OK) - self.assertDictEqual(expected_response, response.data) + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 + self.assertDictEqual(expected_response, response.data) # noqa: PT009 def test_active_only_query_if_passed(self): """Get list of active courses only. @@ -105,8 +104,8 @@ def test_active_only_query_if_passed(self): """ response = self.client.get(self.api_v2_url, {"active_only": "true"}) - self.assertEqual(len(response.data["results"]["courses"]), 1) - self.assertEqual(response.data["results"]["courses"], [OrderedDict([ + self.assertEqual(len(response.data["results"]["courses"]), 1) # noqa: PT009 + self.assertEqual(response.data["results"]["courses"], [OrderedDict([ # noqa: PT009 ("course_key", str(self.course.id)), ("display_name", self.course.display_name), ("lms_link", f'{settings.LMS_ROOT_URL}/courses/{str(self.course.id)}/jump_to/{self.course.location}'), @@ -118,7 +117,7 @@ def test_active_only_query_if_passed(self): ("url", f'/course/{str(self.course.id)}'), ("is_active", True), ])]) - self.assertEqual(response.status_code, status.HTTP_200_OK) + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 def test_archived_only_query_if_passed(self): """Get list of archived courses only. @@ -128,13 +127,13 @@ def test_archived_only_query_if_passed(self): """ response = self.client.get(self.api_v2_url, {"archived_only": "true"}) - self.assertEqual(len(response.data["results"]["courses"]), 1) - self.assertEqual(response.data["results"]["courses"], [OrderedDict([ + self.assertEqual(len(response.data["results"]["courses"]), 1) # noqa: PT009 + self.assertEqual(response.data["results"]["courses"], [OrderedDict([ # noqa: PT009 ("course_key", str(self.archived_course.id)), ("display_name", self.archived_course.display_name), ( "lms_link", - '{url_root}/courses/{course_id}/jump_to/{location}'.format( + '{url_root}/courses/{course_id}/jump_to/{location}'.format( # noqa: UP032 url_root=settings.LMS_ROOT_URL, course_id=str(self.archived_course.id), location=self.archived_course.location @@ -148,7 +147,7 @@ def test_archived_only_query_if_passed(self): ("url", f'/course/{str(self.archived_course.id)}'), ("is_active", False), ])]) - self.assertEqual(response.status_code, status.HTTP_200_OK) + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 def test_search_query_if_passed(self): """Get list of courses when search filter passed as a query param. @@ -158,13 +157,13 @@ def test_search_query_if_passed(self): """ response = self.client.get(self.api_v2_url, {"search": "sample"}) - self.assertEqual(len(response.data["results"]["courses"]), 1) - self.assertEqual(response.data["results"]["courses"], [OrderedDict([ + self.assertEqual(len(response.data["results"]["courses"]), 1) # noqa: PT009 + self.assertEqual(response.data["results"]["courses"], [OrderedDict([ # noqa: PT009 ("course_key", str(self.archived_course.id)), ("display_name", self.archived_course.display_name), ( "lms_link", - '{url_root}/courses/{course_id}/jump_to/{location}'.format( + '{url_root}/courses/{course_id}/jump_to/{location}'.format( # noqa: UP032 url_root=settings.LMS_ROOT_URL, course_id=str(self.archived_course.id), location=self.archived_course.location @@ -178,7 +177,7 @@ def test_search_query_if_passed(self): ("url", f'/course/{str(self.archived_course.id)}'), ("is_active", False), ])]) - self.assertEqual(response.status_code, status.HTTP_200_OK) + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 def test_order_query_if_passed(self): """Get list of courses when order filter passed as a query param. @@ -188,9 +187,9 @@ def test_order_query_if_passed(self): """ response = self.client.get(self.api_v2_url, {"order": "org"}) - self.assertEqual(len(response.data["results"]["courses"]), 2) - self.assertEqual(response.status_code, status.HTTP_200_OK) - self.assertEqual(response.data["results"]["courses"][0]["org"], "demo-org") + self.assertEqual(len(response.data["results"]["courses"]), 2) # noqa: PT009 + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 + self.assertEqual(response.data["results"]["courses"][0]["org"], "demo-org") # noqa: PT009 def test_page_query_if_passed(self): """Get list of courses when page filter passed as a query param. @@ -200,8 +199,8 @@ def test_page_query_if_passed(self): """ response = self.client.get(self.api_v2_url, {"page": 1}) - self.assertEqual(response.data["count"], 2) - self.assertEqual(response.status_code, status.HTTP_200_OK) + self.assertEqual(response.data["count"], 2) # noqa: PT009 + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 @ddt.data( ("active_only", "true"), @@ -222,8 +221,8 @@ def test_if_empty_list_of_courses(self, query_param, value): response = self.client.get(self.api_v2_url, {query_param: value}) - self.assertEqual(len(response.data['results']['courses']), 0) - self.assertEqual(response.status_code, status.HTTP_200_OK) + self.assertEqual(len(response.data['results']['courses']), 0) # noqa: PT009 + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 @ddt.data( ("active_only", "true", 2, 0), @@ -256,7 +255,7 @@ def test_filter_and_ordering_courses( display_name="Course (Demo)", id=archived_course_key, org=archived_course_key.org, - end=(datetime.now() - timedelta(days=365)).replace(tzinfo=pytz.UTC), + end=(datetime.now() - timedelta(days=365)).replace(tzinfo=timezone.utc), # noqa: UP017 ) active_course_key = self.store.make_course_key("foo-org", "foo-number", "foo-run") CourseOverviewFactory.create( @@ -267,12 +266,12 @@ def test_filter_and_ordering_courses( response = self.client.get(self.api_v2_url, {filter_key: filter_value}) - self.assertEqual(response.status_code, status.HTTP_200_OK) - self.assertEqual( + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 + self.assertEqual( # noqa: PT009 len([course for course in response.data["results"]["courses"] if course["is_active"]]), expected_active_length ) - self.assertEqual( + self.assertEqual( # noqa: PT009 len([course for course in response.data["results"]["courses"] if not course["is_active"]]), expected_archived_length ) @@ -296,5 +295,5 @@ def test_if_empty_list_of_courses_non_staff(self, query_param, value): response = self.non_staff_client.get(self.api_v2_url, {query_param: value}) - self.assertEqual(len(response.data["results"]["courses"]), 0) - self.assertEqual(response.status_code, status.HTTP_200_OK) + self.assertEqual(len(response.data["results"]["courses"]), 0) # noqa: PT009 + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 diff --git a/cms/djangoapps/contentstore/rest_api/v2/views/utils.py b/cms/djangoapps/contentstore/rest_api/v2/views/utils.py index 8a6fe461fdb7..840ba2c0e0b0 100644 --- a/cms/djangoapps/contentstore/rest_api/v2/views/utils.py +++ b/cms/djangoapps/contentstore/rest_api/v2/views/utils.py @@ -1,11 +1,12 @@ """ Common utilities for V2 APIs. """ -from rest_framework.response import Response -from rest_framework.generics import GenericAPIView from rest_framework import permissions +from rest_framework.generics import GenericAPIView +from rest_framework.response import Response +from xblocks_contrib.problem.capa.inputtypes import preview_numeric_input + from cms.djangoapps.contentstore.rest_api.v2.serializers.utils import NumericalInputValidationRequestSerializer -from xmodule.capa.inputtypes import preview_numeric_input class NumericalInputValidationView(GenericAPIView): diff --git a/cms/djangoapps/contentstore/signals/handlers.py b/cms/djangoapps/contentstore/signals/handlers.py index e28cbf313acb..74ed55ec95ed 100644 --- a/cms/djangoapps/contentstore/signals/handlers.py +++ b/cms/djangoapps/contentstore/signals/handlers.py @@ -50,9 +50,9 @@ from ..tasks import ( create_or_update_upstream_links, handle_create_xblock_upstream_link, - handle_update_xblock_upstream_link, handle_unlink_upstream_block, handle_unlink_upstream_container, + handle_update_xblock_upstream_link, ) from .signals import GRADING_POLICY_CHANGED @@ -61,7 +61,7 @@ GRADING_POLICY_COUNTDOWN_SECONDS = 3600 -def locked(expiry_seconds, key): # lint-amnesty, pylint: disable=missing-function-docstring +def locked(expiry_seconds, key): # pylint: disable=missing-function-docstring def task_decorator(func): @wraps(func) def wrapper(*args, **kwargs): @@ -75,7 +75,7 @@ def wrapper(*args, **kwargs): return task_decorator -def _create_catalog_data_for_signal(course_key: CourseKey) -> (Optional[datetime], Optional[CourseCatalogData]): +def _create_catalog_data_for_signal(course_key: CourseKey) -> (Optional[datetime], Optional[CourseCatalogData]): # noqa: UP045 # pylint: disable=line-too-long """ Creates data for catalog-info-changed signal when course is published. @@ -94,7 +94,7 @@ def _create_catalog_data_for_signal(course_key: CourseKey) -> (Optional[datetime store = modulestore() with store.branch_setting(ModuleStoreEnum.Branch.published_only, course_key): course = store.get_course(course_key) - timestamp = course.subtree_edited_on.replace(tzinfo=timezone.utc) + timestamp = course.subtree_edited_on.replace(tzinfo=timezone.utc) # noqa: UP017 return timestamp, CourseCatalogData( course_key=course_key.for_branch(None), # Shouldn't be necessary, but just in case... name=course.display_name, @@ -132,7 +132,7 @@ def listen_for_course_publish(sender, course_key, **kwargs): # pylint: disable= from cms.djangoapps.contentstore.tasks import ( update_outline_from_modulestore_task, update_search_index, - update_special_exams_and_publish + update_special_exams_and_publish, ) # DEVELOPER README: probably all tasks here should use transaction.on_commit @@ -238,7 +238,7 @@ def handle_grading_policy_changed(sender, **kwargs): 'event_transaction_type': str(get_event_transaction_type()), } result = task_compute_all_grades_for_course.apply_async(kwargs=kwargs, countdown=GRADING_POLICY_COUNTDOWN_SECONDS) - log.info("Grades: Created {task_name}[{task_id}] with arguments {kwargs}".format( + log.info("Grades: Created {task_name}[{task_id}] with arguments {kwargs}".format( # noqa: UP032 task_name=task_compute_all_grades_for_course.name, task_id=result.task_id, kwargs=kwargs, diff --git a/cms/djangoapps/contentstore/signals/tests/test_handlers.py b/cms/djangoapps/contentstore/signals/tests/test_handlers.py index e70a62508f42..25e7512a1f71 100644 --- a/cms/djangoapps/contentstore/signals/tests/test_handlers.py +++ b/cms/djangoapps/contentstore/signals/tests/test_handlers.py @@ -9,8 +9,9 @@ from openedx_events.content_authoring.data import CourseCatalogData, CourseScheduleData import cms.djangoapps.contentstore.signals.handlers as sh -from xmodule.modulestore.edit_info import EditInfoMixin +from xmodule.course_metadata_utils import DEFAULT_START_DATE from xmodule.modulestore.django import SignalHandler +from xmodule.modulestore.edit_info import EditInfoMixin from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase from xmodule.modulestore.tests.factories import SampleCourseFactory @@ -34,7 +35,7 @@ def setUp(self): course_key=CourseLocator(org='TestU', course='sig101', run='Summer2022', branch=None, version_guid=None), name='Signals 101', schedule_data=CourseScheduleData( - start=datetime.fromisoformat('2030-01-01T00:00+00:00'), + start=DEFAULT_START_DATE, pacing='instructor', end=None, enrollment_start=None, @@ -48,7 +49,7 @@ def setUp(self): autospec=True, side_effect=lambda func: func(), # run right away ) @patch('cms.djangoapps.contentstore.signals.handlers.emit_catalog_info_changed_signal', autospec=True) - def test_signal_chain(self, mock_emit, _mock_on_commit): + def test_signal_chain(self, mock_emit, _mock_on_commit): # noqa: PT019 """ Test that the course_published signal handler invokes the catalog info signal emitter. @@ -66,7 +67,7 @@ def test_emit_regular_course(self, mock_signal): with patch.object(EditInfoMixin, 'subtree_edited_on', now): sh.emit_catalog_info_changed_signal(self.course_key) mock_signal.send_event.assert_called_once_with( - time=now.replace(tzinfo=timezone.utc), + time=now.replace(tzinfo=timezone.utc), # noqa: UP017 catalog_info=self.expected_data) @patch('cms.djangoapps.contentstore.signals.handlers.COURSE_CATALOG_INFO_CHANGED', autospec=True) diff --git a/cms/djangoapps/contentstore/storage.py b/cms/djangoapps/contentstore/storage.py index 83308ebd86b0..b1e9a37bc761 100644 --- a/cms/djangoapps/contentstore/storage.py +++ b/cms/djangoapps/contentstore/storage.py @@ -4,10 +4,11 @@ from django.conf import settings -from common.djangoapps.util.storage import resolve_storage_backend from storages.backends.s3boto3 import S3Boto3Storage from storages.utils import setting +from common.djangoapps.util.storage import resolve_storage_backend + class ImportExportS3Storage(S3Boto3Storage): # pylint: disable=abstract-method """ diff --git a/cms/djangoapps/contentstore/tasks.py b/cms/djangoapps/contentstore/tasks.py index ac9cc3d831ad..a492b50c7c10 100644 --- a/cms/djangoapps/contentstore/tasks.py +++ b/cms/djangoapps/contentstore/tasks.py @@ -29,13 +29,13 @@ set_code_owner_attribute, set_code_owner_attribute_from_module, set_custom_attribute, - set_custom_attributes_for_course_key + set_custom_attributes_for_course_key, ) from olxcleaner.exceptions import ErrorLevel from olxcleaner.reporting import report_error_summary, report_errors from opaque_keys import InvalidKeyError from opaque_keys.edx.keys import CourseKey, UsageKey -from opaque_keys.edx.locator import LibraryContainerLocator, LibraryLocator, BlockUsageLocator +from opaque_keys.edx.locator import LibraryContainerLocator, LibraryLocator from openedx_events.content_authoring.data import CourseData from openedx_events.content_authoring.signals import COURSE_RERUN_COMPLETED from organizations.api import add_organization_course, ensure_organization @@ -50,7 +50,7 @@ from cms.djangoapps.contentstore.courseware_index import ( CoursewareSearchIndexer, LibrarySearchIndexer, - SearchIndexingError + SearchIndexingError, ) from cms.djangoapps.contentstore.storage import course_import_export_storage from cms.djangoapps.contentstore.toggles import enable_course_optimizer_check_prev_run_links @@ -63,7 +63,7 @@ get_previous_run_course_key, initialize_permissions, reverse_usage_url, - translation_language + translation_language, ) from cms.djangoapps.contentstore.xblock_storage_handlers.view_handlers import get_block_info from cms.djangoapps.models.settings.course_metadata import CourseMetadata @@ -94,12 +94,12 @@ from xmodule.tabs import StaticTab from xmodule.util.keys import BlockKey +from .api import get_ready_to_migrate_legacy_library_content_blocks from .models import ComponentLink, ContainerLink, LearningContextLinksStatus, LearningContextLinksStatusChoices from .outlines import update_outline_from_modulestore from .outlines_regenerate import CourseOutlineRegenerate from .toggles import bypass_olx_failure_enabled from .utils import course_import_olx_validation_is_enabled -from .api import get_ready_to_migrate_legacy_library_content_blocks User = get_user_model() @@ -194,7 +194,7 @@ def rerun_course(source_course_key_string, destination_course_key_string, user_i CourseRerunState.objects.succeeded(course_key=destination_course_key) COURSE_RERUN_COMPLETED.send_event( - time=datetime.now(timezone.utc), + time=datetime.now(timezone.utc), # noqa: UP017 course=CourseData( course_key=destination_course_key ) @@ -409,7 +409,7 @@ def create_export_tarball(course_block, course_key, context, status=None): """ name = course_block.url_name export_file = NamedTemporaryFile(prefix=name + '.', - suffix=".tar.gz") # lint-amnesty, pylint: disable=consider-using-with + suffix=".tar.gz") # pylint: disable=consider-using-with root_dir = path(mkdtemp()) try: @@ -523,8 +523,14 @@ def sync_discussion_settings(course_key, user): discussion_config.provider_type = Provider.OPEN_EDX - discussion_config.enable_graded_units = discussion_settings['enable_graded_units'] - discussion_config.unit_level_visibility = discussion_settings['unit_level_visibility'] + fields = ["enable_graded_units", "unit_level_visibility", "enable_in_context", "posting_restrictions"] + # Plugin configuration is stored in the course settings under the provider name. + field_mappings = dict(zip(fields, fields)) | {"plugin_configuration": discussion_config.provider_type} # noqa: B905 # pylint: disable=line-too-long + + for attr_name, settings_key in field_mappings.items(): + if settings_key in discussion_settings: + setattr(discussion_config, attr_name, discussion_settings[settings_key]) + discussion_config.save() LOGGER.info(f'Course import {course.id}: DiscussionsConfiguration synced as per course') except Exception as exc: # pylint: disable=broad-except @@ -534,7 +540,7 @@ def sync_discussion_settings(course_key, user): @shared_task(base=CourseImportTask, bind=True) # Note: The decorator @set_code_owner_attribute cannot be used here because the UserTaskMixin # does stack inspection and can't handle additional decorators. -# lint-amnesty, pylint: disable=too-many-statements +# pylint: disable=too-many-statements def import_olx(self, user_id, course_key_string, archive_path, archive_name, language): """ Import a course or library from a provided OLX .tar.gz or .zip archive. @@ -941,7 +947,7 @@ def _get_users_by_access_level(v1_library_key): return permissions permissions = _get_users_by_access_level(v1_library_key) - for access_level in permissions.keys(): # lint-amnesty, pylint: disable=consider-iterating-dictionary + for access_level in permissions.keys(): # pylint: disable=consider-iterating-dictionary for user in permissions[access_level]: v2contentlib_api.set_library_user_permissions(v2_library_key, user, access_level) @@ -958,7 +964,7 @@ def delete_v1_library(v1_library_key_string): try: delete_course(v1_library_key, ModuleStoreEnum.UserID.mgmt_command, True) LOGGER.info(f"Deleted course {v1_library_key}") - except Exception as error: # lint-amnesty, pylint: disable=broad-except + except Exception as error: # pylint: disable=broad-except return { "v1_library_id": v1_library_key_string, "status": "FAILED", @@ -990,7 +996,7 @@ def validate_all_library_source_blocks_ids_for_course(course_key_string, v1_to_v ) for xblock in blocks: if xblock.source_library_id not in v1_to_v2_lib_map.values(): - # lint-amnesty, pylint: disable=broad-except + # pylint: disable=broad-except raise Exception( f'{xblock.source_library_id} in {course_id} is not found in mapping. Validation failed' ) @@ -1001,7 +1007,7 @@ def validate_all_library_source_blocks_ids_for_course(course_key_string, v1_to_v @shared_task(time_limit=30) @set_code_owner_attribute -def replace_all_library_source_blocks_ids_for_course(course_key_string, v1_to_v2_lib_map): # lint-amnesty, pylint: disable=useless-return +def replace_all_library_source_blocks_ids_for_course(course_key_string, v1_to_v2_lib_map): # pylint: disable=useless-return """Search a Modulestore for all library source blocks in a course by querying mongo. replace all source_library_ids with the corresponding v2 value from the map. @@ -1060,7 +1066,7 @@ def replace_all_library_source_blocks_ids_for_course(course_key_string, v1_to_v2 @shared_task(time_limit=30) @set_code_owner_attribute -def undo_all_library_source_blocks_ids_for_course(course_key_string, v1_to_v2_lib_map): # lint-amnesty, pylint: disable=useless-return +def undo_all_library_source_blocks_ids_for_course(course_key_string, v1_to_v2_lib_map): # pylint: disable=useless-return """Search a Modulestore for all library source blocks in a course by querying mongo. replace all source_library_ids with the corresponding v1 value from the inverted map. This is exists to undo changes made previously. @@ -1165,7 +1171,7 @@ def _check_broken_links(task_instance, user_id, course_key_string, language): Checks for broken links in a course and stores the results in a file. Also checks for previous run links if the feature is enabled. """ - user = _validate_user(task_instance, user_id, language) + user = _validate_user(task_instance, user_id, language) # noqa: F841 task_instance.status.set_state(UserTaskStatus.IN_PROGRESS) course_key = CourseKey.from_string(course_key_string) @@ -1220,7 +1226,7 @@ def _validate_user(task, user_id, language): """Validate if the user exists. Otherwise log an unknown user id error.""" try: return User.objects.get(pk=user_id) - except User.DoesNotExist as exc: + except User.DoesNotExist as exc: # noqa: F841 with translation_language(language): task.status.fail(UserErrors.UNKNOWN_USER_ID.format(user_id)) return @@ -1477,14 +1483,14 @@ async def _validate_url_access(session, url_data, course_key): parsed = urlparse(url) domain = parsed.netloc.lower() headers = DOMAIN_HEADERS.get(domain, DEFAULT_HEADERS) - except Exception as e: # lint-amnesty, pylint: disable=broad-except + except Exception as e: # pylint: disable=broad-except LOGGER.debug(f'[Link Check] Error parsing URL {url}: {str(e)}') headers = DEFAULT_HEADERS try: async with session.get(standardized_url, headers=headers, timeout=5) as response: result.update({'status': response.status}) - except Exception as e: # lint-amnesty, pylint: disable=broad-except + except Exception as e: # pylint: disable=broad-except result.update({'status': None}) LOGGER.debug(f'[Link Check] Request error when validating {url}: {str(e)}') return result @@ -1641,11 +1647,7 @@ def handle_create_xblock_upstream_link(usage_key): return if xblock.top_level_downstream_parent_key is not None: block_key = BlockKey.from_string(xblock.top_level_downstream_parent_key) - top_level_parent_usage_key = BlockUsageLocator( - xblock.course_id, - block_key.type, - block_key.id, - ) + top_level_parent_usage_key = block_key.to_usage_key(xblock.course_id) try: ContainerLink.get_by_downstream_usage_key(top_level_parent_usage_key) except ContainerLink.DoesNotExist: @@ -1686,7 +1688,7 @@ def create_or_update_upstream_links( ensure_cms("create_or_update_upstream_links may only be executed in a CMS context") if not created: - created = datetime.now(timezone.utc) + created = datetime.now(timezone.utc) # noqa: UP017 course_status = LearningContextLinksStatus.get_or_create(course_key_str, created) if course_status.status in [ LearningContextLinksStatusChoices.COMPLETED, @@ -2165,7 +2167,7 @@ def _update_broken_links_file_with_updated_links(course_key, updated_links): try: with latest_artifact.file.open("r") as file: existing_broken_links = json.load(file) - except (json.JSONDecodeError, IOError) as e: + except (json.JSONDecodeError, IOError) as e: # noqa: UP024 LOGGER.error( f"Failed to read broken links file for course {course_key}: {e}" ) diff --git a/cms/djangoapps/contentstore/tests/test_bulk_enabledisable_discussions.py b/cms/djangoapps/contentstore/tests/test_bulk_enabledisable_discussions.py index 149a7a53182f..69a6d1a39beb 100644 --- a/cms/djangoapps/contentstore/tests/test_bulk_enabledisable_discussions.py +++ b/cms/djangoapps/contentstore/tests/test_bulk_enabledisable_discussions.py @@ -5,12 +5,12 @@ from django.urls import reverse from opaque_keys.edx.keys import CourseKey -from xmodule.modulestore import ModuleStoreEnum -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase -from xmodule.modulestore.tests.factories import CourseFactory, BlockFactory from cms.djangoapps.contentstore.tests.utils import AjaxEnabledTestClient from common.djangoapps.student.tests.factories import UserFactory +from xmodule.modulestore import ModuleStoreEnum +from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase +from xmodule.modulestore.tests.factories import BlockFactory, CourseFactory class BulkEnableDisableDiscussionsTestCase(ModuleStoreTestCase): @@ -49,13 +49,13 @@ def setUp(self): category='sequential', display_name="Generated Sequence", ) - unit1 = BlockFactory.create( + unit1 = BlockFactory.create( # noqa: F841 parent=sequence, category='vertical', display_name="Unit in Section1", discussion_enabled=True, ) - unit2 = BlockFactory.create( + unit2 = BlockFactory.create( # noqa: F841 parent=sequence, category='vertical', display_name="Unit in Section2", @@ -82,16 +82,16 @@ def enable_disable_discussions_for_all_units(self, is_enabled): "discussion_enabled": is_enabled } response = self.client.put(self.url, data=json.dumps(data), content_type='application/json') - self.assertEqual(response.status_code, 200) + self.assertEqual(response.status_code, 200) # noqa: PT009 response_data = response.json() print(response_data) - self.assertEqual(response_data['units_updated_and_republished'], 0 if is_enabled else 2) + self.assertEqual(response_data['units_updated_and_republished'], 0 if is_enabled else 2) # noqa: PT009 # Check that all verticals now have discussion_enabled set to the expected value with self.store.bulk_operations(self.course_key): verticals = self.store.get_items(self.course_key, qualifiers={'block_type': 'vertical'}) for vertical in verticals: - self.assertEqual(vertical.discussion_enabled, is_enabled) + self.assertEqual(vertical.discussion_enabled, is_enabled) # noqa: PT009 def test_permission_denied_for_non_staff(self): """ @@ -107,11 +107,11 @@ def test_permission_denied_for_non_staff(self): non_staff_client.login(username=non_staff_user.username, password=self.user_password) response = non_staff_client.put(self.url, content_type='application/json') - self.assertEqual(response.status_code, 403) + self.assertEqual(response.status_code, 403) # noqa: PT009 def test_badrequest_for_empty_request_body(self): """ Test that the API returns a 400 for an empty request body. """ response = self.client.put(self.url, data=json.dumps({}), content_type='application/json') - self.assertEqual(response.status_code, 400) + self.assertEqual(response.status_code, 400) # noqa: PT009 diff --git a/cms/djangoapps/contentstore/tests/test_clone_course.py b/cms/djangoapps/contentstore/tests/test_clone_course.py index 6d45ae5469e1..7de6fcdb63a5 100644 --- a/cms/djangoapps/contentstore/tests/test_clone_course.py +++ b/cms/djangoapps/contentstore/tests/test_clone_course.py @@ -14,10 +14,10 @@ from common.djangoapps.course_action_state.managers import CourseRerunUIStateManager from common.djangoapps.course_action_state.models import CourseRerunState from common.djangoapps.student.auth import has_course_author_access -from xmodule.contentstore.content import StaticContent # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.contentstore.django import contentstore # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore import EdxJSONEncoder, ModuleStoreEnum # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.contentstore.content import StaticContent # pylint: disable=wrong-import-order +from xmodule.contentstore.django import contentstore # pylint: disable=wrong-import-order +from xmodule.modulestore import EdxJSONEncoder, ModuleStoreEnum # pylint: disable=wrong-import-order +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order TEST_DATA_DIR = settings.COMMON_TEST_DATA_ROOT @@ -69,8 +69,8 @@ def test_space_in_asset_name_for_rerun_course(self): # Get & verify all assets of the course assets, count = contentstore().get_all_content_for_course(course.id) - self.assertEqual(count, 1) - self.assertEqual({asset['asset_key'].block_id for asset in assets}, course_assets) # lint-amnesty, pylint: disable=consider-using-set-comprehension + self.assertEqual(count, 1) # noqa: PT009 + self.assertEqual({asset['asset_key'].block_id for asset in assets}, course_assets) # pylint: disable=consider-using-set-comprehension # noqa: PT009 # rerun from split into split split_rerun_id = CourseLocator(org=org, course=course_number, run="2012_Q2") @@ -83,9 +83,9 @@ def test_space_in_asset_name_for_rerun_course(self): ) # Check if re-run was successful - self.assertEqual(result.get(), "succeeded") + self.assertEqual(result.get(), "succeeded") # noqa: PT009 rerun_state = CourseRerunState.objects.find_first(course_key=split_rerun_id) - self.assertEqual(rerun_state.state, CourseRerunUIStateManager.State.SUCCEEDED) + self.assertEqual(rerun_state.state, CourseRerunUIStateManager.State.SUCCEEDED) # noqa: PT009 def test_rerun_course(self): """ @@ -114,14 +114,14 @@ def test_rerun_course(self): CourseRerunState.objects.initiated(split_course.id, split_course3_id, self.user, fields['display_name']) result = rerun_course.delay(str(split_course.id), str(split_course3_id), self.user.id, json.dumps(fields, cls=EdxJSONEncoder)) - self.assertEqual(result.get(), "succeeded") - self.assertTrue(has_course_author_access(self.user, split_course3_id), "Didn't grant access") + self.assertEqual(result.get(), "succeeded") # noqa: PT009 + self.assertTrue(has_course_author_access(self.user, split_course3_id), "Didn't grant access") # noqa: PT009 rerun_state = CourseRerunState.objects.find_first(course_key=split_course3_id) - self.assertEqual(rerun_state.state, CourseRerunUIStateManager.State.SUCCEEDED) + self.assertEqual(rerun_state.state, CourseRerunUIStateManager.State.SUCCEEDED) # noqa: PT009 # try creating rerunning again to same name and ensure it generates error result = rerun_course.delay(str(split_course.id), str(split_course3_id), self.user.id) - self.assertEqual(result.get(), "duplicate course") + self.assertEqual(result.get(), "duplicate course") # noqa: PT009 # the below will raise an exception if the record doesn't exist CourseRerunState.objects.find_first( course_key=split_course3_id, @@ -129,14 +129,14 @@ def test_rerun_course(self): ) # try to hit the generic exception catch - with patch('xmodule.modulestore.split_mongo.mongo_connection.MongoPersistenceBackend.insert_course_index', Mock(side_effect=Exception)): # lint-amnesty, pylint: disable=line-too-long + with patch('xmodule.modulestore.split_mongo.mongo_connection.MongoPersistenceBackend.insert_course_index', Mock(side_effect=Exception)): # pylint: disable=line-too-long split_course4_id = CourseLocator(org="edx3", course="split3", run="rerun_fail") fields = {'display_name': 'total failure'} CourseRerunState.objects.initiated(split_course3_id, split_course4_id, self.user, fields['display_name']) result = rerun_course.delay(str(split_course3_id), str(split_course4_id), self.user.id, json.dumps(fields, cls=EdxJSONEncoder)) - self.assertIn("exception: ", result.get()) - self.assertIsNone(self.store.get_course(split_course4_id), "Didn't delete course after error") + self.assertIn("exception: ", result.get()) # noqa: PT009 + self.assertIsNone(self.store.get_course(split_course4_id), "Didn't delete course after error") # noqa: PT009 # pylint: disable=line-too-long CourseRerunState.objects.find_first( course_key=split_course4_id, state=CourseRerunUIStateManager.State.FAILED diff --git a/cms/djangoapps/contentstore/tests/test_contentstore.py b/cms/djangoapps/contentstore/tests/test_contentstore.py index c7c4cd6921ff..4561926c1b8d 100644 --- a/cms/djangoapps/contentstore/tests/test_contentstore.py +++ b/cms/djangoapps/contentstore/tests/test_contentstore.py @@ -1,4 +1,4 @@ -# lint-amnesty, pylint: disable=missing-module-docstring +# pylint: disable=missing-module-docstring # TODO: Rewrite several of these assertions so that they check the output of the REST or Python # APIs rather than parsing HTML from the deprecated legacy frontend pages. In particular, any @@ -17,11 +17,11 @@ import ddt from django.conf import settings -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.test import TestCase from django.test.utils import override_settings from django.urls import reverse -from edx_toggles.toggles.testutils import override_waffle_switch, override_waffle_flag +from edx_toggles.toggles.testutils import override_waffle_flag, override_waffle_switch from edxval.api import create_video, get_videos_for_course from fs.osfs import OSFS from lxml import etree @@ -29,6 +29,19 @@ from opaque_keys.edx.keys import AssetKey, CourseKey, UsageKey from opaque_keys.edx.locations import CourseLocator from path import Path as path + +from cms.djangoapps.contentstore import toggles +from cms.djangoapps.contentstore.config import waffle +from cms.djangoapps.contentstore.tests.utils import AjaxEnabledTestClient, CourseTestCase, get_url, parse_json +from cms.djangoapps.contentstore.utils import delete_course, reverse_course_url, reverse_url +from cms.djangoapps.contentstore.views.component import ADVANCED_COMPONENT_TYPES +from common.djangoapps.course_action_state.managers import CourseActionStateItemNotFoundError +from common.djangoapps.course_action_state.models import CourseRerunState, CourseRerunUIStateManager +from common.djangoapps.student import auth +from common.djangoapps.student.models import CourseEnrollment +from common.djangoapps.student.roles import CourseCreatorRole, CourseInstructorRole +from openedx.core.djangoapps.django_comment_common.utils import are_permissions_roles_seeded +from openedx.core.lib.tempdir import mkdtemp_clean from xmodule.capa_block import ProblemBlock from xmodule.contentstore.content import StaticContent from xmodule.contentstore.django import contentstore @@ -41,31 +54,14 @@ from xmodule.modulestore.inheritance import own_metadata from xmodule.modulestore.split_mongo import BlockKey from xmodule.modulestore.tests.django_utils import TEST_DATA_SPLIT_MODULESTORE -from xmodule.modulestore.tests.factories import CourseFactory, BlockFactory, check_mongo_calls +from xmodule.modulestore.tests.factories import BlockFactory, CourseFactory, check_mongo_calls from xmodule.modulestore.xml_exporter import export_course_to_xml from xmodule.modulestore.xml_importer import import_course_from_xml, perform_xlint from xmodule.seq_block import SequenceBlock from xmodule.video_block import VideoBlock -from cms.djangoapps.contentstore import toggles -from cms.djangoapps.contentstore.config import waffle -from cms.djangoapps.contentstore.tests.utils import AjaxEnabledTestClient, CourseTestCase, get_url, parse_json -from cms.djangoapps.contentstore.utils import ( - delete_course, - reverse_course_url, - reverse_url, -) -from cms.djangoapps.contentstore.views.component import ADVANCED_COMPONENT_TYPES -from common.djangoapps.course_action_state.managers import CourseActionStateItemNotFoundError -from common.djangoapps.course_action_state.models import CourseRerunState, CourseRerunUIStateManager -from common.djangoapps.student import auth -from common.djangoapps.student.models import CourseEnrollment -from common.djangoapps.student.roles import CourseCreatorRole, CourseInstructorRole -from openedx.core.djangoapps.django_comment_common.utils import are_permissions_roles_seeded -from openedx.core.lib.tempdir import mkdtemp_clean - TEST_DATA_CONTENTSTORE = copy.deepcopy(settings.CONTENTSTORE) -TEST_DATA_CONTENTSTORE['DOC_STORE_CONFIG']['db'] = 'test_xcontent_%s' % uuid4().hex +TEST_DATA_CONTENTSTORE['DOC_STORE_CONFIG']['db'] = 'test_xcontent_%s' % uuid4().hex # noqa: UP031 TEST_DATA_DIR = settings.COMMON_TEST_DATA_ROOT @@ -83,7 +79,7 @@ def decorated_func(*args, **kwargs): try: from PIL import Image except ImportError: - raise SkipTest("Pillow is not installed (or not found)") # lint-amnesty, pylint: disable=raise-missing-from + raise SkipTest("Pillow is not installed (or not found)") # pylint: disable=raise-missing-from # noqa: B904 if not getattr(Image.core, "jpeg_decoder", False): raise SkipTest("Pillow cannot open JPEG files") return func(*args, **kwargs) @@ -111,15 +107,15 @@ def test_no_static_link_rewrites_on_import(self): handouts_usage_key = course.id.make_usage_key('course_info', 'handouts') handouts = self.store.get_item(handouts_usage_key) - self.assertIn('/static/', handouts.data) + self.assertIn('/static/', handouts.data) # noqa: PT009 handouts_usage_key = course.id.make_usage_key('html', 'toyhtml') handouts = self.store.get_item(handouts_usage_key) - self.assertIn('/static/', handouts.data) + self.assertIn('/static/', handouts.data) # noqa: PT009 def test_xlint_fails(self): err_cnt = perform_xlint(TEST_DATA_DIR, ['toy']) - self.assertGreater(err_cnt, 0) + self.assertGreater(err_cnt, 0) # noqa: PT009 def test_invalid_asset_overwrite(self): """ @@ -150,7 +146,7 @@ def test_invalid_asset_overwrite(self): 'import_draft_order', 'import_draft_order' )) - self.assertIsNotNone(course) + self.assertIsNotNone(course) # noqa: PT009 # Add a new asset in the course, and make sure to name it such that it overwrite the one existing # asset in the course. (i.e. _invalid_displayname_subs-esLhHcdKGWvKs.srt) @@ -162,11 +158,11 @@ def test_invalid_asset_overwrite(self): # Get & verify that course actually has two assets assets, count = content_store.get_all_content_for_course(course.id) - self.assertEqual(count, 2) + self.assertEqual(count, 2) # noqa: PT009 # Verify both assets have similar `displayname` after saving. for asset in assets: - self.assertEqual(asset['displayname'], expected_displayname) + self.assertEqual(asset['displayname'], expected_displayname) # noqa: PT009 # Test course export does not fail root_dir = path(mkdtemp_clean()) @@ -177,9 +173,9 @@ def test_invalid_asset_overwrite(self): exported_static_files = filesystem.listdir('/') # Verify that asset have been overwritten during export. - self.assertEqual(len(exported_static_files), 1) - self.assertTrue(filesystem.exists(expected_displayname)) - self.assertEqual(exported_static_files[0], expected_displayname) + self.assertEqual(len(exported_static_files), 1) # noqa: PT009 + self.assertTrue(filesystem.exists(expected_displayname)) # noqa: PT009 + self.assertEqual(exported_static_files[0], expected_displayname) # noqa: PT009 # Remove exported course shutil.rmtree(root_dir) @@ -195,11 +191,11 @@ def test_about_overrides(self): ) course_key = course_items[0].id effort = self.store.get_item(course_key.make_usage_key('about', 'effort')) - self.assertEqual(effort.data, '6 hours') + self.assertEqual(effort.data, '6 hours') # noqa: PT009 # this one should be in a non-override folder effort = self.store.get_item(course_key.make_usage_key('about', 'end_date')) - self.assertEqual(effort.data, 'TBD') + self.assertEqual(effort.data, 'TBD') # noqa: PT009 @requires_pillow_jpeg def test_asset_import(self): @@ -215,23 +211,23 @@ def test_asset_import(self): course = self.store.get_course(self.store.make_course_key('edX', 'toy', '2012_Fall')) - self.assertIsNotNone(course) + self.assertIsNotNone(course) # noqa: PT009 # make sure we have some assets in our contentstore all_assets, __ = content_store.get_all_content_for_course(course.id) - self.assertGreater(len(all_assets), 0) + self.assertGreater(len(all_assets), 0) # noqa: PT009 # make sure we have some thumbnails in our contentstore all_thumbnails = content_store.get_all_content_thumbnails_for_course(course.id) - self.assertGreater(len(all_thumbnails), 0) + self.assertGreater(len(all_thumbnails), 0) # noqa: PT009 location = AssetKey.from_string('asset-v1:edX+toy+2012_Fall+type@asset+block@just_a_test.jpg') content = content_store.find(location) - self.assertIsNotNone(content) + self.assertIsNotNone(content) # noqa: PT009 - self.assertIsNotNone(content.thumbnail_location) + self.assertIsNotNone(content.thumbnail_location) # noqa: PT009 thumbnail = content_store.find(content.thumbnail_location) - self.assertIsNotNone(thumbnail) + self.assertIsNotNone(thumbnail) # noqa: PT009 def test_course_info_updates_import_export(self): """ @@ -245,26 +241,26 @@ def test_course_info_updates_import_export(self): ) course = courses[0] - self.assertIsNotNone(course) + self.assertIsNotNone(course) # noqa: PT009 course_updates = self.store.get_item(course.id.make_usage_key('course_info', 'updates')) - self.assertIsNotNone(course_updates) + self.assertIsNotNone(course_updates) # noqa: PT009 # check that course which is imported has files 'updates.html' and 'updates.items.json' filesystem = OSFS(str(data_dir + '/course_info_updates/info')) - self.assertTrue(filesystem.exists('updates.html')) - self.assertTrue(filesystem.exists('updates.items.json')) + self.assertTrue(filesystem.exists('updates.html')) # noqa: PT009 + self.assertTrue(filesystem.exists('updates.items.json')) # noqa: PT009 # verify that course info update module has same data content as in data file from which it is imported # check 'data' field content with filesystem.open('updates.html', 'r') as course_policy: on_disk = course_policy.read() - self.assertEqual(course_updates.data, on_disk) + self.assertEqual(course_updates.data, on_disk) # noqa: PT009 # check 'items' field content with filesystem.open('updates.items.json', 'r') as course_policy: on_disk = loads(course_policy.read()) - self.assertEqual(course_updates.items, on_disk) + self.assertEqual(course_updates.items, on_disk) # noqa: PT009 # now export the course to a tempdir and test that it contains files 'updates.html' and 'updates.items.json' # with same content as in course 'info' directory @@ -274,17 +270,17 @@ def test_course_info_updates_import_export(self): # check that exported course has files 'updates.html' and 'updates.items.json' filesystem = OSFS(str(root_dir / 'test_export/info')) - self.assertTrue(filesystem.exists('updates.html')) - self.assertTrue(filesystem.exists('updates.items.json')) + self.assertTrue(filesystem.exists('updates.html')) # noqa: PT009 + self.assertTrue(filesystem.exists('updates.items.json')) # noqa: PT009 # verify that exported course has same data content as in course_info_update module with filesystem.open('updates.html', 'r') as grading_policy: on_disk = grading_policy.read() - self.assertEqual(on_disk, course_updates.data) + self.assertEqual(on_disk, course_updates.data) # noqa: PT009 with filesystem.open('updates.items.json', 'r') as grading_policy: on_disk = loads(grading_policy.read()) - self.assertEqual(on_disk, course_updates.items) + self.assertEqual(on_disk, course_updates.items) # noqa: PT009 def test_rewrite_nonportable_links_on_import(self): content_store = contentstore() @@ -298,22 +294,22 @@ def test_rewrite_nonportable_links_on_import(self): course_key = self.store.make_course_key('edX', 'toy', '2012_Fall') html_block_location = course_key.make_usage_key('html', 'nonportable') html_block = self.store.get_item(html_block_location) - self.assertIn('/static/foo.jpg', html_block.data) + self.assertIn('/static/foo.jpg', html_block.data) # noqa: PT009 # then check a intra courseware link html_block_location = course_key.make_usage_key('html', 'nonportable_link') html_block = self.store.get_item(html_block_location) - self.assertIn('/jump_to_id/nonportable_link', html_block.data) + self.assertIn('/jump_to_id/nonportable_link', html_block.data) # noqa: PT009 - def verify_content_existence(self, store, root_dir, course_id, dirname, category_name, filename_suffix=''): # lint-amnesty, pylint: disable=missing-function-docstring + def verify_content_existence(self, store, root_dir, course_id, dirname, category_name, filename_suffix=''): # pylint: disable=missing-function-docstring filesystem = OSFS(root_dir / 'test_export') - self.assertTrue(filesystem.exists(dirname)) + self.assertTrue(filesystem.exists(dirname)) # noqa: PT009 items = store.get_items(course_id, qualifiers={'category': category_name}) for item in items: filesystem = OSFS(root_dir / ('test_export/' + dirname)) - self.assertTrue(filesystem.exists(item.location.block_id + filename_suffix)) + self.assertTrue(filesystem.exists(item.location.block_id + filename_suffix)) # noqa: PT009 def test_export_course_with_metadata_only_video(self): content_store = contentstore() @@ -326,7 +322,7 @@ def test_export_course_with_metadata_only_video(self): # anything in 'data' field, the export was blowing up verticals = self.store.get_items(course_id, qualifiers={'category': 'vertical'}) - self.assertGreater(len(verticals), 0) + self.assertGreater(len(verticals), 0) # noqa: PT009 parent = verticals[0] @@ -352,7 +348,7 @@ def test_export_course_with_metadata_only_word_cloud(self): verticals = self.store.get_items(course_id, qualifiers={'category': 'vertical'}) - self.assertGreater(len(verticals), 0) + self.assertGreater(len(verticals), 0) # noqa: PT009 parent = verticals[0] @@ -384,14 +380,14 @@ def test_import_after_renaming_xml_data(self): ) all_items = split_store.get_items(course_after_rename[0].id, qualifiers={'category': 'chapter'}) renamed_chapter = [item for item in all_items if item.location.block_id == 'renamed_chapter'][0] - self.assertIsNotNone(renamed_chapter.published_on) - self.assertIsNotNone(renamed_chapter.parent) - self.assertIn(renamed_chapter.location, course_after_rename[0].children) + self.assertIsNotNone(renamed_chapter.published_on) # noqa: PT009 + self.assertIsNotNone(renamed_chapter.parent) # noqa: PT009 + self.assertIn(renamed_chapter.location, course_after_rename[0].children) # noqa: PT009 original_chapter = [item for item in all_items if item.location.block_id == 'b9870b9af59841a49e6e02765d0e3bbf'][0] - self.assertIsNone(original_chapter.published_on) - self.assertIsNone(original_chapter.parent) - self.assertNotIn(original_chapter.location, course_after_rename[0].children) + self.assertIsNone(original_chapter.published_on) # noqa: PT009 + self.assertIsNone(original_chapter.parent) # noqa: PT009 + self.assertNotIn(original_chapter.location, course_after_rename[0].children) # noqa: PT009 def test_empty_data_roundtrip(self): """ @@ -405,7 +401,7 @@ def test_empty_data_roundtrip(self): verticals = self.store.get_items(course_id, qualifiers={'category': 'vertical'}) - self.assertGreater(len(verticals), 0) + self.assertGreater(len(verticals), 0) # noqa: PT009 parent = verticals[0] @@ -413,7 +409,7 @@ def test_empty_data_roundtrip(self): word_cloud = BlockFactory.create( parent_location=parent.location, category="word_cloud", display_name="untitled") del word_cloud.data - self.assertEqual(word_cloud.data, '') + self.assertEqual(word_cloud.data, '') # noqa: PT009 # Export the course root_dir = path(mkdtemp_clean()) @@ -424,7 +420,7 @@ def test_empty_data_roundtrip(self): imported_word_cloud = self.store.get_item(course_id.make_usage_key('word_cloud', 'untitled')) # It should now contain empty data - self.assertEqual(imported_word_cloud.data, '') + self.assertEqual(imported_word_cloud.data, '') # noqa: PT009 def test_html_export_roundtrip(self): """ @@ -445,11 +441,11 @@ def test_html_export_roundtrip(self): # get the sample HTML with styling information html_block = self.store.get_item(course_id.make_usage_key('html', 'with_styling')) - self.assertIn('

', html_block.data) + self.assertIn('

', html_block.data) # noqa: PT009 # pylint: disable=line-too-long # get the sample HTML with just a simple tag information html_block = self.store.get_item(course_id.make_usage_key('html', 'just_img')) - self.assertIn('', html_block.data) + self.assertIn('', html_block.data) # noqa: PT009 def test_export_course_without_content_store(self): # Create toy course @@ -483,7 +479,7 @@ def test_export_course_without_content_store(self): 'name': 'vertical_sequential', } ) - self.assertEqual(len(items), 1) + self.assertEqual(len(items), 1) # noqa: PT009 def test_export_course_no_xml_attributes(self): """ @@ -508,7 +504,7 @@ def test_export_course_no_xml_attributes(self): ) # note that it has no `xml_attributes` attribute - self.assertFalse(hasattr(draft_open_assessment, "xml_attributes")) + self.assertFalse(hasattr(draft_open_assessment, "xml_attributes")) # noqa: PT009 # export should still complete successfully root_dir = path(mkdtemp_clean()) @@ -626,9 +622,9 @@ def test_export_on_invalid_displayname(self, invalid_displayname): # Verify that the course has only one asset and it has been added with an invalid asset name. assets, count = content_store.get_all_content_for_course(self.course.id) - self.assertEqual(count, 1) + self.assertEqual(count, 1) # noqa: PT009 display_name = assets[0]['displayname'] - self.assertEqual(display_name, invalid_displayname) + self.assertEqual(display_name, invalid_displayname) # noqa: PT009 # Now export the course to a tempdir and test that it contains assets. The export should pass root_dir = path(mkdtemp_clean()) @@ -639,8 +635,8 @@ def test_export_on_invalid_displayname(self, invalid_displayname): exported_static_files = filesystem.listdir('/') # Verify that only single asset has been exported with the expected asset name. - self.assertTrue(filesystem.exists(exported_asset_name)) - self.assertEqual(len(exported_static_files), 1) + self.assertTrue(filesystem.exists(exported_asset_name)) # noqa: PT009 + self.assertEqual(len(exported_static_files), 1) # noqa: PT009 # Remove tempdir shutil.rmtree(root_dir) @@ -663,7 +659,7 @@ def test_export_with_orphan_vertical(self): # mocking get_item to for drafts. Expect no draft is exported. # Specifically get_item is used in `xmodule.modulestore.xml_exporter._export_drafts` export_draft_dir = OSFS(root_dir / 'test_export/drafts') - self.assertEqual(len(export_draft_dir.listdir('/')), 0) + self.assertEqual(len(export_draft_dir.listdir('/')), 0) # noqa: PT009 # Remove tempdir shutil.rmtree(root_dir) @@ -684,11 +680,11 @@ def test_assets_overwrite(self): # Fetch & verify course assets to be equal to 2. assets, count = content_store.get_all_content_for_course(self.course.id) - self.assertEqual(count, 2) + self.assertEqual(count, 2) # noqa: PT009 # Verify both assets have similar 'displayname' after saving. for asset in assets: - self.assertEqual(asset['displayname'], asset_displayname) + self.assertEqual(asset['displayname'], asset_displayname) # noqa: PT009 # Now export the course to a tempdir and test that it contains assets. root_dir = path(mkdtemp_clean()) @@ -698,8 +694,8 @@ def test_assets_overwrite(self): # Verify that asset have been overwritten during export. filesystem = OSFS(root_dir / 'test_export/static') exported_static_files = filesystem.listdir('/') - self.assertTrue(filesystem.exists(asset_displayname)) - self.assertEqual(len(exported_static_files), 1) + self.assertTrue(filesystem.exists(asset_displayname)) # noqa: PT009 + self.assertEqual(len(exported_static_files), 1) # noqa: PT009 # Remove tempdir shutil.rmtree(root_dir) @@ -713,7 +709,7 @@ def test_edit_unit(self): """Verifies rendering the editor in all the verticals in the given test course""" self._check_verticals([self.vert_loc]) - def _get_draft_counts(self, item): # lint-amnesty, pylint: disable=missing-function-docstring + def _get_draft_counts(self, item): # pylint: disable=missing-function-docstring cnt = 1 if not self.store.has_published_version(item) else 0 for child in item.get_children(): cnt = cnt + self._get_draft_counts(child) @@ -733,14 +729,14 @@ def test_get_items(self): self.course.id, revision=ModuleStoreEnum.RevisionOption.published_only ) items_from_direct_store = [item for item in direct_store_items if item.location == self.problem.location] - self.assertEqual(len(items_from_direct_store), 0) + self.assertEqual(len(items_from_direct_store), 0) # noqa: PT009 # Fetch from the draft store. draft_store_items = self.store.get_items( self.course.id, revision=ModuleStoreEnum.RevisionOption.draft_only ) items_from_draft_store = [item for item in draft_store_items if item.location == self.problem.location] - self.assertEqual(len(items_from_draft_store), 1) + self.assertEqual(len(items_from_draft_store), 1) # noqa: PT009 def test_draft_metadata(self): """ @@ -754,16 +750,16 @@ def test_draft_metadata(self): course = self.store.update_item(course, self.user.id) problem = self.store.get_item(self.problem.location) - self.assertEqual(problem.graceperiod, course.graceperiod) - self.assertNotIn('graceperiod', own_metadata(problem)) + self.assertEqual(problem.graceperiod, course.graceperiod) # noqa: PT009 + self.assertNotIn('graceperiod', own_metadata(problem)) # noqa: PT009 self.store.convert_to_draft(problem.location, self.user.id) # refetch to check metadata problem = self.store.get_item(problem.location) - self.assertEqual(problem.graceperiod, course.graceperiod) - self.assertNotIn('graceperiod', own_metadata(problem)) + self.assertEqual(problem.graceperiod, course.graceperiod) # noqa: PT009 + self.assertNotIn('graceperiod', own_metadata(problem)) # noqa: PT009 # publish block self.store.publish(problem.location, self.user.id) @@ -771,8 +767,8 @@ def test_draft_metadata(self): # refetch to check metadata problem = self.store.get_item(problem.location) - self.assertEqual(problem.graceperiod, course.graceperiod) - self.assertNotIn('graceperiod', own_metadata(problem)) + self.assertEqual(problem.graceperiod, course.graceperiod) # noqa: PT009 + self.assertNotIn('graceperiod', own_metadata(problem)) # noqa: PT009 # put back in draft and change metadata and see if it's now marked as 'own_metadata' self.store.convert_to_draft(problem.location, self.user.id) @@ -780,21 +776,21 @@ def test_draft_metadata(self): new_graceperiod = timedelta(hours=1) - self.assertNotIn('graceperiod', own_metadata(problem)) + self.assertNotIn('graceperiod', own_metadata(problem)) # noqa: PT009 problem.graceperiod = new_graceperiod # Save the data that we've just changed to the underlying # MongoKeyValueStore before we update the mongo datastore. problem.save() - self.assertIn('graceperiod', own_metadata(problem)) - self.assertEqual(problem.graceperiod, new_graceperiod) + self.assertIn('graceperiod', own_metadata(problem)) # noqa: PT009 + self.assertEqual(problem.graceperiod, new_graceperiod) # noqa: PT009 self.store.update_item(problem, self.user.id) # read back to make sure it reads as 'own-metadata' problem = self.store.get_item(problem.location) - self.assertIn('graceperiod', own_metadata(problem)) - self.assertEqual(problem.graceperiod, new_graceperiod) + self.assertIn('graceperiod', own_metadata(problem)) # noqa: PT009 + self.assertEqual(problem.graceperiod, new_graceperiod) # noqa: PT009 # republish self.store.publish(problem.location, self.user.id) @@ -803,27 +799,27 @@ def test_draft_metadata(self): self.store.convert_to_draft(problem.location, self.user.id) problem = self.store.get_item(problem.location) - self.assertIn('graceperiod', own_metadata(problem)) - self.assertEqual(problem.graceperiod, new_graceperiod) + self.assertIn('graceperiod', own_metadata(problem)) # noqa: PT009 + self.assertEqual(problem.graceperiod, new_graceperiod) # noqa: PT009 def test_get_depth_with_drafts(self): # make sure no draft items have been returned num_drafts = self._get_draft_counts(self.course) - self.assertEqual(num_drafts, 0) + self.assertEqual(num_drafts, 0) # noqa: PT009 # put into draft self.problem = self.store.unpublish(self.problem.location, self.user.id) # make sure we can query that item and verify that it is a draft draft_problem = self.store.get_item(self.problem.location) - self.assertEqual(self.store.has_published_version(draft_problem), False) + self.assertEqual(self.store.has_published_version(draft_problem), False) # noqa: PT009 # now requery with depth course = self.store.get_course(self.course.id, depth=None) # make sure just one draft item have been returned num_drafts = self._get_draft_counts(course) - self.assertEqual(num_drafts, 1) + self.assertEqual(num_drafts, 1) # noqa: PT009 @mock.patch('xmodule.course_block.requests.get') def test_import_textbook_as_content_element(self, mock_get): @@ -834,13 +830,13 @@ def test_import_textbook_as_content_element(self, mock_get): """).strip() self.course.textbooks = [Textbook("Textbook", "https://s3.amazonaws.com/edx-textbooks/guttag_computation_v3/")] course = self.store.update_item(self.course, self.user.id) - self.assertGreater(len(course.textbooks), 0) + self.assertGreater(len(course.textbooks), 0) # noqa: PT009 def test_import_polls(self): items = self.store.get_items(self.course.id, qualifiers={'category': 'poll_question'}) - self.assertGreater(len(items), 0) + self.assertGreater(len(items), 0) # noqa: PT009 # check that there's actually content in the 'question' field - self.assertGreater(len(items[0].question), 0) + self.assertGreater(len(items[0].question), 0) # noqa: PT009 def test_module_preview_in_whitelist(self): """ @@ -851,7 +847,7 @@ def test_module_preview_in_whitelist(self): resp = self.client.get_json( get_url('xblock_view_handler', self.vert_loc, kwargs={'view_name': 'container_preview'}) ) - self.assertEqual(resp.status_code, 200) + self.assertEqual(resp.status_code, 200) # noqa: PT009 vertical = self.store.get_item(self.vert_loc) for child in vertical.children: @@ -861,17 +857,17 @@ def test_delete(self): # make sure the parent points to the child object which is to be deleted # need to refetch chapter b/c at the time it was assigned it had no children chapter = self.store.get_item(self.chapter_loc) - self.assertIn(self.seq_loc, chapter.children) + self.assertIn(self.seq_loc, chapter.children) # noqa: PT009 self.client.delete(get_url('xblock_handler', self.seq_loc)) - with self.assertRaises(ItemNotFoundError): + with self.assertRaises(ItemNotFoundError): # noqa: PT027 self.store.get_item(self.seq_loc) chapter = self.store.get_item(self.chapter_loc) # make sure the parent no longer points to the child object which was deleted - self.assertNotIn(self.seq_loc, chapter.children) + self.assertNotIn(self.seq_loc, chapter.children) # noqa: PT009 def test_asset_delete_and_restore(self): """ @@ -881,18 +877,18 @@ def test_asset_delete_and_restore(self): # now try to find it in store, but they should not be there any longer content = contentstore().find(asset_key, throw_on_not_found=False) - self.assertIsNone(content) + self.assertIsNone(content) # noqa: PT009 # now try to find it and the thumbnail in trashcan - should be in there content = contentstore('trashcan').find(asset_key, throw_on_not_found=False) - self.assertIsNotNone(content) + self.assertIsNotNone(content) # noqa: PT009 # let's restore the asset restore_asset_from_trashcan(str(asset_key)) # now try to find it in courseware store, and they should be back after restore content = contentstore('trashcan').find(asset_key, throw_on_not_found=False) - self.assertIsNotNone(content) + self.assertIsNotNone(content) # noqa: PT009 def _delete_asset_in_course(self): """ @@ -915,7 +911,7 @@ def _delete_asset_in_course(self): kwargs={'asset_key_string': str(asset_key)} ) resp = self.client.delete(url) - self.assertEqual(resp.status_code, 204) + self.assertEqual(resp.status_code, 204) # noqa: PT009 return asset_key @@ -927,22 +923,22 @@ def test_empty_trashcan(self): # make sure there's something in the trashcan all_assets, __ = contentstore('trashcan').get_all_content_for_course(self.course.id) - self.assertGreater(len(all_assets), 0) + self.assertGreater(len(all_assets), 0) # noqa: PT009 # empty the trashcan empty_asset_trashcan([self.course.id]) # make sure trashcan is empty all_assets, count = contentstore('trashcan').get_all_content_for_course(self.course.id) - self.assertEqual(len(all_assets), 0) - self.assertEqual(count, 0) + self.assertEqual(len(all_assets), 0) # noqa: PT009 + self.assertEqual(count, 0) # noqa: PT009 def test_illegal_draft_crud_ops(self): chapter = self.store.get_item(self.chapter_loc) chapter.data = 'chapter data' self.store.update_item(chapter, self.user.id) - with self.assertRaises(InvalidVersionError): + with self.assertRaises(InvalidVersionError): # noqa: PT027 self.store.unpublish(self.chapter_loc, self.user.id) def test_bad_contentstore_request(self): @@ -951,10 +947,10 @@ def test_bad_contentstore_request(self): asset/course key """ resp = self.client.get_html('asset-v1:CDX+123123+2012_Fall+type@asset+block@&invalid.png') - self.assertEqual(resp.status_code, 404) + self.assertEqual(resp.status_code, 404) # noqa: PT009 resp = self.client.get_html('asset-v1:CDX+123123+2012_Fall+type@asset+block@invalid.png') - self.assertEqual(resp.status_code, 404) + self.assertEqual(resp.status_code, 404) # noqa: PT009 @override_waffle_switch(waffle.ENABLE_ACCESSIBILITY_POLICY_PAGE, active=False) def test_disabled_accessibility_page(self): @@ -962,7 +958,7 @@ def test_disabled_accessibility_page(self): Test that accessibility page returns 404 when waffle switch is disabled """ resp = self.client.get_html('/accessibility') - self.assertEqual(resp.status_code, 404) + self.assertEqual(resp.status_code, 404) # noqa: PT009 def test_delete_course(self): """ @@ -976,8 +972,8 @@ def test_delete_course(self): ) contentstore().save(content) assets, count = contentstore().get_all_content_for_course(self.course.id) - self.assertGreater(len(assets), 0) - self.assertGreater(count, 0) + self.assertGreater(len(assets), 0) # noqa: PT009 + self.assertGreater(count, 0) # noqa: PT009 self.store.unpublish(self.vert_loc, self.user.id) @@ -986,14 +982,14 @@ def test_delete_course(self): # assert that there's absolutely no non-draft blocks in the course # this should also include all draft items - with self.assertRaises(ItemNotFoundError): + with self.assertRaises(ItemNotFoundError): # noqa: PT027 self.store.get_items(self.course.id) # assert that all content in the asset library is keeped # in case the course is later restored. assets, count = contentstore().get_all_content_for_course(self.course.id) - self.assertGreater(len(assets), 0) - self.assertGreater(count, 0) + self.assertGreater(len(assets), 0) # noqa: PT009 + self.assertGreater(count, 0) # noqa: PT009 def test_course_handouts_rewrites(self): """ @@ -1009,7 +1005,7 @@ def test_course_handouts_rewrites(self): resp = self.client.get(get_url('xblock_handler', handouts.location)) # make sure we got a successful response - self.assertEqual(resp.status_code, 200) + self.assertEqual(resp.status_code, 200) # noqa: PT009 # check that /static/ has been converted to the full path # note, we know the link it should be because that's what in the 'toy' course in the test data asset_key = self.course.id.make_asset_key('asset', 'handouts_sample_handout.txt') @@ -1028,10 +1024,10 @@ def test_prefetch_children(self): course = self.store.get_course(self.course.id, depth=2, lazy=False) # make sure we pre-fetched a known sequential which should be at depth=2 - self.assertIn(BlockKey.from_usage_key(self.seq_loc), course.runtime.module_data) + self.assertIn(BlockKey.from_usage_key(self.seq_loc), course.runtime.module_data) # noqa: PT009 # make sure we don't have a specific vertical which should be at depth=3 - self.assertNotIn(BlockKey.from_usage_key(self.vert_loc), course.runtime.module_data) + self.assertNotIn(BlockKey.from_usage_key(self.vert_loc), course.runtime.module_data) # noqa: PT009 # Now, test with the branch set to draft. No extra round trips b/c it doesn't go deep enough to get # beyond direct only categories @@ -1042,10 +1038,10 @@ def test_prefetch_children(self): def _check_verticals(self, locations): """ Test getting the editing HTML for each vertical. """ # Assert is here to make sure that the course being tested actually has verticals (units) to check. - self.assertGreater(len(locations), 0) + self.assertGreater(len(locations), 0) # noqa: PT009 for loc in locations: resp = self.client.get_html(get_url('container_handler', loc)) - self.assertEqual(resp.status_code, 200) + self.assertEqual(resp.status_code, 200) # noqa: PT009 @ddt.ddt @@ -1077,7 +1073,7 @@ def assert_created_course(self, number_suffix=None): course_key = _get_course_id(self.store, test_course_data) _create_course(self, course_key, test_course_data) # Verify that the creator is now registered in the course. - self.assertTrue(CourseEnrollment.is_enrolled(self.user, course_key)) + self.assertTrue(CourseEnrollment.is_enrolled(self.user, course_key)) # noqa: PT009 return test_course_data def assert_create_course_failed(self, error_message): @@ -1085,9 +1081,9 @@ def assert_create_course_failed(self, error_message): Checks that the course not created. """ resp = self.client.ajax_post('/course/', self.course_data) - self.assertEqual(resp.status_code, 400) + self.assertEqual(resp.status_code, 400) # noqa: PT009 data = parse_json(resp) - self.assertEqual(data['error'], error_message) + self.assertEqual(data['error'], error_message) # noqa: PT009 def test_create_course(self): """Test new course creation - happy path""" @@ -1121,7 +1117,7 @@ def test_create_course__default_enable_flexible_peer_openassessments( new_course = self.store.get_course(new_course_key) # ... and our setting got toggled appropriately on the course - self.assertEqual(new_course.force_on_flexible_peer_openassessments, mock_toggle_state) + self.assertEqual(new_course.force_on_flexible_peer_openassessments, mock_toggle_state) # noqa: PT009 @override_settings(DEFAULT_COURSE_LANGUAGE='hr') def test_create_course_default_language(self): @@ -1129,7 +1125,7 @@ def test_create_course_default_language(self): test_course_data = self.assert_created_course() course_id = _get_course_id(self.store, test_course_data) course_block = self.store.get_course(course_id) - self.assertEqual(course_block.language, 'hr') + self.assertEqual(course_block.language, 'hr') # noqa: PT009 def test_create_course_with_dots(self): """Test new course creation with dots in the name""" @@ -1155,16 +1151,16 @@ def test_course_with_different_cases(self): def test_create_course_check_forum_seeding(self): """Test new course creation and verify forum seeding """ test_course_data = self.assert_created_course(number_suffix=uuid4().hex) - self.assertTrue(are_permissions_roles_seeded(_get_course_id(self.store, test_course_data))) + self.assertTrue(are_permissions_roles_seeded(_get_course_id(self.store, test_course_data))) # noqa: PT009 def test_forum_unseeding_on_delete(self): """Test new course creation and verify forum unseeding """ test_course_data = self.assert_created_course(number_suffix=uuid4().hex) course_id = _get_course_id(self.store, test_course_data) - self.assertTrue(are_permissions_roles_seeded(course_id)) + self.assertTrue(are_permissions_roles_seeded(course_id)) # noqa: PT009 delete_course(course_id, self.user.id) # should raise an exception for checking permissions on deleted course - with self.assertRaises(ItemNotFoundError): + with self.assertRaises(ItemNotFoundError): # noqa: PT027 are_permissions_roles_seeded(course_id) def test_forum_unseeding_with_multiple_courses(self): @@ -1176,12 +1172,12 @@ def test_forum_unseeding_with_multiple_courses(self): course_id = _get_course_id(self.store, test_course_data) delete_course(course_id, self.user.id) # should raise an exception for checking permissions on deleted course - with self.assertRaises(ItemNotFoundError): + with self.assertRaises(ItemNotFoundError): # noqa: PT027 are_permissions_roles_seeded(course_id) second_course_id = _get_course_id(self.store, second_course_data) # permissions should still be there for the other course - self.assertTrue(are_permissions_roles_seeded(second_course_id)) + self.assertTrue(are_permissions_roles_seeded(second_course_id)) # noqa: PT009 def test_course_enrollments_and_roles_on_delete(self): """ @@ -1191,14 +1187,14 @@ def test_course_enrollments_and_roles_on_delete(self): course_id = _get_course_id(self.store, test_course_data) # test that a user gets his enrollment and its 'student' role as default on creating a course - self.assertTrue(CourseEnrollment.is_enrolled(self.user, course_id)) - self.assertTrue(self.user.roles.filter(name="Student", course_id=course_id)) + self.assertTrue(CourseEnrollment.is_enrolled(self.user, course_id)) # noqa: PT009 + self.assertTrue(self.user.roles.filter(name="Student", course_id=course_id)) # noqa: PT009 delete_course(course_id, self.user.id) # check that user's enrollment for this course is not deleted - self.assertTrue(CourseEnrollment.is_enrolled(self.user, course_id)) + self.assertTrue(CourseEnrollment.is_enrolled(self.user, course_id)) # noqa: PT009 # check that user has form role "Student" for this course even after deleting it - self.assertTrue(self.user.roles.filter(name="Student", course_id=course_id)) + self.assertTrue(self.user.roles.filter(name="Student", course_id=course_id)) # noqa: PT009 def test_course_access_groups_on_delete(self): """ @@ -1213,7 +1209,7 @@ def test_course_access_groups_on_delete(self): auth.add_users(self.user, instructor_role, self.user) - self.assertGreater(len(instructor_role.users_with_role()), 0) + self.assertGreater(len(instructor_role.users_with_role()), 0) # noqa: PT009 # Now delete course and check that user not in instructor groups of this course delete_course(course_id, self.user.id) @@ -1221,8 +1217,8 @@ def test_course_access_groups_on_delete(self): # Update our cached user since its roles have changed self.user = User.objects.get_by_natural_key(self.user.natural_key()[0]) - self.assertFalse(instructor_role.has_user(self.user)) - self.assertEqual(len(instructor_role.users_with_role()), 0) + self.assertFalse(instructor_role.has_user(self.user)) # noqa: PT009 + self.assertEqual(len(instructor_role.users_with_role()), 0) # noqa: PT009 def test_delete_course_with_keep_instructors(self): """ @@ -1235,14 +1231,14 @@ def test_delete_course_with_keep_instructors(self): # Add and verify instructor role for the course instructor_role = CourseInstructorRole(course_id) instructor_role.add_users(self.user) - self.assertTrue(instructor_role.has_user(self.user)) + self.assertTrue(instructor_role.has_user(self.user)) # noqa: PT009 delete_course(course_id, self.user.id, keep_instructors=True) # Update our cached user so if any change in roles can be captured self.user = User.objects.get_by_natural_key(self.user.natural_key()[0]) - self.assertTrue(instructor_role.has_user(self.user)) + self.assertTrue(instructor_role.has_user(self.user)) # noqa: PT009 def test_create_course_after_delete(self): """ @@ -1273,13 +1269,14 @@ def assert_course_creation_failed(self, error_message): # b/c the intent of the test with bad chars isn't to test auth but to test the handler, ignore pass resp = self.client.ajax_post('/course/', self.course_data) - self.assertEqual(resp.status_code, 200) + self.assertEqual(resp.status_code, 200) # noqa: PT009 data = parse_json(resp) - self.assertRegex(data['ErrMsg'], error_message) + assert 'ErrMsg' in data, "Expected the course creation to fail" + self.assertRegex(data['ErrMsg'], error_message) # noqa: PT009 if test_enrollment: # One test case involves trying to create the same course twice. Hence for that course, # the user will be enrolled. In the other cases, initially_enrolled will be False. - self.assertEqual(initially_enrolled, CourseEnrollment.is_enrolled(self.user, course_id)) + self.assertEqual(initially_enrolled, CourseEnrollment.is_enrolled(self.user, course_id)) # noqa: PT009 def test_create_course_duplicate_number(self): """Test new course creation - error path""" @@ -1325,11 +1322,11 @@ def test_course_substring(self): cache_current = self.course_data['number'] self.course_data['number'] = '{}a'.format(self.course_data['number']) resp = self.client.ajax_post('/course/', self.course_data) - self.assertEqual(resp.status_code, 200) + self.assertEqual(resp.status_code, 200) # noqa: PT009 self.course_data['number'] = cache_current self.course_data['org'] = 'a{}'.format(self.course_data['org']) resp = self.client.ajax_post('/course/', self.course_data) - self.assertEqual(resp.status_code, 200) + self.assertEqual(resp.status_code, 200) # noqa: PT009 def test_create_course_with_bad_organization(self): """Test new course creation - error path for bad organization name""" @@ -1386,18 +1383,18 @@ def assert_course_permission_denied(self): Checks that the course did not get created due to a PermissionError. """ resp = self.client.ajax_post('/course/', self.course_data) - self.assertEqual(resp.status_code, 403) + self.assertEqual(resp.status_code, 403) # noqa: PT009 def test_course_factory(self): """Test that the course factory works correctly.""" course = CourseFactory.create() - self.assertIsInstance(course, CourseBlock) + self.assertIsInstance(course, CourseBlock) # noqa: PT009 def test_item_factory(self): """Test that the item factory works correctly.""" course = CourseFactory.create() item = BlockFactory.create(parent_location=course.location) - self.assertIsInstance(item, SequenceBlock) + self.assertIsInstance(item, SequenceBlock) # noqa: PT009 def test_create_block(self): """Test creating a new xblock instance.""" @@ -1411,12 +1408,12 @@ def test_create_block(self): resp = self.client.ajax_post(reverse_url('xblock_handler'), section_data) - self.assertEqual(resp.status_code, 200) + self.assertEqual(resp.status_code, 200) # noqa: PT009 data = parse_json(resp) retarget = re.escape( str(course.id.make_usage_key('chapter', 'REPLACE')) ).replace('REPLACE', r'([0-9]|[a-f]){3,}') - self.assertRegex(data['locator'], retarget) + self.assertRegex(data['locator'], retarget) # noqa: PT009 @ddt.data(True, False) def test_hide_xblock_from_toc_via_handler(self, hide_from_toc): @@ -1432,8 +1429,8 @@ def test_hide_xblock_from_toc_via_handler(self, hide_from_toc): response = self.client.ajax_post(get_url("xblock_handler", sequential.location), data) sequential = self.store.get_item(sequential.location) - self.assertEqual(response.status_code, 200) - self.assertEqual(hide_from_toc, sequential.hide_from_toc) + self.assertEqual(response.status_code, 200) # noqa: PT009 + self.assertEqual(hide_from_toc, sequential.hide_from_toc) # noqa: PT009 def test_capa_block(self): """Test that a problem treats markdown specially.""" @@ -1445,12 +1442,12 @@ def test_capa_block(self): } resp = self.client.ajax_post(reverse_url('xblock_handler'), problem_data) - self.assertEqual(resp.status_code, 200) + self.assertEqual(resp.status_code, 200) # noqa: PT009 payload = parse_json(resp) problem_loc = UsageKey.from_string(payload['locator']) problem = self.store.get_item(problem_loc) - self.assertIsInstance(problem, ProblemBlock, "New problem is not a ProblemBlock") - self.assertNotIn('markdown', problem.editable_metadata_fields, "Markdown slipped into the editable metadata fields") # lint-amnesty, pylint: disable=line-too-long + self.assertIsInstance(problem, ProblemBlock, "New problem is not a ProblemBlock") # noqa: PT009 + self.assertNotIn('markdown', problem.editable_metadata_fields, "Markdown slipped into the editable metadata fields") # pylint: disable=line-too-long # noqa: PT009 def test_cms_imported_course_walkthrough(self): """ @@ -1463,7 +1460,7 @@ def test_get_html(handler): resp = self.client.get_html( get_url(handler, course_key, 'course_key_string') ) - self.assertEqual(resp.status_code, 200) + self.assertEqual(resp.status_code, 200) # noqa: PT009 def test_get_json(handler): # Helper function for getting HTML for a page in Studio and @@ -1472,7 +1469,7 @@ def test_get_json(handler): get_url(handler, course_key, 'course_key_string'), HTTP_ACCEPT="application/json", ) - self.assertEqual(resp.status_code, 200) + self.assertEqual(resp.status_code, 200) # noqa: PT009 course_items = import_course_from_xml( self.store, self.user.id, TEST_DATA_DIR, ['simple'], create_if_not_present=True @@ -1483,25 +1480,29 @@ def test_get_json(handler): # course_handler raise 404 for old mongo course if course_key.deprecated: - self.assertEqual(resp.status_code, 404) + self.assertEqual(resp.status_code, 404) # noqa: PT009 return - self.assertEqual(resp.status_code, 200) + self.assertEqual(resp.status_code, 200) # noqa: PT009 self.assertContains(resp, 'Chapter 2') # go to various pages - with override_waffle_flag(toggles.LEGACY_STUDIO_IMPORT, True): - test_get_html('import_handler') - with override_waffle_flag(toggles.LEGACY_STUDIO_EXPORT, True): - test_get_html('export_handler') - with override_waffle_flag(toggles.LEGACY_STUDIO_COURSE_TEAM, True): - test_get_html('course_team_handler') - with override_waffle_flag(toggles.LEGACY_STUDIO_SCHEDULE_DETAILS, True): - test_get_html('settings_handler') - with override_waffle_flag(toggles.LEGACY_STUDIO_GRADING, True): - test_get_html('grading_handler') - with override_waffle_flag(toggles.LEGACY_STUDIO_ADVANCED_SETTINGS, True): - test_get_html('advanced_settings_handler') + with override_settings(COURSE_AUTHORING_MICROFRONTEND_URL='https://mfe.example'): + resp = self.client.get_html(get_url('import_handler', course_key, 'course_key_string')) + self.assertEqual(resp.status_code, 302) # noqa: PT009 + resp = self.client.get_html(get_url('export_handler', course_key, 'course_key_string')) + self.assertEqual(resp.status_code, 302) # noqa: PT009 + resp = self.client.get_html(get_url('course_team_handler', course_key, 'course_key_string')) + self.assertEqual(resp.status_code, 302) # noqa: PT009 + with override_settings(COURSE_AUTHORING_MICROFRONTEND_URL='https://mfe.example'): + resp = self.client.get_html(get_url('settings_handler', course_key, 'course_key_string')) + self.assertEqual(resp.status_code, 302) # noqa: PT009 + with override_settings(COURSE_AUTHORING_MICROFRONTEND_URL='https://mfe.example'): + resp = self.client.get_html(get_url('grading_handler', course_key, 'course_key_string')) + self.assertEqual(resp.status_code, 302) # noqa: PT009 + with override_settings(COURSE_AUTHORING_MICROFRONTEND_URL='https://mfe.example'): + resp = self.client.get_html(get_url('advanced_settings_handler', course_key, 'course_key_string')) + self.assertEqual(resp.status_code, 302) # noqa: PT009 test_get_json('textbooks_list_handler') # Test that studio updates load @@ -1517,19 +1518,19 @@ def test_get_json(handler): resp = self.client.get( get_url('cms.djangoapps.contentstore:v0:course_tab_list', course_key, 'course_id') ) - self.assertEqual(resp.status_code, 200) + self.assertEqual(resp.status_code, 200) # noqa: PT009 # go look at the Edit page unit_key = course_key.make_usage_key('vertical', 'test_vertical') with override_waffle_flag(toggles.LEGACY_STUDIO_UNIT_EDITOR, True): resp = self.client.get_html(get_url('container_handler', unit_key)) - self.assertEqual(resp.status_code, 200) + self.assertEqual(resp.status_code, 200) # noqa: PT009 def delete_item(category, name): """ Helper method for testing the deletion of an xblock item. """ item_key = course_key.make_usage_key(category, name) resp = self.client.delete(get_url('xblock_handler', item_key)) - self.assertEqual(resp.status_code, 204) + self.assertEqual(resp.status_code, 204) # noqa: PT009 # delete a component delete_item(category='html', name='test_html') @@ -1553,7 +1554,7 @@ def test_import_into_new_course_id(self): # we should have a number of blocks in there # we can't specify an exact number since it'll always be changing - self.assertGreater(len(blocks), 10) + self.assertGreater(len(blocks), 10) # noqa: PT009 # # test various re-namespacing elements @@ -1562,10 +1563,10 @@ def test_import_into_new_course_id(self): # first check PDF textbooks, to make sure the url paths got updated course_block = self.store.get_course(target_id) - self.assertEqual(len(course_block.pdf_textbooks), 1) - self.assertEqual(len(course_block.pdf_textbooks[0]["chapters"]), 2) - self.assertEqual(course_block.pdf_textbooks[0]["chapters"][0]["url"], '/static/Chapter1.pdf') - self.assertEqual(course_block.pdf_textbooks[0]["chapters"][1]["url"], '/static/Chapter2.pdf') + self.assertEqual(len(course_block.pdf_textbooks), 1) # noqa: PT009 + self.assertEqual(len(course_block.pdf_textbooks[0]["chapters"]), 2) # noqa: PT009 + self.assertEqual(course_block.pdf_textbooks[0]["chapters"][0]["url"], '/static/Chapter1.pdf') # noqa: PT009 + self.assertEqual(course_block.pdf_textbooks[0]["chapters"][1]["url"], '/static/Chapter2.pdf') # noqa: PT009 def test_import_into_new_course_id_wiki_slug_renamespacing(self): # If reimporting into the same course change the wiki_slug. @@ -1584,7 +1585,7 @@ def test_import_into_new_course_id_wiki_slug_renamespacing(self): # Import a course with wiki_slug == location.course import_course_from_xml(self.store, self.user.id, TEST_DATA_DIR, ['toy'], target_id=target_id) course_block = self.store.get_course(target_id) - self.assertEqual(course_block.wiki_slug, 'edX.toy.2012_Fall') + self.assertEqual(course_block.wiki_slug, 'edX.toy.2012_Fall') # noqa: PT009 # But change the wiki_slug if it is a different course. target_id = self.store.make_course_key('MITx', '111', '2013_Spring') @@ -1599,12 +1600,12 @@ def test_import_into_new_course_id_wiki_slug_renamespacing(self): # Import a course with wiki_slug == location.course import_course_from_xml(self.store, self.user.id, TEST_DATA_DIR, ['toy'], target_id=target_id) course_block = self.store.get_course(target_id) - self.assertEqual(course_block.wiki_slug, 'MITx.111.2013_Spring') + self.assertEqual(course_block.wiki_slug, 'MITx.111.2013_Spring') # noqa: PT009 # Now try importing a course with wiki_slug == '{0}.{1}.{2}'.format(location.org, location.course, location.run) import_course_from_xml(self.store, self.user.id, TEST_DATA_DIR, ['two_toys'], target_id=target_id) course_block = self.store.get_course(target_id) - self.assertEqual(course_block.wiki_slug, 'MITx.111.2013_Spring') + self.assertEqual(course_block.wiki_slug, 'MITx.111.2013_Spring') # noqa: PT009 def test_import_metadata_with_attempts_empty_string(self): import_course_from_xml(self.store, self.user.id, TEST_DATA_DIR, ['simple'], create_if_not_present=True) @@ -1618,7 +1619,7 @@ def test_import_metadata_with_attempts_empty_string(self): pass # make sure we found the item (e.g. it didn't error while loading) - self.assertTrue(did_load_item) + self.assertTrue(did_load_item) # noqa: PT009 def test_forum_id_generation(self): """ @@ -1637,11 +1638,11 @@ def test_forum_id_generation(self): refetched = self.store.get_item(discussion_item.location) # and make sure the same discussion items have the same discussion ids - self.assertEqual(fetched.discussion_id, discussion_item.discussion_id) - self.assertEqual(fetched.discussion_id, refetched.discussion_id) + self.assertEqual(fetched.discussion_id, discussion_item.discussion_id) # noqa: PT009 + self.assertEqual(fetched.discussion_id, refetched.discussion_id) # noqa: PT009 # and make sure that the id isn't the old "$$GUID$$" - self.assertNotEqual(discussion_item.discussion_id, '$$GUID$$') + self.assertNotEqual(discussion_item.discussion_id, '$$GUID$$') # noqa: PT009 def test_metadata_inheritance(self): course_items = import_course_from_xml( @@ -1653,10 +1654,10 @@ def test_metadata_inheritance(self): # let's assert on the metadata_inheritance on an existing vertical for vertical in verticals: - self.assertEqual(course.xqa_key, vertical.xqa_key) - self.assertEqual(course.start, vertical.start) + self.assertEqual(course.xqa_key, vertical.xqa_key) # noqa: PT009 + self.assertEqual(course.start, vertical.start) # noqa: PT009 - self.assertGreater(len(verticals), 0) + self.assertGreater(len(verticals), 0) # noqa: PT009 # crate a new block and add it as a child to a vertical parent = verticals[0] @@ -1668,11 +1669,11 @@ def test_metadata_inheritance(self): new_block = self.store.get_item(new_block.location) # check for grace period definition which should be defined at the course level - self.assertEqual(parent.graceperiod, new_block.graceperiod) - self.assertEqual(parent.start, new_block.start) - self.assertEqual(course.start, new_block.start) + self.assertEqual(parent.graceperiod, new_block.graceperiod) # noqa: PT009 + self.assertEqual(parent.start, new_block.start) # noqa: PT009 + self.assertEqual(course.start, new_block.start) # noqa: PT009 - self.assertEqual(course.xqa_key, new_block.xqa_key) + self.assertEqual(course.xqa_key, new_block.xqa_key) # noqa: PT009 # # now let's define an override at the leaf node level @@ -1683,26 +1684,26 @@ def test_metadata_inheritance(self): # flush the cache and refetch new_block = self.store.get_item(new_block.location) - self.assertEqual(timedelta(1), new_block.graceperiod) + self.assertEqual(timedelta(1), new_block.graceperiod) # noqa: PT009 def test_default_metadata_inheritance(self): course = CourseFactory.create() vertical = BlockFactory.create(parent_location=course.location) course.children.append(vertical) # in memory - self.assertIsNotNone(course.start) - self.assertEqual(course.start, vertical.start) - self.assertEqual(course.textbooks, []) - self.assertIn('GRADER', course.grading_policy) - self.assertIn('GRADE_CUTOFFS', course.grading_policy) + self.assertIsNotNone(course.start) # noqa: PT009 + self.assertEqual(course.start, vertical.start) # noqa: PT009 + self.assertEqual(course.textbooks, []) # noqa: PT009 + self.assertIn('GRADER', course.grading_policy) # noqa: PT009 + self.assertIn('GRADE_CUTOFFS', course.grading_policy) # noqa: PT009 # by fetching fetched_course = self.store.get_item(course.location) fetched_item = self.store.get_item(vertical.location) - self.assertIsNotNone(fetched_course.start) - self.assertEqual(course.start, fetched_course.start) - self.assertEqual(fetched_course.start, fetched_item.start) - self.assertEqual(course.textbooks, fetched_course.textbooks) + self.assertIsNotNone(fetched_course.start) # noqa: PT009 + self.assertEqual(course.start, fetched_course.start) # noqa: PT009 + self.assertEqual(fetched_course.start, fetched_item.start) # noqa: PT009 + self.assertEqual(course.textbooks, fetched_course.textbooks) # noqa: PT009 def test_image_import(self): """Test backwards compatibilty of course image.""" @@ -1721,7 +1722,7 @@ def test_image_import(self): course = courses[0] # Make sure the course image is set to the right place - self.assertEqual(course.course_image, 'images_course_image.jpg') + self.assertEqual(course.course_image, 'images_course_image.jpg') # noqa: PT009 # Ensure that the imported course image is present -- this shouldn't raise an exception asset_key = course.id.make_asset_key('asset', course.course_image) @@ -1741,13 +1742,13 @@ def test_wiki_slug(self): course_key = _get_course_id(self.store, self.course_data) _create_course(self, course_key, self.course_data) course_block = self.store.get_course(course_key) - self.assertEqual(course_block.wiki_slug, 'MITx.111.2013_Spring') + self.assertEqual(course_block.wiki_slug, 'MITx.111.2013_Spring') # noqa: PT009 def test_course_handler_with_invalid_course_key_string(self): """Test viewing the course overview page with invalid course id""" response = self.client.get_html('/course/edX/test') - self.assertEqual(response.status_code, 404) + self.assertEqual(response.status_code, 404) # noqa: PT009 class MetadataSaveTestCase(ContentStoreTestCase): @@ -1780,7 +1781,7 @@ def test_metadata_not_persistence(self): Test that blocks which set metadata fields in their constructor are correctly deleted. """ - self.assertIn('html5_sources', own_metadata(self.video_block)) + self.assertIn('html5_sources', own_metadata(self.video_block)) # noqa: PT009 attrs_to_strip = { 'show_captions', 'youtube_id_1_0', @@ -1798,11 +1799,11 @@ def test_metadata_not_persistence(self): for field_name in attrs_to_strip: delattr(self.video_block, field_name) - self.assertNotIn('html5_sources', own_metadata(self.video_block)) + self.assertNotIn('html5_sources', own_metadata(self.video_block)) # noqa: PT009 self.store.update_item(self.video_block, self.user.id) block = self.store.get_item(location) - self.assertNotIn('html5_sources', own_metadata(block)) + self.assertNotIn('html5_sources', own_metadata(block)) # noqa: PT009 def test_metadata_persistence(self): # TODO: create the same test as `test_metadata_not_persistence`, @@ -1841,10 +1842,10 @@ def post_rerun_request( response = self.client.ajax_post(course_url, rerun_course_data) # verify response - self.assertEqual(response.status_code, response_code) + self.assertEqual(response.status_code, response_code) # noqa: PT009 if not expect_error: json_resp = parse_json(response) - self.assertNotIn('ErrMsg', json_resp) + self.assertNotIn('ErrMsg', json_resp) # noqa: PT009 destination_course_key = CourseKey.from_string(json_resp['destination_course_key']) return destination_course_key @@ -1886,10 +1887,10 @@ def verify_rerun_course(self, source_course_key, destination_course_key, destina 'should_display': True, } for field_name, expected_value in expected_states.items(): - self.assertEqual(getattr(rerun_state, field_name), expected_value) + self.assertEqual(getattr(rerun_state, field_name), expected_value) # noqa: PT009 # Verify that the creator is now enrolled in the course. - self.assertTrue(CourseEnrollment.is_enrolled(self.user, destination_course_key)) + self.assertTrue(CourseEnrollment.is_enrolled(self.user, destination_course_key)) # noqa: PT009 # Verify both courses are in the course listing section self.assertInCourseListing(source_course_key) @@ -1904,7 +1905,7 @@ def test_rerun_course_no_videos_in_val(self): self.verify_rerun_course(source_course.id, destination_course_key, self.destination_course_data['display_name']) videos, __ = get_videos_for_course(str(destination_course_key)) videos = list(videos) - self.assertEqual(0, len(videos)) + self.assertEqual(0, len(videos)) # noqa: PT009 self.assertInCourseListing(destination_course_key) def test_rerun_course_video_upload_token(self): @@ -1924,8 +1925,8 @@ def test_rerun_course_video_upload_token(self): # Verify video upload pipeline is empty. source_course = self.store.get_course(source_course.id) new_course = self.store.get_course(destination_course_key) - self.assertDictEqual(source_course.video_upload_pipeline, {"course_video_upload_token": 'test-token'}) - self.assertEqual(new_course.video_upload_pipeline, {}) + self.assertDictEqual(source_course.video_upload_pipeline, {"course_video_upload_token": 'test-token'}) # noqa: PT009 # pylint: disable=line-too-long + self.assertEqual(new_course.video_upload_pipeline, {}) # noqa: PT009 def test_rerun_course_success(self): source_course = CourseFactory.create(default_store=ModuleStoreEnum.Type.split) @@ -1946,12 +1947,12 @@ def test_rerun_course_success(self): source_videos = list(videos) videos, __ = get_videos_for_course(str(destination_course_key)) target_videos = list(videos) - self.assertEqual(1, len(source_videos)) - self.assertEqual(source_videos, target_videos) + self.assertEqual(1, len(source_videos)) # noqa: PT009 + self.assertEqual(source_videos, target_videos) # noqa: PT009 # Verify that video upload token is empty for rerun. new_course = self.store.get_course(destination_course_key) - self.assertEqual(new_course.video_upload_pipeline, {}) + self.assertEqual(new_course.video_upload_pipeline, {}) # noqa: PT009 def test_rerun_course_resets_advertised_date(self): source_course = CourseFactory.create( @@ -1961,7 +1962,7 @@ def test_rerun_course_resets_advertised_date(self): destination_course_key = self.post_rerun_request(source_course.id) destination_course = self.store.get_course(destination_course_key) - self.assertEqual(None, destination_course.advertised_start) + self.assertEqual(None, destination_course.advertised_start) # noqa: PT009 def test_rerun_of_rerun(self): source_course = CourseFactory.create(default_store=ModuleStoreEnum.Type.split) @@ -1982,11 +1983,11 @@ def test_rerun_course_fail_no_source_course(self): # Verify that the course rerun action is marked failed rerun_state = CourseRerunState.objects.find_first(course_key=destination_course_key) - self.assertEqual(rerun_state.state, CourseRerunUIStateManager.State.FAILED) - self.assertIn("Cannot find a course at", rerun_state.message) + self.assertEqual(rerun_state.state, CourseRerunUIStateManager.State.FAILED) # noqa: PT009 + self.assertIn("Cannot find a course at", rerun_state.message) # noqa: PT009 # Verify that the creator is not enrolled in the course. - self.assertFalse(CourseEnrollment.is_enrolled(self.user, non_existent_course_key)) + self.assertFalse(CourseEnrollment.is_enrolled(self.user, non_existent_course_key)) # noqa: PT009 # Verify that the existing course continues to be in the course listings self.assertInCourseListing(existent_course_key) @@ -2007,7 +2008,7 @@ def test_rerun_course_fail_duplicate_course(self): ) # Verify that the course rerun action doesn't exist - with self.assertRaises(CourseActionStateItemNotFoundError): + with self.assertRaises(CourseActionStateItemNotFoundError): # noqa: PT027 CourseRerunState.objects.find_first(course_key=destination_course_key) # Verify that the existing course continues to be in the course listing @@ -2030,8 +2031,8 @@ def test_rerun_error(self): source_course = CourseFactory.create() destination_course_key = self.post_rerun_request(source_course.id) rerun_state = CourseRerunState.objects.find_first(course_key=destination_course_key) - self.assertEqual(rerun_state.state, CourseRerunUIStateManager.State.FAILED) - self.assertIn(error_message, rerun_state.message) + self.assertEqual(rerun_state.state, CourseRerunUIStateManager.State.FAILED) # noqa: PT009 + self.assertIn(error_message, rerun_state.message) # noqa: PT009 def test_rerun_error_trunc_message(self): """ @@ -2049,9 +2050,9 @@ def test_rerun_error_trunc_message(self): with mock.patch('traceback.format_exc', return_value=message_too_long): destination_course_key = self.post_rerun_request(source_course.id) rerun_state = CourseRerunState.objects.find_first(course_key=destination_course_key) - self.assertEqual(rerun_state.state, CourseRerunUIStateManager.State.FAILED) - self.assertTrue(rerun_state.message.endswith("traceback")) - self.assertEqual(len(rerun_state.message), CourseRerunState.MAX_MESSAGE_LENGTH) + self.assertEqual(rerun_state.state, CourseRerunUIStateManager.State.FAILED) # noqa: PT009 + self.assertTrue(rerun_state.message.endswith("traceback")) # noqa: PT009 + self.assertEqual(len(rerun_state.message), CourseRerunState.MAX_MESSAGE_LENGTH) # noqa: PT009 def test_rerun_course_wiki_slug(self): """ @@ -2072,7 +2073,7 @@ def test_rerun_course_wiki_slug(self): source_course = self.store.get_course(source_course_key) # Verify created course's wiki_slug. - self.assertEqual(source_course.wiki_slug, source_wiki_slug) + self.assertEqual(source_course.wiki_slug, source_wiki_slug) # noqa: PT009 destination_course_data = course_data destination_course_data['run'] = '2013_Rerun' @@ -2083,12 +2084,12 @@ def test_rerun_course_wiki_slug(self): self.verify_rerun_course(source_course.id, destination_course_key, destination_course_data['display_name']) destination_course = self.store.get_course(destination_course_key) - destination_wiki_slug = '{}.{}.{}'.format( + destination_wiki_slug = '{}.{}.{}'.format( # noqa: UP032 destination_course.id.org, destination_course.id.course, destination_course.id.run ) # Verify rerun course's wiki_slug. - self.assertEqual(destination_course.wiki_slug, destination_wiki_slug) + self.assertEqual(destination_course.wiki_slug, destination_wiki_slug) # noqa: PT009 class ContentLicenseTest(ContentStoreTestCase): @@ -2106,7 +2107,7 @@ def test_course_license_export(self): run_file_path = root_dir / "test_license" / "course" / fname with run_file_path.open() as f: run_xml = etree.parse(f) - self.assertEqual(run_xml.getroot().get("license"), "creative-commons: BY SA") + self.assertEqual(run_xml.getroot().get("license"), "creative-commons: BY SA") # noqa: PT009 def test_video_license_export(self): content_store = contentstore() @@ -2120,16 +2121,16 @@ def test_video_license_export(self): video_file_path = root_dir / "test_license" / "video" / fname with video_file_path.open() as f: video_xml = etree.parse(f) - self.assertEqual(video_xml.getroot().get("license"), "all-rights-reserved") + self.assertEqual(video_xml.getroot().get("license"), "all-rights-reserved") # noqa: PT009 def test_license_import(self): course_items = import_course_from_xml( self.store, self.user.id, TEST_DATA_DIR, ['toy'], create_if_not_present=True ) course = course_items[0] - self.assertEqual(course.license, "creative-commons: BY") + self.assertEqual(course.license, "creative-commons: BY") # noqa: PT009 videos = self.store.get_items(course.id, qualifiers={'category': 'video'}) - self.assertEqual(videos[0].license, "all-rights-reserved") + self.assertEqual(videos[0].license, "all-rights-reserved") # noqa: PT009 class EntryPageTestCase(TestCase): @@ -2143,14 +2144,15 @@ def setUp(self): def _test_page(self, page, status_code=200): resp = self.client.get_html(page) - self.assertEqual(resp.status_code, status_code) + self.assertEqual(resp.status_code, status_code) # noqa: PT009 - @override_waffle_flag(toggles.LEGACY_STUDIO_LOGGED_OUT_HOME, True) - def test_how_it_works_legacy(self): - self._test_page("/howitworks") + def test_homepage_redirects_to_home(self): + # Root URL permanently redirects to studio home (sign-in page). + self._test_page("/", 301) - def test_how_it_works_redirect_to_signin(self): - self._test_page("/howitworks", 302) + def test_howitworks_redirects_to_home(self): + # Legacy landing page permanently redirects; preserves bookmarks. + self._test_page("/howitworks", 301) def test_signup(self): # deprecated signup url redirects to LMS register. @@ -2177,10 +2179,10 @@ def _create_course(test, course_key, course_data): """ course_url = get_url('course_handler', course_key, 'course_key_string') response = test.client.ajax_post(course_url, course_data) - test.assertEqual(response.status_code, 200) + test.assertEqual(response.status_code, 200) # noqa: PT009 data = parse_json(response) - test.assertNotIn('ErrMsg', data) - test.assertEqual(data['url'], course_url) + test.assertNotIn('ErrMsg', data) # noqa: PT009 + test.assertEqual(data['url'], course_url) # noqa: PT009 return data diff --git a/cms/djangoapps/contentstore/tests/test_core_caching.py b/cms/djangoapps/contentstore/tests/test_core_caching.py index e6b23c2deeed..956397214a64 100644 --- a/cms/djangoapps/contentstore/tests/test_core_caching.py +++ b/cms/djangoapps/contentstore/tests/test_core_caching.py @@ -32,15 +32,15 @@ class CachingTestCase(TestCase): def test_put_and_get(self): set_cached_content(self.mockAsset) - self.assertEqual(self.mockAsset.content, get_cached_content(self.unicodeLocation).content, + self.assertEqual(self.mockAsset.content, get_cached_content(self.unicodeLocation).content, # noqa: PT009 'should be stored in cache with unicodeLocation') - self.assertEqual(self.mockAsset.content, get_cached_content(self.nonUnicodeLocation).content, + self.assertEqual(self.mockAsset.content, get_cached_content(self.nonUnicodeLocation).content, # noqa: PT009 'should be stored in cache with nonUnicodeLocation') def test_delete(self): set_cached_content(self.mockAsset) del_cached_content(self.nonUnicodeLocation) - self.assertEqual(None, get_cached_content(self.unicodeLocation), + self.assertEqual(None, get_cached_content(self.unicodeLocation), # noqa: PT009 'should not be stored in cache with unicodeLocation') - self.assertEqual(None, get_cached_content(self.nonUnicodeLocation), + self.assertEqual(None, get_cached_content(self.nonUnicodeLocation), # noqa: PT009 'should not be stored in cache with nonUnicodeLocation') diff --git a/cms/djangoapps/contentstore/tests/test_course_create_rerun.py b/cms/djangoapps/contentstore/tests/test_course_create_rerun.py index a03e8e9cd2f5..fbcf56067ac1 100644 --- a/cms/djangoapps/contentstore/tests/test_course_create_rerun.py +++ b/cms/djangoapps/contentstore/tests/test_course_create_rerun.py @@ -14,20 +14,22 @@ from django.test.client import RequestFactory from django.urls import reverse from opaque_keys.edx.keys import CourseKey +from openedx_authz.constants.roles import COURSE_EDITOR from organizations.api import add_organization, get_course_organizations, get_organization_by_short_name from organizations.exceptions import InvalidOrganizationException from organizations.models import Organization -from xmodule.course_block import CourseFields -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase -from xmodule.modulestore.tests.factories import CourseFactory from cms.djangoapps.contentstore.tests.utils import AjaxEnabledTestClient, parse_json +from cms.djangoapps.contentstore.views.course import get_allowed_organizations, user_can_create_organizations from cms.djangoapps.course_creators.admin import CourseCreatorAdmin from cms.djangoapps.course_creators.models import CourseCreator -from cms.djangoapps.contentstore.views.course import get_allowed_organizations, user_can_create_organizations from common.djangoapps.student.auth import update_org_role from common.djangoapps.student.roles import CourseInstructorRole, CourseStaffRole, OrgContentCreatorRole from common.djangoapps.student.tests.factories import AdminFactory, UserFactory +from openedx.core.djangoapps.authz.tests.mixins import CourseAuthoringAuthzTestMixin +from xmodule.course_block import CourseFields +from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase +from xmodule.modulestore.tests.factories import CourseFactory def mock_render_to_string(template_name, context): @@ -99,19 +101,19 @@ def test_rerun(self): 'org': self.source_course_key.org, 'course': self.source_course_key.course, 'run': 'copy', 'display_name': 'not the same old name', }) - self.assertEqual(response.status_code, 200) + self.assertEqual(response.status_code, 200) # noqa: PT009 data = parse_json(response) dest_course_key = CourseKey.from_string(data['destination_course_key']) - self.assertEqual(dest_course_key.run, 'copy') + self.assertEqual(dest_course_key.run, 'copy') # noqa: PT009 dest_course = self.store.get_course(dest_course_key) - self.assertEqual(dest_course.start, CourseFields.start.default) - self.assertEqual(dest_course.end, None) - self.assertEqual(dest_course.enrollment_start, None) - self.assertEqual(dest_course.enrollment_end, None) + self.assertEqual(dest_course.start, CourseFields.start.default) # noqa: PT009 + self.assertEqual(dest_course.end, None) # noqa: PT009 + self.assertEqual(dest_course.enrollment_start, None) # noqa: PT009 + self.assertEqual(dest_course.enrollment_end, None) # noqa: PT009 course_orgs = get_course_organizations(dest_course_key) - self.assertEqual(len(course_orgs), 1) - self.assertEqual(course_orgs[0]['short_name'], self.source_course_key.org) + self.assertEqual(len(course_orgs), 1) # noqa: PT009 + self.assertEqual(course_orgs[0]['short_name'], self.source_course_key.org) # noqa: PT009 def test_newly_created_course_has_web_certs_enabled(self): """ @@ -123,11 +125,11 @@ def test_newly_created_course_has_web_certs_enabled(self): 'display_name': 'Course with web certs enabled', 'run': '2015_T2' }) - self.assertEqual(response.status_code, 200) + self.assertEqual(response.status_code, 200) # noqa: PT009 data = parse_json(response) new_course_key = CourseKey.from_string(data['course_key']) course = self.store.get_course(new_course_key) - self.assertTrue(course.cert_html_view_enabled) + self.assertTrue(course.cert_html_view_enabled) # noqa: PT009 def test_course_creation_for_unknown_organization_relaxed(self): """ @@ -135,7 +137,7 @@ def test_course_creation_for_unknown_organization_relaxed(self): creating a course-run with an unknown org slug will create an organization and organization-course linkage in the system. """ - with self.assertRaises(InvalidOrganizationException): + with self.assertRaises(InvalidOrganizationException): # noqa: PT027 get_organization_by_short_name("orgX") response = self.client.ajax_post(self.course_create_rerun_url, { 'org': 'orgX', @@ -143,13 +145,13 @@ def test_course_creation_for_unknown_organization_relaxed(self): 'display_name': 'Course with web certs enabled', 'run': '2015_T2' }) - self.assertEqual(response.status_code, 200) - self.assertIsNotNone(get_organization_by_short_name("orgX")) + self.assertEqual(response.status_code, 200) # noqa: PT009 + self.assertIsNotNone(get_organization_by_short_name("orgX")) # noqa: PT009 data = parse_json(response) new_course_key = CourseKey.from_string(data['course_key']) course_orgs = get_course_organizations(new_course_key) - self.assertEqual(len(course_orgs), 1) - self.assertEqual(course_orgs[0]['short_name'], 'orgX') + self.assertEqual(len(course_orgs), 1) # noqa: PT009 + self.assertEqual(course_orgs[0]['short_name'], 'orgX') # noqa: PT009 @override_settings(ORGANIZATIONS_AUTOCREATE=False) def test_course_creation_for_unknown_organization_strict(self): @@ -163,11 +165,11 @@ def test_course_creation_for_unknown_organization_strict(self): 'display_name': 'Course with web certs enabled', 'run': '2015_T2' }) - self.assertEqual(response.status_code, 400) - with self.assertRaises(InvalidOrganizationException): + self.assertEqual(response.status_code, 400) # noqa: PT009 + with self.assertRaises(InvalidOrganizationException): # noqa: PT027 get_organization_by_short_name("orgX") data = parse_json(response) - self.assertIn('Organization you selected does not exist in the system', data['error']) + self.assertIn('Organization you selected does not exist in the system', data['error']) # noqa: PT009 @ddt.data(True, False) def test_course_creation_for_known_organization(self, organizations_autocreate): @@ -186,12 +188,12 @@ def test_course_creation_for_known_organization(self, organizations_autocreate): 'display_name': 'Course with web certs enabled', 'run': '2015_T2' }) - self.assertEqual(response.status_code, 200) + self.assertEqual(response.status_code, 200) # noqa: PT009 data = parse_json(response) new_course_key = CourseKey.from_string(data['course_key']) course_orgs = get_course_organizations(new_course_key) - self.assertEqual(len(course_orgs), 1) - self.assertEqual(course_orgs[0]['short_name'], 'orgX') + self.assertEqual(len(course_orgs), 1) # noqa: PT009 + self.assertEqual(course_orgs[0]['short_name'], 'orgX') # noqa: PT009 @override_settings(FEATURES={'ENABLE_CREATOR_GROUP': True}) def test_course_creation_when_user_not_in_org(self): @@ -204,7 +206,7 @@ def test_course_creation_when_user_not_in_org(self): 'display_name': 'Course with web certs enabled', 'run': '2021_T1' }) - self.assertEqual(response.status_code, 403) + self.assertEqual(response.status_code, 403) # noqa: PT009 @override_settings(FEATURES={'ENABLE_CREATOR_GROUP': True}) @mock.patch( @@ -224,14 +226,14 @@ def test_course_creation_when_user_in_org_with_creator_role(self): self.course_creator_entry.all_organizations = True self.course_creator_entry.state = CourseCreator.GRANTED self.creator_admin.save_model(self.request, self.course_creator_entry, None, True) - self.assertIn(self.source_course_key.org, get_allowed_organizations(self.user)) + self.assertIn(self.source_course_key.org, get_allowed_organizations(self.user)) # noqa: PT009 response = self.client.ajax_post(self.course_create_rerun_url, { 'org': self.source_course_key.org, 'number': 'CS101', 'display_name': 'Course with web certs enabled', 'run': '2021_T1' }) - self.assertEqual(response.status_code, 200) + self.assertEqual(response.status_code, 200) # noqa: PT009 @override_settings(FEATURES={'ENABLE_CREATOR_GROUP': True}) @mock.patch( @@ -250,15 +252,15 @@ def test_course_creation_with_all_org_checked(self): self.course_creator_entry.all_organizations = True self.course_creator_entry.state = CourseCreator.GRANTED self.creator_admin.save_model(self.request, self.course_creator_entry, None, True) - self.assertIn(self.source_course_key.org, get_allowed_organizations(self.user)) - self.assertFalse(user_can_create_organizations(self.user)) + self.assertIn(self.source_course_key.org, get_allowed_organizations(self.user)) # noqa: PT009 + self.assertFalse(user_can_create_organizations(self.user)) # noqa: PT009 response = self.client.ajax_post(self.course_create_rerun_url, { 'org': self.source_course_key.org, 'number': 'CS101', 'display_name': 'Course with web certs enabled', 'run': '2021_T1' }) - self.assertEqual(response.status_code, 200) + self.assertEqual(response.status_code, 200) # noqa: PT009 @override_settings(FEATURES={'ENABLE_CREATOR_GROUP': True}) @mock.patch( @@ -279,15 +281,15 @@ def test_course_creation_with_permission_for_specific_organization(self): self.creator_admin.save_model(self.request, self.course_creator_entry, None, True) dc_org_object = Organization.objects.get(name='Test Organization') self.course_creator_entry.organizations.add(dc_org_object) - self.assertIn(self.source_course_key.org, get_allowed_organizations(self.user)) - self.assertFalse(user_can_create_organizations(self.user)) + self.assertIn(self.source_course_key.org, get_allowed_organizations(self.user)) # noqa: PT009 + self.assertFalse(user_can_create_organizations(self.user)) # noqa: PT009 response = self.client.ajax_post(self.course_create_rerun_url, { 'org': self.source_course_key.org, 'number': 'CS101', 'display_name': 'Course with web certs enabled', 'run': '2021_T1' }) - self.assertEqual(response.status_code, 200) + self.assertEqual(response.status_code, 200) # noqa: PT009 @override_settings(FEATURES={'ENABLE_CREATOR_GROUP': True}) @mock.patch( @@ -315,15 +317,15 @@ def test_course_creation_without_permission_for_specific_organization(self): # When the user tries to create course under `Test Organization` it throws a 403. dc_org_object = Organization.objects.get(name='DC') self.course_creator_entry.organizations.add(dc_org_object) - self.assertNotIn(self.source_course_key.org, get_allowed_organizations(self.user)) - self.assertFalse(user_can_create_organizations(self.user)) + self.assertNotIn(self.source_course_key.org, get_allowed_organizations(self.user)) # noqa: PT009 + self.assertFalse(user_can_create_organizations(self.user)) # noqa: PT009 response = self.client.ajax_post(self.course_create_rerun_url, { 'org': self.source_course_key.org, 'number': 'CS101', 'display_name': 'Course with web certs enabled', 'run': '2021_T1' }) - self.assertEqual(response.status_code, 403) + self.assertEqual(response.status_code, 403) # noqa: PT009 @ddt.data(*product([True, False], [True, False])) @ddt.unpack @@ -360,7 +362,7 @@ def test_default_enable_flexible_peer_openassessments_on_rerun( }) # Then the process completes successfully - self.assertEqual(response.status_code, 200) + self.assertEqual(response.status_code, 200) # noqa: PT009 data = parse_json(response) dest_course_key = CourseKey.from_string(data['destination_course_key']) @@ -368,10 +370,124 @@ def test_default_enable_flexible_peer_openassessments_on_rerun( # ... and our setting got enabled appropriately on our new course if mock_toggle_state: - self.assertTrue(dest_course.force_on_flexible_peer_openassessments) + self.assertTrue(dest_course.force_on_flexible_peer_openassessments) # noqa: PT009 # ... or preserved if the default enable setting is not on else: - self.assertEqual( + self.assertEqual( # noqa: PT009 source_course.force_on_flexible_peer_openassessments, dest_course.force_on_flexible_peer_openassessments ) + + +class TestCourseHandlerAuthz( + CourseAuthoringAuthzTestMixin, + ModuleStoreTestCase, +): + """ + AuthZ integration tests for course_handler using real RBAC (no mocks). + """ + + def setUp(self): + super().setUp() + + self.url = reverse("course_handler") + + # Create a base course to extract org + self.course = CourseFactory.create() + self.course_key = self.course.id + self.org = self.course_key.org + + # If your policy expects this format, keep it + self.org_key = f"course-v1:{self.org}+*" + + self.authorized_client = AjaxEnabledTestClient() + self.authorized_client.login( + username=self.authorized_user.username, + password=self.password, + ) + + self.unauthorized_client = AjaxEnabledTestClient() + self.unauthorized_client.login( + username=self.unauthorized_user.username, + password=self.password, + ) + self.authorized_staff_client = AjaxEnabledTestClient() + self.authorized_staff_client.login( + username=self.staff_user.username, + password=self.password, + ) + + # ------------------------------------------------------------ + # CREATE COURSE -- Non-staff users and existing Organization + # ------------------------------------------------------------ + @override_settings(FEATURES={"DISABLE_COURSE_CREATION": False}) + def test_create_course_unauthorized(self): + """ + User without role cannot create course. + """ + + response = self.unauthorized_client.ajax_post(self.url, { + "org": self.org, + "number": "CS101", + "display_name": "Authz Course", + "run": "2026_T1", + }) + + assert response.status_code == 403 + + @override_settings(FEATURES={"DISABLE_COURSE_CREATION": False}) + def test_create_course_unauthorized_with_role(self): + """ + User with role but without required permission cannot create course. + """ + + self.add_user_to_role_in_course( + self.unauthorized_user, + COURSE_EDITOR.external_key, + "course-v1:someotherorg+*", + ) + + response = self.unauthorized_client.ajax_post(self.url, { + "org": self.org, + "number": "CS101", + "display_name": "Authz Course", + "run": "2026_T1", + }) + + assert response.status_code == 403 + + # ------------------------------------------------------------ + # CREATE COURSE -- Staff users + # Only staff users can create course, and they can do it + # without an org role. + # ------------------------------------------------------------ + def test_create_course_staff(self): + """ + Staff user can create course. + """ + response = self.authorized_staff_client.ajax_post(self.url, { + "org": self.org, + "number": "CS101", + "display_name": "Authz Course", + "run": "2026_T1", + }) + + assert response.status_code == 200 + + # ------------------------------------------------------------ + # FEATURE FLAG + # ------------------------------------------------------------ + @override_settings(FEATURES={"DISABLE_COURSE_CREATION": True}) + def test_create_course_disabled_by_flag(self): + """ + Even authorized users cannot create course if feature flag is off. + """ + + response = self.authorized_staff_client.ajax_post(self.url, { + "org": self.org, + "number": "CS101", + "display_name": "Authz Course", + "run": "2026_T1", + }) + + assert response.status_code == 403 diff --git a/cms/djangoapps/contentstore/tests/test_course_listing.py b/cms/djangoapps/contentstore/tests/test_course_listing.py index 990eff83c922..9a56b8ec7c76 100644 --- a/cms/djangoapps/contentstore/tests/test_course_listing.py +++ b/cms/djangoapps/contentstore/tests/test_course_listing.py @@ -10,6 +10,9 @@ from ccx_keys.locator import CCXLocator from django.test import RequestFactory from opaque_keys.edx.locations import CourseLocator +from openedx_authz.api.data import OrgCourseOverviewGlobData +from openedx_authz.api.users import assign_role_to_user_in_scope +from openedx_authz.constants.roles import COURSE_DATA_RESEARCHER, COURSE_EDITOR, COURSE_STAFF from cms.djangoapps.contentstore.tests.utils import AjaxEnabledTestClient from cms.djangoapps.contentstore.utils import delete_course @@ -18,7 +21,7 @@ _accessible_courses_iter_for_tests, _accessible_courses_list_from_groups, _accessible_courses_summary_iter, - get_courses_accessible_to_user + get_courses_accessible_to_user, ) from common.djangoapps.course_action_state.models import CourseRerunState from common.djangoapps.student.models.user import CourseAccessRole @@ -29,19 +32,26 @@ GlobalStaff, OrgInstructorRole, OrgStaffRole, - UserBasedRole + UserBasedRole, ) from common.djangoapps.student.tests.factories import UserFactory +from openedx.core import toggles as core_toggles +from openedx.core.djangoapps.authz.tests.mixins import CourseAuthoringAuthzTestMixin from openedx.core.djangoapps.content.course_overviews.models import CourseOverview from openedx.core.djangoapps.content.course_overviews.tests.factories import CourseOverviewFactory from openedx.core.djangoapps.waffle_utils.testutils import WAFFLE_TABLES -from xmodule.modulestore import ModuleStoreEnum # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from openedx.core.djangolib.testing.utils import AUTHZ_TABLES +from xmodule.modulestore import ModuleStoreEnum # pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + ModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order TOTAL_COURSES_COUNT = 10 USER_COURSES_COUNT = 1 +QUERY_COUNT_TABLE_IGNORELIST = WAFFLE_TABLES + AUTHZ_TABLES + @ddt.ddt class TestCourseListing(ModuleStoreTestCase): @@ -98,20 +108,20 @@ def test_get_course_list(self): # get courses through iterating all courses courses_iter, __ = _accessible_courses_iter_for_tests(self.request) courses_list = list(courses_iter) - self.assertEqual(len(courses_list), 1) + self.assertEqual(len(courses_list), 1) # noqa: PT009 courses_summary_list, __ = _accessible_courses_summary_iter(self.request) - self.assertEqual(len(list(courses_summary_list)), 1) + self.assertEqual(len(list(courses_summary_list)), 1) # noqa: PT009 # get courses by reversing group name formats courses_list_by_groups, __ = _accessible_courses_list_from_groups(self.request) - self.assertEqual(len(courses_list_by_groups), 1) + self.assertEqual(len(courses_list_by_groups), 1) # noqa: PT009 # check both course lists have same courses course_keys_in_course_list = [course.id for course in courses_list] course_keys_in_courses_list_by_groups = [course.id for course in courses_list_by_groups] - self.assertEqual(course_keys_in_course_list, course_keys_in_courses_list_by_groups) + self.assertEqual(course_keys_in_course_list, course_keys_in_courses_list_by_groups) # noqa: PT009 def test_courses_list_with_ccx_courses(self): """ @@ -127,8 +137,8 @@ def test_courses_list_with_ccx_courses(self): # Test that CCX courses are filtered out. courses_list, __ = _accessible_courses_list_from_groups(self.request) - self.assertEqual(len(courses_list), 1) - self.assertNotIn( + self.assertEqual(len(courses_list), 1) # noqa: PT009 + self.assertNotIn( # noqa: PT009 ccx_course_key, [course.id for course in courses_list] ) @@ -139,7 +149,7 @@ def test_courses_list_with_ccx_courses(self): all_courses = (instructor_courses | staff_courses) # Verify that CCX course exists in access but filtered by `_accessible_courses_list_from_groups`. - self.assertIn( + self.assertIn( # noqa: PT009 ccx_course_key, [access.course_id for access in all_courses] ) @@ -151,7 +161,7 @@ def test_courses_list_with_ccx_courses(self): return_value=[mocked_ccx_course], ): courses_iter, __ = _accessible_courses_iter_for_tests(self.request) - self.assertEqual(len(list(courses_iter)), 0) + self.assertEqual(len(list(courses_iter)), 0) # noqa: PT009 def test_staff_course_listing(self): """ @@ -161,7 +171,7 @@ def test_staff_course_listing(self): # Assign & verify staff role to the user GlobalStaff().add_users(self.user) - self.assertTrue(GlobalStaff().has_user(self.user)) + self.assertTrue(GlobalStaff().has_user(self.user)) # noqa: PT009 # Create few courses for num in range(TOTAL_COURSES_COUNT): @@ -171,8 +181,8 @@ def test_staff_course_listing(self): # Fetch accessible courses list & verify their count courses_list_by_staff, __ = get_courses_accessible_to_user(self.request) - self.assertEqual(len(list(courses_list_by_staff)), TOTAL_COURSES_COUNT) - self.assertTrue(all(isinstance(course, CourseOverview) for course in courses_list_by_staff)) + self.assertEqual(len(list(courses_list_by_staff)), TOTAL_COURSES_COUNT) # noqa: PT009 + self.assertTrue(all(isinstance(course, CourseOverview) for course in courses_list_by_staff)) # noqa: PT009 # Now count the db queries for staff with self.assertNumQueries(2): @@ -190,7 +200,7 @@ def test_course_limited_staff_course_listing(self): # Add the user as a course_limited_staff on the course CourseLimitedStaffRole(course.id).add_users(self.user) - self.assertTrue(CourseLimitedStaffRole(course.id).has_user(self.user)) + self.assertTrue(CourseLimitedStaffRole(course.id).has_user(self.user)) # noqa: PT009 # Fetch accessible courses list & verify their count courses_list_by_staff, __ = get_courses_accessible_to_user(self.request) @@ -207,7 +217,7 @@ def test_org_limited_staff_course_listing(self): number=course_location.course, run=course_location.run ) - course = CourseOverviewFactory.create(id=course_location, org=course_location.org) + course = CourseOverviewFactory.create(id=course_location, org=course_location.org) # noqa: F841 # Add a user as course_limited_staff on the org # This is not possible using the course roles classes but is possible via Django admin so we @@ -231,21 +241,21 @@ def test_get_course_list_with_invalid_course_location(self): # get courses through iterating all courses courses_iter, __ = _accessible_courses_iter_for_tests(self.request) courses_list = list(courses_iter) - self.assertEqual(len(courses_list), 1) + self.assertEqual(len(courses_list), 1) # noqa: PT009 courses_summary_iter, __ = _accessible_courses_summary_iter(self.request) courses_summary_list = list(courses_summary_iter) - self.assertTrue(all(isinstance(course, CourseOverview) for course in courses_summary_list)) - self.assertEqual(len(courses_summary_list), 1) + self.assertTrue(all(isinstance(course, CourseOverview) for course in courses_summary_list)) # noqa: PT009 + self.assertEqual(len(courses_summary_list), 1) # noqa: PT009 # get courses by reversing group name formats courses_list_by_groups, __ = _accessible_courses_list_from_groups(self.request) - self.assertEqual(len(courses_list_by_groups), 1) + self.assertEqual(len(courses_list_by_groups), 1) # noqa: PT009 course_keys_in_course_list = [course.id for course in courses_list] course_keys_in_courses_list_by_groups = [course.id for course in courses_list_by_groups] # check course lists have same courses - self.assertEqual(course_keys_in_course_list, course_keys_in_courses_list_by_groups) + self.assertEqual(course_keys_in_course_list, course_keys_in_courses_list_by_groups) # noqa: PT009 # now delete this course and re-add user to instructor group of this course delete_course(course_key, self.user.id) course.delete() @@ -262,7 +272,7 @@ def test_get_course_list_with_invalid_course_location(self): courses_list_by_groups, __ = _accessible_courses_list_from_groups(self.request) # Test that course list returns no course - self.assertEqual( + self.assertEqual( # noqa: PT009 [len(list(courses_iter)), len(courses_list_by_groups), len(list(courses_summary_iter))], [0, 0, 0] ) @@ -289,24 +299,24 @@ def test_course_listing_performance(self): # get courses by iterating through all courses courses_iter, __ = _accessible_courses_iter_for_tests(self.request) - self.assertEqual(len(list(courses_iter)), USER_COURSES_COUNT) + self.assertEqual(len(list(courses_iter)), USER_COURSES_COUNT) # noqa: PT009 # again get courses by iterating through all courses courses_iter, __ = _accessible_courses_iter_for_tests(self.request) - self.assertEqual(len(list(courses_iter)), USER_COURSES_COUNT) + self.assertEqual(len(list(courses_iter)), USER_COURSES_COUNT) # noqa: PT009 # get courses by reversing django groups courses_list, __ = _accessible_courses_list_from_groups(self.request) - self.assertEqual(len(courses_list), USER_COURSES_COUNT) + self.assertEqual(len(courses_list), USER_COURSES_COUNT) # noqa: PT009 # again get courses by reversing django groups courses_list, __ = _accessible_courses_list_from_groups(self.request) - self.assertEqual(len(courses_list), USER_COURSES_COUNT) + self.assertEqual(len(courses_list), USER_COURSES_COUNT) # noqa: PT009 - with self.assertNumQueries(1, table_ignorelist=WAFFLE_TABLES): + with self.assertNumQueries(2, table_ignorelist=QUERY_COUNT_TABLE_IGNORELIST): _accessible_courses_list_from_groups(self.request) - with self.assertNumQueries(2, table_ignorelist=WAFFLE_TABLES): + with self.assertNumQueries(2, table_ignorelist=QUERY_COUNT_TABLE_IGNORELIST): _accessible_courses_iter_for_tests(self.request) def test_course_listing_errored_deleted_courses(self): @@ -322,7 +332,7 @@ def test_course_listing_errored_deleted_courses(self): course.delete() courses_list, __ = _accessible_courses_list_from_groups(self.request) - self.assertEqual(len(courses_list), 1, courses_list) + self.assertEqual(len(courses_list), 1, courses_list) # noqa: PT009 @ddt.data(OrgStaffRole('AwesomeOrg'), OrgInstructorRole('AwesomeOrg')) def test_course_listing_org_permissions(self, role): @@ -353,8 +363,8 @@ def test_course_listing_org_permissions(self, role): # Verify fetched accessible courses list is a list of CourseSummery instances and test expacted # course count is returned - self.assertEqual(len(list(courses_list)), 2) - self.assertTrue(all(isinstance(course, CourseOverview) for course in courses_list)) + self.assertEqual(len(list(courses_list)), 2) # noqa: PT009 + self.assertTrue(all(isinstance(course, CourseOverview) for course in courses_list)) # noqa: PT009 @ddt.data(OrgStaffRole(), OrgInstructorRole()) def test_course_listing_org_permissions_exception(self, role): @@ -364,7 +374,7 @@ def test_course_listing_org_permissions_exception(self, role): """ role.add_users(self.user) - with self.assertRaises(AccessListFallback): + with self.assertRaises(AccessListFallback): # noqa: PT027 _accessible_courses_list_from_groups(self.request) def test_course_listing_with_actions_in_progress(self): @@ -398,7 +408,427 @@ def _set_of_course_keys(course_list, key_attribute_name='id'): return {getattr(c, key_attribute_name) for c in course_list} found_courses, unsucceeded_course_actions = _accessible_courses_iter_for_tests(self.request) - self.assertSetEqual(_set_of_course_keys(courses + courses_in_progress), _set_of_course_keys(found_courses)) - self.assertSetEqual( + self.assertSetEqual(_set_of_course_keys(courses + courses_in_progress), _set_of_course_keys(found_courses)) # noqa: PT009 # pylint: disable=line-too-long + self.assertSetEqual( # noqa: PT009 _set_of_course_keys(courses_in_progress), _set_of_course_keys(unsucceeded_course_actions, 'course_key') ) + + +class TestCourseListingAuthz(CourseAuthoringAuthzTestMixin, ModuleStoreTestCase): + """ + Tests course listing using the new AuthZ authorization framework. + """ + + def setUp(self): + super().setUp() + + self.factory = RequestFactory() + + def _create_course(self, course_key): + """Helper method to create a course and its overview.""" + course = CourseFactory.create( + org=course_key.org, + number=course_key.course, + run=course_key.run, + ) + + return CourseOverviewFactory.create(id=course.id, org=course_key.org) + + def _mock_authz_toggle(self, enabled_keys): + def _is_enabled(course_key=None, **_): + return str(course_key) in enabled_keys + return _is_enabled + + def _make_request(self, user): + request = self.factory.get("/course") + request.user = user + return request + + def _create_courses(self): + """Helper method to create multiple courses for testing.""" + authz_keys = [ + CourseLocator("Org1", "Course1", "AuthzRun"), + CourseLocator("Org1", "Course2", "AuthzRun"), + CourseLocator("Org1", "Course3", "AuthzRun"), + ] + + legacy_keys = [ + CourseLocator("Org1", "Course1", "LegacyRun"), + CourseLocator("Org1", "Course2", "LegacyRun"), + CourseLocator("Org1", "Course3", "LegacyRun"), + ] + + authz_courses = [self._create_course(k) for k in authz_keys] + legacy_courses = [self._create_course(k) for k in legacy_keys] + + return authz_keys, legacy_keys, authz_courses, legacy_courses + + def test_course_listing_with_course_staff_authz_permission(self): + """ + Create courses and assign access to only some of them to the user. + Verify that only those courses are returned in the course listing. + Using COURSE_STAFF role here. + """ + course_key_1 = CourseLocator("Org1", "Course1", "Run1") + course1 = self._create_course(course_key_1) + + course_key_2 = CourseLocator("Org1", "Course2", "Run1") + course2 = self._create_course(course_key_2) # noqa: F841 + + assign_role_to_user_in_scope( + self.authorized_user.username, + COURSE_STAFF.external_key, + str(course_key_1), + ) + + request = self.factory.get("/course") + request.user = self.authorized_user + + courses_list, _ = get_courses_accessible_to_user(request) + + courses = list(courses_list) + + self.assertEqual(len(courses), 1) # noqa: PT009 + self.assertEqual(courses[0].id, course1.id) # noqa: PT009 + self.assertNotIn(course_key_2, {c.id for c in courses}) # noqa: PT009 + + def test_course_listing_with_course_editor_authz_permission(self): + """ + Create courses and assign access to only some of them to the user. + Verify that only those courses are returned in the course listing. + Using COURSE_EDITOR role here. + """ + course_key_1 = CourseLocator("Org1", "Course1", "Run1") + course1 = self._create_course(course_key_1) + + course_key_2 = CourseLocator("Org1", "Course2", "Run1") + course2 = self._create_course(course_key_2) # noqa: F841 + + assign_role_to_user_in_scope( + self.authorized_user.username, + COURSE_EDITOR.external_key, + str(course_key_1), + ) + + request = self.factory.get("/course") + request.user = self.authorized_user + + courses_list, _ = get_courses_accessible_to_user(request) + + courses = list(courses_list) + + self.assertEqual(len(courses), 1) # noqa: PT009 + self.assertEqual(courses[0].id, course1.id) # noqa: PT009 + self.assertNotIn(course_key_2, {c.id for c in courses}) # noqa: PT009 + + def test_course_listing_without_permissions(self): + """ + Create a course but do not assign access to the user. + Verify that no courses are returned in the course listing. + """ + course_key = CourseLocator("Org1", "Course1", "Run1") + + self._create_course(course_key) + + request = self.factory.get("/course") + request.user = self.unauthorized_user + + courses_list, _ = get_courses_accessible_to_user(request) + + self.assertEqual(len(list(courses_list)), 0) # noqa: PT009 + + def test_non_staff_user_cannot_access(self): + """ + Create a course and assign a non-staff role to the user. + Verify that the course is not returned in the course listing. + """ + non_staff_user = UserFactory() + course_key = CourseLocator("Org1", "Course1", "Run1") + self._create_course(course_key) + self.add_user_to_role_in_course(non_staff_user, COURSE_DATA_RESEARCHER.external_key, course_key) + + request = self.factory.get("/course") + request.user = non_staff_user + + courses_list, _ = get_courses_accessible_to_user(request) + + self.assertEqual(len(list(courses_list)), 0) # noqa: PT009 + + def test_authz_and_legacy_basic(self): + """ + AuthZ roles should only apply when toggle is enabled. + Legacy roles should still grant access. + """ + authz_keys, legacy_keys, authz_courses, legacy_courses = self._create_courses() + + enabled_keys = {str(authz_keys[0]), str(authz_keys[2])} + + with patch.object( + core_toggles.AUTHZ_COURSE_AUTHORING_FLAG, + "is_enabled", + side_effect=self._mock_authz_toggle(enabled_keys), + ): + user = UserFactory() + + # AuthZ roles + assign_role_to_user_in_scope( + user.username, + COURSE_STAFF.external_key, + str(authz_keys[0]), # toggle ON → valid + ) + assign_role_to_user_in_scope( + user.username, + COURSE_EDITOR.external_key, + str(authz_keys[1]), # toggle OFF → ignored + ) + + # Legacy role + CourseInstructorRole(legacy_keys[0]).add_users(user) + + courses, _ = get_courses_accessible_to_user(self._make_request(user)) + + result_ids = {c.id for c in courses} + + expected_ids = { + authz_courses[0].id, + legacy_courses[0].id, + } + + self.assertEqual(result_ids, expected_ids) # noqa: PT009 + + def test_authz_role_ignored_when_toggle_off(self): + """ + AuthZ role should not grant access if toggle is disabled for that course. + """ + authz_keys, _, authz_courses, _ = self._create_courses() + + enabled_keys = {str(authz_keys[2])} # only Course3 enabled + + with patch.object( + core_toggles.AUTHZ_COURSE_AUTHORING_FLAG, + "is_enabled", + side_effect=self._mock_authz_toggle(enabled_keys), + ): + user = UserFactory() + + assign_role_to_user_in_scope( + user.username, + COURSE_EDITOR.external_key, + str(authz_keys[1]), # toggle OFF → ignored + ) + + courses, _ = get_courses_accessible_to_user(self._make_request(user)) + + result_ids = {c.id for c in courses} + expected_ids = set() # no access since toggle is off + + self.assertEqual(result_ids, expected_ids) # noqa: PT009 + + def test_multiple_roles_mixed_authz_and_legacy(self): + """ + User should receive: + - AuthZ courses when toggle is enabled + - Legacy courses independently + """ + authz_keys, legacy_keys, authz_courses, legacy_courses = self._create_courses() + + enabled_keys = {str(k) for k in authz_keys} # all enabled + + with patch.object( + core_toggles.AUTHZ_COURSE_AUTHORING_FLAG, + "is_enabled", + side_effect=self._mock_authz_toggle(enabled_keys), + ): + user = UserFactory() + + # AuthZ roles + assign_role_to_user_in_scope( + user.username, + COURSE_STAFF.external_key, + str(authz_keys[0]), + ) + assign_role_to_user_in_scope( + user.username, + COURSE_EDITOR.external_key, + str(authz_keys[1]), + ) + + # Legacy role + CourseInstructorRole(legacy_keys[2]).add_users(user) + + courses, _ = get_courses_accessible_to_user(self._make_request(user)) + + result_ids = {c.id for c in courses} + + expected_ids = { + authz_courses[0].id, + authz_courses[1].id, + legacy_courses[2].id, + } + + self.assertEqual(result_ids, expected_ids) # noqa: PT009 + + def test_staff_gets_all_courses(self): + """ + Global staff should bypass AuthZ/legacy restrictions and get all courses. + """ + authz_keys, legacy_keys, authz_courses, legacy_courses = self._create_courses() + + with patch.object( + core_toggles.AUTHZ_COURSE_AUTHORING_FLAG, + "is_enabled", + return_value=False, # irrelevant for staff + ): + user = UserFactory() + GlobalStaff().add_users(user) + + courses, _ = get_courses_accessible_to_user(self._make_request(user)) + + result_ids = {c.id for c in courses} + + expected_ids = { + *(c.id for c in authz_courses), + *(c.id for c in legacy_courses), + } + + self.assertEqual(result_ids, expected_ids) # noqa: PT009 + + def test_superuser_gets_all_courses(self): + """ + Superuser should bypass all permission checks and get all courses. + """ + _, _, authz_courses, legacy_courses = self._create_courses() + + with patch.object( + core_toggles.AUTHZ_COURSE_AUTHORING_FLAG, + "is_enabled", + return_value=False, # irrelevant for superuser + ): + user = UserFactory(is_superuser=True) + + courses, _ = get_courses_accessible_to_user(self._make_request(user)) + + result_ids = {c.id for c in courses} + + expected_ids = { + *(c.id for c in authz_courses), + *(c.id for c in legacy_courses), + } + + self.assertEqual(result_ids, expected_ids) # noqa: PT009 + + def test_course_listing_with_org_scope(self): + """ + Verify that assigning a course role like course_staff with an org-wide scope + (`course-v1:Org1+*`) grants access to all courses in that org when + the AuthZ course authoring toggle is enabled. + """ + _, _, authz_courses, legacy_courses = self._create_courses() + org_scope = OrgCourseOverviewGlobData(external_key='course-v1:Org1+*') + assign_role_to_user_in_scope( + self.authorized_user.username, + COURSE_STAFF.external_key, + org_scope.external_key, + ) + + request = self._make_request(self.authorized_user) + + with patch.object( + core_toggles.AUTHZ_COURSE_AUTHORING_FLAG, + "is_enabled", + return_value=True, + ): + courses, _ = get_courses_accessible_to_user(request) + + result_ids = {c.id for c in courses} + + expected_ids = { + *(c.id for c in authz_courses), + *(c.id for c in legacy_courses), + } + + self.assertEqual(result_ids, expected_ids) # noqa: PT009 + + def test_course_listing_with_org_scope_with_toggle(self): + """ + If the authz toggle is enabled only for a subset of org courses, only + those course keys should appear in the resulting course list. + """ + authz_keys, _, _, _ = self._create_courses() + # enable only the first and third course keys + enabled_keys = {str(authz_keys[0]), str(authz_keys[2])} + org_scope = OrgCourseOverviewGlobData(external_key='course-v1:Org1+*') + assign_role_to_user_in_scope( + self.authorized_user.username, + COURSE_STAFF.external_key, + org_scope.external_key, + ) + + request = self._make_request(self.authorized_user) + + with patch.object( + core_toggles.AUTHZ_COURSE_AUTHORING_FLAG, + "is_enabled", + side_effect=self._mock_authz_toggle(enabled_keys), + ): + courses, _ = get_courses_accessible_to_user(request) + + result_ids = {c.id for c in courses} + + expected = {authz_keys[0], authz_keys[2]} + self.assertEqual(result_ids, expected) # noqa: PT009 + + def test_course_listing_with_org_scope_without_courses(self): + """ + When the scope is an OrgCourseOverviewGlobData for an org that has no + courses, `get_courses_accessible_to_user` should return an empty + list. + """ + org_scope = OrgCourseOverviewGlobData(external_key='course-v1:Org2+*') + assign_role_to_user_in_scope( + self.authorized_user.username, + COURSE_STAFF.external_key, + org_scope.external_key, + ) + + request = self._make_request(self.authorized_user) + + with patch.object( + core_toggles.AUTHZ_COURSE_AUTHORING_FLAG, + "is_enabled", + return_value=True, + ): + courses, _ = get_courses_accessible_to_user(request) + + self.assertEqual(courses, []) # noqa: PT009 + + def test_course_listing_with_org_scope_fetched_once(self): + """ + Verify that course overviews are fetched once with all authorized orgs. + """ + org_scope1 = OrgCourseOverviewGlobData(external_key='course-v1:Org1+*') + org_scope2 = OrgCourseOverviewGlobData(external_key='course-v1:Org2+*') + assign_role_to_user_in_scope( + self.authorized_user.username, + COURSE_STAFF.external_key, + org_scope1.external_key, + ) + assign_role_to_user_in_scope( + self.authorized_user.username, + COURSE_STAFF.external_key, + org_scope2.external_key, + ) + + request = self._make_request(self.authorized_user) + + with patch.object( + core_toggles.AUTHZ_COURSE_AUTHORING_FLAG, + "is_enabled", + return_value=True, + ), patch.object( + CourseOverview, + "get_all_courses", + ) as mock_get_all_courses: + courses, _ = get_courses_accessible_to_user(request) + + mock_get_all_courses.assert_called_once_with(orgs={"Org1", "Org2"}) diff --git a/cms/djangoapps/contentstore/tests/test_course_settings.py b/cms/djangoapps/contentstore/tests/test_course_settings.py index 876bb37ee783..720a021ecb3f 100644 --- a/cms/djangoapps/contentstore/tests/test_course_settings.py +++ b/cms/djangoapps/contentstore/tests/test_course_settings.py @@ -29,29 +29,27 @@ from pytz import UTC from xblock.fields import Date -from cms.djangoapps.contentstore import toggles from cms.djangoapps.contentstore.utils import reverse_course_url, reverse_usage_url from cms.djangoapps.models.settings.course_grading import ( GRADING_POLICY_CHANGED_EVENT_TYPE, CourseGradingModel, - hash_grading_policy + hash_grading_policy, ) from cms.djangoapps.models.settings.course_metadata import CourseMetadata from cms.djangoapps.models.settings.encoder import CourseSettingsEncoder from cms.djangoapps.models.settings.waffle import MATERIAL_RECOMPUTE_ONLY_FLAG -from common.djangoapps.course_modes.models import CourseMode -from common.djangoapps.student.roles import CourseInstructorRole, CourseStaffRole +from common.djangoapps.student.roles import CourseStaffRole from common.djangoapps.student.tests.factories import UserFactory from common.djangoapps.util import milestones_helpers from common.djangoapps.xblock_django.models import XBlockStudioConfigurationFlag from openedx.core.djangoapps.discussions.config.waffle import ( ENABLE_PAGES_AND_RESOURCES_MICROFRONTEND, - OVERRIDE_DISCUSSION_LEGACY_SETTINGS_FLAG + OVERRIDE_DISCUSSION_LEGACY_SETTINGS_FLAG, ) from openedx.core.djangoapps.models.course_details import CourseDetails from openedx.core.lib.teams_config import TeamsConfig -from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order from .utils import AjaxEnabledTestClient, CourseTestCase @@ -69,14 +67,14 @@ def test_encoder(self): details = CourseDetails.fetch(self.course.id) jsondetails = json.dumps(details, cls=CourseSettingsEncoder) jsondetails = json.loads(jsondetails) - self.assertEqual(jsondetails['course_image_name'], self.course.course_image) - self.assertIsNone(jsondetails['end_date'], "end date somehow initialized ") - self.assertIsNone(jsondetails['enrollment_start'], "enrollment_start date somehow initialized ") - self.assertIsNone(jsondetails['enrollment_end'], "enrollment_end date somehow initialized ") - self.assertIsNone(jsondetails['syllabus'], "syllabus somehow initialized") - self.assertIsNone(jsondetails['intro_video'], "intro_video somehow initialized") - self.assertIsNone(jsondetails['effort'], "effort somehow initialized") - self.assertIsNone(jsondetails['language'], "language somehow initialized") + self.assertEqual(jsondetails['course_image_name'], self.course.course_image) # noqa: PT009 + self.assertIsNone(jsondetails['end_date'], "end date somehow initialized ") # noqa: PT009 + self.assertIsNone(jsondetails['enrollment_start'], "enrollment_start date somehow initialized ") # noqa: PT009 + self.assertIsNone(jsondetails['enrollment_end'], "enrollment_end date somehow initialized ") # noqa: PT009 + self.assertIsNone(jsondetails['syllabus'], "syllabus somehow initialized") # noqa: PT009 + self.assertIsNone(jsondetails['intro_video'], "intro_video somehow initialized") # noqa: PT009 + self.assertIsNone(jsondetails['effort'], "effort somehow initialized") # noqa: PT009 + self.assertIsNone(jsondetails['language'], "language somehow initialized") # noqa: PT009 def test_pre_1900_date(self): """ @@ -88,7 +86,7 @@ def test_pre_1900_date(self): details.enrollment_start = pre_1900 dumped_jsondetails = json.dumps(details, cls=CourseSettingsEncoder) loaded_jsondetails = json.loads(dumped_jsondetails) - self.assertEqual(loaded_jsondetails['enrollment_start'], pre_1900.isoformat()) + self.assertEqual(loaded_jsondetails['enrollment_start'], pre_1900.isoformat()) # noqa: PT009 def test_ooc_encoder(self): """ @@ -102,8 +100,8 @@ def test_ooc_encoder(self): jsondetails = json.dumps(details, cls=CourseSettingsEncoder) jsondetails = json.loads(jsondetails) - self.assertEqual(1, jsondetails['number']) - self.assertEqual(jsondetails['string'], 'string') + self.assertEqual(1, jsondetails['number']) # noqa: PT009 + self.assertEqual(jsondetails['string'], 'string') # noqa: PT009 @ddt.ddt @@ -124,7 +122,6 @@ def setUp(self): CourseStaffRole(self.course.id).add_users(self.nonstaff) @override_settings(FEATURES={'DISABLE_MOBILE_COURSE_AVAILABLE': True}) - @override_waffle_flag(toggles.LEGACY_STUDIO_ADVANCED_SETTINGS, True) def test_mobile_field_available(self): """ @@ -132,13 +129,12 @@ def test_mobile_field_available(self): when DISABLE_MOBILE_COURSE_AVAILABLE is true. """ - response = self.client.get_html(self.course_setting_url) - start = response.content.decode('utf-8').find("mobile_available") - end = response.content.decode('utf-8').find("}", start) - settings_fields = json.loads(response.content.decode('utf-8')[start + len("mobile_available: "):end + 1]) + response = self.client.get(self.course_setting_url, HTTP_ACCEPT='application/json') + data = json.loads(response.content.decode('utf-8')) + settings_fields = data.get('mobile_available') - self.assertEqual(settings_fields["display_name"], "Mobile Course Available") - self.assertEqual(settings_fields["deprecated"], True) + self.assertEqual(settings_fields["display_name"], "Mobile Course Available") # noqa: PT009 + self.assertEqual(settings_fields["deprecated"], True) # noqa: PT009 @ddt.data( (False, False, True), @@ -147,7 +143,6 @@ def test_mobile_field_available(self): (False, True, True) ) @ddt.unpack - @override_waffle_flag(toggles.LEGACY_STUDIO_ADVANCED_SETTINGS, True) def test_discussion_fields_available(self, is_pages_and_resources_enabled, is_legacy_discussion_setting_enabled, fields_visible): """ @@ -156,60 +151,52 @@ def test_discussion_fields_available(self, is_pages_and_resources_enabled, with override_waffle_flag(ENABLE_PAGES_AND_RESOURCES_MICROFRONTEND, is_pages_and_resources_enabled): with override_waffle_flag(OVERRIDE_DISCUSSION_LEGACY_SETTINGS_FLAG, is_legacy_discussion_setting_enabled): - response = self.client.get_html(self.course_setting_url).content.decode('utf-8') - self.assertEqual('allow_anonymous' in response, fields_visible) - self.assertEqual('allow_anonymous_to_peers' in response, fields_visible) - self.assertEqual('discussion_blackouts' in response, fields_visible) - self.assertEqual('discussion_topics' in response, fields_visible) + response = self.client.get(self.course_setting_url, HTTP_ACCEPT='application/json') + data = json.loads(response.content.decode('utf-8')) + self.assertEqual('allow_anonymous' in data, fields_visible) # noqa: PT009 + self.assertEqual('allow_anonymous_to_peers' in data, fields_visible) # noqa: PT009 + self.assertEqual('discussion_blackouts' in data, fields_visible) # noqa: PT009 + self.assertEqual('discussion_topics' in data, fields_visible) # noqa: PT009 @ddt.data(False, True) - @override_waffle_flag(toggles.LEGACY_STUDIO_ADVANCED_SETTINGS, True) - @override_waffle_flag(toggles.LEGACY_STUDIO_IMPORT, True) - @override_waffle_flag(toggles.LEGACY_STUDIO_EXPORT, True) - @override_waffle_flag(toggles.LEGACY_STUDIO_COURSE_TEAM, True) - @override_waffle_flag(toggles.LEGACY_STUDIO_SCHEDULE_DETAILS, True) - @override_waffle_flag(toggles.LEGACY_STUDIO_GRADING, True) def test_disable_advanced_settings_feature(self, disable_advanced_settings): """ - If this feature is enabled, only Django Staff/Superuser should be able to access the "Advanced Settings" page. - For non-staff users the "Advanced Settings" tab link should not be visible. + When DISABLE_ADVANCED_SETTINGS is enabled, non-staff users should receive + a 403 on the advanced settings URL; staff users should always be redirected. """ - advanced_settings_link_html = f"Advanced Settings".encode('utf-8') - with override_settings(FEATURES={ 'DISABLE_ADVANCED_SETTINGS': disable_advanced_settings, - }): - for handler in ( - 'import_handler', - 'export_handler', - 'course_team_handler', - 'settings_handler', - 'grading_handler', - ): - # Test that non-staff users don't see the "Advanced Settings" tab link. - response = self.non_staff_client.get_html( - get_url(self.course.id, handler) - ) - self.assertEqual(response.status_code, 200) - if disable_advanced_settings: - self.assertNotIn(advanced_settings_link_html, response.content) - else: - self.assertIn(advanced_settings_link_html, response.content) - - # Test that staff users see the "Advanced Settings" tab link. - response = self.client.get_html( - get_url(self.course.id, handler) - ) - self.assertEqual(response.status_code, 200) - self.assertIn(advanced_settings_link_html, response.content) - - # Test that non-staff users can't access the "Advanced Settings" page. + }, COURSE_AUTHORING_MICROFRONTEND_URL='https://mfe.example'): response = self.non_staff_client.get_html(self.course_setting_url) - self.assertEqual(response.status_code, 403 if disable_advanced_settings else 200) + self.assertEqual(response.status_code, 403 if disable_advanced_settings else 302) # noqa: PT009 - # Test that staff users can access the "Advanced Settings" page. response = self.client.get_html(self.course_setting_url) - self.assertEqual(response.status_code, 200) + self.assertEqual(response.status_code, 302) # noqa: PT009 + + def test_grading_handler_redirects_to_mfe(self): + """grading_handler redirects to the authoring MFE.""" + response = self.client.get_html(get_url(self.course.id, 'grading_handler')) + self.assertEqual(response.status_code, 302) # noqa: PT009 + + def test_settings_handler_redirects_to_mfe(self): + """settings_handler (schedule & details) redirects to the authoring MFE.""" + response = self.client.get_html(get_url(self.course.id, 'settings_handler')) + self.assertEqual(response.status_code, 302) # noqa: PT009 + + def test_import_handler_redirects_to_mfe(self): + """import_handler redirects to the authoring MFE.""" + response = self.client.get_html(get_url(self.course.id, 'import_handler')) + self.assertEqual(response.status_code, 302) # noqa: PT009 + + def test_export_handler_redirects_to_mfe(self): + """export_handler redirects to the authoring MFE.""" + response = self.client.get_html(get_url(self.course.id, 'export_handler')) + self.assertEqual(response.status_code, 302) # noqa: PT009 + + def test_course_team_handler_redirects_to_mfe(self): + """course_team_handler redirects to the authoring MFE.""" + response = self.client.get_html(get_url(self.course.id, 'course_team_handler')) + self.assertEqual(response.status_code, 302) # noqa: PT009 @ddt.ddt @@ -273,17 +260,17 @@ def compare_details_with_encoding(self, encoded, details, context): self.compare_date_fields(details, encoded, context, 'end_date') self.compare_date_fields(details, encoded, context, 'enrollment_start') self.compare_date_fields(details, encoded, context, 'enrollment_end') - self.assertEqual( + self.assertEqual( # noqa: PT009 details['short_description'], encoded['short_description'], context + " short_description not ==" ) - self.assertEqual( + self.assertEqual( # noqa: PT009 details['about_sidebar_html'], encoded['about_sidebar_html'], context + " about_sidebar_html not ==" ) - self.assertEqual(details['overview'], encoded['overview'], context + " overviews not ==") - self.assertEqual(details['intro_video'], encoded.get('intro_video', None), context + " intro_video not ==") - self.assertEqual(details['effort'], encoded['effort'], context + " efforts not ==") - self.assertEqual(details['course_image_name'], encoded['course_image_name'], context + " images not ==") - self.assertEqual(details['language'], encoded['language'], context + " languages not ==") + self.assertEqual(details['overview'], encoded['overview'], context + " overviews not ==") # noqa: PT009 + self.assertEqual(details['intro_video'], encoded.get('intro_video', None), context + " intro_video not ==") # noqa: PT009 # pylint: disable=line-too-long + self.assertEqual(details['effort'], encoded['effort'], context + " efforts not ==") # noqa: PT009 + self.assertEqual(details['course_image_name'], encoded['course_image_name'], context + " images not ==") # noqa: PT009 # pylint: disable=line-too-long + self.assertEqual(details['language'], encoded['language'], context + " languages not ==") # noqa: PT009 def compare_date_fields(self, details, encoded, context, field): """ @@ -295,53 +282,22 @@ def compare_date_fields(self, details, encoded, context, field): dt1 = date.from_json(encoded[field]) dt2 = details[field] - self.assertEqual(dt1, dt2, msg=f"{dt1} != {dt2} at {context}") + self.assertEqual(dt1, dt2, msg=f"{dt1} != {dt2} at {context}") # noqa: PT009 else: self.fail(field + " missing from encoded but in details at " + context) elif field in encoded and encoded[field] is not None: self.fail(field + " included in encoding but missing from details at " + context) - @ddt.data( - (False, False), - (True, False), - (True, True), - ) - @ddt.unpack - @override_waffle_flag(toggles.LEGACY_STUDIO_SCHEDULE_DETAILS, True) - def test_upgrade_deadline(self, has_verified_mode, has_expiration_date): - if has_verified_mode: - deadline = None - if has_expiration_date: - deadline = self.course.start + datetime.timedelta(days=2) - CourseMode.objects.get_or_create( - course_id=self.course.id, - mode_display_name="Verified", - mode_slug="verified", - min_price=1, - _expiration_datetime=deadline, - ) - - settings_details_url = get_url(self.course.id) - response = self.client.get_html(settings_details_url) - self.assertEqual(b"Upgrade Deadline Date" in response.content, has_expiration_date and has_verified_mode) - - @mock.patch.dict("django.conf.settings.FEATURES", {'ENABLE_PREREQUISITE_COURSES': True}) - @override_waffle_flag(toggles.LEGACY_STUDIO_SCHEDULE_DETAILS, True) - def test_pre_requisite_course_list_present(self): - settings_details_url = get_url(self.course.id) - response = self.client.get_html(settings_details_url) - self.assertContains(response, "Prerequisite Course") - @mock.patch.dict("django.conf.settings.FEATURES", {'ENABLE_PREREQUISITE_COURSES': True}) def test_pre_requisite_course_update_and_fetch(self): - self.assertFalse(milestones_helpers.any_unfulfilled_milestones(self.course.id, self.user.id), + self.assertFalse(milestones_helpers.any_unfulfilled_milestones(self.course.id, self.user.id), # noqa: PT009 msg='The initial empty state should be: no prerequisite courses') url = get_url(self.course.id) resp = self.client.get_json(url) course_detail_json = json.loads(resp.content.decode('utf-8')) # assert pre_requisite_courses is initialized - self.assertEqual([], course_detail_json['pre_requisite_courses']) + self.assertEqual([], course_detail_json['pre_requisite_courses']) # noqa: PT009 # update pre requisite courses with a new course keys pre_requisite_course = CourseFactory.create(org='edX', course='900', run='test_run') @@ -353,9 +309,9 @@ def test_pre_requisite_course_update_and_fetch(self): # fetch updated course to assert pre_requisite_courses has new values resp = self.client.get_json(url) course_detail_json = json.loads(resp.content.decode('utf-8')) - self.assertEqual(pre_requisite_course_keys, course_detail_json['pre_requisite_courses']) + self.assertEqual(pre_requisite_course_keys, course_detail_json['pre_requisite_courses']) # noqa: PT009 - self.assertTrue(milestones_helpers.any_unfulfilled_milestones(self.course.id, self.user.id), + self.assertTrue(milestones_helpers.any_unfulfilled_milestones(self.course.id, self.user.id), # noqa: PT009 msg='Should have prerequisite courses') # remove pre requisite course @@ -363,9 +319,9 @@ def test_pre_requisite_course_update_and_fetch(self): self.client.ajax_post(url, course_detail_json) resp = self.client.get_json(url) course_detail_json = json.loads(resp.content.decode('utf-8')) - self.assertEqual([], course_detail_json['pre_requisite_courses']) + self.assertEqual([], course_detail_json['pre_requisite_courses']) # noqa: PT009 - self.assertFalse(milestones_helpers.any_unfulfilled_milestones(self.course.id, self.user.id), + self.assertFalse(milestones_helpers.any_unfulfilled_milestones(self.course.id, self.user.id), # noqa: PT009 msg='Should not have prerequisite courses anymore') @mock.patch.dict("django.conf.settings.FEATURES", {'ENABLE_PREREQUISITE_COURSES': True}) @@ -379,63 +335,7 @@ def test_invalid_pre_requisite_course(self): pre_requisite_course_keys = [str(pre_requisite_course.id), 'invalid_key'] course_detail_json['pre_requisite_courses'] = pre_requisite_course_keys response = self.client.ajax_post(url, course_detail_json) - self.assertEqual(400, response.status_code) - - @ddt.data( - (False, False, False), - (True, False, True), - (False, True, False), - (True, True, True), - ) - @override_waffle_flag(toggles.LEGACY_STUDIO_SCHEDULE_DETAILS, True) - @override_settings(MILESTONES_APP=False) - def test_visibility_of_entrance_exam_section(self, feature_flags): - """ - Tests entrance exam section is available if ENTRANCE_EXAMS feature is enabled no matter any other - feature is enabled or disabled i.e ENABLE_PUBLISHER. - """ - with patch.dict("django.conf.settings.FEATURES", { - 'ENABLE_PUBLISHER': feature_flags[1] - }), override_settings(ENTRANCE_EXAMS=feature_flags[0]): - course_details_url = get_url(self.course.id) - resp = self.client.get_html(course_details_url) - self.assertEqual( - feature_flags[2], - b'

' in resp.content - ) - - @override_waffle_flag(toggles.LEGACY_STUDIO_SCHEDULE_DETAILS, True) - @override_settings(MILESTONES_APP=False) - @override_settings(ENTRANCE_EXAMS=False) - def test_marketing_site_fetch(self): - settings_details_url = get_url(self.course.id) - - with mock.patch.dict('django.conf.settings.FEATURES', { - 'ENABLE_PUBLISHER': True, - 'ENABLE_MKTG_SITE': True, - 'ENABLE_PREREQUISITE_COURSES': False, - }): - response = self.client.get_html(settings_details_url) - self.assertNotContains(response, "Course Summary Page") - self.assertNotContains(response, "Send a note to students via email") - self.assertContains(response, "course summary page will not be viewable") - - self.assertContains(response, "Course Start Date") - self.assertContains(response, "Course End Date") - self.assertContains(response, "Enrollment Start Date") - self.assertContains(response, "Enrollment End Date") - - self.assertContains(response, "Course Short Description") - self.assertNotContains(response, "Course About Sidebar HTML") - self.assertNotContains(response, "Course Title") - self.assertNotContains(response, "Course Subtitle") - self.assertNotContains(response, "Course Duration") - self.assertNotContains(response, "Course Description") - self.assertNotContains(response, "Course Overview") - self.assertNotContains(response, "Course Introduction Video") - self.assertNotContains(response, "Requirements") - self.assertNotContains(response, "Course Banner Image") - self.assertNotContains(response, "Course Video Thumbnail Image") + self.assertEqual(400, response.status_code) # noqa: PT009 @unittest.skipUnless(settings.FEATURES.get('ENTRANCE_EXAMS', False), True) def test_entrance_exam_created_updated_and_deleted_successfully(self): @@ -444,27 +344,20 @@ def test_entrance_exam_created_updated_and_deleted_successfully(self): Splitting the test requires significant refactoring `settings_handler()` view. """ - self.assertFalse(milestones_helpers.any_unfulfilled_milestones(self.course.id, self.user.id), + self.assertFalse(milestones_helpers.any_unfulfilled_milestones(self.course.id, self.user.id), # noqa: PT009 msg='The initial empty state should be: no entrance exam') settings_details_url = get_url(self.course.id) data = { 'entrance_exam_enabled': 'true', 'entrance_exam_minimum_score_pct': '60', - 'syllabus': 'none', - 'short_description': 'empty', - 'overview': '', - 'effort': '', - 'intro_video': '', - 'start_date': '2012-01-01', - 'end_date': '2012-12-31', } response = self.client.post(settings_details_url, data=json.dumps(data), content_type='application/json', HTTP_ACCEPT='application/json') - self.assertEqual(response.status_code, 200) + self.assertEqual(response.status_code, 200) # noqa: PT009 course = modulestore().get_course(self.course.id) - self.assertTrue(course.entrance_exam_enabled) - self.assertEqual(course.entrance_exam_minimum_score_pct, .60) + self.assertTrue(course.entrance_exam_enabled) # noqa: PT009 + self.assertEqual(course.entrance_exam_minimum_score_pct, .60) # noqa: PT009 # Update the entrance exam data['entrance_exam_enabled'] = "true" @@ -475,12 +368,12 @@ def test_entrance_exam_created_updated_and_deleted_successfully(self): content_type='application/json', HTTP_ACCEPT='application/json' ) - self.assertEqual(response.status_code, 200) + self.assertEqual(response.status_code, 200) # noqa: PT009 course = modulestore().get_course(self.course.id) - self.assertTrue(course.entrance_exam_enabled) - self.assertEqual(course.entrance_exam_minimum_score_pct, .80) + self.assertTrue(course.entrance_exam_enabled) # noqa: PT009 + self.assertEqual(course.entrance_exam_minimum_score_pct, .80) # noqa: PT009 - self.assertTrue(milestones_helpers.any_unfulfilled_milestones(self.course.id, self.user.id), + self.assertTrue(milestones_helpers.any_unfulfilled_milestones(self.course.id, self.user.id), # noqa: PT009 msg='The entrance exam should be required.') # Delete the entrance exam @@ -492,15 +385,15 @@ def test_entrance_exam_created_updated_and_deleted_successfully(self): HTTP_ACCEPT='application/json' ) course = modulestore().get_course(self.course.id) - self.assertEqual(response.status_code, 200) - self.assertFalse(course.entrance_exam_enabled) + self.assertEqual(response.status_code, 200) # noqa: PT009 + self.assertFalse(course.entrance_exam_enabled) # noqa: PT009 entrance_exam_minimum_score_pct = float(settings.ENTRANCE_EXAM_MIN_SCORE_PCT) if entrance_exam_minimum_score_pct.is_integer(): entrance_exam_minimum_score_pct = entrance_exam_minimum_score_pct / 100 - self.assertEqual(course.entrance_exam_minimum_score_pct, entrance_exam_minimum_score_pct) + self.assertEqual(course.entrance_exam_minimum_score_pct, entrance_exam_minimum_score_pct) # noqa: PT009 - self.assertFalse(milestones_helpers.any_unfulfilled_milestones(self.course.id, self.user.id), + self.assertFalse(milestones_helpers.any_unfulfilled_milestones(self.course.id, self.user.id), # noqa: PT009 msg='The entrance exam should not be required anymore') @unittest.skipUnless(settings.FEATURES.get('ENTRANCE_EXAMS', False), True) @@ -512,13 +405,6 @@ def test_entrance_exam_store_default_min_score(self): settings_details_url = get_url(self.course.id) test_data_1 = { 'entrance_exam_enabled': 'true', - 'syllabus': 'none', - 'short_description': 'empty', - 'overview': '', - 'effort': '', - 'intro_video': '', - 'start_date': '2012-01-01', - 'end_date': '2012-12-31', } response = self.client.post( settings_details_url, @@ -526,36 +412,28 @@ def test_entrance_exam_store_default_min_score(self): content_type='application/json', HTTP_ACCEPT='application/json' ) - self.assertEqual(response.status_code, 200) + self.assertEqual(response.status_code, 200) # noqa: PT009 course = modulestore().get_course(self.course.id) - self.assertTrue(course.entrance_exam_enabled) + self.assertTrue(course.entrance_exam_enabled) # noqa: PT009 # entrance_exam_minimum_score_pct is not present in the request so default value should be saved. - self.assertEqual(course.entrance_exam_minimum_score_pct, .5) + self.assertEqual(course.entrance_exam_minimum_score_pct, .5) # noqa: PT009 - #add entrance_exam_minimum_score_pct with empty value in json request. + # add entrance_exam_minimum_score_pct with empty value in json request. test_data_2 = { 'entrance_exam_enabled': 'true', 'entrance_exam_minimum_score_pct': '', - 'syllabus': 'none', - 'short_description': 'empty', - 'overview': '', - 'effort': '', - 'intro_video': '', - 'start_date': '2012-01-01', - 'end_date': '2012-12-31', } - response = self.client.post( settings_details_url, data=json.dumps(test_data_2), content_type='application/json', HTTP_ACCEPT='application/json' ) - self.assertEqual(response.status_code, 200) + self.assertEqual(response.status_code, 200) # noqa: PT009 course = modulestore().get_course(self.course.id) - self.assertTrue(course.entrance_exam_enabled) - self.assertEqual(course.entrance_exam_minimum_score_pct, .5) + self.assertTrue(course.entrance_exam_enabled) # noqa: PT009 + self.assertEqual(course.entrance_exam_minimum_score_pct, .5) # noqa: PT009 @unittest.skipUnless(settings.FEATURES.get('ENTRANCE_EXAMS', False), True) @mock.patch.dict("django.conf.settings.FEATURES", {'ENABLE_PREREQUISITE_COURSES': True}) @@ -605,7 +483,7 @@ def test_entrance_after_changing_other_setting(self): # Call the settings handler again then ensure it didn't delete the settings of the entrance exam data.update({ 'start_date': '2018-01-01', - 'end_date': '{year}-12-31'.format(year=datetime.datetime.now().year + 4), + 'end_date': '{year}-12-31'.format(year=datetime.datetime.now().year + 4), # noqa: UP032 }) response = self.client.post( settings_details_url, @@ -617,14 +495,6 @@ def test_entrance_after_changing_other_setting(self): assert milestones_helpers.any_unfulfilled_milestones(self.course.id, self.user.id), \ 'The entrance exam should be required.' - @override_waffle_flag(toggles.LEGACY_STUDIO_SCHEDULE_DETAILS, True) - def test_editable_short_description_fetch(self): - settings_details_url = get_url(self.course.id) - - with mock.patch.dict('django.conf.settings.FEATURES', {'EDITABLE_SHORT_DESCRIPTION': False}): - response = self.client.get_html(settings_details_url) - self.assertNotContains(response, "Course Short Description") - def test_empty_course_overview_keep_default_value(self): """ Test saving the course with an empty course overview. @@ -653,38 +523,9 @@ def test_empty_course_overview_keep_default_value(self): ) course_details = CourseDetails.fetch(self.course.id) - self.assertEqual(response.status_code, 200) - self.assertEqual(course_details.overview, '

 

') - - @override_waffle_flag(toggles.LEGACY_STUDIO_SCHEDULE_DETAILS, True) - def test_regular_site_fetch(self): - settings_details_url = get_url(self.course.id) + self.assertEqual(response.status_code, 200) # noqa: PT009 + self.assertEqual(course_details.overview, '

 

') # noqa: PT009 - with mock.patch.dict('django.conf.settings.FEATURES', {'ENABLE_PUBLISHER': False, - 'ENABLE_EXTENDED_COURSE_DETAILS': True}): - response = self.client.get_html(settings_details_url) - self.assertContains(response, "Course Summary Page") - self.assertContains(response, "Send a note to students via email") - self.assertNotContains(response, "course summary page will not be viewable") - - self.assertContains(response, "Course Start Date") - self.assertContains(response, "Course End Date") - self.assertContains(response, "Enrollment Start Date") - self.assertContains(response, "Enrollment End Date") - - self.assertContains(response, "Introducing Your Course") - self.assertContains(response, "Course Card Image") - self.assertContains(response, "Course Title") - self.assertContains(response, "Course Subtitle") - self.assertContains(response, "Course Duration") - self.assertContains(response, "Course Description") - self.assertContains(response, "Course Short Description") - self.assertNotContains(response, "Course About Sidebar HTML") - self.assertContains(response, "Course Overview") - self.assertContains(response, "Course Introduction Video") - self.assertContains(response, "Requirements") - self.assertContains(response, "Course Banner Image") - self.assertContains(response, "Course Video Thumbnail Image") @ddt.ddt @@ -695,17 +536,17 @@ class CourseGradingTest(CourseTestCase): def test_initial_grader(self): test_grader = CourseGradingModel(self.course) - self.assertIsNotNone(test_grader.graders) - self.assertIsNotNone(test_grader.grade_cutoffs) + self.assertIsNotNone(test_grader.graders) # noqa: PT009 + self.assertIsNotNone(test_grader.grade_cutoffs) # noqa: PT009 def test_fetch_grader(self): test_grader = CourseGradingModel.fetch(self.course.id) - self.assertIsNotNone(test_grader.graders, "No graders") - self.assertIsNotNone(test_grader.grade_cutoffs, "No cutoffs") + self.assertIsNotNone(test_grader.graders, "No graders") # noqa: PT009 + self.assertIsNotNone(test_grader.grade_cutoffs, "No cutoffs") # noqa: PT009 for i, grader in enumerate(test_grader.graders): subgrader = CourseGradingModel.fetch_grader(self.course.id, i) - self.assertDictEqual(grader, subgrader, str(i) + "th graders not equal") + self.assertDictEqual(grader, subgrader, str(i) + "th graders not equal") # noqa: PT009 @mock.patch('common.djangoapps.track.event_transaction_utils.uuid4') @mock.patch('cms.djangoapps.models.settings.course_grading.tracker') @@ -716,10 +557,10 @@ def test_update_from_json(self, send_signal, tracker, uuid): test_grader = CourseGradingModel.fetch(self.course.id) # there should be no event raised after this call, since nothing got modified altered_grader = CourseGradingModel.update_from_json(self.course.id, test_grader.__dict__, self.user) - self.assertDictEqual(test_grader.__dict__, altered_grader.__dict__, "Noop update") + self.assertDictEqual(test_grader.__dict__, altered_grader.__dict__, "Noop update") # noqa: PT009 test_grader.graders[0]['weight'] = test_grader.graders[0].get('weight') * 2 altered_grader = CourseGradingModel.update_from_json(self.course.id, test_grader.__dict__, self.user) - self.assertDictEqual(test_grader.__dict__, altered_grader.__dict__, "Weight[0] * 2") + self.assertDictEqual(test_grader.__dict__, altered_grader.__dict__, "Weight[0] * 2") # noqa: PT009 grading_policy_2 = self._grading_policy_hash_for_course() # test for bug LMS-11485 with modulestore().bulk_operations(self.course.id): @@ -731,15 +572,15 @@ def test_update_from_json(self, send_signal, tracker, uuid): # don't use altered cached def, get a fresh one CourseGradingModel.update_from_json(self.course.id, test_grader.__dict__, self.user) altered_grader = CourseGradingModel.fetch(self.course.id) - self.assertDictEqual(test_grader.__dict__, altered_grader.__dict__) + self.assertDictEqual(test_grader.__dict__, altered_grader.__dict__) # noqa: PT009 grading_policy_3 = self._grading_policy_hash_for_course() test_grader.grade_cutoffs['D'] = 0.3 altered_grader = CourseGradingModel.update_from_json(self.course.id, test_grader.__dict__, self.user) - self.assertDictEqual(test_grader.__dict__, altered_grader.__dict__, "cutoff add D") + self.assertDictEqual(test_grader.__dict__, altered_grader.__dict__, "cutoff add D") # noqa: PT009 grading_policy_4 = self._grading_policy_hash_for_course() test_grader.grace_period = {'hours': 4, 'minutes': 5, 'seconds': 0} altered_grader = CourseGradingModel.update_from_json(self.course.id, test_grader.__dict__, self.user) - self.assertDictEqual(test_grader.__dict__, altered_grader.__dict__, "4 hour grace period") + self.assertDictEqual(test_grader.__dict__, altered_grader.__dict__, "4 hour grace period") # noqa: PT009 # one for each of the calls to update_from_json() send_signal.assert_has_calls([ @@ -789,7 +630,7 @@ def test_must_fire_grading_event_and_signal_multiple_type(self): modulestore().get_course(self.course.id), course_grading_model.__dict__ ) - self.assertTrue(result) + self.assertTrue(result) # noqa: PT009 @override_waffle_flag(MATERIAL_RECOMPUTE_ONLY_FLAG, True) def test_must_fire_grading_event_and_signal_multiple_type_waffle_on(self): @@ -814,7 +655,7 @@ def test_must_fire_grading_event_and_signal_multiple_type_waffle_on(self): modulestore().get_course(self.course.id), course_grading_model.__dict__ ) - self.assertFalse(result) + self.assertFalse(result) # noqa: PT009 def test_must_fire_grading_event_and_signal_return_true(self): """ @@ -838,7 +679,7 @@ def test_must_fire_grading_event_and_signal_return_true(self): modulestore().get_course(self.course.id), course_grading_model.__dict__ ) - self.assertTrue(result) + self.assertTrue(result) # noqa: PT009 @mock.patch('common.djangoapps.track.event_transaction_utils.uuid4') @mock.patch('cms.djangoapps.models.settings.course_grading.tracker') @@ -849,18 +690,18 @@ def test_update_grader_from_json(self, send_signal, tracker, uuid): altered_grader = CourseGradingModel.update_grader_from_json( self.course.id, test_grader.graders[1], self.user ) - self.assertDictEqual(test_grader.graders[1], altered_grader, "Noop update") + self.assertDictEqual(test_grader.graders[1], altered_grader, "Noop update") # noqa: PT009 test_grader.graders[1]['min_count'] = test_grader.graders[1].get('min_count') + 2 altered_grader = CourseGradingModel.update_grader_from_json( self.course.id, test_grader.graders[1], self.user) - self.assertDictEqual(test_grader.graders[1], altered_grader, "min_count[1] + 2") + self.assertDictEqual(test_grader.graders[1], altered_grader, "min_count[1] + 2") # noqa: PT009 grading_policy_2 = self._grading_policy_hash_for_course() test_grader.graders[1]['drop_count'] = test_grader.graders[1].get('drop_count') + 1 altered_grader = CourseGradingModel.update_grader_from_json( self.course.id, test_grader.graders[1], self.user) - self.assertDictEqual(test_grader.graders[1], altered_grader, "drop_count[1] + 2") + self.assertDictEqual(test_grader.graders[1], altered_grader, "drop_count[1] + 2") # noqa: PT009 grading_policy_3 = self._grading_policy_hash_for_course() # one for each of the calls to update_grader_from_json() @@ -894,19 +735,19 @@ def test_update_cutoffs_from_json(self, tracker, uuid): # Unlike other tests, need to actually perform a db fetch for this test since update_cutoffs_from_json # simply returns the cutoffs you send into it, rather than returning the db contents. altered_grader = CourseGradingModel.fetch(self.course.id) - self.assertDictEqual(test_grader.grade_cutoffs, altered_grader.grade_cutoffs, "Noop update") + self.assertDictEqual(test_grader.grade_cutoffs, altered_grader.grade_cutoffs, "Noop update") # noqa: PT009 grading_policy_1 = self._grading_policy_hash_for_course() test_grader.grade_cutoffs['D'] = 0.3 CourseGradingModel.update_cutoffs_from_json(self.course.id, test_grader.grade_cutoffs, self.user) altered_grader = CourseGradingModel.fetch(self.course.id) - self.assertDictEqual(test_grader.grade_cutoffs, altered_grader.grade_cutoffs, "cutoff add D") + self.assertDictEqual(test_grader.grade_cutoffs, altered_grader.grade_cutoffs, "cutoff add D") # noqa: PT009 grading_policy_2 = self._grading_policy_hash_for_course() test_grader.grade_cutoffs['Pass'] = 0.75 CourseGradingModel.update_cutoffs_from_json(self.course.id, test_grader.grade_cutoffs, self.user) altered_grader = CourseGradingModel.fetch(self.course.id) - self.assertDictEqual(test_grader.grade_cutoffs, altered_grader.grade_cutoffs, "cutoff change 'Pass'") + self.assertDictEqual(test_grader.grade_cutoffs, altered_grader.grade_cutoffs, "cutoff change 'Pass'") # noqa: PT009 # pylint: disable=line-too-long grading_policy_3 = self._grading_policy_hash_for_course() # one for each of the calls to update_cutoffs_from_json() @@ -930,13 +771,13 @@ def test_delete_grace_period(self): ) # update_grace_period_from_json doesn't return anything, so query the db for its contents. altered_grader = CourseGradingModel.fetch(self.course.id) - self.assertEqual(test_grader.grace_period, altered_grader.grace_period, "Noop update") + self.assertEqual(test_grader.grace_period, altered_grader.grace_period, "Noop update") # noqa: PT009 test_grader.grace_period = {'hours': 15, 'minutes': 5, 'seconds': 30} CourseGradingModel.update_grace_period_from_json( self.course.id, test_grader.grace_period, self.user) altered_grader = CourseGradingModel.fetch(self.course.id) - self.assertDictEqual(test_grader.grace_period, altered_grader.grace_period, "Adding in a grace period") + self.assertDictEqual(test_grader.grace_period, altered_grader.grace_period, "Adding in a grace period") # noqa: PT009 # pylint: disable=line-too-long test_grader.grace_period = {'hours': 1, 'minutes': 10, 'seconds': 0} # Now delete the grace period @@ -944,7 +785,7 @@ def test_delete_grace_period(self): # update_grace_period_from_json doesn't return anything, so query the db for its contents. altered_grader = CourseGradingModel.fetch(self.course.id) # Once deleted, the grace period should simply be None - self.assertEqual(None, altered_grader.grace_period, "Delete grace period") + self.assertEqual(None, altered_grader.grace_period, "Delete grace period") # noqa: PT009 @mock.patch('common.djangoapps.track.event_transaction_utils.uuid4') @mock.patch('cms.djangoapps.models.settings.course_grading.tracker') @@ -955,9 +796,9 @@ def test_update_section_grader_type(self, send_signal, tracker, uuid): block = modulestore().get_item(self.course.location) section_grader_type = CourseGradingModel.get_section_grader_type(self.course.location) - self.assertEqual('notgraded', section_grader_type['graderType']) - self.assertEqual(None, block.format) - self.assertEqual(False, block.graded) + self.assertEqual('notgraded', section_grader_type['graderType']) # noqa: PT009 + self.assertEqual(None, block.format) # noqa: PT009 + self.assertEqual(False, block.graded) # noqa: PT009 # Change the default grader type to Homework, which should also mark the section as graded CourseGradingModel.update_section_grader_type(self.course, 'Homework', self.user) @@ -965,9 +806,9 @@ def test_update_section_grader_type(self, send_signal, tracker, uuid): section_grader_type = CourseGradingModel.get_section_grader_type(self.course.location) grading_policy_1 = self._grading_policy_hash_for_course() - self.assertEqual('Homework', section_grader_type['graderType']) - self.assertEqual('Homework', block.format) - self.assertEqual(True, block.graded) + self.assertEqual('Homework', section_grader_type['graderType']) # noqa: PT009 + self.assertEqual('Homework', block.format) # noqa: PT009 + self.assertEqual(True, block.graded) # noqa: PT009 # Change the grader type back to notgraded, which should also unmark the section as graded CourseGradingModel.update_section_grader_type(self.course, 'notgraded', self.user) @@ -975,9 +816,9 @@ def test_update_section_grader_type(self, send_signal, tracker, uuid): section_grader_type = CourseGradingModel.get_section_grader_type(self.course.location) grading_policy_2 = self._grading_policy_hash_for_course() - self.assertEqual('notgraded', section_grader_type['graderType']) - self.assertEqual(None, block.format) - self.assertEqual(False, block.graded) + self.assertEqual('notgraded', section_grader_type['graderType']) # noqa: PT009 + self.assertEqual(None, block.format) # noqa: PT009 + self.assertEqual(False, block.graded) # noqa: PT009 # one for each call to update_section_grader_type() send_signal.assert_has_calls([ @@ -1011,21 +852,21 @@ def test_get_set_grader_types_ajax(self): grader_type_url_base = get_url(self.course.id, 'grading_handler') whole_model = self._model_from_url(grader_type_url_base) - self.assertIn('graders', whole_model) - self.assertIn('grade_cutoffs', whole_model) - self.assertIn('grace_period', whole_model) + self.assertIn('graders', whole_model) # noqa: PT009 + self.assertIn('grade_cutoffs', whole_model) # noqa: PT009 + self.assertIn('grace_period', whole_model) # noqa: PT009 # test post/update whole whole_model['grace_period'] = {'hours': 1, 'minutes': 30, 'seconds': 0} response = self.client.ajax_post(grader_type_url_base, whole_model) - self.assertEqual(200, response.status_code) + self.assertEqual(200, response.status_code) # noqa: PT009 whole_model = self._model_from_url(grader_type_url_base) - self.assertEqual(whole_model['grace_period'], {'hours': 1, 'minutes': 30, 'seconds': 0}) + self.assertEqual(whole_model['grace_period'], {'hours': 1, 'minutes': 30, 'seconds': 0}) # noqa: PT009 # test get one grader - self.assertGreater(len(whole_model['graders']), 1) # ensure test will make sense + self.assertGreater(len(whole_model['graders']), 1) # ensure test will make sense # noqa: PT009 grader_sample = self._model_from_url(grader_type_url_base + '/1') - self.assertEqual(grader_sample, whole_model['graders'][1]) + self.assertEqual(grader_sample, whole_model['graders'][1]) # noqa: PT009 @mock.patch('cms.djangoapps.contentstore.signals.signals.GRADING_POLICY_CHANGED.send') def test_add_delete_grader(self, send_signal): @@ -1046,19 +887,19 @@ def test_add_delete_grader(self, send_signal): new_grader ) grading_policy_hash1 = self._grading_policy_hash_for_course() - self.assertEqual(200, response.status_code) + self.assertEqual(200, response.status_code) # noqa: PT009 grader_sample = json.loads(response.content.decode('utf-8')) new_grader['id'] = len(original_model['graders']) - self.assertEqual(new_grader, grader_sample) + self.assertEqual(new_grader, grader_sample) # noqa: PT009 # test deleting the original grader response = self.client.delete(grader_type_url_base + '/1', HTTP_ACCEPT="application/json") grading_policy_hash2 = self._grading_policy_hash_for_course() - self.assertEqual(204, response.status_code) + self.assertEqual(204, response.status_code) # noqa: PT009 updated_model = self._model_from_url(grader_type_url_base) new_grader['id'] -= 1 # one fewer and the id mutates - self.assertIn(new_grader, updated_model['graders']) - self.assertNotIn(original_model['graders'][1], updated_model['graders']) + self.assertIn(new_grader, updated_model['graders']) # noqa: PT009 + self.assertNotIn(original_model['graders'][1], updated_model['graders']) # noqa: PT009 send_signal.assert_has_calls([ # once for the POST # pylint: disable=line-too-long @@ -1075,7 +916,7 @@ def setup_test_set_get_section_grader_ajax(self): self.populate_course() sections = modulestore().get_items(self.course.id, qualifiers={'category': "sequential"}) # see if test makes sense - self.assertGreater(len(sections), 0, "No sections found") + self.assertGreater(len(sections), 0, "No sections found") # noqa: PT009 section = sections[0] # just take the first one return reverse_usage_url('xblock_handler', section.location) @@ -1085,14 +926,14 @@ def test_set_get_section_grader_ajax(self): """ grade_type_url = self.setup_test_set_get_section_grader_ajax() response = self.client.ajax_post(grade_type_url, {'graderType': 'Homework'}) - self.assertEqual(200, response.status_code) + self.assertEqual(200, response.status_code) # noqa: PT009 response = self.client.get_json(grade_type_url + '?fields=graderType') - self.assertEqual(json.loads(response.content.decode('utf-8')).get('graderType'), 'Homework') + self.assertEqual(json.loads(response.content.decode('utf-8')).get('graderType'), 'Homework') # noqa: PT009 # and unset response = self.client.ajax_post(grade_type_url, {'graderType': 'notgraded'}) - self.assertEqual(200, response.status_code) + self.assertEqual(200, response.status_code) # noqa: PT009 response = self.client.get_json(grade_type_url + '?fields=graderType') - self.assertEqual(json.loads(response.content.decode('utf-8')).get('graderType'), 'notgraded') + self.assertEqual(json.loads(response.content.decode('utf-8')).get('graderType'), 'notgraded') # noqa: PT009 def _grading_policy_hash_for_course(self): return hash_grading_policy(modulestore().get_course(self.course.id).grading_policy) @@ -1118,16 +959,16 @@ def setUp(self): def test_fetch_initial_fields(self): test_model = CourseMetadata.fetch(self.course) - self.assertIn('display_name', test_model, 'Missing editable metadata field') - self.assertEqual(test_model['display_name']['value'], self.course.display_name) + self.assertIn('display_name', test_model, 'Missing editable metadata field') # noqa: PT009 + self.assertEqual(test_model['display_name']['value'], self.course.display_name) # noqa: PT009 test_model = CourseMetadata.fetch(self.fullcourse) - self.assertNotIn('graceperiod', test_model, 'blacklisted field leaked in') - self.assertIn('display_name', test_model, 'full missing editable metadata field') - self.assertEqual(test_model['display_name']['value'], self.fullcourse.display_name) - self.assertIn('rerandomize', test_model, 'Missing rerandomize metadata field') - self.assertIn('showanswer', test_model, 'showanswer field ') - self.assertIn('xqa_key', test_model, 'xqa_key field ') + self.assertNotIn('graceperiod', test_model, 'blacklisted field leaked in') # noqa: PT009 + self.assertIn('display_name', test_model, 'full missing editable metadata field') # noqa: PT009 + self.assertEqual(test_model['display_name']['value'], self.fullcourse.display_name) # noqa: PT009 + self.assertIn('rerandomize', test_model, 'Missing rerandomize metadata field') # noqa: PT009 + self.assertIn('showanswer', test_model, 'showanswer field ') # noqa: PT009 + self.assertIn('xqa_key', test_model, 'xqa_key field ') # noqa: PT009 @override_settings(ENABLE_EXPORT_GIT=True) def test_fetch_giturl_present(self): @@ -1135,7 +976,7 @@ def test_fetch_giturl_present(self): If feature flag ENABLE_EXPORT_GIT is on, show the setting as a non-deprecated Advanced Setting. """ test_model = CourseMetadata.fetch(self.fullcourse) - self.assertIn('giturl', test_model) + self.assertIn('giturl', test_model) # noqa: PT009 @override_settings(ENABLE_EXPORT_GIT=False) def test_fetch_giturl_not_present(self): @@ -1143,7 +984,7 @@ def test_fetch_giturl_not_present(self): If feature flag ENABLE_EXPORT_GIT is off, don't show the setting at all on the Advanced Settings page. """ test_model = CourseMetadata.fetch(self.fullcourse) - self.assertNotIn('giturl', test_model) + self.assertNotIn('giturl', test_model) # noqa: PT009 @override_settings( PROCTORING_BACKENDS={ @@ -1157,7 +998,7 @@ def test_fetch_proctoring_escalation_email_present(self): show the escalation email setting """ test_model = CourseMetadata.fetch(self.fullcourse) - self.assertIn('proctoring_escalation_email', test_model) + self.assertIn('proctoring_escalation_email', test_model) # noqa: PT009 @override_settings( PROCTORING_BACKENDS={ @@ -1171,7 +1012,7 @@ def test_fetch_proctoring_escalation_email_not_present(self): don't show the escalation email setting """ test_model = CourseMetadata.fetch(self.fullcourse) - self.assertNotIn('proctoring_escalation_email', test_model) + self.assertNotIn('proctoring_escalation_email', test_model) # noqa: PT009 @override_settings(ENABLE_EXPORT_GIT=False) def test_validate_update_filtered_off(self): @@ -1186,7 +1027,7 @@ def test_validate_update_filtered_off(self): }, user=self.user ) - self.assertNotIn('giturl', test_model) + self.assertNotIn('giturl', test_model) # noqa: PT009 @override_settings(ENABLE_EXPORT_GIT=True) def test_validate_update_filtered_on(self): @@ -1201,7 +1042,7 @@ def test_validate_update_filtered_on(self): }, user=self.user ) - self.assertIn('giturl', test_model) + self.assertIn('giturl', test_model) # noqa: PT009 @override_settings(ENABLE_EXPORT_GIT=True) def test_update_from_json_filtered_on(self): @@ -1215,7 +1056,7 @@ def test_update_from_json_filtered_on(self): }, user=self.user ) - self.assertIn('giturl', test_model) + self.assertIn('giturl', test_model) # noqa: PT009 @override_settings(ENABLE_EXPORT_GIT=False) def test_update_from_json_filtered_off(self): @@ -1229,7 +1070,7 @@ def test_update_from_json_filtered_off(self): }, user=self.user ) - self.assertNotIn('giturl', test_model) + self.assertNotIn('giturl', test_model) # noqa: PT009 @patch.dict(settings.FEATURES, {'ENABLE_EDXNOTES': True}) def test_edxnotes_present(self): @@ -1237,7 +1078,7 @@ def test_edxnotes_present(self): If feature flag ENABLE_EDXNOTES is on, show the setting as a non-deprecated Advanced Setting. """ test_model = CourseMetadata.fetch(self.fullcourse) - self.assertIn('edxnotes', test_model) + self.assertIn('edxnotes', test_model) # noqa: PT009 @patch.dict(settings.FEATURES, {'ENABLE_EDXNOTES': False}) def test_edxnotes_not_present(self): @@ -1245,7 +1086,7 @@ def test_edxnotes_not_present(self): If feature flag ENABLE_EDXNOTES is off, don't show the setting at all on the Advanced Settings page. """ test_model = CourseMetadata.fetch(self.fullcourse) - self.assertNotIn('edxnotes', test_model) + self.assertNotIn('edxnotes', test_model) # noqa: PT009 @patch.dict(settings.FEATURES, {'ENABLE_EDXNOTES': False}) def test_validate_update_filtered_edxnotes_off(self): @@ -1260,7 +1101,7 @@ def test_validate_update_filtered_edxnotes_off(self): }, user=self.user ) - self.assertNotIn('edxnotes', test_model) + self.assertNotIn('edxnotes', test_model) # noqa: PT009 @patch.dict(settings.FEATURES, {'ENABLE_EDXNOTES': True}) def test_validate_update_filtered_edxnotes_on(self): @@ -1275,7 +1116,7 @@ def test_validate_update_filtered_edxnotes_on(self): }, user=self.user ) - self.assertIn('edxnotes', test_model) + self.assertIn('edxnotes', test_model) # noqa: PT009 @patch.dict(settings.FEATURES, {'ENABLE_EDXNOTES': True}) def test_update_from_json_filtered_edxnotes_on(self): @@ -1289,7 +1130,7 @@ def test_update_from_json_filtered_edxnotes_on(self): }, user=self.user ) - self.assertIn('edxnotes', test_model) + self.assertIn('edxnotes', test_model) # noqa: PT009 @patch.dict(settings.FEATURES, {'ENABLE_EDXNOTES': False}) def test_update_from_json_filtered_edxnotes_off(self): @@ -1303,7 +1144,7 @@ def test_update_from_json_filtered_edxnotes_off(self): }, user=self.user ) - self.assertNotIn('edxnotes', test_model) + self.assertNotIn('edxnotes', test_model) # noqa: PT009 @patch.dict(settings.FEATURES, {'ENABLE_OTHER_COURSE_SETTINGS': True}) def test_othercoursesettings_present(self): @@ -1311,7 +1152,7 @@ def test_othercoursesettings_present(self): If feature flag ENABLE_OTHER_COURSE_SETTINGS is on, show the setting in Advanced Settings. """ test_model = CourseMetadata.fetch(self.fullcourse) - self.assertIn('other_course_settings', test_model) + self.assertIn('other_course_settings', test_model) # noqa: PT009 @patch.dict(settings.FEATURES, {'ENABLE_OTHER_COURSE_SETTINGS': False}) def test_othercoursesettings_not_present(self): @@ -1319,16 +1160,16 @@ def test_othercoursesettings_not_present(self): If feature flag ENABLE_OTHER_COURSE_SETTINGS is off, don't show the setting at all in Advanced Settings. """ test_model = CourseMetadata.fetch(self.fullcourse) - self.assertNotIn('other_course_settings', test_model) + self.assertNotIn('other_course_settings', test_model) # noqa: PT009 def test_allow_unsupported_xblocks(self): """ allow_unsupported_xblocks is only shown in Advanced Settings if XBlockStudioConfigurationFlag is enabled. """ - self.assertNotIn('allow_unsupported_xblocks', CourseMetadata.fetch(self.fullcourse)) + self.assertNotIn('allow_unsupported_xblocks', CourseMetadata.fetch(self.fullcourse)) # noqa: PT009 XBlockStudioConfigurationFlag(enabled=True).save() - self.assertIn('allow_unsupported_xblocks', CourseMetadata.fetch(self.fullcourse)) + self.assertIn('allow_unsupported_xblocks', CourseMetadata.fetch(self.fullcourse)) # noqa: PT009 def test_validate_from_json_correct_inputs(self): is_valid, errors, test_model = CourseMetadata.validate_and_update_from_json( @@ -1340,13 +1181,13 @@ def test_validate_from_json_correct_inputs(self): }, user=self.user ) - self.assertTrue(is_valid) - self.assertEqual(len(errors), 0) + self.assertTrue(is_valid) # noqa: PT009 + self.assertEqual(len(errors), 0) # noqa: PT009 self.update_check(test_model) # Tab gets tested in test_advanced_settings_munge_tabs - self.assertIn('advanced_modules', test_model, 'Missing advanced_modules') - self.assertEqual(test_model['advanced_modules']['value'], ['notes'], 'advanced_module is not updated') + self.assertIn('advanced_modules', test_model, 'Missing advanced_modules') # noqa: PT009 + self.assertEqual(test_model['advanced_modules']['value'], ['notes'], 'advanced_module is not updated') # noqa: PT009 # pylint: disable=line-too-long def test_validate_from_json_wrong_inputs(self): # input incorrectly formatted data @@ -1362,21 +1203,21 @@ def test_validate_from_json_wrong_inputs(self): ) # Check valid results from validate_and_update_from_json - self.assertFalse(is_valid) - self.assertEqual(len(errors), 3) - self.assertFalse(test_model) + self.assertFalse(is_valid) # noqa: PT009 + self.assertEqual(len(errors), 3) # noqa: PT009 + self.assertFalse(test_model) # noqa: PT009 error_keys = {error_obj['model']['display_name'] for error_obj in errors} test_keys = {'Advanced Module List', 'Course Advertised Start Date', 'Days Early for Beta Users'} - self.assertEqual(error_keys, test_keys) + self.assertEqual(error_keys, test_keys) # noqa: PT009 # try fresh fetch to ensure no update happened fresh = modulestore().get_course(self.course.id) test_model = CourseMetadata.fetch(fresh) - self.assertNotEqual(test_model['advertised_start']['value'], 1, + self.assertNotEqual(test_model['advertised_start']['value'], 1, # noqa: PT009 'advertised_start should not be updated to a wrong value') - self.assertNotEqual(test_model['days_early_for_beta']['value'], "supposed to be an integer", + self.assertNotEqual(test_model['days_early_for_beta']['value'], "supposed to be an integer", # noqa: PT009 'days_early_for beta should not be updated to a wrong value') def test_correct_http_status(self): @@ -1389,7 +1230,7 @@ def test_correct_http_status(self): "advanced_modules": {"value": 1, "display_name": "Advanced Module List", }, }) response = self.client.ajax_post(self.course_setting_url, json_data) - self.assertEqual(400, response.status_code) + self.assertEqual(400, response.status_code) # noqa: PT009 def test_update_from_json(self): test_model = CourseMetadata.update_from_json( @@ -1414,36 +1255,36 @@ def test_update_from_json(self): }, user=self.user ) - self.assertIn('display_name', test_model, 'Missing editable metadata field') - self.assertEqual(test_model['display_name']['value'], 'jolly roger', "not expected value") - self.assertIn('advertised_start', test_model, 'Missing revised advertised_start metadata field') - self.assertEqual(test_model['advertised_start']['value'], 'start B', "advertised_start not expected value") + self.assertIn('display_name', test_model, 'Missing editable metadata field') # noqa: PT009 + self.assertEqual(test_model['display_name']['value'], 'jolly roger', "not expected value") # noqa: PT009 + self.assertIn('advertised_start', test_model, 'Missing revised advertised_start metadata field') # noqa: PT009 + self.assertEqual(test_model['advertised_start']['value'], 'start B', "advertised_start not expected value") # noqa: PT009 # pylint: disable=line-too-long def update_check(self, test_model): """ checks that updates were made """ - self.assertIn('display_name', test_model, 'Missing editable metadata field') - self.assertEqual(test_model['display_name']['value'], self.course.display_name) - self.assertIn('advertised_start', test_model, 'Missing new advertised_start metadata field') - self.assertEqual(test_model['advertised_start']['value'], 'start A', "advertised_start not expected value") - self.assertIn('days_early_for_beta', test_model, 'Missing days_early_for_beta metadata field') - self.assertEqual(test_model['days_early_for_beta']['value'], 2, "days_early_for_beta not expected value") + self.assertIn('display_name', test_model, 'Missing editable metadata field') # noqa: PT009 + self.assertEqual(test_model['display_name']['value'], self.course.display_name) # noqa: PT009 + self.assertIn('advertised_start', test_model, 'Missing new advertised_start metadata field') # noqa: PT009 + self.assertEqual(test_model['advertised_start']['value'], 'start A', "advertised_start not expected value") # noqa: PT009 # pylint: disable=line-too-long + self.assertIn('days_early_for_beta', test_model, 'Missing days_early_for_beta metadata field') # noqa: PT009 + self.assertEqual(test_model['days_early_for_beta']['value'], 2, "days_early_for_beta not expected value") # noqa: PT009 # pylint: disable=line-too-long def test_http_fetch_initial_fields(self): response = self.client.get_json(self.course_setting_url) test_model = json.loads(response.content.decode('utf-8')) - self.assertIn('display_name', test_model, 'Missing editable metadata field') - self.assertEqual(test_model['display_name']['value'], self.course.display_name) + self.assertIn('display_name', test_model, 'Missing editable metadata field') # noqa: PT009 + self.assertEqual(test_model['display_name']['value'], self.course.display_name) # noqa: PT009 response = self.client.get_json(self.fullcourse_setting_url) test_model = json.loads(response.content.decode('utf-8')) - self.assertNotIn('graceperiod', test_model, 'blacklisted field leaked in') - self.assertIn('display_name', test_model, 'full missing editable metadata field') - self.assertEqual(test_model['display_name']['value'], self.fullcourse.display_name) - self.assertIn('rerandomize', test_model, 'Missing rerandomize metadata field') - self.assertIn('showanswer', test_model, 'showanswer field ') - self.assertIn('xqa_key', test_model, 'xqa_key field ') + self.assertNotIn('graceperiod', test_model, 'blacklisted field leaked in') # noqa: PT009 + self.assertIn('display_name', test_model, 'full missing editable metadata field') # noqa: PT009 + self.assertEqual(test_model['display_name']['value'], self.fullcourse.display_name) # noqa: PT009 + self.assertIn('rerandomize', test_model, 'Missing rerandomize metadata field') # noqa: PT009 + self.assertIn('showanswer', test_model, 'showanswer field ') # noqa: PT009 + self.assertIn('xqa_key', test_model, 'xqa_key field ') # noqa: PT009 def test_http_update_from_json(self): response = self.client.ajax_post(self.course_setting_url, { @@ -1462,10 +1303,10 @@ def test_http_update_from_json(self): "display_name": {"value": "jolly roger"} }) test_model = json.loads(response.content.decode('utf-8')) - self.assertIn('display_name', test_model, 'Missing editable metadata field') - self.assertEqual(test_model['display_name']['value'], 'jolly roger', "not expected value") - self.assertIn('advertised_start', test_model, 'Missing revised advertised_start metadata field') - self.assertEqual(test_model['advertised_start']['value'], 'start B', "advertised_start not expected value") + self.assertIn('display_name', test_model, 'Missing editable metadata field') # noqa: PT009 + self.assertEqual(test_model['display_name']['value'], 'jolly roger', "not expected value") # noqa: PT009 + self.assertIn('advertised_start', test_model, 'Missing revised advertised_start metadata field') # noqa: PT009 + self.assertEqual(test_model['advertised_start']['value'], 'start B', "advertised_start not expected value") # noqa: PT009 # pylint: disable=line-too-long @patch.dict(settings.FEATURES, {'ENABLE_EDXNOTES': True}) @patch('xmodule.util.xmodule_django.get_current_request') @@ -1482,7 +1323,7 @@ def test_post_settings_with_staff_not_enrolled(self, mock_request): response = self.client.ajax_post(self.course_setting_url, { 'advanced_modules': {"value": [""]} }) - self.assertEqual(response.status_code, 200) + self.assertEqual(response.status_code, 200) # noqa: PT009 @ddt.data(True, False) @override_settings( @@ -1510,20 +1351,20 @@ def test_validate_update_does_not_allow_proctoring_provider_changes_after_course ) if staff_user: - self.assertTrue(did_validate) - self.assertEqual(len(errors), 0) - self.assertIn(field_name, test_model) + self.assertTrue(did_validate) # noqa: PT009 + self.assertEqual(len(errors), 0) # noqa: PT009 + self.assertIn(field_name, test_model) # noqa: PT009 else: - self.assertFalse(did_validate) - self.assertEqual(len(errors), 1) - self.assertEqual( + self.assertFalse(did_validate) # noqa: PT009 + self.assertEqual(len(errors), 1) # noqa: PT009 + self.assertEqual( # noqa: PT009 errors[0].get('message'), ( 'The proctoring provider cannot be modified after a course has started.' ' Contact support@foobar.com for assistance' ) ) - self.assertIsNone(test_model) + self.assertIsNone(test_model) # noqa: PT009 @ddt.data(True, False) @override_settings( @@ -1546,10 +1387,10 @@ def test_validate_update_requires_escalation_email_if_relevant_flag_is_set(self, json_data, user=self.user ) - self.assertFalse(did_validate) - self.assertEqual(len(errors), 1) - self.assertIsNone(test_model) - self.assertEqual( + self.assertFalse(did_validate) # noqa: PT009 + self.assertEqual(len(errors), 1) # noqa: PT009 + self.assertIsNone(test_model) # noqa: PT009 + self.assertEqual( # noqa: PT009 errors[0].get('message'), 'Provider \'test_proctoring_provider\' requires an exam escalation contact.' ) @@ -1568,9 +1409,9 @@ def test_validate_update_does_not_require_escalation_email_by_default(self): }, user=self.user ) - self.assertTrue(did_validate) - self.assertEqual(len(errors), 0) - self.assertIn('proctoring_provider', test_model) + self.assertTrue(did_validate) # noqa: PT009 + self.assertEqual(len(errors), 0) # noqa: PT009 + self.assertIn('proctoring_provider', test_model) # noqa: PT009 @override_settings( PROCTORING_BACKENDS={ @@ -1592,10 +1433,10 @@ def test_validate_update_cannot_unset_escalation_email_when_requires_escalation_ }, user=self.user ) - self.assertFalse(did_validate) - self.assertEqual(len(errors), 1) - self.assertIsNone(test_model) - self.assertEqual( + self.assertFalse(did_validate) # noqa: PT009 + self.assertEqual(len(errors), 1) # noqa: PT009 + self.assertIsNone(test_model) # noqa: PT009 + self.assertEqual( # noqa: PT009 errors[0].get('message'), 'Provider \'test_proctoring_provider\' requires an exam escalation contact.' ) @@ -1615,10 +1456,10 @@ def test_validate_update_set_proctoring_provider_with_valid_escalation_email(sel }, user=self.user ) - self.assertTrue(did_validate) - self.assertEqual(len(errors), 0) - self.assertIn('proctoring_provider', test_model) - self.assertIn('proctoring_escalation_email', test_model) + self.assertTrue(did_validate) # noqa: PT009 + self.assertEqual(len(errors), 0) # noqa: PT009 + self.assertIn('proctoring_provider', test_model) # noqa: PT009 + self.assertIn('proctoring_escalation_email', test_model) # noqa: PT009 @override_settings( PROCTORING_BACKENDS={ @@ -1644,9 +1485,9 @@ def test_validate_update_disable_proctoring_with_no_escalation_email(self): }, user=self.user ) - self.assertTrue(did_validate) - self.assertEqual(len(errors), 0) - self.assertIn('enable_proctored_exams', test_model) + self.assertTrue(did_validate) # noqa: PT009 + self.assertEqual(len(errors), 0) # noqa: PT009 + self.assertIn('enable_proctored_exams', test_model) # noqa: PT009 @override_settings( PROCTORING_BACKENDS={ @@ -1664,11 +1505,11 @@ def test_validate_update_disable_proctoring_and_change_escalation_email(self): }, user=self.user ) - self.assertTrue(did_validate) - self.assertEqual(len(errors), 0) - self.assertIn('proctoring_provider', test_model) - self.assertIn('proctoring_escalation_email', test_model) - self.assertIn('enable_proctored_exams', test_model) + self.assertTrue(did_validate) # noqa: PT009 + self.assertEqual(len(errors), 0) # noqa: PT009 + self.assertIn('proctoring_provider', test_model) # noqa: PT009 + self.assertIn('proctoring_escalation_email', test_model) # noqa: PT009 + self.assertIn('enable_proctored_exams', test_model) # noqa: PT009 @override_settings( PROCTORING_BACKENDS={ @@ -1690,11 +1531,11 @@ def test_validate_update_disabled_proctoring_and_unset_escalation_email(self): }, user=self.user ) - self.assertTrue(did_validate) - self.assertEqual(len(errors), 0) - self.assertIn('proctoring_provider', test_model) - self.assertIn('proctoring_escalation_email', test_model) - self.assertIn('enable_proctored_exams', test_model) + self.assertTrue(did_validate) # noqa: PT009 + self.assertEqual(len(errors), 0) # noqa: PT009 + self.assertIn('proctoring_provider', test_model) # noqa: PT009 + self.assertIn('proctoring_escalation_email', test_model) # noqa: PT009 + self.assertIn('enable_proctored_exams', test_model) # noqa: PT009 def test_create_zendesk_tickets_present_for_edx_staff(self): """ @@ -1703,7 +1544,7 @@ def test_create_zendesk_tickets_present_for_edx_staff(self): self._set_request_user_to_staff() test_model = CourseMetadata.fetch(self.fullcourse) - self.assertIn('create_zendesk_tickets', test_model) + self.assertIn('create_zendesk_tickets', test_model) # noqa: PT009 def test_validate_update_does_not_filter_out_create_zendesk_tickets_for_edx_staff(self): """ @@ -1721,7 +1562,7 @@ def test_validate_update_does_not_filter_out_create_zendesk_tickets_for_edx_staf }, user=self.user ) - self.assertIn(field_name, test_model) + self.assertIn(field_name, test_model) # noqa: PT009 def test_update_from_json_does_not_filter_out_create_zendesk_tickets_for_edx_staff(self): """ @@ -1739,7 +1580,7 @@ def test_update_from_json_does_not_filter_out_create_zendesk_tickets_for_edx_sta }, user=self.user ) - self.assertIn(field_name, test_model) + self.assertIn(field_name, test_model) # noqa: PT009 def test_validate_update_does_not_filter_out_create_zendesk_tickets_for_course_staff(self): """ @@ -1755,7 +1596,7 @@ def test_validate_update_does_not_filter_out_create_zendesk_tickets_for_course_s }, user=self.user ) - self.assertIn(field_name, test_model) + self.assertIn(field_name, test_model) # noqa: PT009 def test_update_from_json_does_not_filter_out_create_zendesk_tickets_for_course_staff(self): """ @@ -1771,7 +1612,7 @@ def test_update_from_json_does_not_filter_out_create_zendesk_tickets_for_course_ }, user=self.user ) - self.assertIn(field_name, test_model) + self.assertIn(field_name, test_model) # noqa: PT009 def _set_request_user_to_staff(self): """ @@ -1816,9 +1657,9 @@ def test_team_content_groups_off(self): user=self.user ) - self.assertEqual(len(errors), 0) + self.assertEqual(len(errors), 0) # noqa: PT009 for team_set in updated_data["teams_configuration"]["value"]["team_sets"]: - self.assertNotIn("user_partition_id", team_set) + self.assertNotIn("user_partition_id", team_set) # noqa: PT009 @patch("cms.djangoapps.models.settings.course_metadata.CONTENT_GROUPS_FOR_TEAMS.is_enabled", lambda _: True) def test_team_content_groups_on(self): @@ -1856,9 +1697,9 @@ def test_team_content_groups_on(self): user=self.user ) - self.assertEqual(len(errors), 0) + self.assertEqual(len(errors), 0) # noqa: PT009 for team_set in updated_data["teams_configuration"]["value"]["team_sets"]: - self.assertIn("user_partition_id", team_set) + self.assertIn("user_partition_id", team_set) # noqa: PT009 class CourseGraderUpdatesTest(CourseTestCase): @@ -1875,17 +1716,17 @@ def setUp(self): def test_get(self): """Test getting a specific grading type record.""" resp = self.client.get_json(self.url + '/0') - self.assertEqual(resp.status_code, 200) + self.assertEqual(resp.status_code, 200) # noqa: PT009 obj = json.loads(resp.content.decode('utf-8')) - self.assertEqual(self.starting_graders[0], obj) + self.assertEqual(self.starting_graders[0], obj) # noqa: PT009 def test_delete(self): """Test deleting a specific grading type record.""" resp = self.client.delete(self.url + '/0', HTTP_ACCEPT="application/json") - self.assertEqual(resp.status_code, 204) + self.assertEqual(resp.status_code, 204) # noqa: PT009 current_graders = CourseGradingModel.fetch(self.course.id).graders - self.assertNotIn(self.starting_graders[0], current_graders) - self.assertEqual(len(self.starting_graders) - 1, len(current_graders)) + self.assertNotIn(self.starting_graders[0], current_graders) # noqa: PT009 + self.assertEqual(len(self.starting_graders) - 1, len(current_graders)) # noqa: PT009 def test_update(self): """Test updating a specific grading type record.""" @@ -1898,11 +1739,11 @@ def test_update(self): "weight": 17.3, } resp = self.client.ajax_post(self.url + '/0', grader) - self.assertEqual(resp.status_code, 200) + self.assertEqual(resp.status_code, 200) # noqa: PT009 obj = json.loads(resp.content.decode('utf-8')) - self.assertEqual(obj, grader) + self.assertEqual(obj, grader) # noqa: PT009 current_graders = CourseGradingModel.fetch(self.course.id).graders - self.assertEqual(len(self.starting_graders), len(current_graders)) + self.assertEqual(len(self.starting_graders), len(current_graders)) # noqa: PT009 def test_add(self): """Test adding a grading type record.""" @@ -1917,139 +1758,10 @@ def test_add(self): "weight": 17.3, } resp = self.client.ajax_post(f'{self.url}/{len(self.starting_graders) + 1}', grader) - self.assertEqual(resp.status_code, 200) + self.assertEqual(resp.status_code, 200) # noqa: PT009 obj = json.loads(resp.content.decode('utf-8')) - self.assertEqual(obj['id'], len(self.starting_graders)) + self.assertEqual(obj['id'], len(self.starting_graders)) # noqa: PT009 del obj['id'] - self.assertEqual(obj, grader) + self.assertEqual(obj, grader) # noqa: PT009 current_graders = CourseGradingModel.fetch(self.course.id).graders - self.assertEqual(len(self.starting_graders) + 1, len(current_graders)) - - -class CourseEnrollmentEndFieldTest(CourseTestCase): - """ - Base class to test the enrollment end fields in the course settings details view in Studio - when using marketing site flag and global vs non-global staff to access the page. - """ - - NOT_EDITABLE_HELPER_MESSAGE = "Contact your edX partner manager to update these settings." - NOT_EDITABLE_DATE_WRAPPER = "
" - NOT_EDITABLE_TIME_WRAPPER = "
" - NOT_EDITABLE_DATE_FIELD = "" - NOT_EDITABLE_TIME_FIELD = "" - - EDITABLE_DATE_WRAPPER = "
" - EDITABLE_TIME_WRAPPER = "
" - EDITABLE_DATE_FIELD = "" - EDITABLE_TIME_FIELD = "" - - EDITABLE_ELEMENTS = [ - EDITABLE_DATE_WRAPPER, - EDITABLE_TIME_WRAPPER, - EDITABLE_DATE_FIELD, - EDITABLE_TIME_FIELD, - ] - - NOT_EDITABLE_ELEMENTS = [ - NOT_EDITABLE_HELPER_MESSAGE, - NOT_EDITABLE_DATE_WRAPPER, - NOT_EDITABLE_TIME_WRAPPER, - NOT_EDITABLE_DATE_FIELD, - NOT_EDITABLE_TIME_FIELD, - ] - - def setUp(self): - """ - Initialize course used to test enrollment fields. - """ - super().setUp() - self.course = CourseFactory.create(org='edX', number='dummy', display_name='Marketing Site Course') - self.course_details_url = reverse_course_url('settings_handler', str(self.course.id)) - - def _get_course_details_response(self, global_staff): - """ - Return the course details page as either global or non-global staff - """ - user = UserFactory(is_staff=global_staff, password=self.TEST_PASSWORD) - CourseInstructorRole(self.course.id).add_users(user) - - self.client.login(username=user.username, password=self.TEST_PASSWORD) - - return self.client.get_html(self.course_details_url) - - def _verify_editable(self, response): - """ - Verify that the response has expected editable fields. - - Assert that all editable field content exists and no - uneditable field content exists for enrollment end fields. - """ - self.assertEqual(response.status_code, 200) - for element in self.NOT_EDITABLE_ELEMENTS: - self.assertNotContains(response, element) - - for element in self.EDITABLE_ELEMENTS: - self.assertContains(response, element) - - def _verify_not_editable(self, response): - """ - Verify that the response has expected non-editable fields. - - Assert that all uneditable field content exists and no - editable field content exists for enrollment end fields. - """ - self.assertEqual(response.status_code, 200) - for element in self.NOT_EDITABLE_ELEMENTS: - self.assertContains(response, element) - - for element in self.EDITABLE_ELEMENTS: - self.assertNotContains(response, element) - - @mock.patch.dict("django.conf.settings.FEATURES", {'ENABLE_PUBLISHER': False}) - @override_waffle_flag(toggles.LEGACY_STUDIO_SCHEDULE_DETAILS, True) - def test_course_details_with_disabled_setting_global_staff(self): - """ - Test that user enrollment end date is editable in response. - - Feature flag 'ENABLE_PUBLISHER' is not enabled. - User is global staff. - """ - self._verify_editable(self._get_course_details_response(True)) - - @mock.patch.dict("django.conf.settings.FEATURES", {'ENABLE_PUBLISHER': False}) - @override_waffle_flag(toggles.LEGACY_STUDIO_SCHEDULE_DETAILS, True) - def test_course_details_with_disabled_setting_non_global_staff(self): - """ - Test that user enrollment end date is editable in response. - - Feature flag 'ENABLE_PUBLISHER' is not enabled. - User is non-global staff. - """ - self._verify_editable(self._get_course_details_response(False)) - - @mock.patch.dict("django.conf.settings.FEATURES", {'ENABLE_PUBLISHER': True}) - @override_waffle_flag(toggles.LEGACY_STUDIO_SCHEDULE_DETAILS, True) - def test_course_details_with_enabled_setting_global_staff(self): - """ - Test that user enrollment end date is editable in response. - - Feature flag 'ENABLE_PUBLISHER' is enabled. - User is global staff. - """ - self._verify_editable(self._get_course_details_response(True)) - - @mock.patch.dict("django.conf.settings.FEATURES", {'ENABLE_PUBLISHER': True}) - @override_settings(PLATFORM_NAME='edX') - @override_waffle_flag(toggles.LEGACY_STUDIO_SCHEDULE_DETAILS, True) - def test_course_details_with_enabled_setting_non_global_staff(self): - """ - Test that user enrollment end date is not editable in response. - - Feature flag 'ENABLE_PUBLISHER' is enabled. - User is non-global staff. - """ - self._verify_not_editable(self._get_course_details_response(False)) + self.assertEqual(len(self.starting_graders) + 1, len(current_graders)) # noqa: PT009 diff --git a/cms/djangoapps/contentstore/tests/test_courseware_index.py b/cms/djangoapps/contentstore/tests/test_courseware_index.py index 3ab3fa373f81..7c59773bd871 100644 --- a/cms/djangoapps/contentstore/tests/test_courseware_index.py +++ b/cms/djangoapps/contentstore/tests/test_courseware_index.py @@ -5,7 +5,7 @@ import time from datetime import datetime from unittest import skip -from unittest.mock import patch, Mock +from unittest.mock import Mock, patch import ddt import pytest @@ -18,7 +18,7 @@ CourseAboutSearchIndexer, CoursewareSearchIndexer, LibrarySearchIndexer, - SearchIndexingError + SearchIndexingError, ) from cms.djangoapps.contentstore.signals.handlers import listen_for_course_publish, listen_for_library_update from cms.djangoapps.contentstore.tasks import update_search_index @@ -27,16 +27,20 @@ from common.djangoapps.course_modes.models import CourseMode from common.djangoapps.course_modes.tests.factories import CourseModeFactory from openedx.core.djangoapps.models.course_details import CourseDetails -from xmodule.library_tools import normalize_key_for_search # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore import ModuleStoreEnum # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.django import SignalHandler, modulestore # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.django_utils import ( # lint-amnesty, pylint: disable=wrong-import-order - ModuleStoreTestCase, +from xmodule.library_tools import normalize_key_for_search # pylint: disable=wrong-import-order +from xmodule.modulestore import ModuleStoreEnum # pylint: disable=wrong-import-order +from xmodule.modulestore.django import SignalHandler, modulestore # pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( # pylint: disable=wrong-import-order TEST_DATA_SPLIT_MODULESTORE, + ModuleStoreTestCase, SharedModuleStoreTestCase, ) -from xmodule.modulestore.tests.factories import CourseFactory, BlockFactory, LibraryFactory # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.partitions.partitions import UserPartition # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.factories import ( # pylint: disable=wrong-import-order + BlockFactory, + CourseFactory, + LibraryFactory, +) +from xmodule.partitions.partitions import UserPartition # pylint: disable=wrong-import-order COURSE_CHILD_STRUCTURE = { "course": "chapter", @@ -53,7 +57,7 @@ def create_children(store, parent, category, load_factor): child_object = BlockFactory.create( parent_location=parent.location, category=category, - display_name=f"{category} {child_index} {time.clock()}", # lint-amnesty, pylint: disable=no-member + display_name=f"{category} {child_index} {time.clock()}", # pylint: disable=no-member modulestore=store, publish_item=True, start=datetime(2015, 3, 1, tzinfo=UTC), @@ -85,7 +89,7 @@ class MixedWithOptionsTestCase(ModuleStoreTestCase): def setup_course_base(self, store): """ base version of setup_course_base is a no-op """ - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass @lazy def searcher(self): @@ -208,15 +212,15 @@ def _test_indexing_course(self, store): """ indexing course tests """ # Only published blocks should be in the index added_to_index = self.reindex_course(store) # This reindex may not be necessary (it may already be indexed) - self.assertEqual(added_to_index, 3) + self.assertEqual(added_to_index, 3) # noqa: PT009 response = self.search() - self.assertEqual(response["total"], 3) + self.assertEqual(response["total"], 3) # noqa: PT009 # Publish the vertical as is, and any unpublished children should now be available self.publish_item(store, self.vertical.location) self.reindex_course(store) response = self.search() - self.assertEqual(response["total"], 4) + self.assertEqual(response["total"], 4) # noqa: PT009 def _test_not_indexing_unpublished_content(self, store): """ add a new one, only appers in index once added """ @@ -224,7 +228,7 @@ def _test_not_indexing_unpublished_content(self, store): self.publish_item(store, self.vertical.location) self.reindex_course(store) response = self.search() - self.assertEqual(response["total"], 4) + self.assertEqual(response["total"], 4) # noqa: PT009 # Now add a new unit to the existing vertical BlockFactory.create( @@ -236,14 +240,14 @@ def _test_not_indexing_unpublished_content(self, store): ) self.reindex_course(store) response = self.search() - self.assertEqual(response["total"], 4) + self.assertEqual(response["total"], 4) # noqa: PT009 # Now publish it and we should find it # Publish the vertical as is, and everything should be available self.publish_item(store, self.vertical.location) self.reindex_course(store) response = self.search() - self.assertEqual(response["total"], 5) + self.assertEqual(response["total"], 5) # noqa: PT009 def _test_delete_course_from_search_index_after_course_deletion(self, store): # pylint: disable=invalid-name """ @@ -253,14 +257,14 @@ def _test_delete_course_from_search_index_after_course_deletion(self, store): # # index the course in search_index (it may already be indexed) self.reindex_course(store) response = self.search() - self.assertEqual(response["total"], 1) + self.assertEqual(response["total"], 1) # noqa: PT009 # delete the course and look course in search_index store.delete_course(self.course.id, ModuleStoreEnum.UserID.test) - self.assertIsNone(store.get_course(self.course.id)) + self.assertIsNone(store.get_course(self.course.id)) # noqa: PT009 # Now, because of contentstore.signals.handlers.listen_for_course_delete, the index should already be updated: response = self.search() - self.assertEqual(response["total"], 0) + self.assertEqual(response["total"], 0) # noqa: PT009 def _test_deleting_item(self, store): """ test deleting an item """ @@ -268,19 +272,19 @@ def _test_deleting_item(self, store): self.publish_item(store, self.vertical.location) self.reindex_course(store) response = self.search() - self.assertEqual(response["total"], 4) + self.assertEqual(response["total"], 4) # noqa: PT009 # just a delete should not change anything self.delete_item(store, self.html_unit.location) self.reindex_course(store) response = self.search() - self.assertEqual(response["total"], 4) + self.assertEqual(response["total"], 4) # noqa: PT009 # but after publishing, we should no longer find the html_unit self.publish_item(store, self.vertical.location) self.reindex_course(store) response = self.search() - self.assertEqual(response["total"], 3) + self.assertEqual(response["total"], 3) # noqa: PT009 def _test_start_date_propagation(self, store): """ make sure that the start date is applied at the right level """ @@ -291,7 +295,7 @@ def _test_start_date_propagation(self, store): self.publish_item(store, self.vertical.location) self.reindex_course(store) response = self.search() - self.assertEqual(response["total"], 4) + self.assertEqual(response["total"], 4) # noqa: PT009 results = response["results"] date_map = { @@ -301,19 +305,19 @@ def _test_start_date_propagation(self, store): str(self.html_unit.location): later_date, } for result in results: - self.assertEqual(result["data"]["start_date"], date_map[result["data"]["id"]]) + self.assertEqual(result["data"]["start_date"], date_map[result["data"]["id"]]) # noqa: PT009 @patch('django.conf.settings.SEARCH_ENGINE', None) def _test_search_disabled(self, store): """ if search setting has it as off, confirm that nothing is indexed """ indexed_count = self.reindex_course(store) - self.assertFalse(indexed_count) + self.assertFalse(indexed_count) # noqa: PT009 def _test_time_based_index(self, store): """ Make sure that a time based request to index does not index anything too old """ self.publish_item(store, self.vertical.location) indexed_count = self.reindex_course(store) - self.assertEqual(indexed_count, 4) + self.assertEqual(indexed_count, 4) # noqa: PT009 # Add a new sequential sequential2 = BlockFactory.create( @@ -347,11 +351,11 @@ def _test_time_based_index(self, store): # because it is in a common subtree but not of the original vertical # because the original sequential's subtree is too old new_indexed_count = self.index_recent_changes(store, before_time) - self.assertEqual(new_indexed_count, 5) + self.assertEqual(new_indexed_count, 5) # noqa: PT009 # full index again indexed_count = self.reindex_course(store) - self.assertEqual(indexed_count, 7) + self.assertEqual(indexed_count, 7) # noqa: PT009 def _test_course_about_property_index(self, store): """ @@ -365,8 +369,8 @@ def _test_course_about_property_index(self, store): response = self.searcher.search( field_dictionary={"course": str(self.course.id)} ) - self.assertEqual(response["total"], 1) - self.assertEqual(response["results"][0]["data"]["content"]["display_name"], display_name) + self.assertEqual(response["total"], 1) # noqa: PT009 + self.assertEqual(response["results"][0]["data"]["content"]["display_name"], display_name) # noqa: PT009 def _test_course_about_store_index(self, store): """ @@ -382,8 +386,8 @@ def _test_course_about_store_index(self, store): response = self.searcher.search( field_dictionary={"course": str(self.course.id)} ) - self.assertEqual(response["total"], 1) - self.assertEqual(response["results"][0]["data"]["content"]["short_description"], short_description) + self.assertEqual(response["total"], 1) # noqa: PT009 + self.assertEqual(response["results"][0]["data"]["content"]["short_description"], short_description) # noqa: PT009 # pylint: disable=line-too-long def _test_course_about_mode_index(self, store): """ @@ -409,20 +413,20 @@ def _test_course_about_mode_index(self, store): response = self.searcher.search( field_dictionary={"course": str(self.course.id)} ) - self.assertEqual(response["total"], 1) - self.assertIn(CourseMode.HONOR, response["results"][0]["data"]["modes"]) - self.assertIn(CourseMode.VERIFIED, response["results"][0]["data"]["modes"]) + self.assertEqual(response["total"], 1) # noqa: PT009 + self.assertIn(CourseMode.HONOR, response["results"][0]["data"]["modes"]) # noqa: PT009 + self.assertIn(CourseMode.VERIFIED, response["results"][0]["data"]["modes"]) # noqa: PT009 def _test_course_location_info(self, store): """ Test that course location information is added to index """ self.publish_item(store, self.vertical.location) self.reindex_course(store) response = self.search(query_string="Html Content") - self.assertEqual(response["total"], 1) + self.assertEqual(response["total"], 1) # noqa: PT009 result = response["results"][0]["data"] - self.assertEqual(result["course_name"], "Search Index Test Course") - self.assertEqual(result["location"], ["Week 1", "Lesson 1", "Subsection 1"]) + self.assertEqual(result["course_name"], "Search Index Test Course") # noqa: PT009 + self.assertEqual(result["location"], ["Week 1", "Lesson 1", "Subsection 1"]) # noqa: PT009 def _test_course_location_null(self, store): """ Test that course location information is added to index """ @@ -451,17 +455,17 @@ def _test_course_location_null(self, store): ) self.reindex_course(store) response = self.search(query_string="Find Me") - self.assertEqual(response["total"], 1) + self.assertEqual(response["total"], 1) # noqa: PT009 result = response["results"][0]["data"] - self.assertEqual(result["course_name"], "Search Index Test Course") - self.assertEqual(result["location"], ["Week 1", CoursewareSearchIndexer.UNNAMED_MODULE_NAME, "Subsection 2"]) + self.assertEqual(result["course_name"], "Search Index Test Course") # noqa: PT009 + self.assertEqual(result["location"], ["Week 1", CoursewareSearchIndexer.UNNAMED_MODULE_NAME, "Subsection 2"]) # noqa: PT009 # pylint: disable=line-too-long @patch('django.conf.settings.SEARCH_ENGINE', 'search.tests.utils.ErroringIndexEngine') def _test_exception(self, store): """ Test that exception within indexing yields a SearchIndexingError """ self.publish_item(store, self.vertical.location) - with self.assertRaises(SearchIndexingError): + with self.assertRaises(SearchIndexingError): # noqa: PT027 self.reindex_course(store) def test_indexing_course(self): @@ -541,7 +545,7 @@ def assert_search_count(self, expected_count): """ Check that the search within this course will yield the expected number of results """ response = self.searcher.search(field_dictionary={"course": self.course_id}) - self.assertEqual(response["total"], expected_count) + self.assertEqual(response["total"], expected_count) # noqa: PT009 def _do_test_large_course_deletion(self, store, load_factor): """ Test that deleting items from a course works even when present within a very large course """ @@ -667,7 +671,7 @@ def test_task_indexing_course(self): response = searcher.search( field_dictionary={"course": str(self.course.id)} ) - self.assertEqual(response["total"], 0) + self.assertEqual(response["total"], 0) # noqa: PT009 listen_for_course_publish(self, self.course.id) @@ -675,20 +679,20 @@ def test_task_indexing_course(self): response = searcher.search( field_dictionary={"course": str(self.course.id)} ) - self.assertEqual(response["total"], 3) + self.assertEqual(response["total"], 3) # noqa: PT009 def test_task_library_update(self): """ Making sure that the receiver correctly fires off the task when invoked by signal """ searcher = SearchEngine.get_search_engine(LibrarySearchIndexer.INDEX_NAME) library_search_key = str(normalize_key_for_search(self.library.location.library_key)) response = searcher.search(field_dictionary={"library": library_search_key}) - self.assertEqual(response["total"], 0) + self.assertEqual(response["total"], 0) # noqa: PT009 listen_for_library_update(self, self.library.location.library_key) # Note that this test will only succeed if celery is working in inline mode response = searcher.search(field_dictionary={"library": library_search_key}) - self.assertEqual(response["total"], 2) + self.assertEqual(response["total"], 2) # noqa: PT009 def test_ignore_ccx(self): """Test that we ignore CCX courses (it's too slow now).""" @@ -697,12 +701,12 @@ def test_ignore_ccx(self): # fall through to the normal indexing and raise an exception because # there is no data or backing course behind the course key. with patch('cms.djangoapps.contentstore.courseware_index.CoursewareSearchIndexer.index') as mock_index: - self.assertIsNone( + self.assertIsNone( # noqa: PT009 update_search_index( "ccx-v1:OpenEdX+FAKECOURSE+FAKERUN+ccx@1", "2020-09-28T16:41:57.150796" ) ) - self.assertFalse(mock_index.called) + self.assertFalse(mock_index.called) # noqa: PT009 @pytest.mark.django_db @@ -760,18 +764,18 @@ def _test_indexing_library(self, store): """ indexing course tests """ self.reindex_library(store) response = self.search() - self.assertEqual(response["total"], 2) + self.assertEqual(response["total"], 2) # noqa: PT009 added_to_index = self.reindex_library(store) - self.assertEqual(added_to_index, 2) + self.assertEqual(added_to_index, 2) # noqa: PT009 response = self.search() - self.assertEqual(response["total"], 2) + self.assertEqual(response["total"], 2) # noqa: PT009 def _test_creating_item(self, store): """ test updating an item """ self.reindex_library(store) response = self.search() - self.assertEqual(response["total"], 2) + self.assertEqual(response["total"], 2) # noqa: PT009 # updating a library item causes immediate reindexing data = "Some data" @@ -786,15 +790,15 @@ def _test_creating_item(self, store): self.reindex_library(store) response = self.search() - self.assertEqual(response["total"], 3) + self.assertEqual(response["total"], 3) # noqa: PT009 html_contents = [cont['html_content'] for cont in self._get_contents(response)] - self.assertIn(data, html_contents) + self.assertIn(data, html_contents) # noqa: PT009 def _test_updating_item(self, store): """ test updating an item """ self.reindex_library(store) response = self.search() - self.assertEqual(response["total"], 2) + self.assertEqual(response["total"], 2) # noqa: PT009 # updating a library item causes immediate reindexing new_data = "I'm new data" @@ -802,32 +806,32 @@ def _test_updating_item(self, store): self.update_item(store, self.html_unit1) self.reindex_library(store) response = self.search() - self.assertEqual(response["total"], 2) + self.assertEqual(response["total"], 2) # noqa: PT009 html_contents = [cont['html_content'] for cont in self._get_contents(response)] - self.assertIn(new_data, html_contents) + self.assertIn(new_data, html_contents) # noqa: PT009 def _test_deleting_item(self, store): """ test deleting an item """ self.reindex_library(store) response = self.search() - self.assertEqual(response["total"], 2) + self.assertEqual(response["total"], 2) # noqa: PT009 # deleting a library item causes immediate reindexing self.delete_item(store, self.html_unit1.location) self.reindex_library(store) response = self.search() - self.assertEqual(response["total"], 1) + self.assertEqual(response["total"], 1) # noqa: PT009 @patch('django.conf.settings.SEARCH_ENGINE', None) def _test_search_disabled(self, store): """ if search setting has it as off, confirm that nothing is indexed """ indexed_count = self.reindex_library(store) - self.assertFalse(indexed_count) + self.assertFalse(indexed_count) # noqa: PT009 @patch('django.conf.settings.SEARCH_ENGINE', 'search.tests.utils.ErroringIndexEngine') def _test_exception(self, store): """ Test that exception within indexing yields a SearchIndexingError """ - with self.assertRaises(SearchIndexingError): + with self.assertRaises(SearchIndexingError): # noqa: PT027 self.reindex_library(store) @ddt.data(*WORKS_WITH_STORES) @@ -1173,9 +1177,9 @@ def test_content_group_gets_indexed(self): # Only published blocks should be in the index added_to_index = self.reindex_course(self.store) - self.assertEqual(added_to_index, 16) + self.assertEqual(added_to_index, 16) # noqa: PT009 response = self.searcher.search(field_dictionary={"course": str(self.course.id)}) - self.assertEqual(response["total"], 16) + self.assertEqual(response["total"], 16) # noqa: PT009 group_access_content = {'group_access': {666: [1]}} @@ -1189,46 +1193,46 @@ def test_content_group_gets_indexed(self): with patch(settings.SEARCH_ENGINE + '.index') as mock_index: self.reindex_course(self.store) - self.assertTrue(mock_index.called) + self.assertTrue(mock_index.called) # noqa: PT009 indexed_content = self._get_index_values_from_call_args(mock_index) - self.assertIn(self._html_group_result(self.html_unit1, [1]), indexed_content) - self.assertIn(self._html_experiment_group_result(self.html_unit4, [str(2)]), indexed_content) - self.assertIn(self._html_experiment_group_result(self.html_unit5, [str(3)]), indexed_content) - self.assertIn(self._html_experiment_group_result(self.html_unit6, [str(4)]), indexed_content) - self.assertNotIn(self._html_experiment_group_result(self.html_unit6, [str(5)]), indexed_content) - self.assertIn( + self.assertIn(self._html_group_result(self.html_unit1, [1]), indexed_content) # noqa: PT009 + self.assertIn(self._html_experiment_group_result(self.html_unit4, [str(2)]), indexed_content) # noqa: PT009 + self.assertIn(self._html_experiment_group_result(self.html_unit5, [str(3)]), indexed_content) # noqa: PT009 + self.assertIn(self._html_experiment_group_result(self.html_unit6, [str(4)]), indexed_content) # noqa: PT009 + self.assertNotIn(self._html_experiment_group_result(self.html_unit6, [str(5)]), indexed_content) # noqa: PT009 # pylint: disable=line-too-long + self.assertIn( # noqa: PT009 self._vertical_experiment_group_result(self.condition_0_vertical, [str(2)]), indexed_content ) - self.assertNotIn( + self.assertNotIn( # noqa: PT009 self._vertical_experiment_group_result(self.condition_1_vertical, [str(2)]), indexed_content ) - self.assertNotIn( + self.assertNotIn( # noqa: PT009 self._vertical_experiment_group_result(self.condition_2_vertical, [str(2)]), indexed_content ) - self.assertNotIn( + self.assertNotIn( # noqa: PT009 self._vertical_experiment_group_result(self.condition_0_vertical, [str(3)]), indexed_content ) - self.assertIn( + self.assertIn( # noqa: PT009 self._vertical_experiment_group_result(self.condition_1_vertical, [str(3)]), indexed_content ) - self.assertNotIn( + self.assertNotIn( # noqa: PT009 self._vertical_experiment_group_result(self.condition_2_vertical, [str(3)]), indexed_content ) - self.assertNotIn( + self.assertNotIn( # noqa: PT009 self._vertical_experiment_group_result(self.condition_0_vertical, [str(4)]), indexed_content ) - self.assertNotIn( + self.assertNotIn( # noqa: PT009 self._vertical_experiment_group_result(self.condition_1_vertical, [str(4)]), indexed_content ) - self.assertIn( + self.assertIn( # noqa: PT009 self._vertical_experiment_group_result(self.condition_2_vertical, [str(4)]), indexed_content ) @@ -1239,9 +1243,9 @@ def test_content_group_not_assigned(self): with patch(settings.SEARCH_ENGINE + '.index') as mock_index: self.reindex_course(self.store) - self.assertTrue(mock_index.called) + self.assertTrue(mock_index.called) # noqa: PT009 indexed_content = self._get_index_values_from_call_args(mock_index) - self.assertIn(self._html_nogroup_result(self.html_unit1), indexed_content) + self.assertIn(self._html_nogroup_result(self.html_unit1), indexed_content) # noqa: PT009 mock_index.reset_mock() def test_content_group_not_indexed_on_delete(self): @@ -1259,9 +1263,9 @@ def test_content_group_not_indexed_on_delete(self): # Checking group indexed correctly with patch(settings.SEARCH_ENGINE + '.index') as mock_index: self.reindex_course(self.store) - self.assertTrue(mock_index.called) + self.assertTrue(mock_index.called) # noqa: PT009 indexed_content = self._get_index_values_from_call_args(mock_index) - self.assertIn(self._html_group_result(self.html_unit1, [1]), indexed_content) + self.assertIn(self._html_group_result(self.html_unit1, [1]), indexed_content) # noqa: PT009 mock_index.reset_mock() empty_group_access = {'group_access': {}} @@ -1276,9 +1280,9 @@ def test_content_group_not_indexed_on_delete(self): # Checking group removed and not indexed any more with patch(settings.SEARCH_ENGINE + '.index') as mock_index: self.reindex_course(self.store) - self.assertTrue(mock_index.called) + self.assertTrue(mock_index.called) # noqa: PT009 indexed_content = self._get_index_values_from_call_args(mock_index) - self.assertIn(self._html_nogroup_result(self.html_unit1), indexed_content) + self.assertIn(self._html_nogroup_result(self.html_unit1), indexed_content) # noqa: PT009 mock_index.reset_mock() def test_group_indexed_only_on_assigned_html_block(self): @@ -1293,10 +1297,10 @@ def test_group_indexed_only_on_assigned_html_block(self): with patch(settings.SEARCH_ENGINE + '.index') as mock_index: self.reindex_course(self.store) - self.assertTrue(mock_index.called) + self.assertTrue(mock_index.called) # noqa: PT009 indexed_content = self._get_index_values_from_call_args(mock_index) - self.assertIn(self._html_group_result(self.html_unit1, [1]), indexed_content) - self.assertIn(self._html_nogroup_result(self.html_unit2), indexed_content) + self.assertIn(self._html_group_result(self.html_unit1, [1]), indexed_content) # noqa: PT009 + self.assertIn(self._html_nogroup_result(self.html_unit2), indexed_content) # noqa: PT009 mock_index.reset_mock() def test_different_groups_indexed_on_assigned_html_blocks(self): @@ -1318,10 +1322,10 @@ def test_different_groups_indexed_on_assigned_html_blocks(self): with patch(settings.SEARCH_ENGINE + '.index') as mock_index: self.reindex_course(self.store) - self.assertTrue(mock_index.called) + self.assertTrue(mock_index.called) # noqa: PT009 indexed_content = self._get_index_values_from_call_args(mock_index) - self.assertIn(self._html_group_result(self.html_unit1, [1]), indexed_content) - self.assertIn(self._html_group_result(self.html_unit2, [0]), indexed_content) + self.assertIn(self._html_group_result(self.html_unit1, [1]), indexed_content) # noqa: PT009 + self.assertIn(self._html_group_result(self.html_unit2, [0]), indexed_content) # noqa: PT009 mock_index.reset_mock() def test_different_groups_indexed_on_same_vertical_html_blocks(self): @@ -1347,8 +1351,8 @@ def test_different_groups_indexed_on_same_vertical_html_blocks(self): with patch(settings.SEARCH_ENGINE + '.index') as mock_index: self.reindex_course(self.store) - self.assertTrue(mock_index.called) + self.assertTrue(mock_index.called) # noqa: PT009 indexed_content = self._get_index_values_from_call_args(mock_index) - self.assertIn(self._html_group_result(self.html_unit2, [1]), indexed_content) - self.assertIn(self._html_group_result(self.html_unit3, [0]), indexed_content) + self.assertIn(self._html_group_result(self.html_unit2, [1]), indexed_content) # noqa: PT009 + self.assertIn(self._html_group_result(self.html_unit3, [0]), indexed_content) # noqa: PT009 mock_index.reset_mock() diff --git a/cms/djangoapps/contentstore/tests/test_crud.py b/cms/djangoapps/contentstore/tests/test_crud.py index 792d0386ac48..dc151254dc6a 100644 --- a/cms/djangoapps/contentstore/tests/test_crud.py +++ b/cms/djangoapps/contentstore/tests/test_crud.py @@ -17,22 +17,22 @@ class TemplateTests(ModuleStoreTestCase): """ def test_get_templates(self): found = templates.all_templates() - self.assertIsNotNone(found.get('course')) - self.assertIsNotNone(found.get('about')) - self.assertIsNotNone(found.get('html')) - self.assertEqual(len(found.get('course')), 0) - self.assertEqual(len(found.get('about')), 1) - self.assertGreaterEqual(len(found.get('html')), 2) + self.assertIsNotNone(found.get('course')) # noqa: PT009 + self.assertIsNotNone(found.get('about')) # noqa: PT009 + self.assertIsNotNone(found.get('html')) # noqa: PT009 + self.assertEqual(len(found.get('course')), 0) # noqa: PT009 + self.assertEqual(len(found.get('about')), 1) # noqa: PT009 + self.assertGreaterEqual(len(found.get('html')), 2) # noqa: PT009 def test_get_some_templates(self): course = CourseFactory.create() htmlblock = BlockFactory.create(category="html", parent_location=course.location) - self.assertEqual(len(SequenceBlock.templates()), 0) - self.assertGreater(len(htmlblock.templates()), 0) - self.assertIsNone(SequenceBlock.get_template('doesntexist.yaml')) - self.assertIsNone(htmlblock.get_template('doesntexist.yaml')) - self.assertIsNotNone(htmlblock.get_template('announcement.yaml')) + self.assertEqual(len(SequenceBlock.templates()), 0) # noqa: PT009 + self.assertGreater(len(htmlblock.templates()), 0) # noqa: PT009 + self.assertIsNone(SequenceBlock.get_template('doesntexist.yaml')) # noqa: PT009 + self.assertIsNone(htmlblock.get_template('doesntexist.yaml')) # noqa: PT009 + self.assertIsNotNone(htmlblock.get_template('announcement.yaml')) # noqa: PT009 def test_factories(self): test_course = CourseFactory.create( @@ -42,24 +42,24 @@ def test_factories(self): display_name='fun test course', user_id=ModuleStoreEnum.UserID.test, ) - self.assertIsInstance(test_course, CourseBlock) - self.assertEqual(test_course.display_name, 'fun test course') + self.assertIsInstance(test_course, CourseBlock) # noqa: PT009 + self.assertEqual(test_course.display_name, 'fun test course') # noqa: PT009 course_from_store = self.store.get_course(test_course.id) - self.assertEqual(course_from_store.id.org, 'testx') - self.assertEqual(course_from_store.id.course, 'course') - self.assertEqual(course_from_store.id.run, '2014') + self.assertEqual(course_from_store.id.org, 'testx') # noqa: PT009 + self.assertEqual(course_from_store.id.course, 'course') # noqa: PT009 + self.assertEqual(course_from_store.id.run, '2014') # noqa: PT009 test_chapter = BlockFactory.create( parent_location=test_course.location, category='chapter', display_name='chapter 1' ) - self.assertIsInstance(test_chapter, SequenceBlock) + self.assertIsInstance(test_chapter, SequenceBlock) # noqa: PT009 # refetch parent which should now point to child test_course = self.store.get_course(test_course.id.version_agnostic()) - self.assertIn(test_chapter.location, test_course.children) + self.assertIn(test_chapter.location, test_course.children) # noqa: PT009 - with self.assertRaises(DuplicateCourseError): + with self.assertRaises(DuplicateCourseError): # noqa: PT027 CourseFactory.create( org='testx', course='course', @@ -81,9 +81,9 @@ def test_temporary_xblocks(self): test_course.runtime, test_course.id, 'chapter', fields={'display_name': 'chapter n'}, parent_xblock=test_course ) - self.assertIsInstance(test_chapter, SequenceBlock) - self.assertEqual(test_chapter.display_name, 'chapter n') - self.assertIn(test_chapter, test_course.get_children()) + self.assertIsInstance(test_chapter, SequenceBlock) # noqa: PT009 + self.assertEqual(test_chapter.display_name, 'chapter n') # noqa: PT009 + self.assertIn(test_chapter, test_course.get_children()) # noqa: PT009 # test w/ a definition (e.g., a problem) test_def_content = 'boo' @@ -91,11 +91,11 @@ def test_temporary_xblocks(self): test_course.runtime, test_course.id, 'problem', fields={'data': test_def_content}, parent_xblock=test_chapter ) - self.assertIsInstance(test_problem, ProblemBlock) - self.assertEqual(test_problem.data, test_def_content) - self.assertIn(test_problem, test_chapter.get_children()) + self.assertIsInstance(test_problem, ProblemBlock) # noqa: PT009 + self.assertEqual(test_problem.data, test_def_content) # noqa: PT009 + self.assertIn(test_problem, test_chapter.get_children()) # noqa: PT009 test_problem.display_name = 'test problem' - self.assertEqual(test_problem.display_name, 'test problem') + self.assertEqual(test_problem.display_name, 'test problem') # noqa: PT009 def test_delete_course(self): test_course = CourseFactory.create( @@ -113,13 +113,13 @@ def test_delete_course(self): id_locator = test_course.id.for_branch(ModuleStoreEnum.BranchName.draft) # verify it can be retrieved by id - self.assertIsInstance(self.store.get_course(id_locator), CourseBlock) + self.assertIsInstance(self.store.get_course(id_locator), CourseBlock) # noqa: PT009 # TODO reenable when split_draft supports getting specific versions # guid_locator = test_course.location.course_agnostic() # Verify it can be retrieved by guid # self.assertIsInstance(self.store.get_item(guid_locator), CourseBlock) self.store.delete_course(id_locator, ModuleStoreEnum.UserID.test) # Test can no longer retrieve by id. - self.assertIsNone(self.store.get_course(id_locator)) + self.assertIsNone(self.store.get_course(id_locator)) # noqa: PT009 # But can retrieve by guid -- same TODO as above # self.assertIsInstance(self.store.get_item(guid_locator), CourseBlock) diff --git a/cms/djangoapps/contentstore/tests/test_exams.py b/cms/djangoapps/contentstore/tests/test_exams.py index 823038957714..6974c234c019 100644 --- a/cms/djangoapps/contentstore/tests/test_exams.py +++ b/cms/djangoapps/contentstore/tests/test_exams.py @@ -3,7 +3,7 @@ """ import itertools from datetime import datetime, timedelta, timezone -from unittest.mock import patch, Mock +from unittest.mock import Mock, patch import ddt from django.conf import settings @@ -14,7 +14,7 @@ from cms.djangoapps.contentstore.signals.handlers import listen_for_course_publish from openedx.core.djangoapps.course_apps.toggles import EXAMS_IDA from xmodule.modulestore.tests.django_utils import TEST_DATA_SPLIT_MODULESTORE, ModuleStoreTestCase -from xmodule.modulestore.tests.factories import CourseFactory, BlockFactory +from xmodule.modulestore.tests.factories import BlockFactory, CourseFactory @ddt.ddt @@ -182,7 +182,7 @@ def test_feature_flag_off(self, mock_patch_course_exams): @ddt.data( *itertools.product( (True, False), - (datetime(2035, 1, 1, 0, 0, tzinfo=timezone.utc), None), + (datetime(2035, 1, 1, 0, 0, tzinfo=timezone.utc), None), # noqa: UP017 ('null', 'lti_external'), ) ) @@ -236,7 +236,7 @@ def test_subsection_due_date_prioritized_instructor_paced( Test that exam due date is computed correctly. """ self.course.self_paced = is_self_paced - self.course.end = datetime(2035, 1, 1, 0, 0, tzinfo=timezone.utc) + self.course.end = datetime(2035, 1, 1, 0, 0, tzinfo=timezone.utc) # noqa: UP017 self.course.proctoring_provider = proctoring_provider self.course = self.update_course(self.course, 1) diff --git a/cms/djangoapps/contentstore/tests/test_export_git.py b/cms/djangoapps/contentstore/tests/test_export_git.py index e65c441d0e90..a986b342041d 100644 --- a/cms/djangoapps/contentstore/tests/test_export_git.py +++ b/cms/djangoapps/contentstore/tests/test_export_git.py @@ -14,12 +14,12 @@ import cms.djangoapps.contentstore.git_export_utils as git_export_utils from cms.djangoapps.contentstore.utils import reverse_course_url -from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order from .utils import CourseTestCase TEST_DATA_CONTENTSTORE = copy.deepcopy(settings.CONTENTSTORE) -TEST_DATA_CONTENTSTORE['DOC_STORE_CONFIG']['db'] = 'test_xcontent_%s' % uuid4().hex +TEST_DATA_CONTENTSTORE['DOC_STORE_CONFIG']['db'] = 'test_xcontent_%s' % uuid4().hex # noqa: UP031 @override_settings(CONTENTSTORE=TEST_DATA_CONTENTSTORE) @@ -46,7 +46,7 @@ def make_bare_repo_with_course(self, repo_name): os.mkdir(repo_dir) self.addCleanup(shutil.rmtree, repo_dir) - bare_repo_dir = '{}/{}.git'.format( + bare_repo_dir = '{}/{}.git'.format( # noqa: UP032 os.path.abspath(git_export_utils.GIT_REPO_EXPORT_DIR), repo_name ) @@ -136,7 +136,7 @@ def test_dirty_repo(self): ) test_file = os.path.join(repo_dir, 'test.txt') open(test_file, 'a').close() - self.assertTrue(os.path.isfile(test_file)) + self.assertTrue(os.path.isfile(test_file)) # noqa: PT009 git_export_utils.export_to_git(self.course.id, self.course_block.giturl, self.user) - self.assertFalse(os.path.isfile(test_file)) + self.assertFalse(os.path.isfile(test_file)) # noqa: PT009 diff --git a/cms/djangoapps/contentstore/tests/test_filters.py b/cms/djangoapps/contentstore/tests/test_filters.py index 4011ae728b34..2f9dfce50813 100644 --- a/cms/djangoapps/contentstore/tests/test_filters.py +++ b/cms/djangoapps/contentstore/tests/test_filters.py @@ -4,12 +4,12 @@ from datetime import datetime from urllib.parse import urljoin -from pytz import UTC - from django.test import override_settings -from cms.djangoapps.contentstore import asset_storage_handlers from opaque_keys.edx.locator import CourseLocator from openedx_filters import PipelineStep +from pytz import UTC + +from cms.djangoapps.contentstore import asset_storage_handlers from xmodule.contentstore.content import StaticContent from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase @@ -74,7 +74,7 @@ def test_lms_url_requested_filter_executed(self): self.course_key ) - self.assertEqual(output.get('external_url'), urljoin('https://lms-url-creation', self.asset_url)) + self.assertEqual(output.get('external_url'), urljoin('https://lms-url-creation', self.asset_url)) # noqa: PT009 @override_settings(OPEN_EDX_FILTERS_CONFIG={}, LMS_ROOT_URL="https://lms-base") def test_lms_url_requested_without_filter_configuration(self): @@ -95,4 +95,4 @@ def test_lms_url_requested_without_filter_configuration(self): self.course_key ) - self.assertEqual(output.get('external_url'), urljoin('https://lms-base', self.asset_url)) + self.assertEqual(output.get('external_url'), urljoin('https://lms-base', self.asset_url)) # noqa: PT009 diff --git a/cms/djangoapps/contentstore/tests/test_gating.py b/cms/djangoapps/contentstore/tests/test_gating.py index 91d2395bfde4..fa173d394911 100644 --- a/cms/djangoapps/contentstore/tests/test_gating.py +++ b/cms/djangoapps/contentstore/tests/test_gating.py @@ -9,8 +9,13 @@ from cms.djangoapps.contentstore.signals.handlers import handle_item_deleted from openedx.core.lib.gating import api as gating_api -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory, BlockFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + ModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import ( # pylint: disable=wrong-import-order + BlockFactory, + CourseFactory, +) class TestHandleItemDeleted(ModuleStoreTestCase, MilestonesTestCaseMixin): diff --git a/cms/djangoapps/contentstore/tests/test_i18n.py b/cms/djangoapps/contentstore/tests/test_i18n.py index 3ee991493196..1aaab8b52e36 100644 --- a/cms/djangoapps/contentstore/tests/test_i18n.py +++ b/cms/djangoapps/contentstore/tests/test_i18n.py @@ -5,16 +5,15 @@ from unittest import mock from django.utils import translation - from django.utils.translation import get_language from xblock.core import XBlock + +from cms.djangoapps.contentstore.views.preview import _prepare_runtime_for_preview from xmodule.modulestore.django import XBlockI18nService from xmodule.modulestore.tests.django_utils import TEST_DATA_SPLIT_MODULESTORE, ModuleStoreTestCase -from xmodule.modulestore.tests.factories import CourseFactory, BlockFactory +from xmodule.modulestore.tests.factories import BlockFactory, CourseFactory from xmodule.tests.test_export import PureXBlock -from cms.djangoapps.contentstore.views.preview import _prepare_runtime_for_preview - class FakeTranslations(XBlockI18nService): """A test GNUTranslations class that takes a map of msg -> translations.""" @@ -73,8 +72,8 @@ def get_block_i18n_service(self, block): return the block i18n service. """ i18n_service = self.block.runtime.service(block, 'i18n') - self.assertIsNotNone(i18n_service) - self.assertIsInstance(i18n_service, XBlockI18nService) + self.assertIsNotNone(i18n_service) # noqa: PT009 + self.assertIsInstance(i18n_service, XBlockI18nService) # noqa: PT009 return i18n_service def test_django_service_translation_works(self): @@ -112,10 +111,10 @@ def __exit__(self, _type, _value, _traceback): # wrap the ugettext functions so that 'XYZ ' will prefix each translation with wrap_ugettext_with_xyz(french_translation): - self.assertEqual(i18n_service.ugettext(self.test_language), 'XYZ dummy language') + self.assertEqual(i18n_service.ugettext(self.test_language), 'XYZ dummy language') # noqa: PT009 # Check that the old ugettext has been put back into place - self.assertEqual(i18n_service.ugettext(self.test_language), 'dummy language') + self.assertEqual(i18n_service.ugettext(self.test_language), 'dummy language') # noqa: PT009 @mock.patch('django.utils.translation.gettext', mock.Mock(return_value='XYZ-TEST-LANGUAGE')) def test_django_translator_in_use_with_empty_block(self): @@ -123,7 +122,7 @@ def test_django_translator_in_use_with_empty_block(self): Test: Django default translator should in use if we have an empty block """ i18n_service = XBlockI18nService(None) - self.assertEqual(i18n_service.ugettext(self.test_language), 'XYZ-TEST-LANGUAGE') + self.assertEqual(i18n_service.ugettext(self.test_language), 'XYZ-TEST-LANGUAGE') # noqa: PT009 @mock.patch('django.utils.translation.gettext', mock.Mock(return_value='XYZ-TEST-LANGUAGE')) def test_message_catalog_translations(self): @@ -141,24 +140,24 @@ def test_message_catalog_translations(self): with mock.patch('gettext.translation', return_value=_translator(domain='text', localedir=localedir, languages=[get_language()])): i18n_service = self.get_block_i18n_service(self.block) - self.assertEqual(i18n_service.ugettext('Hello'), 'es-hello-world') + self.assertEqual(i18n_service.ugettext('Hello'), 'es-hello-world') # noqa: PT009 translation.activate("ar") with mock.patch('gettext.translation', return_value=_translator(domain='text', localedir=localedir, languages=[get_language()])): i18n_service = self.get_block_i18n_service(self.block) - self.assertEqual(i18n_service.gettext('Hello'), 'Hello') - self.assertNotEqual(i18n_service.gettext('Hello'), 'fr-hello-world') - self.assertNotEqual(i18n_service.gettext('Hello'), 'es-hello-world') + self.assertEqual(i18n_service.gettext('Hello'), 'Hello') # noqa: PT009 + self.assertNotEqual(i18n_service.gettext('Hello'), 'fr-hello-world') # noqa: PT009 + self.assertNotEqual(i18n_service.gettext('Hello'), 'es-hello-world') # noqa: PT009 translation.activate("fr") with mock.patch('gettext.translation', return_value=_translator(domain='text', localedir=localedir, languages=[get_language()])): i18n_service = self.get_block_i18n_service(self.block) - self.assertEqual(i18n_service.ugettext('Hello'), 'fr-hello-world') + self.assertEqual(i18n_service.ugettext('Hello'), 'fr-hello-world') # noqa: PT009 def test_i18n_service_callable(self): """ Test: i18n service should be callable in studio. """ - self.assertTrue(callable(self.block.runtime._services.get('i18n'))) # pylint: disable=protected-access + self.assertTrue(callable(self.block.runtime._services.get('i18n'))) # pylint: disable=protected-access # noqa: PT009 diff --git a/cms/djangoapps/contentstore/tests/test_import.py b/cms/djangoapps/contentstore/tests/test_import.py index dbcef8e79ba7..af703184f776 100644 --- a/cms/djangoapps/contentstore/tests/test_import.py +++ b/cms/djangoapps/contentstore/tests/test_import.py @@ -11,10 +11,12 @@ import ddt from django.conf import settings +from django.core.files.storage import storages from django.test.client import Client from django.test.utils import override_settings -from django.core.files.storage import storages +from storages.backends.s3boto3 import S3Boto3Storage +from common.djangoapps.util.storage import resolve_storage_backend from xmodule.contentstore.django import contentstore from xmodule.exceptions import NotFoundError from xmodule.modulestore import ModuleStoreEnum @@ -22,11 +24,8 @@ from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase from xmodule.modulestore.xml_importer import import_course_from_xml -from common.djangoapps.util.storage import resolve_storage_backend -from storages.backends.s3boto3 import S3Boto3Storage - TEST_DATA_CONTENTSTORE = copy.deepcopy(settings.CONTENTSTORE) -TEST_DATA_CONTENTSTORE['DOC_STORE_CONFIG']['db'] = 'test_xcontent_%s' % uuid4().hex +TEST_DATA_CONTENTSTORE['DOC_STORE_CONFIG']['db'] = 'test_xcontent_%s' % uuid4().hex # noqa: UP031 TEST_DATA_DIR = settings.COMMON_TEST_DATA_ROOT @@ -73,7 +72,7 @@ def load_test_import_course(self, target_id=None, create_if_not_present=True, mo ) course_id = module_store.make_course_key('edX', 'test_import_course', '2012_Fall') course = module_store.get_course(course_id) - self.assertIsNotNone(course) + self.assertIsNotNone(course) # noqa: PT009 return module_store, content_store, course @@ -90,7 +89,7 @@ def test_import_course_into_similar_namespace(self): target_id=course.id, verbose=True, ) - self.assertEqual(len(course_items), 1) + self.assertEqual(len(course_items), 1) # noqa: PT009 def test_unicode_chars_in_course_name_import(self): """ @@ -110,10 +109,10 @@ def test_unicode_chars_in_course_name_import(self): ) course = module_store.get_course(course_id) - self.assertIsNotNone(course) + self.assertIsNotNone(course) # noqa: PT009 # test that course 'display_name' same as imported course 'display_name' - self.assertEqual(course.display_name, "Φυσικά το όνομα Unicode") + self.assertEqual(course.display_name, "Φυσικά το όνομα Unicode") # noqa: PT009 def test_static_import(self): ''' @@ -123,9 +122,9 @@ def test_static_import(self): # make sure we have ONE asset in our contentstore ("should_be_imported.html") all_assets, count = content_store.get_all_content_for_course(course.id) - print("len(all_assets)=%d" % len(all_assets)) - self.assertEqual(len(all_assets), 1) - self.assertEqual(count, 1) + print("len(all_assets)=%d" % len(all_assets)) # noqa: UP031 + self.assertEqual(len(all_assets), 1) # noqa: PT009 + self.assertEqual(count, 1) # noqa: PT009 content = None try: @@ -134,11 +133,11 @@ def test_static_import(self): except NotFoundError: pass - self.assertIsNotNone(content) + self.assertIsNotNone(content) # noqa: PT009 # make sure course.static_asset_path is correct print(f"static_asset_path = {course.static_asset_path}") - self.assertEqual(course.static_asset_path, 'test_import_course') + self.assertEqual(course.static_asset_path, 'test_import_course') # noqa: PT009 def test_asset_import_nostatic(self): ''' @@ -158,8 +157,8 @@ def test_asset_import_nostatic(self): # make sure we have NO assets in our contentstore all_assets, count = content_store.get_all_content_for_course(course.id) - self.assertEqual(all_assets, []) - self.assertEqual(count, 0) + self.assertEqual(all_assets, []) # noqa: PT009 + self.assertEqual(count, 0) # noqa: PT009 def test_no_static_link_rewrites_on_import(self): module_store = modulestore() @@ -170,15 +169,15 @@ def test_no_static_link_rewrites_on_import(self): course_key = courses[0].id handouts = module_store.get_item(course_key.make_usage_key('course_info', 'handouts')) - self.assertIn('/static/', handouts.data) + self.assertIn('/static/', handouts.data) # noqa: PT009 handouts = module_store.get_item(course_key.make_usage_key('html', 'toyhtml')) - self.assertIn('/static/', handouts.data) + self.assertIn('/static/', handouts.data) # noqa: PT009 def test_tab_name_imports_correctly(self): _module_store, _content_store, course = self.load_test_import_course() print(f"course tabs = {course.tabs}") - self.assertEqual(course.tabs[1]['name'], 'Syllabus') + self.assertEqual(course.tabs[1]['name'], 'Syllabus') # noqa: PT009 def test_reimport(self): __, __, course = self.load_test_import_course(create_if_not_present=True) @@ -201,16 +200,16 @@ def test_rewrite_reference_list(self): conditional_block = module_store.get_item( target_id.make_usage_key('conditional', 'condone') ) - self.assertIsNotNone(conditional_block) + self.assertIsNotNone(conditional_block) # noqa: PT009 different_course_id = module_store.make_course_key('edX', 'different_course', 'course_run') - self.assertListEqual( + self.assertListEqual( # noqa: PT009 [ target_id.make_usage_key('problem', 'choiceprob'), different_course_id.make_usage_key('html', 'for_testing_import_rewrites') ], conditional_block.sources_list ) - self.assertListEqual( + self.assertListEqual( # noqa: PT009 [ target_id.make_usage_key('html', 'congrats'), target_id.make_usage_key('html', 'secret_page') @@ -240,7 +239,7 @@ def test_rewrite_reference_value_dict_draft(self): {"0": '9f0941d021414798836ef140fb5f6841', "1": '0faf29473cf1497baa33fcc828b179cd'}, ) - def _verify_split_test_import(self, target_course_name, source_course_name, split_test_name, groups_to_verticals): # lint-amnesty, pylint: disable=missing-function-docstring + def _verify_split_test_import(self, target_course_name, source_course_name, split_test_name, groups_to_verticals): # pylint: disable=missing-function-docstring module_store = modulestore() target_id = module_store.make_course_key('testX', target_course_name, 'copy_run') import_course_from_xml( @@ -254,13 +253,13 @@ def _verify_split_test_import(self, target_course_name, source_course_name, spli split_test_block = module_store.get_item( target_id.make_usage_key('split_test', split_test_name) ) - self.assertIsNotNone(split_test_block) + self.assertIsNotNone(split_test_block) # noqa: PT009 remapped_verticals = { key: target_id.make_usage_key('vertical', value) for key, value in groups_to_verticals.items() } - self.assertEqual(remapped_verticals, split_test_block.group_id_to_child) + self.assertEqual(remapped_verticals, split_test_block.group_id_to_child) # noqa: PT009 def test_video_components_present_while_import(self): """ @@ -278,7 +277,7 @@ def test_video_components_present_while_import(self): vertical = module_store.get_item(re_course.id.make_usage_key('vertical', 'vertical_test')) video = module_store.get_item(vertical.children[1]) - self.assertEqual(video.display_name, 'default') + self.assertEqual(video.display_name, 'default') # noqa: PT009 @override_settings( COURSE_IMPORT_EXPORT_STORAGE="cms.djangoapps.contentstore.storage.ImportExportS3Storage", @@ -291,7 +290,7 @@ def test_video_components_present_while_import(self): def test_default_storage(self): """ Ensure the default storage is invoked, even if course export storage is configured """ storage = storages["default"] - self.assertEqual(storage.__class__.__name__, "FileSystemStorage") + self.assertEqual(storage.__class__.__name__, "FileSystemStorage") # noqa: PT009 @override_settings( COURSE_IMPORT_EXPORT_STORAGE="cms.djangoapps.contentstore.storage.ImportExportS3Storage", @@ -308,8 +307,8 @@ def test_resolve_happy_path_storage(self): storage_key="course_import_export", legacy_setting_key="COURSE_IMPORT_EXPORT_STORAGE" ) - self.assertEqual(storage.__class__.__name__, "ImportExportS3Storage") - self.assertEqual(storage.bucket_name, "bucket_name_test") + self.assertEqual(storage.__class__.__name__, "ImportExportS3Storage") # noqa: PT009 + self.assertEqual(storage.bucket_name, "bucket_name_test") # noqa: PT009 @override_settings() def test_resolve_storage_with_no_config(self): @@ -320,7 +319,7 @@ def test_resolve_storage_with_no_config(self): storage_key="course_import_export", legacy_setting_key="COURSE_IMPORT_EXPORT_STORAGE" ) - self.assertEqual(storage.__class__.__name__, "FileSystemStorage") + self.assertEqual(storage.__class__.__name__, "FileSystemStorage") # noqa: PT009 @override_settings( COURSE_IMPORT_EXPORT_STORAGE=None, @@ -338,8 +337,8 @@ def test_resolve_storage_using_django5_settings(self): storage_key="course_import_export", legacy_setting_key="COURSE_IMPORT_EXPORT_STORAGE" ) - self.assertEqual(storage.__class__.__name__, "ImportExportS3Storage") - self.assertEqual(storage.bucket_name, "bucket_name_test") + self.assertEqual(storage.__class__.__name__, "ImportExportS3Storage") # noqa: PT009 + self.assertEqual(storage.bucket_name, "bucket_name_test") # noqa: PT009 @override_settings( STORAGES={ @@ -359,5 +358,5 @@ def test_resolve_storage_using_django5_settings_with_options(self): storage_key="course_import_export", legacy_setting_key="COURSE_IMPORT_EXPORT_STORAGE" ) - self.assertEqual(storage.__class__.__name__, S3Boto3Storage.__name__) - self.assertEqual(storage.bucket_name, "bucket_name_test") + self.assertEqual(storage.__class__.__name__, S3Boto3Storage.__name__) # noqa: PT009 + self.assertEqual(storage.bucket_name, "bucket_name_test") # noqa: PT009 diff --git a/cms/djangoapps/contentstore/tests/test_import_draft_order.py b/cms/djangoapps/contentstore/tests/test_import_draft_order.py index f87efc043fbc..3783dafc9708 100644 --- a/cms/djangoapps/contentstore/tests/test_import_draft_order.py +++ b/cms/djangoapps/contentstore/tests/test_import_draft_order.py @@ -14,7 +14,7 @@ # This test is in the CMS module because the test configuration to use a draft # modulestore is dependent on django. -class DraftReorderTestCase(ModuleStoreTestCase): # lint-amnesty, pylint: disable=missing-class-docstring +class DraftReorderTestCase(ModuleStoreTestCase): # pylint: disable=missing-class-docstring def test_order(self): """ @@ -36,21 +36,21 @@ def test_order(self): # 2 , 4 , 6 , 5 , and 0 respectively. # # '5a05be9d59fc4bb79282c94c9e6b88c7' and 'second' are public verticals. - self.assertEqual(7, len(verticals)) - self.assertEqual(course_key.make_usage_key('vertical', 'z'), verticals[0]) - self.assertEqual(course_key.make_usage_key('vertical', '5a05be9d59fc4bb79282c94c9e6b88c7'), verticals[1]) - self.assertEqual(course_key.make_usage_key('vertical', 'a'), verticals[2]) - self.assertEqual(course_key.make_usage_key('vertical', 'second'), verticals[3]) - self.assertEqual(course_key.make_usage_key('vertical', 'b'), verticals[4]) - self.assertEqual(course_key.make_usage_key('vertical', 'd'), verticals[5]) - self.assertEqual(course_key.make_usage_key('vertical', 'c'), verticals[6]) + self.assertEqual(7, len(verticals)) # noqa: PT009 + self.assertEqual(course_key.make_usage_key('vertical', 'z'), verticals[0]) # noqa: PT009 + self.assertEqual(course_key.make_usage_key('vertical', '5a05be9d59fc4bb79282c94c9e6b88c7'), verticals[1]) # noqa: PT009 # pylint: disable=line-too-long + self.assertEqual(course_key.make_usage_key('vertical', 'a'), verticals[2]) # noqa: PT009 + self.assertEqual(course_key.make_usage_key('vertical', 'second'), verticals[3]) # noqa: PT009 + self.assertEqual(course_key.make_usage_key('vertical', 'b'), verticals[4]) # noqa: PT009 + self.assertEqual(course_key.make_usage_key('vertical', 'd'), verticals[5]) # noqa: PT009 + self.assertEqual(course_key.make_usage_key('vertical', 'c'), verticals[6]) # noqa: PT009 # Now also test that the verticals in a second sequential are correct. sequential = store.get_item(course_key.make_usage_key('sequential', 'secondseq')) verticals = sequential.children # 'asecond' and 'zsecond' are drafts with 'index_in_children_list' 0 and 2, respectively. # 'secondsubsection' is a public vertical. - self.assertEqual(3, len(verticals)) - self.assertEqual(course_key.make_usage_key('vertical', 'asecond'), verticals[0]) - self.assertEqual(course_key.make_usage_key('vertical', 'secondsubsection'), verticals[1]) - self.assertEqual(course_key.make_usage_key('vertical', 'zsecond'), verticals[2]) + self.assertEqual(3, len(verticals)) # noqa: PT009 + self.assertEqual(course_key.make_usage_key('vertical', 'asecond'), verticals[0]) # noqa: PT009 + self.assertEqual(course_key.make_usage_key('vertical', 'secondsubsection'), verticals[1]) # noqa: PT009 + self.assertEqual(course_key.make_usage_key('vertical', 'zsecond'), verticals[2]) # noqa: PT009 diff --git a/cms/djangoapps/contentstore/tests/test_import_pure_xblock.py b/cms/djangoapps/contentstore/tests/test_import_pure_xblock.py index 0a0e8663bae3..8b998ff852ff 100644 --- a/cms/djangoapps/contentstore/tests/test_import_pure_xblock.py +++ b/cms/djangoapps/contentstore/tests/test_import_pure_xblock.py @@ -62,5 +62,5 @@ def _assert_import(self, course_dir, expected_field_val, has_draft=False): xblock_location = courses[0].id.make_usage_key('stubxblock', 'xblock_test') xblock = self.store.get_item(xblock_location) - self.assertTrue(isinstance(xblock, StubXBlock)) - self.assertEqual(xblock.test_field, expected_field_val) + self.assertTrue(isinstance(xblock, StubXBlock)) # noqa: PT009 + self.assertEqual(xblock.test_field, expected_field_val) # noqa: PT009 diff --git a/cms/djangoapps/contentstore/tests/test_libraries.py b/cms/djangoapps/contentstore/tests/test_libraries.py index 376ba56d8dd9..29a194fd017e 100644 --- a/cms/djangoapps/contentstore/tests/test_libraries.py +++ b/cms/djangoapps/contentstore/tests/test_libraries.py @@ -8,15 +8,9 @@ import ddt from django.test.utils import override_settings from opaque_keys.edx.locator import CourseKey, LibraryLocator -from xmodule.modulestore import ModuleStoreEnum -from xmodule.modulestore.django import modulestore -from xmodule.modulestore.tests.django_utils import TEST_DATA_MONGO_MODULESTORE, ModuleStoreTestCase -from xmodule.modulestore.tests.factories import CourseFactory, BlockFactory -from xmodule.x_module import STUDIO_VIEW from cms.djangoapps.contentstore.tests.utils import AjaxEnabledTestClient, parse_json -from cms.djangoapps.contentstore.utils import reverse_library_url, reverse_url, \ - reverse_usage_url, duplicate_block +from cms.djangoapps.contentstore.utils import duplicate_block, reverse_library_url, reverse_url, reverse_usage_url from cms.djangoapps.contentstore.views.preview import _load_preview_block from cms.djangoapps.contentstore.views.tests.test_library import LIBRARY_REST_URL from cms.djangoapps.course_creators.views import add_user_with_status_granted @@ -28,10 +22,15 @@ LibraryUserRole, OrgInstructorRole, OrgLibraryUserRole, - OrgStaffRole + OrgStaffRole, ) from common.djangoapps.student.tests.factories import UserFactory from common.djangoapps.xblock_django.user_service import DjangoXBlockUserService +from xmodule.modulestore import ModuleStoreEnum +from xmodule.modulestore.django import modulestore +from xmodule.modulestore.tests.django_utils import TEST_DATA_MONGO_MODULESTORE, ModuleStoreTestCase +from xmodule.modulestore.tests.factories import BlockFactory, CourseFactory +from xmodule.x_module import STUDIO_VIEW class LibraryTestCase(ModuleStoreTestCase): @@ -67,10 +66,10 @@ def _create_library(self, org="org", library="lib", display_name="Test Library") 'library': library, 'display_name': display_name, }) - self.assertEqual(response.status_code, 200) + self.assertEqual(response.status_code, 200) # noqa: PT009 lib_info = parse_json(response) lib_key = CourseKey.from_string(lib_info['library_key']) - self.assertIsInstance(lib_key, LibraryLocator) + self.assertIsInstance(lib_key, LibraryLocator) # noqa: PT009 return lib_key def _add_library_content_block(self, course, library_key, publish_item=False, other_settings=None): @@ -111,7 +110,7 @@ def _upgrade_and_sync(self, lib_content_block, status_code_expected=200): kwargs={'handler': 'upgrade_and_sync'} ) response = self.client.ajax_post(handler_url) - self.assertEqual(response.status_code, status_code_expected) + self.assertEqual(response.status_code, status_code_expected) # noqa: PT009 return modulestore().get_item(lib_content_block.location) def _bind_block(self, block, user=None): @@ -143,7 +142,7 @@ def _list_libraries(self): Use the REST API to get a list of libraries visible to the current user. """ response = self.client.get_json(LIBRARY_REST_URL) - self.assertEqual(response.status_code, 200) + self.assertEqual(response.status_code, 200) # noqa: PT009 return parse_json(response) @@ -170,7 +169,7 @@ def test_max_items(self, num_to_create, num_to_select, num_expected): course = CourseFactory.create() lc_block = self._add_library_content_block(course, self.lib_key, other_settings={'max_count': num_to_select}) - self.assertEqual(len(lc_block.children), 0) + self.assertEqual(len(lc_block.children), 0) # noqa: PT009 lc_block = self._upgrade_and_sync(lc_block) # Now, we want to make sure that .children has the total # of potential @@ -179,8 +178,8 @@ def test_max_items(self, num_to_create, num_to_select, num_expected): # In order to be able to call get_child_blocks(), we must first # call bind_for_student: self._bind_block(lc_block) - self.assertEqual(len(lc_block.children), num_to_create) - self.assertEqual(len(lc_block.get_child_blocks()), num_expected) + self.assertEqual(len(lc_block.children), num_to_create) # noqa: PT009 + self.assertEqual(len(lc_block.get_child_blocks()), num_expected) # noqa: PT009 def test_consistent_children(self): """ @@ -205,7 +204,7 @@ def get_child_of_lc_block(block): Fetch the child shown to the current user. """ children = block.get_child_blocks() - self.assertEqual(len(children), 1) + self.assertEqual(len(children), 1) # noqa: PT009 return children[0] # Check which child a student will see: @@ -225,9 +224,9 @@ def check(): lc_block = modulestore().get_item(lc_block_key) # Reload block from the database self._bind_block(lc_block) current_child = get_child_of_lc_block(lc_block) - self.assertEqual(current_child.location, chosen_child.location) - self.assertEqual(current_child.data, chosen_child.data) - self.assertEqual(current_child.definition_locator.definition_id, chosen_child_defn_id) + self.assertEqual(current_child.location, chosen_child.location) # noqa: PT009 + self.assertEqual(current_child.data, chosen_child.data) # noqa: PT009 + self.assertEqual(current_child.definition_locator.definition_id, chosen_child_defn_id) # noqa: PT009 check() # Refresh the children: @@ -243,7 +242,7 @@ def test_definition_shared_with_library(self): def_id1 = block1.definition_locator.definition_id block2 = self._add_simple_content_block() def_id2 = block2.definition_locator.definition_id - self.assertNotEqual(def_id1, def_id2) + self.assertNotEqual(def_id1, def_id2) # noqa: PT009 # Next, create a course: with modulestore().default_store(ModuleStoreEnum.Type.split): @@ -255,7 +254,7 @@ def test_definition_shared_with_library(self): for child_key in lc_block.children: child = modulestore().get_item(child_key) def_id = child.definition_locator.definition_id - self.assertIn(def_id, (def_id1, def_id2)) + self.assertIn(def_id, (def_id1, def_id2)) # noqa: PT009 def test_fields(self): """ @@ -272,8 +271,8 @@ def test_fields(self): display_name=name_value, data=data_value, ) - self.assertEqual(lib_block.data, data_value) - self.assertEqual(lib_block.display_name, name_value) + self.assertEqual(lib_block.data, data_value) # noqa: PT009 + self.assertEqual(lib_block.display_name, name_value) # noqa: PT009 # Next, create a course: with modulestore().default_store(ModuleStoreEnum.Type.split): @@ -284,8 +283,8 @@ def test_fields(self): lc_block = self._upgrade_and_sync(lc_block) course_block = modulestore().get_item(lc_block.children[0]) - self.assertEqual(course_block.data, data_value) - self.assertEqual(course_block.display_name, name_value) + self.assertEqual(course_block.data, data_value) # noqa: PT009 + self.assertEqual(course_block.display_name, name_value) # noqa: PT009 def test_block_with_children(self): """ @@ -308,8 +307,8 @@ def test_block_with_children(self): display_name=name_value, data=data_value, ) - self.assertEqual(child_block.data, data_value) - self.assertEqual(child_block.display_name, name_value) + self.assertEqual(child_block.data, data_value) # noqa: PT009 + self.assertEqual(child_block.display_name, name_value) # noqa: PT009 # Next, create a course: with modulestore().default_store(ModuleStoreEnum.Type.split): @@ -318,13 +317,13 @@ def test_block_with_children(self): # Add a LibraryContent block to the course: lc_block = self._add_library_content_block(course, self.lib_key) lc_block = self._upgrade_and_sync(lc_block) - self.assertEqual(len(lc_block.children), 1) + self.assertEqual(len(lc_block.children), 1) # noqa: PT009 course_vert_block = modulestore().get_item(lc_block.children[0]) - self.assertEqual(len(course_vert_block.children), 1) + self.assertEqual(len(course_vert_block.children), 1) # noqa: PT009 course_child_block = modulestore().get_item(course_vert_block.children[0]) - self.assertEqual(course_child_block.data, data_value) - self.assertEqual(course_child_block.display_name, name_value) + self.assertEqual(course_child_block.data, data_value) # noqa: PT009 + self.assertEqual(course_child_block.display_name, name_value) # noqa: PT009 def test_switch_to_unknown_source_library_preserves_settings(self): """ @@ -354,8 +353,8 @@ def test_switch_to_unknown_source_library_preserves_settings(self): good_library_version = lc_block.source_library_version assert good_library_id assert good_library_version - self.assertEqual(len(lc_block.children), 1) - self.assertEqual(modulestore().get_item(lc_block.children[0]).data, data_value) + self.assertEqual(len(lc_block.children), 1) # noqa: PT009 + self.assertEqual(modulestore().get_item(lc_block.children[0]).data, data_value) # noqa: PT009 # Now, change the block settings to have an invalid library key: bad_library_id = "library-v1:NOT+FOUND" @@ -363,7 +362,7 @@ def test_switch_to_unknown_source_library_preserves_settings(self): lc_block.location, {"source_library_id": bad_library_id}, ) - self.assertEqual(resp.status_code, 200) + self.assertEqual(resp.status_code, 200) # noqa: PT009 lc_block = modulestore().get_item(lc_block.location) # Source library id should be set to the new bad one... @@ -371,8 +370,8 @@ def test_switch_to_unknown_source_library_preserves_settings(self): # ...but old source library version should be preserved... assert lc_block.source_library_version == good_library_version # ...and children should not be deleted due to a bad setting. - self.assertEqual(len(lc_block.children), 1) - self.assertEqual(modulestore().get_item(lc_block.children[0]).data, data_value) + self.assertEqual(len(lc_block.children), 1) # noqa: PT009 + self.assertEqual(modulestore().get_item(lc_block.children[0]).data, data_value) # noqa: PT009 # Attempting to force an upgrade (the user would have to do this through the API, as # the UI wouldn't give them the option) returns a 400 and preserves the LC block's state. @@ -385,8 +384,8 @@ def test_switch_to_unknown_source_library_preserves_settings(self): # ...but old source library version should be preserved... assert lc_block.source_library_version == good_library_version # ...and children should not be deleted due to a bad setting. - self.assertEqual(len(lc_block.children), 1) - self.assertEqual(modulestore().get_item(lc_block.children[0]).data, data_value) + self.assertEqual(len(lc_block.children), 1) # noqa: PT009 + self.assertEqual(modulestore().get_item(lc_block.children[0]).data, data_value) # noqa: PT009 def test_sync_if_source_library_changed(self): """ @@ -422,9 +421,9 @@ def test_sync_if_source_library_changed(self): lc_block = self._upgrade_and_sync(lc_block) # Sanity check the initial condition. - self.assertEqual(len(lc_block.children), 1) + self.assertEqual(len(lc_block.children), 1) # noqa: PT009 html_block_1 = modulestore().get_item(lc_block.children[0]) - self.assertEqual(html_block_1.data, data1) + self.assertEqual(html_block_1.data, data1) # noqa: PT009 # Now, switch over to new library. Don't call upgrade_and_sync, because we are # testing that it happens automatically. @@ -432,13 +431,13 @@ def test_sync_if_source_library_changed(self): lc_block.location, {"source_library_id": str(library2key)}, ) - self.assertEqual(resp.status_code, 200) + self.assertEqual(resp.status_code, 200) # noqa: PT009 # Check that the course now has the new lib's new block. lc_block = modulestore().get_item(lc_block.location) - self.assertEqual(len(lc_block.children), 1) + self.assertEqual(len(lc_block.children), 1) # noqa: PT009 html_block_2 = modulestore().get_item(lc_block.children[0]) - self.assertEqual(html_block_2.data, data2) + self.assertEqual(html_block_2.data, data2) # noqa: PT009 def test_sync_if_capa_type_changed(self): """ Tests that children are automatically refreshed if capa type field changes """ @@ -467,29 +466,29 @@ def test_sync_if_capa_type_changed(self): # Add a LibraryContent block to the course: lc_block = self._add_library_content_block(course, self.lib_key) lc_block = self._upgrade_and_sync(lc_block) - self.assertEqual(len(lc_block.children), 2) + self.assertEqual(len(lc_block.children), 2) # noqa: PT009 resp = self._update_block( lc_block.location, {"capa_type": 'optionresponse'}, ) - self.assertEqual(resp.status_code, 200) + self.assertEqual(resp.status_code, 200) # noqa: PT009 lc_block = modulestore().get_item(lc_block.location) - self.assertEqual(len(lc_block.children), 1) + self.assertEqual(len(lc_block.children), 1) # noqa: PT009 html_block = modulestore().get_item(lc_block.children[0]) - self.assertEqual(html_block.display_name, name1) + self.assertEqual(html_block.display_name, name1) # noqa: PT009 resp = self._update_block( lc_block.location, {"capa_type": 'multiplechoiceresponse'}, ) - self.assertEqual(resp.status_code, 200) + self.assertEqual(resp.status_code, 200) # noqa: PT009 lc_block = modulestore().get_item(lc_block.location) - self.assertEqual(len(lc_block.children), 1) + self.assertEqual(len(lc_block.children), 1) # noqa: PT009 html_block = modulestore().get_item(lc_block.children[0]) - self.assertEqual(html_block.display_name, name2) + self.assertEqual(html_block.display_name, name2) # noqa: PT009 def test_library_filters(self): """ @@ -500,12 +499,12 @@ def test_library_filters(self): self._create_library(library="l3", display_name="Library-Title-3", org='org-test1') self._create_library(library="l4", display_name="Library-Title-4", org='org-test2') - self.assertEqual(len(self.client.get_json(LIBRARY_REST_URL).json()), 5) # 1 more from self.setUp() - self.assertEqual(len(self.client.get_json(f'{LIBRARY_REST_URL}?org=org-test1').json()), 2) - self.assertEqual(len(self.client.get_json(f'{LIBRARY_REST_URL}?text_search=test-lib').json()), 2) - self.assertEqual(len(self.client.get_json(f'{LIBRARY_REST_URL}?text_search=library-title').json()), 3) - self.assertEqual(len(self.client.get_json(f'{LIBRARY_REST_URL}?text_search=library-').json()), 3) - self.assertEqual(len(self.client.get_json(f'{LIBRARY_REST_URL}?text_search=org-test').json()), 3) + self.assertEqual(len(self.client.get_json(LIBRARY_REST_URL).json()), 5) # 1 more from self.setUp() # noqa: PT009 # pylint: disable=line-too-long + self.assertEqual(len(self.client.get_json(f'{LIBRARY_REST_URL}?org=org-test1').json()), 2) # noqa: PT009 + self.assertEqual(len(self.client.get_json(f'{LIBRARY_REST_URL}?text_search=test-lib').json()), 2) # noqa: PT009 + self.assertEqual(len(self.client.get_json(f'{LIBRARY_REST_URL}?text_search=library-title').json()), 3) # noqa: PT009 # pylint: disable=line-too-long + self.assertEqual(len(self.client.get_json(f'{LIBRARY_REST_URL}?text_search=library-').json()), 3) # noqa: PT009 + self.assertEqual(len(self.client.get_json(f'{LIBRARY_REST_URL}?text_search=org-test').json()), 3) # noqa: PT009 @ddt.ddt @@ -529,14 +528,14 @@ def _login_as_non_staff_user(self, logout_first=True): def _assert_cannot_create_library(self, org="org", library="libfail", expected_code=403): """ Ensure the current user is not able to create a library. """ - self.assertGreaterEqual(expected_code, 300) + self.assertGreaterEqual(expected_code, 300) # noqa: PT009 response = self.client.ajax_post( LIBRARY_REST_URL, {'org': org, 'library': library, 'display_name': "Irrelevant"} ) - self.assertEqual(response.status_code, expected_code) + self.assertEqual(response.status_code, expected_code) # noqa: PT009 key = LibraryLocator(org=org, library=library) - self.assertEqual(modulestore().get_library(key), None) + self.assertEqual(modulestore().get_library(key), None) # noqa: PT009 def _can_access_library(self, library): """ @@ -549,7 +548,7 @@ def _can_access_library(self, library): else: lib_key = library.location.library_key response = self.client.get(reverse_library_url('library_handler', str(lib_key))) - self.assertIn(response.status_code, (200, 302, 403)) + self.assertIn(response.status_code, (200, 302, 403)) # noqa: PT009 return response.status_code == 200 def tearDown(self): @@ -564,10 +563,10 @@ def test_creation(self): The user that creates a library should have instructor (admin) and staff permissions """ # self.library has been auto-created by the staff user. - self.assertTrue(has_studio_write_access(self.user, self.lib_key)) - self.assertTrue(has_studio_read_access(self.user, self.lib_key)) + self.assertTrue(has_studio_write_access(self.user, self.lib_key)) # noqa: PT009 + self.assertTrue(has_studio_read_access(self.user, self.lib_key)) # noqa: PT009 # Make sure the user was actually assigned the instructor role and not just using is_staff superpowers: - self.assertTrue(CourseInstructorRole(self.lib_key).has_user(self.user)) + self.assertTrue(CourseInstructorRole(self.lib_key).has_user(self.user)) # noqa: PT009 # Now log out and ensure we are forbidden from creating a library: self.client.logout() @@ -583,7 +582,7 @@ def test_creation(self): with patch.dict('django.conf.settings.FEATURES', {'ENABLE_CREATOR_GROUP': True}): lib_key2 = self._create_library(library="lib2", display_name="Test Library 2") library2 = modulestore().get_library(lib_key2) - self.assertIsNotNone(library2) + self.assertIsNotNone(library2) # noqa: PT009 @ddt.data( CourseInstructorRole, @@ -602,19 +601,19 @@ def test_acccess(self, access_role): # non_staff_user shouldn't be able to access any libraries: lib_list = self._list_libraries() - self.assertEqual(len(lib_list), 0) - self.assertFalse(self._can_access_library(self.library)) - self.assertFalse(self._can_access_library(library2_key)) + self.assertEqual(len(lib_list), 0) # noqa: PT009 + self.assertFalse(self._can_access_library(self.library)) # noqa: PT009 + self.assertFalse(self._can_access_library(library2_key)) # noqa: PT009 # Now manually intervene to give non_staff_user access to library2_key: access_role(library2_key).add_users(self.non_staff_user) # Now non_staff_user should be able to access library2_key only: lib_list = self._list_libraries() - self.assertEqual(len(lib_list), 1) - self.assertEqual(lib_list[0]["library_key"], str(library2_key)) - self.assertTrue(self._can_access_library(library2_key)) - self.assertFalse(self._can_access_library(self.library)) + self.assertEqual(len(lib_list), 1) # noqa: PT009 + self.assertEqual(lib_list[0]["library_key"], str(library2_key)) # noqa: PT009 + self.assertTrue(self._can_access_library(library2_key)) # noqa: PT009 + self.assertFalse(self._can_access_library(self.library)) # noqa: PT009 @ddt.data( OrgStaffRole, @@ -638,11 +637,11 @@ def test_org_based_access(self, org_access_role): # Now non_staff_user should be able to access lib_key_pacific only: lib_list = self._list_libraries() - self.assertEqual(len(lib_list), 1) - self.assertEqual(lib_list[0]["library_key"], str(lib_key_pacific)) - self.assertTrue(self._can_access_library(lib_key_pacific)) - self.assertFalse(self._can_access_library(lib_key_atlantic)) - self.assertFalse(self._can_access_library(self.lib_key)) + self.assertEqual(len(lib_list), 1) # noqa: PT009 + self.assertEqual(lib_list[0]["library_key"], str(lib_key_pacific)) # noqa: PT009 + self.assertTrue(self._can_access_library(lib_key_pacific)) # noqa: PT009 + self.assertFalse(self._can_access_library(lib_key_atlantic)) # noqa: PT009 + self.assertFalse(self._can_access_library(self.lib_key)) # noqa: PT009 @ddt.data(True, False) def test_read_only_role(self, use_org_level_role): @@ -654,26 +653,26 @@ def test_read_only_role(self, use_org_level_role): # Login as a non_staff_user: self._login_as_non_staff_user() - self.assertFalse(self._can_access_library(self.library)) + self.assertFalse(self._can_access_library(self.library)) # noqa: PT009 block_url = reverse_usage_url('xblock_handler', block.location) def can_read_block(): """ Check if studio lets us view the XBlock in the library """ response = self.client.get_json(block_url) - self.assertIn(response.status_code, (200, 403)) # 400 would be ambiguous + self.assertIn(response.status_code, (200, 403)) # 400 would be ambiguous # noqa: PT009 return response.status_code == 200 def can_edit_block(): """ Check if studio lets us edit the XBlock in the library """ response = self.client.ajax_post(block_url) - self.assertIn(response.status_code, (200, 403)) # 400 would be ambiguous + self.assertIn(response.status_code, (200, 403)) # 400 would be ambiguous # noqa: PT009 return response.status_code == 200 def can_delete_block(): """ Check if studio lets us delete the XBlock in the library """ response = self.client.delete(block_url) - self.assertIn(response.status_code, (200, 403)) # 400 would be ambiguous + self.assertIn(response.status_code, (200, 403)) # 400 would be ambiguous # noqa: PT009 return response.status_code == 200 def can_copy_block(): @@ -682,7 +681,7 @@ def can_copy_block(): 'parent_locator': str(self.library.location), 'duplicate_source_locator': str(block.location), }) - self.assertIn(response.status_code, (200, 403)) # 400 would be ambiguous + self.assertIn(response.status_code, (200, 403)) # 400 would be ambiguous # noqa: PT009 return response.status_code == 200 def can_create_block(): @@ -690,15 +689,15 @@ def can_create_block(): response = self.client.ajax_post(reverse_url('xblock_handler'), { 'parent_locator': str(self.library.location), 'category': 'html', }) - self.assertIn(response.status_code, (200, 403)) # 400 would be ambiguous + self.assertIn(response.status_code, (200, 403)) # 400 would be ambiguous # noqa: PT009 return response.status_code == 200 # Check that we do not have read or write access to block: - self.assertFalse(can_read_block()) - self.assertFalse(can_edit_block()) - self.assertFalse(can_delete_block()) - self.assertFalse(can_copy_block()) - self.assertFalse(can_create_block()) + self.assertFalse(can_read_block()) # noqa: PT009 + self.assertFalse(can_edit_block()) # noqa: PT009 + self.assertFalse(can_delete_block()) # noqa: PT009 + self.assertFalse(can_copy_block()) # noqa: PT009 + self.assertFalse(can_create_block()) # noqa: PT009 # Give non_staff_user read-only permission: if use_org_level_role: @@ -706,12 +705,12 @@ def can_create_block(): else: LibraryUserRole(self.lib_key).add_users(self.non_staff_user) - self.assertTrue(self._can_access_library(self.library)) - self.assertTrue(can_read_block()) - self.assertFalse(can_edit_block()) - self.assertFalse(can_delete_block()) - self.assertFalse(can_copy_block()) - self.assertFalse(can_create_block()) + self.assertTrue(self._can_access_library(self.library)) # noqa: PT009 + self.assertTrue(can_read_block()) # noqa: PT009 + self.assertFalse(can_edit_block()) # noqa: PT009 + self.assertFalse(can_delete_block()) # noqa: PT009 + self.assertFalse(can_copy_block()) # noqa: PT009 + self.assertFalse(can_create_block()) # noqa: PT009 @ddt.data( (LibraryUserRole, CourseStaffRole, True), @@ -744,9 +743,9 @@ def test_duplicate_across_courses(self, library_role, course_role, expected_resu 'parent_locator': str(course.location), 'duplicate_source_locator': str(block.location), }) - self.assertIn(response.status_code, (200, 403)) # 400 would be ambiguous + self.assertIn(response.status_code, (200, 403)) # 400 would be ambiguous # noqa: PT009 duplicate_action_allowed = (response.status_code == 200) - self.assertEqual(duplicate_action_allowed, expected_result) + self.assertEqual(duplicate_action_allowed, expected_result) # noqa: PT009 @ddt.data( (LibraryUserRole, CourseStaffRole, True), @@ -781,7 +780,7 @@ def test_upgrade_and_sync_handler_content_permissions(self, library_role, course # We must use the CMS's module system in order to get permissions checks. self._bind_block(lc_block, user=self.non_staff_user) lc_block = self._upgrade_and_sync(lc_block, status_code_expected=200 if expected_result else 403) - self.assertEqual(len(lc_block.children), 1 if expected_result else 0) + self.assertEqual(len(lc_block.children), 1 if expected_result else 0) # noqa: PT009 def test_studio_user_permissions(self): """ @@ -819,27 +818,27 @@ def _get_settings_html(): edit_view_url = reverse_usage_url("xblock_view_handler", lib_block.location, {"view_name": STUDIO_VIEW}) resp = self.client.get_json(edit_view_url) - self.assertEqual(resp.status_code, 200) + self.assertEqual(resp.status_code, 200) # noqa: PT009 return parse_json(resp)['html'] self._login_as_staff_user() staff_settings_html = _get_settings_html() - self.assertIn('staff_lib_1', staff_settings_html) - self.assertIn('staff_lib_2', staff_settings_html) - self.assertIn('admin_lib_1', staff_settings_html) - self.assertIn('admin_lib_2', staff_settings_html) + self.assertIn('staff_lib_1', staff_settings_html) # noqa: PT009 + self.assertIn('staff_lib_2', staff_settings_html) # noqa: PT009 + self.assertIn('admin_lib_1', staff_settings_html) # noqa: PT009 + self.assertIn('admin_lib_2', staff_settings_html) # noqa: PT009 self._login_as_non_staff_user() response = self.client.get_json(LIBRARY_REST_URL) staff_libs = parse_json(response) - self.assertEqual(2, len(staff_libs)) + self.assertEqual(2, len(staff_libs)) # noqa: PT009 non_staff_settings_html = _get_settings_html() - self.assertIn('staff_lib_1', non_staff_settings_html) - self.assertIn('staff_lib_2', non_staff_settings_html) - self.assertNotIn('admin_lib_1', non_staff_settings_html) - self.assertNotIn('admin_lib_2', non_staff_settings_html) + self.assertIn('staff_lib_1', non_staff_settings_html) # noqa: PT009 + self.assertIn('staff_lib_2', non_staff_settings_html) # noqa: PT009 + self.assertNotIn('admin_lib_1', non_staff_settings_html) # noqa: PT009 + self.assertNotIn('admin_lib_2', non_staff_settings_html) # noqa: PT009 @ddt.ddt @@ -893,11 +892,11 @@ def test_overrides(self): self.problem_in_course = modulestore().get_item(self.lc_block.children[0]) problem2_in_course = modulestore().get_item(lc_block2.children[0]) - self.assertEqual(self.problem_in_course.display_name, new_display_name) - self.assertEqual(self.problem_in_course.weight, new_weight) + self.assertEqual(self.problem_in_course.display_name, new_display_name) # noqa: PT009 + self.assertEqual(self.problem_in_course.weight, new_weight) # noqa: PT009 - self.assertEqual(problem2_in_course.display_name, self.original_display_name) - self.assertEqual(problem2_in_course.weight, self.original_weight) + self.assertEqual(problem2_in_course.display_name, self.original_display_name) # noqa: PT009 + self.assertEqual(problem2_in_course.weight, self.original_weight) # noqa: PT009 def test_reset_override(self): """ @@ -910,8 +909,8 @@ def test_reset_override(self): modulestore().update_item(self.problem_in_course, self.user.id) self.problem_in_course = modulestore().get_item(self.problem_in_course.location) - self.assertEqual(self.problem_in_course.display_name, new_display_name) - self.assertEqual(self.problem_in_course.weight, new_weight) + self.assertEqual(self.problem_in_course.display_name, new_display_name) # noqa: PT009 + self.assertEqual(self.problem_in_course.weight, new_weight) # noqa: PT009 # Reset: for field_name in ["display_name", "weight"]: @@ -921,8 +920,8 @@ def test_reset_override(self): modulestore().update_item(self.problem_in_course, self.user.id) self.problem_in_course = modulestore().get_item(self.problem_in_course.location) - self.assertEqual(self.problem_in_course.display_name, self.original_display_name) - self.assertEqual(self.problem_in_course.weight, self.original_weight) + self.assertEqual(self.problem_in_course.display_name, self.original_display_name) # noqa: PT009 + self.assertEqual(self.problem_in_course.weight, self.original_weight) # noqa: PT009 def test_consistent_definitions(self): """ @@ -932,7 +931,7 @@ def test_consistent_definitions(self): This test is specific to split mongo. """ definition_id = self.problem.definition_locator.definition_id - self.assertEqual(self.problem_in_course.definition_locator.definition_id, definition_id) + self.assertEqual(self.problem_in_course.definition_locator.definition_id, definition_id) # noqa: PT009 # Now even if we change some Scope.settings fields and refresh, the definition should be unchanged self.problem.weight = 20 @@ -941,8 +940,8 @@ def test_consistent_definitions(self): self.lc_block = self._upgrade_and_sync(self.lc_block) self.problem_in_course = modulestore().get_item(self.problem_in_course.location) - self.assertEqual(self.problem.definition_locator.definition_id, definition_id) - self.assertEqual(self.problem_in_course.definition_locator.definition_id, definition_id) + self.assertEqual(self.problem.definition_locator.definition_id, definition_id) # noqa: PT009 + self.assertEqual(self.problem_in_course.definition_locator.definition_id, definition_id) # noqa: PT009 @ddt.data(False, True) def test_persistent_overrides(self, duplicate): @@ -965,8 +964,8 @@ def test_persistent_overrides(self, duplicate): self.problem_in_course = modulestore().get_item(self.lc_block.children[0]) else: self.problem_in_course = modulestore().get_item(self.problem_in_course.location) - self.assertEqual(self.problem_in_course.display_name, new_display_name) - self.assertEqual(self.problem_in_course.weight, new_weight) + self.assertEqual(self.problem_in_course.display_name, new_display_name) # noqa: PT009 + self.assertEqual(self.problem_in_course.weight, new_weight) # noqa: PT009 # Change the settings in the library version: self.problem.display_name = "X" @@ -978,9 +977,9 @@ def test_persistent_overrides(self, duplicate): self.lc_block = self._upgrade_and_sync(self.lc_block) self.problem_in_course = modulestore().get_item(self.problem_in_course.location) - self.assertEqual(self.problem_in_course.display_name, new_display_name) - self.assertEqual(self.problem_in_course.weight, new_weight) - self.assertEqual(self.problem_in_course.data, new_data_value) + self.assertEqual(self.problem_in_course.display_name, new_display_name) # noqa: PT009 + self.assertEqual(self.problem_in_course.weight, new_weight) # noqa: PT009 + self.assertEqual(self.problem_in_course.data, new_data_value) # noqa: PT009 def test_duplicated_version(self): """ @@ -988,8 +987,8 @@ def test_duplicated_version(self): the new block will use the old library version and not the new one. """ store = modulestore() - self.assertEqual(len(self.library.children), 1) - self.assertEqual(len(self.lc_block.children), 1) + self.assertEqual(len(self.library.children), 1) # noqa: PT009 + self.assertEqual(len(self.lc_block.children), 1) # noqa: PT009 # Edit the only problem in the library: self.problem.display_name = "--changed in library--" @@ -1006,28 +1005,28 @@ def test_duplicated_version(self): self.library = store.get_library(self.lib_key) # The library has changed... - self.assertEqual(len(self.library.children), 2) + self.assertEqual(len(self.library.children), 2) # noqa: PT009 # But the block hasn't. self.lc_block = store.get_item(self.lc_block.location) - self.assertEqual(len(self.lc_block.children), 1) - self.assertEqual(self.problem_in_course.location, self.lc_block.children[0]) - self.assertEqual(self.problem_in_course.display_name, self.original_display_name) + self.assertEqual(len(self.lc_block.children), 1) # noqa: PT009 + self.assertEqual(self.problem_in_course.location, self.lc_block.children[0]) # noqa: PT009 + self.assertEqual(self.problem_in_course.display_name, self.original_display_name) # noqa: PT009 # Duplicate self.lc_block: duplicate = store.get_item( duplicate_block(self.course.location, self.lc_block.location, self.user) ) # The duplicate should have identical children to the original: - self.assertTrue(self.lc_block.source_library_version) - self.assertEqual(self.lc_block.source_library_version, duplicate.source_library_version) - self.assertEqual(len(duplicate.children), 1) + self.assertTrue(self.lc_block.source_library_version) # noqa: PT009 + self.assertEqual(self.lc_block.source_library_version, duplicate.source_library_version) # noqa: PT009 + self.assertEqual(len(duplicate.children), 1) # noqa: PT009 problem2_in_course = store.get_item(duplicate.children[0]) - self.assertEqual(problem2_in_course.display_name, self.original_display_name) + self.assertEqual(problem2_in_course.display_name, self.original_display_name) # noqa: PT009 # Refresh our reference to the block self.lc_block = self._upgrade_and_sync(self.lc_block) self.problem_in_course = store.get_item(self.problem_in_course.location) # and the block has changed too. - self.assertEqual(len(self.lc_block.children), 2) + self.assertEqual(len(self.lc_block.children), 2) # noqa: PT009 diff --git a/cms/djangoapps/contentstore/tests/test_orphan.py b/cms/djangoapps/contentstore/tests/test_orphan.py index 244eecebf9af..af63f9f8028d 100644 --- a/cms/djangoapps/contentstore/tests/test_orphan.py +++ b/cms/djangoapps/contentstore/tests/test_orphan.py @@ -10,9 +10,12 @@ from cms.djangoapps.contentstore.tests.utils import CourseTestCase from cms.djangoapps.contentstore.utils import reverse_course_url from common.djangoapps.student.models import CourseEnrollment -from xmodule.modulestore import ModuleStoreEnum # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.search import path_to_location # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory, check_mongo_calls_range # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore import ModuleStoreEnum # pylint: disable=wrong-import-order +from xmodule.modulestore.search import path_to_location # pylint: disable=wrong-import-order +from xmodule.modulestore.tests.factories import ( # pylint: disable=wrong-import-order + CourseFactory, + check_mongo_calls_range, +) class TestOrphanBase(CourseTestCase): @@ -70,7 +73,7 @@ def assertOrphanCount(self, course_key, number): Asserts that we have the expected count of orphans for a given course_key """ - self.assertEqual(len(self.store.get_orphans(course_key)), number) + self.assertEqual(len(self.store.get_orphans(course_key)), number) # noqa: PT009 class TestOrphan(TestOrphanBase): @@ -91,13 +94,13 @@ def test_get_orphans(self): HTTP_ACCEPT='application/json' ).content.decode('utf-8') ) - self.assertEqual(len(orphans), 3, f"Wrong # {orphans}") + self.assertEqual(len(orphans), 3, f"Wrong # {orphans}") # noqa: PT009 location = course.location.replace(category='chapter', name='OrphanChapter') - self.assertIn(str(location), orphans) + self.assertIn(str(location), orphans) # noqa: PT009 location = course.location.replace(category='vertical', name='OrphanVert') - self.assertIn(str(location), orphans) + self.assertIn(str(location), orphans) # noqa: PT009 location = course.location.replace(category='html', name='OrphanHtml') - self.assertIn(str(location), orphans) + self.assertIn(str(location), orphans) # noqa: PT009 def test_delete_orphans(self): """ @@ -112,11 +115,11 @@ def test_delete_orphans(self): orphans = json.loads( self.client.get(orphan_url, HTTP_ACCEPT='application/json').content.decode('utf-8') ) - self.assertEqual(len(orphans), 0, f"Orphans not deleted {orphans}") + self.assertEqual(len(orphans), 0, f"Orphans not deleted {orphans}") # noqa: PT009 # make sure that any children with one orphan parent and one non-orphan # parent are not deleted - self.assertTrue(self.store.has_item(course.id.make_usage_key('html', "multi_parent_html"))) + self.assertTrue(self.store.has_item(course.id.make_usage_key('html', "multi_parent_html"))) # noqa: PT009 def test_not_permitted(self): """ @@ -128,9 +131,9 @@ def test_not_permitted(self): test_user_client, test_user = self.create_non_staff_authed_user_client() CourseEnrollment.enroll(test_user, course.id) response = test_user_client.get(orphan_url) - self.assertEqual(response.status_code, 403) + self.assertEqual(response.status_code, 403) # noqa: PT009 response = test_user_client.delete(orphan_url) - self.assertEqual(response.status_code, 403) + self.assertEqual(response.status_code, 403) # noqa: PT009 def test_path_to_location_for_orphan_vertical(self): r""" @@ -155,16 +158,16 @@ def test_path_to_location_for_orphan_vertical(self): multi_parent_html = self.store.get_item(BlockUsageLocator(course.id, 'html', 'multi_parent_html')) # Verify `OrphanVert` is an orphan - self.assertIn(orphan_vertical.location, self.store.get_orphans(course.id)) + self.assertIn(orphan_vertical.location, self.store.get_orphans(course.id)) # noqa: PT009 # Verify `multi_parent_html` is child of both `Vertical1` and `OrphanVert` - self.assertIn(multi_parent_html.location, orphan_vertical.children) - self.assertIn(multi_parent_html.location, vertical1.children) + self.assertIn(multi_parent_html.location, orphan_vertical.children) # noqa: PT009 + self.assertIn(multi_parent_html.location, vertical1.children) # noqa: PT009 # HTML component has `vertical1` as its parent. html_parent = self.store.get_parent_location(multi_parent_html.location) - self.assertNotEqual(str(html_parent), str(orphan_vertical.location)) - self.assertEqual(str(html_parent), str(vertical1.location)) + self.assertNotEqual(str(html_parent), str(orphan_vertical.location)) # noqa: PT009 + self.assertEqual(str(html_parent), str(vertical1.location)) # noqa: PT009 # Get path of the `multi_parent_html` & verify path_to_location returns a expected path path = path_to_location(self.store, multi_parent_html.location) @@ -176,9 +179,9 @@ def test_path_to_location_for_orphan_vertical(self): "", path[-1] ) - self.assertIsNotNone(path) - self.assertEqual(len(path), 6) - self.assertEqual(path, expected_path) + self.assertIsNotNone(path) # noqa: PT009 + self.assertEqual(len(path), 6) # noqa: PT009 + self.assertEqual(path, expected_path) # noqa: PT009 def test_path_to_location_for_orphan_chapter(self): r""" @@ -201,7 +204,7 @@ def test_path_to_location_for_orphan_chapter(self): vertical1 = self.store.get_item(BlockUsageLocator(course.id, 'vertical', 'Vertical1')) # Verify `OrhanChapter` is an orphan - self.assertIn(orphan_chapter.location, self.store.get_orphans(course.id)) + self.assertIn(orphan_chapter.location, self.store.get_orphans(course.id)) # noqa: PT009 # Create a vertical (`Vertical0`) in orphan chapter (`OrphanChapter`). # OrphanChapter -> Vertical0 @@ -215,7 +218,7 @@ def test_path_to_location_for_orphan_chapter(self): # Verify chapter1 is parent of vertical1. vertical1_parent = self.store.get_parent_location(vertical1.location) - self.assertEqual(str(vertical1_parent), str(chapter1.location)) + self.assertEqual(str(vertical1_parent), str(chapter1.location)) # noqa: PT009 # Make `Vertical1` the parent of `HTML0`. So `HTML0` will have to parents (`Vertical0` & `Vertical1`) vertical1.children.append(html.location) @@ -224,7 +227,7 @@ def test_path_to_location_for_orphan_chapter(self): # Get parent location & verify its either of the two verticals. As both parents are non-orphan, # alphabetically least is returned html_parent = self.store.get_parent_location(html.location) - self.assertEqual(str(html_parent), str(vertical1.location)) + self.assertEqual(str(html_parent), str(vertical1.location)) # noqa: PT009 # verify path_to_location returns a expected path path = path_to_location(self.store, html.location) @@ -236,6 +239,6 @@ def test_path_to_location_for_orphan_chapter(self): "", path[-1] ) - self.assertIsNotNone(path) - self.assertEqual(len(path), 6) - self.assertEqual(path, expected_path) + self.assertIsNotNone(path) # noqa: PT009 + self.assertEqual(len(path), 6) # noqa: PT009 + self.assertEqual(path, expected_path) # noqa: PT009 diff --git a/cms/djangoapps/contentstore/tests/test_outlines.py b/cms/djangoapps/contentstore/tests/test_outlines.py index 108edd82df43..c94c12f7bdad 100644 --- a/cms/djangoapps/contentstore/tests/test_outlines.py +++ b/cms/djangoapps/contentstore/tests/test_outlines.py @@ -8,9 +8,14 @@ from openedx.core.djangoapps.content.learning_sequences.api import get_course_outline from openedx.core.djangoapps.content.learning_sequences.data import CourseOutlineData, ExamData, VisibilityData -from xmodule.modulestore import ModuleStoreEnum # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory, BlockFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore import ModuleStoreEnum # pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + ModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import ( # pylint: disable=wrong-import-order + BlockFactory, + CourseFactory, +) from ..outlines import get_outline_from_modulestore @@ -66,7 +71,7 @@ def test_empty_course_metadata(self): # published_at assert isinstance(outline.published_at, datetime) assert outline.published_at == published_course.subtree_edited_on - assert outline.published_at.tzinfo == timezone.utc + assert outline.published_at.tzinfo == timezone.utc # noqa: UP017 # published_version assert isinstance(outline.published_version, str) @@ -517,7 +522,7 @@ class OutlineFromModuleStoreTaskTestCase(ModuleStoreTestCase): def test_task_invocation(self): """Test outline auto-creation after course publish""" course_key = CourseKey.from_string("course-v1:TNL+7733+2021-01-21") - with self.assertRaises(CourseOutlineData.DoesNotExist): + with self.assertRaises(CourseOutlineData.DoesNotExist): # noqa: PT027 get_course_outline(course_key) course = CourseFactory.create( diff --git a/cms/djangoapps/contentstore/tests/test_permissions.py b/cms/djangoapps/contentstore/tests/test_permissions.py index d8fad571658d..6cdd8629ec52 100644 --- a/cms/djangoapps/contentstore/tests/test_permissions.py +++ b/cms/djangoapps/contentstore/tests/test_permissions.py @@ -4,15 +4,14 @@ import copy -from edx_toggles.toggles.testutils import override_waffle_flag - -from cms.djangoapps.contentstore import toggles from cms.djangoapps.contentstore.tests.utils import AjaxEnabledTestClient -from cms.djangoapps.contentstore.utils import reverse_course_url, reverse_url +from cms.djangoapps.contentstore.utils import reverse_url from common.djangoapps.student import auth from common.djangoapps.student.roles import CourseInstructorRole, CourseStaffRole, OrgInstructorRole, OrgStaffRole from common.djangoapps.student.tests.factories import UserFactory -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + ModuleStoreTestCase, # pylint: disable=wrong-import-order +) class TestCourseAccess(ModuleStoreTestCase): @@ -66,19 +65,14 @@ def tearDown(self): self.client.logout() ModuleStoreTestCase.tearDown(self) # pylint: disable=non-parent-method-called - @override_waffle_flag(toggles.LEGACY_STUDIO_COURSE_TEAM, True) def test_get_all_users(self): """ Test getting all authors for a course where their permissions run the gamut of allowed group types. - - TODO: Replace the call to the legacy course_team_handler with a call to the course team REST API. - The legacy page will be removed, but we still want to the test these behaviors. - Part of https://github.com/openedx/edx-platform/issues/36275. """ # first check the course creator.has explicit access (don't use has_access as is_staff # will trump the actual test) - self.assertTrue( + self.assertTrue( # noqa: PT009 CourseInstructorRole(self.course_key).has_user(self.user), "Didn't add creator as instructor." ) @@ -99,13 +93,7 @@ def test_get_all_users(self): user = users.pop() group.add_users(user) user_by_role[role].append(user) - self.assertTrue(auth.has_course_author_access(user, self.course_key), f"{user} does not have access") # lint-amnesty, pylint: disable=line-too-long - - course_team_url = reverse_course_url('course_team_handler', self.course_key) - response = self.client.get_html(course_team_url) - for role in [CourseInstructorRole, CourseStaffRole]: # Global and org-based roles don't appear on this page - for user in user_by_role[role]: - self.assertContains(response, user.email) + self.assertTrue(auth.has_course_author_access(user, self.course_key), f"{user} does not have access") # pylint: disable=line-too-long # noqa: PT009 # test copying course permissions copy_course_key = self.store.make_course_key('copyu', 'copydept.mycourse', 'myrun') @@ -132,9 +120,9 @@ def test_get_all_users(self): if hasattr(user, '_roles'): del user._roles - self.assertTrue(auth.has_course_author_access(user, copy_course_key), f"{user} no copy access") + self.assertTrue(auth.has_course_author_access(user, copy_course_key), f"{user} no copy access") # noqa: PT009 # pylint: disable=line-too-long if (role is OrgStaffRole) or (role is OrgInstructorRole): auth.remove_users(self.user, role(self.course_key.org), user) else: auth.remove_users(self.user, role(self.course_key), user) - self.assertFalse(auth.has_course_author_access(user, self.course_key), f"{user} remove didn't work") # lint-amnesty, pylint: disable=line-too-long + self.assertFalse(auth.has_course_author_access(user, self.course_key), f"{user} remove didn't work") # pylint: disable=line-too-long # noqa: PT009 diff --git a/cms/djangoapps/contentstore/tests/test_proctoring.py b/cms/djangoapps/contentstore/tests/test_proctoring.py index d9b83a811ef0..83b46ca2a063 100644 --- a/cms/djangoapps/contentstore/tests/test_proctoring.py +++ b/cms/djangoapps/contentstore/tests/test_proctoring.py @@ -4,18 +4,18 @@ from datetime import datetime, timedelta -from unittest.mock import patch, Mock +from unittest.mock import Mock, patch import ddt from django.conf import settings from edx_proctoring.api import get_all_exams_for_course, get_review_policy_by_exam_id from pytz import UTC -from xmodule.modulestore import ModuleStoreEnum -from xmodule.modulestore.tests.django_utils import TEST_DATA_SPLIT_MODULESTORE, ModuleStoreTestCase -from xmodule.modulestore.tests.factories import CourseFactory, BlockFactory from cms.djangoapps.contentstore.signals.handlers import listen_for_course_publish from common.djangoapps.student.tests.factories import UserFactory +from xmodule.modulestore import ModuleStoreEnum +from xmodule.modulestore.tests.django_utils import TEST_DATA_SPLIT_MODULESTORE, ModuleStoreTestCase +from xmodule.modulestore.tests.factories import BlockFactory, CourseFactory @ddt.ddt @@ -52,27 +52,27 @@ def _verify_exam_data(self, sequence, expected_active): """ exams = get_all_exams_for_course(str(self.course.id)) - self.assertEqual(len(exams), 1) + self.assertEqual(len(exams), 1) # noqa: PT009 exam = exams[0] if exam['is_proctored'] and not exam['is_practice_exam']: # get the review policy object exam_review_policy = get_review_policy_by_exam_id(exam['id']) - self.assertEqual(exam_review_policy['review_policy'], sequence.exam_review_rules) + self.assertEqual(exam_review_policy['review_policy'], sequence.exam_review_rules) # noqa: PT009 if not exam['is_proctored'] and not exam['is_practice_exam']: # the hide after due value only applies to timed exams - self.assertEqual(exam['hide_after_due'], sequence.hide_after_due) + self.assertEqual(exam['hide_after_due'], sequence.hide_after_due) # noqa: PT009 - self.assertEqual(exam['course_id'], str(self.course.id)) - self.assertEqual(exam['content_id'], str(sequence.location)) - self.assertEqual(exam['exam_name'], sequence.display_name) - self.assertEqual(exam['time_limit_mins'], sequence.default_time_limit_minutes) - self.assertEqual(exam['is_proctored'], sequence.is_proctored_exam) - self.assertEqual(exam['is_practice_exam'], sequence.is_practice_exam or sequence.is_onboarding_exam) - self.assertEqual(exam['is_active'], expected_active) - self.assertEqual(exam['backend'], self.course.proctoring_provider) + self.assertEqual(exam['course_id'], str(self.course.id)) # noqa: PT009 + self.assertEqual(exam['content_id'], str(sequence.location)) # noqa: PT009 + self.assertEqual(exam['exam_name'], sequence.display_name) # noqa: PT009 + self.assertEqual(exam['time_limit_mins'], sequence.default_time_limit_minutes) # noqa: PT009 + self.assertEqual(exam['is_proctored'], sequence.is_proctored_exam) # noqa: PT009 + self.assertEqual(exam['is_practice_exam'], sequence.is_practice_exam or sequence.is_onboarding_exam) # noqa: PT009 # pylint: disable=line-too-long + self.assertEqual(exam['is_active'], expected_active) # noqa: PT009 + self.assertEqual(exam['backend'], self.course.proctoring_provider) # noqa: PT009 @ddt.data( (False, True), @@ -174,7 +174,7 @@ def test_unpublishing_proctored_exam(self): listen_for_course_publish(self, self.course.id) exams = get_all_exams_for_course(str(self.course.id)) - self.assertEqual(len(exams), 1) + self.assertEqual(len(exams), 1) # noqa: PT009 sequence.is_time_limited = False sequence.is_proctored_exam = False @@ -205,7 +205,7 @@ def test_dangling_exam(self): listen_for_course_publish(self, self.course.id) exams = get_all_exams_for_course(str(self.course.id)) - self.assertEqual(len(exams), 1) + self.assertEqual(len(exams), 1) # noqa: PT009 self.store.delete_item(chapter.location, self.user.id) @@ -215,10 +215,10 @@ def test_dangling_exam(self): # look through exam table, the dangling exam # should be disabled exams = get_all_exams_for_course(str(self.course.id)) - self.assertEqual(len(exams), 1) + self.assertEqual(len(exams), 1) # noqa: PT009 exam = exams[0] - self.assertEqual(exam['is_active'], False) + self.assertEqual(exam['is_active'], False) # noqa: PT009 @patch.dict('django.conf.settings.FEATURES', {'ENABLE_SPECIAL_EXAMS': False}) def test_feature_flag_off(self): @@ -240,7 +240,7 @@ def test_feature_flag_off(self): listen_for_course_publish(self, self.course.id) exams = get_all_exams_for_course(str(self.course.id)) - self.assertEqual(len(exams), 0) + self.assertEqual(len(exams), 0) # noqa: PT009 @ddt.data( (True, False, 1), @@ -279,7 +279,7 @@ def test_advanced_settings(self, enable_timed_exams, enable_proctored_exams, exp # there shouldn't be any exams because we haven't enabled that # advanced setting flag exams = get_all_exams_for_course(str(self.course.id)) - self.assertEqual(len(exams), expected_count) + self.assertEqual(len(exams), expected_count) # noqa: PT009 def test_self_paced_no_due_dates(self): self.course = CourseFactory.create( @@ -336,7 +336,7 @@ def test_async_waffle_flag_publishes(self): listen_for_course_publish(self, self.course.id) exams = get_all_exams_for_course(str(self.course.id)) - self.assertEqual(len(exams), 1) + self.assertEqual(len(exams), 1) # noqa: PT009 self._verify_exam_data(sequence, True) def test_async_waffle_flag_task(self): diff --git a/cms/djangoapps/contentstore/tests/test_request_event.py b/cms/djangoapps/contentstore/tests/test_request_event.py index c4d21f72497a..ee99dc12c934 100644 --- a/cms/djangoapps/contentstore/tests/test_request_event.py +++ b/cms/djangoapps/contentstore/tests/test_request_event.py @@ -23,7 +23,7 @@ def test_post_answers_to_log(self): ] for request_params in requests: response = self.client.post(reverse(cms_user_track), request_params) - self.assertEqual(response.status_code, 204) + self.assertEqual(response.status_code, 204) # noqa: PT009 def test_get_answers_to_log(self): """ @@ -36,4 +36,4 @@ def test_get_answers_to_log(self): ] for request_params in requests: response = self.client.get(reverse(cms_user_track), request_params) - self.assertEqual(response.status_code, 204) + self.assertEqual(response.status_code, 204) # noqa: PT009 diff --git a/cms/djangoapps/contentstore/tests/test_signals.py b/cms/djangoapps/contentstore/tests/test_signals.py index de66134a440f..17338814ae92 100644 --- a/cms/djangoapps/contentstore/tests/test_signals.py +++ b/cms/djangoapps/contentstore/tests/test_signals.py @@ -8,8 +8,10 @@ from cms.djangoapps.contentstore.signals.handlers import GRADING_POLICY_COUNTDOWN_SECONDS, handle_grading_policy_changed from common.djangoapps.student.models import CourseEnrollment from common.djangoapps.student.tests.factories import UserFactory -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + ModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order @ddt.ddt @@ -36,6 +38,6 @@ def test_locked(self, lock_available, compute_grades_async_mock, add_mock): handle_grading_policy_changed(sender, course_key=str(self.course.id)) cache_key = f'handle_grading_policy_changed-{str(self.course.id)}' - self.assertEqual(lock_available, compute_grades_async_mock.called) + self.assertEqual(lock_available, compute_grades_async_mock.called) # noqa: PT009 if lock_available: add_mock.assert_called_once_with(cache_key, "true", GRADING_POLICY_COUNTDOWN_SECONDS) diff --git a/cms/djangoapps/contentstore/tests/test_tasks.py b/cms/djangoapps/contentstore/tests/test_tasks.py index 5a76b7d67fe7..1f8f0348a11c 100644 --- a/cms/djangoapps/contentstore/tests/test_tasks.py +++ b/cms/djangoapps/contentstore/tests/test_tasks.py @@ -5,13 +5,15 @@ import json import logging from unittest import mock -from unittest.mock import AsyncMock, patch, MagicMock +from unittest.mock import AsyncMock, MagicMock, patch from uuid import uuid4 -from celery import Task +import ddt import pytest +from celery import Task from django.conf import settings -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user +from django.db import models from django.test.utils import override_settings from edx_toggles.toggles.testutils import override_waffle_flag from opaque_keys.edx.keys import CourseKey @@ -25,29 +27,36 @@ from common.djangoapps.course_action_state.models import CourseRerunState from common.djangoapps.student.tests.factories import UserFactory from openedx.core.djangoapps.course_apps.toggles import EXAMS_IDA +from openedx.core.djangoapps.discussions.config.waffle import ENABLE_NEW_STRUCTURE_DISCUSSIONS +from openedx.core.djangoapps.discussions.models import DiscussionsConfiguration, Provider from openedx.core.djangoapps.embargo.models import Country, CountryAccessRule, RestrictedCourse from xmodule.modulestore import ModuleStoreEnum -from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order from xmodule.modulestore.tests.django_utils import TEST_DATA_SPLIT_MODULESTORE, ModuleStoreTestCase -from xmodule.modulestore.tests.factories import CourseFactory, BlockFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.factories import ( # pylint: disable=wrong-import-order + BlockFactory, + CourseFactory, +) + from ..tasks import ( LinkState, - export_olx, - update_special_exams_and_publish, - rerun_course, - _validate_urls_access_in_batches, - _filter_by_status, _check_broken_links, + _convert_to_standard_url, + _filter_by_status, _is_studio_url, _scan_course_for_links, - _convert_to_standard_url, - extract_content_URLs_from_course + _validate_urls_access_in_batches, + export_olx, + extract_content_URLs_from_course, + rerun_course, + sync_discussion_settings, + update_special_exams_and_publish, ) logging = logging.getLogger(__name__) TEST_DATA_CONTENTSTORE = copy.deepcopy(settings.CONTENTSTORE) -TEST_DATA_CONTENTSTORE['DOC_STORE_CONFIG']['db'] = 'test_xcontent_%s' % uuid4().hex +TEST_DATA_CONTENTSTORE['DOC_STORE_CONFIG']['db'] = 'test_xcontent_%s' % uuid4().hex # noqa: UP031 def side_effect_exception(*args, **kwargs): @@ -70,11 +79,11 @@ def test_success(self): key = str(self.course.location.course_key) result = export_olx.delay(self.user.id, key, 'en') status = UserTaskStatus.objects.get(task_id=result.id) - self.assertEqual(status.state, UserTaskStatus.SUCCEEDED) + self.assertEqual(status.state, UserTaskStatus.SUCCEEDED) # noqa: PT009 artifacts = UserTaskArtifact.objects.filter(status=status) - self.assertEqual(len(artifacts), 1) + self.assertEqual(len(artifacts), 1) # noqa: PT009 output = artifacts[0] - self.assertEqual(output.name, 'Output') + self.assertEqual(output.name, 'Output') # noqa: PT009 @mock.patch('cms.djangoapps.contentstore.tasks.export_course_to_xml', side_effect=side_effect_exception) def test_exception(self, mock_export): # pylint: disable=unused-argument @@ -109,12 +118,12 @@ def _assert_failed(self, task_result, error_message): Verify that a task failed with the specified error message """ status = UserTaskStatus.objects.get(task_id=task_result.id) - self.assertEqual(status.state, UserTaskStatus.FAILED) + self.assertEqual(status.state, UserTaskStatus.FAILED) # noqa: PT009 artifacts = UserTaskArtifact.objects.filter(status=status) - self.assertEqual(len(artifacts), 1) + self.assertEqual(len(artifacts), 1) # noqa: PT009 error = artifacts[0] - self.assertEqual(error.name, 'Error') - self.assertEqual(error.text, error_message) + self.assertEqual(error.name, 'Error') # noqa: PT009 + self.assertEqual(error.text, error_message) # noqa: PT009 @override_settings(CONTENTSTORE=TEST_DATA_CONTENTSTORE) @@ -130,15 +139,15 @@ def test_success(self): key = str(self.lib_key) result = export_olx.delay(self.user.id, key, 'en') status = UserTaskStatus.objects.get(task_id=result.id) - self.assertEqual(status.state, UserTaskStatus.SUCCEEDED) + self.assertEqual(status.state, UserTaskStatus.SUCCEEDED) # noqa: PT009 artifacts = UserTaskArtifact.objects.filter(status=status) - self.assertEqual(len(artifacts), 1) + self.assertEqual(len(artifacts), 1) # noqa: PT009 output = artifacts[0] - self.assertEqual(output.name, 'Output') + self.assertEqual(output.name, 'Output') # noqa: PT009 @override_settings(CONTENTSTORE=TEST_DATA_CONTENTSTORE) -class RerunCourseTaskTestCase(CourseTestCase): # lint-amnesty, pylint: disable=missing-class-docstring +class RerunCourseTaskTestCase(CourseTestCase): # pylint: disable=missing-class-docstring MODULESTORE = TEST_DATA_SPLIT_MODULESTORE @@ -171,18 +180,18 @@ def test_success(self): # Verify the new course run exists course = modulestore().get_course(new_course_key) - self.assertIsNotNone(course) + self.assertIsNotNone(course) # noqa: PT009 # Verify the OrganizationCourse is cloned - self.assertEqual(OrganizationCourse.objects.count(), 2) + self.assertEqual(OrganizationCourse.objects.count(), 2) # noqa: PT009 # This will raise an error if the OrganizationCourse object was not cloned OrganizationCourse.objects.get(course_id=new_course_id, organization=organization) # Verify the RestrictedCourse and related objects are cloned - self.assertEqual(RestrictedCourse.objects.count(), 2) + self.assertEqual(RestrictedCourse.objects.count(), 2) # noqa: PT009 restricted_course = RestrictedCourse.objects.get(course_key=new_course_key) - self.assertEqual(CountryAccessRule.objects.count(), 2) + self.assertEqual(CountryAccessRule.objects.count(), 2) # noqa: PT009 CountryAccessRule.objects.get( rule_type=CountryAccessRule.BLACKLIST_RULE, restricted_course=restricted_course, @@ -206,7 +215,7 @@ def test_success_different_org(self): self._rerun_course(old_course_key, new_course_key) # Verify the OrganizationCourse is cloned with a different org - self.assertEqual(OrganizationCourse.objects.count(), 2) + self.assertEqual(OrganizationCourse.objects.count(), 2) # noqa: PT009 OrganizationCourse.objects.get(course_id=new_course_id, organization__short_name='neworg') @@ -215,7 +224,7 @@ class RegisterExamsTaskTestCase(CourseTestCase): # pylint: disable=missing-clas @mock.patch('cms.djangoapps.contentstore.exams.register_exams') @mock.patch('cms.djangoapps.contentstore.proctoring.register_special_exams') - def test_exam_service_not_enabled_success(self, _mock_register_exams_proctoring, _mock_register_exams_service): + def test_exam_service_not_enabled_success(self, _mock_register_exams_proctoring, _mock_register_exams_service): # noqa: PT019 # pylint: disable=line-too-long """ edx-proctoring interface is called if exam service is not enabled """ update_special_exams_and_publish(str(self.course.id)) _mock_register_exams_proctoring.assert_called_once_with(self.course.id) @@ -224,7 +233,7 @@ def test_exam_service_not_enabled_success(self, _mock_register_exams_proctoring, @mock.patch('cms.djangoapps.contentstore.exams.register_exams') @mock.patch('cms.djangoapps.contentstore.proctoring.register_special_exams') @override_waffle_flag(EXAMS_IDA, active=True) - def test_exam_service_enabled_success(self, _mock_register_exams_proctoring, _mock_register_exams_service): + def test_exam_service_enabled_success(self, _mock_register_exams_proctoring, _mock_register_exams_service): # noqa: PT019 # pylint: disable=line-too-long """ exams service interface is called if exam service is enabled """ update_special_exams_and_publish(str(self.course.id)) _mock_register_exams_proctoring.assert_not_called() @@ -232,7 +241,7 @@ def test_exam_service_enabled_success(self, _mock_register_exams_proctoring, _mo @mock.patch('cms.djangoapps.contentstore.exams.register_exams') @mock.patch('cms.djangoapps.contentstore.proctoring.register_special_exams') - def test_register_exams_failure(self, _mock_register_exams_proctoring, _mock_register_exams_service): + def test_register_exams_failure(self, _mock_register_exams_proctoring, _mock_register_exams_service): # noqa: PT019 """ credit requirements update signal fires even if exam registration fails """ with mock.patch('openedx.core.djangoapps.credit.signals.handlers.on_course_publish') as course_publish: _mock_register_exams_proctoring.side_effect = Exception('boom!') @@ -252,7 +261,7 @@ class CheckBrokenLinksTaskTest(ModuleStoreTestCase): """Tests for CheckBrokenLinksTask""" def setUp(self): super().setUp() - self.store = modulestore()._get_modulestore_by_type(ModuleStoreEnum.Type.mongo) # lint-amnesty, pylint: disable=protected-access + self.store = modulestore()._get_modulestore_by_type(ModuleStoreEnum.Type.mongo) # pylint: disable=protected-access self.test_course = CourseFactory.create( org="test", course="course1", display_name="run1" ) @@ -354,22 +363,22 @@ def test_hash_tags_stripped_from_url_lists(self): f'Processed URL list lines = {processed_lines}; expected {original_lines - 2}' def test_http_url_not_recognized_as_studio_url_scheme(self): - self.assertFalse(_is_studio_url('http://www.google.com')) + self.assertFalse(_is_studio_url('http://www.google.com')) # noqa: PT009 def test_https_url_not_recognized_as_studio_url_scheme(self): - self.assertFalse(_is_studio_url('https://www.google.com')) + self.assertFalse(_is_studio_url('https://www.google.com')) # noqa: PT009 def test_http_with_studio_base_url_recognized_as_studio_url_scheme(self): - self.assertTrue(_is_studio_url(f'http://{settings.CMS_BASE}/testurl')) + self.assertTrue(_is_studio_url(f'http://{settings.CMS_BASE}/testurl')) # noqa: PT009 def test_https_with_studio_base_url_recognized_as_studio_url_scheme(self): - self.assertTrue(_is_studio_url(f'https://{settings.CMS_BASE}/testurl')) + self.assertTrue(_is_studio_url(f'https://{settings.CMS_BASE}/testurl')) # noqa: PT009 def test_container_url_without_url_base_is_recognized_as_studio_url_scheme(self): - self.assertTrue(_is_studio_url('container/test')) + self.assertTrue(_is_studio_url('container/test')) # noqa: PT009 def test_slash_url_without_url_base_is_recognized_as_studio_url_scheme(self): - self.assertTrue(_is_studio_url('/static/test')) + self.assertTrue(_is_studio_url('/static/test')) # noqa: PT009 @mock.patch('cms.djangoapps.contentstore.tasks.ModuleStoreEnum', autospec=True) @mock.patch('cms.djangoapps.contentstore.tasks.modulestore', autospec=True) @@ -398,7 +407,7 @@ def test_number_of_scanned_blocks_equals_blocks_in_course(self, mockextract_cont expected_blocks = self.store.get_items(self.test_course.id) _scan_course_for_links(self.test_course.id) - self.assertEqual(len(expected_blocks), mockextract_content_URLs_from_course.call_count) + self.assertEqual(len(expected_blocks), mockextract_content_URLs_from_course.call_count) # noqa: PT009 @mock.patch('cms.djangoapps.contentstore.tasks.get_block_info', autospec=True) @mock.patch('cms.djangoapps.contentstore.tasks.modulestore', autospec=True) @@ -434,11 +443,11 @@ def get_block_side_effect(block): urls = _scan_course_for_links(self.test_course.id) # The drag-and-drop block should not appear in the results - self.assertFalse( + self.assertFalse( # noqa: PT009 any(block_id == str(drag_and_drop_block.usage_key) for block_id, _ in urls), "Drag and Drop blocks should be excluded" ) - self.assertTrue( + self.assertTrue( # noqa: PT009 any(block_id == str(text_block.usage_key) for block_id, _ in urls), "Text block should be included" ) @@ -536,8 +545,8 @@ def test_filter_by_status(self): filtered_results, retry_list = _filter_by_status(results) - self.assertEqual(filtered_results, expected_filtered_results) - self.assertEqual(retry_list, expected_retry_list) + self.assertEqual(filtered_results, expected_filtered_results) # noqa: PT009 + self.assertEqual(retry_list, expected_retry_list) # noqa: PT009 @patch("cms.djangoapps.contentstore.tasks._validate_user", return_value=MagicMock()) @patch("cms.djangoapps.contentstore.tasks._scan_course_for_links", return_value=["url1", "url2"]) @@ -606,7 +615,7 @@ def __init__(self): logging.exception("Error checking links for course %s", course_key_string, exc_info=True) if mock_self.status.state != "FAILED": mock_self.status.fail({"raw_error_msg": str(e)}) - assert False, "Exception should not occur" + assert False, "Exception should not occur" # noqa: B011, PT015 # Assertions to confirm patched calls were invoked mock_validate_user.assert_called_once_with(mock_self, user_id, language) @@ -638,7 +647,7 @@ def test_convert_to_standard_url(self): ] for url, expected in test_cases: - self.assertEqual( + self.assertEqual( # noqa: PT009 _convert_to_standard_url(url, course_key), expected, f"Failed for URL: {url}", @@ -667,4 +676,137 @@ def test_extract_content_URLs_from_course(self): "https://validsite.com", "https://another-valid.com" ] - self.assertEqual(extract_content_URLs_from_course(content), set(expected)) + self.assertEqual(extract_content_URLs_from_course(content), set(expected)) # noqa: PT009 + + +@ddt.ddt +@override_settings(CONTENTSTORE=TEST_DATA_CONTENTSTORE) +class SyncDiscussionSettingsTaskTestCase(CourseTestCase): + """Tests for the `sync_discussion_settings` task.""" + + def setUp(self): + super().setUp() + self.discussion_config = DiscussionsConfiguration.objects.create(context_key=self.course.id) + + def _update_discussion_settings(self, discussions_settings: dict): + """Helper method to set discussion settings in the course.""" + self.course.discussions_settings = discussions_settings + modulestore().update_item(self.course, self.user.id) + + def test_sync_settings(self): + """Test syncing discussion settings to DiscussionsConfiguration.""" + self._update_discussion_settings( + { + "enable_graded_units": True, + "unit_level_visibility": False, + "enable_in_context": True, + "posting_restrictions": "enabled", + } + ) + + sync_discussion_settings(self.course.id, self.user) + + self.discussion_config.refresh_from_db() + assert self.discussion_config.enable_graded_units is True + assert self.discussion_config.unit_level_visibility is False + assert self.discussion_config.enable_in_context is True + assert self.discussion_config.posting_restrictions == "enabled" + assert self.discussion_config.provider_type == Provider.LEGACY + + def test_sync_plugin_configuration(self): + """Test syncing plugin configuration from provider settings.""" + # Set up course discussion settings with provider-specific config + provider_config = {"test_key": "test_value", "test_key_2": "test_value_2"} + self._update_discussion_settings({self.discussion_config.provider_type: provider_config}) + + sync_discussion_settings(self.course.id, self.user) + + self.discussion_config.refresh_from_db() + assert self.discussion_config.plugin_configuration == provider_config + + @override_waffle_flag(ENABLE_NEW_STRUCTURE_DISCUSSIONS, active=True) + def test_auto_migrate_to_new_structure(self): + """Test automatic migration to the `OPEN_EDX` provider when new structure is enabled.""" + with self.assertLogs("cms.djangoapps.contentstore.tasks", level="INFO") as logs: + sync_discussion_settings(self.course.id, self.user) + + migration_log = f"New structure is enabled, also updating {self.course.id} to use new provider" + assert any(migration_log in log for log in logs.output) + + self.discussion_config.refresh_from_db() + assert self.discussion_config.provider_type == Provider.OPEN_EDX + + course = modulestore().get_course(self.course.id) + assert course.discussions_settings.get("provider_type") == Provider.OPEN_EDX + + @ddt.data( + {"provider_type": Provider.OPEN_EDX}, # Using the `provider_type` field. + {"provider": Provider.OPEN_EDX}, # Using the `provider` field as fallback. + ) + @override_waffle_flag(ENABLE_NEW_STRUCTURE_DISCUSSIONS, active=True) + def test_no_provider_migration_when_already_openedx(self, provider_settings: dict): + """Test no migration occurs when provider is already `OPEN_EDX`.""" + self._update_discussion_settings(provider_settings) + + with self.assertLogs("cms.djangoapps.contentstore.tasks", level="INFO") as logs: + sync_discussion_settings(self.course.id, self.user) + + migration_log = f"New structure is enabled, also updating {self.course.id} to use new provider" + assert not any(migration_log in log for log in logs.output) + + def test_all_syncable_fields_are_overridden(self): + """ + Verify that all syncable DiscussionsConfiguration fields are updated during course import. + + If this test fails after adding a new field, update `sync_discussion_settings` to handle it. + """ + + excluded_fields = { + "context_key", # Primary key - not synced. + "enabled", # Handled separately in `update_discussions_settings_from_course`. + "created", # Auto-generated by TimeStampedModel. + "modified", # Auto-generated by TimeStampedModel. + "plugin_configuration", # Custom logic. Already tested in `test_sync_plugin_configuration`. + "provider_type", # Custom logic. Already tested in `test_auto_migrate_to_new_structure`. + } + + test_values = {} + for field in DiscussionsConfiguration._meta.get_fields(): + if not getattr(field, "concrete", False): + continue + if field.primary_key or field.name in excluded_fields: + continue + if isinstance(field, (models.ForeignKey, models.ManyToManyField)): + continue + + if isinstance(field, models.BooleanField): + test_values[field.name] = not field.default + elif isinstance(field, models.CharField) and field.choices: + test_values[field.name] = next(v for v, _ in field.choices if v != field.default) + elif isinstance(field, models.CharField): + test_values[field.name] = "test_sync_value" + else: + test_values[field.name] = {"synced_key": "synced_value"} + + self._update_discussion_settings(test_values) + sync_discussion_settings(self.course.id, self.user) + + self.discussion_config.refresh_from_db() + for name, expected in test_values.items(): + assert getattr(self.discussion_config, name) == expected, ( + f"Field '{name}' was not synced during course import. " + f"Update sync_discussion_settings to handle this field.", + ) + + def test_handling_exceptions(self): + """Test that exceptions are caught and logged properly.""" + test_error_message = "Test error" + + with mock.patch.object(DiscussionsConfiguration.objects, "get", side_effect=Exception(test_error_message)): + with self.assertLogs("cms.djangoapps.contentstore.tasks", level="INFO") as logs: + sync_discussion_settings(self.course.id, self.user) + + expected_log = ( + f"Course import {self.course.id}: DiscussionsConfiguration sync failed: {test_error_message}" + ) + assert any(expected_log in log for log in logs.output) diff --git a/cms/djangoapps/contentstore/tests/test_transcripts_utils.py b/cms/djangoapps/contentstore/tests/test_transcripts_utils.py index 9163ff1ffc75..f9cc996717ee 100644 --- a/cms/djangoapps/contentstore/tests/test_transcripts_utils.py +++ b/cms/djangoapps/contentstore/tests/test_transcripts_utils.py @@ -1,12 +1,12 @@ """ Tests for transcripts_utils. """ -from contextlib import contextmanager import copy import json import re import tempfile import textwrap import unittest +from contextlib import contextmanager from unittest.mock import patch from uuid import uuid4 @@ -15,19 +15,24 @@ from django.conf import settings from django.test.utils import override_settings from django.utils import translation +from xblocks_contrib.video.exceptions import TranscriptsGenerationException from cms.djangoapps.contentstore.tests.utils import setup_caption_responses from common.djangoapps.student.tests.factories import UserFactory -from xmodule.contentstore.content import StaticContent # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.contentstore.django import contentstore # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.exceptions import NotFoundError # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory, BlockFactory # lint-amnesty, pylint: disable=wrong-import-order -from openedx.core.djangoapps.video_config import transcripts_utils # lint-amnesty, pylint: disable=wrong-import-order -from xblocks_contrib.video.exceptions import TranscriptsGenerationException +from openedx.core.djangoapps.video_config import transcripts_utils # pylint: disable=wrong-import-order +from xmodule.contentstore.content import StaticContent # pylint: disable=wrong-import-order +from xmodule.contentstore.django import contentstore # pylint: disable=wrong-import-order +from xmodule.exceptions import NotFoundError # pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + SharedModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import ( # pylint: disable=wrong-import-order + BlockFactory, + CourseFactory, +) TEST_DATA_CONTENTSTORE = copy.deepcopy(settings.CONTENTSTORE) -TEST_DATA_CONTENTSTORE['DOC_STORE_CONFIG']['db'] = 'test_xcontent_%s' % uuid4().hex +TEST_DATA_CONTENTSTORE['DOC_STORE_CONFIG']['db'] = 'test_xcontent_%s' % uuid4().hex # noqa: UP031 class TestGenerateSubs(unittest.TestCase): @@ -49,7 +54,7 @@ def setUp(self): def test_generate_subs_increase_speed(self): subs = transcripts_utils.generate_subs(2, 1, self.source_subs) - self.assertDictEqual( + self.assertDictEqual( # noqa: PT009 subs, { 'start': [200, 400, 480, 780, 2000], @@ -60,7 +65,7 @@ def test_generate_subs_increase_speed(self): def test_generate_subs_decrease_speed_1(self): subs = transcripts_utils.generate_subs(0.5, 1, self.source_subs) - self.assertDictEqual( + self.assertDictEqual( # noqa: PT009 subs, { 'start': [50, 100, 120, 195, 500], @@ -72,7 +77,7 @@ def test_generate_subs_decrease_speed_1(self): def test_generate_subs_decrease_speed_2(self): """Test for correct devision during `generate_subs` process.""" subs = transcripts_utils.generate_subs(1, 2, self.source_subs) - self.assertDictEqual( + self.assertDictEqual( # noqa: PT009 subs, { 'start': [50, 100, 120, 195, 500], @@ -143,7 +148,7 @@ def setUp(self): self.clear_subs_content() def test_save_subs_to_store(self): - with self.assertRaises(NotFoundError): + with self.assertRaises(NotFoundError): # noqa: PT027 contentstore().find(self.content_location) result_location = transcripts_utils.save_subs_to_store( @@ -151,23 +156,23 @@ def test_save_subs_to_store(self): self.subs_id, self.course) - self.assertTrue(contentstore().find(self.content_location)) - self.assertEqual(result_location, self.content_location) + self.assertTrue(contentstore().find(self.content_location)) # noqa: PT009 + self.assertEqual(result_location, self.content_location) # noqa: PT009 def test_save_unjsonable_subs_to_store(self): """ Ensures that subs, that can't be dumped, can't be found later. """ - with self.assertRaises(NotFoundError): + with self.assertRaises(NotFoundError): # noqa: PT027 contentstore().find(self.content_location_unjsonable) - with self.assertRaises(TypeError): + with self.assertRaises(TypeError): # noqa: PT027 transcripts_utils.save_subs_to_store( self.unjsonable_subs, self.unjsonable_subs_id, self.course) - with self.assertRaises(NotFoundError): + with self.assertRaises(NotFoundError): # noqa: PT027 contentstore().find(self.content_location_unjsonable) @@ -181,7 +186,7 @@ class TestYoutubeSubsBase(SharedModuleStoreTestCase): def setUpClass(cls): super().setUpClass() cls.course = CourseFactory.create( - org=cls.org, number=cls.number, display_name=cls.display_name) # lint-amnesty, pylint: disable=no-member + org=cls.org, number=cls.number, display_name=cls.display_name) # pylint: disable=no-member @override_settings(CONTENTSTORE=TEST_DATA_CONTENTSTORE) @@ -233,11 +238,11 @@ def test_success_downloading_subs(self): setup_caption_responses(mock_get, language_code, caption_response_string) transcripts_utils.download_youtube_subs(good_youtube_sub, self.course, settings) - self.assertEqual(2, len(mock_get.mock_calls)) + self.assertEqual(2, len(mock_get.mock_calls)) # noqa: PT009 args, kwargs = mock_get.call_args_list[0] - self.assertEqual(args[0], 'https://www.youtube.com/watch?v=good_id_2') + self.assertEqual(args[0], 'https://www.youtube.com/watch?v=good_id_2') # noqa: PT009 args, kwargs = mock_get.call_args_list[1] - self.assertTrue(re.match(r"^https://www\.youtube\.com/api/timedtext.*", args[0])) + self.assertTrue(re.match(r"^https://www\.youtube\.com/api/timedtext.*", args[0])) # noqa: PT009 def test_subs_for_html5_vid_with_periods(self): """ @@ -246,11 +251,11 @@ def test_subs_for_html5_vid_with_periods(self): incorrect subs name parsing """ html5_ids = transcripts_utils.get_html5_ids(['foo.mp4', 'foo.1.bar.mp4', 'foo/bar/baz.1.4.mp4', 'foo']) - self.assertEqual(4, len(html5_ids)) - self.assertEqual(html5_ids[0], 'foo') - self.assertEqual(html5_ids[1], 'foo.1.bar') - self.assertEqual(html5_ids[2], 'baz.1.4') - self.assertEqual(html5_ids[3], 'foo') + self.assertEqual(4, len(html5_ids)) # noqa: PT009 + self.assertEqual(html5_ids[0], 'foo') # noqa: PT009 + self.assertEqual(html5_ids[1], 'foo.1.bar') # noqa: PT009 + self.assertEqual(html5_ids[2], 'baz.1.4') # noqa: PT009 + self.assertEqual(html5_ids[3], 'foo') # noqa: PT009 @patch('openedx.core.djangoapps.video_config.transcripts_utils.requests.get') def test_fail_downloading_subs(self, mock_get): @@ -261,7 +266,7 @@ def test_fail_downloading_subs(self, mock_get): bad_youtube_sub = 'BAD_YOUTUBE_ID2' self.clear_sub_content(bad_youtube_sub) - with self.assertRaises(transcripts_utils.GetTranscriptsFromYouTubeException): + with self.assertRaises(transcripts_utils.GetTranscriptsFromYouTubeException): # noqa: PT027 transcripts_utils.download_youtube_subs(bad_youtube_sub, self.course, settings) def test_success_downloading_chinese_transcripts(self): @@ -278,17 +283,17 @@ def test_success_downloading_chinese_transcripts(self): transcripts_utils.download_youtube_subs(good_youtube_sub, self.course, settings) # Check assets status after importing subtitles. - for subs_id in good_youtube_subs.values(): # lint-amnesty, pylint: disable=undefined-variable + for subs_id in good_youtube_subs.values(): # pylint: disable=undefined-variable # noqa: F821 filename = f'subs_{subs_id}.srt.sjson' content_location = StaticContent.compute_location( self.course.id, filename ) - self.assertTrue(contentstore().find(content_location)) + self.assertTrue(contentstore().find(content_location)) # noqa: PT009 self.clear_sub_content(good_youtube_sub) -class TestGenerateSubsFromSource(TestDownloadYoutubeSubs): # lint-amnesty, pylint: disable=test-inherits-tests +class TestGenerateSubsFromSource(TestDownloadYoutubeSubs): # pylint: disable=test-inherits-tests """Tests for `generate_subs_from_source` function.""" def test_success_generating_subs(self): @@ -318,7 +323,7 @@ def test_success_generating_subs(self): content_location = StaticContent.compute_location( self.course.id, filename ) - self.assertTrue(contentstore().find(content_location)) + self.assertTrue(contentstore().find(content_location)) # noqa: PT009 self.clear_subs_content(youtube_subs) @@ -339,10 +344,10 @@ def test_fail_bad_subs_type(self): At the left we can see... """) - with self.assertRaises(TranscriptsGenerationException) as cm: + with self.assertRaises(TranscriptsGenerationException) as cm: # noqa: PT027 transcripts_utils.generate_subs_from_source(youtube_subs, 'BAD_FORMAT', srt_filedata, self.course) exception_message = str(cm.exception) - self.assertEqual(exception_message, "We support only SubRip (*.srt) transcripts format.") + self.assertEqual(exception_message, "We support only SubRip (*.srt) transcripts format.") # noqa: PT009 def test_fail_bad_subs_filedata(self): youtube_subs = { @@ -353,13 +358,13 @@ def test_fail_bad_subs_filedata(self): srt_filedata = """BAD_DATA""" - with self.assertRaises(TranscriptsGenerationException) as cm: + with self.assertRaises(TranscriptsGenerationException) as cm: # noqa: PT027 transcripts_utils.generate_subs_from_source(youtube_subs, 'srt', srt_filedata, self.course) exception_message = str(cm.exception) - self.assertEqual(exception_message, "Something wrong with SubRip transcripts file during parsing.") + self.assertEqual(exception_message, "Something wrong with SubRip transcripts file during parsing.") # noqa: PT009 # pylint: disable=line-too-long -class TestGenerateSrtFromSjson(TestDownloadYoutubeSubs): # lint-amnesty, pylint: disable=test-inherits-tests +class TestGenerateSrtFromSjson(TestDownloadYoutubeSubs): # pylint: disable=test-inherits-tests """Tests for `generate_srt_from_sjson` function.""" def test_success_generating_subs(self): @@ -375,7 +380,7 @@ def test_success_generating_subs(self): ] } srt_subs = transcripts_utils.generate_srt_from_sjson(sjson_subs, 1) - self.assertTrue(srt_subs) + self.assertTrue(srt_subs) # noqa: PT009 expected_subs = [ '00:00:00,100 --> 00:00:00,200\nsubs #1', '00:00:00,200 --> 00:00:00,240\nsubs #2', @@ -385,7 +390,7 @@ def test_success_generating_subs(self): ] for sub in expected_subs: - self.assertIn(sub, srt_subs) + self.assertIn(sub, srt_subs) # noqa: PT009 def test_success_generating_subs_speed_up(self): sjson_subs = { @@ -400,7 +405,7 @@ def test_success_generating_subs_speed_up(self): ] } srt_subs = transcripts_utils.generate_srt_from_sjson(sjson_subs, 0.5) - self.assertTrue(srt_subs) + self.assertTrue(srt_subs) # noqa: PT009 expected_subs = [ '00:00:00,050 --> 00:00:00,100\nsubs #1', '00:00:00,100 --> 00:00:00,120\nsubs #2', @@ -409,7 +414,7 @@ def test_success_generating_subs_speed_up(self): '00:00:27,000 --> 00:00:39,200\nsubs #5', ] for sub in expected_subs: - self.assertIn(sub, srt_subs) + self.assertIn(sub, srt_subs) # noqa: PT009 def test_success_generating_subs_speed_down(self): sjson_subs = { @@ -424,7 +429,7 @@ def test_success_generating_subs_speed_down(self): ] } srt_subs = transcripts_utils.generate_srt_from_sjson(sjson_subs, 2) - self.assertTrue(srt_subs) + self.assertTrue(srt_subs) # noqa: PT009 expected_subs = [ '00:00:00,200 --> 00:00:00,400\nsubs #1', @@ -434,7 +439,7 @@ def test_success_generating_subs_speed_down(self): '00:01:48,000 --> 00:02:36,800\nsubs #5', ] for sub in expected_subs: - self.assertIn(sub, srt_subs) + self.assertIn(sub, srt_subs) # noqa: PT009 def test_fail_generating_subs(self): sjson_subs = { @@ -446,7 +451,7 @@ def test_fail_generating_subs(self): ] } srt_subs = transcripts_utils.generate_srt_from_sjson(sjson_subs, 1) - self.assertFalse(srt_subs) + self.assertFalse(srt_subs) # noqa: PT009 class TestYoutubeTranscripts(unittest.TestCase): @@ -458,7 +463,7 @@ def test_youtube_bad_status_code(self, mock_get): track_status_code = 404 setup_caption_responses(mock_get, 'en', 'test', track_status_code) youtube_id = 'bad_youtube_id' - with self.assertRaises(transcripts_utils.GetTranscriptsFromYouTubeException): + with self.assertRaises(transcripts_utils.GetTranscriptsFromYouTubeException): # noqa: PT027 link = transcripts_utils.get_transcript_links_from_youtube(youtube_id, settings, translation) transcripts_utils.get_transcript_from_youtube(link, youtube_id, translation) @@ -466,7 +471,7 @@ def test_youtube_bad_status_code(self, mock_get): def test_youtube_empty_text(self, mock_get): setup_caption_responses(mock_get, 'en', '') youtube_id = 'bad_youtube_id' - with self.assertRaises(transcripts_utils.GetTranscriptsFromYouTubeException): + with self.assertRaises(transcripts_utils.GetTranscriptsFromYouTubeException): # noqa: PT027 link = transcripts_utils.get_transcript_links_from_youtube(youtube_id, settings, translation) transcripts_utils.get_transcript_from_youtube(link, youtube_id, translation) @@ -491,12 +496,12 @@ def test_youtube_good_result(self): link = transcripts_utils.get_transcript_links_from_youtube(youtube_id, settings, translation) transcripts = transcripts_utils.get_transcript_from_youtube(link['en'], youtube_id, translation) - self.assertEqual(transcripts, expected_transcripts) - self.assertEqual(2, len(mock_get.mock_calls)) + self.assertEqual(transcripts, expected_transcripts) # noqa: PT009 + self.assertEqual(2, len(mock_get.mock_calls)) # noqa: PT009 args, kwargs = mock_get.call_args_list[0] - self.assertEqual(args[0], f'https://www.youtube.com/watch?v={youtube_id}') + self.assertEqual(args[0], f'https://www.youtube.com/watch?v={youtube_id}') # noqa: PT009 args, kwargs = mock_get.call_args_list[1] - self.assertTrue(re.match(r"^https://www\.youtube\.com/api/timedtext.*", args[0])) + self.assertTrue(re.match(r"^https://www\.youtube\.com/api/timedtext.*", args[0])) # noqa: PT009 class TestTranscript(unittest.TestCase): @@ -542,7 +547,7 @@ def test_convert_srt_to_txt(self): """ expected = self.txt_transcript actual = transcripts_utils.Transcript.convert(self.srt_transcript, 'srt', 'txt') - self.assertEqual(actual, expected) + self.assertEqual(actual, expected) # noqa: PT009 def test_convert_srt_to_srt(self): """ @@ -550,7 +555,7 @@ def test_convert_srt_to_srt(self): """ expected = self.srt_transcript actual = transcripts_utils.Transcript.convert(self.srt_transcript, 'srt', 'srt') - self.assertEqual(actual, expected) + self.assertEqual(actual, expected) # noqa: PT009 def test_convert_sjson_to_txt(self): """ @@ -558,7 +563,7 @@ def test_convert_sjson_to_txt(self): """ expected = self.txt_transcript actual = transcripts_utils.Transcript.convert(self.sjson_transcript, 'sjson', 'txt') - self.assertEqual(actual, expected) + self.assertEqual(actual, expected) # noqa: PT009 def test_convert_sjson_to_srt(self): """ @@ -566,7 +571,7 @@ def test_convert_sjson_to_srt(self): """ expected = self.srt_transcript actual = transcripts_utils.Transcript.convert(self.sjson_transcript, 'sjson', 'srt') - self.assertEqual(actual, expected) + self.assertEqual(actual, expected) # noqa: PT009 def test_convert_srt_to_sjson(self): """ @@ -574,7 +579,7 @@ def test_convert_srt_to_sjson(self): """ expected = self.sjson_transcript actual = transcripts_utils.Transcript.convert(self.srt_transcript, 'srt', 'sjson') - self.assertDictEqual(json.loads(actual), json.loads(expected)) + self.assertDictEqual(json.loads(actual), json.loads(expected)) # noqa: PT009 def test_convert_invalid_srt_to_sjson(self): """ @@ -582,7 +587,7 @@ def test_convert_invalid_srt_to_sjson(self): to convert invalid srt transcript to sjson. """ invalid_srt_transcript = 'invalid SubRip file content' - with self.assertRaises(TranscriptsGenerationException): + with self.assertRaises(TranscriptsGenerationException): # noqa: PT027 transcripts_utils.Transcript.convert(invalid_srt_transcript, 'srt', 'sjson') def test_convert_invalid_invalid_sjson_to_srt(self): @@ -595,10 +600,10 @@ def test_dummy_non_existent_transcript(self): """ Test `Transcript.asset` raises `NotFoundError` for dummy non-existent transcript. """ - with self.assertRaises(NotFoundError): + with self.assertRaises(NotFoundError): # noqa: PT027 transcripts_utils.Transcript.asset(None, transcripts_utils.NON_EXISTENT_TRANSCRIPT) - with self.assertRaises(NotFoundError): + with self.assertRaises(NotFoundError): # noqa: PT027 transcripts_utils.Transcript.asset(None, None, filename=transcripts_utils.NON_EXISTENT_TRANSCRIPT) def test_latin1(self): @@ -644,9 +649,9 @@ class TestSubsFilename(unittest.TestCase): def test_unicode(self): name = transcripts_utils.subs_filename("˙∆©ƒƒƒ") - self.assertEqual(name, 'subs_˙∆©ƒƒƒ.srt.sjson') + self.assertEqual(name, 'subs_˙∆©ƒƒƒ.srt.sjson') # noqa: PT009 name = transcripts_utils.subs_filename("˙∆©ƒƒƒ", 'uk') - self.assertEqual(name, 'uk_subs_˙∆©ƒƒƒ.srt.sjson') + self.assertEqual(name, 'uk_subs_˙∆©ƒƒƒ.srt.sjson') # noqa: PT009 @ddt.ddt @@ -686,7 +691,7 @@ def test_get_video_ids_info(self, edx_video_id, youtube_id_1_0, html5_sources, e Verify that `get_video_ids_info` works as expected. """ actual_result = transcripts_utils.get_video_ids_info(edx_video_id, youtube_id_1_0, html5_sources) - self.assertEqual(actual_result, expected_result) + self.assertEqual(actual_result, expected_result) # noqa: PT009 @ddt.ddt @@ -763,7 +768,7 @@ def create_srt_file(self, content): """ Create srt file. """ - srt_file = tempfile.NamedTemporaryFile(suffix=".srt") # lint-amnesty, pylint: disable=consider-using-with + srt_file = tempfile.NamedTemporaryFile(suffix=".srt") # pylint: disable=consider-using-with srt_file.content_type = transcripts_utils.Transcript.SRT srt_file.write(content) srt_file.seek(0) @@ -796,7 +801,7 @@ def test_get_transcript_not_found(self, lang): """ Verify that `NotFoundError` exception is raised when transcript is not found in both the content store and val. """ - with self.assertRaises(NotFoundError): + with self.assertRaises(NotFoundError): # noqa: PT027 transcripts_utils.get_transcript( self.video, lang=lang @@ -864,9 +869,9 @@ def test_get_transcript_from_contentstore( language ) - self.assertEqual(content, self.subs[language]) - self.assertEqual(file_name, expected_filename) - self.assertEqual(mimetype, self.srt_mime_type) + self.assertEqual(content, self.subs[language]) # noqa: PT009 + self.assertEqual(file_name, expected_filename) # noqa: PT009 + self.assertEqual(mimetype, self.srt_mime_type) # noqa: PT009 def test_get_transcript_from_content_store_for_ur(self): """ @@ -880,9 +885,9 @@ def test_get_transcript_from_content_store_for_ur(self): output_format=transcripts_utils.Transcript.SJSON ) - self.assertEqual(json.loads(content), self.subs_sjson) - self.assertEqual(filename, 'ur_video_101.sjson') - self.assertEqual(mimetype, self.sjson_mime_type) + self.assertEqual(json.loads(content), self.subs_sjson) # noqa: PT009 + self.assertEqual(filename, 'ur_video_101.sjson') # noqa: PT009 + self.assertEqual(mimetype, self.sjson_mime_type) # noqa: PT009 @patch('openedx.core.djangoapps.video_config.transcripts_utils.get_video_transcript_content') def test_get_transcript_from_val(self, mock_get_video_transcript_content): @@ -897,15 +902,15 @@ def test_get_transcript_from_val(self, mock_get_video_transcript_content): content, filename, mimetype = transcripts_utils.get_transcript( self.video, ) - self.assertEqual(content, self.subs_srt) - self.assertEqual(filename, 'edx.srt') - self.assertEqual(mimetype, self.srt_mime_type) + self.assertEqual(content, self.subs_srt) # noqa: PT009 + self.assertEqual(filename, 'edx.srt') # noqa: PT009 + self.assertEqual(mimetype, self.srt_mime_type) # noqa: PT009 def test_get_transcript_invalid_format(self): """ Verify that `get_transcript` raises correct exception if transcript format is invalid. """ - with self.assertRaises(NotFoundError) as invalid_format_exception: + with self.assertRaises(NotFoundError) as invalid_format_exception: # noqa: PT027 transcripts_utils.get_transcript( self.video, 'ur', @@ -913,7 +918,7 @@ def test_get_transcript_invalid_format(self): ) exception_message = str(invalid_format_exception.exception) - self.assertEqual(exception_message, 'Invalid transcript format `mpeg`') + self.assertEqual(exception_message, 'Invalid transcript format `mpeg`') # noqa: PT009 def test_get_transcript_no_content(self): """ @@ -922,14 +927,14 @@ def test_get_transcript_no_content(self): self.upload_file(self.create_srt_file(b''), self.video.location, 'ur_video_101.srt') self.create_transcript('', 'ur', 'ur_video_101.srt') - with self.assertRaises(NotFoundError) as no_content_exception: + with self.assertRaises(NotFoundError) as no_content_exception: # noqa: PT027 transcripts_utils.get_transcript( self.video, 'ur' ) exception_message = str(no_content_exception.exception) - self.assertEqual(exception_message, 'No transcript content') + self.assertEqual(exception_message, 'No transcript content') # noqa: PT009 def test_get_transcript_no_en_transcript(self): """ @@ -937,14 +942,14 @@ def test_get_transcript_no_en_transcript(self): """ self.video.youtube_id_1_0 = '' self.store.update_item(self.video, self.user.id) - with self.assertRaises(NotFoundError) as no_en_transcript_exception: + with self.assertRaises(NotFoundError) as no_en_transcript_exception: # noqa: PT027 transcripts_utils.get_transcript( self.video, 'en' ) exception_message = str(no_en_transcript_exception.exception) - self.assertEqual(exception_message, 'No transcript for `en` language') + self.assertEqual(exception_message, 'No transcript for `en` language') # noqa: PT009 @patch('openedx.core.djangoapps.video_config.transcripts_utils.edxval_api.get_video_transcript_data') def test_get_transcript_incorrect_json_(self, mock_get_video_transcript_data): @@ -969,7 +974,7 @@ def test_get_transcript_val_exceptions(self, exception_to_raise, mock_Transcript transcripts_info = self.video.get_transcripts_info() lang = self.video.get_default_transcript_language(transcripts_info) edx_video_id = transcripts_utils.clean_video_id(self.video.edx_video_id) - with self.assertRaises(NotFoundError): + with self.assertRaises(NotFoundError): # noqa: PT027 transcripts_utils.get_transcript_from_val( edx_video_id, lang=lang, @@ -988,7 +993,7 @@ def test_get_transcript_content_store_exceptions(self, exception_to_raise, mock_ mock_Transcript.asset.side_effect = exception_to_raise transcripts_info = self.video.get_transcripts_info() lang = self.video.get_default_transcript_language(transcripts_info) - with self.assertRaises(NotFoundError): + with self.assertRaises(NotFoundError): # noqa: PT027 transcripts_utils.get_transcript_from_contentstore( self.video, language=lang, @@ -1016,7 +1021,7 @@ def test_resolve_lang(self, lang, expected): Test that resolve_language_code_to_transcript_code will successfully match language codes of different cases, and return None if it isn't found """ - self.assertEqual( + self.assertEqual( # noqa: PT009 transcripts_utils.resolve_language_code_to_transcript_code(self.TEST_TRANSCRIPTS, lang), expected ) @@ -1053,7 +1058,7 @@ def mock_django_get_language_info(self, side_effect=None): def test_language_in_languages(self): """ If language is found in LANGUAGE_DICT that value should be returned """ with override_settings(LANGUAGE_DICT=self.TEST_LANGUAGE_DICT): - self.assertEqual( + self.assertEqual( # noqa: PT009 transcripts_utils.get_endonym_or_label(self.LANG_CODE), self.LANG_ENTONYM ) @@ -1065,7 +1070,7 @@ def test_language_in_django_lang_info(self): """ with override_settings(LANGUAGE_DICT={}): with self.mock_django_get_language_info() as mock_get_language_info: - self.assertEqual( + self.assertEqual( # noqa: PT009 transcripts_utils.get_endonym_or_label(self.LANG_CODE), mock_get_language_info.return_value['name_local'] ) @@ -1079,7 +1084,7 @@ def test_language_exact_in_all_languages(self): with self.mock_django_get_language_info(side_effect=KeyError): with override_settings(ALL_LANGUAGES=self.TEST_ALL_LANGUAGES): label = transcripts_utils.get_endonym_or_label(self.LANG_CODE) - self.assertEqual(label, self.LANG_LABEL) + self.assertEqual(label, self.LANG_LABEL) # noqa: PT009 def test_language_generic_in_all_languages(self): """ @@ -1096,7 +1101,7 @@ def test_language_generic_in_all_languages(self): with self.mock_django_get_language_info(side_effect=KeyError): with override_settings(ALL_LANGUAGES=all_languages): label = transcripts_utils.get_endonym_or_label(self.LANG_CODE) - self.assertEqual(label, self.GENERIC_LABEL) + self.assertEqual(label, self.GENERIC_LABEL) # noqa: PT009 def test_language_not_found_anywhere(self): """ @@ -1106,5 +1111,5 @@ def test_language_not_found_anywhere(self): with override_settings(LANGUAGE_DICT={}): with self.mock_django_get_language_info(side_effect=KeyError): with override_settings(ALL_LANGUAGES=all_languages): - with self.assertRaises(NotFoundError): + with self.assertRaises(NotFoundError): # noqa: PT027 transcripts_utils.get_endonym_or_label(self.LANG_CODE) diff --git a/cms/djangoapps/contentstore/tests/test_upstream_downstream_links.py b/cms/djangoapps/contentstore/tests/test_upstream_downstream_links.py index 5c3ba8386480..f649299d560b 100644 --- a/cms/djangoapps/contentstore/tests/test_upstream_downstream_links.py +++ b/cms/djangoapps/contentstore/tests/test_upstream_downstream_links.py @@ -10,14 +10,14 @@ from django.test import TestCase from opaque_keys.edx.keys import CourseKey from opaque_keys.edx.locator import LibraryContainerLocator, LibraryUsageLocatorV2 -from openedx_events.tests.utils import OpenEdxEventsTestMixin +from openedx_events.testing import OpenEdxEventsTestMixin from common.djangoapps.student.tests.factories import UserFactory from openedx.core.djangolib.testing.utils import skip_unless_cms -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase, ImmediateOnCommitMixin +from xmodule.modulestore.tests.django_utils import ImmediateOnCommitMixin, ModuleStoreTestCase from xmodule.modulestore.tests.factories import BlockFactory, CourseFactory -from ..models import ContainerLink, LearningContextLinksStatus, LearningContextLinksStatusChoices, ComponentLink +from ..models import ComponentLink, ContainerLink, LearningContextLinksStatus, LearningContextLinksStatusChoices class BaseUpstreamLinksHelpers(TestCase): @@ -108,7 +108,7 @@ def _compare_links(self, course_key, expected_component_links, expected_containe 'version_synced', 'version_declined', )) - self.assertListEqual(links, expected_component_links) + self.assertListEqual(links, expected_component_links) # noqa: PT009 container_links = list(ContainerLink.objects.filter(downstream_context_key=course_key).values( 'upstream_container', 'upstream_container_key', @@ -118,7 +118,7 @@ def _compare_links(self, course_key, expected_component_links, expected_containe 'version_synced', 'version_declined', )) - self.assertListEqual(container_links, expected_container_links) + self.assertListEqual(container_links, expected_container_links) # noqa: PT009 @skip_unless_cms @@ -167,9 +167,9 @@ def test_call_with_invalid_args(self): """ Test command with invalid args. """ - with self.assertRaisesRegex(CommandError, 'Either --course or --all argument'): + with self.assertRaisesRegex(CommandError, 'Either --course or --all argument'): # noqa: PT027 self.call_command() - with self.assertRaisesRegex(CommandError, 'Only one of --course or --all argument'): + with self.assertRaisesRegex(CommandError, 'Only one of --course or --all argument'): # noqa: PT027 self.call_command('--all', '--course', str(self.course_key_1)) def test_call_for_single_course(self): @@ -246,7 +246,7 @@ def test_call_for_invalid_course(self): course_key = "invalid-course" with self.assertLogs(level="ERROR") as ctx: self.call_command('--course', course_key) - self.assertEqual( + self.assertEqual( # noqa: PT009 f'Invalid course key: {course_key}, skipping..', ctx.records[0].getMessage() ) @@ -258,7 +258,7 @@ def test_call_for_nonexistent_course(self): course_key = "course-v1:unix+ux1+2024_T2" with self.assertLogs(level="ERROR") as ctx: self.call_command('--course', course_key) - self.assertIn( + self.assertIn( # noqa: PT009 f'Could not find items for given course: {course_key}', ctx.records[0].getMessage() ) diff --git a/cms/djangoapps/contentstore/tests/test_users_default_role.py b/cms/djangoapps/contentstore/tests/test_users_default_role.py index 1abf0a0ec697..2f05801e5010 100644 --- a/cms/djangoapps/contentstore/tests/test_users_default_role.py +++ b/cms/djangoapps/contentstore/tests/test_users_default_role.py @@ -5,12 +5,11 @@ from unittest import skip -from xmodule.modulestore.tests.django_utils import TEST_DATA_SPLIT_MODULESTORE, ModuleStoreTestCase - from cms.djangoapps.contentstore.tests.utils import AjaxEnabledTestClient from cms.djangoapps.contentstore.utils import delete_course, reverse_url from common.djangoapps.student.models import CourseEnrollment from common.djangoapps.student.tests.factories import UserFactory +from xmodule.modulestore.tests.django_utils import TEST_DATA_SPLIT_MODULESTORE, ModuleStoreTestCase class TestUsersDefaultRole(ModuleStoreTestCase): @@ -61,18 +60,18 @@ def test_user_forum_default_role_on_course_deletion(self): enrolled even the course is deleted and keeps its "Student" forum role for that course """ # check that user has enrollment for this course - self.assertTrue(CourseEnrollment.is_enrolled(self.user, self.course_key)) + self.assertTrue(CourseEnrollment.is_enrolled(self.user, self.course_key)) # noqa: PT009 # check that user has his default "Student" forum role for this course - self.assertTrue(self.user.roles.filter(name="Student", course_id=self.course_key)) + self.assertTrue(self.user.roles.filter(name="Student", course_id=self.course_key)) # noqa: PT009 delete_course(self.course_key, self.user.id) # check that user's enrollment for this course is not deleted - self.assertTrue(CourseEnrollment.is_enrolled(self.user, self.course_key)) + self.assertTrue(CourseEnrollment.is_enrolled(self.user, self.course_key)) # noqa: PT009 # check that user has forum role for this course even after deleting it - self.assertTrue(self.user.roles.filter(name="Student", course_id=self.course_key)) + self.assertTrue(self.user.roles.filter(name="Student", course_id=self.course_key)) # noqa: PT009 def test_user_role_on_course_recreate(self): """ @@ -80,19 +79,19 @@ def test_user_role_on_course_recreate(self): forum role "Student" for that course """ # check that user has enrollment and his default "Student" forum role for this course - self.assertTrue(CourseEnrollment.is_enrolled(self.user, self.course_key)) - self.assertTrue(self.user.roles.filter(name="Student", course_id=self.course_key)) + self.assertTrue(CourseEnrollment.is_enrolled(self.user, self.course_key)) # noqa: PT009 + self.assertTrue(self.user.roles.filter(name="Student", course_id=self.course_key)) # noqa: PT009 # delete this course and recreate this course with same user delete_course(self.course_key, self.user.id) resp = self._create_course_with_given_location(self.course_key) - self.assertEqual(resp.status_code, 200) + self.assertEqual(resp.status_code, 200) # noqa: PT009 # check that user has his enrollment for this course - self.assertTrue(CourseEnrollment.is_enrolled(self.user, self.course_key)) + self.assertTrue(CourseEnrollment.is_enrolled(self.user, self.course_key)) # noqa: PT009 # check that user has his default "Student" forum role for this course - self.assertTrue(self.user.roles.filter(name="Student", course_id=self.course_key)) + self.assertTrue(self.user.roles.filter(name="Student", course_id=self.course_key)) # noqa: PT009 @skip("OldMongo Deprecation") # Issue with case-insensitive course keys @@ -102,17 +101,17 @@ def test_user_role_on_course_recreate_with_change_name_case(self): his default forum role "Student" for that course """ # check that user has enrollment and his default "Student" forum role for this course - self.assertTrue(CourseEnrollment.is_enrolled(self.user, self.course_key)) + self.assertTrue(CourseEnrollment.is_enrolled(self.user, self.course_key)) # noqa: PT009 # delete this course and recreate this course with same user delete_course(self.course_key, self.user.id) # now create same course with different name case ('uppercase') new_course_key = self.course_key.replace(course=self.course_key.course.upper()) resp = self._create_course_with_given_location(new_course_key) - self.assertEqual(resp.status_code, 200) + self.assertEqual(resp.status_code, 200) # noqa: PT009 # check that user has his default "Student" forum role again for this course (with changed name case) - self.assertTrue( + self.assertTrue( # noqa: PT009 self.user.roles.filter(name="Student", course_id=new_course_key) ) diff --git a/cms/djangoapps/contentstore/tests/test_utils.py b/cms/djangoapps/contentstore/tests/test_utils.py index c529410cd110..e04cabd226a4 100644 --- a/cms/djangoapps/contentstore/tests/test_utils.py +++ b/cms/djangoapps/contentstore/tests/test_utils.py @@ -9,10 +9,9 @@ from django.conf import settings from django.test import TestCase from django.test.utils import override_settings -from edx_toggles.toggles.testutils import override_waffle_flag from opaque_keys.edx.keys import CourseKey from opaque_keys.edx.locator import CourseLocator, LibraryLocator -from openedx_events.tests.utils import OpenEdxEventsTestMixin +from openedx_events.testing import OpenEdxEventsTestMixin from path import Path as path from pytz import UTC from rest_framework import status @@ -24,20 +23,16 @@ from cms.djangoapps.contentstore.utils import send_course_update_notification from common.djangoapps.student.models import CourseEnrollment from common.djangoapps.student.tests.factories import GlobalStaffFactory, InstructorFactory, UserFactory -from openedx.core.djangoapps.notifications.config.waffle import ENABLE_NOTIFICATIONS from openedx.core.djangoapps.notifications.models import Notification from openedx.core.djangoapps.site_configuration.tests.test_util import with_site_configuration_context -from xmodule.modulestore import ModuleStoreEnum # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.django_utils import ( # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore import ModuleStoreEnum # pylint: disable=wrong-import-order +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( # pylint: disable=wrong-import-order TEST_DATA_SPLIT_MODULESTORE, ModuleStoreTestCase, SharedModuleStoreTestCase, ) -from xmodule.modulestore.tests.factories import ( - BlockFactory, - CourseFactory, -) +from xmodule.modulestore.tests.factories import BlockFactory, CourseFactory from xmodule.partitions.partitions import Group, UserPartition @@ -49,12 +44,12 @@ def lms_link_test(self): course_key = CourseLocator('mitX', '101', 'test') location = course_key.make_usage_key('vertical', 'contacting_us') link = utils.get_lms_link_for_item(location, False) - self.assertEqual(link, "//localhost:8000/courses/course-v1:mitX+101+test/jump_to/block-v1:mitX+101+test+type" + self.assertEqual(link, "//localhost:8000/courses/course-v1:mitX+101+test/jump_to/block-v1:mitX+101+test+type" # noqa: PT009 # pylint: disable=line-too-long "@vertical+block@contacting_us") # test preview link = utils.get_lms_link_for_item(location, True) - self.assertEqual( + self.assertEqual( # noqa: PT009 link, "//preview.localhost/courses/course-v1:mitX+101+test/jump_to/block-v1:mitX+101+test+type@vertical+block" "@contacting_us " @@ -63,27 +58,27 @@ def lms_link_test(self): # now test with the course' location location = course_key.make_usage_key('course', 'test') link = utils.get_lms_link_for_item(location) - self.assertEqual(link, "//localhost:8000/courses/course-v1:mitX+101+test/jump_to/block-v1:mitX+101+test+type" + self.assertEqual(link, "//localhost:8000/courses/course-v1:mitX+101+test/jump_to/block-v1:mitX+101+test+type" # noqa: PT009 # pylint: disable=line-too-long "@course+block@test") def lms_link_for_certificate_web_view_test(self): """ Tests get_lms_link_for_certificate_web_view. """ course_key = CourseLocator('mitX', '101', 'test') - dummy_user = ModuleStoreEnum.UserID.test + dummy_user = ModuleStoreEnum.UserID.test # noqa: F841 mode = 'professional' - self.assertEqual( + self.assertEqual( # noqa: PT009 utils.get_lms_link_for_certificate_web_view(course_key, mode), - "//localhost:8000/certificates/course/{course_key}?preview={mode}".format( + "//localhost:8000/certificates/course/{course_key}?preview={mode}".format( # noqa: UP032 course_key=course_key, mode=mode ) ) with with_site_configuration_context(configuration={"course_org_filter": "mitX", "LMS_BASE": "dummyhost:8000"}): - self.assertEqual( + self.assertEqual( # noqa: PT009 utils.get_lms_link_for_certificate_web_view(course_key, mode), - "//dummyhost:8000/certificates/course/{course_key}?preview={mode}".format( + "//dummyhost:8000/certificates/course/{course_key}?preview={mode}".format( # noqa: UP032 course_key=course_key, mode=mode ) @@ -156,7 +151,7 @@ def test_draft_released_xblock(self): vertical.start = self.future modulestore().update_item(vertical, self.dummy_user) - self.assertTrue(utils.is_currently_visible_to_students(vertical)) + self.assertTrue(utils.is_currently_visible_to_students(vertical)) # noqa: PT009 def _test_visible_to_students(self, expected_visible_without_lock, name, start_date, publish=False): """ @@ -164,13 +159,13 @@ def _test_visible_to_students(self, expected_visible_without_lock, name, start_d with and without visible_to_staff_only set. """ no_staff_lock = self._create_xblock_with_start_date(name, start_date, publish, visible_to_staff_only=False) - self.assertEqual(expected_visible_without_lock, utils.is_currently_visible_to_students(no_staff_lock)) + self.assertEqual(expected_visible_without_lock, utils.is_currently_visible_to_students(no_staff_lock)) # noqa: PT009 # pylint: disable=line-too-long # any xblock with visible_to_staff_only set to True should not be visible to students. staff_lock = self._create_xblock_with_start_date( name + "_locked", start_date, publish, visible_to_staff_only=True ) - self.assertFalse(utils.is_currently_visible_to_students(staff_lock)) + self.assertFalse(utils.is_currently_visible_to_students(staff_lock)) # noqa: PT009 def _create_xblock_with_start_date(self, name, start_date, publish=False, visible_to_staff_only=False): """Helper to create an xblock with a start date, optionally publishing it""" @@ -216,8 +211,8 @@ def _update_release_dates(self, chapter_start, sequential_start, vertical_start) def _verify_release_date_source(self, item, expected_source): """Helper to verify that the release date source of a given item matches the expected source""" source = utils.find_release_date_source(item) - self.assertEqual(source.location, expected_source.location) - self.assertEqual(source.start, expected_source.start) + self.assertEqual(source.location, expected_source.location) # noqa: PT009 + self.assertEqual(source.start, expected_source.start) # noqa: PT009 def test_chapter_source_for_vertical(self): """Tests a vertical's release date being set by its chapter""" @@ -285,8 +280,8 @@ class StaffLockSourceTest(StaffLockTest): def _verify_staff_lock_source(self, item, expected_source): """Helper to verify that the staff lock source of a given item matches the expected source""" source = utils.find_staff_lock_source(item) - self.assertEqual(source.location, expected_source.location) - self.assertTrue(source.visible_to_staff_only) + self.assertEqual(source.location, expected_source.location) # noqa: PT009 + self.assertTrue(source.visible_to_staff_only) # noqa: PT009 def test_chapter_source_for_vertical(self): """Tests a vertical's staff lock being set by its chapter""" @@ -311,12 +306,12 @@ def test_vertical_source_for_vertical(self): def test_orphan_has_no_source(self): """Tests that a orphaned xblock has no staff lock source""" - self.assertIsNone(utils.find_staff_lock_source(self.orphan)) + self.assertIsNone(utils.find_staff_lock_source(self.orphan)) # noqa: PT009 def test_no_source_for_vertical(self): """Tests a vertical with no staff lock set anywhere""" self._update_staff_locks(False, False, False) - self.assertIsNone(utils.find_staff_lock_source(self.vertical)) + self.assertIsNone(utils.find_staff_lock_source(self.vertical)) # noqa: PT009 class InheritedStaffLockTest(StaffLockTest): @@ -325,27 +320,27 @@ class InheritedStaffLockTest(StaffLockTest): def test_no_inheritance(self): """Tests that a locked or unlocked vertical with no locked ancestors does not have an inherited lock""" self._update_staff_locks(False, False, False) - self.assertFalse(utils.ancestor_has_staff_lock(self.vertical)) + self.assertFalse(utils.ancestor_has_staff_lock(self.vertical)) # noqa: PT009 self._update_staff_locks(False, False, True) - self.assertFalse(utils.ancestor_has_staff_lock(self.vertical)) + self.assertFalse(utils.ancestor_has_staff_lock(self.vertical)) # noqa: PT009 def test_inheritance_in_locked_section(self): """Tests that a locked or unlocked vertical in a locked section has an inherited lock""" self._update_staff_locks(True, False, False) - self.assertTrue(utils.ancestor_has_staff_lock(self.vertical)) + self.assertTrue(utils.ancestor_has_staff_lock(self.vertical)) # noqa: PT009 self._update_staff_locks(True, False, True) - self.assertTrue(utils.ancestor_has_staff_lock(self.vertical)) + self.assertTrue(utils.ancestor_has_staff_lock(self.vertical)) # noqa: PT009 def test_inheritance_in_locked_subsection(self): """Tests that a locked or unlocked vertical in a locked subsection has an inherited lock""" self._update_staff_locks(False, True, False) - self.assertTrue(utils.ancestor_has_staff_lock(self.vertical)) + self.assertTrue(utils.ancestor_has_staff_lock(self.vertical)) # noqa: PT009 self._update_staff_locks(False, True, True) - self.assertTrue(utils.ancestor_has_staff_lock(self.vertical)) + self.assertTrue(utils.ancestor_has_staff_lock(self.vertical)) # noqa: PT009 def test_no_inheritance_for_orphan(self): """Tests that an orphaned xblock does not inherit staff lock""" - self.assertFalse(utils.ancestor_has_staff_lock(self.orphan)) + self.assertFalse(utils.ancestor_has_staff_lock(self.orphan)) # noqa: PT009 class GroupVisibilityTest(CourseTestCase): @@ -417,8 +412,8 @@ def test_no_visibility_set(self): def verify_all_components_visible_to_all(): """ Verifies when group_access has not been set on anything. """ for item in (self.sequential, self.vertical, self.html, self.problem): - self.assertFalse(utils.has_children_visible_to_specific_partition_groups(item)) - self.assertFalse(utils.is_visible_to_specific_partition_groups(item)) + self.assertFalse(utils.has_children_visible_to_specific_partition_groups(item)) # noqa: PT009 + self.assertFalse(utils.is_visible_to_specific_partition_groups(item)) # noqa: PT009 verify_all_components_visible_to_all() @@ -440,15 +435,15 @@ def test_sequential_and_problem_have_group_access(self): self.problem = self.store.get_item(self.problem.location) # Note that "has_children_visible_to_specific_partition_groups" only checks immediate children. - self.assertFalse(utils.has_children_visible_to_specific_partition_groups(self.sequential)) - self.assertTrue(utils.has_children_visible_to_specific_partition_groups(self.vertical)) - self.assertFalse(utils.has_children_visible_to_specific_partition_groups(self.html)) - self.assertFalse(utils.has_children_visible_to_specific_partition_groups(self.problem)) + self.assertFalse(utils.has_children_visible_to_specific_partition_groups(self.sequential)) # noqa: PT009 + self.assertTrue(utils.has_children_visible_to_specific_partition_groups(self.vertical)) # noqa: PT009 + self.assertFalse(utils.has_children_visible_to_specific_partition_groups(self.html)) # noqa: PT009 + self.assertFalse(utils.has_children_visible_to_specific_partition_groups(self.problem)) # noqa: PT009 - self.assertTrue(utils.is_visible_to_specific_partition_groups(self.sequential)) - self.assertFalse(utils.is_visible_to_specific_partition_groups(self.vertical)) - self.assertFalse(utils.is_visible_to_specific_partition_groups(self.html)) - self.assertTrue(utils.is_visible_to_specific_partition_groups(self.problem)) + self.assertTrue(utils.is_visible_to_specific_partition_groups(self.sequential)) # noqa: PT009 + self.assertFalse(utils.is_visible_to_specific_partition_groups(self.vertical)) # noqa: PT009 + self.assertFalse(utils.is_visible_to_specific_partition_groups(self.html)) # noqa: PT009 + self.assertTrue(utils.is_visible_to_specific_partition_groups(self.problem)) # noqa: PT009 class GetUserPartitionInfoTest(ModuleStoreTestCase): @@ -523,12 +518,12 @@ def test_retrieves_partition_info_with_selected_groups(self): ] } ] - self.assertEqual(self._get_partition_info(schemes=["cohort", "random"]), expected) + self.assertEqual(self._get_partition_info(schemes=["cohort", "random"]), expected) # noqa: PT009 # Update group access and expect that now one group is marked as selected. self._set_group_access({0: [1]}) expected[0]["groups"][1]["selected"] = True - self.assertEqual(self._get_partition_info(schemes=["cohort", "random"]), expected) + self.assertEqual(self._get_partition_info(schemes=["cohort", "random"]), expected) # noqa: PT009 def test_deleted_groups(self): # Select a group that is not defined in the partition @@ -537,8 +532,8 @@ def test_deleted_groups(self): # Expect that the group appears as selected but is marked as deleted partitions = self._get_partition_info() groups = partitions[0]["groups"] - self.assertEqual(len(groups), 3) - self.assertEqual(groups[2], { + self.assertEqual(len(groups), 3) # noqa: PT009 + self.assertEqual(groups[2], { # noqa: PT009 "id": 3, "name": "Deleted Group", "selected": True, @@ -562,8 +557,8 @@ def test_singular_deleted_group(self): self._set_group_access({0: [1]}) partitions = self._get_partition_info() groups = partitions[0]["groups"] - self.assertEqual(len(groups), 1) - self.assertEqual(groups[0], { + self.assertEqual(len(groups), 1) # noqa: PT009 + self.assertEqual(groups[0], { # noqa: PT009 "id": 1, "name": "Deleted Group", "selected": True, @@ -572,8 +567,8 @@ def test_singular_deleted_group(self): def test_filter_by_partition_scheme(self): partitions = self._get_partition_info(schemes=["random"]) - self.assertEqual(len(partitions), 1) - self.assertEqual(partitions[0]["scheme"], "random") + self.assertEqual(len(partitions), 1) # noqa: PT009 + self.assertEqual(partitions[0]["scheme"], "random") # noqa: PT009 def test_exclude_inactive_partitions(self): # Include an inactive verification scheme @@ -602,8 +597,8 @@ def test_exclude_inactive_partitions(self): # Expect that the inactive scheme is excluded from the results partitions = self._get_partition_info(schemes=["cohort", "verification"]) - self.assertEqual(len(partitions), 1) - self.assertEqual(partitions[0]["scheme"], "cohort") + self.assertEqual(len(partitions), 1) # noqa: PT009 + self.assertEqual(partitions[0]["scheme"], "cohort") # noqa: PT009 def test_exclude_partitions_with_no_groups(self): # The cohort partition has no groups defined @@ -628,8 +623,8 @@ def test_exclude_partitions_with_no_groups(self): # Expect that the partition with no groups is excluded from the results partitions = self._get_partition_info(schemes=["cohort", "random"]) - self.assertEqual(len(partitions), 1) - self.assertEqual(partitions[0]["scheme"], "random") + self.assertEqual(len(partitions), 1) # noqa: PT009 + self.assertEqual(partitions[0]["scheme"], "random") # noqa: PT009 def _set_partitions(self, partitions): """Set the user partitions of the course block. """ @@ -666,24 +661,24 @@ def test_with_library_locator(self, mock_olxcleaner_validate): Tests that olx is validation is skipped with library locator. """ library_key = LibraryLocator(org='TestOrg', library='TestProbs') - self.assertTrue(validate_course_olx(library_key, self.toy_course_path, self.status)) - self.assertFalse(mock_olxcleaner_validate.called) + self.assertTrue(validate_course_olx(library_key, self.toy_course_path, self.status)) # noqa: PT009 + self.assertFalse(mock_olxcleaner_validate.called) # noqa: PT009 def test_config_settings_enabled(self, mock_olxcleaner_validate): """ Tests olx validation with config setting is disabled. """ with patch.dict(settings.FEATURES, ENABLE_COURSE_OLX_VALIDATION=False): - self.assertTrue(validate_course_olx(self.course.id, self.toy_course_path, self.status)) - self.assertFalse(mock_olxcleaner_validate.called) + self.assertTrue(validate_course_olx(self.course.id, self.toy_course_path, self.status)) # noqa: PT009 + self.assertFalse(mock_olxcleaner_validate.called) # noqa: PT009 def test_config_settings_disabled(self, mock_olxcleaner_validate): """ Tests olx validation with config setting is enabled. """ with patch.dict(settings.FEATURES, ENABLE_COURSE_OLX_VALIDATION=True): - self.assertTrue(validate_course_olx(self.course.id, self.toy_course_path, self.status)) - self.assertTrue(mock_olxcleaner_validate.called) + self.assertTrue(validate_course_olx(self.course.id, self.toy_course_path, self.status)) # noqa: PT009 + self.assertTrue(mock_olxcleaner_validate.called) # noqa: PT009 def test_exception_during_validation(self, mock_olxcleaner_validate): """ @@ -694,8 +689,8 @@ def test_exception_during_validation(self, mock_olxcleaner_validate): """ mock_olxcleaner_validate.side_effect = Exception with mock.patch(self.LOGGER) as patched_log: - self.assertTrue(validate_course_olx(self.course.id, self.toy_course_path, self.status)) - self.assertTrue(mock_olxcleaner_validate.called) + self.assertTrue(validate_course_olx(self.course.id, self.toy_course_path, self.status)) # noqa: PT009 + self.assertTrue(mock_olxcleaner_validate.called) # noqa: PT009 patched_log.exception.assert_called_once_with( f'Course import {self.course.id}: CourseOlx could not be validated') @@ -709,10 +704,10 @@ def test_no_errors(self, mock_olxcleaner_validate): Mock(errors=[], return_error=Mock(return_value=False)), Mock() ] - self.assertTrue(validate_course_olx(self.course.id, self.toy_course_path, self.status)) + self.assertTrue(validate_course_olx(self.course.id, self.toy_course_path, self.status)) # noqa: PT009 task_artifact = UserTaskArtifact.objects.filter(status=self.status, name='OLX_VALIDATION_ERROR').first() - self.assertIsNone(task_artifact) - self.assertTrue(mock_olxcleaner_validate.called) + self.assertIsNone(task_artifact) # noqa: PT009 + self.assertTrue(mock_olxcleaner_validate.called) # noqa: PT009 @mock.patch('cms.djangoapps.contentstore.tasks.report_error_summary') @mock.patch('cms.djangoapps.contentstore.tasks.report_errors') @@ -733,12 +728,12 @@ def test_creates_artifact(self, mock_report_errors, mock_report_error_summary, m mock_report_error_summary.return_value = [f'Errors: {len(errors)}'] with patch(self.LOGGER) as patched_log: - self.assertFalse(validate_course_olx(self.course.id, self.toy_course_path, self.status)) + self.assertFalse(validate_course_olx(self.course.id, self.toy_course_path, self.status)) # noqa: PT009 patched_log.error.assert_called_once_with( f'Course import {self.course.id}: CourseOlx validation failed.') task_artifact = UserTaskArtifact.objects.filter(status=self.status, name='OLX_VALIDATION_ERROR').first() - self.assertIsNotNone(task_artifact) + self.assertIsNotNone(task_artifact) # noqa: PT009 def test_validate_calls_with(self, mock_olxcleaner_validate): """ @@ -769,7 +764,7 @@ def test_html_replaced_with_text_for_none(self): display_name = None block_type = "html" result = utils.determine_label(display_name, block_type) - self.assertEqual(result, "Text") + self.assertEqual(result, "Text") # noqa: PT009 def test_html_replaced_with_text_for_empty(self): """ @@ -778,7 +773,7 @@ def test_html_replaced_with_text_for_empty(self): display_name = "" block_type = "html" result = utils.determine_label(display_name, block_type) - self.assertEqual(result, "Text") + self.assertEqual(result, "Text") # noqa: PT009 def test_set_titles_not_replaced(self): """ @@ -787,7 +782,7 @@ def test_set_titles_not_replaced(self): display_name = "Something" block_type = "html" result = utils.determine_label(display_name, block_type) - self.assertEqual(result, "Something") + self.assertEqual(result, "Something") # noqa: PT009 def test_non_html_blocks_titles_not_replaced(self): """ @@ -796,10 +791,10 @@ def test_non_html_blocks_titles_not_replaced(self): display_name = None block_type = "something else" result = utils.determine_label(display_name, block_type) - self.assertEqual(result, "something else") + self.assertEqual(result, "something else") # noqa: PT009 -class AuthorizeStaffTestCase(): +class AuthorizeStaffTestCase(): # noqa: UP039 """ Test that only staff roles can access an API endpoint. """ @@ -938,7 +933,6 @@ def test_update_course_details_instructor_paced(self, mock_update): mock_update.assert_called_once_with(self.course.id, payload, mock_request.user) -@override_waffle_flag(ENABLE_NOTIFICATIONS, active=True) class CourseUpdateNotificationTests(OpenEdxEventsTestMixin, ModuleStoreTestCase): """ Unit tests for the course_update notification. diff --git a/cms/djangoapps/contentstore/tests/test_video_utils.py b/cms/djangoapps/contentstore/tests/test_video_utils.py index e65e4f6638c6..21ae94c1334a 100644 --- a/cms/djangoapps/contentstore/tests/test_video_utils.py +++ b/cms/djangoapps/contentstore/tests/test_video_utils.py @@ -4,8 +4,7 @@ from datetime import datetime -from unittest import TestCase -from unittest import mock +from unittest import TestCase, mock import ddt import pytz @@ -23,7 +22,7 @@ YOUTUBE_THUMBNAIL_SIZES, download_youtube_video_thumbnail, scrape_youtube_thumbnail, - validate_video_image + validate_video_image, ) from openedx.core.djangoapps.profile_images.tests.helpers import make_image_file @@ -37,7 +36,7 @@ def test_invalid_image_file_info(self): Test that when no file information is provided to validate_video_image, it gives proper error message. """ error = validate_video_image({}) - self.assertEqual(error, 'The image must have name, content type, and size information.') + self.assertEqual(error, 'The image must have name, content type, and size information.') # noqa: PT009 def test_corrupt_image_file(self): """ @@ -50,7 +49,7 @@ def test_corrupt_image_file(self): size=settings.VIDEO_IMAGE_SETTINGS['VIDEO_IMAGE_MIN_BYTES'] ) error = validate_video_image(uploaded_image_file) - self.assertEqual(error, 'There is a problem with this image file. Try to upload a different file.') + self.assertEqual(error, 'There is a problem with this image file. Try to upload a different file.') # noqa: PT009 # pylint: disable=line-too-long @ddt.ddt @@ -215,7 +214,7 @@ def mocked_youtube_thumbnail_responses(resolutions): mocked_responses = [] for resolution in YOUTUBE_THUMBNAIL_SIZES: mocked_content = resolutions.get(resolution, '') - error_response = False if mocked_content else True # lint-amnesty, pylint: disable=simplifiable-if-expression + error_response = False if mocked_content else True # pylint: disable=simplifiable-if-expression mocked_responses.append(self.mocked_youtube_thumbnail_response(mocked_content, error_response)) return mocked_responses @@ -224,8 +223,8 @@ def mocked_youtube_thumbnail_responses(resolutions): thumbnail_content, thumbnail_content_type = download_youtube_video_thumbnail('test-yt-id') # Verify that we get the expected thumbnail content. - self.assertEqual(thumbnail_content, expected_thumbnail_content) - self.assertEqual(thumbnail_content_type, 'image/jpeg') + self.assertEqual(thumbnail_content, expected_thumbnail_content) # noqa: PT009 + self.assertEqual(thumbnail_content_type, 'image/jpeg') # noqa: PT009 @override_settings(AWS_ACCESS_KEY_ID='test_key_id', AWS_SECRET_ACCESS_KEY='test_secret') @mock.patch('requests.get') @@ -242,11 +241,11 @@ def test_scrape_youtube_thumbnail(self, mocked_request): # Verify that video1 has no image attached. video1_image_url = get_course_video_image_url(course_id=course_id, edx_video_id=video1_edx_video_id) - self.assertIsNone(video1_image_url) + self.assertIsNone(video1_image_url) # noqa: PT009 # Verify that video2 has already image attached. video2_image_url = get_course_video_image_url(course_id=course_id, edx_video_id=video2_edx_video_id) - self.assertIsNotNone(video2_image_url) + self.assertIsNotNone(video2_image_url) # noqa: PT009 # Scrape video thumbnails. scrape_youtube_thumbnail(course_id, video1_edx_video_id, 'test-yt-id') @@ -254,11 +253,11 @@ def test_scrape_youtube_thumbnail(self, mocked_request): # Verify that now video1 image is attached. video1_image_url = get_course_video_image_url(course_id=course_id, edx_video_id=video1_edx_video_id) - self.assertIsNotNone(video1_image_url) + self.assertIsNotNone(video1_image_url) # noqa: PT009 # Also verify that video2's image is not updated. video2_image_url_latest = get_course_video_image_url(course_id=course_id, edx_video_id=video2_edx_video_id) - self.assertEqual(video2_image_url, video2_image_url_latest) + self.assertEqual(video2_image_url, video2_image_url_latest) # noqa: PT009 @ddt.data( ( @@ -314,21 +313,21 @@ def test_scrape_youtube_thumbnail_logging( ( None, 'image/jpeg', - 'This image file must be larger than {image_min_size}.'.format( + 'This image file must be larger than {image_min_size}.'.format( # noqa: UP032 image_min_size=settings.VIDEO_IMAGE_MIN_FILE_SIZE_KB ) ), ( b'dummy-content', None, - 'This image file type is not supported. Supported file types are {supported_file_formats}.'.format( + 'This image file type is not supported. Supported file types are {supported_file_formats}.'.format( # noqa: UP032 # pylint: disable=line-too-long supported_file_formats=list(settings.VIDEO_IMAGE_SUPPORTED_FILE_FORMATS.keys()) ) ), ( None, None, - 'This image file type is not supported. Supported file types are {supported_file_formats}.'.format( + 'This image file type is not supported. Supported file types are {supported_file_formats}.'.format( # noqa: UP032 # pylint: disable=line-too-long supported_file_formats=list(settings.VIDEO_IMAGE_SUPPORTED_FILE_FORMATS.keys()) ) ), @@ -353,7 +352,7 @@ def test_no_video_thumbnail_downloaded( # Verify that video1 has no image attached. video1_image_url = get_course_video_image_url(course_id=course_id, edx_video_id=video1_edx_video_id) - self.assertIsNone(video1_image_url) + self.assertIsNone(video1_image_url) # noqa: PT009 # Scrape video thumbnail. scrape_youtube_thumbnail(course_id, video1_edx_video_id, 'test-yt-id') @@ -367,7 +366,7 @@ def test_no_video_thumbnail_downloaded( # Verify that no image is attached to video1. video1_image_url = get_course_video_image_url(course_id=course_id, edx_video_id=video1_edx_video_id) - self.assertIsNone(video1_image_url) + self.assertIsNone(video1_image_url) # noqa: PT009 @ddt.ddt @@ -388,7 +387,7 @@ def order_dict(self, dictionary): return dictionary def test_video_backend(self): - self.assertEqual( + self.assertEqual( # noqa: PT009 S3Boto3Storage, import_string( 'storages.backends.s3boto3.S3Boto3Storage', @@ -405,7 +404,7 @@ def test_boto3_backend_with_params(self): settings.VIDEO_IMAGE_SETTINGS.get('STORAGE_CLASS', {}) )(**settings.VIDEO_IMAGE_SETTINGS.get('STORAGE_KWARGS', {})) - self.assertEqual(S3Boto3Storage, storage.__class__) + self.assertEqual(S3Boto3Storage, storage.__class__) # noqa: PT009 def test_storage_without_global_default_acl_setting(self): """ diff --git a/cms/djangoapps/contentstore/tests/test_xblock_handler_permissions.py b/cms/djangoapps/contentstore/tests/test_xblock_handler_permissions.py new file mode 100644 index 000000000000..cc7b53ca0991 --- /dev/null +++ b/cms/djangoapps/contentstore/tests/test_xblock_handler_permissions.py @@ -0,0 +1,470 @@ +""" +Tests verifying that xblock_handler enforces the correct permissions. +""" +from unittest.mock import patch + +from cms.djangoapps.contentstore.tests.utils import CourseTestCase +from openedx.core import toggles as core_toggles +from xmodule.modulestore.tests.factories import BlockFactory + + +class XBlockHandlerPermissionsTest(CourseTestCase): + """ + Tests for xblock_storage_handlers.view_handlers.handle_xblock. + + Verifies legacy permission enforcement (staff vs non-staff). + """ + + def setUp(self): + super().setUp() + self.chapter = BlockFactory.create(category='chapter', parent_location=self.course.location) + self.sequential = BlockFactory.create(category='sequential', parent_location=self.chapter.location) + self.vertical = BlockFactory.create(category='vertical', parent_location=self.sequential.location) + self.html_block = BlockFactory.create(category='html', parent_location=self.vertical.location) + self.static_tab = BlockFactory.create(category='static_tab', parent_location=self.course.location) + self.non_staff_client, _ = self.create_non_staff_authed_user_client() + + # --- GET /xblock/{blockId} --- + + def test_get_block_fields_staff_allowed(self): + self.assertEqual(self.client.get_json(f'/xblock/{self.html_block.location}').status_code, 200) # noqa: PT009 + + def test_get_block_fields_non_staff_forbidden(self): + self.assertEqual(self.non_staff_client.get_json(f'/xblock/{self.html_block.location}').status_code, 403) # noqa: PT009 # pylint: disable=line-too-long + + # --- POST /xblock/{blockId} metadata --- + + def test_post_metadata_staff_allowed(self): + resp = self.client.ajax_post( + f'/xblock/{self.html_block.location}', data={'metadata': {'display_name': 'New Name'}} + ) + self.assertEqual(resp.status_code, 200) # noqa: PT009 + + def test_post_metadata_non_staff_forbidden(self): + resp = self.non_staff_client.ajax_post( + f'/xblock/{self.html_block.location}', data={'metadata': {'display_name': 'New Name'}} + ) + self.assertEqual(resp.status_code, 403) # noqa: PT009 + + # --- POST /xblock/{blockId} publish --- + + def test_publish_staff_allowed(self): + resp = self.client.ajax_post(f'/xblock/{self.vertical.location}', data={'publish': 'make_public'}) + self.assertEqual(resp.status_code, 200) # noqa: PT009 + + def test_publish_non_staff_forbidden(self): + resp = self.non_staff_client.ajax_post(f'/xblock/{self.vertical.location}', data={'publish': 'make_public'}) + self.assertEqual(resp.status_code, 403) # noqa: PT009 + + # --- DELETE /xblock/{blockId} --- + + def test_delete_block_staff_allowed(self): + resp = self.client.delete(f'/xblock/{self.html_block.location}', HTTP_ACCEPT='application/json') + self.assertEqual(resp.status_code, 204) # noqa: PT009 + + def test_delete_block_non_staff_forbidden(self): + resp = self.non_staff_client.delete(f'/xblock/{self.html_block.location}', HTTP_ACCEPT='application/json') + self.assertEqual(resp.status_code, 403) # noqa: PT009 + + # --- POST /xblock/ (create/duplicate) --- + + def test_post_duplicate_staff_allowed(self): + data = { + 'duplicate_source_locator': str(self.html_block.location), + 'parent_locator': str(self.vertical.location), + } + self.assertEqual(self.client.ajax_post('/xblock/', data=data).status_code, 200) # noqa: PT009 + + def test_post_duplicate_non_staff_forbidden(self): + data = { + 'duplicate_source_locator': str(self.html_block.location), + 'parent_locator': str(self.vertical.location), + } + self.assertEqual(self.non_staff_client.ajax_post('/xblock/', data=data).status_code, 403) # noqa: PT009 + + def test_post_add_component_staff_allowed(self): + data = {'category': 'html', 'parent_locator': str(self.vertical.location)} + self.assertEqual(self.client.ajax_post('/xblock/', data=data).status_code, 200) # noqa: PT009 + + def test_post_add_component_non_staff_forbidden(self): + data = {'category': 'html', 'parent_locator': str(self.vertical.location)} + self.assertEqual(self.non_staff_client.ajax_post('/xblock/', data=data).status_code, 403) # noqa: PT009 + + # --- PUT /xblock/{blockId} (reorder) --- + + def test_put_reorder_staff_allowed(self): + data={'children': [str(self.html_block.location)]} + resp = self.client.put( + f'/xblock/{self.vertical.location}', data=data, + content_type='application/json', HTTP_ACCEPT='application/json', + ) + self.assertEqual(resp.status_code, 200) # noqa: PT009 + + def test_put_reorder_non_staff_forbidden(self): + data={'children': [str(self.html_block.location)]} + resp = self.non_staff_client.put( + f'/xblock/{self.vertical.location}', data=data, + content_type='application/json', HTTP_ACCEPT='application/json', + ) + self.assertEqual(resp.status_code, 403) # noqa: PT009 + + # --- PATCH /xblock/ (move) --- + + def test_patch_move_component_staff_allowed(self): + vertical2 = BlockFactory.create(category='vertical', parent_location=self.sequential.location) + data={ + 'move_source_locator': str(self.html_block.location), + 'parent_locator': str(vertical2.location), + } + resp = self.client.patch( + '/xblock/', data=data, content_type='application/json', HTTP_ACCEPT='application/json', + ) + self.assertNotEqual(resp.status_code, 403) # noqa: PT009 + + def test_patch_move_component_non_staff_forbidden(self): + data={ + 'move_source_locator': str(self.html_block.location), + 'parent_locator': str(self.vertical.location), + } + resp = self.non_staff_client.patch( + '/xblock/', data=data, content_type='application/json', HTTP_ACCEPT='application/json', + ) + self.assertEqual(resp.status_code, 403) # noqa: PT009 + + # --- static_tab and course_info --- + + def test_put_update_custom_page_staff_allowed(self): + data={'metadata': {'display_name': 'Updated Page'}} + resp = self.client.put( + f'/xblock/{self.static_tab.location}', data=data, + content_type='application/json', HTTP_ACCEPT='application/json', + ) + self.assertEqual(resp.status_code, 200) # noqa: PT009 + + def test_put_update_custom_page_non_staff_forbidden(self): + data={'metadata': {'display_name': 'Updated Page'}} + resp = self.non_staff_client.put( + f'/xblock/{self.static_tab.location}', data=data, + content_type='application/json', HTTP_ACCEPT='application/json', + ) + self.assertEqual(resp.status_code, 403) # noqa: PT009 + + def test_delete_custom_page_staff_allowed(self): + resp = self.client.delete(f'/xblock/{self.static_tab.location}', HTTP_ACCEPT='application/json') + self.assertEqual(resp.status_code, 204) # noqa: PT009 + + def test_delete_custom_page_non_staff_forbidden(self): + resp = self.non_staff_client.delete(f'/xblock/{self.static_tab.location}', HTTP_ACCEPT='application/json') + self.assertEqual(resp.status_code, 403) # noqa: PT009 + + def test_post_static_tab_content_staff_allowed(self): + resp = self.client.ajax_post( + f'/xblock/{self.static_tab.location}', data={'data': '

Content

', 'metadata': {'display_name': 'Page'}} + ) + self.assertEqual(resp.status_code, 200) # noqa: PT009 + + def test_post_static_tab_content_non_staff_forbidden(self): + resp = self.non_staff_client.ajax_post( + f'/xblock/{self.static_tab.location}', data={'data': '

Content

', 'metadata': {'display_name': 'Page'}} + ) + self.assertEqual(resp.status_code, 403) # noqa: PT009 + + def test_get_handouts_staff_allowed(self): + handouts = BlockFactory.create(category='course_info', parent_location=self.course.location) + self.assertEqual(self.client.get_json(f'/xblock/{handouts.location}').status_code, 200) # noqa: PT009 + + def test_get_handouts_non_staff_forbidden(self): + handouts = BlockFactory.create(category='course_info', parent_location=self.course.location) + self.assertEqual(self.non_staff_client.get_json(f'/xblock/{handouts.location}').status_code, 403) # noqa: PT009 + + +@patch('cms.djangoapps.contentstore.xblock_storage_handlers.view_handlers.authz_api.is_user_allowed', return_value=True) +@patch.object(core_toggles.AUTHZ_COURSE_AUTHORING_FLAG, 'is_enabled', return_value=True) +class XBlockHandlerAuthzPermissionsTest(CourseTestCase): + """ + Tests for authz-based permission checks in xblock_handler. + + Verifies that when AUTHZ_COURSE_AUTHORING_FLAG is enabled, the handler + uses granular authz permissions instead of legacy permission checks. + """ + + def setUp(self): + super().setUp() + self.chapter = BlockFactory.create(category='chapter', parent_location=self.course.location) + self.sequential = BlockFactory.create(category='sequential', parent_location=self.chapter.location) + self.vertical = BlockFactory.create(category='vertical', parent_location=self.sequential.location) + self.html_block = BlockFactory.create(category='html', parent_location=self.vertical.location) + self.static_tab = BlockFactory.create(category='static_tab', parent_location=self.course.location) + self.course_info = BlockFactory.create(category='course_info', parent_location=self.course.location) + + # --- GET /xblock/{blockId} --- + + def test_get_regular_block_checks_view_course(self, _mock_flag, mock_is_allowed): # noqa: PT019 + """GET on regular block should check courses.view_course permission""" + self.client.get_json(f'/xblock/{self.html_block.location}') + mock_is_allowed.assert_called_with( + self.user.username, + 'courses.view_course', + str(self.course.id) + ) + + def test_get_course_info_checks_view_course_updates(self, _mock_flag, mock_is_allowed): # noqa: PT019 + """GET on course_info block should check courses.view_course_updates permission""" + self.client.get_json(f'/xblock/{self.course_info.location}') + mock_is_allowed.assert_called_with( + self.user.username, + 'courses.view_course_updates', + str(self.course.id) + ) + + def test_get_static_tab_checks_view_course(self, _mock_flag, mock_is_allowed): # noqa: PT019 + """GET on static_tab should check courses.view_course""" + self.client.get_json(f'/xblock/{self.static_tab.location}') + mock_is_allowed.assert_called_with( + self.user.username, + 'courses.view_course', + str(self.course.id) + ) + + # --- POST /xblock/{blockId} metadata --- + + def test_post_regular_block_checks_edit_course_content(self, _mock_flag, mock_is_allowed): # noqa: PT019 + """POST on regular block without publish should check courses.edit_course_content""" + self.client.ajax_post(f'/xblock/{self.html_block.location}', data={'metadata': {'display_name': 'New'}}) + mock_is_allowed.assert_called_with( + self.user.username, + 'courses.edit_course_content', + str(self.course.id) + ) + + def test_post_with_publish_none_and_metadata_checks_edit(self, _mock_flag, mock_is_allowed): # noqa: PT019 + """POST with publish=None + metadata should check courses.edit_course_content""" + self.client.ajax_post( + f'/xblock/{self.vertical.location}', + data={'publish': None, 'metadata': {'visible_to_staff_only': True}} + ) + mock_is_allowed.assert_called_with( + self.user.username, + 'courses.edit_course_content', + str(self.course.id) + ) + + # --- POST /xblock/{blockId} publish --- + + def test_post_with_publish_checks_publish_course_content(self, _mock_flag, mock_is_allowed): # noqa: PT019 + """POST with publish='make_public' should check courses.publish_course_content""" + self.client.ajax_post(f'/xblock/{self.vertical.location}', data={'publish': 'make_public'}) + mock_is_allowed.assert_called_with( + self.user.username, + 'courses.publish_course_content', + str(self.course.id) + ) + + def test_post_discard_changes_checks_publish(self, _mock_flag, mock_is_allowed): # noqa: PT019 + """POST with publish='discard_changes' should check courses.publish_course_content""" + self.client.ajax_post(f'/xblock/{self.vertical.location}', data={'publish': 'discard_changes'}) + mock_is_allowed.assert_called_with( + self.user.username, + 'courses.publish_course_content', + str(self.course.id) + ) + + def test_post_republish_without_changes_checks_publish(self, _mock_flag, mock_is_allowed): # noqa: PT019 + """POST with publish='republish' and no content changes should check courses.publish_course_content""" + self.client.ajax_post(f'/xblock/{self.vertical.location}', data={'publish': 'republish'}) + mock_is_allowed.assert_called_with( + self.user.username, + 'courses.publish_course_content', + str(self.course.id) + ) + + def test_post_make_public_with_content_changes_checks_edit(self, _mock_flag, mock_is_allowed): # noqa: PT019 + """POST with publish='make_public' + metadata should check courses.edit_course_content""" + self.client.ajax_post( + f'/xblock/{self.vertical.location}', + data={'publish': 'make_public', 'metadata': {'display_name': 'New'}} + ) + mock_is_allowed.assert_called_with( + self.user.username, + 'courses.edit_course_content', + str(self.course.id) + ) + + def test_post_republish_with_metadata_checks_edit(self, _mock_flag, mock_is_allowed): # noqa: PT019 + """POST with publish='republish' + metadata changes should check courses.edit_course_content""" + self.client.ajax_post( + f'/xblock/{self.chapter.location}', + data={'publish': 'republish', 'metadata': {'highlights': ['Week 1']}} + ) + mock_is_allowed.assert_called_with( + self.user.username, + 'courses.edit_course_content', + str(self.course.id) + ) + + def test_post_republish_with_grader_type_checks_edit(self, _mock_flag, mock_is_allowed): # noqa: PT019 + """POST with publish='republish' + graderType should check courses.edit_course_content""" + self.client.ajax_post( + f'/xblock/{self.sequential.location}', + data={'publish': 'republish', 'graderType': 'Homework', 'prereqMinScore': 100} + ) + mock_is_allowed.assert_called_with( + self.user.username, + 'courses.edit_course_content', + str(self.course.id) + ) + + # --- DELETE /xblock/{blockId} --- + + def test_delete_regular_block_checks_edit_course_content(self, _mock_flag, mock_is_allowed): # noqa: PT019 + """DELETE on regular block should check courses.edit_course_content""" + self.client.delete(f'/xblock/{self.html_block.location}', HTTP_ACCEPT='application/json') + mock_is_allowed.assert_called_with( + self.user.username, + 'courses.edit_course_content', + str(self.course.id) + ) + + def test_delete_static_tab_checks_manage_pages_and_resources(self, _mock_flag, mock_is_allowed): # noqa: PT019 + """DELETE on static_tab should check courses.manage_pages_and_resources""" + self.client.delete(f'/xblock/{self.static_tab.location}', HTTP_ACCEPT='application/json') + mock_is_allowed.assert_called_with( + self.user.username, + 'courses.manage_pages_and_resources', + str(self.course.id) + ) + + # --- POST /xblock/ (create/duplicate) --- + + def test_create_block_checks_edit_course_content(self, _mock_flag, mock_is_allowed): # noqa: PT019 + """POST /xblock/ to create block should check courses.edit_course_content""" + self.client.ajax_post('/xblock/', data={'category': 'html', 'parent_locator': str(self.vertical.location)}) + mock_is_allowed.assert_called_with( + self.user.username, + 'courses.edit_course_content', + str(self.course.id) + ) + + def test_create_static_tab_checks_manage_pages_and_resources(self, _mock_flag, mock_is_allowed): # noqa: PT019 + """PUT /xblock/ to create static_tab should check courses.manage_pages_and_resources""" + self.client.put( + '/xblock/', + data={'category': 'static_tab', 'parent_locator': str(self.course.location)}, + content_type='application/json', HTTP_ACCEPT='application/json', + ) + mock_is_allowed.assert_called_with( + self.user.username, + 'courses.manage_pages_and_resources', + str(self.course.id) + ) + + def test_duplicate_block_checks_edit_course_content(self, _mock_flag, mock_is_allowed): # noqa: PT019 + """POST /xblock/ to duplicate should check courses.edit_course_content""" + self.client.ajax_post( + '/xblock/', + data={ + 'duplicate_source_locator': str(self.html_block.location), + 'parent_locator': str(self.vertical.location), + } + ) + mock_is_allowed.assert_called_with( + self.user.username, + 'courses.edit_course_content', + str(self.course.id) + ) + + # --- PUT /xblock/{blockId} (reorder) --- + + def test_put_reorder_checks_edit_course_content(self, _mock_flag, mock_is_allowed): # noqa: PT019 + """PUT on regular block (reorder children) should check courses.edit_course_content""" + self.client.put( + f'/xblock/{self.vertical.location}', + data={'children': [str(self.html_block.location)]}, + content_type='application/json', HTTP_ACCEPT='application/json', + ) + mock_is_allowed.assert_called_with( + self.user.username, + 'courses.edit_course_content', + str(self.course.id) + ) + + # --- PATCH /xblock/ (move) --- + + def test_move_block_checks_edit_course_content(self, _mock_flag, mock_is_allowed): # noqa: PT019 + """PATCH /xblock/ to move should check courses.edit_course_content""" + vertical2 = BlockFactory.create(category='vertical', parent_location=self.sequential.location) + self.client.patch( + '/xblock/', + data={ + 'move_source_locator': str(self.html_block.location), + 'parent_locator': str(vertical2.location), + }, + content_type='application/json', + HTTP_ACCEPT='application/json', + ) + mock_is_allowed.assert_called_with( + self.user.username, + 'courses.edit_course_content', + str(self.course.id) + ) + + # --- static_tab and course_info --- + + def test_post_static_tab_checks_manage_pages_and_resources(self, _mock_flag, mock_is_allowed): # noqa: PT019 + """POST on static_tab should check courses.manage_pages_and_resources""" + self.client.ajax_post(f'/xblock/{self.static_tab.location}', data={'metadata': {'display_name': 'Updated'}}) + mock_is_allowed.assert_called_with( + self.user.username, + 'courses.manage_pages_and_resources', + str(self.course.id) + ) + + def test_put_static_tab_checks_manage_pages_and_resources(self, _mock_flag, mock_is_allowed): # noqa: PT019 + """PUT on static_tab should check courses.manage_pages_and_resources""" + self.client.put( + f'/xblock/{self.static_tab.location}', + data={'metadata': {'display_name': 'Updated'}}, + content_type='application/json', HTTP_ACCEPT='application/json', + ) + mock_is_allowed.assert_called_with( + self.user.username, + 'courses.manage_pages_and_resources', + str(self.course.id) + ) + + def test_post_course_info_checks_manage_course_updates(self, _mock_flag, mock_is_allowed): # noqa: PT019 + """POST on course_info block should check courses.manage_course_updates""" + self.client.ajax_post(f'/xblock/{self.course_info.location}', data={'data': '

Updated

'}) + mock_is_allowed.assert_called_with( + self.user.username, + 'courses.manage_course_updates', + str(self.course.id) + ) + + def test_put_course_info_checks_manage_course_updates(self, _mock_flag, mock_is_allowed): # noqa: PT019 + """PUT on course_info should check courses.manage_course_updates""" + self.client.put( + f'/xblock/{self.course_info.location}', + data={'data': '

Updated

'}, + content_type='application/json', + HTTP_ACCEPT='application/json', + ) + mock_is_allowed.assert_called_with( + self.user.username, + 'courses.manage_course_updates', + str(self.course.id) + ) + + # --- authz flag behavior --- + + def test_authz_denied_raises_permission_denied(self, _mock_flag, mock_is_allowed): # noqa: PT019 + """When authz denies permission, PermissionDenied should be raised""" + mock_is_allowed.return_value = False + response = self.client.get_json(f'/xblock/{self.html_block.location}') + self.assertEqual(response.status_code, 403) # noqa: PT009 + + def test_authz_flag_disabled_uses_legacy_permissions(self, _mock_flag, mock_is_allowed): # noqa: PT019 + """When authz flag is disabled, should use legacy permission checks""" + with patch.object(core_toggles.AUTHZ_COURSE_AUTHORING_FLAG, 'is_enabled', return_value=False): + self.client.get_json(f'/xblock/{self.html_block.location}') + mock_is_allowed.assert_not_called() diff --git a/cms/djangoapps/contentstore/tests/tests.py b/cms/djangoapps/contentstore/tests/tests.py index d151b1d58526..67558b9e5826 100644 --- a/cms/djangoapps/contentstore/tests/tests.py +++ b/cms/djangoapps/contentstore/tests/tests.py @@ -2,31 +2,28 @@ This test file will test registration, login, activation, and session activity timeouts TODO: Rewrite several of these assertions so that they check the output of the REST or Python -APIs rather than parsing HTML from the deprecated legacy frontend pages. In particular, any -test case using override_waffle_flag(toggles.LEGACY_STUDIO_*, True) will need to be fixed. -Part of https://github.com/openedx/edx-platform/issues/36275. +APIs rather than parsing HTML from the deprecated legacy frontend pages. """ import datetime import time -from unittest import mock -from urllib.parse import quote_plus, unquote +from urllib.parse import unquote from ddt import data, ddt, unpack from django.conf import settings from django.core.cache import cache from django.test.utils import override_settings from django.urls import reverse -from edx_toggles.toggles.testutils import override_waffle_flag from pytz import UTC -from cms.djangoapps.contentstore import toggles from cms.djangoapps.contentstore.tests.test_course_settings import CourseTestCase from cms.djangoapps.contentstore.tests.utils import AjaxEnabledTestClient, parse_json, registration, user from cms.djangoapps.contentstore.utils import get_studio_home_url -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + ModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order class ContentStoreTestCase(ModuleStoreTestCase): @@ -46,7 +43,7 @@ def _login(self, email, password): def login(self, email, password): """Login, check that it worked.""" resp = self._login(email, password) - self.assertEqual(resp.status_code, 200) + self.assertEqual(resp.status_code, 200) # noqa: PT009 return resp def _create_account(self, username, email, password): @@ -67,12 +64,12 @@ def _create_account(self, username, email, password): def create_account(self, username, email, password): """Create the account and check that it worked""" resp = self._create_account(username, email, password) - self.assertEqual(resp.status_code, 200) + self.assertEqual(resp.status_code, 200) # noqa: PT009 json_data = parse_json(resp) - self.assertEqual(json_data['success'], True) + self.assertEqual(json_data['success'], True) # noqa: PT009 # Check both that the user is created, and inactive - self.assertFalse(user(email).is_active) + self.assertFalse(user(email).is_active) # noqa: PT009 return resp @@ -87,9 +84,9 @@ def _activate_user(self, email): def activate_user(self, email): resp = self._activate_user(email) - self.assertEqual(resp.status_code, 200) + self.assertEqual(resp.status_code, 200) # noqa: PT009 # Now make sure that the user is now actually activated - self.assertTrue(user(email).is_active) + self.assertTrue(user(email).is_active) # noqa: PT009 @ddt @@ -177,32 +174,6 @@ def test_inactive_session_timeout(self): # re-request, and we should get a redirect to login page self.assertRedirects(resp, settings.LOGIN_URL + '?next=/home/', target_status_code=302) - @data( - (True, 'assertContains'), - (False, 'assertNotContains')) - @unpack - @override_waffle_flag(toggles.LEGACY_STUDIO_LOGGED_OUT_HOME, True) - def test_signin_and_signup_buttons_index_page(self, allow_account_creation, assertion_method_name): - """ - Navigate to the home page and check the Sign Up button is hidden when ALLOW_PUBLIC_ACCOUNT_CREATION flag - is turned off, and not when it is turned on. The Sign In button should always appear. - """ - with mock.patch.dict(settings.FEATURES, {"ALLOW_PUBLIC_ACCOUNT_CREATION": allow_account_creation}): - response = self.client.get(reverse('homepage')) - assertion_method = getattr(self, assertion_method_name) - login_url = quote_plus(f"http://testserver{settings.LOGIN_URL}") - assertion_method( - response, - f'' - ) - self.assertContains( - response, - '' - ) - - class ForumTestCase(CourseTestCase): """Tests class to verify course to forum operations""" @@ -224,31 +195,31 @@ def test_blackouts(self): (now + datetime.timedelta(days=24), now + datetime.timedelta(days=30)) ] self.set_blackout_dates(times1) - self.assertTrue(self.course.forum_posts_allowed) + self.assertTrue(self.course.forum_posts_allowed) # noqa: PT009 times2 = [ (now - datetime.timedelta(days=14), now + datetime.timedelta(days=2)), (now + datetime.timedelta(days=24), now + datetime.timedelta(days=30)) ] self.set_blackout_dates(times2) - self.assertFalse(self.course.forum_posts_allowed) + self.assertFalse(self.course.forum_posts_allowed) # noqa: PT009 # Single date set for allowed forum posts. self.course.discussion_blackouts = [ now + datetime.timedelta(days=24), now + datetime.timedelta(days=30) ] - self.assertTrue(self.course.forum_posts_allowed) + self.assertTrue(self.course.forum_posts_allowed) # noqa: PT009 # Single date set for restricted forum posts. self.course.discussion_blackouts = [ now - datetime.timedelta(days=24), now + datetime.timedelta(days=30) ] - self.assertFalse(self.course.forum_posts_allowed) + self.assertFalse(self.course.forum_posts_allowed) # noqa: PT009 # test if user gives empty blackout date it should return true for forum_posts_allowed self.course.discussion_blackouts = [[]] - self.assertTrue(self.course.forum_posts_allowed) + self.assertTrue(self.course.forum_posts_allowed) # noqa: PT009 @ddt @@ -262,20 +233,19 @@ def setUp(self): super().setUp() self.course = CourseFactory.create(org='edX', number='test_course_key', display_name='Test Course') - @data(('edX/test_course_key/Test_Course', 200), ('garbage:edX+test_course_key+Test_Course', 404)) + @data(('edX/test_course_key/Test_Course', 302, 200), ('garbage:edX+test_course_key+Test_Course', 404, 404)) @unpack - @override_waffle_flag(toggles.LEGACY_STUDIO_IMPORT, True) - def test_course_key_decorator(self, course_key, status_code): + def test_course_key_decorator(self, course_key, import_status_code, import_status_handler_code): """ Tests for the ensure_valid_course_key decorator. """ url = f'/import/{course_key}' resp = self.client.get_html(url) - self.assertEqual(resp.status_code, status_code) + self.assertEqual(resp.status_code, import_status_code) # noqa: PT009 url = '/import_status/{course_key}/{filename}'.format( course_key=course_key, filename='xyz.tar.gz' ) resp = self.client.get_html(url) - self.assertEqual(resp.status_code, status_code) + self.assertEqual(resp.status_code, import_status_handler_code) # noqa: PT009 diff --git a/cms/djangoapps/contentstore/tests/utils.py b/cms/djangoapps/contentstore/tests/utils.py index 42f57563c292..4b5e33fb65ec 100644 --- a/cms/djangoapps/contentstore/tests/utils.py +++ b/cms/djangoapps/contentstore/tests/utils.py @@ -6,20 +6,19 @@ import json from django.conf import settings -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.test.client import Client from opaque_keys.edx.keys import AssetKey + +from cms.djangoapps.contentstore.utils import reverse_url +from common.djangoapps.student.models import Registration +from openedx.core.djangoapps.video_config.tests.test_transcripts_utils import YoutubeVideoHTMLResponse from xmodule.contentstore.django import contentstore from xmodule.modulestore.inheritance import own_metadata from xmodule.modulestore.split_mongo.split import SplitMongoModuleStore from xmodule.modulestore.tests.django_utils import TEST_DATA_SPLIT_MODULESTORE, ModuleStoreTestCase from xmodule.modulestore.tests.factories import CourseFactory from xmodule.modulestore.tests.utils import ProceduralCourseTestMixin -from openedx.core.djangoapps.video_config.tests.test_transcripts_utils import YoutubeVideoHTMLResponse - -from cms.djangoapps.contentstore.utils import reverse_url -from common.djangoapps.student.models import Registration - TEST_DATA_DIR = settings.COMMON_TEST_DATA_ROOT @@ -131,12 +130,12 @@ def assertCoursesEqual(self, course1_id, course2_id): """ course1_items = self.store.get_items(course1_id) course2_items = self.store.get_items(course2_id) - self.assertGreater(len(course1_items), 0) # ensure it found content instead of [] == [] + self.assertGreater(len(course1_items), 0) # ensure it found content instead of [] == [] # noqa: PT009 if len(course1_items) != len(course2_items): course1_block_ids = {item.location.block_id for item in course1_items} course2_block_ids = {item.location.block_id for item in course2_items} raise AssertionError( - "Course1 extra blocks: {}; course2 extra blocks: {}".format( + "Course1 extra blocks: {}; course2 extra blocks: {}".format( # noqa: UP032 course1_block_ids - course2_block_ids, course2_block_ids - course1_block_ids ) ) @@ -152,15 +151,15 @@ def assertCoursesEqual(self, course1_id, course2_id): course2_item = self.store.get_item(course2_item_loc) # compare published state - self.assertEqual( + self.assertEqual( # noqa: PT009 self.store.has_published_version(course1_item), self.store.has_published_version(course2_item) ) # compare data - self.assertEqual(hasattr(course1_item, 'data'), hasattr(course2_item, 'data')) + self.assertEqual(hasattr(course1_item, 'data'), hasattr(course2_item, 'data')) # noqa: PT009 if hasattr(course1_item, 'data'): - self.assertEqual(course1_item.data, course2_item.data) + self.assertEqual(course1_item.data, course2_item.data) # noqa: PT009 # compare meta-data course1_metadata = own_metadata(course1_item) @@ -168,23 +167,23 @@ def assertCoursesEqual(self, course1_id, course2_id): # Omit edx_video_id as it can be different in case of extrnal video imports. course1_metadata.pop('edx_video_id', None) course2_metadata.pop('edx_video_id', None) - self.assertEqual(course1_metadata, course2_metadata) + self.assertEqual(course1_metadata, course2_metadata) # noqa: PT009 # compare children - self.assertEqual(course1_item.has_children, course2_item.has_children) + self.assertEqual(course1_item.has_children, course2_item.has_children) # noqa: PT009 if course1_item.has_children: expected_children = [] for course1_item_child in course1_item.children: expected_children.append( course2_id.make_usage_key(course1_item_child.block_type, course1_item_child.block_id) ) - self.assertEqual(expected_children, course2_item.children) + self.assertEqual(expected_children, course2_item.children) # noqa: PT009 # compare assets content_store = self.store.contentstore course1_assets, count_course1_assets = content_store.get_all_content_for_course(course1_id) _, count_course2_assets = content_store.get_all_content_for_course(course2_id) - self.assertEqual(count_course1_assets, count_course2_assets) + self.assertEqual(count_course1_assets, count_course2_assets) # noqa: PT009 for asset in course1_assets: asset_son = asset.get('content_son', asset['_id']) self.assertAssetsEqual(asset_son, course1_id, course2_id) @@ -192,10 +191,10 @@ def assertCoursesEqual(self, course1_id, course2_id): def check_verticals(self, items): """ Test getting the editing HTML for each vertical. """ # assert is here to make sure that the course being tested actually has verticals (units) to check. - self.assertGreater(len(items), 0, "Course has no verticals (units) to check") + self.assertGreater(len(items), 0, "Course has no verticals (units) to check") # noqa: PT009 for block in items: resp = self.client.get_html(get_url('container_handler', block.location)) - self.assertEqual(resp.status_code, 200) + self.assertEqual(resp.status_code, 200) # noqa: PT009 def assertAssetsEqual(self, asset_son, course1_id, course2_id): """Verifies the asset of the given key has the same attributes in both given courses.""" @@ -204,12 +203,12 @@ def assertAssetsEqual(self, asset_son, course1_id, course2_id): filename = asset_son.block_id if hasattr(asset_son, 'block_id') else asset_son['name'] course1_asset_attrs = content_store.get_attrs(course1_id.make_asset_key(category, filename)) course2_asset_attrs = content_store.get_attrs(course2_id.make_asset_key(category, filename)) - self.assertEqual(len(course1_asset_attrs), len(course2_asset_attrs)) + self.assertEqual(len(course1_asset_attrs), len(course2_asset_attrs)) # noqa: PT009 for key, value in course1_asset_attrs.items(): if key in ['_id', 'filename', 'uploadDate', 'content_son', 'thumbnail_location']: pass else: - self.assertEqual(value, course2_asset_attrs[key]) + self.assertEqual(value, course2_asset_attrs[key]) # noqa: PT009 class HTTPGetResponse: diff --git a/cms/djangoapps/contentstore/toggles.py b/cms/djangoapps/contentstore/toggles.py index 5462a28bae4b..94960ba66ec0 100644 --- a/cms/djangoapps/contentstore/toggles.py +++ b/cms/djangoapps/contentstore/toggles.py @@ -2,10 +2,10 @@ CMS feature toggles. """ from edx_toggles.toggles import SettingToggle, WaffleFlag + from openedx.core.djangoapps.content.search import api as search_api from openedx.core.djangoapps.waffle_utils import CourseWaffleFlag - # .. toggle_name: ENABLE_EXPORT_GIT # .. toggle_implementation: SettingToggle # .. toggle_default: False @@ -86,23 +86,21 @@ def exam_setting_view_enabled(course_key): return not LEGACY_STUDIO_EXAM_SETTINGS.is_enabled(course_key) -# .. toggle_name: legacy_studio.video_editor +# .. toggle_name: legacy_studio.pdf_editor # .. toggle_implementation: WaffleFlag # .. toggle_default: False -# .. toggle_description: Temporarily fall back to the old Video component (a.k.a. video block) editor. -# .. toggle_use_cases: temporary -# .. toggle_creation_date: 2025-03-14 -# .. toggle_target_removal_date: 2025-09-14 -# .. toggle_tickets: https://github.com/openedx/edx-platform/issues/36275 -# .. toggle_warning: In Ulmo, this toggle will be removed. Only the new (React-based) experience will be available. -LEGACY_STUDIO_VIDEO_EDITOR = CourseWaffleFlag('legacy_studio.video_editor', __name__) +# .. toggle_description: Use the PDF XBlock's studio_view instead of the new React-based editor. You may wish to do +# this if you run a custom PDF block. +# .. toggle_use_cases: opt_out +# .. toggle_creation_date: 2026-03-10 +LEGACY_STUDIO_PDF_EDITOR = WaffleFlag('legacy_studio.pdf_editor', __name__) -def use_new_video_editor(course_key): +def use_new_pdf_editor(): """ Returns a boolean = true if new video editor is enabled """ - return not LEGACY_STUDIO_VIDEO_EDITOR.is_enabled(course_key) + return not LEGACY_STUDIO_PDF_EDITOR.is_enabled() # .. toggle_name: new_core_editors.use_video_gallery_flow @@ -112,7 +110,7 @@ def use_new_video_editor(course_key): # .. toggle_use_cases: temporary # .. toggle_creation_date: 2023-04-03 # .. toggle_target_removal_date: 2023-6-01 -# .. toggle_warning: You need to activate the `new_core_editors.use_new_video_editor` flag to use this new flow. +# .. toggle_warning: This controls the new core video xblock editor flow. ENABLE_VIDEO_GALLERY_FLOW_FLAG = WaffleFlag('new_core_editors.use_video_gallery_flow', __name__) @@ -161,117 +159,25 @@ def use_react_markdown_editor(course_key): return ENABLE_REACT_MARKDOWN_EDITOR.is_enabled(course_key) -# .. toggle_name: legacy_studio.schedule_details -# .. toggle_implementation: WaffleFlag -# .. toggle_default: False -# .. toggle_description: Temporarily fall back to the old Studio Schedule & Details page. -# .. toggle_use_cases: temporary -# .. toggle_creation_date: 2025-03-14 -# .. toggle_target_removal_date: 2025-09-14 -# .. toggle_tickets: https://github.com/openedx/edx-platform/issues/36275 -# .. toggle_warning: In Ulmo, this toggle will be removed. Only the new (React-based) experience will be available. -LEGACY_STUDIO_SCHEDULE_DETAILS = CourseWaffleFlag('legacy_studio.schedule_details', __name__) - - -def use_new_schedule_details_page(course_key): - """ - Returns a boolean if new studio schedule and details mfe is enabled - """ - return not LEGACY_STUDIO_SCHEDULE_DETAILS.is_enabled(course_key) - - -# .. toggle_name: legacy_studio.advanced_settings -# .. toggle_implementation: WaffleFlag -# .. toggle_default: False -# .. toggle_description: Temporarily fall back to the old Studio Advanced Settings page. -# .. toggle_use_cases: temporary -# .. toggle_creation_date: 2025-03-14 -# .. toggle_target_removal_date: 2025-09-14 -# .. toggle_tickets: https://github.com/openedx/edx-platform/issues/36275 -# .. toggle_warning: In Ulmo, this toggle will be removed. Only the new (React-based) experience will be available. -LEGACY_STUDIO_ADVANCED_SETTINGS = CourseWaffleFlag('legacy_studio.advanced_settings', __name__) - - -def use_new_advanced_settings_page(course_key): - """ - Returns a boolean if new studio advanced settings pafe mfe is enabled - """ - return not LEGACY_STUDIO_ADVANCED_SETTINGS.is_enabled(course_key) - - -# .. toggle_name: legacy_studio.grading -# .. toggle_implementation: WaffleFlag -# .. toggle_default: False -# .. toggle_description: Temporarily fall back to the old Studio Course Grading page. -# .. toggle_use_cases: temporary -# .. toggle_creation_date: 2025-03-14 -# .. toggle_target_removal_date: 2025-09-14 -# .. toggle_tickets: https://github.com/openedx/edx-platform/issues/36275 -# .. toggle_warning: In Ulmo, this toggle will be removed. Only the new (React-based) experience will be available. -LEGACY_STUDIO_GRADING = CourseWaffleFlag('legacy_studio.grading', __name__) - - -def use_new_grading_page(course_key): - """ - Returns a boolean if new studio grading mfe is enabled - """ - return not LEGACY_STUDIO_GRADING.is_enabled(course_key) - - -# .. toggle_name: legacy_studio.import -# .. toggle_implementation: WaffleFlag -# .. toggle_default: False -# .. toggle_description: Temporarily fall back to the old Course Import page. -# .. toggle_use_cases: temporary -# .. toggle_creation_date: 2025-03-14 -# .. toggle_target_removal_date: 2025-09-14 -# .. toggle_tickets: https://github.com/openedx/edx-platform/issues/36275 -# .. toggle_warning: In Ulmo, this toggle will be removed. Only the new (React-based) experience will be available. -LEGACY_STUDIO_IMPORT = CourseWaffleFlag('legacy_studio.import', __name__) - - -def use_new_import_page(course_key): - """ - Returns a boolean if new studio import mfe is enabled - """ - return not LEGACY_STUDIO_IMPORT.is_enabled(course_key) - - -# .. toggle_name: legacy_studio.export -# .. toggle_implementation: WaffleFlag -# .. toggle_default: False -# .. toggle_description: Temporarily fall back to the old Course Export page. -# .. toggle_use_cases: temporary -# .. toggle_creation_date: 2025-03-14 -# .. toggle_target_removal_date: 2025-09-14 -# .. toggle_tickets: https://github.com/openedx/edx-platform/issues/36275 -# .. toggle_warning: In Ulmo, this toggle will be removed. Only the new (React-based) experience will be available. -LEGACY_STUDIO_EXPORT = CourseWaffleFlag('legacy_studio.export', __name__) - - -def use_new_export_page(course_key): - """ - Returns a boolean if new studio export mfe is enabled - """ - return not LEGACY_STUDIO_EXPORT.is_enabled(course_key) - - # .. toggle_name: contentstore.new_studio_mfe.use_new_video_uploads_page # .. toggle_implementation: CourseWaffleFlag # .. toggle_default: False -# .. toggle_description: This flag enables the use of the new studio video uploads page mfe -# .. toggle_use_cases: temporary -# .. toggle_creation_date: 2023-5-15 -# .. toggle_target_removal_date: 2023-8-31 -# .. toggle_tickets: TNL-10619 -# .. toggle_warning: +# .. toggle_description: This flag enables the use of the new studio video uploads page MFE. +# Note: This page only works on edx.org or other sites that have reverse-engineered +# the edX video pipeline. It is off by default for the community. +# .. toggle_use_cases: opt_in +# .. toggle_creation_date: 2023-05-15 +# .. toggle_tickets: https://github.com/openedx/openedx-platform/issues/37972 ENABLE_NEW_STUDIO_VIDEO_UPLOADS_PAGE = CourseWaffleFlag( f'{CONTENTSTORE_NAMESPACE}.new_studio_mfe.use_new_video_uploads_page', __name__) def use_new_video_uploads_page(course_key): """ - Returns a boolean if new studio video uploads mfe is enabled + Returns a boolean if new studio video uploads MFE is enabled. + + This is off by default because the video uploads page requires the edX + video pipeline which is not available to the open source community. """ return ENABLE_NEW_STUDIO_VIDEO_UPLOADS_PAGE.is_enabled(course_key) @@ -307,63 +213,6 @@ def use_new_unit_page(course_key): return not LEGACY_STUDIO_UNIT_EDITOR.is_enabled(course_key) -# .. toggle_name: legacy_studio.course_team -# .. toggle_implementation: WaffleFlag -# .. toggle_default: False -# .. toggle_description: Temporarily fall back to the old Studio Course Team page. -# .. toggle_use_cases: temporary -# .. toggle_creation_date: 2025-03-14 -# .. toggle_target_removal_date: 2025-09-14 -# .. toggle_tickets: https://github.com/openedx/edx-platform/issues/36275 -# .. toggle_warning: In Ulmo, this toggle will be removed. Only the new (React-based) experience will be available. -LEGACY_STUDIO_COURSE_TEAM = CourseWaffleFlag('legacy_studio.course_team', __name__) - - -def use_new_course_team_page(course_key): - """ - Returns a boolean if new studio course team mfe is enabled - """ - return not LEGACY_STUDIO_COURSE_TEAM.is_enabled(course_key) - - -# .. toggle_name: legacy_studio.certificates -# .. toggle_implementation: WaffleFlag -# .. toggle_default: False -# .. toggle_description: Temporarily fall back to the old Studio Course Certificates page. -# .. toggle_use_cases: temporary -# .. toggle_creation_date: 2025-03-14 -# .. toggle_target_removal_date: 2025-09-14 -# .. toggle_tickets: https://github.com/openedx/edx-platform/issues/36275 -# .. toggle_warning: In Ulmo, this toggle will be removed. Only the new (React-based) experience will be available. -LEGACY_STUDIO_CERTIFICATES = CourseWaffleFlag('legacy_studio.certificates', __name__) - - -def use_new_certificates_page(course_key): - """ - Returns a boolean if new studio certificates mfe is enabled - """ - return not LEGACY_STUDIO_CERTIFICATES.is_enabled(course_key) - - -# .. toggle_name: legacy_studio.configurations -# .. toggle_implementation: WaffleFlag -# .. toggle_default: False -# .. toggle_description: Temporarily fall back to the old Studio Configurations page. -# .. toggle_use_cases: temporary -# .. toggle_creation_date: 2025-03-14 -# .. toggle_target_removal_date: 2025-09-14 -# .. toggle_tickets: https://github.com/openedx/edx-platform/issues/36275 -# .. toggle_warning: In Ulmo, this toggle will be removed. Only the new (React-based) experience will be available. -LEGACY_STUDIO_CONFIGURATIONS = CourseWaffleFlag('legacy_studio.configurations', __name__) - - -def use_new_group_configurations_page(course_key): - """ - Returns a boolean if new studio group configurations mfe is enabled - """ - return not LEGACY_STUDIO_CONFIGURATIONS.is_enabled(course_key) - - # .. toggle_name: contentstore.mock_video_uploads # .. toggle_implementation: WaffleFlag # .. toggle_default: False @@ -499,28 +348,6 @@ def enable_course_optimizer(course_id): return ENABLE_COURSE_OPTIMIZER.is_enabled(course_id) -# .. toggle_name: legacy_studio.logged_out_home -# .. toggle_implementation: WaffleFlag -# .. toggle_default: False -# .. toggle_description: Temporarily fall back to the old Studio "How it Works" page when unauthenticated -# .. toggle_use_cases: temporary -# .. toggle_creation_date: 2025-03-14 -# .. toggle_target_removal_date: 2025-09-14 -# .. toggle_tickets: https://github.com/openedx/edx-platform/issues/36275 -# .. toggle_warning: In Ulmo, this toggle will be removed, along with the legacy page. The only available -# behavior will be to send the user to the log-in page with a redirect to Studio Course Listing (/home). -LEGACY_STUDIO_LOGGED_OUT_HOME = WaffleFlag('legacy_studio.logged_out_home', __name__) - - -def use_legacy_logged_out_home(): - """ - Returns whether the old "how it works" page should be shown. - - If not, then we should just go to the login page w/ redirect to studio course listing. - """ - return LEGACY_STUDIO_LOGGED_OUT_HOME.is_enabled() - - # .. toggle_name: contentstore.enable_course_optimizer_check_prev_run_links # .. toggle_implementation: CourseWaffleFlag # .. toggle_default: False diff --git a/cms/djangoapps/contentstore/transcript_storage_handlers.py b/cms/djangoapps/contentstore/transcript_storage_handlers.py index 2c254eb359b3..0c8dc37faa0e 100644 --- a/cms/djangoapps/contentstore/transcript_storage_handlers.py +++ b/cms/djangoapps/contentstore/transcript_storage_handlers.py @@ -11,20 +11,22 @@ from django.utils.translation import gettext as _ from edxval.api import ( create_or_update_video_transcript, - delete_video_transcript as delete_video_transcript_source_function, get_3rd_party_transcription_plans, get_available_transcript_languages, + get_video_transcript, get_video_transcript_data, update_transcript_credentials_state_for_org, - get_video_transcript ) +from edxval.api import delete_video_transcript as delete_video_transcript_source_function from opaque_keys.edx.keys import CourseKey +from xblocks_contrib.video.exceptions import TranscriptsGenerationException from common.djangoapps.util.json_request import JsonResponse from openedx.core.djangoapps.video_config.models import VideoTranscriptEnabledFlag +from openedx.core.djangoapps.video_config.transcripts_utils import ( + Transcript, # pylint: disable=wrong-import-order +) from openedx.core.djangoapps.video_pipeline.api import update_3rd_party_transcription_service_credentials -from openedx.core.djangoapps.video_config.transcripts_utils import Transcript # lint-amnesty, pylint: disable=wrong-import-order -from xblocks_contrib.video.exceptions import TranscriptsGenerationException from .toggles import use_mock_video_uploads from .video_storage_handlers import TranscriptProvider @@ -62,7 +64,7 @@ def validate_transcript_credentials(provider, **credentials): must_have_props = ['api_key', 'username'] missing = [ - must_have_prop for must_have_prop in must_have_props if must_have_prop not in list(credentials.keys()) # lint-amnesty, pylint: disable=consider-iterating-dictionary + must_have_prop for must_have_prop in must_have_props if must_have_prop not in list(credentials.keys()) # pylint: disable=consider-iterating-dictionary ] if missing: error_message = '{missing} must be specified.'.format(missing=' and '.join(missing)) @@ -231,7 +233,7 @@ def validate_transcript_upload_data(data, files): data['language_code'] != data['new_language_code'] and data['new_language_code'] in get_available_transcript_languages(video_id=data['edx_video_id']) ): - error = _('A transcript with the "{language_code}" language code already exists.'.format( # lint-amnesty, pylint: disable=translation-of-non-string + error = _('A transcript with the "{language_code}" language code already exists.'.format( # pylint: disable=translation-of-non-string language_code=data['new_language_code'] )) elif 'file' not in files: diff --git a/cms/djangoapps/contentstore/utils.py b/cms/djangoapps/contentstore/utils.py index 779a1f218a96..4c284fb07efb 100644 --- a/cms/djangoapps/contentstore/utils.py +++ b/cms/djangoapps/contentstore/utils.py @@ -27,7 +27,6 @@ from opaque_keys import InvalidKeyError from opaque_keys.edx.keys import CourseKey, UsageKey, UsageKeyV2 from opaque_keys.edx.locator import BlockUsageLocator, LibraryContainerLocator, LibraryLocator -from openedx.core.djangoapps.video_config.services import VideoConfigService from openedx_events.content_authoring.data import DuplicatedXBlockData from openedx_events.content_authoring.signals import XBLOCK_DUPLICATED from openedx_events.learning.data import CourseNotificationData @@ -42,16 +41,7 @@ libraries_v1_enabled, libraries_v2_enabled, split_library_view_on_dashboard, - use_new_advanced_settings_page, - use_new_certificates_page, - use_new_course_team_page, - use_new_export_page, - use_new_grading_page, - use_new_group_configurations_page, - use_new_import_page, - use_new_schedule_details_page, use_new_unit_page, - use_new_video_uploads_page, ) from cms.djangoapps.models.settings.course_grading import CourseGradingModel from cms.djangoapps.models.settings.course_metadata import CourseMetadata @@ -64,11 +54,7 @@ from common.djangoapps.student import auth from common.djangoapps.student.auth import STUDIO_EDIT_ROLES, has_studio_read_access, has_studio_write_access from common.djangoapps.student.models import CourseEnrollment -from common.djangoapps.student.roles import ( - CourseInstructorRole, - CourseStaffRole, - GlobalStaff, -) +from common.djangoapps.student.roles import CourseInstructorRole, CourseStaffRole, GlobalStaff from common.djangoapps.track import contexts from common.djangoapps.util.course import get_link_for_about_page from common.djangoapps.util.date_utils import get_default_time_display @@ -94,6 +80,7 @@ from openedx.core.djangoapps.models.course_details import CourseDetails from openedx.core.djangoapps.site_configuration import helpers as configuration_helpers from openedx.core.djangoapps.site_configuration.models import SiteConfiguration +from openedx.core.djangoapps.video_config.services import VideoConfigService from openedx.core.djangoapps.xblock.api import get_component_from_usage_key from openedx.core.lib.courses import course_image_url from openedx.core.lib.html_to_text import html_to_text @@ -101,14 +88,14 @@ from openedx.features.content_type_gating.models import ContentTypeGatingConfig from openedx.features.content_type_gating.partitions import CONTENT_TYPE_GATING_SCHEME from openedx.features.course_experience.waffle import ENABLE_COURSE_ABOUT_SIDEBAR_HTML -from xmodule.course_block import DEFAULT_START_DATE # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.course_block import DEFAULT_START_DATE # pylint: disable=wrong-import-order from xmodule.data import CertificatesDisplayBehaviors from xmodule.library_tools import LegacyLibraryToolsService -from xmodule.modulestore import ModuleStoreEnum # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.exceptions import ItemNotFoundError # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore import ModuleStoreEnum # pylint: disable=wrong-import-order +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order +from xmodule.modulestore.exceptions import ItemNotFoundError # pylint: disable=wrong-import-order from xmodule.partitions.partitions_service import ( - get_all_partitions_for_course, # lint-amnesty, pylint: disable=wrong-import-order + get_all_partitions_for_course, # pylint: disable=wrong-import-order ) from xmodule.services import ConfigurationService, SettingsService, TeamsConfigurationService from xmodule.util.keys import BlockKey @@ -184,7 +171,7 @@ def _remove_instructors(course_key): try: remove_all_instructors(course_key) - except Exception as err: # lint-amnesty, pylint: disable=broad-except + except Exception as err: # pylint: disable=broad-except log.error(f"Error in deleting course groups for {course_key}: {err}") @@ -214,7 +201,7 @@ def get_lms_link_for_item(location, preview=False): query_string = urlencode(params) url_parts = list(urlparse(lms_base)) - url_parts[2] = '/courses/{course_key}/jump_to/{location}'.format( + url_parts[2] = '/courses/{course_key}/jump_to/{location}'.format( # noqa: UP032 course_key=str(location.course_key), location=str(location), ) @@ -235,7 +222,7 @@ def get_lms_link_for_certificate_web_view(course_key, mode): if lms_base is None: return None - return "//{certificate_web_base}/certificates/course/{course_id}?preview={mode}".format( + return "//{certificate_web_base}/certificates/course/{course_id}?preview={mode}".format( # noqa: UP032 certificate_web_base=lms_base, course_id=str(course_key), mode=mode @@ -309,52 +296,36 @@ def get_schedule_details_url(course_locator) -> str: """ Gets course authoring microfrontend URL for schedule and details pages view. """ - schedule_details_url = None - if use_new_schedule_details_page(course_locator): - mfe_base_url = get_course_authoring_url(course_locator) - course_mfe_url = f'{mfe_base_url}/course/{course_locator}/settings/details' - if mfe_base_url: - schedule_details_url = course_mfe_url - return schedule_details_url + mfe_base_url = get_course_authoring_url(course_locator) + course_mfe_url = f'{mfe_base_url}/course/{course_locator}/settings/details' + return course_mfe_url if mfe_base_url else None -def get_advanced_settings_url(course_locator) -> str: +def get_advanced_settings_url(course_locator) -> str | None: """ Gets course authoring microfrontend URL for advanced settings page view. """ - advanced_settings_url = None - if use_new_advanced_settings_page(course_locator): - mfe_base_url = get_course_authoring_url(course_locator) - course_mfe_url = f'{mfe_base_url}/course/{course_locator}/settings/advanced' - if mfe_base_url: - advanced_settings_url = course_mfe_url - return advanced_settings_url + mfe_base_url = get_course_authoring_url(course_locator) + course_mfe_url = f'{mfe_base_url}/course/{course_locator}/settings/advanced' + return course_mfe_url if mfe_base_url else None def get_grading_url(course_locator) -> str: """ Gets course authoring microfrontend URL for grading page view. """ - grading_url = None - if use_new_grading_page(course_locator): - mfe_base_url = get_course_authoring_url(course_locator) - course_mfe_url = f'{mfe_base_url}/course/{course_locator}/settings/grading' - if mfe_base_url: - grading_url = course_mfe_url - return grading_url + mfe_base_url = get_course_authoring_url(course_locator) + course_mfe_url = f'{mfe_base_url}/course/{course_locator}/settings/grading' + return course_mfe_url if mfe_base_url else None def get_course_team_url(course_locator) -> str: """ Gets course authoring microfrontend URL for course team page view. """ - course_team_url = None - if use_new_course_team_page(course_locator): - mfe_base_url = get_course_authoring_url(course_locator) - course_mfe_url = f'{mfe_base_url}/course/{course_locator}/course_team' - if mfe_base_url: - course_team_url = course_mfe_url - return course_team_url + mfe_base_url = get_course_authoring_url(course_locator) + course_mfe_url = f'{mfe_base_url}/course/{course_locator}/course_team' + return course_mfe_url if mfe_base_url else None def get_updates_url(course_locator) -> str: @@ -369,30 +340,22 @@ def get_updates_url(course_locator) -> str: return updates_url -def get_import_url(course_locator) -> str: +def get_import_url(course_locator) -> str | None: """ Gets course authoring microfrontend URL for import page view. """ - import_url = None - if use_new_import_page(course_locator): - mfe_base_url = get_course_authoring_url(course_locator) - course_mfe_url = f'{mfe_base_url}/course/{course_locator}/import' - if mfe_base_url: - import_url = course_mfe_url - return import_url + mfe_base_url = get_course_authoring_url(course_locator) + course_mfe_url = f'{mfe_base_url}/course/{course_locator}/import' + return course_mfe_url if mfe_base_url else None -def get_export_url(course_locator) -> str: +def get_export_url(course_locator) -> str | None: """ Gets course authoring microfrontend URL for export page view. """ - export_url = None - if use_new_export_page(course_locator): - mfe_base_url = get_course_authoring_url(course_locator) - course_mfe_url = f'{mfe_base_url}/course/{course_locator}/export' - if mfe_base_url: - export_url = course_mfe_url - return export_url + mfe_base_url = get_course_authoring_url(course_locator) + course_mfe_url = f'{mfe_base_url}/course/{course_locator}/export' + return course_mfe_url if mfe_base_url else None def get_optimizer_url(course_locator) -> str: @@ -425,11 +388,10 @@ def get_video_uploads_url(course_locator) -> str: Gets course authoring microfrontend URL for files and uploads page view. """ video_uploads_url = None - if use_new_video_uploads_page(course_locator): - mfe_base_url = get_course_authoring_url(course_locator) - course_mfe_url = f'{mfe_base_url}/course/{course_locator}/videos/' - if mfe_base_url: - video_uploads_url = course_mfe_url + mfe_base_url = get_course_authoring_url(course_locator) + course_mfe_url = f'{mfe_base_url}/course/{course_locator}/videos/' + if mfe_base_url: + video_uploads_url = course_mfe_url return video_uploads_url @@ -476,13 +438,9 @@ def get_certificates_url(course_locator) -> str: """ Gets course authoring microfrontend URL for certificates page view. """ - certificates_url = None - if use_new_certificates_page(course_locator): - mfe_base_url = get_course_authoring_url(course_locator) - course_mfe_url = f'{mfe_base_url}/course/{course_locator}/certificates' - if mfe_base_url: - certificates_url = course_mfe_url - return certificates_url + mfe_base_url = get_course_authoring_url(course_locator) + course_mfe_url = f'{mfe_base_url}/course/{course_locator}/certificates' + return course_mfe_url if mfe_base_url else None def get_textbooks_url(course_locator) -> str: @@ -501,13 +459,9 @@ def get_group_configurations_url(course_locator) -> str: """ Gets course authoring microfrontend URL for group configurations page view. """ - group_configurations_url = None - if use_new_group_configurations_page(course_locator): - mfe_base_url = get_course_authoring_url(course_locator) - course_mfe_url = f'{mfe_base_url}/course/{course_locator}/group_configurations' - if mfe_base_url: - group_configurations_url = course_mfe_url - return group_configurations_url + mfe_base_url = get_course_authoring_url(course_locator) + course_mfe_url = f'{mfe_base_url}/course/{course_locator}/group_configurations' + return course_mfe_url if mfe_base_url else None def get_custom_pages_url(course_locator) -> str: @@ -549,6 +503,17 @@ def get_taxonomy_list_url() -> str | None: return f'{mfe_base_url}/taxonomies' +def get_libraries_list_url() -> str | None: + """ + Gets course authoring microfrontend URL for libraries list view. + """ + mfe_base_url = settings.COURSE_AUTHORING_MICROFRONTEND_URL + if not mfe_base_url: + return None + + return f'{mfe_base_url}/libraries' + + def get_taxonomy_tags_widget_url(course_locator=None) -> str | None: """ Gets course authoring microfrontend URL for taxonomy tags drawer widget view. @@ -594,7 +559,7 @@ def is_currently_visible_to_students(xblock): return False # Check start date - if 'detached' not in published._class_tags and published.start is not None: # lint-amnesty, pylint: disable=protected-access + if 'detached' not in published._class_tags and published.start is not None: # pylint: disable=protected-access return datetime.now(UTC) > published.start # No start date, so it's always visible @@ -991,7 +956,7 @@ def get_subsections_in_section(): section_subsections = section.get_children() return section_subsections except AttributeError: - log.error("URL Retrieval Error: subsection {subsection} included in section {section}".format( + log.error("URL Retrieval Error: subsection {subsection} included in section {section}".format( # noqa: UP032 # pylint: disable=line-too-long section=section.location, subsection=subsection.location )) @@ -1005,7 +970,7 @@ def get_sections_in_course(): section_subsections = section.get_parent().get_children() return section_subsections except AttributeError: - log.error("URL Retrieval Error: In section {section} in course".format( + log.error("URL Retrieval Error: In section {section} in course".format( # noqa: UP032 section=section.location, )) return None @@ -1216,7 +1181,7 @@ def duplicate_block( # .. event_implemented_name: XBLOCK_DUPLICATED # .. event_type: org.openedx.content_authoring.xblock.duplicated.v1 XBLOCK_DUPLICATED.send_event( - time=datetime.now(timezone.utc), + time=datetime.now(timezone.utc), # noqa: UP017 xblock_info=DuplicatedXBlockData( usage_key=dest_block.location, block_type=dest_block.location.block_type, @@ -1319,7 +1284,7 @@ def load_services_for_studio(runtime, user): "video_config": VideoConfigService(), } - runtime._services.update(services) # lint-amnesty, pylint: disable=protected-access + runtime._services.update(services) # pylint: disable=protected-access def update_course_details(request, course_key, payload, course_block): @@ -1409,7 +1374,7 @@ def get_course_settings(request, course_key, course_block): It is used for both DRF and django views. """ - from .views.course import get_courses_accessible_to_user, _process_courses_list + from .views.course import _process_courses_list, get_courses_accessible_to_user credit_eligibility_enabled = settings.FEATURES.get('ENABLE_CREDIT_ELIGIBILITY', False) upload_asset_url = reverse_course_url('assets_handler', course_key) @@ -1489,7 +1454,7 @@ def get_course_settings(request, course_key, course_block): # if 'minimum_grade_credit' of a course is not set or 0 then # show warning message to course author. - show_min_grade_warning = False if course_block.minimum_grade_credit > 0 else True # lint-amnesty, pylint: disable=simplifiable-if-expression + show_min_grade_warning = False if course_block.minimum_grade_credit > 0 else True # pylint: disable=simplifiable-if-expression settings_context.update( { 'is_credit_course': True, @@ -1585,12 +1550,8 @@ def get_library_context(request, request_is_json=False): get_allowed_organizations_for_libraries, user_can_create_organizations, ) - from cms.djangoapps.contentstore.views.library import ( - user_can_view_create_library_button, - ) - from openedx.core.djangoapps.content_libraries.api import ( - user_can_create_library, - ) + from cms.djangoapps.contentstore.views.library import user_can_view_create_library_button + from openedx.core.djangoapps.content_libraries.api import user_can_create_library is_migrated: bool | None # None means: do not filter on is_migrated if (is_migrated_param := request.GET.get('is_migrated')) is not None: @@ -1645,10 +1606,7 @@ def get_course_context(request): It is used for both DRF and django views. """ - from cms.djangoapps.contentstore.views.course import ( - get_courses_accessible_to_user, - _process_courses_list, - ) + from cms.djangoapps.contentstore.views.course import _process_courses_list, get_courses_accessible_to_user def format_in_process_course_view(uca): """ @@ -1684,9 +1642,7 @@ def get_course_context_v2(request): # Importing here to avoid circular imports: # ImportError: cannot import name 'reverse_course_url' from partially initialized module # 'cms.djangoapps.contentstore.utils' (most likely due to a circular import) - from cms.djangoapps.contentstore.views.course import ( - get_courses_accessible_to_user, - ) + from cms.djangoapps.contentstore.views.course import get_courses_accessible_to_user def format_in_process_course_view(uca): """ @@ -1723,17 +1679,13 @@ def get_home_context(request, no_course=False): """ from cms.djangoapps.contentstore.views.course import ( + _get_course_creator_status, get_allowed_organizations, get_allowed_organizations_for_libraries, user_can_create_organizations, - _get_course_creator_status, - ) - from cms.djangoapps.contentstore.views.library import ( - user_can_view_create_library_button, - ) - from openedx.core.djangoapps.content_libraries.api import ( - user_can_create_library, ) + from cms.djangoapps.contentstore.views.library import user_can_view_create_library_button + from openedx.core.djangoapps.content_libraries.api import user_can_create_library active_courses = [] archived_courses = [] @@ -1808,23 +1760,22 @@ def get_course_videos_context(course_block, pagination_conf, course_key=None): get_transcript_credentials_state_for_org, get_transcript_preferences, ) + from openedx.core.djangoapps.video_config.models import VideoTranscriptEnabledFlag from openedx.core.djangoapps.video_config.toggles import use_xpert_translations_component - from openedx.core.djangoapps.video_config.transcripts_utils import Transcript # lint-amnesty, pylint: disable=wrong-import-order - - from .video_storage_handlers import ( - get_all_transcript_languages, - _get_index_videos, - _get_default_video_image_url + from openedx.core.djangoapps.video_config.transcripts_utils import ( + Transcript, # pylint: disable=wrong-import-order ) + from .video_storage_handlers import _get_default_video_image_url, _get_index_videos, get_all_transcript_languages + VIDEO_SUPPORTED_FILE_FORMATS = { '.mp4': 'video/mp4', '.mov': 'video/quicktime', } VIDEO_UPLOAD_MAX_FILE_SIZE_GB = 5 # Waffle switch for enabling/disabling video image upload feature - VIDEO_IMAGE_UPLOAD_ENABLED = WaffleSwitch( # lint-amnesty, pylint: disable=toggle-missing-annotation + VIDEO_IMAGE_UPLOAD_ENABLED = WaffleSwitch( # pylint: disable=toggle-missing-annotation 'videos.video_image_upload_enabled', __name__ ) @@ -1904,9 +1855,9 @@ def _get_course_index_context(request, course_key, course_block): """ from cms.djangoapps.contentstore.views.course import ( - course_outline_initial_state, _course_outline_json, _deprecated_blocks_info, + course_outline_initial_state, ) from openedx.core.djangoapps.content_staging import api as content_staging_api @@ -1959,7 +1910,7 @@ def _get_course_index_context(request, course_key, course_block): 'lms_link': lms_link, 'sections': sections, 'course_structure': course_structure, - 'initial_state': course_outline_initial_state(locator_to_show, course_structure) if locator_to_show else None, # lint-amnesty, pylint: disable=line-too-long + 'initial_state': course_outline_initial_state(locator_to_show, course_structure) if locator_to_show else None, # pylint: disable=line-too-long 'initial_user_clipboard': user_clipboard, 'rerun_notification_id': current_action.id if current_action else None, 'course_release_date': course_release_date, @@ -1989,13 +1940,13 @@ def get_container_handler_context(request, usage_key, course, xblock): # pylint It is used for both DRF and django views. """ + from cms.djangoapps.contentstore.helpers import get_parent_xblock, is_unit from cms.djangoapps.contentstore.views.component import ( - get_component_templates, - get_unit_tags, CONTAINER_TEMPLATES, LIBRARY_BLOCK_TYPES, + get_component_templates, + get_unit_tags, ) - from cms.djangoapps.contentstore.helpers import get_parent_xblock, is_unit from cms.djangoapps.contentstore.xblock_storage_handlers.view_handlers import ( add_container_page_publishing_info, create_xblock_info, @@ -2179,12 +2130,13 @@ def get_group_configurations_context(course, store): """ from cms.djangoapps.contentstore.course_group_config import ( - COHORT_SCHEME, ENROLLMENT_SCHEME, GroupConfiguration, RANDOM_SCHEME - ) - from cms.djangoapps.contentstore.views.course import ( - are_content_experiments_enabled + COHORT_SCHEME, + ENROLLMENT_SCHEME, + RANDOM_SCHEME, + GroupConfiguration, ) - from xmodule.partitions.partitions import UserPartition # lint-amnesty, pylint: disable=wrong-import-order + from cms.djangoapps.contentstore.views.course import are_content_experiments_enabled + from xmodule.partitions.partitions import UserPartition # pylint: disable=wrong-import-order course_key = course.id group_configuration_url = reverse_course_url('group_configurations_list_handler', course_key) @@ -2433,7 +2385,7 @@ def _create_or_update_container_link(created: datetime | None, xblock): """ upstream_container_key = LibraryContainerLocator.from_string(xblock.upstream) try: - lib_component = get_container(upstream_container_key).container_pk + lib_component = get_container(upstream_container_key).container_id except ObjectDoesNotExist: log.error(f"Library component not found for {upstream_container_key}") lib_component = None diff --git a/cms/djangoapps/contentstore/video_storage_handlers.py b/cms/djangoapps/contentstore/video_storage_handlers.py index d90dab5dc9e1..ac68ed5fee1d 100644 --- a/cms/djangoapps/contentstore/video_storage_handlers.py +++ b/cms/djangoapps/contentstore/video_storage_handlers.py @@ -9,15 +9,17 @@ import json import logging import os -import requests -import shutil import pathlib +import shutil import zipfile -import boto3 - from contextlib import closing from datetime import datetime, timedelta +from tempfile import NamedTemporaryFile, mkdtemp from uuid import uuid4 +from wsgiref.util import FileWrapper + +import boto3 +import requests from django.conf import settings from django.contrib.staticfiles.storage import staticfiles_storage from django.http import FileResponse, HttpResponseNotFound, StreamingHttpResponse @@ -32,13 +34,13 @@ create_video, get_3rd_party_transcription_plans, get_available_transcript_languages, - get_video_transcript_url, get_transcript_preferences, + get_video_transcript_url, get_videos_for_course, remove_transcript_preferences, remove_video_for_course, update_video_image, - update_video_status + update_video_status, ) from fs.osfs import OSFS from opaque_keys import InvalidKeyError @@ -46,24 +48,19 @@ from path import Path as path from pytz import UTC from rest_framework import status as rest_status +from rest_framework.exceptions import ValidationError from rest_framework.response import Response -from tempfile import NamedTemporaryFile, mkdtemp -from wsgiref.util import FileWrapper -from common.djangoapps.edxmako.shortcuts import render_to_response from common.djangoapps.util.json_request import JsonResponse from openedx.core.djangoapps.video_config.models import VideoTranscriptEnabledFlag from openedx.core.djangoapps.video_config.toggles import PUBLIC_VIDEO_SHARE -from openedx.core.djangoapps.video_pipeline.config.waffle import ( - DEPRECATE_YOUTUBE, - ENABLE_DEVSTACK_VIDEO_UPLOADS, -) +from openedx.core.djangoapps.video_pipeline.config.waffle import DEPRECATE_YOUTUBE, ENABLE_DEVSTACK_VIDEO_UPLOADS from openedx.core.djangoapps.waffle_utils import CourseWaffleFlag -from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order from .models import VideoUploadConfig -from .toggles import use_new_video_uploads_page, use_mock_video_uploads -from .utils import get_video_uploads_url, get_course_videos_context +from .toggles import use_mock_video_uploads +from .utils import get_video_uploads_url from .video_utils import validate_video_image from .views.course import get_course_and_check_access @@ -73,14 +70,14 @@ WAFFLE_NAMESPACE = 'videos' # Waffle switch for enabling/disabling video image upload feature -VIDEO_IMAGE_UPLOAD_ENABLED = WaffleSwitch( # lint-amnesty, pylint: disable=toggle-missing-annotation +VIDEO_IMAGE_UPLOAD_ENABLED = WaffleSwitch( # pylint: disable=toggle-missing-annotation f'{WAFFLE_NAMESPACE}.video_image_upload_enabled', __name__ ) # Waffle flag namespace for studio WAFFLE_STUDIO_FLAG_NAMESPACE = 'studio' -ENABLE_VIDEO_UPLOAD_PAGINATION = CourseWaffleFlag( # lint-amnesty, pylint: disable=toggle-missing-annotation +ENABLE_VIDEO_UPLOAD_PAGINATION = CourseWaffleFlag( # pylint: disable=toggle-missing-annotation f'{WAFFLE_STUDIO_FLAG_NAMESPACE}.enable_video_upload_pagination', __name__ ) # Default expiration, in seconds, of one-time URLs used for uploading videos. @@ -236,11 +233,34 @@ def send_zip(zip_file, size=None): """ wrapper = FileWrapper(zip_file, settings.COURSE_EXPORT_DOWNLOAD_CHUNK_SIZE) response = StreamingHttpResponse(wrapper, content_type='application/zip') - response['Content-Dispositon'] = 'attachment; filename=%s' % os.path.basename(zip_file.name) + response['Content-Dispositon'] = 'attachment; filename=%s' % os.path.basename(zip_file.name) # noqa: UP031 response['Content-Length'] = size return response +def get_course_video_download_urls(course_key_string): + """ + Return the set of encoded-video URLs that legitimately belong to the given + course, as recorded in VAL. + + The video download endpoint only ever needs to fetch URLs that were already + surfaced to the client by the video listing. Restricting fetches to this set + prevents server-side request forgery (SSRF) via attacker-supplied URLs. + """ + videos, __ = get_videos_for_course( + course_key_string, + VideoSortField.created, + SortDirection.desc, + None, + ) + return { + encoding['url'] + for video in videos + for encoding in video['encoded_videos'] + if encoding.get('url') + } + + def create_video_zip(course_key_string, files): """ Generates the video zip, or returns None if there was an error. @@ -249,10 +269,17 @@ def create_video_zip(course_key_string, files): """ name = course_key_string + '_videos' video_folder_zip = NamedTemporaryFile(prefix=name + '_', - suffix=".zip") # lint-amnesty, pylint: disable=consider-using-with + suffix=".zip") # pylint: disable=consider-using-with root_dir = path(mkdtemp()) video_dir = root_dir + '/' + name zip_folder = None + # Only allow fetching URLs that belong to this course's videos. Anything + # else (internal services, cloud metadata endpoints, arbitrary hosts) is a + # potential SSRF target and is rejected before any request is made. + allowed_urls = get_course_video_download_urls(course_key_string) + for file in files: + if file['url'] not in allowed_urls: + raise ValidationError(f"Invalid video download url: {file['url']}") try: for file in files: url = file['url'] @@ -389,7 +416,7 @@ def validate_transcript_preferences(provider, cielo24_fidelity, cielo24_turnarou # validate transcription providers transcription_plans = get_3rd_party_transcription_plans() - if provider in list(transcription_plans.keys()): # lint-amnesty, pylint: disable=consider-iterating-dictionary + if provider in list(transcription_plans.keys()): # pylint: disable=consider-iterating-dictionary # Further validations for providers if provider == TranscriptProvider.CIELO24: @@ -740,13 +767,7 @@ def videos_index_html(course, pagination_conf=None): """ Returns an HTML page to display previous video uploads and allow new ones """ - if use_new_video_uploads_page(course.id): - return redirect(get_video_uploads_url(course.id)) - context = get_course_videos_context( - course, - pagination_conf, - ) - return render_to_response('videos_index.html', context) + return redirect(get_video_uploads_url(course.id)) def videos_index_json(course): @@ -821,7 +842,7 @@ def videos_post(course, request): try: file_name.encode('ascii') except UnicodeEncodeError: - error_msg = 'The file name for %s must contain only ASCII characters.' % file_name + error_msg = 'The file name for %s must contain only ASCII characters.' % file_name # noqa: UP031 return {'error': error_msg}, 400 edx_video_id = str(uuid4()) @@ -971,10 +992,10 @@ def get_course_youtube_edx_video_ids(course_id): """ Get a list of youtube edx_video_ids """ - invalid_key_error_msg = "Invalid course_key: '%s'." % course_id - unexpected_error_msg = "Unexpected error occurred for course_id: '%s'." % course_id + invalid_key_error_msg = "Invalid course_key: '%s'." % course_id # noqa: UP031 + unexpected_error_msg = "Unexpected error occurred for course_id: '%s'." % course_id # noqa: UP031 - try: # lint-amnesty, pylint: disable=too-many-nested-blocks + try: # pylint: disable=too-many-nested-blocks course_key = CourseKey.from_string(course_id) course = modulestore().get_course(course_key) diff --git a/cms/djangoapps/contentstore/video_utils.py b/cms/djangoapps/contentstore/video_utils.py index 4681b2d98595..f60cdbb31df9 100644 --- a/cms/djangoapps/contentstore/video_utils.py +++ b/cms/djangoapps/contentstore/video_utils.py @@ -87,7 +87,7 @@ def download_youtube_video_thumbnail(youtube_id): thumbnail_content = thumbnail_content_type = None # Download highest resolution thumbnail available. for thumbnail_quality in YOUTUBE_THUMBNAIL_SIZES: - thumbnail_url = urljoin('https://img.youtube.com', '/vi/{youtube_id}/{thumbnail_quality}.jpg'.format( + thumbnail_url = urljoin('https://img.youtube.com', '/vi/{youtube_id}/{thumbnail_quality}.jpg'.format( # noqa: UP032 # pylint: disable=line-too-long youtube_id=youtube_id, thumbnail_quality=thumbnail_quality )) response = requests.get(thumbnail_url) @@ -115,7 +115,7 @@ def validate_and_update_video_image(course_key_string, edx_video_id, image_file, update_video_image(edx_video_id, course_key_string, image_file, image_filename) LOGGER.info( - 'VIDEOS: Scraping youtube video thumbnail for edx_video_id [%s] in course [%s]', edx_video_id, course_key_string # lint-amnesty, pylint: disable=line-too-long + 'VIDEOS: Scraping youtube video thumbnail for edx_video_id [%s] in course [%s]', edx_video_id, course_key_string # pylint: disable=line-too-long ) diff --git a/cms/djangoapps/contentstore/views/__init__.py b/cms/djangoapps/contentstore/views/__init__.py index ba87c54d38c0..95f176180b8d 100644 --- a/cms/djangoapps/contentstore/views/__init__.py +++ b/cms/djangoapps/contentstore/views/__init__.py @@ -1,25 +1,25 @@ "All view functions for contentstore, broken out into submodules" -from .assets import * -from .checklists import * -from .component import * -from .course import * # lint-amnesty, pylint: disable=redefined-builtin -from .entrance_exam import * -from .error import * -from .export_git import * -from .helpers import * -from .import_export import * -from .block import * -from .library import * -from .preview import * -from .public import * -from .tabs import * -from .transcript_settings import * -from .transcripts_ajax import * -from .user import * -from .videos import * +from .assets import * # noqa: F403 +from .block import * # noqa: F403 +from .checklists import * # noqa: F403 +from .component import * # noqa: F403 +from .course import * # pylint: disable=redefined-builtin # noqa: F403 +from .entrance_exam import * # noqa: F403 +from .error import * # noqa: F403 +from .export_git import * # noqa: F403 +from .helpers import * # noqa: F403 +from .import_export import * # noqa: F403 +from .library import * # noqa: F403 +from .preview import * # noqa: F403 +from .public import * # noqa: F403 +from .tabs import * # noqa: F403 +from .transcript_settings import * # noqa: F403 +from .transcripts_ajax import * # noqa: F403 +from .user import * # noqa: F403 +from .videos import * # noqa: F403 try: - from .dev import * + from .dev import * # noqa: F403 except ImportError: pass diff --git a/cms/djangoapps/contentstore/views/assets.py b/cms/djangoapps/contentstore/views/assets.py index c9ae16a1402c..beb378e8a759 100644 --- a/cms/djangoapps/contentstore/views/assets.py +++ b/cms/djangoapps/contentstore/views/assets.py @@ -3,15 +3,14 @@ from django.contrib.auth.decorators import login_required from django.views.decorators.csrf import ensure_csrf_cookie + +from cms.djangoapps.contentstore.asset_storage_handlers import delete_asset as delete_asset_source_function +from cms.djangoapps.contentstore.asset_storage_handlers import get_asset_json as get_asset_json_source_function +from cms.djangoapps.contentstore.asset_storage_handlers import get_asset_usage_path_json, handle_assets +from cms.djangoapps.contentstore.asset_storage_handlers import get_file_size as get_file_size_source_function +from cms.djangoapps.contentstore.asset_storage_handlers import update_asset as update_asset_source_function from cms.djangoapps.contentstore.asset_storage_handlers import ( - handle_assets, - get_asset_usage_path_json, update_course_run_asset as update_course_run_asset_source_function, - get_file_size as get_file_size_source_function, - delete_asset as delete_asset_source_function, - get_asset_json as get_asset_json_source_function, - update_asset as update_asset_source_function, - ) __all__ = ['assets_handler', 'asset_usage_path_handler'] diff --git a/cms/djangoapps/contentstore/views/block.py b/cms/djangoapps/contentstore/views/block.py index b57042085df2..b2c0e39df77c 100644 --- a/cms/djangoapps/contentstore/views/block.py +++ b/cms/djangoapps/contentstore/views/block.py @@ -12,54 +12,38 @@ from django.views.decorators.clickjacking import xframe_options_exempt from django.views.decorators.http import require_http_methods from opaque_keys.edx.keys import CourseKey +from openedx_authz.constants.permissions import COURSES_VIEW_COURSE from web_fragments.fragment import Fragment from cms.djangoapps.contentstore.utils import load_services_for_studio +from cms.djangoapps.contentstore.xblock_storage_handlers.view_handlers import ( + create_xblock_info, + delete_orphans, + get_block_info, + get_xblock, + handle_xblock, +) +from cms.djangoapps.contentstore.xblock_storage_handlers.xblock_helpers import get_tags_count, usage_key_with_run from cms.lib.xblock.authoring_mixin import VISIBILITY_VIEW from common.djangoapps.edxmako.shortcuts import render_to_response, render_to_string -from common.djangoapps.student.auth import ( - has_studio_read_access, - has_studio_write_access, -) +from common.djangoapps.student.auth import has_studio_read_access, has_studio_write_access from common.djangoapps.util.json_request import JsonResponse, expect_json -from openedx.core.lib.xblock_utils import ( - hash_resource, - request_token, - wrap_xblock, - wrap_xblock_aside, -) -from xmodule.modulestore.django import ( - modulestore, -) # lint-amnesty, pylint: disable=wrong-import-order +from openedx.core.djangoapps.authz.constants import LegacyAuthoringPermission +from openedx.core.djangoapps.authz.decorators import user_has_course_permission from openedx.core.djangoapps.content_tagging.toggles import is_tagging_feature_disabled - -from xmodule.x_module import ( +from openedx.core.lib.xblock_utils import hash_resource, request_token, wrap_xblock, wrap_xblock_aside +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order +from xmodule.x_module import ( # pylint: disable=wrong-import-order AUTHOR_VIEW, PREVIEW_VIEWS, STUDENT_VIEW, STUDIO_VIEW, -) # lint-amnesty, pylint: disable=wrong-import-order - - -from ..helpers import ( - is_unit, -) -from .preview import get_preview_fragment -from .component import _get_item_in_course -from ..utils import get_container_handler_context - -from cms.djangoapps.contentstore.xblock_storage_handlers.view_handlers import ( - handle_xblock, - create_xblock_info, - get_block_info, - get_xblock, - delete_orphans, -) -from cms.djangoapps.contentstore.xblock_storage_handlers.xblock_helpers import ( - usage_key_with_run, - get_tags_count, ) +from ..helpers import is_unit +from ..utils import get_container_handler_context +from .component import _get_item_in_course +from .preview import get_preview_fragment __all__ = [ "orphan_handler", @@ -348,7 +332,12 @@ def xblock_outline_handler(request, usage_key_string): a course. """ usage_key = usage_key_with_run(usage_key_string) - if not has_studio_read_access(request.user, usage_key.course_key): + if not user_has_course_permission( + request.user, + COURSES_VIEW_COURSE.identifier, + usage_key.course_key, + LegacyAuthoringPermission.READ, + ): raise PermissionDenied() response_format = request.GET.get("format", "html") diff --git a/cms/djangoapps/contentstore/views/certificate_manager.py b/cms/djangoapps/contentstore/views/certificate_manager.py index 081afdcc0dd7..0c36762f8967 100644 --- a/cms/djangoapps/contentstore/views/certificate_manager.py +++ b/cms/djangoapps/contentstore/views/certificate_manager.py @@ -6,16 +6,15 @@ from django.conf import settings from django.utils.translation import gettext as _ - -from common.djangoapps.course_modes.models import CourseMode from eventtracking import tracker from opaque_keys import InvalidKeyError from opaque_keys.edx.keys import AssetKey -from .assets import delete_asset +from common.djangoapps.course_modes.models import CourseMode from common.djangoapps.util.db import MYSQL_MAX_INT, generate_int_id from ..exceptions import AssetNotFoundException +from .assets import delete_asset CERTIFICATE_SCHEMA_VERSION = 1 CERTIFICATE_MINIMUM_ID = 100 @@ -27,14 +26,14 @@ class CertificateException(Exception): """ Base exception for Certificates workflows """ - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass class CertificateValidationError(CertificateException): """ An exception raised when certificate information is invalid. """ - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass def _delete_asset(course_key, asset_key_string): @@ -89,7 +88,7 @@ def parse(json_string): try: certificate = json.loads(json_string) except ValueError: - raise CertificateValidationError(_("invalid JSON")) # lint-amnesty, pylint: disable=raise-missing-from + raise CertificateValidationError(_("invalid JSON")) # pylint: disable=raise-missing-from # noqa: B904 # Include the data contract version certificate["version"] = CERTIFICATE_SCHEMA_VERSION # Ensure a signatories list is always returned @@ -156,7 +155,7 @@ def assign_id(course, certificate_data, certificate_id=None): used_ids ) - for index, signatory in enumerate(certificate_data['signatories']): # pylint: disable=unused-variable + for index, signatory in enumerate(certificate_data['signatories']): # pylint: disable=unused-variable # noqa: B007 if signatory and not signatory.get('id', False): signatory['id'] = generate_int_id(used_ids=used_ids) used_ids.append(signatory['id']) @@ -252,7 +251,7 @@ def remove_certificate(request, store, course, certificate_id): if int(cert['id']) == int(certificate_id): certificate = course.certificates['certificates'][index] # Remove any signatory assets prior to dropping the entire cert record from the course - for sig_index, signatory in enumerate(certificate.get('signatories')): # pylint: disable=unused-variable + for sig_index, signatory in enumerate(certificate.get('signatories')): # pylint: disable=unused-variable # noqa: B007 _delete_asset(course.id, signatory['signature_image_path']) # Now drop the certificate record course.certificates['certificates'].pop(index) @@ -265,7 +264,7 @@ def remove_signatory(request, store, course, certificate_id, signatory_id): """ Remove the specified signatory from the provided course certificate """ - for cert_index, cert in enumerate(course.certificates['certificates']): # pylint: disable=unused-variable + for cert_index, cert in enumerate(course.certificates['certificates']): # pylint: disable=unused-variable # noqa: B007 if int(cert['id']) == int(certificate_id): for sig_index, signatory in enumerate(cert.get('signatories')): if int(signatory_id) == int(signatory['id']): diff --git a/cms/djangoapps/contentstore/views/certificates.py b/cms/djangoapps/contentstore/views/certificates.py index 50039cf00d08..08da2de77d39 100644 --- a/cms/djangoapps/contentstore/views/certificates.py +++ b/cms/djangoapps/contentstore/views/certificates.py @@ -29,35 +29,27 @@ from django.core.exceptions import PermissionDenied from django.http import HttpResponse from django.shortcuts import redirect -from django.utils.translation import gettext as _ from django.utils.decorators import method_decorator +from django.utils.translation import gettext as _ from django.views.decorators.csrf import ensure_csrf_cookie from django.views.decorators.http import require_http_methods -from rest_framework.views import APIView +from opaque_keys.edx.keys import CourseKey +from rest_framework import status from rest_framework.permissions import IsAuthenticated from rest_framework.response import Response -from rest_framework import status -from opaque_keys.edx.keys import CourseKey +from rest_framework.views import APIView -from openedx.core.lib.api.view_utils import DeveloperErrorViewMixin -from common.djangoapps.edxmako.shortcuts import render_to_response +from cms.djangoapps.contentstore.views.permissions import HasStudioWriteAccess +from cms.djangoapps.contentstore.views.serializers import CertificateActivationSerializer, CertificateSerializer from common.djangoapps.student.auth import has_studio_write_access from common.djangoapps.student.roles import GlobalStaff - from common.djangoapps.util.json_request import JsonResponse -from xmodule.modulestore import EdxJSONEncoder # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order - -from cms.djangoapps.contentstore.views.serializers import CertificateActivationSerializer, CertificateSerializer -from cms.djangoapps.contentstore.views.permissions import HasStudioWriteAccess +from openedx.core.lib.api.view_utils import DeveloperErrorViewMixin +from xmodule.modulestore import EdxJSONEncoder # pylint: disable=wrong-import-order +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order +from ..utils import get_certificates_url, reverse_course_url from .certificate_manager import CertificateManager, CertificateValidationError -from ..toggles import use_new_certificates_page -from ..utils import ( - get_certificates_context, - get_certificates_url, - reverse_course_url, -) CERTIFICATE_MINIMUM_ID = 100 @@ -149,10 +141,7 @@ def certificates_list_handler(request, course_key_string): return JsonResponse({"error": msg}, status=403) if 'text/html' in request.META.get('HTTP_ACCEPT', 'text/html'): - if use_new_certificates_page(course_key): - return redirect(get_certificates_url(course_key)) - certificates_context = get_certificates_context(course, request.user) - return render_to_response('certificates.html', certificates_context) + return redirect(get_certificates_url(course_key)) elif "application/json" in request.META.get('HTTP_ACCEPT'): # Retrieve the list of certificates for the specified course if request.method == 'GET': @@ -298,7 +287,7 @@ def signatory_detail_handler(request, course_key_string, certificate_id, signato match_cert = None # pylint: disable=unused-variable - for index, cert in enumerate(certificates_list): + for index, cert in enumerate(certificates_list): # noqa: B007 if certificate_id is not None: if int(cert['id']) == int(certificate_id): match_cert = cert diff --git a/cms/djangoapps/contentstore/views/checklists.py b/cms/djangoapps/contentstore/views/checklists.py index eb5c651a3da3..fa8e4856e2d4 100644 --- a/cms/djangoapps/contentstore/views/checklists.py +++ b/cms/djangoapps/contentstore/views/checklists.py @@ -1,4 +1,4 @@ -# lint-amnesty, pylint: disable=missing-module-docstring +# pylint: disable=missing-module-docstring from django.conf import settings from django.contrib.auth.decorators import login_required from django.core.exceptions import PermissionDenied diff --git a/cms/djangoapps/contentstore/views/component.py b/cms/djangoapps/contentstore/views/component.py index fbd29a89d1b7..c30eb49b9529 100644 --- a/cms/djangoapps/contentstore/views/component.py +++ b/cms/djangoapps/contentstore/views/component.py @@ -21,26 +21,18 @@ from xblock.plugin import PluginMissingError from xblock.runtime import Mixologist +from cms.djangoapps.contentstore.helpers import get_parent_if_split_test, is_library_content, is_unit +from cms.djangoapps.contentstore.toggles import libraries_v1_enabled, libraries_v2_enabled, use_new_unit_page +from cms.djangoapps.contentstore.xblock_storage_handlers.view_handlers import load_services_for_studio from common.djangoapps.edxmako.shortcuts import render_to_response from common.djangoapps.student.auth import has_course_author_access from common.djangoapps.xblock_django.api import authorable_xblocks, disabled_xblocks from common.djangoapps.xblock_django.models import XBlockStudioConfigurationFlag -from cms.djangoapps.contentstore.helpers import ( - get_parent_if_split_test, - is_unit, - is_library_content, -) -from cms.djangoapps.contentstore.toggles import ( - libraries_v1_enabled, - libraries_v2_enabled, - use_new_unit_page, -) -from cms.djangoapps.contentstore.xblock_storage_handlers.view_handlers import load_services_for_studio -from openedx.core.lib.xblock_utils import get_aside_from_xblock, is_xblock_aside -from openedx.core.djangoapps.discussions.models import DiscussionsConfiguration from openedx.core.djangoapps.content_tagging.api import get_object_tags -from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.exceptions import ItemNotFoundError # lint-amnesty, pylint: disable=wrong-import-order +from openedx.core.djangoapps.discussions.models import DiscussionsConfiguration +from openedx.core.lib.xblock_utils import get_aside_from_xblock, is_xblock_aside +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order +from xmodule.modulestore.exceptions import ItemNotFoundError # pylint: disable=wrong-import-order __all__ = [ 'container_handler', @@ -63,7 +55,7 @@ 'drag-and-drop-v2', ] -BETA_COMPONENT_TYPES = ['library_v2', 'itembank'] +BETA_COMPONENT_TYPES = [] ADVANCED_COMPONENT_TYPES = sorted({name for name, class_ in XBlock.load_classes()} - set(COMPONENT_TYPES)) @@ -154,7 +146,7 @@ def container_handler(request, usage_key_string): # pylint: disable=too-many-st try: usage_key = UsageKey.from_string(usage_key_string) except InvalidKeyError: # Raise Http404 on invalid 'usage_key_string' - raise Http404 # lint-amnesty, pylint: disable=raise-missing-from + raise Http404 # pylint: disable=raise-missing-from # noqa: B904 with modulestore().bulk_operations(usage_key.course_key): try: course, xblock, lms_link, preview_lms_link = _get_item_in_course(request, usage_key) @@ -202,13 +194,13 @@ def container_embed_handler(request, usage_key_string): # pylint: disable=too-m try: course, xblock, lms_link, preview_lms_link = _get_item_in_course(request, usage_key) except ItemNotFoundError: - raise Http404 # lint-amnesty, pylint: disable=raise-missing-from + raise Http404 # pylint: disable=raise-missing-from # noqa: B904 container_handler_context = get_container_handler_context(request, usage_key, course, xblock) return render_to_response('container_chromeless.html', container_handler_context) -def get_component_templates(courselike, library=False): # lint-amnesty, pylint: disable=too-many-statements +def get_component_templates(courselike, library=False): # pylint: disable=too-many-statements """ Returns the applicable component templates that can be used by the specified course or library. """ @@ -315,7 +307,7 @@ def create_support_legend_dict(): # Content Libraries currently don't allow opting in to unsupported xblocks/problem types. allow_unsupported = getattr(courselike, "allow_unsupported_xblocks", False) - for category in component_types: # lint-amnesty, pylint: disable=too-many-nested-blocks + for category in component_types: # pylint: disable=too-many-nested-blocks authorable_variations = authorable_xblocks(allow_unsupported=allow_unsupported, name=category) support_level_without_template = component_support_level(authorable_variations, category) templates_for_category = [] @@ -358,7 +350,7 @@ def create_support_legend_dict(): templates_for_category.append( create_template_dict( - _(template['metadata'].get('display_name')), # lint-amnesty, pylint: disable=translation-of-non-string + _(template['metadata'].get('display_name')), # pylint: disable=translation-of-non-string category, support_level_with_template, template_id, @@ -588,7 +580,7 @@ def component_handler(request, usage_key_string, handler, suffix=''): resp = handler_block.handle(handler, req, suffix) except NoSuchHandlerError: log.info("XBlock %s attempted to access missing handler %r", handler_block, handler, exc_info=True) - raise Http404 # lint-amnesty, pylint: disable=raise-missing-from + raise Http404 # pylint: disable=raise-missing-from # noqa: B904 # unintentional update to handle any side effects of handle call # could potentially be updating actual course data or simply caching its values @@ -614,7 +606,7 @@ def get_unit_tags(usage_key): Get the tags of a Unit and build a json to be read by the UI Note: When migrating the `TagList` subview from `container_subview.js` to the course-authoring MFE, - this function can be simplified to use the REST API of openedx-learning, + this function can be simplified to use the REST API of openedx_tagging, which already provides this grouping + sorting logic. """ # Get content tags from content tagging API diff --git a/cms/djangoapps/contentstore/views/course.py b/cms/djangoapps/contentstore/views/course.py index bf2cd9cb83d6..569871b95bea 100644 --- a/cms/djangoapps/contentstore/views/course.py +++ b/cms/djangoapps/contentstore/views/course.py @@ -7,19 +7,15 @@ import random import re import string -from typing import Dict +from typing import Dict # noqa: UP035 import django.utils from ccx_keys.locator import CCXLocator from django.conf import settings from django.contrib.auth import get_user_model from django.contrib.auth.decorators import login_required -from django.core.exceptions import ( - FieldError, - ImproperlyConfigured, - PermissionDenied, - ValidationError as DjangoValidationError, -) +from django.core.exceptions import FieldError, ImproperlyConfigured, PermissionDenied +from django.core.exceptions import ValidationError as DjangoValidationError from django.db.models import QuerySet from django.http import Http404, HttpResponse, HttpResponseBadRequest, HttpResponseNotFound from django.shortcuts import redirect @@ -27,91 +23,94 @@ from django.utils.translation import gettext as _ from django.views.decorators.csrf import ensure_csrf_cookie from django.views.decorators.http import require_GET, require_http_methods -from drf_spectacular.utils import extend_schema, OpenApiParameter, OpenApiRequest, OpenApiResponse +from drf_spectacular.utils import OpenApiParameter, OpenApiRequest, OpenApiResponse, extend_schema from edx_django_utils.monitoring import function_trace from opaque_keys import InvalidKeyError from opaque_keys.edx.keys import CourseKey from opaque_keys.edx.locator import BlockUsageLocator +from openedx_authz.api import get_scopes_for_user_and_permission +from openedx_authz.api.data import CourseOverviewData, OrgCourseOverviewGlobData, ScopeData +from openedx_authz.constants.permissions import ( + COURSES_MANAGE_COURSE_UPDATES, + COURSES_MANAGE_GROUP_CONFIGURATIONS, + COURSES_MANAGE_PAGES_AND_RESOURCES, + COURSES_PUBLISH_COURSE_CONTENT, + COURSES_VIEW_COURSE, + COURSES_VIEW_COURSE_UPDATES, + COURSES_VIEW_PAGES_AND_RESOURCES, +) from organizations.api import add_organization_course, ensure_organization from organizations.exceptions import InvalidOrganizationException -from rest_framework.exceptions import ValidationError +from organizations.models import Organization from rest_framework.decorators import api_view -from openedx.core.lib.api.view_utils import view_auth_classes +from rest_framework.exceptions import ValidationError +from cms.djangoapps.contentstore.api.views.utils import get_bool_param from cms.djangoapps.contentstore.xblock_storage_handlers.view_handlers import create_xblock_info -from cms.djangoapps.course_creators.views import add_user_with_status_unrequested, get_course_creator_status from cms.djangoapps.course_creators.models import CourseCreator +from cms.djangoapps.course_creators.views import add_user_with_status_unrequested, get_course_creator_status from cms.djangoapps.models.settings.course_grading import CourseGradingModel from cms.djangoapps.models.settings.course_metadata import CourseMetadata from cms.djangoapps.models.settings.encoder import CourseSettingsEncoder from cms.djangoapps.modulestore_migrator.data import ModulestoreMigration -from cms.djangoapps.contentstore.api.views.utils import get_bool_param from common.djangoapps.course_action_state.managers import CourseActionStateItemNotFoundError from common.djangoapps.course_action_state.models import CourseRerunState, CourseRerunUIStateManager from common.djangoapps.edxmako.shortcuts import render_to_response from common.djangoapps.student.auth import ( - has_course_author_access, + has_studio_advanced_settings_access, has_studio_read_access, has_studio_write_access, - has_studio_advanced_settings_access, is_content_creator, ) from common.djangoapps.student.roles import ( CourseInstructorRole, CourseStaffRole, GlobalStaff, - UserBasedRole, OrgStaffRole, + UserBasedRole, strict_role_checking, ) from common.djangoapps.util.json_request import JsonResponse, JsonResponseBadRequest, expect_json from common.djangoapps.util.string_utils import _has_non_ascii_characters +from openedx.core import toggles as core_toggles +from openedx.core.djangoapps.authz.constants import LegacyAuthoringPermission +from openedx.core.djangoapps.authz.decorators import user_has_course_permission from openedx.core.djangoapps.content.course_overviews.models import CourseOverview from openedx.core.djangoapps.credit.tasks import update_credit_course_requirements from openedx.core.djangoapps.models.course_details import CourseDetails -from openedx.core.djangoapps.site_configuration import helpers as configuration_helpers from openedx.core.djangolib.js_utils import dump_js_escaped_json +from openedx.core.lib.api.view_utils import view_auth_classes from openedx.core.lib.course_tabs import CourseTabPluginManager -from organizations.models import Organization -from xmodule.course_block import CourseBlock, CourseFields # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.error_block import ErrorBlock # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore import EdxJSONEncoder # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.exceptions import DuplicateCourseError # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.tabs import CourseTab, CourseTabList, InvalidTabsException # lint-amnesty, pylint: disable=wrong-import-order - -from ..course_group_config import ( - COHORT_SCHEME, - RANDOM_SCHEME, - GroupConfiguration, - GroupConfigurationsValidationError +from xmodule.course_block import CourseBlock, CourseFields # pylint: disable=wrong-import-order +from xmodule.error_block import ErrorBlock # pylint: disable=wrong-import-order +from xmodule.modulestore import EdxJSONEncoder # pylint: disable=wrong-import-order +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order +from xmodule.modulestore.exceptions import DuplicateCourseError # pylint: disable=wrong-import-order +from xmodule.tabs import ( # pylint: disable=wrong-import-order + CourseTab, + CourseTabList, + InvalidTabsException, ) + +from ..course_group_config import COHORT_SCHEME, RANDOM_SCHEME, GroupConfiguration, GroupConfigurationsValidationError from ..course_info_model import delete_course_update, get_course_updates, update_course_updates from ..courseware_index import CoursewareSearchIndexer, SearchIndexingError from ..tasks import rerun_course as rerun_course_task from ..toggles import ( default_enable_flexible_peer_openassessments, - use_new_advanced_settings_page, - use_new_grading_page, - use_new_group_configurations_page, - use_new_schedule_details_page ) from ..utils import ( add_instructor, get_advanced_settings_url, - get_course_grading, get_course_outline_url, get_course_rerun_context, - get_course_settings, get_grading_url, - get_group_configurations_context, get_group_configurations_url, get_lms_link_for_item, - get_proctored_exam_settings_url, get_schedule_details_url, get_studio_home_url, - get_updates_url, get_textbooks_url, + get_updates_url, initialize_permissions, remove_all_instructors, reverse_course_url, @@ -144,25 +143,51 @@ class AccessListFallback(Exception): An exception that is raised whenever we need to `fall back` to fetching *all* courses available to a user, rather than using a shorter method (i.e. fetching by group) """ - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass -def get_course_and_check_access(course_key, user, depth=0): +def _get_course_block(course_key, depth=0): """ Function used to calculate and return the locator and course block for the view functions in this file. """ - if not has_studio_read_access(user, course_key): - raise PermissionDenied() course_block = modulestore().get_course(course_key, depth=depth) return course_block +def get_course_and_check_access(course_key, user, depth=0): + """ + Function used to validate permission and return a course block + for the view functions in this file. + """ + if not has_studio_read_access(user, course_key): + raise PermissionDenied() + return _get_course_block(course_key, depth) + +def get_course_and_check_manage_group_configurations_access(course_key, user, depth=0): + """ + Function used to validate permission and return a course block + for the view functions for group configurations in this file. + """ + if not user_has_course_permission( + user=user, + authz_permission=COURSES_MANAGE_GROUP_CONFIGURATIONS.identifier, + course_key=course_key, + legacy_permission=LegacyAuthoringPermission.READ + ): + raise PermissionDenied() + return _get_course_block(course_key, depth) + def reindex_course_and_check_access(course_key, user): """ Internal method used to restart indexing on a course. """ - if not has_course_author_access(user, course_key): + if not user_has_course_permission( + user=user, + authz_permission=COURSES_PUBLISH_COURSE_CONTENT.identifier, + course_key=course_key, + legacy_permission=LegacyAuthoringPermission.WRITE + ): raise PermissionDenied() return CoursewareSearchIndexer.do_course_reindex(modulestore(), course_key) @@ -305,7 +330,7 @@ def course_handler(request, course_key_string=None): else: return HttpResponseNotFound() except InvalidKeyError: - raise Http404 # lint-amnesty, pylint: disable=raise-missing-from + raise Http404 # pylint: disable=raise-missing-from # noqa: B904 @login_required @@ -338,10 +363,13 @@ def course_search_index_handler(request, course_key_string): html: return status of indexing task json: return status of indexing task """ - # Only global staff (PMs) are able to index courses - if not GlobalStaff().has_user(request.user): - raise PermissionDenied() course_key = CourseKey.from_string(course_key_string) + is_authz_enabled = core_toggles.AUTHZ_COURSE_AUTHORING_FLAG.is_enabled(course_key) + if not is_authz_enabled and not GlobalStaff().has_user(request.user): + # When AuthZ is disabled, restrict to global staff (legacy behavior). + # When AuthZ is enabled, access control is enforced by the AuthZ layer, + # which includes staff/superuser checks and course-level permissions. + raise PermissionDenied() content_type = request.META.get('CONTENT_TYPE', None) if content_type is None: content_type = "application/json; charset=utf-8" @@ -368,7 +396,7 @@ def _course_outline_json(request, course_block): return create_xblock_info( course_block, include_child_info=True, - course_outline=False if is_concise else True, # lint-amnesty, pylint: disable=simplifiable-if-expression + course_outline=False if is_concise else True, # pylint: disable=simplifiable-if-expression include_children_predicate=include_children_predicate, is_concise=is_concise, user=request.user @@ -385,7 +413,9 @@ def get_in_process_course_actions(request): exclude_args={'state': CourseRerunUIStateManager.State.SUCCEEDED}, should_display=True, ) - if has_studio_read_access(request.user, course.course_key) + if user_has_course_permission( + request.user, COURSES_VIEW_COURSE.identifier, course.course_key, LegacyAuthoringPermission.READ + ) ] @@ -750,26 +780,214 @@ def course_index(request, course_key): return redirect(get_course_outline_url(course_key, block_to_show)) +def _apply_course_query_filters(request, courses): + """Applies all query filters to the given courses queryset. + This includes filtering by active/archived status, search query, ordering + and any special filters (e.g. CCX courses, template courses). The filters are applied in the following order: + 1. Active/archived status + 2. Search query + 3. Ordering + 4. Special filters (e.g. CCX courses, template courses) + The first 3 filters are applied using queryset methods, while the last filter is applied using a Python filter + function since it involves checking the course type (i.e. if it's a CCX course or a template course). + """ + + def filter_course(course): + """ + Special filters + """ + # CCXs cannot be edited in Studio (aka cms) and should not be shown in this dashboard. + include_course = not isinstance(course.id, CCXLocator) + + # TODO remove this condition when templates purged from db + include_course = include_course and course.location.course != 'templates' + + return include_course + + search_query, order, active_only, archived_only = get_query_params_if_present(request) + + filtered_courses = get_filtered_and_ordered_courses( + courses, + active_only, + archived_only, + search_query, + order, + ) + return filter(filter_course, filtered_courses) + + +def _get_course_keys_for_org_scope(org_keys: set[str]): + """ + Convert a set of organization keys into specific course keys. + """ + + return CourseOverview.get_all_courses(orgs=org_keys).values_list('id', flat=True) + +def _get_course_keys_from_scopes(authz_scopes: list[ScopeData]): + """ + Convert a set of Authz scopes into specific course keys. + """ + course_keys = set() + org_keys = set() + for access in authz_scopes: + if isinstance(access, CourseOverviewData) and access.course_key: + if core_toggles.enable_authz_course_authoring(access.course_key): + course_keys.add(access.course_key) + elif isinstance(access, OrgCourseOverviewGlobData) and access.org: + org_keys.add(access.org) + if org_keys: + course_keys.update( + key for key in _get_course_keys_for_org_scope(org_keys) + if core_toggles.enable_authz_course_authoring(key) + ) + return course_keys + +def _get_authz_accessible_courses_list(request): + """ + List all courses available to the logged in user by + evaluating Authz scopes for course access. + """ + user = request.user + authz_scopes = get_scopes_for_user_and_permission( + user.username, + COURSES_VIEW_COURSE.identifier + ) + + return _get_course_keys_from_scopes(authz_scopes) + +def _get_legacy_accessible_courses_list(request): + """ + List all courses available to the logged in user by + evaluating legacy Django group roles and organization-level access. + """ + user = request.user + instructor_courses = UserBasedRole(user, CourseInstructorRole.ROLE).courses_with_role() + + with strict_role_checking(): + staff_courses = UserBasedRole(user, CourseStaffRole.ROLE).courses_with_role() + + group_keys = set() + org_accesses = set() + legacy_accesses = instructor_courses | staff_courses + + for access in legacy_accesses: + if access.course_id is not None: + course_key = access.course_id + if not isinstance(course_key, CourseKey): + course_key = CourseKey.from_string(str(course_key)) + group_keys.add(course_key) + elif access.org: + org_accesses.add(access.org) + else: + # No course_id or org is associated with this access. + raise AccessListFallback + + if org_accesses: + # Getting courses from user global orgs + org_course_keys = CourseOverview.get_all_courses(orgs=org_accesses).values_list("id", flat=True) + group_keys.update(org_course_keys) + return group_keys + + +def _get_candidate_course_keys(request): + """ + Resolve accessible course keys by merging Authz scope evaluation with + legacy permission checks. + + Why merge Authz and legacy checks? + At the time of implementation, the system is in a transition phase where + both Authz scopes and legacy permission checks are required to determine + course access. Combining both approaches allows us to leverage the + efficiency of Authz scopes while still capturing access granted through + legacy mechanisms. + + This produces a comprehensive and performant set of candidate course keys, + combining: + + - Authz scopes: + Collects course keys from the user's scopes for the + `COURSES_VIEW_COURSE` permission. + + - Legacy access: + Collects course keys based on Django group roles + (`CourseInstructorRole`, `CourseStaffRole`) and + organization-level access. If the user has organization-level access, + all courses within those organizations are included. + """ + # Collecting all course keys from authz scopes + authz_keys = _get_authz_accessible_courses_list(request) + + # Collecting all course keys from django groups and org access + group_keys = _get_legacy_accessible_courses_list(request) + + return authz_keys | group_keys + @function_trace('get_courses_accessible_to_user') def get_courses_accessible_to_user(request): """ - Try to get all courses by first reversing django groups and fallback to old method if it fails - Note: overhead of pymongo reads will increase if getting courses from django groups fails + Return courses accessible to the user using a hybrid AuthZ + legacy approach. - Arguments: - request: the request object + Flow: + 1. Determine candidate course keys: + - Staff: all courses (full scan). + - Non-staff: derived from AuthZ scopes and legacy access. + + 2. Single-pass access evaluation: + - Use AuthZ or legacy checks per course (based on feature flags). + - Collect only accessible course keys. + + 3. Batch fetch courses: + - Retrieve all valid courses in one query (ordered by creation date). + + 4. Apply request-based filters. + + Returns: + tuple: + - list[CourseOverview]: Accessible courses. + - list: In-process course actions (staff only). """ - if GlobalStaff().has_user(request.user): - # user has global access so no need to get courses from django groups - courses, in_process_course_actions = _accessible_courses_summary_iter(request) + user = request.user + is_staff_user = GlobalStaff().has_user(user) or user.is_superuser + in_process_actions = [] + + # Step 1: Determine candidate keys + if is_staff_user: + # Unavoidable full scan + # however, we only fetch the course keys here for the access check, + # and defer fetching the full course objects until after filtering by access + candidate_keys = CourseOverview.get_all_courses().values_list("id", flat=True) + # Compute actions once for staff users since they have access to all courses + in_process_actions = get_in_process_course_actions(request) else: + # For non-staff users, we can get a more targeted list of candidate course keys + # by combining AuthZ scopes and legacy access. + # Why? Because non-staff users typically have access to a smaller subset of courses, + # so this can significantly reduce the number of courses we need to check for access + # in the next step. try: - courses, in_process_course_actions = _accessible_courses_list_from_groups(request) + candidate_keys = _get_candidate_course_keys(request) except AccessListFallback: - # user have some old groups or there was some error getting courses from django groups + # This exception is raised when we cannot determine candidate course keys from legacy access. + # User have some old groups or there was some error getting courses from django groups # so fallback to iterating through all courses - courses, in_process_course_actions = _accessible_courses_summary_iter(request) - return courses, in_process_course_actions + candidate_keys = CourseOverview.get_all_courses().values_list("id", flat=True) + in_process_actions = get_in_process_course_actions(request) + + # Step 2: Single-pass decision → collect valid keys + valid_course_keys = set(candidate_keys) + + if not valid_course_keys: + return [], in_process_actions + + # Step 3: Batch fetch valid courses with a single query, ordered by creation date + courses = CourseOverview.get_all_courses( + filter_={'id__in': list(valid_course_keys)} + ).order_by('created') # default ordering is by created date + + # Step 4: Apply filters (e.g. search, active/archived status, ordering) + courses = _apply_course_query_filters(request, courses) + + return courses, in_process_actions def _process_courses_list(courses_iter, in_process_course_actions, split_archived=False): @@ -937,7 +1155,7 @@ def _create_or_rerun_course(request): return JsonResponse({ "ErrMsg": _("Unable to create course '{name}'.\n\n{err}").format(name=display_name, err=str(error))} ) - except PermissionDenied as error: # pylint: disable=unused-variable + except PermissionDenied as error: # pylint: disable=unused-variable # noqa: F841 log.info( "User does not have the permission to create course in this organization" "or course creation is disabled." @@ -963,7 +1181,7 @@ def create_new_course(user, org, number, run, fields): try: org_data = ensure_organization(org) except InvalidOrganizationException: - raise ValidationError(_( # lint-amnesty, pylint: disable=raise-missing-from + raise ValidationError(_( # pylint: disable=raise-missing-from # noqa: B904 'You must link this course to an organization in order to continue. Organization ' 'you selected does not exist in the system, you will need to add it to the system' )) @@ -1072,7 +1290,7 @@ def course_info_handler(request, course_key_string): try: course_key = CourseKey.from_string(course_key_string) except InvalidKeyError: - raise Http404 # lint-amnesty, pylint: disable=raise-missing-from + raise Http404 # pylint: disable=raise-missing-from # noqa: B904 return redirect(get_updates_url(course_key)) @@ -1100,8 +1318,14 @@ def course_info_update_handler(request, course_key_string, provided_id=None): if provided_id == '': provided_id = None - # check that logged in user has permissions to this item (GET shouldn't require this level?) - if not has_studio_write_access(request.user, usage_key.course_key): + if request.method == 'GET': + authz_perm = COURSES_VIEW_COURSE_UPDATES.identifier + legacy_perm = LegacyAuthoringPermission.READ + else: + authz_perm = COURSES_MANAGE_COURSE_UPDATES.identifier + legacy_perm = LegacyAuthoringPermission.WRITE + + if not user_has_course_permission(request.user, authz_perm, usage_key.course_key, legacy_perm): raise PermissionDenied() if request.method == 'GET': @@ -1113,7 +1337,7 @@ def course_info_update_handler(request, course_key_string, provided_id=None): elif request.method == 'DELETE': try: return JsonResponse(delete_course_update(usage_key, request.json, provided_id, request.user)) - except: # lint-amnesty, pylint: disable=bare-except + except: # pylint: disable=bare-except return HttpResponseBadRequest( "Failed to delete", content_type="text/plain" @@ -1124,7 +1348,7 @@ def course_info_update_handler(request, course_key_string, provided_id=None): return JsonResponse(update_course_updates( usage_key, request.json, provided_id, request.user, request.method )) - except: # lint-amnesty, pylint: disable=bare-except + except: # pylint: disable=bare-except return HttpResponseBadRequest( "Failed to save", content_type="text/plain" @@ -1135,7 +1359,7 @@ def course_info_update_handler(request, course_key_string, provided_id=None): @ensure_csrf_cookie @require_http_methods(("GET", "PUT", "POST")) @expect_json -def settings_handler(request, course_key_string): # lint-amnesty, pylint: disable=too-many-statements +def settings_handler(request, course_key_string): # pylint: disable=too-many-statements """ Course settings for dates and about pages GET @@ -1149,10 +1373,7 @@ def settings_handler(request, course_key_string): # lint-amnesty, pylint: disab with modulestore().bulk_operations(course_key): course_block = get_course_and_check_access(course_key, request.user) if 'text/html' in request.META.get('HTTP_ACCEPT', '') and request.method == 'GET': - if use_new_schedule_details_page(course_key): - return redirect(get_schedule_details_url(course_key)) - settings_context = get_course_settings(request, course_key, course_block) - return render_to_response('settings.html', settings_context) + return redirect(get_schedule_details_url(course_key)) elif 'application/json' in request.META.get('HTTP_ACCEPT', ''): # pylint: disable=too-many-nested-blocks if request.method == 'GET': course_details = CourseDetails.fetch(course_key) @@ -1192,10 +1413,7 @@ def grading_handler(request, course_key_string, grader_index=None): raise PermissionDenied() if 'text/html' in request.META.get('HTTP_ACCEPT', '') and request.method == 'GET': - if use_new_grading_page(course_key): - return redirect(get_grading_url(course_key)) - grading_context = get_course_grading(course_key) - return render_to_response('settings_graders.html', grading_context) + return redirect(get_grading_url(course_key)) elif 'application/json' in request.META.get('HTTP_ACCEPT', ''): if request.method == 'GET': if grader_index is None: @@ -1289,27 +1507,10 @@ def advanced_settings_handler(request, course_key_string): advanced_dict.get('mobile_available')['deprecated'] = True if 'text/html' in request.META.get('HTTP_ACCEPT', '') and request.method == 'GET': - if use_new_advanced_settings_page(course_key): - return redirect(get_advanced_settings_url(course_key)) - publisher_enabled = configuration_helpers.get_value_for_org( - course_block.location.org, - 'ENABLE_PUBLISHER', - settings.FEATURES.get('ENABLE_PUBLISHER', False) - ) - # gather any errors in the currently stored proctoring settings. - proctoring_errors = CourseMetadata.validate_proctoring_settings(course_block, advanced_dict, request.user) - - return render_to_response('settings_advanced.html', { - 'context_course': course_block, - 'advanced_dict': advanced_dict, - 'advanced_settings_url': reverse_course_url('advanced_settings_handler', course_key), - 'publisher_enabled': publisher_enabled, - 'mfe_proctored_exam_settings_url': get_proctored_exam_settings_url(course_block.id), - 'proctoring_errors': proctoring_errors, - }) + return redirect(get_advanced_settings_url(course_key)) elif 'application/json' in request.META.get('HTTP_ACCEPT', ''): if request.method == 'GET': - return JsonResponse(CourseMetadata.fetch(course_block)) + return JsonResponse(advanced_dict) else: try: return JsonResponse( @@ -1319,7 +1520,7 @@ def advanced_settings_handler(request, course_key_string): return JsonResponseBadRequest(err.detail) -def update_course_advanced_settings(course_block: CourseBlock, data: Dict, user: User) -> Dict: +def update_course_advanced_settings(course_block: CourseBlock, data: Dict, user: User) -> Dict: # noqa: UP006 """ Helper function to update course advanced settings from API data. @@ -1371,7 +1572,7 @@ def update_course_advanced_settings(course_block: CourseBlock, data: Dict, user: class TextbookValidationError(Exception): "An error thrown when a textbook input is invalid" - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass def validate_textbooks_json(text): @@ -1383,7 +1584,7 @@ def validate_textbooks_json(text): try: textbooks = json.loads(text) except ValueError: - raise TextbookValidationError("invalid JSON") # lint-amnesty, pylint: disable=raise-missing-from + raise TextbookValidationError("invalid JSON") # pylint: disable=raise-missing-from # noqa: B904 if not isinstance(textbooks, (list, tuple)): raise TextbookValidationError("must be JSON list") for textbook in textbooks: @@ -1406,7 +1607,7 @@ def validate_textbook_json(textbook): try: textbook = json.loads(textbook) except ValueError: - raise TextbookValidationError("invalid JSON") # lint-amnesty, pylint: disable=raise-missing-from + raise TextbookValidationError("invalid JSON") # pylint: disable=raise-missing-from # noqa: B904 if not isinstance(textbook, dict): raise TextbookValidationError("must be JSON object") if not textbook.get("tab_title"): @@ -1449,16 +1650,23 @@ def textbooks_list_handler(request, course_key_string): """ course_key = CourseKey.from_string(course_key_string) if "application/json" not in request.META.get('HTTP_ACCEPT', 'text/html'): - # return HTML page - # We don't need to do an access check here because - # that is done when the endpoint for the actual content of the page. - # This is just to handle redirecting anyone that has bookmarked the old - # textbooks page. + # Legacy HTML bookmark redirect — no data is exposed here. + # Access is enforced when the MFE fetches data from the textbooks API. return redirect(get_textbooks_url(course_key)) + if request.method == 'GET': + authz_perm = COURSES_VIEW_PAGES_AND_RESOURCES.identifier + legacy_perm = LegacyAuthoringPermission.READ + else: + authz_perm = COURSES_MANAGE_PAGES_AND_RESOURCES.identifier + legacy_perm = LegacyAuthoringPermission.WRITE + + if not user_has_course_permission(request.user, authz_perm, course_key, legacy_perm): + raise PermissionDenied() + store = modulestore() with store.bulk_operations(course_key): - course = get_course_and_check_access(course_key, request.user) + course = _get_course_block(course_key) # from here on down, we know the client has requested JSON if request.method == 'GET': @@ -1521,9 +1729,20 @@ def textbooks_detail_handler(request, course_key_string, textbook_id): json: remove textbook """ course_key = CourseKey.from_string(course_key_string) + + if request.method == 'GET': + authz_perm = COURSES_VIEW_PAGES_AND_RESOURCES.identifier + legacy_perm = LegacyAuthoringPermission.READ + else: + authz_perm = COURSES_MANAGE_PAGES_AND_RESOURCES.identifier + legacy_perm = LegacyAuthoringPermission.WRITE + + if not user_has_course_permission(request.user, authz_perm, course_key, legacy_perm): + raise PermissionDenied() + store = modulestore() with store.bulk_operations(course_key): - course_block = get_course_and_check_access(course_key, request.user) + course_block = _get_course_block(course_key) matching_id = [tb for tb in course_block.pdf_textbooks if str(tb.get("id")) == str(textbook_id)] if matching_id: @@ -1619,13 +1838,10 @@ def group_configurations_list_handler(request, course_key_string): course_key = CourseKey.from_string(course_key_string) store = modulestore() with store.bulk_operations(course_key): - course = get_course_and_check_access(course_key, request.user) + course = get_course_and_check_manage_group_configurations_access(course_key, request.user) if 'text/html' in request.META.get('HTTP_ACCEPT', 'text/html'): - if use_new_group_configurations_page(course_key): - return redirect(get_group_configurations_url(course_key)) - group_configurations_context = get_group_configurations_context(course, store) - return render_to_response('group_configurations.html', group_configurations_context) + return redirect(get_group_configurations_url(course_key)) elif "application/json" in request.META.get('HTTP_ACCEPT'): if request.method == 'POST': # create a new group configuration for the course @@ -1662,7 +1878,7 @@ def group_configurations_detail_handler(request, course_key_string, group_config course_key = CourseKey.from_string(course_key_string) store = modulestore() with store.bulk_operations(course_key): - course = get_course_and_check_access(course_key, request.user) + course = get_course_and_check_manage_group_configurations_access(course_key, request.user) matching_id = [p for p in course.user_partitions if str(p.id) == str(group_configuration_id)] if matching_id: @@ -1672,7 +1888,7 @@ def group_configurations_detail_handler(request, course_key_string, group_config if request.method in ('POST', 'PUT'): # can be either and sometimes django is rewriting one to the other try: - new_configuration = GroupConfiguration(request.body, course, group_configuration_id).get_user_partition() # lint-amnesty, pylint: disable=line-too-long + new_configuration = GroupConfiguration(request.body, course, group_configuration_id).get_user_partition() # pylint: disable=line-too-long except GroupConfigurationsValidationError as err: return JsonResponse({"error": str(err)}, status=400) @@ -1777,7 +1993,7 @@ def bulk_enable_disable_discussions(request, course_key_string): store.publish(vertical.location, user.id) changed += 1 return JsonResponse({"units_updated_and_republished": changed}) - except Exception as e: # lint-amnesty, pylint: disable=broad-except + except Exception as e: # pylint: disable=broad-except log.exception("Exception occurred while enabling/disabling discussion: %s", str(e)) return JsonResponseBadRequest({"error": str(e)}) diff --git a/cms/djangoapps/contentstore/views/entrance_exam.py b/cms/djangoapps/contentstore/views/entrance_exam.py index 5d914366bd9e..caf35dbdc7db 100644 --- a/cms/djangoapps/contentstore/views/entrance_exam.py +++ b/cms/djangoapps/contentstore/views/entrance_exam.py @@ -15,17 +15,17 @@ from opaque_keys import InvalidKeyError from opaque_keys.edx.keys import CourseKey, UsageKey +from cms.djangoapps.contentstore.xblock_storage_handlers.create_xblock import create_xblock +from cms.djangoapps.contentstore.xblock_storage_handlers.view_handlers import delete_item from cms.djangoapps.models.settings.course_metadata import CourseMetadata from common.djangoapps.student.auth import has_course_author_access from common.djangoapps.util import milestones_helpers from openedx.core import toggles as core_toggles from openedx.core.djangolib.js_utils import dump_js_escaped_json -from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.exceptions import ItemNotFoundError # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order +from xmodule.modulestore.exceptions import ItemNotFoundError # pylint: disable=wrong-import-order from ..helpers import remove_entrance_exam_graders -from cms.djangoapps.contentstore.xblock_storage_handlers.create_xblock import create_xblock -from cms.djangoapps.contentstore.xblock_storage_handlers.view_handlers import delete_item __all__ = ['entrance_exam', ] @@ -178,7 +178,7 @@ def _get_entrance_exam(request, course_key): return HttpResponse(status=404) try: exam_block = modulestore().get_item(exam_key) - return HttpResponse( # lint-amnesty, pylint: disable=http-response-with-content-type-json + return HttpResponse( # pylint: disable=http-response-with-content-type-json dump_js_escaped_json({'locator': str(exam_block.location)}), status=200, content_type='application/json') except ItemNotFoundError: @@ -235,7 +235,7 @@ def _delete_entrance_exam(request, course_key): return HttpResponse(status=204) -def add_entrance_exam_milestone(course_id, x_block): # lint-amnesty, pylint: disable=missing-function-docstring +def add_entrance_exam_milestone(course_id, x_block): # pylint: disable=missing-function-docstring # Add an entrance exam milestone if one does not already exist for given xBlock # As this is a standalone method for entrance exam, We should check that given xBlock should be an entrance exam. if x_block.is_entrance_exam: @@ -245,7 +245,7 @@ def add_entrance_exam_milestone(course_id, x_block): # lint-amnesty, pylint: di course_id ) milestones = milestones_helpers.get_milestones(milestone_namespace) - if len(milestones): # lint-amnesty, pylint: disable=len-as-condition + if len(milestones): # pylint: disable=len-as-condition milestone = milestones[0] else: description = f'Autogenerated during {str(course_id)} entrance exam creation.' diff --git a/cms/djangoapps/contentstore/views/error.py b/cms/djangoapps/contentstore/views/error.py index 5a9c23490ba6..8690fa9cda0c 100644 --- a/cms/djangoapps/contentstore/views/error.py +++ b/cms/djangoapps/contentstore/views/error.py @@ -1,4 +1,4 @@ -# lint-amnesty, pylint: disable=missing-module-docstring +# pylint: disable=missing-module-docstring import functools from django.http import HttpResponse, HttpResponseNotFound, HttpResponseServerError @@ -20,7 +20,7 @@ def outer(func): def inner(request, *args, **kwargs): if request.headers.get('x-requested-with') == 'XMLHttpRequest': content = dump_js_escaped_json({"error": message}) - return HttpResponse(content, content_type="application/json", # lint-amnesty, pylint: disable=http-response-with-content-type-json + return HttpResponse(content, content_type="application/json", # pylint: disable=http-response-with-content-type-json status=status) else: return func(request, *args, **kwargs) @@ -29,7 +29,7 @@ def inner(request, *args, **kwargs): @jsonable_error(404, "Resource not found") -def not_found(request, exception): # lint-amnesty, pylint: disable=unused-argument +def not_found(request, exception): # pylint: disable=unused-argument return render_to_response('error.html', {'error': '404'}) @@ -40,7 +40,7 @@ def server_error(request): @fix_crum_request @jsonable_error(404, "Resource not found") -def render_404(request, exception): # lint-amnesty, pylint: disable=unused-argument +def render_404(request, exception): # pylint: disable=unused-argument return HttpResponseNotFound(render_to_string('404.html', {}, request=request)) diff --git a/cms/djangoapps/contentstore/views/export_git.py b/cms/djangoapps/contentstore/views/export_git.py index 0da89f9fe74b..7fc7b6086944 100644 --- a/cms/djangoapps/contentstore/views/export_git.py +++ b/cms/djangoapps/contentstore/views/export_git.py @@ -15,7 +15,7 @@ import cms.djangoapps.contentstore.git_export_utils as git_export_utils from common.djangoapps.edxmako.shortcuts import render_to_response from common.djangoapps.student.auth import has_course_author_access -from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order log = logging.getLogger(__name__) diff --git a/cms/djangoapps/contentstore/views/import_export.py b/cms/djangoapps/contentstore/views/import_export.py index 22310faa1ae2..ab0e1574515a 100644 --- a/cms/djangoapps/contentstore/views/import_export.py +++ b/cms/djangoapps/contentstore/views/import_export.py @@ -27,28 +27,24 @@ from edx_django_utils.monitoring import set_custom_attribute, set_custom_attributes_for_course_key from opaque_keys.edx.keys import CourseKey from opaque_keys.edx.locator import LibraryLocator +from openedx_authz.constants.permissions import COURSES_EXPORT_COURSE, COURSES_IMPORT_COURSE from path import Path as path from storages.backends.s3boto3 import S3Boto3Storage from user_tasks.conf import settings as user_tasks_settings from user_tasks.models import UserTaskArtifact, UserTaskStatus from common.djangoapps.edxmako.shortcuts import render_to_response -from common.djangoapps.student.auth import has_course_author_access from common.djangoapps.util.json_request import JsonResponse from common.djangoapps.util.monitoring import monitor_import_failure from common.djangoapps.util.views import ensure_valid_course_key -from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order +from openedx.core.djangoapps.authz.constants import LegacyAuthoringPermission +from openedx.core.djangoapps.authz.decorators import user_has_course_permission +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order from ..storage import course_import_export_storage from ..tasks import CourseExportTask, CourseImportTask, export_olx, import_olx -from ..toggles import use_new_export_page, use_new_import_page -from ..utils import ( - reverse_course_url, - reverse_library_url, - get_export_url, - get_import_url, - IMPORTABLE_FILE_TYPES, -) +from ..utils import IMPORTABLE_FILE_TYPES, get_export_url, get_import_url, reverse_course_url, reverse_library_url + __all__ = [ 'import_handler', 'import_status_handler', 'export_handler', 'export_output_handler', 'export_status_handler', @@ -87,17 +83,22 @@ def import_handler(request, course_key_string): successful_url = reverse_course_url('course_handler', courselike_key) context_name = 'context_course' courselike_block = modulestore().get_course(courselike_key) - if not has_course_author_access(request.user, courselike_key): + if not user_has_course_permission( + user=request.user, + authz_permission=COURSES_IMPORT_COURSE.identifier, + course_key=courselike_key, + legacy_permission=LegacyAuthoringPermission.WRITE + ): raise PermissionDenied() if 'application/json' in request.META.get('HTTP_ACCEPT', 'application/json'): - if request.method == 'GET': # lint-amnesty, pylint: disable=no-else-raise + if request.method == 'GET': # pylint: disable=no-else-raise raise NotImplementedError('coming soon') else: return _write_chunk(request, courselike_key) elif request.method == 'GET': # assume html - if use_new_import_page(courselike_key) and not library: + if not library: return redirect(get_import_url(courselike_key)) status_url = reverse_course_url( "import_status_handler", courselike_key, kwargs={'filename': "fillerName"} @@ -124,7 +125,7 @@ def _save_request_status(request, key, status): request.session.save() -def _write_chunk(request, courselike_key): # lint-amnesty, pylint: disable=too-many-statements +def _write_chunk(request, courselike_key): # pylint: disable=too-many-statements """ Write the OLX file data chunk from the given request to the local filesystem. """ @@ -257,7 +258,12 @@ def import_status_handler(request, course_key_string, filename=None): """ course_key = CourseKey.from_string(course_key_string) - if not has_course_author_access(request.user, course_key): + if not user_has_course_permission( + user=request.user, + authz_permission=COURSES_IMPORT_COURSE.identifier, + course_key=course_key, + legacy_permission=LegacyAuthoringPermission.WRITE + ): raise PermissionDenied() # The task status record is authoritative once it's been created @@ -294,7 +300,7 @@ def send_tarball(tarball, size): """ wrapper = FileWrapper(tarball, settings.COURSE_EXPORT_DOWNLOAD_CHUNK_SIZE) response = StreamingHttpResponse(wrapper, content_type='application/x-tgz') - response['Content-Disposition'] = 'attachment; filename=%s' % os.path.basename(tarball.name) + response['Content-Disposition'] = 'attachment; filename=%s' % os.path.basename(tarball.name) # noqa: UP031 response['Content-Length'] = size return response @@ -318,7 +324,12 @@ def export_handler(request, course_key_string): a link appearing on the page once it's ready. """ course_key = CourseKey.from_string(course_key_string) - if not has_course_author_access(request.user, course_key): + if not user_has_course_permission( + user=request.user, + authz_permission=COURSES_EXPORT_COURSE.identifier, + course_key=course_key, + legacy_permission=LegacyAuthoringPermission.WRITE + ): raise PermissionDenied() library = isinstance(course_key, LibraryLocator) if library: @@ -346,7 +357,7 @@ def export_handler(request, course_key_string): export_olx.delay(request.user.id, course_key_string, request.LANGUAGE_CODE) return JsonResponse({'ExportStatus': 1}) elif 'text/html' in requested_format: - if use_new_export_page(course_key) and not library: + if not library: return redirect(get_export_url(course_key)) return render_to_response('export.html', context) else: @@ -373,7 +384,12 @@ def export_status_handler(request, course_key_string): returned. """ course_key = CourseKey.from_string(course_key_string) - if not has_course_author_access(request.user, course_key): + if not user_has_course_permission( + user=request.user, + authz_permission=COURSES_EXPORT_COURSE.identifier, + course_key=course_key, + legacy_permission=LegacyAuthoringPermission.WRITE + ): raise PermissionDenied() # The task status record is authoritative once it's been created @@ -435,7 +451,12 @@ def export_output_handler(request, course_key_string): filesystem instead of an external service like S3. """ course_key = CourseKey.from_string(course_key_string) - if not has_course_author_access(request.user, course_key): + if not user_has_course_permission( + user=request.user, + authz_permission=COURSES_EXPORT_COURSE.identifier, + course_key=course_key, + legacy_permission=LegacyAuthoringPermission.WRITE + ): raise PermissionDenied() task_status = _latest_task_status(request, course_key_string, export_output_handler) @@ -446,7 +467,7 @@ def export_output_handler(request, course_key_string): tarball = course_import_export_storage.open(artifact.file.name) return send_tarball(tarball, artifact.file.storage.size(artifact.file.name)) except UserTaskArtifact.DoesNotExist: - raise Http404 # lint-amnesty, pylint: disable=raise-missing-from + raise Http404 # pylint: disable=raise-missing-from # noqa: B904 finally: if artifact: artifact.file.close() diff --git a/cms/djangoapps/contentstore/views/library.py b/cms/djangoapps/contentstore/views/library.py index 92e4329c2f94..70ae0bce2c2a 100644 --- a/cms/djangoapps/contentstore/views/library.py +++ b/cms/djangoapps/contentstore/views/library.py @@ -19,10 +19,8 @@ from opaque_keys.edx.locator import LibraryLocator, LibraryUsageLocator from organizations.api import ensure_organization from organizations.exceptions import InvalidOrganizationException -from xmodule.modulestore import ModuleStoreEnum -from xmodule.modulestore.django import modulestore -from xmodule.modulestore.exceptions import DuplicateCourseError +from cms.djangoapps.contentstore.xblock_storage_handlers.view_handlers import create_xblock_info from cms.djangoapps.course_creators.views import get_course_creator_status from common.djangoapps.edxmako.shortcuts import render_to_response from common.djangoapps.student.auth import ( @@ -40,11 +38,13 @@ UserBasedRole, ) from common.djangoapps.util.json_request import JsonResponse, JsonResponseBadRequest, expect_json +from xmodule.modulestore import ModuleStoreEnum +from xmodule.modulestore.django import modulestore +from xmodule.modulestore.exceptions import DuplicateCourseError -from ..utils import add_instructor, reverse_library_url from ..toggles import libraries_v1_enabled +from ..utils import add_instructor, reverse_library_url from .component import CONTAINER_TEMPLATES, get_component_templates -from cms.djangoapps.contentstore.xblock_storage_handlers.view_handlers import create_xblock_info from .user import user_with_role __all__ = ['library_handler', 'manage_library_users'] @@ -73,24 +73,23 @@ def _user_can_create_library_for_org(user, org=None): elif user.is_staff: return True elif settings.FEATURES.get('ENABLE_CREATOR_GROUP', False): - org_filter_params = {} - if org: - org_filter_params['org'] = org is_course_creator = get_course_creator_status(user) == 'granted' - has_org_staff_role = OrgStaffRole().get_orgs_for_user(user).filter(**org_filter_params).exists() - has_course_staff_role = ( - UserBasedRole(user=user, role=CourseStaffRole.ROLE) - .courses_with_role() - .filter(**org_filter_params) - .exists() - ) - has_course_admin_role = ( - UserBasedRole(user=user, role=CourseInstructorRole.ROLE) - .courses_with_role() - .filter(**org_filter_params) - .exists() - ) - return is_course_creator or has_org_staff_role or has_course_staff_role or has_course_admin_role + if is_course_creator: + return True + + has_org_staff_role = OrgStaffRole().has_org_for_user(user, org) + if has_org_staff_role: + return True + + has_course_staff_role = UserBasedRole(user=user, role=CourseStaffRole.ROLE).has_courses_with_role(org) + if has_course_staff_role: + return True + + has_course_admin_role = UserBasedRole(user=user, role=CourseInstructorRole.ROLE).has_courses_with_role(org) + if has_course_admin_role: + return True + + return False else: # EDUCATOR-1924: DISABLE_LIBRARY_CREATION overrides DISABLE_COURSE_CREATION, if present. disable_library_creation = settings.FEATURES.get('DISABLE_LIBRARY_CREATION', None) @@ -228,7 +227,7 @@ def _create_library(request): ) # Give the user admin ("Instructor") role for this library: add_instructor(new_lib.location.library_key, request.user, request.user) - except PermissionDenied as error: # pylint: disable=unused-variable + except PermissionDenied as error: # pylint: disable=unused-variable # noqa: F841 log.info( "User does not have the permission to create LIBRARY in this organization." "User: '%s' Org: '%s' LIBRARY #: '%s'.", diff --git a/cms/djangoapps/contentstore/views/organization.py b/cms/djangoapps/contentstore/views/organization.py index 7ece98201ac1..511ef611aa82 100644 --- a/cms/djangoapps/contentstore/views/organization.py +++ b/cms/djangoapps/contentstore/views/organization.py @@ -18,8 +18,8 @@ class OrganizationListView(View): """ @method_decorator(login_required) - def get(self, request, *args, **kwargs): # lint-amnesty, pylint: disable=unused-argument + def get(self, request, *args, **kwargs): # pylint: disable=unused-argument """Returns organization list as json.""" organizations = get_organizations() org_names_list = [(org["short_name"]) for org in organizations] - return HttpResponse(dump_js_escaped_json(org_names_list), content_type='application/json; charset=utf-8') # lint-amnesty, pylint: disable=http-response-with-content-type-json + return HttpResponse(dump_js_escaped_json(org_names_list), content_type='application/json; charset=utf-8') # pylint: disable=http-response-with-content-type-json diff --git a/cms/djangoapps/contentstore/views/preview.py b/cms/djangoapps/contentstore/views/preview.py index b83158e35c76..5e5892fef46b 100644 --- a/cms/djangoapps/contentstore/views/preview.py +++ b/cms/djangoapps/contentstore/views/preview.py @@ -1,11 +1,11 @@ -# lint-amnesty, pylint: disable=missing-module-docstring +# pylint: disable=missing-module-docstring import logging from functools import partial from django.conf import settings -from django.core.cache import cache from django.contrib.auth.decorators import login_required +from django.core.cache import cache from django.http import Http404, HttpResponseBadRequest from django.urls import reverse from django.utils.translation import gettext as _ @@ -18,35 +18,31 @@ from xblock.exceptions import NoSuchHandlerError, NotFoundError, ProcessingError from xblock.runtime import KvsFieldData -from openedx.core.djangoapps.video_config.services import VideoConfigService -from xmodule.contentstore.django import contentstore -from xmodule.exceptions import NotFoundError as XModuleNotFoundError -from xmodule.modulestore.django import XBlockI18nService, modulestore -from xmodule.partitions.partitions_service import PartitionService -from xmodule.services import SettingsService, TeamsConfigurationService -from xmodule.studio_editable import has_author_view -from xmodule.util.sandboxing import SandboxService -from xmodule.util.builtin_assets import add_webpack_js_to_fragment -from xmodule.x_module import AUTHOR_VIEW, PREVIEW_VIEWS, STUDENT_VIEW, XModuleMixin -from cms.djangoapps.xblock_config.models import StudioConfig from cms.djangoapps.contentstore.toggles import individualize_anonymous_user_id +from cms.djangoapps.xblock_config.models import StudioConfig from cms.lib.xblock.field_data import CmsFieldData from cms.lib.xblock.upstream_sync import UpstreamLink +from common.djangoapps.edxmako.services import MakoService +from common.djangoapps.edxmako.shortcuts import render_to_string from common.djangoapps.static_replace.services import ReplaceURLService from common.djangoapps.static_replace.wrapper import replace_urls_wrapper from common.djangoapps.student.models import anonymous_id_for_user -from common.djangoapps.edxmako.shortcuts import render_to_string -from common.djangoapps.edxmako.services import MakoService from common.djangoapps.xblock_django.user_service import DjangoXBlockUserService from lms.djangoapps.lms_xblock.field_data import LmsFieldData -from openedx.core.lib.license import wrap_with_license +from openedx.core.djangoapps.discussions.services import DiscussionConfigService +from openedx.core.djangoapps.video_config.services import VideoConfigService from openedx.core.lib.cache_utils import CacheService -from openedx.core.lib.xblock_utils import ( - request_token, - wrap_fragment, - wrap_xblock, - wrap_xblock_aside -) +from openedx.core.lib.license import wrap_with_license +from openedx.core.lib.xblock_utils import request_token, wrap_fragment, wrap_xblock, wrap_xblock_aside +from xmodule.contentstore.django import contentstore +from xmodule.exceptions import NotFoundError as XModuleNotFoundError +from xmodule.modulestore.django import XBlockI18nService, modulestore +from xmodule.partitions.partitions_service import PartitionService +from xmodule.services import SettingsService, TeamsConfigurationService, XQueueService +from xmodule.studio_editable import has_author_view +from xmodule.util.builtin_assets import add_webpack_js_to_fragment +from xmodule.util.sandboxing import SandboxService +from xmodule.x_module import AUTHOR_VIEW, PREVIEW_VIEWS, STUDENT_VIEW, XModuleMixin from ..utils import StudioPermissionsService, get_visibility_partition_info from .access import get_user_role @@ -79,11 +75,11 @@ def preview_handler(request, usage_key_string, handler, suffix=''): except NoSuchHandlerError: log.exception("XBlock %s attempted to access missing handler %r", instance, handler) - raise Http404 # lint-amnesty, pylint: disable=raise-missing-from + raise Http404 # pylint: disable=raise-missing-from # noqa: B904 except (XModuleNotFoundError, NotFoundError): log.exception("Module indicating to user that request doesn't exist") - raise Http404 # lint-amnesty, pylint: disable=raise-missing-from + raise Http404 # pylint: disable=raise-missing-from # noqa: B904 except ProcessingError: log.warning("Module raised an error while processing AJAX request", @@ -97,7 +93,7 @@ def preview_handler(request, usage_key_string, handler, suffix=''): return webob_to_django_response(resp) -def handler_url(block, handler_name, suffix='', query='', thirdparty=False): # lint-amnesty, pylint: disable=unused-argument +def handler_url(block, handler_name, suffix='', query='', thirdparty=False): # pylint: disable=unused-argument """ Handler URL function for Preview """ @@ -228,6 +224,8 @@ def _prepare_runtime_for_preview(request, block): "cache": CacheService(cache), 'replace_urls': ReplaceURLService, 'video_config': VideoConfigService(), + 'discussion_config_service': DiscussionConfigService(), + 'xqueue': XQueueService(block), } block.runtime.get_block_for_descriptor = partial(_load_preview_block, request) @@ -314,7 +312,7 @@ def _studio_wrap_xblock(xblock, view, frag, context, display_name_only=False): is_reorderable = _is_xblock_reorderable(xblock, context) selected_groups_label = get_visibility_partition_info(xblock)['selected_groups_label'] if selected_groups_label: - selected_groups_label = _('Access restricted to: {list_of_groups}').format(list_of_groups=selected_groups_label) # lint-amnesty, pylint: disable=line-too-long + selected_groups_label = _('Access restricted to: {list_of_groups}').format(list_of_groups=selected_groups_label) # pylint: disable=line-too-long course = modulestore().get_course(xblock.location.course_key) can_edit = context.get('can_edit', True) diff --git a/cms/djangoapps/contentstore/views/public.py b/cms/djangoapps/contentstore/views/public.py index 0684d52022ae..f841d345b1af 100644 --- a/cms/djangoapps/contentstore/views/public.py +++ b/cms/djangoapps/contentstore/views/public.py @@ -8,13 +8,10 @@ from django.http.response import Http404 from django.shortcuts import redirect -from common.djangoapps.edxmako.shortcuts import render_to_response - from ..config.waffle import ENABLE_ACCESSIBILITY_POLICY_PAGE -from ..toggles import use_legacy_logged_out_home __all__ = [ - 'register_redirect_to_lms', 'login_redirect_to_lms', 'howitworks', 'accessibility', + 'register_redirect_to_lms', 'login_redirect_to_lms', 'accessibility', 'redirect_to_lms_login_for_admin', ] @@ -24,7 +21,7 @@ def register_redirect_to_lms(request): This view redirects to the LMS register view. It is used to temporarily keep the old Studio signup url alive. """ - register_url = '{register_url}{params}'.format( + register_url = '{register_url}{params}'.format( # noqa: UP032 register_url=settings.FRONTEND_REGISTER_URL, params=_build_next_param(request), ) @@ -36,7 +33,7 @@ def login_redirect_to_lms(request): This view redirects to the LMS login view. It is used for Django's LOGIN_URL setting, which is where unauthenticated requests to protected endpoints are redirected. """ - login_url = '{login_url}{params}'.format( + login_url = '{login_url}{params}'.format( # noqa: UP032 login_url=settings.FRONTEND_LOGIN_URL, params=_build_next_param(request), ) @@ -62,15 +59,6 @@ def _build_next_param(request): return '' -def howitworks(request): - """ - Deprecated logged-out home page. New behavior is just login w/ redirect to studio course list. - """ - if use_legacy_logged_out_home() and not request.user.is_authenticated: - return render_to_response('howitworks.html', {}) - return redirect('/home/') - - def accessibility(request): """ Display the accessibility accommodation form. diff --git a/cms/djangoapps/contentstore/views/serializers.py b/cms/djangoapps/contentstore/views/serializers.py index 71608fb0deab..6f49cc95c728 100644 --- a/cms/djangoapps/contentstore/views/serializers.py +++ b/cms/djangoapps/contentstore/views/serializers.py @@ -5,12 +5,13 @@ Add new serializers here as needed for API endpoints in this module. """ -from rest_framework import serializers from django.core.exceptions import PermissionDenied +from rest_framework import serializers from cms.djangoapps.contentstore.views.certificate_manager import ( CERTIFICATE_SCHEMA_VERSION, - CertificateManager, Certificate, + Certificate, + CertificateManager, ) from common.djangoapps.student.roles import GlobalStaff diff --git a/cms/djangoapps/contentstore/views/session_kv_store.py b/cms/djangoapps/contentstore/views/session_kv_store.py index e39753c7258d..8bda3abd52a0 100644 --- a/cms/djangoapps/contentstore/views/session_kv_store.py +++ b/cms/djangoapps/contentstore/views/session_kv_store.py @@ -10,8 +10,8 @@ def stringify(key): return repr(tuple(key)) -class SessionKeyValueStore(KeyValueStore): # lint-amnesty, pylint: disable=missing-class-docstring - def __init__(self, request): # lint-amnesty, pylint: disable=super-init-not-called +class SessionKeyValueStore(KeyValueStore): # pylint: disable=missing-class-docstring + def __init__(self, request): # pylint: disable=super-init-not-called self._session = request.session def get(self, key): diff --git a/cms/djangoapps/contentstore/views/tabs.py b/cms/djangoapps/contentstore/views/tabs.py index 8fa9d024458d..a10e87c2c27e 100644 --- a/cms/djangoapps/contentstore/views/tabs.py +++ b/cms/djangoapps/contentstore/views/tabs.py @@ -1,7 +1,7 @@ """ Views related to course tabs """ -from typing import Dict, Iterable, List, Optional, Union +from typing import Dict, Iterable, List, Optional, Union # noqa: UP035 from django.contrib.auth import get_user_model from django.contrib.auth.decorators import login_required @@ -12,14 +12,15 @@ from django.views.decorators.http import require_http_methods from opaque_keys.edx.keys import CourseKey, UsageKey from rest_framework.exceptions import ValidationError + +from common.djangoapps.student.auth import has_course_author_access +from common.djangoapps.util.json_request import JsonResponse, JsonResponseBadRequest, expect_json from xmodule.course_block import CourseBlock from xmodule.modulestore import ModuleStoreEnum from xmodule.modulestore.django import modulestore from xmodule.tabs import CourseTab, CourseTabList, InvalidTabsException, StaticTab -from common.djangoapps.student.auth import has_course_author_access -from common.djangoapps.util.json_request import JsonResponse, JsonResponseBadRequest, expect_json -from ..utils import get_pages_and_resources_url, get_custom_pages_url +from ..utils import get_custom_pages_url, get_pages_and_resources_url __all__ = ["tabs_handler", "update_tabs_handler"] @@ -51,7 +52,7 @@ def tabs_handler(request, course_key_string): course_item = modulestore().get_course(course_key) if "application/json" in request.META.get("HTTP_ACCEPT", "application/json"): - if request.method == "GET": # lint-amnesty, pylint: disable=no-else-raise + if request.method == "GET": # pylint: disable=no-else-raise raise NotImplementedError("coming soon") else: try: @@ -91,7 +92,7 @@ def get_course_tabs(course_item: CourseBlock, user: User) -> Iterable[CourseTab] yield tab -def update_tabs_handler(course_item: CourseBlock, tabs_data: Dict, user: User) -> None: +def update_tabs_handler(course_item: CourseBlock, tabs_data: Dict, user: User) -> None: # noqa: UP006 """ Helper to handle updates to course tabs based on API data. @@ -154,7 +155,7 @@ def create_new_list(tab_locators, old_tab_list): return sorted(new_tab_list, key=lambda item: item.priority or float('inf')) -def edit_tab_handler(course_item: CourseBlock, tabs_data: Dict, user: User): +def edit_tab_handler(course_item: CourseBlock, tabs_data: Dict, user: User): # noqa: UP006 """ Helper function for handling requests to edit settings of a single tab """ @@ -178,7 +179,7 @@ def edit_tab_handler(course_item: CourseBlock, tabs_data: Dict, user: User): raise NotImplementedError(f"Unsupported request to edit tab: {tabs_data}") -def get_tab_by_tab_id_locator(tab_list: List[CourseTab], tab_id_locator: Dict[str, str]) -> Optional[CourseTab]: +def get_tab_by_tab_id_locator(tab_list: List[CourseTab], tab_id_locator: Dict[str, str]) -> Optional[CourseTab]: # noqa: UP006, UP045 # pylint: disable=line-too-long """ Look for a tab with the specified tab_id or locator. Returns the first matching tab. """ @@ -190,7 +191,7 @@ def get_tab_by_tab_id_locator(tab_list: List[CourseTab], tab_id_locator: Dict[st return tab -def get_tab_by_locator(tab_list: List[CourseTab], tab_location: Union[str, UsageKey]) -> Optional[CourseTab]: +def get_tab_by_locator(tab_list: List[CourseTab], tab_location: Union[str, UsageKey]) -> Optional[CourseTab]: # noqa: UP006, UP007, UP045 # pylint: disable=line-too-long """ Look for a tab with the specified locator. Returns the first matching tab. """ diff --git a/cms/djangoapps/contentstore/views/tests/test_access.py b/cms/djangoapps/contentstore/views/tests/test_access.py index b8c2404cf678..b1eacbab09c7 100644 --- a/cms/djangoapps/contentstore/views/tests/test_access.py +++ b/cms/djangoapps/contentstore/views/tests/test_access.py @@ -39,12 +39,12 @@ def test_get_user_role_instructor(self): Verifies if user is instructor. """ add_users(self.global_admin, CourseInstructorRole(self.course_key), self.instructor) - self.assertEqual( + self.assertEqual( # noqa: PT009 'instructor', get_user_role(self.instructor, self.course_key) ) add_users(self.global_admin, CourseStaffRole(self.course_key), self.staff) - self.assertEqual( + self.assertEqual( # noqa: PT009 'instructor', get_user_role(self.instructor, self.course_key) ) @@ -54,7 +54,7 @@ def test_get_user_role_staff(self): Verifies if user is staff. """ add_users(self.global_admin, CourseStaffRole(self.course_key), self.staff) - self.assertEqual( + self.assertEqual( # noqa: PT009 'staff', get_user_role(self.staff, self.course_key) ) diff --git a/cms/djangoapps/contentstore/views/tests/test_assets.py b/cms/djangoapps/contentstore/views/tests/test_assets.py index e7dbcfe9f55a..513a39fe82ab 100644 --- a/cms/djangoapps/contentstore/views/tests/test_assets.py +++ b/cms/djangoapps/contentstore/views/tests/test_assets.py @@ -14,21 +14,25 @@ from django.test.utils import override_settings from opaque_keys.edx.keys import AssetKey from opaque_keys.edx.locator import CourseLocator +from openedx_authz.constants.roles import COURSE_ADMIN, COURSE_AUDITOR, COURSE_EDITOR from PIL import Image from pytz import UTC +from rest_framework.test import APIClient from cms.djangoapps.contentstore.tests.utils import CourseTestCase from cms.djangoapps.contentstore.utils import reverse_course_url from cms.djangoapps.contentstore.views import assets from common.djangoapps.static_replace import replace_static_urls -from xmodule.assetstore import AssetMetadata # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.contentstore.content import StaticContent # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.contentstore.django import contentstore # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore import ModuleStoreEnum # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory -from xmodule.modulestore.xml_importer import import_course_from_xml # lint-amnesty, pylint: disable=wrong-import-order +from common.djangoapps.student.tests.factories import UserFactory +from openedx.core.djangoapps.authz.tests.mixins import CourseAuthzTestMixin +from xmodule.assetstore import AssetMetadata # pylint: disable=wrong-import-order +from xmodule.contentstore.content import StaticContent # pylint: disable=wrong-import-order +from xmodule.contentstore.django import contentstore # pylint: disable=wrong-import-order +from xmodule.modulestore import ModuleStoreEnum # pylint: disable=wrong-import-order +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order from xmodule.modulestore.tests.django_utils import TEST_DATA_SPLIT_MODULESTORE +from xmodule.modulestore.tests.factories import CourseFactory +from xmodule.modulestore.xml_importer import import_course_from_xml # pylint: disable=wrong-import-order TEST_DATA_DIR = settings.COMMON_TEST_DATA_ROOT @@ -87,14 +91,14 @@ class BasicAssetsTestCase(AssetsTestCase): def test_basic(self): resp = self.client.get(self.url, HTTP_ACCEPT='text/html') - self.assertEqual(resp.status_code, 302) + self.assertEqual(resp.status_code, 302) # noqa: PT009 def test_static_url_generation(self): course_key = CourseLocator('org', 'class', 'run') location = course_key.make_asset_key('asset', 'my_file_name.jpg') path = StaticContent.get_static_path_from_location(location) - self.assertEqual(path, '/static/my_file_name.jpg') + self.assertEqual(path, '/static/my_file_name.jpg') # noqa: PT009 def test_pdf_asset(self): module_store = modulestore() @@ -118,7 +122,7 @@ def test_pdf_asset(self): # Check after import textbook.pdf has valid contentType ('application/pdf') # Note: Actual contentType for textbook.pdf in asset.json is 'text/pdf' - self.assertEqual(content.content_type, 'application/pdf') + self.assertEqual(content.content_type, 'application/pdf') # noqa: PT009 def test_relative_url_for_split_course(self): """ @@ -144,9 +148,9 @@ def test_relative_url_for_split_course(self): url = asset_url.replace('"', '') base_url = url.replace(filename, '') - self.assertIn(f"/{filename}", url) + self.assertIn(f"/{filename}", url) # noqa: PT009 resp = self.client.get(url) - self.assertEqual(resp.status_code, 200) + self.assertEqual(resp.status_code, 200) # noqa: PT009 # simulation of html page where base_url is up-to asset's main directory # and relative_path is dom element with its src @@ -154,9 +158,9 @@ def test_relative_url_for_split_course(self): # browser append relative_path with base_url absolute_path = base_url + relative_path - self.assertIn(f"/{relative_path}", absolute_path) + self.assertIn(f"/{relative_path}", absolute_path) # noqa: PT009 resp = self.client.get(absolute_path) - self.assertEqual(resp.status_code, 200) + self.assertEqual(resp.status_code, 200) # noqa: PT009 class PaginationTestCase(AssetsTestCase): @@ -260,9 +264,9 @@ def assert_correct_asset_response(self, url, expected_start, expected_length, ex resp = self.client.get(url, HTTP_ACCEPT='application/json') json_response = json.loads(resp.content.decode('utf-8')) assets_response = json_response['assets'] - self.assertEqual(json_response['start'], expected_start) - self.assertEqual(len(assets_response), expected_length) - self.assertEqual(json_response['totalCount'], expected_total) + self.assertEqual(json_response['start'], expected_start) # noqa: PT009 + self.assertEqual(len(assets_response), expected_length) # noqa: PT009 + self.assertEqual(json_response['totalCount'], expected_total) # noqa: PT009 def assert_correct_sort_response(self, url, sort, direction): """ @@ -272,17 +276,17 @@ def assert_correct_sort_response(self, url, sort, direction): url + '?sort=' + sort + '&direction=' + direction, HTTP_ACCEPT='application/json') json_response = json.loads(resp.content.decode('utf-8')) assets_response = json_response['assets'] - self.assertEqual(sort, json_response['sort']) - self.assertEqual(direction, json_response['direction']) + self.assertEqual(sort, json_response['sort']) # noqa: PT009 + self.assertEqual(direction, json_response['direction']) # noqa: PT009 name1 = assets_response[0][sort] name2 = assets_response[1][sort] name3 = assets_response[2][sort] if direction == 'asc': - self.assertLessEqual(name1, name2) - self.assertLessEqual(name2, name3) + self.assertLessEqual(name1, name2) # noqa: PT009 + self.assertLessEqual(name2, name3) # noqa: PT009 else: - self.assertGreaterEqual(name1, name2) - self.assertGreaterEqual(name2, name3) + self.assertGreaterEqual(name1, name2) # noqa: PT009 + self.assertGreaterEqual(name2, name3) # noqa: PT009 def assert_correct_filter_response(self, url, filter_type, filter_value): """ @@ -308,7 +312,7 @@ def assert_correct_filter_response(self, url, filter_type, filter_value): url + '?' + filter_type + '=' + filter_value, HTTP_ACCEPT='application/json') json_response = json.loads(resp.content.decode('utf-8')) assets_response = json_response['assets'] - self.assertEqual(filter_value_split, json_response['assetTypes']) + self.assertEqual(filter_value_split, json_response['assetTypes']) # noqa: PT009 if filter_value != '': content_types = [asset['content_type'].lower() @@ -317,12 +321,12 @@ def assert_correct_filter_response(self, url, filter_type, filter_value): for content_type in content_types: # content_type is either not any defined type (i.e. OTHER) or is a defined type (if multiple # parameters including OTHER are used) - self.assertTrue( + self.assertTrue( # noqa: PT009 content_type in requested_file_extensions or content_type not in all_file_extensions ) else: for content_type in content_types: - self.assertIn(content_type, requested_file_extensions) + self.assertIn(content_type, requested_file_extensions) # noqa: PT009 def assert_invalid_parameters_error(self, url, filter_type, filter_value): """ @@ -330,7 +334,7 @@ def assert_invalid_parameters_error(self, url, filter_type, filter_value): """ resp = self.client.get( url + '?' + filter_type + '=' + filter_value, HTTP_ACCEPT='application/json') - self.assertEqual(resp.status_code, 400) + self.assertEqual(resp.status_code, 400) # noqa: PT009 def assert_correct_text_search_response(self, url, text_search, number_matches): """ @@ -340,14 +344,14 @@ def assert_correct_text_search_response(self, url, text_search, number_matches): url + '?text_search=' + text_search, HTTP_ACCEPT='application/json') json_response = json.loads(resp.content.decode('utf-8')) assets_response = json_response['assets'] - self.assertEqual(text_search, json_response['textSearch']) - self.assertEqual(len(assets_response), number_matches) + self.assertEqual(text_search, json_response['textSearch']) # noqa: PT009 + self.assertEqual(len(assets_response), number_matches) # noqa: PT009 text_search_tokens = text_search.split() for asset_response in assets_response: for token in text_search_tokens: - self.assertIn(token.lower(), asset_response['display_name'].lower()) + self.assertIn(token.lower(), asset_response['display_name'].lower()) # noqa: PT009 @ddt @@ -361,11 +365,11 @@ def setUp(self): def test_happy_path(self): resp = self.upload_asset() - self.assertEqual(resp.status_code, 200) + self.assertEqual(resp.status_code, 200) # noqa: PT009 def test_upload_image(self): resp = self.upload_asset("test_image", asset_type="image") - self.assertEqual(resp.status_code, 200) + self.assertEqual(resp.status_code, 200) # noqa: PT009 @data( (int(MAX_FILE_SIZE / 2.0), "small.file.test", 200), @@ -383,7 +387,7 @@ def test_file_size(self, case, get_file_size): "name": name, "file": f }) - self.assertEqual(resp.status_code, status_code) + self.assertEqual(resp.status_code, status_code) # noqa: PT009 class DownloadTestCase(AssetsTestCase): @@ -396,19 +400,19 @@ def setUp(self): # First, upload something. self.asset_name = 'download_test' resp = self.upload_asset(self.asset_name) - self.assertEqual(resp.status_code, 200) + self.assertEqual(resp.status_code, 200) # noqa: PT009 self.uploaded_url = json.loads(resp.content.decode('utf-8'))['asset']['url'] def test_download(self): # Now, download it. resp = self.client.get(self.uploaded_url, HTTP_ACCEPT='text/html') - self.assertEqual(resp.status_code, 200) + self.assertEqual(resp.status_code, 200) # noqa: PT009 self.assertContains(resp, 'This file is generated by python unit test') def test_download_not_found_throw(self): url = self.uploaded_url.replace(self.asset_name, 'not_the_asset_name') resp = self.client.get(url, HTTP_ACCEPT='text/html') - self.assertEqual(resp.status_code, 404) + self.assertEqual(resp.status_code, 404) # noqa: PT009 @patch('xmodule.modulestore.mixed.MixedModuleStore.find_asset_metadata') def test_pickling_calls(self, patched_find_asset_metadata): @@ -416,7 +420,7 @@ def test_pickling_calls(self, patched_find_asset_metadata): """ patched_find_asset_metadata.return_value = None self.client.get(self.uploaded_url, HTTP_ACCEPT='text/html') - self.assertFalse(patched_find_asset_metadata.called) + self.assertFalse(patched_find_asset_metadata.called) # noqa: PT009 class AssetToJsonTestCase(AssetsTestCase): @@ -436,20 +440,20 @@ def test_basic(self): output = assets._get_asset_json("my_file", content_type, upload_date, location, thumbnail_location, True, course_key) - self.assertEqual(output["display_name"], "my_file") - self.assertEqual(output["date_added"], "Jun 01, 2013 at 10:30 UTC") - self.assertEqual(output["url"], "/asset-v1:org+class+run+type@asset+block@my_file_name.jpg") - self.assertEqual( + self.assertEqual(output["display_name"], "my_file") # noqa: PT009 + self.assertEqual(output["date_added"], "Jun 01, 2013 at 10:30 UTC") # noqa: PT009 + self.assertEqual(output["url"], "/asset-v1:org+class+run+type@asset+block@my_file_name.jpg") # noqa: PT009 + self.assertEqual( # noqa: PT009 output["external_url"], "https://lms_root_url/asset-v1:org+class+run+type@asset+block@my_file_name.jpg" ) - self.assertEqual(output["portable_url"], "/static/my_file_name.jpg") - self.assertEqual(output["thumbnail"], "/asset-v1:org+class+run+type@thumbnail+block@my_file_name_thumb.jpg") - self.assertEqual(output["id"], str(location)) - self.assertEqual(output['locked'], True) - self.assertEqual(output['static_full_url'], '/asset-v1:org+class+run+type@asset+block@my_file_name.jpg') + self.assertEqual(output["portable_url"], "/static/my_file_name.jpg") # noqa: PT009 + self.assertEqual(output["thumbnail"], "/asset-v1:org+class+run+type@thumbnail+block@my_file_name_thumb.jpg") # noqa: PT009 # pylint: disable=line-too-long + self.assertEqual(output["id"], str(location)) # noqa: PT009 + self.assertEqual(output['locked'], True) # noqa: PT009 + self.assertEqual(output['static_full_url'], '/asset-v1:org+class+run+type@asset+block@my_file_name.jpg') # noqa: PT009 # pylint: disable=line-too-long output = assets._get_asset_json("name", content_type, upload_date, location, None, False, course_key) - self.assertIsNone(output["thumbnail"]) + self.assertIsNone(output["thumbnail"]) # noqa: PT009 class LockAssetTestCase(AssetsTestCase): @@ -466,7 +470,7 @@ def verify_asset_locked_state(locked): asset_location = StaticContent.get_location_from_path( 'asset-v1:edX+toy+2012_Fall+type@asset+block@sample_static.html') content = contentstore().find(asset_location) - self.assertEqual(content.locked, locked) + self.assertEqual(content.locked, locked) # noqa: PT009 def post_asset_update(lock, course): """ Helper method for posting asset update. """ @@ -486,7 +490,7 @@ def post_asset_update(lock, course): "application/json" ) - self.assertEqual(resp.status_code, 201) + self.assertEqual(resp.status_code, 201) # noqa: PT009 return json.loads(resp.content.decode('utf-8')) # Load the toy course. @@ -505,12 +509,12 @@ def post_asset_update(lock, course): # Lock the asset resp_asset = post_asset_update(True, course) - self.assertTrue(resp_asset['locked']) + self.assertTrue(resp_asset['locked']) # noqa: PT009 verify_asset_locked_state(True) # Unlock the asset resp_asset = post_asset_update(False, course) - self.assertFalse(resp_asset['locked']) + self.assertFalse(resp_asset['locked']) # noqa: PT009 verify_asset_locked_state(False) @@ -527,7 +531,7 @@ def setUp(self): self.asset = self.get_sample_asset(self.asset_name) response = self.client.post(self.url, {"name": self.asset_name, "file": self.asset}) - self.assertEqual(response.status_code, 200) + self.assertEqual(response.status_code, 200) # noqa: PT009 self.uploaded_id = json.loads(response.content.decode('utf-8'))['asset']['id'] self.asset_location = AssetKey.from_string(self.uploaded_id) @@ -538,7 +542,7 @@ def test_delete_asset(self): test_url = reverse_course_url( 'assets_handler', self.course.id, kwargs={'asset_key_string': self.uploaded_id}) resp = self.client.delete(test_url, HTTP_ACCEPT="application/json") - self.assertEqual(resp.status_code, 204) + self.assertEqual(resp.status_code, 204) # noqa: PT009 def test_delete_image_type_asset(self): """ Tests deletion of image type asset """ @@ -547,12 +551,12 @@ def test_delete_image_type_asset(self): # upload image response = self.client.post(self.url, {"name": "delete_image_test", "file": image_asset}) - self.assertEqual(response.status_code, 200) + self.assertEqual(response.status_code, 200) # noqa: PT009 uploaded_image_url = json.loads(response.content.decode('utf-8'))['asset']['id'] # upload image thumbnail response = self.client.post(self.url, {"name": "delete_image_thumb_test", "file": thumbnail_image_asset}) - self.assertEqual(response.status_code, 200) + self.assertEqual(response.status_code, 200) # noqa: PT009 thumbnail_url = json.loads(response.content.decode('utf-8'))['asset']['url'] thumbnail_location = StaticContent.get_location_from_path(thumbnail_url) @@ -567,7 +571,7 @@ def test_delete_image_type_asset(self): test_url = reverse_course_url( 'assets_handler', self.course.id, kwargs={'asset_key_string': str(uploaded_image_url)}) resp = self.client.delete(test_url, HTTP_ACCEPT="application/json") - self.assertEqual(resp.status_code, 204) + self.assertEqual(resp.status_code, 204) # noqa: PT009 def test_delete_asset_with_invalid_asset(self): """ Tests the sad path :( """ @@ -576,7 +580,7 @@ def test_delete_asset_with_invalid_asset(self): self.course.id, kwargs={'asset_key_string': "asset-v1:edX+toy+2012_Fall+type@asset+block@invalid.pdf"} ) resp = self.client.delete(test_url, HTTP_ACCEPT="application/json") - self.assertEqual(resp.status_code, 404) + self.assertEqual(resp.status_code, 404) # noqa: PT009 def test_delete_asset_with_invalid_thumbnail(self): """ Tests the sad path :( """ @@ -586,4 +590,154 @@ def test_delete_asset_with_invalid_thumbnail(self): '/asset-v1:edX+toy+2012_Fall+type@asset+block@invalid.pdf') contentstore().save(self.content) resp = self.client.delete(test_url, HTTP_ACCEPT="application/json") - self.assertEqual(resp.status_code, 204) + self.assertEqual(resp.status_code, 204) # noqa: PT009 + + +class AssetsEndpointsAuthzTestCase(CourseAuthzTestMixin, AssetsTestCase): + """ + Unit tests for validating authorization on Assets endpoints when AuthZ is enabled. + """ + + authz_roles_to_assign = [] + + @property + def course_key(self): + return self.course.id + + def setUp(self): + super().setUp() + + # Upload a file for GET/PUT/DELETE tests + r = self.upload_asset('authz_test_file') + + if r.status_code == 200: + sample_asset_key = json.loads(r.content.decode('utf-8'))['asset']['id'] + self.asset_url = reverse_course_url( + 'assets_handler', + self.course.id, + kwargs={'asset_key_string': sample_asset_key} + ) + self.asset_usage_url = reverse_course_url( + 'asset_usage_path_handler', + self.course.id, + kwargs={'asset_key_string': sample_asset_key} + ) + + def _put_asset(self, client): + # Simulate a PUT (edit) request with a JSON body + return client.put( + self.asset_url, + data=json.dumps({"locked": True}), + content_type="application/json" + ) + + def _delete_asset(self, client): + return client.delete(self.asset_url, HTTP_ACCEPT="application/json") + + def test_auditor_permissions(self): + """Auditor: read allowed, write/edit/delete forbidden.""" + user = UserFactory(password=self.user_password) + self.add_user_to_role(user, COURSE_AUDITOR.external_key) + + client = APIClient() + client.login(username=user.username, password=self.user_password) + + # GET assets_handler allowed + resp = client.get(self.asset_url) + self.assertEqual(resp.status_code, 200) # noqa: PT009 + + # GET asset_usage_path_handler allowed + resp = client.get(self.asset_usage_url) + self.assertEqual(resp.status_code, 200) # noqa: PT009 + + # POST assets_handler forbidden + resp = client.post(self.url, {"name": "file", "file": self.get_sample_asset('file')}) + self.assertEqual(resp.status_code, 403) # noqa: PT009 + + # PUT assets_handler forbidden + resp = self._put_asset(client) + self.assertEqual(resp.status_code, 403) # noqa: PT009 + + # DELETE assets_handler forbidden + resp = self._delete_asset(client) + self.assertEqual(resp.status_code, 403) # noqa: PT009 + + def test_editor_permissions(self): + """Editor: read/create/edit allowed, delete forbidden.""" + user = UserFactory(password=self.user_password) + self.add_user_to_role(user, COURSE_EDITOR.external_key) + client = APIClient() + client.login(username=user.username, password=self.user_password) + + # GET assets_handler allowed + resp = client.get(self.url) + self.assertEqual(resp.status_code, 200) # noqa: PT009 + + # GET asset_usage_path_handler allowed + resp = client.get(self.asset_usage_url) + self.assertEqual(resp.status_code, 200) # noqa: PT009 + + # POST assets_handler allowed + resp = client.post(self.url, {"name": "file", "file": self.get_sample_asset('file')}) + self.assertEqual(resp.status_code, 200) # noqa: PT009 + + # PUT assets_handler allowed + resp = self._put_asset(client) + self.assertIn(resp.status_code, [200, 201]) # noqa: PT009 + + # DELETE assets_handler forbidden + resp = self._delete_asset(client) + self.assertEqual(resp.status_code, 403) # noqa: PT009 + + def test_admin_permissions(self): + """Admin: full access.""" + user = UserFactory(password=self.user_password) + self.add_user_to_role(user, COURSE_ADMIN.external_key) + client = APIClient() + client.login(username=user.username, password=self.user_password) + + # GET assets_handler allowed + resp = client.get(self.url) + self.assertEqual(resp.status_code, 200) # noqa: PT009 + + # GET asset_usage_path_handler allowed + resp = client.get(self.asset_usage_url) + self.assertEqual(resp.status_code, 200) # noqa: PT009 + + # POST assets_handler allowed + resp = client.post(self.url, {"name": "file", "file": self.get_sample_asset('file')}) + self.assertEqual(resp.status_code, 200) # noqa: PT009 + + # PUT assets_handler allowed + resp = self._put_asset(client) + self.assertIn(resp.status_code, [200, 201]) # noqa: PT009 + + # DELETE assets_handler allowed + resp = self._delete_asset(client) + self.assertEqual(resp.status_code, 204) # noqa: PT009 + + def test_no_role_permissions(self): + """No role: all forbidden.""" + user = UserFactory(password=self.user_password) + client = APIClient() + client.login(username=user.username, password=self.user_password) + + # GET assets_handler forbidden + resp = client.get(self.url) + self.assertEqual(resp.status_code, 403) # noqa: PT009 + + # GET asset_usage_path_handler forbidden + resp = client.get(self.asset_usage_url) + self.assertEqual(resp.status_code, 403) # noqa: PT009 + + # POST assets_handler forbidden + resp = client.post(self.url, {"name": "file", "file": self.get_sample_asset('file')}) + self.assertEqual(resp.status_code, 403) # noqa: PT009 + + # PUT assets_handler forbidden + resp = self._put_asset(client) + self.assertEqual(resp.status_code, 403) # noqa: PT009 + + # DELETE assets_handler forbidden + resp = self._delete_asset(client) + self.assertEqual(resp.status_code, 403) # noqa: PT009 diff --git a/cms/djangoapps/contentstore/views/tests/test_block.py b/cms/djangoapps/contentstore/views/tests/test_block.py index 846c62d2436a..d5441ac8bca7 100644 --- a/cms/djangoapps/contentstore/views/tests/test_block.py +++ b/cms/djangoapps/contentstore/views/tests/test_block.py @@ -7,23 +7,23 @@ from unittest.mock import Mock, PropertyMock, patch import ddt +from bs4 import BeautifulSoup from django.conf import settings from django.http import Http404 from django.test import TestCase from django.test.client import RequestFactory -from django.urls import reverse from django.test.utils import override_settings -from openedx.core.djangoapps.video_config.toggles import PUBLIC_VIDEO_SHARE -from openedx_events.content_authoring.data import DuplicatedXBlockData -from openedx_events.content_authoring.signals import XBLOCK_DUPLICATED -from openedx_events.tests.utils import OpenEdxEventsTestMixin +from django.urls import reverse from edx_proctoring.exceptions import ProctoredExamNotFoundException from opaque_keys import InvalidKeyError from opaque_keys.edx.asides import AsideUsageKeyV2 from opaque_keys.edx.keys import CourseKey, UsageKey from opaque_keys.edx.locator import BlockUsageLocator, CourseLocator +from openedx_authz.constants.roles import COURSE_ADMIN, COURSE_AUDITOR, COURSE_EDITOR, COURSE_STAFF +from openedx_events.content_authoring.data import DuplicatedXBlockData +from openedx_events.content_authoring.signals import XBLOCK_DUPLICATED +from openedx_events.testing import OpenEdxEventsTestMixin from pytz import UTC -from bs4 import BeautifulSoup from web_fragments.fragment import Fragment from webob import Response from xblock.core import XBlockAside @@ -32,37 +32,20 @@ from xblock.runtime import DictKeyValueStore, KvsFieldData from xblock.test.tools import TestRuntime from xblock.validation import ValidationMessage -from xmodule.course_block import DEFAULT_START_DATE -from xmodule.modulestore import ModuleStoreEnum -from xmodule.modulestore.django import modulestore -from xmodule.modulestore.exceptions import ItemNotFoundError -from xmodule.modulestore.tests.django_utils import ( - TEST_DATA_SPLIT_MODULESTORE, - ModuleStoreTestCase, -) -from xmodule.modulestore.tests.factories import ( - CourseFactory, - BlockFactory, - LibraryFactory, - check_mongo_calls, -) -from xmodule.partitions.partitions import ( - ENROLLMENT_TRACK_PARTITION_ID, - MINIMUM_UNUSED_PARTITION_ID, - Group, - UserPartition, -) -from xmodule.partitions.tests.test_partitions import MockPartitionService -from xmodule.x_module import STUDENT_VIEW, STUDIO_VIEW from cms.djangoapps.contentstore.tests.utils import CourseTestCase -from cms.djangoapps.contentstore.utils import ( - reverse_course_url, - reverse_usage_url, - duplicate_block, - update_from_source, -) +from cms.djangoapps.contentstore.utils import duplicate_block, reverse_course_url, reverse_usage_url, update_from_source from cms.djangoapps.contentstore.xblock_storage_handlers import view_handlers as item_module +from cms.djangoapps.contentstore.xblock_storage_handlers.view_handlers import ( + ALWAYS, + VisibilityState, + _get_metadata_with_problem_defaults, + _get_source_index, + _xblock_type_and_display_name, + add_container_page_publishing_info, + create_xblock_info, + get_block_info, +) from common.djangoapps.student.tests.factories import StaffFactory, UserFactory from common.djangoapps.xblock_django.models import ( XBlockConfiguration, @@ -70,21 +53,28 @@ XBlockStudioConfigurationFlag, ) from common.djangoapps.xblock_django.user_service import DjangoXBlockUserService +from common.test.utils import assert_dict_contains_subset from lms.djangoapps.lms_xblock.mixin import NONSENSICAL_ACCESS_RESTRICTION -from openedx.core.djangoapps.discussions.models import DiscussionsConfiguration +from openedx.core.djangoapps.authz.tests.mixins import CourseAuthoringAuthzTestMixin from openedx.core.djangoapps.content_tagging import api as tagging_api - -from ..component import component_handler, DEFAULT_ADVANCED_MODULES, get_component_templates -from cms.djangoapps.contentstore.xblock_storage_handlers.view_handlers import ( - ALWAYS, - VisibilityState, - get_block_info, - _get_source_index, - _xblock_type_and_display_name, - add_container_page_publishing_info, - create_xblock_info, +from openedx.core.djangoapps.discussions.models import DiscussionsConfiguration +from openedx.core.djangoapps.video_config.toggles import PUBLIC_VIDEO_SHARE +from xmodule.course_block import DEFAULT_START_DATE +from xmodule.modulestore import ModuleStoreEnum +from xmodule.modulestore.django import modulestore +from xmodule.modulestore.exceptions import ItemNotFoundError +from xmodule.modulestore.tests.django_utils import TEST_DATA_SPLIT_MODULESTORE, ModuleStoreTestCase +from xmodule.modulestore.tests.factories import BlockFactory, CourseFactory, LibraryFactory, check_mongo_calls +from xmodule.partitions.partitions import ( + ENROLLMENT_TRACK_PARTITION_ID, + MINIMUM_UNUSED_PARTITION_ID, + Group, + UserPartition, ) -from common.test.utils import assert_dict_contains_subset +from xmodule.partitions.tests.test_partitions import MockPartitionService +from xmodule.x_module import STUDENT_VIEW, STUDIO_VIEW + +from ..component import DEFAULT_ADVANCED_MODULES, component_handler, get_component_templates class AsideTest(XBlockAside): @@ -126,7 +116,7 @@ def response_usage_key(self, response): :param response: """ parsed = json.loads(response.content.decode("utf-8")) - self.assertEqual(response.status_code, 200) + self.assertEqual(response.status_code, 200) # noqa: PT009 key = UsageKey.from_string(parsed["locator"]) if key.course_key.run is None: key = key.map_into_course(CourseKey.from_string(parsed["courseKey"])) @@ -134,7 +124,7 @@ def response_usage_key(self, response): def create_xblock( self, parent_usage_key=None, display_name=None, category=None, boilerplate=None - ): # lint-amnesty, pylint: disable=missing-function-docstring + ): # pylint: disable=missing-function-docstring data = { "parent_locator": str(self.usage_key) if parent_usage_key is None @@ -154,7 +144,7 @@ def _create_vertical(self, parent_usage_key=None): resp = self.create_xblock( category="vertical", parent_usage_key=parent_usage_key ) - self.assertEqual(resp.status_code, 200) + self.assertEqual(resp.status_code, 200) # noqa: PT009 return self.response_usage_key(resp) @@ -176,12 +166,12 @@ def _get_container_preview(self, usage_key, data=None): Returns the HTML and resources required for the xblock at the specified UsageKey """ resp = self._get_preview(usage_key, data) - self.assertEqual(resp.status_code, 200) + self.assertEqual(resp.status_code, 200) # noqa: PT009 resp_content = json.loads(resp.content.decode("utf-8")) html = resp_content["html"] - self.assertTrue(html) + self.assertTrue(html) # noqa: PT009 resources = resp_content["resources"] - self.assertIsNotNone(resources) + self.assertIsNotNone(resources) # noqa: PT009 return html, resources def _get_container_preview_with_error( @@ -189,7 +179,7 @@ def _get_container_preview_with_error( ): """Make request and asserts on response code and response contents""" resp = self._get_preview(usage_key, data) - self.assertEqual(resp.status_code, expected_code) + self.assertEqual(resp.status_code, expected_code) # noqa: PT009 if content_contains: self.assertContains(resp, content_contains, status_code=expected_code) return resp @@ -201,20 +191,20 @@ def test_get_vertical(self): # Retrieve it resp = self.client.get(reverse_usage_url("xblock_handler", usage_key)) - self.assertEqual(resp.status_code, 200) + self.assertEqual(resp.status_code, 200) # noqa: PT009 def test_get_empty_container_fragment(self): root_usage_key = self._create_vertical() html, __ = self._get_container_preview(root_usage_key) # XBlock messages are added by the Studio wrapper. - self.assertIn("wrapper-xblock-message", html) + self.assertIn("wrapper-xblock-message", html) # noqa: PT009 # Make sure that "wrapper-xblock" does not appear by itself (without -message at end). - self.assertNotRegex(html, r"wrapper-xblock[^-]+") + self.assertNotRegex(html, r"wrapper-xblock[^-]+") # noqa: PT009 # Verify that the header and article tags are still added - self.assertIn('
', html) - self.assertIn('
', html) + self.assertIn('
', html) # noqa: PT009 + self.assertIn('
', html) # noqa: PT009 def test_get_container_fragment(self): root_usage_key = self._create_vertical() @@ -227,18 +217,18 @@ def test_get_container_fragment(self): parent_usage_key=child_vertical_usage_key, category="problem", ) - self.assertEqual(resp.status_code, 200) + self.assertEqual(resp.status_code, 200) # noqa: PT009 # Get the preview HTML html, __ = self._get_container_preview(root_usage_key) # Verify that the Studio nesting wrapper has been added - self.assertIn("level-nesting", html) - self.assertIn('
', html) - self.assertIn('
', html) + self.assertIn("level-nesting", html) # noqa: PT009 + self.assertIn('
', html) # noqa: PT009 + self.assertIn('
', html) # noqa: PT009 # Verify that the Studio element wrapper has been added - self.assertIn("level-element", html) + self.assertIn("level-element", html) # noqa: PT009 def test_get_container_nested_container_fragment(self): """ @@ -248,23 +238,23 @@ def test_get_container_nested_container_fragment(self): root_usage_key = self._create_vertical() resp = self.create_xblock(parent_usage_key=root_usage_key, category="wrapper") - self.assertEqual(resp.status_code, 200) + self.assertEqual(resp.status_code, 200) # noqa: PT009 wrapper_usage_key = self.response_usage_key(resp) resp = self.create_xblock( parent_usage_key=wrapper_usage_key, category="problem", ) - self.assertEqual(resp.status_code, 200) + self.assertEqual(resp.status_code, 200) # noqa: PT009 # Get the preview HTML and verify the View -> link is present. html, __ = self._get_container_preview(root_usage_key) - self.assertIn("wrapper-xblock", html) - self.assertRegex( + self.assertIn("wrapper-xblock", html) # noqa: PT009 + self.assertRegex( # noqa: PT009 html, # The instance of the wrapper class will have an auto-generated ID. Allow any # characters after wrapper. - ( + ( # noqa: UP032 '"/container/{}" class="action-button xblock-view-action-button">' '\\s*View' ).format(re.escape(str(wrapper_usage_key))), @@ -282,7 +272,7 @@ def test_tag_count_in_container_fragment(self, mock_get_object_tag_counts): parent_usage_key=child_vertical_usage_key, category="problem", ) - self.assertEqual(resp.status_code, 200) + self.assertEqual(resp.status_code, 200) # noqa: PT009 usage_key = self.response_usage_key(resp) # Get the preview HTML with tags @@ -290,8 +280,8 @@ def test_tag_count_in_container_fragment(self, mock_get_object_tag_counts): str(usage_key): 13, } html, __ = self._get_container_preview(root_usage_key) - self.assertIn("wrapper-xblock", html) - self.assertIn('data-testid="tag-count-button"', html) + self.assertIn("wrapper-xblock", html) # noqa: PT009 + self.assertIn('data-testid="tag-count-button"', html) # noqa: PT009 def test_split_test(self): """ @@ -306,12 +296,12 @@ def test_split_test(self): parent_usage_key=split_test_usage_key, category="html", ) - self.assertEqual(resp.status_code, 200) + self.assertEqual(resp.status_code, 200) # noqa: PT009 resp = self.create_xblock( parent_usage_key=split_test_usage_key, category="html", ) - self.assertEqual(resp.status_code, 200) + self.assertEqual(resp.status_code, 200) # noqa: PT009 def test_split_test_edited(self): """ @@ -336,8 +326,8 @@ def test_split_test_edited(self): data={"metadata": {"user_partition_id": str(0)}}, ) html, __ = self._get_container_preview(split_test_usage_key) - self.assertIn("alpha", html) - self.assertIn("beta", html) + self.assertIn("alpha", html) # noqa: PT009 + self.assertIn("beta", html) # noqa: PT009 # Rename groups in group configuration GROUP_CONFIGURATION_JSON = { @@ -363,12 +353,12 @@ def test_split_test_edited(self): HTTP_ACCEPT="application/json", HTTP_X_REQUESTED_WITH="XMLHttpRequest", ) - self.assertEqual(response.status_code, 201) + self.assertEqual(response.status_code, 201) # noqa: PT009 html, __ = self._get_container_preview(split_test_usage_key) - self.assertNotIn("alpha", html) - self.assertNotIn("beta", html) - self.assertIn("New_NAME_A", html) - self.assertIn("New_NAME_B", html) + self.assertNotIn("alpha", html) # noqa: PT009 + self.assertNotIn("beta", html) # noqa: PT009 + self.assertIn("New_NAME_A", html) # noqa: PT009 + self.assertIn("New_NAME_B", html) # noqa: PT009 def test_valid_paging(self): """ @@ -389,8 +379,8 @@ def test_valid_paging(self): ) call_args = patched_get_preview_fragment.call_args[0] _, _, context = call_args - self.assertIn("paging", context) - self.assertEqual({"page_number": 0, "page_size": 2}, context["paging"]) + self.assertIn("paging", context) # noqa: PT009 + self.assertEqual({"page_number": 0, "page_size": 2}, context["paging"]) # noqa: PT009 @ddt.data([1, "invalid"], ["invalid", 2]) @ddt.unpack @@ -435,11 +425,11 @@ def test_get_user_partitions_and_groups(self): resp = self.create_xblock(category="vertical") usage_key = self.response_usage_key(resp) resp = self.client.get(reverse_usage_url("xblock_handler", usage_key)) - self.assertEqual(resp.status_code, 200) + self.assertEqual(resp.status_code, 200) # noqa: PT009 # Check that the partition and group information was returned result = json.loads(resp.content.decode("utf-8")) - self.assertEqual( + self.assertEqual( # noqa: PT009 result["user_partitions"], [ { @@ -476,7 +466,7 @@ def test_get_user_partitions_and_groups(self): }, ], ) - self.assertEqual(result["group_access"], {}) + self.assertEqual(result["group_access"], {}) # noqa: PT009 @ddt.data("ancestorInfo", "") def test_ancestor_info(self, field_type): @@ -526,9 +516,9 @@ def assert_xblock_info(xblock, xblock_info): xblock (XBlock): An XBlock item. xblock_info (dict): A dict containing xblock information. """ - self.assertEqual(str(xblock.location), xblock_info["id"]) - self.assertEqual(xblock.display_name, xblock_info["display_name"]) - self.assertEqual(xblock.category, xblock_info["category"]) + self.assertEqual(str(xblock.location), xblock_info["id"]) # noqa: PT009 + self.assertEqual(xblock.display_name, xblock_info["display_name"]) # noqa: PT009 + self.assertEqual(xblock.category, xblock_info["category"]) # noqa: PT009 for usage_key in ( problem_usage_key, @@ -541,18 +531,18 @@ def assert_xblock_info(xblock, xblock_info): reverse_usage_url("xblock_handler", usage_key) + f"?fields={field_type}" ) response = self.client.get(url) - self.assertEqual(response.status_code, 200) + self.assertEqual(response.status_code, 200) # noqa: PT009 response = json.loads(response.content.decode("utf-8")) if field_type == "ancestorInfo": - self.assertIn("ancestors", response) + self.assertIn("ancestors", response) # noqa: PT009 for ancestor_info in response["ancestors"]: parent_xblock = xblock.get_parent() assert_xblock_info(parent_xblock, ancestor_info) xblock = parent_xblock else: - self.assertNotIn("ancestors", response) + self.assertNotIn("ancestors", response) # noqa: PT009 xblock_info = get_block_info(xblock) - self.assertEqual(xblock_info, response) + self.assertEqual(xblock_info, response) # noqa: PT009 @ddt.ddt @@ -569,7 +559,7 @@ def test_delete_static_page(self): # Now delete it. There was a bug that the delete was failing (static tabs do not exist in draft modulestore). resp = self.client.delete(reverse_usage_url("xblock_handler", usage_key)) - self.assertEqual(resp.status_code, 204) + self.assertEqual(resp.status_code, 204) # noqa: PT009 class TestCreateItem(ItemTest): @@ -588,14 +578,14 @@ def test_create_nicely(self): # get the new item and check its category and display_name chap_usage_key = self.response_usage_key(resp) new_obj = self.get_item_from_modulestore(chap_usage_key) - self.assertEqual(new_obj.scope_ids.block_type, "chapter") - self.assertEqual(new_obj.display_name, display_name) - self.assertEqual(new_obj.location.org, self.course.location.org) - self.assertEqual(new_obj.location.course, self.course.location.course) + self.assertEqual(new_obj.scope_ids.block_type, "chapter") # noqa: PT009 + self.assertEqual(new_obj.display_name, display_name) # noqa: PT009 + self.assertEqual(new_obj.location.org, self.course.location.org) # noqa: PT009 + self.assertEqual(new_obj.location.course, self.course.location.course) # noqa: PT009 # get the course and ensure it now points to this one course = self.get_item_from_modulestore(self.usage_key) - self.assertIn(chap_usage_key, course.children) + self.assertIn(chap_usage_key, course.children) # noqa: PT009 def test_create_block_negative(self): """ @@ -603,14 +593,14 @@ def test_create_block_negative(self): """ # non-existent boilerplate: creates a default resp = self.create_xblock(category="problem") - self.assertEqual(resp.status_code, 200) + self.assertEqual(resp.status_code, 200) # noqa: PT009 def test_create_with_future_date(self): - self.assertEqual(self.course.start, datetime(2030, 1, 1, tzinfo=UTC)) + self.assertEqual(self.course.start, DEFAULT_START_DATE) # noqa: PT009 resp = self.create_xblock(category="chapter") usage_key = self.response_usage_key(resp) obj = self.get_item_from_modulestore(usage_key) - self.assertEqual(obj.start, datetime(2030, 1, 1, tzinfo=UTC)) + self.assertEqual(obj.start, DEFAULT_START_DATE) # noqa: PT009 def test_static_tabs_initialization(self): """ @@ -622,7 +612,7 @@ def test_static_tabs_initialization(self): # Check that its name is not None new_tab = self.get_item_from_modulestore(usage_key) - self.assertEqual(new_tab.display_name, "Empty") + self.assertEqual(new_tab.display_name, "Empty") # noqa: PT009 class DuplicateHelper: @@ -636,7 +626,7 @@ def _duplicate_and_verify( """Duplicates the source, parenting to supplied parent. Then does equality check.""" usage_key = self._duplicate_item(parent_usage_key, source_usage_key) # pylint: disable=no-member - self.assertTrue( + self.assertTrue( # noqa: PT009 self._check_equality( source_usage_key, usage_key, parent_usage_key, check_asides=check_asides ), @@ -664,16 +654,16 @@ def _check_equality( if check_asides: original_asides = original_item.runtime.get_asides(original_item) duplicated_asides = duplicated_item.runtime.get_asides(duplicated_item) - self.assertEqual(len(original_asides), 1) - self.assertEqual(len(duplicated_asides), 1) - self.assertEqual(original_asides[0].field11, duplicated_asides[0].field11) - self.assertEqual(original_asides[0].field12, duplicated_asides[0].field12) - self.assertNotEqual( + self.assertEqual(len(original_asides), 1) # noqa: PT009 + self.assertEqual(len(duplicated_asides), 1) # noqa: PT009 + self.assertEqual(original_asides[0].field11, duplicated_asides[0].field11) # noqa: PT009 + self.assertEqual(original_asides[0].field12, duplicated_asides[0].field12) # noqa: PT009 + self.assertNotEqual( # noqa: PT009 original_asides[0].field13, duplicated_asides[0].field13 ) - self.assertEqual(duplicated_asides[0].field13, "aside1_default_value3") + self.assertEqual(duplicated_asides[0].field13, "aside1_default_value3") # noqa: PT009 - self.assertNotEqual( + self.assertNotEqual( # noqa: PT009 str(original_item.location), str(duplicated_item.location), "Location of duplicate should be different from original", @@ -682,13 +672,13 @@ def _check_equality( # Parent will only be equal for root of duplicated structure, in the case # where an item is duplicated in-place. if parent_usage_key and str(original_item.parent) == str(parent_usage_key): - self.assertEqual( + self.assertEqual( # noqa: PT009 str(parent_usage_key), str(duplicated_item.parent), "Parent of duplicate should equal parent of source for root xblock when duplicated in-place", ) else: - self.assertNotEqual( + self.assertNotEqual( # noqa: PT009 str(original_item.parent), str(duplicated_item.parent), "Parent duplicate should be different from source", @@ -702,7 +692,7 @@ def _check_equality( # Children will also be duplicated, so for the purposes of testing equality, we will set # the children to the original after recursively checking the children. if original_item.has_children: - self.assertEqual( + self.assertEqual( # noqa: PT009 len(original_item.children), len(duplicated_item.children), "Duplicated item differs in number of children", @@ -732,11 +722,11 @@ def _verify_duplicate_display_name( if original_item.display_name is not None: return ( duplicated_item.display_name - == "Duplicate of '{display_name}'".format( + == "Duplicate of '{display_name}'".format( # noqa: UP032 display_name=original_item.display_name ) ) - return duplicated_item.display_name == "Duplicate of {display_name}".format( + return duplicated_item.display_name == "Duplicate of {display_name}".format( # noqa: UP032 display_name=original_item.category ) @@ -756,7 +746,7 @@ def _duplicate_item(self, parent_usage_key, source_usage_key, display_name=None) return self.response_usage_key(resp) -class TestDuplicateItem(ItemTest, DuplicateHelper, OpenEdxEventsTestMixin): +class TestDuplicateItem(OpenEdxEventsTestMixin, ItemTest, DuplicateHelper): """ Test the duplicate method. """ @@ -765,22 +755,6 @@ class TestDuplicateItem(ItemTest, DuplicateHelper, OpenEdxEventsTestMixin): "org.openedx.content_authoring.xblock.duplicated.v1", ] - @classmethod - def setUpClass(cls): - """ - Set up class method for the Test class. - This method starts manually events isolation. Explanation here: - openedx/core/djangoapps/user_authn/views/tests/test_events.py#L44 - """ - super().setUpClass() - cls.start_events_isolation() - - @classmethod - def tearDownClass(cls): - """ Don't let our event isolation affect other test cases """ - super().tearDownClass() - cls.enable_all_events() # Re-enable events other than the ENABLED_OPENEDX_EVENTS subset we isolated. - def setUp(self): """Creates the test course structure and a few components to 'duplicate'.""" super().setUp() @@ -858,21 +832,21 @@ def verify_order(source_usage_key, parent_usage_key, source_position=None): parent = self.get_item_from_modulestore(parent_usage_key) children = parent.children if source_position is None: - self.assertNotIn( + self.assertNotIn( # noqa: PT009 source_usage_key, children, "source item not expected in children array", ) - self.assertEqual( + self.assertEqual( # noqa: PT009 children[len(children) - 1], usage_key, "duplicated item not at end" ) else: - self.assertEqual( + self.assertEqual( # noqa: PT009 children[source_position], source_usage_key, "source item at wrong position", ) - self.assertEqual( + self.assertEqual( # noqa: PT009 children[source_position + 1], usage_key, "duplicated item not ordered after source item", @@ -900,7 +874,7 @@ def verify_name( parent_usage_key, source_usage_key, display_name ) duplicated_item = self.get_item_from_modulestore(usage_key) - self.assertEqual(duplicated_item.display_name, expected_name) + self.assertEqual(duplicated_item.display_name, expected_name) # noqa: PT009 return usage_key # Uses default display_name of 'Text' from HTML component. @@ -931,7 +905,7 @@ def test_shallow_duplicate(self): BlockFactory(parent=source_chapter, category="html", display_name="Child") # Refresh. source_chapter = self.store.get_item(source_chapter.location) - self.assertEqual(len(source_chapter.get_children()), 1) + self.assertEqual(len(source_chapter.get_children()), 1) # noqa: PT009 destination_course = CourseFactory() destination_location = duplicate_block( parent_usage_key=destination_course.location, @@ -942,8 +916,8 @@ def test_shallow_duplicate(self): ) # Refresh here, too, just to be sure. destination_chapter = self.store.get_item(destination_location) - self.assertEqual(len(destination_chapter.get_children()), 0) - self.assertEqual(destination_chapter.display_name, "Source Chapter") + self.assertEqual(len(destination_chapter.get_children()), 0) # noqa: PT009 + self.assertEqual(destination_chapter.display_name, "Source Chapter") # noqa: PT009 def test_duplicate_library_content_block(self): # pylint: disable=too-many-statements """ @@ -1109,7 +1083,7 @@ def test_duplicate_tags(self): user=user, ) dupe_chapter = self.store.get_item(dupe_location) - self.assertEqual(len(dupe_chapter.get_children()), 1) + self.assertEqual(len(dupe_chapter.get_children()), 1) # noqa: PT009 dupe_block = dupe_chapter.get_children()[0] # Check that the duplicated blocks also duplicated tags @@ -1237,8 +1211,8 @@ def setup_and_verify_content_experiment(self, partition_id): split_test = self.get_item_from_modulestore(self.split_test_usage_key) # Initially, no user_partition_id is set, and the split_test has no children. - self.assertEqual(split_test.user_partition_id, -1) - self.assertEqual(len(split_test.children), 0) + self.assertEqual(split_test.user_partition_id, -1) # noqa: PT009 + self.assertEqual(len(split_test.children), 0) # noqa: PT009 # Set group configuration self.client.ajax_post( @@ -1246,8 +1220,8 @@ def setup_and_verify_content_experiment(self, partition_id): data={"metadata": {"user_partition_id": str(partition_id)}}, ) split_test = self.get_item_from_modulestore(self.split_test_usage_key) - self.assertEqual(split_test.user_partition_id, partition_id) - self.assertEqual( + self.assertEqual(split_test.user_partition_id, partition_id) # noqa: PT009 + self.assertEqual( # noqa: PT009 len(split_test.children), len(self.course.user_partitions[partition_id].groups), ) @@ -1292,24 +1266,24 @@ def assert_move_item(self, source_usage_key, target_usage_key, target_index=None response = self._move_component( source_usage_key, target_usage_key, target_index ) - self.assertEqual(response.status_code, 200) + self.assertEqual(response.status_code, 200) # noqa: PT009 response = json.loads(response.content.decode("utf-8")) - self.assertEqual(response["move_source_locator"], str(source_usage_key)) - self.assertEqual(response["parent_locator"], str(target_usage_key)) - self.assertEqual(response["source_index"], expected_index) + self.assertEqual(response["move_source_locator"], str(source_usage_key)) # noqa: PT009 + self.assertEqual(response["parent_locator"], str(target_usage_key)) # noqa: PT009 + self.assertEqual(response["source_index"], expected_index) # noqa: PT009 # Verify parent referance has been changed now. new_parent_loc = self.store.get_parent_location(source_usage_key) source_item = self.get_item_from_modulestore(source_usage_key) - self.assertEqual(source_item.parent, new_parent_loc) - self.assertEqual(new_parent_loc, target_usage_key) - self.assertNotEqual(parent_loc, new_parent_loc) + self.assertEqual(source_item.parent, new_parent_loc) # noqa: PT009 + self.assertEqual(new_parent_loc, target_usage_key) # noqa: PT009 + self.assertNotEqual(parent_loc, new_parent_loc) # noqa: PT009 # Assert item is present in children list of target parent and not source parent target_parent = self.get_item_from_modulestore(target_usage_key) source_parent = self.get_item_from_modulestore(parent_loc) - self.assertIn(source_usage_key, target_parent.children) - self.assertNotIn(source_usage_key, source_parent.children) + self.assertIn(source_usage_key, target_parent.children) # noqa: PT009 + self.assertNotIn(source_usage_key, source_parent.children) # noqa: PT009 def test_move_component(self): """ @@ -1329,7 +1303,7 @@ def test_move_source_index(self): """ parent = self.get_item_from_modulestore(self.vert_usage_key) children = parent.get_children() - self.assertEqual(len(children), 3) + self.assertEqual(len(children), 3) # noqa: PT009 # Create a component within vert2. resp = self.create_xblock( @@ -1341,8 +1315,8 @@ def test_move_source_index(self): self.assert_move_item(html2_usage_key, self.vert_usage_key, 1) parent = self.get_item_from_modulestore(self.vert_usage_key) children = parent.get_children() - self.assertEqual(len(children), 4) - self.assertEqual(children[1].location, html2_usage_key) + self.assertEqual(len(children), 4) # noqa: PT009 + self.assertEqual(children[1].location, html2_usage_key) # noqa: PT009 def test_move_undo(self): """ @@ -1355,22 +1329,22 @@ def test_move_undo(self): # Move component and verify that response contains initial index response = self._move_component(self.html_usage_key, self.vert2_usage_key) response = json.loads(response.content.decode("utf-8")) - self.assertEqual(original_index, response["source_index"]) + self.assertEqual(original_index, response["source_index"]) # noqa: PT009 # Verify that new parent has the moved component at the last index. parent = self.get_item_from_modulestore(self.vert2_usage_key) - self.assertEqual(self.html_usage_key, parent.children[-1]) + self.assertEqual(self.html_usage_key, parent.children[-1]) # noqa: PT009 # Verify original and new index is different now. source_index = _get_source_index(self.html_usage_key, parent) - self.assertNotEqual(original_index, source_index) + self.assertNotEqual(original_index, source_index) # noqa: PT009 # Undo Move to the original index, use the source index fetched from the response. response = self._move_component( self.html_usage_key, self.vert_usage_key, response["source_index"] ) response = json.loads(response.content.decode("utf-8")) - self.assertEqual(original_index, response["source_index"]) + self.assertEqual(original_index, response["source_index"]) # noqa: PT009 def test_move_large_target_index(self): """ @@ -1381,17 +1355,17 @@ def test_move_large_target_index(self): response = self._move_component( self.html_usage_key, self.vert2_usage_key, parent_children_length + 10 ) - self.assertEqual(response.status_code, 400) + self.assertEqual(response.status_code, 400) # noqa: PT009 response = json.loads(response.content.decode("utf-8")) expected_error = ( - "You can not move {usage_key} at an invalid index ({target_index}).".format( + "You can not move {usage_key} at an invalid index ({target_index}).".format( # noqa: UP032 usage_key=self.html_usage_key, target_index=parent_children_length + 10 ) ) - self.assertEqual(expected_error, response["error"]) + self.assertEqual(expected_error, response["error"]) # noqa: PT009 new_parent_loc = self.store.get_parent_location(self.html_usage_key) - self.assertEqual(new_parent_loc, self.vert_usage_key) + self.assertEqual(new_parent_loc, self.vert_usage_key) # noqa: PT009 def test_invalid_move(self): """ @@ -1399,31 +1373,31 @@ def test_invalid_move(self): """ parent_loc = self.store.get_parent_location(self.html_usage_key) response = self._move_component(self.html_usage_key, self.seq_usage_key) - self.assertEqual(response.status_code, 400) + self.assertEqual(response.status_code, 400) # noqa: PT009 response = json.loads(response.content.decode("utf-8")) - expected_error = "You can not move {source_type} into {target_type}.".format( + expected_error = "You can not move {source_type} into {target_type}.".format( # noqa: UP032 source_type=self.html_usage_key.block_type, target_type=self.seq_usage_key.block_type, ) - self.assertEqual(expected_error, response["error"]) + self.assertEqual(expected_error, response["error"]) # noqa: PT009 new_parent_loc = self.store.get_parent_location(self.html_usage_key) - self.assertEqual(new_parent_loc, parent_loc) + self.assertEqual(new_parent_loc, parent_loc) # noqa: PT009 def test_move_current_parent(self): """ Test that a component can not be moved to it's current parent. """ parent_loc = self.store.get_parent_location(self.html_usage_key) - self.assertEqual(parent_loc, self.vert_usage_key) + self.assertEqual(parent_loc, self.vert_usage_key) # noqa: PT009 response = self._move_component(self.html_usage_key, self.vert_usage_key) - self.assertEqual(response.status_code, 400) + self.assertEqual(response.status_code, 400) # noqa: PT009 response = json.loads(response.content.decode("utf-8")) - self.assertEqual( + self.assertEqual( # noqa: PT009 response["error"], "Item is already present in target location." ) - self.assertEqual( + self.assertEqual( # noqa: PT009 self.store.get_parent_location(self.html_usage_key), parent_loc ) @@ -1438,15 +1412,15 @@ def test_can_not_move_into_itself(self): ) library_content_usage_key = self.response_usage_key(library_content) parent_loc = self.store.get_parent_location(library_content_usage_key) - self.assertEqual(parent_loc, self.vert_usage_key) + self.assertEqual(parent_loc, self.vert_usage_key) # noqa: PT009 response = self._move_component( library_content_usage_key, library_content_usage_key ) - self.assertEqual(response.status_code, 400) + self.assertEqual(response.status_code, 400) # noqa: PT009 response = json.loads(response.content.decode("utf-8")) - self.assertEqual(response["error"], "You can not move an item into itself.") - self.assertEqual( + self.assertEqual(response["error"], "You can not move an item into itself.") # noqa: PT009 + self.assertEqual( # noqa: PT009 self.store.get_parent_location(self.html_usage_key), parent_loc ) @@ -1461,7 +1435,7 @@ def test_move_library_content(self): ) library_content_usage_key = self.response_usage_key(library_content) parent_loc = self.store.get_parent_location(library_content_usage_key) - self.assertEqual(parent_loc, self.vert_usage_key) + self.assertEqual(parent_loc, self.vert_usage_key) # noqa: PT009 self.assert_move_item(library_content_usage_key, self.vert2_usage_key) def test_move_into_library_content(self): @@ -1515,14 +1489,14 @@ def test_can_not_move_into_content_experiment_level(self): """ self.setup_and_verify_content_experiment(0) response = self._move_component(self.html_usage_key, self.split_test_usage_key) - self.assertEqual(response.status_code, 400) + self.assertEqual(response.status_code, 400) # noqa: PT009 response = json.loads(response.content.decode("utf-8")) - self.assertEqual( + self.assertEqual( # noqa: PT009 response["error"], "You can not move an item directly into content experiment.", ) - self.assertEqual( + self.assertEqual( # noqa: PT009 self.store.get_parent_location(self.html_usage_key), self.vert_usage_key ) @@ -1537,13 +1511,13 @@ def test_can_not_move_content_experiment_into_its_children(self): response = self._move_component( self.split_test_usage_key, child_vert_usage_key ) - self.assertEqual(response.status_code, 400) + self.assertEqual(response.status_code, 400) # noqa: PT009 response = json.loads(response.content.decode("utf-8")) - self.assertEqual( + self.assertEqual( # noqa: PT009 response["error"], "You can not move an item into it's child." ) - self.assertEqual( + self.assertEqual( # noqa: PT009 self.store.get_parent_location(self.split_test_usage_key), self.vert_usage_key, ) @@ -1563,11 +1537,11 @@ def test_can_not_move_content_experiment_into_its_children(self): response = self._move_component( self.split_test_usage_key, child_split_test.children[0] ) - self.assertEqual(response.status_code, 400) + self.assertEqual(response.status_code, 400) # noqa: PT009 response = json.loads(response.content.decode("utf-8")) - self.assertEqual(response["error"], "You can not move an item into it's child.") - self.assertEqual( + self.assertEqual(response["error"], "You can not move an item into it's child.") # noqa: PT009 + self.assertEqual( # noqa: PT009 self.store.get_parent_location(self.split_test_usage_key), self.vert_usage_key, ) @@ -1581,20 +1555,20 @@ def test_move_invalid_source_index(self): response = self._move_component( self.html_usage_key, self.vert2_usage_key, target_index ) - self.assertEqual(response.status_code, 400) + self.assertEqual(response.status_code, 400) # noqa: PT009 response = json.loads(response.content.decode("utf-8")) error = f"You must provide target_index ({target_index}) as an integer." - self.assertEqual(response["error"], error) + self.assertEqual(response["error"], error) # noqa: PT009 new_parent_loc = self.store.get_parent_location(self.html_usage_key) - self.assertEqual(new_parent_loc, parent_loc) + self.assertEqual(new_parent_loc, parent_loc) # noqa: PT009 def test_move_no_target_locator(self): """ Test move an item without specifying the target location. """ data = {"move_source_locator": str(self.html_usage_key)} - with self.assertRaises(InvalidKeyError): + with self.assertRaises(InvalidKeyError): # noqa: PT027 self.client.patch( reverse("xblock_handler"), json.dumps(data), @@ -1606,9 +1580,9 @@ def test_no_move_source_locator(self): Test patch request without providing a move source locator. """ response = self.client.patch(reverse("xblock_handler")) - self.assertEqual(response.status_code, 400) + self.assertEqual(response.status_code, 400) # noqa: PT009 response = json.loads(response.content.decode("utf-8")) - self.assertEqual( + self.assertEqual( # noqa: PT009 response["error"], "Patch request did not recognise any parameters to handle.", ) @@ -1619,8 +1593,8 @@ def _verify_validation_message( """ Verify that the validation message has the expected validation message and type. """ - self.assertEqual(message.text, expected_message) - self.assertEqual(message.type, expected_message_type) + self.assertEqual(message.text, expected_message) # noqa: PT009 + self.assertEqual(message.type, expected_message_type) # noqa: PT009 def test_move_component_nonsensical_access_restriction_validation(self): """ @@ -1643,7 +1617,7 @@ def test_move_component_nonsensical_access_restriction_validation(self): self.course, course_id=self.course.id, ) - html.runtime._services["partitions"] = partitions_service # lint-amnesty, pylint: disable=protected-access + html.runtime._services["partitions"] = partitions_service # pylint: disable=protected-access # Set access settings so html will contradict vert2 when moved into that unit vert1.group_access = {self.course.user_partitions[0].id: [group2.id]} @@ -1655,14 +1629,14 @@ def test_move_component_nonsensical_access_restriction_validation(self): # Verify that there is no warning when html is in a non contradicting unit validation = html.validate() - self.assertEqual(len(validation.messages), 0) + self.assertEqual(len(validation.messages), 0) # noqa: PT009 # Now move it and confirm that the html component has been moved into vertical 2 self.assert_move_item(self.html_usage_key, self.vert2_usage_key) html.parent = self.vert2_usage_key html = self.store.update_item(html, self.user.id) validation = html.validate() - self.assertEqual(len(validation.messages), 1) + self.assertEqual(len(validation.messages), 1) # noqa: PT009 self._verify_validation_message( validation.messages[0], NONSENSICAL_ACCESS_RESTRICTION, @@ -1674,7 +1648,7 @@ def test_move_component_nonsensical_access_restriction_validation(self): html.parent = self.vert_usage_key html = self.store.update_item(html, self.user.id) validation = html.validate() - self.assertEqual(len(validation.messages), 0) + self.assertEqual(len(validation.messages), 0) # noqa: PT009 @patch("cms.djangoapps.contentstore.xblock_storage_handlers.view_handlers.log") def test_move_logging(self, mock_logger): @@ -1704,7 +1678,7 @@ def test_move_and_discard_changes(self): old_parent_loc = self.store.get_parent_location(self.html_usage_key) # Check that old_parent_loc is not yet published. - self.assertFalse( + self.assertFalse( # noqa: PT009 self.store.has_item( old_parent_loc, revision=ModuleStoreEnum.RevisionOption.published_only ) @@ -1717,18 +1691,18 @@ def test_move_and_discard_changes(self): ) # Check that old_parent_loc is now published. - self.assertTrue( + self.assertTrue( # noqa: PT009 self.store.has_item( old_parent_loc, revision=ModuleStoreEnum.RevisionOption.published_only ) ) - self.assertFalse(self.store.has_changes(self.store.get_item(old_parent_loc))) + self.assertFalse(self.store.has_changes(self.store.get_item(old_parent_loc))) # noqa: PT009 # Move component html_usage_key in vert2_usage_key self.assert_move_item(self.html_usage_key, self.vert2_usage_key) # Check old_parent_loc becomes in draft mode now. - self.assertTrue(self.store.has_changes(self.store.get_item(old_parent_loc))) + self.assertTrue(self.store.has_changes(self.store.get_item(old_parent_loc))) # noqa: PT009 # Now discard changes in old_parent_loc self.client.ajax_post( @@ -1737,25 +1711,25 @@ def test_move_and_discard_changes(self): ) # Check that old_parent_loc now is reverted to publish. Changes discarded, html_usage_key moved back. - self.assertTrue( + self.assertTrue( # noqa: PT009 self.store.has_item( old_parent_loc, revision=ModuleStoreEnum.RevisionOption.published_only ) ) - self.assertFalse(self.store.has_changes(self.store.get_item(old_parent_loc))) + self.assertFalse(self.store.has_changes(self.store.get_item(old_parent_loc))) # noqa: PT009 # Now source item should be back in the old parent. source_item = self.get_item_from_modulestore(self.html_usage_key) - self.assertEqual(source_item.parent, old_parent_loc) - self.assertEqual( + self.assertEqual(source_item.parent, old_parent_loc) # noqa: PT009 + self.assertEqual( # noqa: PT009 self.store.get_parent_location(self.html_usage_key), source_item.parent ) # Also, check that item is not present in target parent but in source parent target_parent = self.get_item_from_modulestore(self.vert2_usage_key) source_parent = self.get_item_from_modulestore(old_parent_loc) - self.assertIn(self.html_usage_key, source_parent.children) - self.assertNotIn(self.html_usage_key, target_parent.children) + self.assertIn(self.html_usage_key, source_parent.children) # noqa: PT009 + self.assertNotIn(self.html_usage_key, target_parent.children) # noqa: PT009 def test_move_item_not_found(self): """ @@ -1769,7 +1743,7 @@ def test_move_item_not_found(self): ), "parent_locator": str(self.vert2_usage_key), } - with self.assertRaises(ItemNotFoundError): + with self.assertRaises(ItemNotFoundError): # noqa: PT027 self.client.patch( reverse("xblock_handler"), json.dumps(data), @@ -1834,9 +1808,9 @@ def create_aside(usage_key, block_type): scope_ids=ScopeIds("user", block_type, def_id, usage_id), runtime=runtime, ) - aside.field11 = "%s_new_value11" % block_type - aside.field12 = "%s_new_value12" % block_type - aside.field13 = "%s_new_value13" % block_type + aside.field11 = "%s_new_value11" % block_type # noqa: UP031 + aside.field12 = "%s_new_value12" % block_type # noqa: UP031 + aside.field13 = "%s_new_value13" % block_type # noqa: UP031 self.store.update_item(item, self.user.id, asides=[aside]) @@ -1909,30 +1883,30 @@ def test_delete_field(self): self.problem_update_url, data={"metadata": {"rerandomize": "onreset"}} ) problem = self.get_item_from_modulestore(self.problem_usage_key) - self.assertEqual(problem.rerandomize, 'onreset') + self.assertEqual(problem.rerandomize, 'onreset') # noqa: PT009 self.client.ajax_post( self.problem_update_url, data={"metadata": {"rerandomize": None}} ) problem = self.get_item_from_modulestore(self.problem_usage_key) - self.assertEqual(problem.rerandomize, 'never') + self.assertEqual(problem.rerandomize, 'never') # noqa: PT009 def test_date_fields(self): """ Test setting due & start dates on sequential """ sequential = self.get_item_from_modulestore(self.seq_usage_key) - self.assertIsNone(sequential.due) + self.assertIsNone(sequential.due) # noqa: PT009 self.client.ajax_post( self.seq_update_url, data={"metadata": {"due": "2010-11-22T04:00Z"}} ) sequential = self.get_item_from_modulestore(self.seq_usage_key) - self.assertEqual(sequential.due, datetime(2010, 11, 22, 4, 0, tzinfo=UTC)) + self.assertEqual(sequential.due, datetime(2010, 11, 22, 4, 0, tzinfo=UTC)) # noqa: PT009 self.client.ajax_post( self.seq_update_url, data={"metadata": {"start": "2010-09-12T14:00Z"}} ) sequential = self.get_item_from_modulestore(self.seq_usage_key) - self.assertEqual(sequential.due, datetime(2010, 11, 22, 4, 0, tzinfo=UTC)) - self.assertEqual(sequential.start, datetime(2010, 9, 12, 14, 0, tzinfo=UTC)) + self.assertEqual(sequential.due, datetime(2010, 11, 22, 4, 0, tzinfo=UTC)) # noqa: PT009 + self.assertEqual(sequential.start, datetime(2010, 9, 12, 14, 0, tzinfo=UTC)) # noqa: PT009 @ddt.data( "1000-01-01T00:00Z", @@ -1954,8 +1928,8 @@ def test_xblock_due_date_validity(self, date): user=self.user, ) # Both display and actual value should be None - self.assertEqual(xblock_info["due_date"], "") - self.assertIsNone(xblock_info["due"]) + self.assertEqual(xblock_info["due_date"], "") # noqa: PT009 + self.assertIsNone(xblock_info["due"]) # noqa: PT009 def test_update_generic_fields(self): new_display_name = "New Display Name" @@ -1970,8 +1944,8 @@ def test_update_generic_fields(self): }, ) problem = self.get_item_from_modulestore(self.problem_usage_key) - self.assertEqual(problem.display_name, new_display_name) - self.assertEqual(problem.max_attempts, new_max_attempts) + self.assertEqual(problem.display_name, new_display_name) # noqa: PT009 + self.assertEqual(problem.max_attempts, new_max_attempts) # noqa: PT009 def test_delete_child(self): """ @@ -1984,19 +1958,19 @@ def test_delete_child(self): chapter2_usage_key = self.response_usage_key(resp_2) course = self.get_item_from_modulestore(self.usage_key) - self.assertIn(chapter1_usage_key, course.children) - self.assertIn(chapter2_usage_key, course.children) + self.assertIn(chapter1_usage_key, course.children) # noqa: PT009 + self.assertIn(chapter2_usage_key, course.children) # noqa: PT009 # Remove one child from the course. resp = self.client.delete( reverse_usage_url("xblock_handler", chapter1_usage_key) ) - self.assertEqual(resp.status_code, 204) + self.assertEqual(resp.status_code, 204) # noqa: PT009 # Verify that the child is removed. course = self.get_item_from_modulestore(self.usage_key) - self.assertNotIn(chapter1_usage_key, course.children) - self.assertIn(chapter2_usage_key, course.children) + self.assertNotIn(chapter1_usage_key, course.children) # noqa: PT009 + self.assertIn(chapter2_usage_key, course.children) # noqa: PT009 def test_reorder_children(self): """ @@ -2017,8 +1991,8 @@ def test_reorder_children(self): # Children must be on the sequential to reproduce the original bug, # as it is important that the parent (sequential) NOT be in the draft store. children = self.get_item_from_modulestore(self.seq_usage_key).children - self.assertEqual(unit1_usage_key, children[1]) - self.assertEqual(unit2_usage_key, children[2]) + self.assertEqual(unit1_usage_key, children[1]) # noqa: PT009 + self.assertEqual(unit2_usage_key, children[2]) # noqa: PT009 resp = self.client.ajax_post( self.seq_update_url, @@ -2030,12 +2004,12 @@ def test_reorder_children(self): ] }, ) - self.assertEqual(resp.status_code, 200) + self.assertEqual(resp.status_code, 200) # noqa: PT009 children = self.get_item_from_modulestore(self.seq_usage_key).children - self.assertEqual(self.problem_usage_key, children[0]) - self.assertEqual(unit1_usage_key, children[2]) - self.assertEqual(unit2_usage_key, children[1]) + self.assertEqual(self.problem_usage_key, children[0]) # noqa: PT009 + self.assertEqual(unit1_usage_key, children[2]) # noqa: PT009 + self.assertEqual(unit2_usage_key, children[1]) # noqa: PT009 def test_move_parented_child(self): """ @@ -2060,14 +2034,14 @@ def test_move_parented_child(self): resp = self.client.ajax_post( self.seq2_update_url, data={"children": [str(unit_1_key), str(unit_2_key)]} ) - self.assertEqual(resp.status_code, 200) + self.assertEqual(resp.status_code, 200) # noqa: PT009 # verify children - self.assertListEqual( + self.assertListEqual( # noqa: PT009 self.get_item_from_modulestore(self.seq2_usage_key).children, [unit_1_key, unit_2_key], ) - self.assertListEqual( + self.assertListEqual( # noqa: PT009 self.get_item_from_modulestore(self.seq_usage_key).children, [self.problem_usage_key], # problem child created in setUp ) @@ -2089,7 +2063,7 @@ def test_move_orphaned_child_error(self): ) # verify children - self.assertListEqual( + self.assertListEqual( # noqa: PT009 self.get_item_from_modulestore(self.seq2_usage_key).children, [] ) @@ -2121,7 +2095,7 @@ def test_move_child_creates_orphan_error(self): ) # verify children - self.assertListEqual( + self.assertListEqual( # noqa: PT009 self.get_item_from_modulestore(self.seq2_usage_key).children, [unit_1_key, unit_2_key], ) @@ -2138,20 +2112,20 @@ def _verify_published_with_no_draft(self, location): """ Verifies the item with given location has a published version and no draft (unpublished changes). """ - self.assertTrue(self._is_location_published(location)) - self.assertFalse(modulestore().has_changes(modulestore().get_item(location))) + self.assertTrue(self._is_location_published(location)) # noqa: PT009 + self.assertFalse(modulestore().has_changes(modulestore().get_item(location))) # noqa: PT009 def _verify_published_with_draft(self, location): """ Verifies the item with given location has a published version and also a draft version (unpublished changes). """ - self.assertTrue(self._is_location_published(location)) - self.assertTrue(modulestore().has_changes(modulestore().get_item(location))) + self.assertTrue(self._is_location_published(location)) # noqa: PT009 + self.assertTrue(modulestore().has_changes(modulestore().get_item(location))) # noqa: PT009 def test_make_public(self): """Test making a private problem public (publishing it).""" # When the problem is first created, it is only in draft (because of its category). - self.assertFalse(self._is_location_published(self.problem_usage_key)) + self.assertFalse(self._is_location_published(self.problem_usage_key)) # noqa: PT009 self.client.ajax_post(self.problem_update_url, data={"publish": "make_public"}) self._verify_published_with_no_draft(self.problem_usage_key) @@ -2170,14 +2144,14 @@ def test_revert_to_published(self): self.problem_usage_key, revision=ModuleStoreEnum.RevisionOption.published_only, ) - self.assertIsNone(published.due) + self.assertIsNone(published.due) # noqa: PT009 def test_republish(self): """Test republishing an item.""" new_display_name = "New Display Name" # When the problem is first created, it is only in draft (because of its category). - self.assertFalse(self._is_location_published(self.problem_usage_key)) + self.assertFalse(self._is_location_published(self.problem_usage_key)) # noqa: PT009 # Republishing when only in draft will update the draft but not cause a public item to be created. self.client.ajax_post( @@ -2187,9 +2161,9 @@ def test_republish(self): "metadata": {"display_name": new_display_name}, }, ) - self.assertFalse(self._is_location_published(self.problem_usage_key)) + self.assertFalse(self._is_location_published(self.problem_usage_key)) # noqa: PT009 draft = self.get_item_from_modulestore(self.problem_usage_key) - self.assertEqual(draft.display_name, new_display_name) + self.assertEqual(draft.display_name, new_display_name) # noqa: PT009 # Publish the item self.client.ajax_post(self.problem_update_url, data={"publish": "make_public"}) @@ -2208,7 +2182,7 @@ def test_republish(self): self.problem_usage_key, revision=ModuleStoreEnum.RevisionOption.published_only, ) - self.assertEqual(published.display_name, new_display_name_2) + self.assertEqual(published.display_name, new_display_name_2) # noqa: PT009 def test_direct_only_categories_not_republished(self): """Verify that republish is ignored for items in DIRECT_ONLY_CATEGORIES""" @@ -2240,20 +2214,20 @@ def _make_draft_content_different_from_published(self): published = modulestore().get_item( self.problem_usage_key, revision=ModuleStoreEnum.RevisionOption.published_only, - ) # lint-amnesty, pylint: disable=line-too-long + ) # pylint: disable=line-too-long # Update the draft version and check that published is different. self.client.ajax_post( self.problem_update_url, data={"metadata": {"due": "2077-10-10T04:00Z"}} ) updated_draft = self.get_item_from_modulestore(self.problem_usage_key) - self.assertEqual(updated_draft.due, datetime(2077, 10, 10, 4, 0, tzinfo=UTC)) - self.assertIsNone(published.due) + self.assertEqual(updated_draft.due, datetime(2077, 10, 10, 4, 0, tzinfo=UTC)) # noqa: PT009 + self.assertIsNone(published.due) # noqa: PT009 # Fetch the published version again to make sure the due date is still unset. published = modulestore().get_item( published.location, revision=ModuleStoreEnum.RevisionOption.published_only ) - self.assertIsNone(published.due) + self.assertIsNone(published.due) # noqa: PT009 def test_make_public_with_update(self): """Update a problem and make it public at the same time.""" @@ -2262,7 +2236,7 @@ def test_make_public_with_update(self): data={"metadata": {"due": "2077-10-10T04:00Z"}, "publish": "make_public"}, ) published = self.get_item_from_modulestore(self.problem_usage_key) - self.assertEqual(published.due, datetime(2077, 10, 10, 4, 0, tzinfo=UTC)) + self.assertEqual(published.due, datetime(2077, 10, 10, 4, 0, tzinfo=UTC)) # noqa: PT009 def test_published_and_draft_contents_with_update(self): """Create a draft and publish it then modify the draft and check that published content is not modified""" @@ -2287,30 +2261,30 @@ def test_published_and_draft_contents_with_update(self): # Both published and draft content should be different draft = self.get_item_from_modulestore(self.problem_usage_key) - self.assertNotEqual(draft.data, published.data) + self.assertNotEqual(draft.data, published.data) # noqa: PT009 # Get problem by 'xblock_handler' view_url = reverse_usage_url( "xblock_view_handler", self.problem_usage_key, {"view_name": STUDENT_VIEW} ) resp = self.client.get(view_url, HTTP_ACCEPT="application/json") - self.assertEqual(resp.status_code, 200) + self.assertEqual(resp.status_code, 200) # noqa: PT009 # Activate the editing view view_url = reverse_usage_url( "xblock_view_handler", self.problem_usage_key, {"view_name": STUDIO_VIEW} ) resp = self.client.get(view_url, HTTP_ACCEPT="application/json") - self.assertEqual(resp.status_code, 200) + self.assertEqual(resp.status_code, 200) # noqa: PT009 # Both published and draft content should still be different draft = self.get_item_from_modulestore(self.problem_usage_key) - self.assertNotEqual(draft.data, published.data) + self.assertNotEqual(draft.data, published.data) # noqa: PT009 # Fetch the published version again to make sure the data is correct. published = modulestore().get_item( published.location, revision=ModuleStoreEnum.RevisionOption.published_only ) - self.assertNotEqual(draft.data, published.data) + self.assertNotEqual(draft.data, published.data) # noqa: PT009 def test_publish_states_of_nested_xblocks(self): """Test publishing of a unit page containing a nested xblock""" @@ -2328,12 +2302,12 @@ def test_publish_states_of_nested_xblocks(self): # The unit and its children should be private initially unit_update_url = reverse_usage_url("xblock_handler", unit_usage_key) - self.assertFalse(self._is_location_published(unit_usage_key)) - self.assertFalse(self._is_location_published(html_usage_key)) + self.assertFalse(self._is_location_published(unit_usage_key)) # noqa: PT009 + self.assertFalse(self._is_location_published(html_usage_key)) # noqa: PT009 # Make the unit public and verify that the problem is also made public resp = self.client.ajax_post(unit_update_url, data={"publish": "make_public"}) - self.assertEqual(resp.status_code, 200) + self.assertEqual(resp.status_code, 200) # noqa: PT009 self._verify_published_with_no_draft(unit_usage_key) self._verify_published_with_no_draft(html_usage_key) @@ -2357,10 +2331,10 @@ def test_field_value_errors(self): }, }, ) - self.assertEqual(response.status_code, 400) + self.assertEqual(response.status_code, 400) # noqa: PT009 parsed = json.loads(response.content.decode("utf-8")) - self.assertIn("error", parsed) - self.assertIn( + self.assertIn("error", parsed) # noqa: PT009 + self.assertIn( # noqa: PT009 "Incorrect RelativeTime value", parsed["error"] ) # See xmodule/fields.py @@ -2441,7 +2415,7 @@ def _update_partition_id(self, partition_id): # Verify the partition_id was saved. split_test = self.get_item_from_modulestore(self.split_test_usage_key) - self.assertEqual(partition_id, split_test.user_partition_id) + self.assertEqual(partition_id, split_test.user_partition_id) # noqa: PT009 return split_test def _assert_children(self, expected_number): @@ -2449,7 +2423,7 @@ def _assert_children(self, expected_number): Verifies the number of children of the split_test instance. """ split_test = self.get_item_from_modulestore(self.split_test_usage_key) - self.assertEqual(expected_number, len(split_test.children)) + self.assertEqual(expected_number, len(split_test.children)) # noqa: PT009 return split_test def test_create_groups(self): @@ -2459,32 +2433,32 @@ def test_create_groups(self): """ split_test = self.get_item_from_modulestore(self.split_test_usage_key) # Initially, no user_partition_id is set, and the split_test has no children. - self.assertEqual(-1, split_test.user_partition_id) - self.assertEqual(0, len(split_test.children)) + self.assertEqual(-1, split_test.user_partition_id) # noqa: PT009 + self.assertEqual(0, len(split_test.children)) # noqa: PT009 # Set the user_partition_id to match the first user_partition. split_test = self._update_partition_id(self.first_user_partition.id) # Verify that child verticals have been set to match the groups - self.assertEqual(2, len(split_test.children)) + self.assertEqual(2, len(split_test.children)) # noqa: PT009 vertical_0 = self.get_item_from_modulestore(split_test.children[0]) vertical_1 = self.get_item_from_modulestore(split_test.children[1]) - self.assertEqual("vertical", vertical_0.category) - self.assertEqual("vertical", vertical_1.category) - self.assertEqual( + self.assertEqual("vertical", vertical_0.category) # noqa: PT009 + self.assertEqual("vertical", vertical_1.category) # noqa: PT009 + self.assertEqual( # noqa: PT009 "Group ID " + str(MINIMUM_UNUSED_PARTITION_ID + 1), vertical_0.display_name ) - self.assertEqual( + self.assertEqual( # noqa: PT009 "Group ID " + str(MINIMUM_UNUSED_PARTITION_ID + 2), vertical_1.display_name ) # Verify that the group_id_to_child mapping is correct. - self.assertEqual(2, len(split_test.group_id_to_child)) - self.assertEqual( + self.assertEqual(2, len(split_test.group_id_to_child)) # noqa: PT009 + self.assertEqual( # noqa: PT009 vertical_0.location, split_test.group_id_to_child[str(self.first_user_partition_group_1.id)], ) - self.assertEqual( + self.assertEqual( # noqa: PT009 vertical_1.location, split_test.group_id_to_child[str(self.first_user_partition_group_2.id)], ) @@ -2495,12 +2469,12 @@ def test_split_xblock_info_group_name(self): """ split_test = self.get_item_from_modulestore(self.split_test_usage_key) # Initially, no user_partition_id is set, and the split_test has no children. - self.assertEqual(split_test.user_partition_id, -1) - self.assertEqual(len(split_test.children), 0) + self.assertEqual(split_test.user_partition_id, -1) # noqa: PT009 + self.assertEqual(len(split_test.children), 0) # noqa: PT009 # Set the user_partition_id to match the first user_partition. split_test = self._update_partition_id(self.first_user_partition.id) # Verify that child verticals have been set to match the groups - self.assertEqual(len(split_test.children), 2) + self.assertEqual(len(split_test.children), 2) # noqa: PT009 # Get xblock outline xblock_info = create_xblock_info( @@ -2511,10 +2485,10 @@ def test_split_xblock_info_group_name(self): course=self.course, user=self.request.user, ) - self.assertEqual( + self.assertEqual( # noqa: PT009 xblock_info["child_info"]["children"][0]["display_name"], "alpha" ) - self.assertEqual( + self.assertEqual( # noqa: PT009 xblock_info["child_info"]["children"][1]["display_name"], "beta" ) @@ -2525,36 +2499,36 @@ def test_change_user_partition_id(self): """ # Set to first group configuration. split_test = self._update_partition_id(self.first_user_partition.id) - self.assertEqual(2, len(split_test.children)) + self.assertEqual(2, len(split_test.children)) # noqa: PT009 initial_vertical_0_location = split_test.children[0] initial_vertical_1_location = split_test.children[1] # Set to second group configuration split_test = self._update_partition_id(self.second_user_partition.id) # We don't remove existing children. - self.assertEqual(5, len(split_test.children)) - self.assertEqual(initial_vertical_0_location, split_test.children[0]) - self.assertEqual(initial_vertical_1_location, split_test.children[1]) + self.assertEqual(5, len(split_test.children)) # noqa: PT009 + self.assertEqual(initial_vertical_0_location, split_test.children[0]) # noqa: PT009 + self.assertEqual(initial_vertical_1_location, split_test.children[1]) # noqa: PT009 vertical_0 = self.get_item_from_modulestore(split_test.children[2]) vertical_1 = self.get_item_from_modulestore(split_test.children[3]) vertical_2 = self.get_item_from_modulestore(split_test.children[4]) # Verify that the group_id_to child mapping is correct. - self.assertEqual(3, len(split_test.group_id_to_child)) - self.assertEqual( + self.assertEqual(3, len(split_test.group_id_to_child)) # noqa: PT009 + self.assertEqual( # noqa: PT009 vertical_0.location, split_test.group_id_to_child[str(self.second_user_partition_group_1.id)], ) - self.assertEqual( + self.assertEqual( # noqa: PT009 vertical_1.location, split_test.group_id_to_child[str(self.second_user_partition_group_2.id)], ) - self.assertEqual( + self.assertEqual( # noqa: PT009 vertical_2.location, split_test.group_id_to_child[str(self.second_user_partition_group_3.id)], ) - self.assertNotEqual(initial_vertical_0_location, vertical_0.location) - self.assertNotEqual(initial_vertical_1_location, vertical_1.location) + self.assertNotEqual(initial_vertical_0_location, vertical_0.location) # noqa: PT009 + self.assertNotEqual(initial_vertical_1_location, vertical_1.location) # noqa: PT009 def test_change_same_user_partition_id(self): """ @@ -2562,13 +2536,13 @@ def test_change_same_user_partition_id(self): """ # Set to first group configuration. split_test = self._update_partition_id(self.first_user_partition.id) - self.assertEqual(2, len(split_test.children)) + self.assertEqual(2, len(split_test.children)) # noqa: PT009 initial_group_id_to_child = split_test.group_id_to_child # Set again to first group configuration. split_test = self._update_partition_id(self.first_user_partition.id) - self.assertEqual(2, len(split_test.children)) - self.assertEqual(initial_group_id_to_child, split_test.group_id_to_child) + self.assertEqual(2, len(split_test.children)) # noqa: PT009 + self.assertEqual(initial_group_id_to_child, split_test.group_id_to_child) # noqa: PT009 def test_change_non_existent_user_partition_id(self): """ @@ -2578,13 +2552,13 @@ def test_change_non_existent_user_partition_id(self): """ # Set to first group configuration. split_test = self._update_partition_id(self.first_user_partition.id) - self.assertEqual(2, len(split_test.children)) + self.assertEqual(2, len(split_test.children)) # noqa: PT009 initial_group_id_to_child = split_test.group_id_to_child # Set to an group configuration that doesn't exist. split_test = self._update_partition_id(-50) - self.assertEqual(2, len(split_test.children)) - self.assertEqual(initial_group_id_to_child, split_test.group_id_to_child) + self.assertEqual(2, len(split_test.children)) # noqa: PT009 + self.assertEqual(initial_group_id_to_child, split_test.group_id_to_child) # noqa: PT009 def test_add_groups(self): """ @@ -2615,7 +2589,7 @@ def test_add_groups(self): # group_id_to_child and children have not changed yet. split_test = self._assert_children(2) group_id_to_child = split_test.group_id_to_child.copy() - self.assertEqual(2, len(group_id_to_child)) + self.assertEqual(2, len(group_id_to_child)) # noqa: PT009 # SplitModuleStoreRuntime is used in tests. # SplitModuleStoreRuntime doesn't have user service, that's needed for @@ -2627,14 +2601,14 @@ def test_add_groups(self): # Call add_missing_groups method to add the missing group. split_test.add_missing_groups(self.request) split_test = self._assert_children(3) - self.assertNotEqual(group_id_to_child, split_test.group_id_to_child) + self.assertNotEqual(group_id_to_child, split_test.group_id_to_child) # noqa: PT009 group_id_to_child = split_test.group_id_to_child - self.assertEqual(split_test.children[2], group_id_to_child[new_group_id]) + self.assertEqual(split_test.children[2], group_id_to_child[new_group_id]) # noqa: PT009 # Call add_missing_groups again -- it should be a no-op. split_test.add_missing_groups(self.request) split_test = self._assert_children(3) - self.assertEqual(group_id_to_child, split_test.group_id_to_child) + self.assertEqual(group_id_to_child, split_test.group_id_to_child) # noqa: PT009 @ddt.ddt @@ -2670,15 +2644,15 @@ def setUp(self): def test_invalid_handler(self): self.block.handle.side_effect = NoSuchHandlerError - with self.assertRaises(Http404): + with self.assertRaises(Http404): # noqa: PT027 component_handler(self.request, self.usage_key_string, "invalid_handler") @ddt.data("GET", "POST", "PUT", "DELETE") def test_request_method(self, method): def check_handler( handler, request, suffix - ): # lint-amnesty, pylint: disable=unused-argument - self.assertEqual(request.method, method) + ): # pylint: disable=unused-argument + self.assertEqual(request.method, method) # noqa: PT009 return Response() self.block.handle = check_handler @@ -2693,12 +2667,12 @@ def check_handler( def test_response_code(self, status_code): def create_response( handler, request, suffix - ): # lint-amnesty, pylint: disable=unused-argument + ): # pylint: disable=unused-argument return Response(status_code=status_code) self.block.handle = create_response - self.assertEqual( + self.assertEqual( # noqa: PT009 component_handler( self.request, self.usage_key_string, "dummy_handler" ).status_code, @@ -2716,7 +2690,7 @@ def test_submit_studio_edits_checks_author_permission(self, mock_logger): def create_response( handler, request, suffix - ): # lint-amnesty, pylint: disable=unused-argument + ): # pylint: disable=unused-argument """create dummy response""" return Response(status_code=200) @@ -2752,7 +2726,7 @@ def test_aside(self, is_xblock_aside, is_get_aside_called): def create_response( handler, request, suffix - ): # lint-amnesty, pylint: disable=unused-argument + ): # pylint: disable=unused-argument """create dummy response""" return Response(status_code=200) @@ -2888,19 +2862,19 @@ def test_basic_components(self): self._verify_basic_component_display_name("discussion", "Discussion") self._verify_basic_component_display_name("video", "Video") self._verify_basic_component_display_name("openassessment", "Open Response") - self.assertGreater(len(self.get_templates_of_type("library")), 0) - self.assertGreater(len(self.get_templates_of_type("html")), 0) - self.assertGreater(len(self.get_templates_of_type("problem")), 0) + self.assertGreater(len(self.get_templates_of_type("library")), 0) # noqa: PT009 + self.assertGreater(len(self.get_templates_of_type("html")), 0) # noqa: PT009 + self.assertGreater(len(self.get_templates_of_type("problem")), 0) # noqa: PT009 # Check for default advanced modules advanced_templates = self.get_templates_of_type("advanced") advanced_module_keys = [t['category'] for t in advanced_templates] - self.assertCountEqual(advanced_module_keys, DEFAULT_ADVANCED_MODULES) + self.assertCountEqual(advanced_module_keys, DEFAULT_ADVANCED_MODULES) # noqa: PT009 # Now fully disable video through XBlockConfiguration XBlockConfiguration.objects.create(name="video", enabled=False) self.templates = get_component_templates(self.course) - self.assertIsNone(self.get_templates_of_type("video")) + self.assertIsNone(self.get_templates_of_type("video")) # noqa: PT009 def test_basic_components_support_levels(self): """ @@ -2909,7 +2883,7 @@ def test_basic_components_support_levels(self): XBlockStudioConfigurationFlag.objects.create(enabled=True) self.templates = get_component_templates(self.course) self._verify_basic_component("discussion", "Discussion", "ps") - self.assertEqual([], self.get_templates_of_type("video")) + self.assertEqual([], self.get_templates_of_type("video")) # noqa: PT009 supported_problem_templates = [ { "boilerplate_name": None, @@ -2920,7 +2894,7 @@ def test_basic_components_support_levels(self): "tab": "advanced", } ] - self.assertEqual( + self.assertEqual( # noqa: PT009 supported_problem_templates, self.get_templates_of_type("problem") ) @@ -2931,7 +2905,7 @@ def test_basic_components_support_levels(self): # Now fully disable video through XBlockConfiguration XBlockConfiguration.objects.create(name="video", enabled=False) self.templates = get_component_templates(self.course) - self.assertIsNone(self.get_templates_of_type("video")) + self.assertIsNone(self.get_templates_of_type("video")) # noqa: PT009 def test_advanced_components(self): """ @@ -2941,11 +2915,11 @@ def test_advanced_components(self): EXPECTED_ADVANCED_MODULES_LENGTH = len(DEFAULT_ADVANCED_MODULES) + 1 self.templates = get_component_templates(self.course) advanced_templates = self.get_templates_of_type("advanced") - self.assertEqual(len(advanced_templates), EXPECTED_ADVANCED_MODULES_LENGTH) + self.assertEqual(len(advanced_templates), EXPECTED_ADVANCED_MODULES_LENGTH) # noqa: PT009 done_template = advanced_templates[0] - self.assertEqual(done_template.get("category"), "done") - self.assertEqual(done_template.get("display_name"), "Completion") - self.assertIsNone(done_template.get("boilerplate_name", None)) + self.assertEqual(done_template.get("category"), "done") # noqa: PT009 + self.assertEqual(done_template.get("display_name"), "Completion") # noqa: PT009 + self.assertIsNone(done_template.get("boilerplate_name", None)) # noqa: PT009 # Verify that components are not added twice self.course.advanced_modules.append("video") @@ -2957,18 +2931,18 @@ def test_advanced_components(self): self.templates = get_component_templates(self.course) advanced_templates = self.get_templates_of_type("advanced") - self.assertEqual(len(advanced_templates), EXPECTED_ADVANCED_MODULES_LENGTH) + self.assertEqual(len(advanced_templates), EXPECTED_ADVANCED_MODULES_LENGTH) # noqa: PT009 only_template = advanced_templates[0] - self.assertNotEqual(only_template.get("category"), "video") - self.assertNotEqual(only_template.get("category"), "drag-and-drop-v2") - self.assertNotEqual(only_template.get("category"), "poll") - self.assertNotEqual(only_template.get("category"), "google-document") - self.assertNotEqual(only_template.get("category"), "survey") + self.assertNotEqual(only_template.get("category"), "video") # noqa: PT009 + self.assertNotEqual(only_template.get("category"), "drag-and-drop-v2") # noqa: PT009 + self.assertNotEqual(only_template.get("category"), "poll") # noqa: PT009 + self.assertNotEqual(only_template.get("category"), "google-document") # noqa: PT009 + self.assertNotEqual(only_template.get("category"), "survey") # noqa: PT009 # Now fully disable done through XBlockConfiguration XBlockConfiguration.objects.create(name="done", enabled=False) self.templates = get_component_templates(self.course) - self.assertTrue((not any(item.get("category") == "done" for item in self.get_templates_of_type("advanced")))) + self.assertTrue((not any(item.get("category") == "done" for item in self.get_templates_of_type("advanced")))) # noqa: PT009, UP034 # pylint: disable=line-too-long def test_deprecated_no_advance_component_button(self): """ @@ -2986,7 +2960,7 @@ def test_deprecated_no_advance_component_button(self): self.course.advanced_modules.extend(["poll", "survey"]) templates = get_component_templates(self.course) button_names = [template["display_name"] for template in templates] - self.assertNotIn("Advanced", button_names) + self.assertNotIn("Advanced", button_names) # noqa: PT009 def test_cannot_create_deprecated_problems(self): """ @@ -3037,18 +3011,18 @@ def verify_staffgradedxblock_present(support_level): Helper method to verify that staffgradedxblock template is present """ sgp = get_xblock_problem("Staff Graded Points") - self.assertIsNotNone(sgp) - self.assertEqual(sgp.get("category"), "staffgradedxblock") - self.assertEqual(sgp.get("support_level"), support_level) + self.assertIsNotNone(sgp) # noqa: PT009 + self.assertEqual(sgp.get("category"), "staffgradedxblock") # noqa: PT009 + self.assertEqual(sgp.get("support_level"), support_level) # noqa: PT009 def verify_dndv2_present(support_level): """ Helper method to verify that DnDv2 template is present """ dndv2 = get_xblock_problem("Drag and Drop") - self.assertIsNotNone(dndv2) - self.assertEqual(dndv2.get("category"), "drag-and-drop-v2") - self.assertEqual(dndv2.get("support_level"), support_level) + self.assertIsNotNone(dndv2) # noqa: PT009 + self.assertEqual(dndv2.get("category"), "drag-and-drop-v2") # noqa: PT009 + self.assertEqual(dndv2.get("support_level"), support_level) # noqa: PT009 verify_dndv2_present(True) verify_staffgradedxblock_present(True) @@ -3056,8 +3030,8 @@ def verify_dndv2_present(support_level): # Now enable XBlockStudioConfigurationFlag. The staffgradedxblock block is marked # unsupported, so will no longer show up, but DnDv2 will continue to appear. XBlockStudioConfigurationFlag.objects.create(enabled=True) - self.assertIsNone(get_xblock_problem("Staff Graded Points")) - self.assertIsNotNone(get_xblock_problem("Drag and Drop")) + self.assertIsNone(get_xblock_problem("Staff Graded Points")) # noqa: PT009 + self.assertIsNotNone(get_xblock_problem("Drag and Drop")) # noqa: PT009 # Now allow unsupported components. self.course.allow_unsupported_xblocks = True @@ -3067,8 +3041,8 @@ def verify_dndv2_present(support_level): # Now disable the blocks completely through XBlockConfiguration XBlockConfiguration.objects.create(name="staffgradedxblock", enabled=False) XBlockConfiguration.objects.create(name="drag-and-drop-v2", enabled=False) - self.assertIsNone(get_xblock_problem("Staff Graded Points")) - self.assertIsNone(get_xblock_problem("Drag and Drop")) + self.assertIsNone(get_xblock_problem("Staff Graded Points")) # noqa: PT009 + self.assertIsNone(get_xblock_problem("Drag and Drop")) # noqa: PT009 def test_discussion_button_present_no_provider(self): """ @@ -3114,16 +3088,16 @@ def _verify_advanced_xblocks(self, expected_xblocks, expected_support_levels): """ templates = get_component_templates(self.course) button_names = [template["display_name"] for template in templates] - self.assertIn("Advanced", button_names) - self.assertEqual(len(templates[-1]["templates"]), len(expected_xblocks)) + self.assertIn("Advanced", button_names) # noqa: PT009 + self.assertEqual(len(templates[-1]["templates"]), len(expected_xblocks)) # noqa: PT009 template_display_names = [ template["display_name"] for template in templates[-1]["templates"] ] - self.assertEqual(template_display_names, expected_xblocks) + self.assertEqual(template_display_names, expected_xblocks) # noqa: PT009 template_support_levels = [ template["support_level"] for template in templates[-1]["templates"] ] - self.assertEqual(template_support_levels, expected_support_levels) + self.assertEqual(template_support_levels, expected_support_levels) # noqa: PT009 def _verify_basic_component( self, component_type, display_name, support_level=True, no_of_templates=1 @@ -3132,16 +3106,16 @@ def _verify_basic_component( Verify the display name and support level of basic components (that have no boilerplates). """ templates = self.get_templates_of_type(component_type) - self.assertEqual(no_of_templates, len(templates)) - self.assertEqual(display_name, templates[0]["display_name"]) - self.assertEqual(support_level, templates[0]["support_level"]) + self.assertEqual(no_of_templates, len(templates)) # noqa: PT009 + self.assertEqual(display_name, templates[0]["display_name"]) # noqa: PT009 + self.assertEqual(support_level, templates[0]["support_level"]) # noqa: PT009 def _verify_basic_component_display_name(self, component_type, display_name): """ Verify the display name of basic components. """ component_display_name = self.get_display_name_of_type(component_type) - self.assertEqual(display_name, component_display_name) + self.assertEqual(display_name, component_display_name) # noqa: PT009 @ddt.ddt @@ -3221,11 +3195,11 @@ def test_entrance_exam_chapter_xblock_info(self): ) # entrance exam chapter should not be deletable, draggable and childAddable. actions = xblock_info["actions"] - self.assertEqual(actions["deletable"], False) - self.assertEqual(actions["draggable"], False) - self.assertEqual(actions["childAddable"], False) - self.assertEqual(xblock_info["display_name"], "Entrance Exam") - self.assertIsNone(xblock_info.get("is_header_visible", None)) + self.assertEqual(actions["deletable"], False) # noqa: PT009 + self.assertEqual(actions["draggable"], False) # noqa: PT009 + self.assertEqual(actions["childAddable"], False) # noqa: PT009 + self.assertEqual(xblock_info["display_name"], "Entrance Exam") # noqa: PT009 + self.assertIsNone(xblock_info.get("is_header_visible", None)) # noqa: PT009 def test_none_entrance_exam_chapter_xblock_info(self): chapter = BlockFactory.create( @@ -3243,11 +3217,11 @@ def test_none_entrance_exam_chapter_xblock_info(self): # chapter should be deletable, draggable and childAddable if not an entrance exam. actions = xblock_info["actions"] - self.assertEqual(actions["deletable"], True) - self.assertEqual(actions["draggable"], True) - self.assertEqual(actions["childAddable"], True) + self.assertEqual(actions["deletable"], True) # noqa: PT009 + self.assertEqual(actions["draggable"], True) # noqa: PT009 + self.assertEqual(actions["childAddable"], True) # noqa: PT009 # chapter xblock info should not contains the key of 'is_header_visible'. - self.assertIsNone(xblock_info.get("is_header_visible", None)) + self.assertIsNone(xblock_info.get("is_header_visible", None)) # noqa: PT009 def test_entrance_exam_sequential_xblock_info(self): chapter = BlockFactory.create( @@ -3271,8 +3245,8 @@ def test_entrance_exam_sequential_xblock_info(self): subsection, include_child_info=True, include_children_predicate=ALWAYS ) # in case of entrance exam subsection, header should be hidden. - self.assertEqual(xblock_info["is_header_visible"], False) - self.assertEqual(xblock_info["display_name"], "Subsection - Entrance Exam") + self.assertEqual(xblock_info["is_header_visible"], False) # noqa: PT009 + self.assertEqual(xblock_info["display_name"], "Subsection - Entrance Exam") # noqa: PT009 def test_none_entrance_exam_sequential_xblock_info(self): subsection = BlockFactory.create( @@ -3289,7 +3263,7 @@ def test_none_entrance_exam_sequential_xblock_info(self): parent_xblock=self.chapter, ) # sequential xblock info should not contains the key of 'is_header_visible'. - self.assertIsNone(xblock_info.get("is_header_visible", None)) + self.assertIsNone(xblock_info.get("is_header_visible", None)) # noqa: PT009 def test_chapter_xblock_info(self): chapter = modulestore().get_item(self.chapter.location) @@ -3348,13 +3322,13 @@ def test_validate_start_date(self): user=self.user ) - self.assertEqual(xblock_info['start'], DEFAULT_START_DATE.strftime('%Y-%m-%dT%H:%M:%SZ')) + self.assertEqual(xblock_info['start'], DEFAULT_START_DATE.strftime('%Y-%m-%dT%H:%M:%SZ')) # noqa: PT009 def test_highlights_enabled(self): self.course.highlights_enabled_for_messaging = True self.store.update_item(self.course, None) course_xblock_info = create_xblock_info(self.course) - self.assertTrue(course_xblock_info["highlights_enabled_for_messaging"]) + self.assertTrue(course_xblock_info["highlights_enabled_for_messaging"]) # noqa: PT009 def test_xblock_public_video_sharing_enabled(self): """ @@ -3364,8 +3338,8 @@ def test_xblock_public_video_sharing_enabled(self): with patch.object(PUBLIC_VIDEO_SHARE, "is_enabled", return_value=True): self.store.update_item(self.course, None) course_xblock_info = create_xblock_info(self.course) - self.assertTrue(course_xblock_info["video_sharing_enabled"]) - self.assertEqual(course_xblock_info["video_sharing_options"], "all-on") + self.assertTrue(course_xblock_info["video_sharing_enabled"]) # noqa: PT009 + self.assertEqual(course_xblock_info["video_sharing_options"], "all-on") # noqa: PT009 def test_xblock_public_video_sharing_disabled(self): """ @@ -3375,8 +3349,8 @@ def test_xblock_public_video_sharing_disabled(self): with patch.object(PUBLIC_VIDEO_SHARE, "is_enabled", return_value=False): self.store.update_item(self.course, None) course_xblock_info = create_xblock_info(self.course) - self.assertNotIn("video_sharing_enabled", course_xblock_info) - self.assertNotIn("video_sharing_options", course_xblock_info) + self.assertNotIn("video_sharing_enabled", course_xblock_info) # noqa: PT009 + self.assertNotIn("video_sharing_options", course_xblock_info) # noqa: PT009 def validate_course_xblock_info( self, xblock_info, has_child_info=True, course_outline=False @@ -3384,11 +3358,11 @@ def validate_course_xblock_info( """ Validate that the xblock info is correct for the test course. """ - self.assertEqual(xblock_info["category"], "course") - self.assertEqual(xblock_info["id"], str(self.course.location)) - self.assertEqual(xblock_info["display_name"], self.course.display_name) - self.assertTrue(xblock_info["published"]) - self.assertFalse(xblock_info["highlights_enabled_for_messaging"]) + self.assertEqual(xblock_info["category"], "course") # noqa: PT009 + self.assertEqual(xblock_info["id"], str(self.course.location)) # noqa: PT009 + self.assertEqual(xblock_info["display_name"], self.course.display_name) # noqa: PT009 + self.assertTrue(xblock_info["published"]) # noqa: PT009 + self.assertFalse(xblock_info["highlights_enabled_for_messaging"]) # noqa: PT009 # Finally, validate the entire response for consistency self.validate_xblock_info_consistency( @@ -3399,21 +3373,21 @@ def validate_chapter_xblock_info(self, xblock_info, has_child_info=True): """ Validate that the xblock info is correct for the test chapter. """ - self.assertEqual(xblock_info["category"], "chapter") - self.assertEqual(xblock_info["id"], str(self.chapter.location)) - self.assertEqual(xblock_info["display_name"], "Week 1") - self.assertTrue(xblock_info["published"]) - self.assertIsNone(xblock_info.get("edited_by", None)) - self.assertEqual( + self.assertEqual(xblock_info["category"], "chapter") # noqa: PT009 + self.assertEqual(xblock_info["id"], str(self.chapter.location)) # noqa: PT009 + self.assertEqual(xblock_info["display_name"], "Week 1") # noqa: PT009 + self.assertTrue(xblock_info["published"]) # noqa: PT009 + self.assertIsNone(xblock_info.get("edited_by", None)) # noqa: PT009 + self.assertEqual( # noqa: PT009 xblock_info["course_graders"], ["Homework", "Lab", "Midterm Exam", "Final Exam"], ) - self.assertEqual(xblock_info["start"], "2030-01-01T00:00:00Z") - self.assertEqual(xblock_info["graded"], False) - self.assertEqual(xblock_info["due"], None) - self.assertEqual(xblock_info["format"], None) - self.assertEqual(xblock_info["highlights"], self.chapter.highlights) - self.assertTrue(xblock_info["highlights_enabled"]) + self.assertEqual(xblock_info["start"], DEFAULT_START_DATE.strftime('%Y-%m-%dT%H:%M:%SZ')) # noqa: PT009 + self.assertEqual(xblock_info["graded"], False) # noqa: PT009 + self.assertEqual(xblock_info["due"], None) # noqa: PT009 + self.assertEqual(xblock_info["format"], None) # noqa: PT009 + self.assertEqual(xblock_info["highlights"], self.chapter.highlights) # noqa: PT009 + self.assertTrue(xblock_info["highlights_enabled"]) # noqa: PT009 # Finally, validate the entire response for consistency self.validate_xblock_info_consistency( @@ -3424,11 +3398,11 @@ def validate_sequential_xblock_info(self, xblock_info, has_child_info=True): """ Validate that the xblock info is correct for the test sequential. """ - self.assertEqual(xblock_info["category"], "sequential") - self.assertEqual(xblock_info["id"], str(self.sequential.location)) - self.assertEqual(xblock_info["display_name"], "Lesson 1") - self.assertTrue(xblock_info["published"]) - self.assertIsNone(xblock_info.get("edited_by", None)) + self.assertEqual(xblock_info["category"], "sequential") # noqa: PT009 + self.assertEqual(xblock_info["id"], str(self.sequential.location)) # noqa: PT009 + self.assertEqual(xblock_info["display_name"], "Lesson 1") # noqa: PT009 + self.assertTrue(xblock_info["published"]) # noqa: PT009 + self.assertIsNone(xblock_info.get("edited_by", None)) # noqa: PT009 # Finally, validate the entire response for consistency self.validate_xblock_info_consistency( @@ -3439,17 +3413,17 @@ def validate_vertical_xblock_info(self, xblock_info): """ Validate that the xblock info is correct for the test vertical. """ - self.assertEqual(xblock_info["category"], "vertical") - self.assertEqual(xblock_info["id"], str(self.vertical.location)) - self.assertEqual(xblock_info["display_name"], "Unit 1") - self.assertTrue(xblock_info["published"]) - self.assertEqual(xblock_info["edited_by"], "testuser") + self.assertEqual(xblock_info["category"], "vertical") # noqa: PT009 + self.assertEqual(xblock_info["id"], str(self.vertical.location)) # noqa: PT009 + self.assertEqual(xblock_info["display_name"], "Unit 1") # noqa: PT009 + self.assertTrue(xblock_info["published"]) # noqa: PT009 + self.assertEqual(xblock_info["edited_by"], "testuser") # noqa: PT009 # Validate that the correct ancestor info has been included ancestor_info = xblock_info.get("ancestor_info", None) - self.assertIsNotNone(ancestor_info) + self.assertIsNotNone(ancestor_info) # noqa: PT009 ancestors = ancestor_info["ancestors"] - self.assertEqual(len(ancestors), 3) + self.assertEqual(len(ancestors), 3) # noqa: PT009 self.validate_sequential_xblock_info(ancestors[0], has_child_info=True) self.validate_chapter_xblock_info(ancestors[1], has_child_info=False) self.validate_course_xblock_info(ancestors[2], has_child_info=False) @@ -3463,11 +3437,11 @@ def validate_component_xblock_info(self, xblock_info): """ Validate that the xblock info is correct for the test component. """ - self.assertEqual(xblock_info["category"], "video") - self.assertEqual(xblock_info["id"], str(self.video.location)) - self.assertEqual(xblock_info["display_name"], "My Video") - self.assertTrue(xblock_info["published"]) - self.assertIsNone(xblock_info.get("edited_by", None)) + self.assertEqual(xblock_info["category"], "video") # noqa: PT009 + self.assertEqual(xblock_info["id"], str(self.video.location)) # noqa: PT009 + self.assertEqual(xblock_info["display_name"], "My Video") # noqa: PT009 + self.assertTrue(xblock_info["published"]) # noqa: PT009 + self.assertIsNone(xblock_info.get("edited_by", None)) # noqa: PT009 # Finally, validate the entire response for consistency self.validate_xblock_info_consistency(xblock_info) @@ -3482,12 +3456,12 @@ def validate_xblock_info_consistency( """ Validate that the xblock info is internally consistent. """ - self.assertIsNotNone(xblock_info["display_name"]) - self.assertIsNotNone(xblock_info["id"]) - self.assertIsNotNone(xblock_info["category"]) - self.assertTrue(xblock_info["published"]) + self.assertIsNotNone(xblock_info["display_name"]) # noqa: PT009 + self.assertIsNotNone(xblock_info["id"]) # noqa: PT009 + self.assertIsNotNone(xblock_info["category"]) # noqa: PT009 + self.assertTrue(xblock_info["published"]) # noqa: PT009 if has_ancestor_info: - self.assertIsNotNone(xblock_info.get("ancestor_info", None)) + self.assertIsNotNone(xblock_info.get("ancestor_info", None)) # noqa: PT009 ancestors = xblock_info["ancestor_info"]["ancestors"] for ancestor in xblock_info["ancestor_info"]["ancestors"]: self.validate_xblock_info_consistency( @@ -3498,20 +3472,236 @@ def validate_xblock_info_consistency( course_outline=course_outline, ) else: - self.assertIsNone(xblock_info.get("ancestor_info", None)) + self.assertIsNone(xblock_info.get("ancestor_info", None)) # noqa: PT009 if has_child_info: - self.assertIsNotNone(xblock_info.get("child_info", None)) + self.assertIsNotNone(xblock_info.get("child_info", None)) # noqa: PT009 if xblock_info["child_info"].get("children", None): for child_response in xblock_info["child_info"]["children"]: self.validate_xblock_info_consistency( child_response, has_child_info=( - not child_response.get("child_info", None) is None + child_response.get("child_info", None) is not None ), course_outline=course_outline, ) else: - self.assertIsNone(xblock_info.get("child_info", None)) + self.assertIsNone(xblock_info.get("child_info", None)) # noqa: PT009 + + +@ddt.ddt +class TestXBlockOutlineHandlerAuthz(CourseAuthoringAuthzTestMixin, ItemTest): + """ + Unit tests for xblock_outline_handler authorization functionality. + """ + + def setUp(self): + super().setUp() + user_id = self.user.id + self.chapter = BlockFactory.create( + parent_location=self.course.location, + category="chapter", + display_name="Week 1", + user_id=user_id, + ) + self.sequential = BlockFactory.create( + parent_location=self.chapter.location, + category="sequential", + display_name="Lesson 1", + user_id=user_id, + ) + self.vertical = BlockFactory.create( + parent_location=self.sequential.location, + category="vertical", + display_name="Unit 1", + user_id=user_id, + ) + # Assign COURSE_STAFF role to authorized_user for the course + self.add_user_to_role_in_course( + self.authorized_user, + COURSE_STAFF.external_key, + self.course.id + ) + + def test_authorized_user_gets_json_response(self): + """ + Test that authorized user gets JSON response from xblock_outline_handler. + """ + outline_url = reverse_usage_url("xblock_outline_handler", self.usage_key) + + self.client.login(username=self.authorized_user.username, password=self.password) + resp = self.client.get(outline_url, HTTP_ACCEPT="application/json") + + assert resp.status_code == 200 + json_response = json.loads(resp.content.decode("utf-8")) + assert "id" in json_response + assert "display_name" in json_response + assert "child_info" in json_response + + @ddt.data( + COURSE_ADMIN.external_key, + COURSE_AUDITOR.external_key, + COURSE_EDITOR.external_key, + ) + def test_other_course_roles_can_view_outline(self, role_key): + """ + Test that course_admin, course_auditor, and course_editor roles + can access the outline (all have COURSES_VIEW_COURSE). + """ + role_user = UserFactory(password=self.password) + self.add_user_to_role_in_course(role_user, role_key, self.course.id) + + outline_url = reverse_usage_url("xblock_outline_handler", self.usage_key) + self.client.login(username=role_user.username, password=self.password) + resp = self.client.get(outline_url, HTTP_ACCEPT="application/json") + + assert resp.status_code == 200 + + def test_unauthorized_user_gets_permission_denied(self): + """ + Test that unauthorized user gets 403 response from xblock_outline_handler. + """ + outline_url = reverse_usage_url("xblock_outline_handler", self.usage_key) + + self.client.login(username=self.unauthorized_user.username, password=self.password) + resp = self.client.get(outline_url, HTTP_ACCEPT="application/json") + + assert resp.status_code == 403 + + def test_superuser_gets_json_response(self): + """ + Test that superuser gets JSON response from xblock_outline_handler. + """ + outline_url = reverse_usage_url("xblock_outline_handler", self.usage_key) + + self.client.login(username=self.super_user.username, password=self.password) + resp = self.client.get(outline_url, HTTP_ACCEPT="application/json") + + assert resp.status_code == 200 + json_response = json.loads(resp.content.decode("utf-8")) + assert "id" in json_response + assert "display_name" in json_response + assert "child_info" in json_response + + def test_staff_user_gets_json_response(self): + """ + Test that staff user gets JSON response from xblock_outline_handler. + """ + outline_url = reverse_usage_url("xblock_outline_handler", self.usage_key) + + self.client.login(username=self.staff_user.username, password=self.password) + resp = self.client.get(outline_url, HTTP_ACCEPT="application/json") + + assert resp.status_code == 200 + json_response = json.loads(resp.content.decode("utf-8")) + assert "id" in json_response + assert "display_name" in json_response + assert "child_info" in json_response + + def test_authorized_chapter_outline(self): + """ + Test that authorized user can access chapter-level outline. + """ + outline_url = reverse_usage_url("xblock_outline_handler", self.chapter.location) + + self.client.login(username=self.authorized_user.username, password=self.password) + resp = self.client.get(outline_url, HTTP_ACCEPT="application/json") + + assert resp.status_code == 200 + json_response = json.loads(resp.content.decode("utf-8")) + assert json_response["display_name"] == "Week 1" + assert "child_info" in json_response + # Verify that children are included (should have the sequential) + children = json_response["child_info"]["children"] + assert len(children) > 0 + assert children[0]["display_name"] == "Lesson 1" + + def test_unauthorized_chapter_outline(self): + """ + Test that unauthorized user cannot access chapter-level outline. + """ + outline_url = reverse_usage_url("xblock_outline_handler", self.chapter.location) + + self.client.login(username=self.unauthorized_user.username, password=self.password) + resp = self.client.get(outline_url, HTTP_ACCEPT="application/json") + + assert resp.status_code == 403 + + +class TestGetMetadataWithProblemDefaults(ModuleStoreTestCase): + """ + Unit tests for _get_metadata_with_problem_defaults. + + The helper must inject a ``weight`` value (derived from ``max_score()``) for + problem xblocks that have never had ``weight`` explicitly saved, while leaving + every other combination untouched. + """ + + def _make_problem(self, **kwargs): + """Create and return a problem xblock from the modulestore.""" + course = CourseFactory.create() + block = BlockFactory.create( + parent_location=course.location, + category='problem', + display_name='A Problem', + **kwargs, + ) + return modulestore().get_item(block.location) + + # ------------------------------------------------------------------ + # Problem blocks – weight absent from stored metadata + # ------------------------------------------------------------------ + + def test_problem_without_weight_adds_weight_from_max_score(self): + """ + When weight is absent and max_score() > 0, it is injected into metadata. + """ + xblock = self._make_problem() + with patch.object(xblock, 'max_score', return_value=3.0): + metadata = _get_metadata_with_problem_defaults(xblock) + assert metadata.get('weight') == 3.0 + + def test_problem_without_weight_max_score_zero_does_not_inject(self): + """ + A zero max_score will not inject a weight. + """ + xblock = self._make_problem() + with patch.object(xblock, 'max_score', return_value=0): + metadata = _get_metadata_with_problem_defaults(xblock) + assert 'weight' not in metadata + + # ------------------------------------------------------------------ + # Problem blocks – weight already present in stored metadata + # ------------------------------------------------------------------ + + def test_problem_with_explicit_weight_is_preserved(self): + """ + When weight is already explicitly set, it will not be overwritten. + """ + xblock = self._make_problem(weight=5.0) + with patch.object(xblock, 'max_score', return_value=2.0): + metadata = _get_metadata_with_problem_defaults(xblock) + assert metadata.get('weight') == 5.0 + + # ------------------------------------------------------------------ + # Non-problem blocks + # ------------------------------------------------------------------ + + def test_non_problem_block_is_unmodified(self): + """ + Non-problem blocks must pass through untouched even if a max_score + method is available on them. + """ + course = CourseFactory.create() + video = BlockFactory.create( + parent_location=course.location, + category='video', + display_name='A Video', + ) + xblock = modulestore().get_item(video.location) + metadata_before = dict(get_block_info(xblock).get('metadata', {})) + metadata_result = _get_metadata_with_problem_defaults(xblock) + assert metadata_result == metadata_before + assert 'weight' not in metadata_result @patch.dict("django.conf.settings.FEATURES", {"ENABLE_SPECIAL_EXAMS": True}) @@ -3570,7 +3760,7 @@ def test_proctoring_is_enabled_for_course(self): def test_special_exam_xblock_info( self, mock_get_exam_by_content_id, - _mock_does_backend_support_onboarding, + _mock_does_backend_support_onboarding, # noqa: PT019 mock_get_exam_configuration_dashboard_url, ): sequential = BlockFactory.create( @@ -3615,7 +3805,7 @@ def test_special_exam_xblock_info( def test_show_review_rules_xblock_info( self, mock_get_exam_by_content_id, - _mock_does_backend_support_onboarding, + _mock_does_backend_support_onboarding, # noqa: PT019 mock_get_exam_configuration_dashboard_url, ): # Set course.proctoring_provider to test_proctoring_provider @@ -3655,7 +3845,7 @@ def test_proctoring_values_correct_depending_on_lti_external( expected_proctoring_link, mock_get_exam_by_content_id, mock_does_backend_support_onboarding, - _mock_get_exam_configuration_dashboard_url, + _mock_get_exam_configuration_dashboard_url, # noqa: PT019 ): sequential = BlockFactory.create( parent_location=self.chapter.location, @@ -3697,8 +3887,8 @@ def test_xblock_was_ever_linked_to_external_exam( external_id, expected_value, mock_get_exam_by_content_id, - _mock_does_backend_support_onboarding_patch, - _mock_get_exam_configuration_dashboard_url, + _mock_does_backend_support_onboarding_patch, # noqa: PT019 + _mock_get_exam_configuration_dashboard_url, # noqa: PT019 ): sequential = BlockFactory.create( parent_location=self.chapter.location, @@ -3725,8 +3915,8 @@ def test_xblock_was_ever_linked_to_external_exam( def test_xblock_was_never_linked_to_external_exam( self, mock_get_exam_by_content_id, - _mock_does_backend_support_onboarding_patch, - _mock_get_exam_configuration_dashboard_url, + _mock_does_backend_support_onboarding_patch, # noqa: PT019 + _mock_get_exam_configuration_dashboard_url, # noqa: PT019 ): sequential = BlockFactory.create( parent_location=self.chapter.location, @@ -3752,7 +3942,7 @@ def test_xblock_was_never_linked_to_external_exam( def test_special_exam_xblock_info_get_dashboard_error( self, mock_get_exam_by_content_id, - _mock_does_backend_support_onboarding, + _mock_does_backend_support_onboarding, # noqa: PT019 mock_get_exam_configuration_dashboard_url, ): sequential = BlockFactory.create( @@ -3817,7 +4007,7 @@ def test_lib_xblock_info(self): html_block = modulestore().get_item(self.top_level_html.location) xblock_info = create_xblock_info(html_block) self.validate_component_xblock_info(xblock_info, html_block) - self.assertIsNone(xblock_info.get("child_info", None)) + self.assertIsNone(xblock_info.get("child_info", None)) # noqa: PT009 def test_lib_child_xblock_info(self): html_block = modulestore().get_item(self.child_html.location) @@ -3825,24 +4015,24 @@ def test_lib_child_xblock_info(self): html_block, include_ancestor_info=True, include_child_info=True ) self.validate_component_xblock_info(xblock_info, html_block) - self.assertIsNone(xblock_info.get("child_info", None)) + self.assertIsNone(xblock_info.get("child_info", None)) # noqa: PT009 ancestors = xblock_info["ancestor_info"]["ancestors"] - self.assertEqual(len(ancestors), 2) - self.assertEqual(ancestors[0]["category"], "vertical") - self.assertEqual(ancestors[0]["id"], str(self.vertical.location)) - self.assertEqual(ancestors[1]["category"], "library") + self.assertEqual(len(ancestors), 2) # noqa: PT009 + self.assertEqual(ancestors[0]["category"], "vertical") # noqa: PT009 + self.assertEqual(ancestors[0]["id"], str(self.vertical.location)) # noqa: PT009 + self.assertEqual(ancestors[1]["category"], "library") # noqa: PT009 def validate_component_xblock_info(self, xblock_info, original_block): """ Validate that the xblock info is correct for the test component. """ - self.assertEqual(xblock_info["category"], original_block.category) - self.assertEqual(xblock_info["id"], str(original_block.location)) - self.assertEqual(xblock_info["display_name"], original_block.display_name) - self.assertIsNone(xblock_info.get("has_changes", None)) - self.assertIsNone(xblock_info.get("published", None)) - self.assertIsNone(xblock_info.get("published_on", None)) - self.assertIsNone(xblock_info.get("graders", None)) + self.assertEqual(xblock_info["category"], original_block.category) # noqa: PT009 + self.assertEqual(xblock_info["id"], str(original_block.location)) # noqa: PT009 + self.assertEqual(xblock_info["display_name"], original_block.display_name) # noqa: PT009 + self.assertIsNone(xblock_info.get("has_changes", None)) # noqa: PT009 + self.assertIsNone(xblock_info.get("published", None)) # noqa: PT009 + self.assertIsNone(xblock_info.get("published_on", None)) # noqa: PT009 + self.assertIsNone(xblock_info.get("graders", None)) # noqa: PT009 class TestLibraryXBlockCreation(ItemTest): @@ -3859,9 +4049,9 @@ def test_add_xblock(self): parent_usage_key=lib.location, display_name="Test", category="html" ) lib = self.store.get_library(lib.location.library_key) - self.assertTrue(lib.children) + self.assertTrue(lib.children) # noqa: PT009 xblock_locator = lib.children[0] - self.assertEqual(self.store.get_item(xblock_locator).display_name, "Test") + self.assertEqual(self.store.get_item(xblock_locator).display_name, "Test") # noqa: PT009 def test_no_add_discussion(self): """ @@ -3871,9 +4061,9 @@ def test_no_add_discussion(self): response = self.create_xblock( parent_usage_key=lib.location, display_name="Test", category="discussion" ) - self.assertEqual(response.status_code, 400) + self.assertEqual(response.status_code, 400) # noqa: PT009 lib = self.store.get_library(lib.location.library_key) - self.assertFalse(lib.children) + self.assertFalse(lib.children) # noqa: PT009 def test_no_add_advanced(self): lib = LibraryFactory.create() @@ -3882,9 +4072,9 @@ def test_no_add_advanced(self): response = self.create_xblock( parent_usage_key=lib.location, display_name="Test", category="lti" ) - self.assertEqual(response.status_code, 400) + self.assertEqual(response.status_code, 400) # noqa: PT009 lib = self.store.get_library(lib.location.library_key) - self.assertFalse(lib.children) + self.assertFalse(lib.children) # noqa: PT009 @ddt.ddt @@ -3920,7 +4110,7 @@ def _get_child_xblock_info(self, xblock_info, index): Returns the child xblock info at the specified index. """ children = xblock_info["child_info"]["children"] - self.assertGreater(len(children), index) + self.assertGreater(len(children), index) # noqa: PT009 return children[index] def _get_xblock_info(self, location): @@ -3993,9 +4183,9 @@ def _verify_xblock_info_state( ) else: if should_equal: - self.assertEqual(xblock_info[xblock_info_field], expected_state) + self.assertEqual(xblock_info[xblock_info_field], expected_state) # noqa: PT009 else: - self.assertNotEqual(xblock_info[xblock_info_field], expected_state) + self.assertNotEqual(xblock_info[xblock_info_field], expected_state) # noqa: PT009 def _verify_has_staff_only_message(self, xblock_info, expected_state, path=None): """ @@ -4175,7 +4365,7 @@ def test_staff_only_section(self): vertical_info = self._get_xblock_info(vertical.location) add_container_page_publishing_info(vertical, vertical_info) - self.assertEqual( + self.assertEqual( # noqa: PT009 _xblock_type_and_display_name(chapter), vertical_info["staff_lock_from"] ) @@ -4226,7 +4416,7 @@ def test_staff_only_subsection(self): vertical_info = self._get_xblock_info(vertical.location) add_container_page_publishing_info(vertical, vertical_info) - self.assertEqual( + self.assertEqual( # noqa: PT009 _xblock_type_and_display_name(sequential), vertical_info["staff_lock_from"] ) @@ -4278,7 +4468,7 @@ def test_staff_only_unit(self): vertical_info = self._get_xblock_info(vertical.location) add_container_page_publishing_info(vertical, vertical_info) - self.assertEqual( + self.assertEqual( # noqa: PT009 _xblock_type_and_display_name(vertical), vertical_info["staff_lock_from"] ) @@ -4372,12 +4562,12 @@ def test_self_paced_item_visibility_state(self): # Check that chapter has scheduled state xblock_info = self._get_xblock_info(chapter.location) self._verify_visibility_state(xblock_info, VisibilityState.ready) - self.assertFalse(course.self_paced) + self.assertFalse(course.self_paced) # noqa: PT009 # Change course pacing to self paced course.self_paced = True self.store.update_item(course, self.user.id) - self.assertTrue(course.self_paced) + self.assertTrue(course.self_paced) # noqa: PT009 # Check that in self paced course content has live state now xblock_info = self._get_xblock_info(chapter.location) @@ -4430,13 +4620,13 @@ def create_source_block(self, course): # quick sanity checks source_block = self.store.get_item(source_block.location) - self.assertEqual(source_block.due, datetime(2010, 11, 22, 4, 0, tzinfo=UTC)) - self.assertEqual(source_block.display_name, "Source Block") - self.assertEqual( + self.assertEqual(source_block.due, datetime(2010, 11, 22, 4, 0, tzinfo=UTC)) # noqa: PT009 + self.assertEqual(source_block.display_name, "Source Block") # noqa: PT009 + self.assertEqual( # noqa: PT009 source_block.runtime.get_asides(source_block)[0].field11, "html_new_value1" ) - self.assertEqual(source_block.data, "
test
") - self.assertEqual(source_block.items, ["test", "beep"]) + self.assertEqual(source_block.data, "
test
") # noqa: PT009 + self.assertEqual(source_block.items, ["test", "beep"]) # noqa: PT009 return source_block @@ -4445,12 +4635,12 @@ def check_updated(self, source_block, destination_key): Check that the destination block has been updated to match our source block. """ revised = self.store.get_item(destination_key) - self.assertEqual(source_block.display_name, revised.display_name) - self.assertEqual(source_block.due, revised.due) - self.assertEqual(revised.data, source_block.data) - self.assertEqual(revised.items, source_block.items) + self.assertEqual(source_block.display_name, revised.display_name) # noqa: PT009 + self.assertEqual(source_block.due, revised.due) # noqa: PT009 + self.assertEqual(revised.data, source_block.data) # noqa: PT009 + self.assertEqual(revised.items, source_block.items) # noqa: PT009 - self.assertEqual( + self.assertEqual( # noqa: PT009 revised.runtime.get_asides(revised)[0].field11, source_block.runtime.get_asides(source_block)[0].field11, ) @@ -4548,15 +4738,15 @@ def _create_block(self, parent, category, display_name, **kwargs): def test_xblock_edit_view(self): url = reverse_usage_url("xblock_edit_handler", self.video.location) resp = self.client.get_html(url) - self.assertEqual(resp.status_code, 200) + self.assertEqual(resp.status_code, 200) # noqa: PT009 html_content = resp.content.decode(resp.charset) - self.assertIn("var decodedActionName = 'edit';", html_content) + self.assertIn("var decodedActionName = 'edit';", html_content) # noqa: PT009 def test_xblock_edit_view_contains_resources(self): url = reverse_usage_url("xblock_edit_handler", self.video.location) resp = self.client.get(url) - self.assertEqual(resp.status_code, 200) + self.assertEqual(resp.status_code, 200) # noqa: PT009 html_content = resp.content.decode(resp.charset) soup = BeautifulSoup(html_content, "html.parser") @@ -4564,5 +4754,22 @@ def test_xblock_edit_view_contains_resources(self): resource_links = [link["href"] for link in soup.find_all("link", {"rel": "stylesheet"})] script_sources = [script["src"] for script in soup.find_all("script") if script.get("src")] - self.assertGreater(len(resource_links), 0, f"No CSS resources found in HTML. Found: {resource_links}") - self.assertGreater(len(script_sources), 0, f"No JS resources found in HTML. Found: {script_sources}") + self.assertGreater(len(resource_links), 0, f"No CSS resources found in HTML. Found: {resource_links}") # noqa: PT009 # pylint: disable=line-too-long + self.assertGreater(len(script_sources), 0, f"No JS resources found in HTML. Found: {script_sources}") # noqa: PT009 # pylint: disable=line-too-long + + def test_xblock_edit_view_contains_page_notification(self): + """ + The page-notification element is required for XBlock runtime error + notifications (e.g. ORA validation errors) to be visible to the user. + """ + url = reverse_usage_url("xblock_edit_handler", self.video.location) + resp = self.client.get(url) + self.assertEqual(resp.status_code, 200) # noqa: PT009 + + html_content = resp.content.decode(resp.charset) + soup = BeautifulSoup(html_content, "html.parser") + self.assertIsNotNone( # noqa: PT009 + soup.find(id="page-notification"), + "container_editor.html must include a #page-notification element " + "so that XBlock runtime error notifications are rendered.", + ) diff --git a/cms/djangoapps/contentstore/views/tests/test_certificates.py b/cms/djangoapps/contentstore/views/tests/test_certificates.py index dfbad798f6f4..0da1596b3986 100644 --- a/cms/djangoapps/contentstore/views/tests/test_certificates.py +++ b/cms/djangoapps/contentstore/views/tests/test_certificates.py @@ -5,15 +5,12 @@ import itertools import json -from unittest import mock import ddt from django.conf import settings from django.test.utils import override_settings -from edx_toggles.toggles.testutils import override_waffle_flag from opaque_keys.edx.keys import AssetKey -from cms.djangoapps.contentstore import toggles from cms.djangoapps.contentstore.tests.utils import CourseTestCase from cms.djangoapps.contentstore.utils import get_lms_link_for_certificate_web_view, reverse_course_url from common.djangoapps.course_modes.tests.factories import CourseModeFactory @@ -21,9 +18,9 @@ from common.djangoapps.student.roles import CourseInstructorRole, CourseStaffRole from common.djangoapps.student.tests.factories import UserFactory from common.djangoapps.util.testing import EventTestMixin, UrlResetMixin -from xmodule.contentstore.content import StaticContent # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.contentstore.django import contentstore # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.exceptions import NotFoundError # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.contentstore.content import StaticContent # pylint: disable=wrong-import-order +from xmodule.contentstore.django import contentstore # pylint: disable=wrong-import-order +from xmodule.exceptions import NotFoundError # pylint: disable=wrong-import-order from ..certificate_manager import CERTIFICATE_SCHEMA_VERSION, CertificateManager @@ -143,10 +140,10 @@ def test_required_fields_are_absent(self): HTTP_X_REQUESTED_WITH="XMLHttpRequest" ) - self.assertEqual(response.status_code, 400) - self.assertNotIn("Location", response) + self.assertEqual(response.status_code, 400) # noqa: PT009 + self.assertNotIn("Location", response) # noqa: PT009 content = json.loads(response.content.decode('utf-8')) - self.assertIn("error", content) + self.assertIn("error", content) # noqa: PT009 def test_invalid_json(self): """ @@ -164,10 +161,10 @@ def test_invalid_json(self): HTTP_X_REQUESTED_WITH="XMLHttpRequest" ) - self.assertEqual(response.status_code, 400) - self.assertNotIn("Location", response) + self.assertEqual(response.status_code, 400) # noqa: PT009 + self.assertNotIn("Location", response) # noqa: PT009 content = json.loads(response.content.decode('utf-8')) - self.assertTrue("error" in content or "detail" in content) + self.assertTrue("error" in content or "detail" in content) # noqa: PT009 def test_certificate_data_validation(self): #Test certificate schema version @@ -177,10 +174,10 @@ def test_certificate_data_validation(self): 'description': 'Test description' } - with self.assertRaises(Exception) as context: + with self.assertRaises(Exception) as context: # noqa: PT027 CertificateManager.validate(json_data_1) - self.assertIn( + self.assertIn( # noqa: PT009 "Unsupported certificate schema version: 100. Expected version: 1.", str(context.exception) ) @@ -191,10 +188,10 @@ def test_certificate_data_validation(self): 'description': 'Test description' } - with self.assertRaises(Exception) as context: + with self.assertRaises(Exception) as context: # noqa: PT027 CertificateManager.validate(json_data_2) - self.assertIn('must have name of the certificate', str(context.exception)) + self.assertIn('must have name of the certificate', str(context.exception)) # noqa: PT009 @ddt.ddt @@ -206,7 +203,7 @@ class CertificatesListHandlerTestCase( Test cases for certificates_list_handler. """ - def setUp(self): # lint-amnesty, pylint: disable=arguments-differ + def setUp(self): # pylint: disable=arguments-differ """ Set up CertificatesListHandlerTestCase. """ @@ -235,11 +232,11 @@ def test_can_create_certificate(self): data=CERTIFICATE_JSON ) - self.assertEqual(response.status_code, 201) - self.assertIn("Location", response) + self.assertEqual(response.status_code, 201) # noqa: PT009 + self.assertIn("Location", response) # noqa: PT009 content = json.loads(response.content.decode('utf-8')) certificate_id = content.pop("id") - self.assertEqual(content, expected) + self.assertEqual(content, expected) # noqa: PT009 self.assert_event_emitted( 'edx.certificate.configuration.created', course_id=str(self.course.id), @@ -257,7 +254,7 @@ def test_cannot_create_certificate_if_user_has_no_write_permissions(self): data=CERTIFICATE_JSON ) - self.assertEqual(response.status_code, 403) + self.assertEqual(response.status_code, 403) # noqa: PT009 @override_settings(LMS_BASE=None) def test_no_lms_base_for_certificate_web_view_link(self): @@ -265,7 +262,7 @@ def test_no_lms_base_for_certificate_web_view_link(self): course_key=self.course.id, mode='honor' ) - self.assertEqual(test_link, None) + self.assertEqual(test_link, None) # noqa: PT009 @override_settings(LMS_BASE="lms_base_url") def test_lms_link_for_certificate_web_view(self): @@ -275,13 +272,11 @@ def test_lms_link_for_certificate_web_view(self): course_key=self.course.id, mode='honor' ) - self.assertEqual(link, test_url) + self.assertEqual(link, test_url) # noqa: PT009 - @override_waffle_flag(toggles.LEGACY_STUDIO_CERTIFICATES, True) - @mock.patch.dict('django.conf.settings.FEATURES', {'CERTIFICATES_HTML_VIEW': True}) def test_certificate_info_in_response(self): """ - Test that certificate has been created and rendered properly with non-audit course mode. + Test that a created certificate is returned in the JSON GET response. """ CourseModeFactory.create(course_id=self.course.id, mode_slug='verified') response = self.client.ajax_post( @@ -289,37 +284,14 @@ def test_certificate_info_in_response(self): data=CERTIFICATE_JSON_WITH_SIGNATORIES ) - self.assertEqual(response.status_code, 201) - - # in html response - result = self.client.get_html(self._url()) - self.assertContains(result, 'Test certificate') - self.assertContains(result, 'Test description') + self.assertEqual(response.status_code, 201) # noqa: PT009 - # in JSON response response = self.client.get_json(self._url()) data = json.loads(response.content.decode('utf-8')) - self.assertEqual(len(data), 1) - self.assertEqual(data[0]['name'], 'Test certificate') - self.assertEqual(data[0]['description'], 'Test description') - self.assertEqual(data[0]['version'], CERTIFICATE_SCHEMA_VERSION) - - @mock.patch.dict('django.conf.settings.FEATURES', {'CERTIFICATES_HTML_VIEW': True}) - @override_waffle_flag(toggles.LEGACY_STUDIO_CERTIFICATES, True) - def test_certificate_info_not_in_response(self): - """ - Test that certificate has not been rendered audit only course mode. - """ - response = self.client.ajax_post( - self._url(), - data=CERTIFICATE_JSON_WITH_SIGNATORIES - ) - - self.assertEqual(response.status_code, 201) - - # in html response - result = self.client.get_html(self._url()) - self.assertNotContains(result, 'Test certificate') + self.assertEqual(len(data), 1) # noqa: PT009 + self.assertEqual(data[0]['name'], 'Test certificate') # noqa: PT009 + self.assertEqual(data[0]['description'], 'Test description') # noqa: PT009 + self.assertEqual(data[0]['version'], CERTIFICATE_SCHEMA_VERSION) # noqa: PT009 def test_unsupported_http_accept_header(self): """ @@ -329,14 +301,14 @@ def test_unsupported_http_accept_header(self): self._url(), HTTP_ACCEPT="text/plain", ) - self.assertEqual(response.status_code, 406) + self.assertEqual(response.status_code, 406) # noqa: PT009 def test_certificate_unsupported_method(self): """ Unit Test: test_certificate_unsupported_method """ resp = self.client.put(self._url()) - self.assertEqual(resp.status_code, 405) + self.assertEqual(resp.status_code, 405) # noqa: PT009 def test_not_permitted(self): """ @@ -350,55 +322,6 @@ def test_not_permitted(self): ) self.assertContains(response, "error", status_code=403) - @override_waffle_flag(toggles.LEGACY_STUDIO_CERTIFICATES, True) - def test_audit_course_mode_is_skipped(self): - """ - Tests audit course mode is skipped when rendering certificates page. - """ - CourseModeFactory.create(course_id=self.course.id) - CourseModeFactory.create(course_id=self.course.id, mode_slug='verified') - response = self.client.get_html( - self._url(), - ) - self.assertEqual(response.status_code, 200) - self.assertContains(response, 'verified') - self.assertNotContains(response, 'audit') - - @override_waffle_flag(toggles.LEGACY_STUDIO_CERTIFICATES, True) - def test_audit_only_disables_cert(self): - """ - Tests audit course mode is skipped when rendering certificates page. - """ - CourseModeFactory.create(course_id=self.course.id, mode_slug='audit') - response = self.client.get_html( - self._url(), - ) - self.assertEqual(response.status_code, 200) - self.assertContains(response, 'This course does not use a mode that offers certificates.') - self.assertNotContains(response, 'This module is not enabled.') - self.assertNotContains(response, 'Loading') - - @ddt.data( - ['audit', 'verified'], - ['verified'], - ['audit', 'verified', 'credit'], - ['verified', 'credit'], - ['professional'] - ) - @override_waffle_flag(toggles.LEGACY_STUDIO_CERTIFICATES, True) - def test_non_audit_enables_cert(self, slugs): - """ - Tests audit course mode is skipped when rendering certificates page. - """ - for slug in slugs: - CourseModeFactory.create(course_id=self.course.id, mode_slug=slug) - response = self.client.get_html( - self._url(), - ) - self.assertEqual(response.status_code, 200) - self.assertNotContains(response, 'This course does not use a mode that offers certificates.') - self.assertNotContains(response, 'This module is not enabled.') - self.assertContains(response, 'Loading') def test_assign_unique_identifier_to_certificates(self): """ @@ -423,7 +346,7 @@ def test_assign_unique_identifier_to_certificates(self): new_certificate = json.loads(response.content.decode('utf-8')) for prev_certificate in self.course.certificates['certificates']: - self.assertNotEqual(new_certificate.get('id'), prev_certificate.get('id')) + self.assertNotEqual(new_certificate.get('id'), prev_certificate.get('id')) # noqa: PT009 @ddt.ddt @@ -476,7 +399,7 @@ def test_can_create_new_certificate_if_it_does_not_exist(self): HTTP_X_REQUESTED_WITH="XMLHttpRequest", ) content = json.loads(response.content.decode('utf-8')) - self.assertEqual(content, expected) + self.assertEqual(content, expected) # noqa: PT009 self.assert_event_emitted( 'edx.certificate.configuration.created', course_id=str(self.course.id), @@ -508,7 +431,7 @@ def test_can_edit_certificate(self): HTTP_X_REQUESTED_WITH="XMLHttpRequest", ) content = json.loads(response.content.decode('utf-8')) - self.assertEqual(content, expected) + self.assertEqual(content, expected) # noqa: PT009 self.assert_event_emitted( 'edx.certificate.configuration.modified', course_id=str(self.course.id), @@ -518,9 +441,9 @@ def test_can_edit_certificate(self): # Verify that certificate is properly updated in the course. course_certificates = self.course.certificates['certificates'] - self.assertEqual(len(course_certificates), 2) - self.assertEqual(course_certificates[1].get('name'), 'New test certificate') - self.assertEqual(course_certificates[1].get('description'), 'New test description') + self.assertEqual(len(course_certificates), 2) # noqa: PT009 + self.assertEqual(course_certificates[1].get('name'), 'New test certificate') # noqa: PT009 + self.assertEqual(course_certificates[1].get('description'), 'New test description') # noqa: PT009 def test_can_edit_certificate_without_is_active(self): """ @@ -557,9 +480,9 @@ def test_can_edit_certificate_without_is_active(self): HTTP_ACCEPT="application/json", HTTP_X_REQUESTED_WITH="XMLHttpRequest", ) - self.assertEqual(response.status_code, 201) + self.assertEqual(response.status_code, 201) # noqa: PT009 content = json.loads(response.content.decode('utf-8')) - self.assertEqual(content, expected) + self.assertEqual(content, expected) # noqa: PT009 @ddt.data(C4X_SIGNATORY_PATH, SIGNATORY_PATH) def test_can_delete_certificate_with_signatories(self, signatory_path): @@ -573,7 +496,7 @@ def test_can_delete_certificate_with_signatories(self, signatory_path): HTTP_ACCEPT="application/json", HTTP_X_REQUESTED_WITH="XMLHttpRequest", ) - self.assertEqual(response.status_code, 204) + self.assertEqual(response.status_code, 204) # noqa: PT009 self.assert_event_emitted( 'edx.certificate.configuration.deleted', course_id=str(self.course.id), @@ -582,9 +505,9 @@ def test_can_delete_certificate_with_signatories(self, signatory_path): self.reload_course() # Verify that certificates are properly updated in the course. certificates = self.course.certificates['certificates'] - self.assertEqual(len(certificates), 1) - self.assertEqual(certificates[0].get('name'), 'Name 0') - self.assertEqual(certificates[0].get('description'), 'Description 0') + self.assertEqual(len(certificates), 1) # noqa: PT009 + self.assertEqual(certificates[0].get('name'), 'Name 0') # noqa: PT009 + self.assertEqual(certificates[0].get('description'), 'Description 0') # noqa: PT009 def test_can_delete_certificate_with_slash_prefix_signatory(self): """ @@ -597,7 +520,7 @@ def test_can_delete_certificate_with_slash_prefix_signatory(self): HTTP_ACCEPT="application/json", HTTP_X_REQUESTED_WITH="XMLHttpRequest", ) - self.assertEqual(response.status_code, 204) + self.assertEqual(response.status_code, 204) # noqa: PT009 self.assert_event_emitted( 'edx.certificate.configuration.deleted', course_id=str(self.course.id), @@ -606,9 +529,9 @@ def test_can_delete_certificate_with_slash_prefix_signatory(self): self.reload_course() # Verify that certificates are properly updated in the course. certificates = self.course.certificates['certificates'] - self.assertEqual(len(certificates), 1) - self.assertEqual(certificates[0].get('name'), 'Name 0') - self.assertEqual(certificates[0].get('description'), 'Description 0') + self.assertEqual(len(certificates), 1) # noqa: PT009 + self.assertEqual(certificates[0].get('name'), 'Name 0') # noqa: PT009 + self.assertEqual(certificates[0].get('description'), 'Description 0') # noqa: PT009 @ddt.data("not_a_valid_asset_key{}.png", "/not_a_valid_asset_key{}.png") def test_can_delete_certificate_with_invalid_signatory(self, signatory_path): @@ -622,7 +545,7 @@ def test_can_delete_certificate_with_invalid_signatory(self, signatory_path): HTTP_ACCEPT="application/json", HTTP_X_REQUESTED_WITH="XMLHttpRequest", ) - self.assertEqual(response.status_code, 204) + self.assertEqual(response.status_code, 204) # noqa: PT009 self.assert_event_emitted( 'edx.certificate.configuration.deleted', course_id=str(self.course.id), @@ -631,9 +554,9 @@ def test_can_delete_certificate_with_invalid_signatory(self, signatory_path): self.reload_course() # Verify that certificates are properly updated in the course. certificates = self.course.certificates['certificates'] - self.assertEqual(len(certificates), 1) - self.assertEqual(certificates[0].get('name'), 'Name 0') - self.assertEqual(certificates[0].get('description'), 'Description 0') + self.assertEqual(len(certificates), 1) # noqa: PT009 + self.assertEqual(certificates[0].get('name'), 'Name 0') # noqa: PT009 + self.assertEqual(certificates[0].get('description'), 'Description 0') # noqa: PT009 @ddt.data(C4X_SIGNATORY_PATH, SIGNATORY_PATH) def test_delete_certificate_without_write_permissions(self, signatory_path): @@ -649,7 +572,7 @@ def test_delete_certificate_without_write_permissions(self, signatory_path): HTTP_ACCEPT="application/json", HTTP_X_REQUESTED_WITH="XMLHttpRequest", ) - self.assertEqual(response.status_code, 403) + self.assertEqual(response.status_code, 403) # noqa: PT009 @ddt.data(C4X_SIGNATORY_PATH, SIGNATORY_PATH) def test_delete_certificate_without_global_staff_permissions(self, signatory_path): @@ -667,7 +590,7 @@ def test_delete_certificate_without_global_staff_permissions(self, signatory_pat HTTP_ACCEPT="application/json", HTTP_X_REQUESTED_WITH="XMLHttpRequest", ) - self.assertEqual(response.status_code, 403) + self.assertEqual(response.status_code, 403) # noqa: PT009 @ddt.data(C4X_SIGNATORY_PATH, SIGNATORY_PATH) def test_update_active_certificate_without_global_staff_permissions(self, signatory_path): @@ -696,7 +619,7 @@ def test_update_active_certificate_without_global_staff_permissions(self, signat HTTP_ACCEPT="application/json", HTTP_X_REQUESTED_WITH="XMLHttpRequest", ) - self.assertEqual(response.status_code, 403) + self.assertEqual(response.status_code, 403) # noqa: PT009 def test_delete_non_existing_certificate(self): """ @@ -709,7 +632,7 @@ def test_delete_non_existing_certificate(self): HTTP_ACCEPT="application/json", HTTP_X_REQUESTED_WITH="XMLHttpRequest", ) - self.assertEqual(response.status_code, 404) + self.assertEqual(response.status_code, 404) # noqa: PT009 @ddt.data(C4X_SIGNATORY_PATH, SIGNATORY_PATH) def test_can_delete_signatory(self, signatory_path): @@ -721,7 +644,7 @@ def test_can_delete_signatory(self, signatory_path): signatory = certificates[1].get("signatories")[1] image_asset_location = AssetKey.from_string(signatory['signature_image_path']) content = contentstore().find(image_asset_location) - self.assertIsNotNone(content) + self.assertIsNotNone(content) # noqa: PT009 test_url = f'{self._url(cid=1)}/signatories/1' response = self.client.delete( test_url, @@ -729,14 +652,14 @@ def test_can_delete_signatory(self, signatory_path): HTTP_ACCEPT="application/json", HTTP_X_REQUESTED_WITH="XMLHttpRequest", ) - self.assertEqual(response.status_code, 204) + self.assertEqual(response.status_code, 204) # noqa: PT009 self.reload_course() # Verify that certificates are properly updated in the course. certificates = self.course.certificates['certificates'] - self.assertEqual(len(certificates[1].get("signatories")), 2) + self.assertEqual(len(certificates[1].get("signatories")), 2) # noqa: PT009 # make sure signatory signature image is deleted too - self.assertRaises(NotFoundError, contentstore().find, image_asset_location) + self.assertRaises(NotFoundError, contentstore().find, image_asset_location) # noqa: PT027 @ddt.data(C4X_SIGNATORY_PATH, SIGNATORY_PATH) def test_deleting_signatory_without_signature(self, signatory_path): @@ -751,7 +674,7 @@ def test_deleting_signatory_without_signature(self, signatory_path): HTTP_ACCEPT="application/json", HTTP_X_REQUESTED_WITH="XMLHttpRequest", ) - self.assertEqual(response.status_code, 204) + self.assertEqual(response.status_code, 204) # noqa: PT009 def test_delete_signatory_non_existing_certificate(self): """ @@ -765,7 +688,7 @@ def test_delete_signatory_non_existing_certificate(self): HTTP_ACCEPT="application/json", HTTP_X_REQUESTED_WITH="XMLHttpRequest", ) - self.assertEqual(response.status_code, 404) + self.assertEqual(response.status_code, 404) # noqa: PT009 @ddt.data(C4X_SIGNATORY_PATH, SIGNATORY_PATH) def test_certificate_activation_success(self, signatory_path): @@ -786,10 +709,10 @@ def test_certificate_activation_success(self, signatory_path): HTTP_ACCEPT="application/json", HTTP_X_REQUESTED_WITH="XMLHttpRequest" ) - self.assertEqual(response.status_code, 200) + self.assertEqual(response.status_code, 200) # noqa: PT009 course = self.store.get_course(self.course.id) certificates = course.certificates['certificates'] - self.assertEqual(certificates[0].get('is_active'), is_active) + self.assertEqual(certificates[0].get('is_active'), is_active) # noqa: PT009 cert_event_type = 'activated' if is_active else 'deactivated' self.assert_event_emitted( '.'.join(['edx.certificate.configuration', cert_event_type]), @@ -814,7 +737,7 @@ def test_certificate_activation_without_write_permissions(self, activate, signat HTTP_ACCEPT="application/json", HTTP_X_REQUESTED_WITH="XMLHttpRequest" ) - self.assertEqual(response.status_code, 403) + self.assertEqual(response.status_code, 403) # noqa: PT009 @ddt.data(C4X_SIGNATORY_PATH, SIGNATORY_PATH) def test_certificate_activation_failure(self, signatory_path): @@ -833,7 +756,7 @@ def test_certificate_activation_failure(self, signatory_path): HTTP_ACCEPT="application/json", HTTP_X_REQUESTED_WITH="XMLHttpRequest", ) - self.assertEqual(response.status_code, 403) + self.assertEqual(response.status_code, 403) # noqa: PT009 course = self.store.get_course(self.course.id) certificates = course.certificates['certificates'] - self.assertEqual(certificates[0].get('is_active'), False) + self.assertEqual(certificates[0].get('is_active'), False) # noqa: PT009 diff --git a/cms/djangoapps/contentstore/views/tests/test_clipboard_paste.py b/cms/djangoapps/contentstore/views/tests/test_clipboard_paste.py index 2ca03ccf892b..8bed7e6d1031 100644 --- a/cms/djangoapps/contentstore/views/tests/test_clipboard_paste.py +++ b/cms/djangoapps/contentstore/views/tests/test_clipboard_paste.py @@ -5,23 +5,24 @@ """ import ddt from opaque_keys.edx.keys import UsageKey -from rest_framework.test import APIClient +from openedx_content.api import signals as content_signals from openedx_events.content_authoring.signals import ( LIBRARY_BLOCK_DELETED, XBLOCK_CREATED, XBLOCK_DELETED, XBLOCK_UPDATED, ) -from openedx_events.tests.utils import OpenEdxEventsTestMixin -from openedx_tagging.core.tagging.models import Tag +from openedx_events.testing import OpenEdxEventsTestMixin +from openedx_tagging.models import Tag from organizations.models import Organization -from xmodule.modulestore.django import contentstore, modulestore -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase, upload_file_to_course, ImmediateOnCommitMixin -from xmodule.modulestore.tests.factories import BlockFactory, CourseFactory, ToyCourseFactory, LibraryFactory +from rest_framework.test import APIClient from cms.djangoapps.contentstore.utils import reverse_usage_url from openedx.core.djangoapps.content_libraries import api as library_api from openedx.core.djangoapps.content_tagging import api as tagging_api +from xmodule.modulestore.django import contentstore, modulestore +from xmodule.modulestore.tests.django_utils import ImmediateOnCommitMixin, ModuleStoreTestCase, upload_file_to_course +from xmodule.modulestore.tests.factories import BlockFactory, CourseFactory, LibraryFactory, ToyCourseFactory CLIPBOARD_ENDPOINT = "/api/content-staging/v1/clipboard/" XBLOCK_ENDPOINT = "/xblock/" @@ -405,6 +406,7 @@ class ClipboardPasteFromV2LibraryTestCase(OpenEdxEventsTestMixin, ImmediateOnCom Test Clipboard Paste functionality with a "new" (as of Sumac) library """ ENABLED_OPENEDX_EVENTS = [ + content_signals.ENTITIES_DRAFT_CHANGED.event_type, # Required for library events to work LIBRARY_BLOCK_DELETED.event_type, XBLOCK_CREATED.event_type, XBLOCK_DELETED.event_type, @@ -491,7 +493,8 @@ def test_paste_from_library_read_only_tags(self): assert object_tag.is_copied # If we delete the upstream library block... - library_api.delete_library_block(self.lib_block_key) + with self.captureOnCommitCallbacks(execute=True): # make event handlers fire now, within TestCase transaction + library_api.delete_library_block(self.lib_block_key) # ...the copied tags remain, but should no longer be marked as "copied" object_tags = tagging_api.get_object_tags(new_block_key) @@ -622,7 +625,7 @@ def setup_library(cls): Creates and returns a legacy content library with 1 problem """ library = LibraryFactory.create(display_name='Library') - lib_block = BlockFactory.create( + lib_block = BlockFactory.create( # noqa: F841 parent_location=library.usage_key, category="problem", display_name="MCQ", diff --git a/cms/djangoapps/contentstore/views/tests/test_container_page.py b/cms/djangoapps/contentstore/views/tests/test_container_page.py index e6b58257b69d..fbb14634820c 100644 --- a/cms/djangoapps/contentstore/views/tests/test_container_page.py +++ b/cms/djangoapps/contentstore/views/tests/test_container_page.py @@ -6,20 +6,23 @@ import datetime import re from unittest.mock import Mock, patch +from urllib.parse import quote from django.http import Http404 from django.test.client import RequestFactory from django.urls import reverse from edx_toggles.toggles.testutils import override_waffle_flag from pytz import UTC -from urllib.parse import quote import cms.djangoapps.contentstore.views.component as views from cms.djangoapps.contentstore import toggles from cms.djangoapps.contentstore.tests.test_libraries import LibraryTestCase -from xmodule.modulestore import ModuleStoreEnum # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory, BlockFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore import ModuleStoreEnum # pylint: disable=wrong-import-order +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order +from xmodule.modulestore.tests.factories import ( # pylint: disable=wrong-import-order + BlockFactory, + CourseFactory, +) from .utils import StudioPageTestCase @@ -66,7 +69,7 @@ def test_container_html(self): self._test_html_content( self.child_container, expected_section_tag=( - '
+ diff --git a/cms/templates/js/certificate-details.underscore b/cms/templates/js/certificate-details.underscore deleted file mode 100644 index a09a3baf897c..000000000000 --- a/cms/templates/js/certificate-details.underscore +++ /dev/null @@ -1,71 +0,0 @@ -
-
-

- <%- name %> -

-
- -
    - <% if (!_.isUndefined(id)) { %> -
  1. - <%- gettext('ID') %>: - <%- id %> -
    2. - <% } %> - <% if (showDetails) { %> -
    -
    -

    <%- gettext("Certificate Details") %>

    -
    -
    -
    -

    - <%- gettext('Course Title') %>: - <%- course.get('name') %> -

    - <% if (course_title) { %> -

    - <%- gettext('Course Title Override') %>: - <%- course_title %> -

    - <% } %> -
    - -
    -

    - <%- gettext('Course Number') %>: - <%- course.get('num') %> -

    - - <% if (course.get('display_course_number')) { %> -

    - <%- gettext('Course Number Override') %>: - <%- course.get('display_course_number') %> -

    - <% } %> -
    -
    -
    - - -
    -
    -

    <%- gettext("Certificate Signatories") %>

    -
    -

    <%- gettext("It is strongly recommended that you include four or fewer signatories. If you include additional signatories, preview the certificate in Print View to ensure the certificate will print correctly on one page.") %>

    -
    -
    - <% } %> -
- -
    - <% if (CMS.User.isGlobalStaff || !is_active) { %> -
  • - -
    • -
  • - -
    • - <% } %> -
-
diff --git a/cms/templates/js/certificate-editor.underscore b/cms/templates/js/certificate-editor.underscore deleted file mode 100644 index 513113b80500..000000000000 --- a/cms/templates/js/certificate-editor.underscore +++ /dev/null @@ -1,54 +0,0 @@ -
-
- <% if (error && error.message) { %> -
- <%- gettext(error.message) %> -
- <% } %> -
-
-
- <%- gettext("Certificate Information") %> -
- - " value="<%- name %>" aria-describedby="certificate-name-<%-uniqueId %>-tip" /> - <%- gettext("Name of the certificate") %> -
-
- - - <%- gettext("Description of the certificate") %> -
-
-

<%- gettext("Certificate Details") %>

-
-
- <%- gettext("Course Title") %>: - <%- course.get('name') %> -
-
- - " value="<%- course_title %>" aria-describedby="certificate-course-title-<%-uniqueId %>-tip" /> - <%- gettext("Specify an alternative to the official course title to display on certificates. Leave blank to use the official course title.") %> -
-
-
-

<%- gettext("Certificate Signatories") %>

-
-

<%- gettext("It is strongly recommended that you include four or fewer signatories. If you include additional signatories, preview the certificate in Print View to ensure the certificate will print correctly on one page.") %>

-
- - - <%- gettext("(Add signatories for a certificate)") %> - -
-
- - - <% if (!isNew && (CMS.User.isGlobalStaff || !is_active)) { %> - - <%- gettext("Delete") %> - - <% } %> -
-
diff --git a/cms/templates/js/certificate-web-preview.underscore b/cms/templates/js/certificate-web-preview.underscore deleted file mode 100644 index 566a1544f81d..000000000000 --- a/cms/templates/js/certificate-web-preview.underscore +++ /dev/null @@ -1,17 +0,0 @@ - - - class="button preview-certificate-link" rel="noopener" target="_blank"> - <%- gettext("Preview Certificate") %> - - diff --git a/cms/templates/js/content-group-editor.underscore b/cms/templates/js/content-group-editor.underscore deleted file mode 100644 index 038b725b84cc..000000000000 --- a/cms/templates/js/content-group-editor.underscore +++ /dev/null @@ -1,46 +0,0 @@ -
- <% if (error && error.message) { %> -
- <%- gettext(error.message) %> -
- <% } %> -
-
-
- <% - if (!_.isUndefined(id) && !_.isEmpty(id)) { - %> - <%- gettext('Content Group ID') %> - <%- id %> - <% - } - %> - "> -
-
- <% if (!_.isEmpty(usage)) { %> -
- -

- <%- gettext('This content group is used in one or more units.') %> -

-
- <% } %> -
-
- - - - <% if (!isNew) { %> - <% if (_.isEmpty(usage)) { %> - "> - <%- gettext("Delete") %> - - <% } else { %> - - <%- gettext("Delete") %> - - <% } %> - <% } %> -
-
diff --git a/cms/templates/js/course-instructor-details.underscore b/cms/templates/js/course-instructor-details.underscore deleted file mode 100644 index f437e6963c2f..000000000000 --- a/cms/templates/js/course-instructor-details.underscore +++ /dev/null @@ -1,43 +0,0 @@ -
  • -
    - - data-field="name" placeholder="<%- gettext('Instructor Name') %>" /> - <%- gettext("Please add the instructor's name")%> -
    - -
    - - data-field="title" placeholder="<%- gettext('Instructor Title') %>" /> - <%- gettext("Please add the instructor's title")%> -
    - -
    - - data-field="organization" placeholder="<%- gettext('Organization Name') %>" /> - <%- gettext("Please add the institute where the instructor is associated")%> -
    - -
    - - - <%- gettext("Please add the instructor's biography")%> -
    - -
    - - - <%- gettext('Instructor Photo') %> - -
    -
    - - <%- gettext("Please add a photo of the instructor (Note: only JPEG or PNG format supported)")%> -
    - -
    -
    - -
    - -
    -
    • diff --git a/cms/templates/js/course-settings-learning-fields.underscore b/cms/templates/js/course-settings-learning-fields.underscore deleted file mode 100644 index 86ea67983744..000000000000 --- a/cms/templates/js/course-settings-learning-fields.underscore +++ /dev/null @@ -1,5 +0,0 @@ -
    - - - -
    diff --git a/cms/templates/js/course-video-settings-update-org-credentials-footer.underscore b/cms/templates/js/course-video-settings-update-org-credentials-footer.underscore deleted file mode 100644 index 9de3376527ff..000000000000 --- a/cms/templates/js/course-video-settings-update-org-credentials-footer.underscore +++ /dev/null @@ -1,8 +0,0 @@ - - diff --git a/cms/templates/js/course-video-settings-update-settings-footer.underscore b/cms/templates/js/course-video-settings-update-settings-footer.underscore deleted file mode 100644 index 77fd90e9d9ef..000000000000 --- a/cms/templates/js/course-video-settings-update-settings-footer.underscore +++ /dev/null @@ -1,13 +0,0 @@ - - - -<%if (dateModified) { %> - <%- gettext('Last updated')%> <%- dateModified %> -<% } %> - diff --git a/cms/templates/js/course-video-settings.underscore b/cms/templates/js/course-video-settings.underscore deleted file mode 100644 index 80012a293a7e..000000000000 --- a/cms/templates/js/course-video-settings.underscore +++ /dev/null @@ -1,18 +0,0 @@ -
    -
    -
    - -
    -
    -
    -
    - <%- gettext('Course Video Settings') %> -
    -
    -
    -
    -
    diff --git a/cms/templates/js/course-video-transcript-preferences.underscore b/cms/templates/js/course-video-transcript-preferences.underscore deleted file mode 100644 index 3bad3dc5975a..000000000000 --- a/cms/templates/js/course-video-transcript-preferences.underscore +++ /dev/null @@ -1,31 +0,0 @@ -
    -
    - - - -
    -
    - - - -
    -
    - - - -
    -
    - <%- gettext('Transcript Languages') %> - -
    -
    -
    - -
    - -
    - -
    -
    -
    -
    diff --git a/cms/templates/js/course-video-transcript-provider-empty.underscore b/cms/templates/js/course-video-transcript-provider-empty.underscore deleted file mode 100644 index dc8335ea5cb8..000000000000 --- a/cms/templates/js/course-video-transcript-provider-empty.underscore +++ /dev/null @@ -1,7 +0,0 @@ - -
    - <% for (var i = 0; i < providers.length; i++) { %> - > - - <% } %> -
    diff --git a/cms/templates/js/course-video-transcript-provider-selected.underscore b/cms/templates/js/course-video-transcript-provider-selected.underscore deleted file mode 100644 index d5e9eee2691d..000000000000 --- a/cms/templates/js/course-video-transcript-provider-selected.underscore +++ /dev/null @@ -1,8 +0,0 @@ - -
    - <%- selectedProvider %> - -
    diff --git a/cms/templates/js/course_grade_cutoff.underscore b/cms/templates/js/course_grade_cutoff.underscore deleted file mode 100644 index 1a85dd30f721..000000000000 --- a/cms/templates/js/course_grade_cutoff.underscore +++ /dev/null @@ -1,5 +0,0 @@ -
  • - <%- descriptor %> - - <% if (removable) {%>remove<% ;} %> -
    • diff --git a/cms/templates/js/course_grade_policy.underscore b/cms/templates/js/course_grade_policy.underscore deleted file mode 100644 index a787978a5a03..000000000000 --- a/cms/templates/js/course_grade_policy.underscore +++ /dev/null @@ -1,82 +0,0 @@ -
  • -
    - - <% // xss-lint: disable=underscore-not-escaped %> - <%- gettext("The general category for this type of assignment, for example, Homework or Midterm Exam. This name is visible to learners.") %> -
    - -
    - - <% // xss-lint: disable=underscore-not-escaped %> - <%- gettext("This short name for the assignment type (for example, HW or Midterm) appears next to assignments on a learner's Progress page.") %> -
    - -
    - - <% // xss-lint: disable=underscore-not-escaped %> - <%- gettext("The weight of all assignments of this type as a percentage of the total grade, for example, 40. Do not include the percent symbol.") %> -
    - -
    - - <% // xss-lint: disable=underscore-not-escaped %> - <%- gettext("The number of subsections in the course that contain problems of this assignment type.") %> -
    - -
    - - <% // xss-lint: disable=underscore-not-escaped %> - <%- gettext("The number of assignments of this type that will be dropped. The lowest scoring assignments are dropped first.") %> -
    - - <% if (model.get('type') !== '') { %> - <% if (assignmentList.length !== model.get('min_count')){ %> -
    -
    - - <%- gettext("Warning: ") %> - <%- - edx.StringUtils.interpolate( - gettext("The number of {type} assignments defined here does not match the current number of {type} assignments in the course:"), - {type: model.get('type')}, - ) - %> -
    -
    - <% if (assignmentList.length == 0){ %> -
    <%- gettext("There are no assignments of this type in the course.") %>
    - <% } else { %> - <%- - edx.StringUtils.interpolate( - gettext("{assignment_count} {type} assignment(s) found:"), - { - assignment_count: assignmentList.length, - type: model.get('type') - }, - ) - %> -
      - <% _.each(assignmentList, function (qualifiedSubsectionName){ %> -
    1. <%- qualifiedSubsectionName %>
      2. - <% }) %> -
    - <% } %> -
    -
    - <% } else { %> -
    - - <%- - edx.StringUtils.interpolate( - gettext("The number of {type} assignments in the course matches the number defined here."), - {type: model.get('type')}, - ) - %> -
    - <% } %> - <% } %> - -
    - <%- gettext("Delete") %> -
    -
    • diff --git a/cms/templates/js/group-configuration-details.underscore b/cms/templates/js/group-configuration-details.underscore deleted file mode 100644 index f3fd77971827..000000000000 --- a/cms/templates/js/group-configuration-details.underscore +++ /dev/null @@ -1,95 +0,0 @@ -
    -
    -

    - - - <%- name %> - -

    -
    - -
      - <% if (!_.isUndefined(id)) { %> -
    1. <%- gettext('ID') %>: <%- id %>
      2. - <% } %> - <% if (showGroups) { %> -
    2. - <%- description %> -
      3. - <% } else { %> -
    3. - <%- groupsCountMessage %> -
      4. -
    4. - <%- usageCountMessage %> -
      5. - <% } %> -
    - - <% if(showGroups) { %> - <% allocation = Math.floor(100 / groups.length) %> -
      - <% groups.each(function(group, groupIndex) { %> -
    1. - <%- group.get('name') %> - <%- allocation %>% -
      2. - <% }) %> -
    - <% } %> -
      -
    • - -
      • - <% if (_.isEmpty(usage)) { %> -
    • - -
      • - <% } else { %> -
    • - -
      • - <% } %> -
    -
    -<% if(showGroups) { %> -
    - <% if (!_.isEmpty(usage)) { %> -

    <%- gettext('This Group Configuration is used in:') %>

    -
      - <% _.each(usage, function(unit) { %> -
    1. -

      ><%- unit.label %>

      - <% if (unit.validation) { %> -

      - <% if (unit.validation.type === 'warning') { %> - - <% } else if (unit.validation.type === 'error') { %> - - <% } %> - - <%- unit.validation.text %> - -

      - <% } %> -
      2. - <% }) %> -
    - <% } else { %> -

    - <%= HtmlUtils.interpolateHtml( - gettext('This Group Configuration is not in use. Start by adding a content experiment to any Unit via the {linkStart}Course Outline{linkEnd}.'), - { - linkStart: HtmlUtils.interpolateHtml( - HtmlUtils.HTML(''), - { courseOutlineUrl: courseOutlineUrl, courseOutlineTitle: gettext('Course Outline')}), - linkEnd: HtmlUtils.HTML('') - }) - %> -

    - <% } %> -
    -<% } %> diff --git a/cms/templates/js/group-configuration-editor.underscore b/cms/templates/js/group-configuration-editor.underscore deleted file mode 100644 index 12a3edfbe34d..000000000000 --- a/cms/templates/js/group-configuration-editor.underscore +++ /dev/null @@ -1,59 +0,0 @@ -
    - <% if (error && error.message) { %> -
    - <%- gettext(error.message) %> -
    - <% } %> -
    -
    - <%- gettext("Group Configuration information") %> -
    - <% - if (!_.isUndefined(id)) { - %> - <%- gettext('Group Configuration ID') %> - <%- id %> - <% - } - %> - " value="<%- name %>"> - <%- gettext("Name or short description of the configuration") %> -
    -
    - - - <%- gettext("Optional long description") %> -
    -
    -
    - <%- gettext("Group information") %> - - <%- gettext("Name of the groups that students will be assigned to, for example, Control, Video, Problems. You must have two or more groups.") %> -
      - -
      - <% if (!_.isEmpty(usage)) { %> -
      - -

      - <%- gettext('This configuration is currently used in content experiments. If you make changes to the groups, you may need to edit those experiments.') %> -

      -
      - <% } %> -
      -
      - - - <% if (!isNew) { %> - <% if (_.isEmpty(usage)) { %> - - <%- gettext("Delete") %> - - <% } else { %> - - <%- gettext("Delete") %> - - <% } %> - <% } %> -
      -
      diff --git a/cms/templates/js/group-edit.underscore b/cms/templates/js/group-edit.underscore deleted file mode 100644 index e2021df69972..000000000000 --- a/cms/templates/js/group-edit.underscore +++ /dev/null @@ -1,4 +0,0 @@ -
      -
      <%- allocation %>%
      - <%- gettext("delete group") %> diff --git a/cms/templates/js/mock/mock-group-configuration-page.underscore b/cms/templates/js/mock/mock-group-configuration-page.underscore deleted file mode 100644 index 62da5501d8eb..000000000000 --- a/cms/templates/js/mock/mock-group-configuration-page.underscore +++ /dev/null @@ -1,28 +0,0 @@ -
      -
      -
      -

      - Settings - > Group Configurations" -

      -
      -
      - -
      -
      -
      -
      -
      -

      Loading

      -
      -
      -
      -
      -

      Loading

      -
      -
      -
      - -
      -
      -
      diff --git a/cms/templates/js/partition-group-details.underscore b/cms/templates/js/partition-group-details.underscore deleted file mode 100644 index e2d228bce904..000000000000 --- a/cms/templates/js/partition-group-details.underscore +++ /dev/null @@ -1,73 +0,0 @@ -
      -
      -

      - - - <%- name %> - -

      -
      - -
        - <% if (!_.isUndefined(id)) { %> -
      1. <%- gettext('ID') %>: <%- id %>
        2. - <% } %> - <% if (!showContentGroupUsages) { %> -
      2. - <%- usageCountMessage %> -
        3. - <% } %> -
      - -
        - <% if (!restrictEditing) { %> -
      • - -
        • - <% if (_.isEmpty(usage)) { %> -
      • - -
        • - <% } else { %> -
      • - -
        • - <% } %> - <% } %> -
      -
      - -<% if (showContentGroupUsages) { %> -
      - <% if (!_.isEmpty(usage)) { %> -

      - <%- gettext('This group controls access to:') %> -

      -
        - <% _.each(usage, function(unit) { %> -
      1. -

        ><%- unit.label %>

        -
        2. - <% }) %> -
      - <% } else { %> -

      - <%= HtmlUtils.interpolateHtml( - gettext("In the {linkStart}Course Outline{linkEnd}, use this group to control access to a component."), - { - linkStart: HtmlUtils.interpolateHtml( - HtmlUtils.HTML(''), - {courseOutlineUrl: courseOutlineUrl, courseOutlineTitle: gettext('Course Outline')} - ), - linkEnd: HtmlUtils.HTML('') - } - ) - %> - -

      - <% } %> -
      -<% } %> diff --git a/cms/templates/js/previous-video-upload-list.underscore b/cms/templates/js/previous-video-upload-list.underscore deleted file mode 100644 index 5adb3e211984..000000000000 --- a/cms/templates/js/previous-video-upload-list.underscore +++ /dev/null @@ -1,24 +0,0 @@ -
      -

      <%- gettext("Previous Uploads") %>

      -
      - - <%- gettext("Download available encodings (.csv)") %> - -
      -
      -
      -
      - <% if (videoImageUploadEnabled) { %> -
      <%- gettext("Thumbnail") %>
      - <% } %> -
      <%- gettext("Name") %>
      -
      <%- gettext("Date Added") %>
      -
      <%- gettext("Video ID") %>
      -
      <%- gettext("Transcripts") %>
      -
      <%- gettext("Video Status") %>
      -
      <%- gettext("Action") %>
      -
      -
      -
      -
      -
      diff --git a/cms/templates/js/previous-video-upload.underscore b/cms/templates/js/previous-video-upload.underscore deleted file mode 100644 index a4cd993235a3..000000000000 --- a/cms/templates/js/previous-video-upload.underscore +++ /dev/null @@ -1,20 +0,0 @@ -
      - <% if (videoImageUploadEnabled) { %> -
      - <% } %> -
      <%- client_video_id %>
      -
      <%- created %>
      -
      <%- edx_video_id %>
      -
      -
      -
      - -
      -
      diff --git a/cms/templates/js/signatory-actions.underscore b/cms/templates/js/signatory-actions.underscore deleted file mode 100644 index 08c65d0ce103..000000000000 --- a/cms/templates/js/signatory-actions.underscore +++ /dev/null @@ -1,6 +0,0 @@ -
      -
      - - -
      -
      diff --git a/cms/templates/js/signatory-details.underscore b/cms/templates/js/signatory-details.underscore deleted file mode 100644 index 92ed4f9bc6d1..000000000000 --- a/cms/templates/js/signatory-details.underscore +++ /dev/null @@ -1,33 +0,0 @@ -
      - <% if (CMS.User.isGlobalStaff || !certificate.get('is_active')) { %> -
      - - <%- gettext("Edit") %> - -
      - <% } %> -
      <%- gettext("Signatory") %> <%- signatory_number %> 
      -
      -
      -
      - <%- gettext("Name") %>:  - <%- name %> -
      -
      - <%- gettext("Title") %>:  - <%= _.escape(title).replace(new RegExp('\r?\n','g'), '
      ') %>       -
      -
      - <%- gettext("Organization") %>:  - <%- organization %> -
      -
      -
      - <% if (signature_image_path != "") { %> -
      - <%- gettext('Signature Image') %> -
      - <% } %> -
      -
      -
      diff --git a/cms/templates/js/signatory-editor.underscore b/cms/templates/js/signatory-editor.underscore deleted file mode 100644 index e26525108340..000000000000 --- a/cms/templates/js/signatory-editor.underscore +++ /dev/null @@ -1,51 +0,0 @@ -
      - <% if (is_editing_all_collections && signatories_count > 1 && (total_saved_signatories > 1 || isNew) ) { %> - - - <%- gettext("Delete") %> - - <% } %> -
      <%- gettext("Signatory") %> <%- signatory_number %>
      -
      -
      - <%- gettext("Certificate Signatory Configuration") %> -
      - - " value="<%- name %>" aria-describedby="signatory-name-<%- signatory_number %>-tip" /> - <%- gettext("The name of this signatory as it should appear on certificates.") %> - <% if(error && error.name) { %> - <%- error.name %> - <% } %> -
      -
      - - - <%- gettext("Titles more than 100 characters may prevent students from printing their certificate on a single page.") %> - <% if(error && error.title) { %> - <%- error.title %> - <% } %> -
      -
      - - " value="<%- organization %>" aria-describedby="signatory-organization-<%- signatory_number %>-tip" /> - <%- gettext("The organization that this signatory belongs to, as it should appear on certificates.") %> - <% if(error && error.organization) { %> - <%- error.organization %> - <% } %> -
      -
      - - <% if (signature_image_path != "") { %> -
      Signature Image
      - <% } %> -
      -
      - " value="<%- signature_image_path %>" aria-describedby="signatory-signature-<%- signatory_number %>-tip" readonly /> - <%- gettext("Image must be in PNG format") %> -
      - -
      -
      -
      -
      -
      diff --git a/cms/templates/js/validation-error-modal.underscore b/cms/templates/js/validation-error-modal.underscore deleted file mode 100644 index ca661f4fcf75..000000000000 --- a/cms/templates/js/validation-error-modal.underscore +++ /dev/null @@ -1,34 +0,0 @@ -
      -
      -

      - <%= _.template( // xss-lint: disable=underscore-not-escaped - ngettext( - "There was {strong_start}{num_errors} validation error{strong_end} while trying to save the course settings in the database.", - "There were {strong_start}{num_errors} validation errors{strong_end} while trying to save the course settings in the database.", - num_errors - ), - {interpolate: /\{(.+?)\}/g})( - { - strong_start:'', - num_errors: num_errors, - strong_end: '' - })%> - <%- gettext("Please check the following validation feedbacks and reflect them in your course settings:")%>

      -
      - -
      - -
        - <% _.each(response, function(value, index, list) { %> - -
      • - - - <%- value.model.display_name %>: - - -
        • - - <% }); %> -
      -
      diff --git a/cms/templates/js/video-status.underscore b/cms/templates/js/video-status.underscore deleted file mode 100644 index e2a24faf1d78..000000000000 --- a/cms/templates/js/video-status.underscore +++ /dev/null @@ -1,5 +0,0 @@ -<%- status %> -<% if (show_error && error_description) { %> -
      - <%- error_description %> -<% }%> diff --git a/cms/templates/js/video-thumbnail-error.underscore b/cms/templates/js/video-thumbnail-error.underscore deleted file mode 100644 index 4f7c7c4d2ed4..000000000000 --- a/cms/templates/js/video-thumbnail-error.underscore +++ /dev/null @@ -1,4 +0,0 @@ -
      - - <%- errorText %> -
      diff --git a/cms/templates/js/video-thumbnail.underscore b/cms/templates/js/video-thumbnail.underscore deleted file mode 100644 index 1d6538668985..000000000000 --- a/cms/templates/js/video-thumbnail.underscore +++ /dev/null @@ -1,28 +0,0 @@ -
      - <%- imageAltText %> -
      - - - - - <%- edx.StringUtils.interpolate( - gettext("Recommended image resolution is {imageResolution}, maximum image file size should be {maxFileSize} and format must be one of {supportedImageFormats}."), - {imageResolution: videoImageResolution, maxFileSize: videoImageMaxSize.humanize, supportedImageFormats: videoImageSupportedFileFormats.humanize} - ) %> - -
      - <% if(duration) { %> -
      - <%- duration.humanize %> - -
      - <% } %> -
      diff --git a/cms/templates/js/video-transcript-upload-status.underscore b/cms/templates/js/video-transcript-upload-status.underscore deleted file mode 100644 index 3c3566462582..000000000000 --- a/cms/templates/js/video-transcript-upload-status.underscore +++ /dev/null @@ -1,5 +0,0 @@ - -<%- shortMessage %> - diff --git a/cms/templates/js/video-transcripts.underscore b/cms/templates/js/video-transcripts.underscore deleted file mode 100644 index 290291db4979..000000000000 --- a/cms/templates/js/video-transcripts.underscore +++ /dev/null @@ -1,52 +0,0 @@ -
      -<% if (transcription_status) { %> - <%- transcription_status %> - <% if (error_description) { %> -
      - <%- error_description %> - <% }%> -<% } else if (!transcripts.length){ %> - <%- gettext('No transcript uploaded.') %> -<% }%> -
      -<% if (transcripts.length) { %> - -<% }%> -
      -<% _.each(transcripts, function(transcriptLanguageCode){ %> - <% selectedLanguageCodes = _.keys(_.omit(transcripts, transcriptLanguageCode)); %> -
      -
      - <%- StringUtils.interpolate(gettext('{transcriptClientTitle}_{transcriptLanguageCode}.{fileExtension}'), {transcriptClientTitle: transcriptClientTitle, transcriptLanguageCode: transcriptLanguageCode, fileExtension: transcriptFileFormat}) %> - - -
      - - <%- gettext('Download') %> - - | - - | - -
      -
      -<% }) %> -
      -
      diff --git a/cms/templates/library-block-author-preview-header.html b/cms/templates/library-block-author-preview-header.html index c6ebb4e6214c..f32498053ccf 100644 --- a/cms/templates/library-block-author-preview-header.html +++ b/cms/templates/library-block-author-preview-header.html @@ -1,6 +1,34 @@ <%page expression_filter="h"/> -<%! from django.utils.translation import ngettext %> +<%! +from django.utils.translation import ngettext, gettext as _ +from cms.djangoapps.contentstore.utils import get_libraries_list_url + +libraries_list_url = get_libraries_list_url() +%>
      +

      diff --git a/cms/templates/library.html b/cms/templates/library.html index 57d0363dad9e..0e16beec2881 100644 --- a/cms/templates/library.html +++ b/cms/templates/library.html @@ -5,6 +5,7 @@ <%! from cms.djangoapps.contentstore.helpers import xblock_studio_url, xblock_type_display_name +from cms.djangoapps.contentstore.utils import get_libraries_list_url from django.utils.translation import gettext as _ from openedx.core.djangolib.js_utils import dump_js_escaped_json from openedx.core.djangolib.markup import HTML, Text @@ -41,7 +42,7 @@ <%block name="content"> - +<% libraries_list_url = get_libraries_list_url() %>

      @@ -77,6 +78,29 @@

      ${_("Page Actions")}

      +
      diff --git a/cms/templates/manage_users.html b/cms/templates/manage_users.html deleted file mode 100644 index 5da57980a459..000000000000 --- a/cms/templates/manage_users.html +++ /dev/null @@ -1,131 +0,0 @@ -## xss-lint: disable=mako-missing-default -<%inherit file="base.html" /> -<%! -from django.utils.translation import gettext as _ -from django.urls import reverse - -from openedx.core.djangolib.js_utils import ( - dump_js_escaped_json, js_escaped_string -) -%> -<%def name="online_help_token()"><% return "team_course" %> -<%block name="title">${_("Course Team Settings")} -<%block name="bodyclass">is-signedin course users view-team -<%namespace name='static' file='static_content.html'/> - -<%block name="header_extras"> - - - -<%block name="content"> - -
      -
      -

      - ${_("Settings")} - > ${_("Course Team")} -

      - - -
      -
      - -
      -
      -
      - %if allow_actions: -
      -
      -
      -

      ${_("Add a User to Your Course's Team")}

      - -
      - ${_("New Team Member Information")} - -
        -
      1. - - - ${_("Provide the email address of the user you want to add as Staff")} -
        2. -
      -
      -
      - -
      - - -
      -
      -
      - %endif - -
        -
        -

        ${_('Loading')}

        -
        -
      - - % if allow_actions and len(users) == 1: -
      -
      -

      ${_('Add Team Members to This Course')}

      -
      -

      ${_('Adding team members makes course authoring collaborative. Users must be signed up for {studio_name} and have an active account.').format(studio_name=settings.STUDIO_SHORT_NAME)}

      -
      -
      - - -
      - %endif -
      - - -
      -
      - - -<%block name="requirejs"> - require(["js/factories/manage_users"], function(ManageCourseUsersFactory) { - ManageCourseUsersFactory( - // xss-lint: disable=mako-invalid-js-filter - "${context_course.display_name_with_default | h}", - ${users | n, dump_js_escaped_json}, - // xss-lint: disable=mako-invalid-js-filter - "${reverse('course_team_handler', kwargs={'course_key_string': str(context_course.id), 'email': '@@EMAIL@@'}) | n, js_escaped_string}", - ${request.user.id | n, dump_js_escaped_json}, - ${allow_actions | n, dump_js_escaped_json} - ); - }); - diff --git a/cms/templates/settings.html b/cms/templates/settings.html deleted file mode 100644 index df64bcc39361..000000000000 --- a/cms/templates/settings.html +++ /dev/null @@ -1,723 +0,0 @@ -<%page expression_filter="h"/> -<%inherit file="base.html" /> -<%def name="online_help_token()"><% return "schedule" %> -<%block name="title">${_("Schedule & Details Settings")} -<%block name="bodyclass">is-signedin course schedule view-settings feature-upload - -<%namespace name='static' file='static_content.html'/> -<%! - from django.utils.translation import gettext as _ - from common.djangoapps.student.auth import has_studio_advanced_settings_access - from cms.djangoapps.contentstore import utils - from lms.djangoapps.certificates.api import can_show_certificate_available_date_field - from openedx.core.djangolib.js_utils import ( - dump_js_escaped_json, js_escaped_string - ) - from openedx.core.djangolib.markup import HTML, Text - from six.moves.urllib.parse import quote - from six.moves.urllib import parse as urllib -%> - -<%block name="header_extras"> -% for template_name in ["basic-modal", "modal-button", "upload-dialog", "license-selector", "course-settings-learning-fields", "course-instructor-details"]: - -% endfor - - -<%block name="jsextra"> - - - - - -<%block name="requirejs"> - require(["js/factories/settings"], function(SettingsFactory) { - SettingsFactory( - "${details_url | n, js_escaped_string}", - ${show_min_grade_warning | n, dump_js_escaped_json}, - ${can_show_certificate_available_date_field(context_course) | n, dump_js_escaped_json}, - "${upgrade_deadline | n, js_escaped_string}", - ); - }); - - -<%block name="content"> -
      -
      -

      - ${_("Settings")} - > ${_("Schedule & Details")} -

      -
      -
      - -
      -
      -
      -
      -
      -
      -

      ${_("Basic Information")}

      - ${_("The nuts and bolts of your course")} -
      - -
        -
      1. - - -
        2. - -
      2. - - -
        3. - -
      3. - - -
        4. -
      - - % if not marketing_enabled: -
      -

      ${_("Course Summary Page")} ${_("(for student enrollment and access)")}

      -
      - <% - link_for_about_page = lms_link_for_about_page - %> -

      ${link_for_about_page}

      -
      - -
        -
      • - <% - email_subject = urllib.quote(_("Enroll in {course_display_name}").format( - course_display_name = context_course.display_name_with_default - ).encode("utf-8")) - email_body = urllib.quote(_('The course "{course_display_name}", provided by {platform_name}, is open for enrollment. Please navigate to this course at {link_for_about_page} to enroll.').format( - course_display_name = context_course.display_name_with_default, - platform_name = settings.PLATFORM_NAME, - link_for_about_page = link_for_about_page - ).encode("utf-8")) - %> - - ${_("Invite your students")} -
        • -
      -
      - % endif - - % if marketing_enabled: -
      -

      ${_("Promoting Your Course with {platform_name}").format(platform_name=settings.PLATFORM_NAME)}

      -
      -

      ${_( - 'Your course summary page will not be viewable until your course ' - 'has been announced. To provide content for the page and preview ' - 'it, follow the instructions provided by your Program Manager.')} - ${_( - 'Please note that changes here may take up to a business day to ' - 'appear on your course summary page.')} -

      -
      -
      - % endif -
      -
      - - % if credit_eligibility_enabled and is_credit_course: -
      -
      -

      ${_("Course Credit Requirements")}

      - ${_("Steps required to earn course credit")} -
      - A requirement appears in this list when you publish the unit that contains the requirement. - - % if credit_requirements: -
        - % if 'grade' in credit_requirements: -
      1. - - % for requirement in credit_requirements['grade']: - - - % endfor -
        2. - % endif - - % if 'proctored_exam' in credit_requirements: -
      2. - - % for requirement in credit_requirements['proctored_exam']: - - - % endfor -
        3. - % endif - - % if 'reverification' in credit_requirements: -
      3. - - % for requirement in credit_requirements['reverification']: - - - % endfor -
        4. - % endif -
      - % else: -

      No credit requirements found.

      - % endif -
      -
      - % endif - -
      -
      - -
      -

      ${_("Course Pacing")}

      - ${_("Set the pacing for this course")} -
      -       - - -
        -
      1. - - - ${_("Instructor-paced courses progress at the pace that the course author sets. You can configure release dates for course content and due dates for assignments.")} -
        2. -
      2. - - - ${_("Self-paced courses offer suggested due dates for assignments or exams based on the learner’s enrollment date and the expected course duration. These courses offer learners flexibility to modify the assignment dates as needed.")} -
        3. -
      -
      -
      - -
      - -
      -
      -

      ${_('Course Schedule')}

      - ${_('Dates that control when your course can be viewed')} -
      - -
        -
      1. -
        - - - - ${_("First day the course begins")} -
        - -
        - - - ${_("(UTC)")} -
        -
        2. - -
      2. -
        - - - - ${_("Last day your course is active")} -
        - -
        - - - ${_("(UTC)")} -
        -
        3. -
      - - % if can_show_certificate_available_date_field(context_course): -
        -
      1. -
        - - - ${_("Certificates are awarded at the end of a course run")} - - -
        - - -
        -
        - - -
        2. -
      - % endif - -
        -
      1. -
        - - - - ${_("First day students can enroll")} -
        - -
        - - - ${_("(UTC)")} -
        -
        2. - <% - enrollment_end_readonly = HTML("readonly aria-readonly=\"true\"") if not enrollment_end_editable else "" - enrollment_end_editable_class = "is-not-editable" if not enrollment_end_editable else "" - %> -
      2. -
        - - - - - ${_("Last day students can enroll.")} - % if not enrollment_end_editable: - ${_("Contact your {platform_name} partner manager to update these settings.").format(platform_name=settings.PLATFORM_NAME)} - % endif - -
        - -
        - - - ${_("(UTC)")} -
        -
        3. -
      - - % if upgrade_deadline: -
        -
      1. -
        - - - - ${_("Last day students can upgrade to a verified enrollment.")} - ${_("Contact your {platform_name} partner manager to update these settings.").format(platform_name=settings.PLATFORM_NAME)} - -
        - -
        - - - ${_("(UTC)")} -
        -
        2. -
      - % endif -
      - - % if about_page_editable: -
      -
      -

      ${_('Course Details')}

      - ${_('Provide useful information about your course')} -
      -
        -
      1. - - - ${_("Identify the course language here. This is used to assist users find courses that are taught in a specific language. It is also used to localize the 'From:' field in bulk emails.")} -
        2. -
      -
      - % endif - -
      -
      - - % if about_page_editable: -
      -

      ${_("Introducing Your Course")}

      - ${_("Information for prospective students")} -
      - % endif - -
        - - % if enable_extended_course_details: -
      1. - - - ${_("Displayed as title on the course details page. Limit to 50 characters.")} -
        2. -
      2. - - - ${_("Displayed as subtitle on the course details page. Limit to 150 characters.")} -
        3. -
      3. - - - ${_("Displayed on the course details page. Limit to 50 characters.")} -
        4. -
      4. - - - ${_("Displayed on the course details page. Limit to 1000 characters.")} -
        5. - % endif - - % if short_description_editable: -
      5. - - - ${_("Appears on the course catalog page when students roll over the course name. Limit to ~150 characters")} -
        6. - % endif - - % if about_page_editable: -
      6. - - - - ${ - Text(_("Introductions, prerequisites, FAQs that are used on {a_link_start}your course summary page{a_link_end} (formatted in HTML)")).format( - a_link_start=HTML("").format(lms_link_for_about_page=lms_link_for_about_page), - a_link_end=HTML("") - )} -
        7. - % if sidebar_html_enabled: -
      7. - - ${ - Text(_("Custom sidebar content for {a_link_start}your course summary page{a_link_end} (formatted in HTML)")).format( - a_link_start=HTML("").format(lms_link_for_about_page=lms_link_for_about_page), - a_link_end=HTML("") - )} -
        8. - % endif - % endif - - % if about_page_editable: -
      8. - -
        - % if context_course.course_image: - - ${_('Course Card Image')} - - - - ${Text(_("You can manage this image along with all of your other {a_link_start}files and uploads{a_link_end}")).format( - a_link_start=HTML("").format(upload_asset_url=upload_asset_url), - a_link_end=HTML("") - )} - - - % else: - - ${_('Course Card Image')} - - ${_("Your course currently does not have an image. Please upload one (JPEG or PNG format, and minimum suggested dimensions are 375px wide by 200px tall)")} - % endif -
        - -
        -
        - ## Translators: This is the placeholder text for a field that requests the URL for a course image - - ${_("Please provide a valid path and name to your course image (Note: only JPEG or PNG format supported)")} -
        - -
        -
        9. - % endif - - % if enable_extended_course_details: -
      9. - -
        - % if context_course.banner_image: - - - - - - ${Text(_("You can manage this image along with all of your other {a_link_start}files and uploads{a_link_end}")).format( - a_link_start=HTML("").format(upload_asset_url=upload_asset_url), - a_link_end=HTML("") - )} - - - % else: - - - - ${_("Your course currently does not have an image. Please upload one (JPEG or PNG format, and minimum suggested dimensions are 1440px wide by 400px tall)")} - % endif -
        - -
        -
        - ## Translators: This is the placeholder text for a field that requests the URL for a course banner image - - ${_("Please provide a valid path and name to your banner image (Note: only JPEG or PNG format supported)")} -
        - -
        -
        10. - -
      10. - -
        - % if context_course.video_thumbnail_image: - - ${_('Video Thumbnail Image')} - - - - ${Text(_("You can manage this image along with all of your other {a_link_start}files and uploads{a_link_end}")).format( - a_link_start=HTML("").format(upload_asset_url=upload_asset_url), - a_link_end=HTML("") - )} - - - % else: - - ${_('Video Thumbnail Image')} - - ${_("Your course currently does not have a video thumbnail image. Please upload one (JPEG or PNG format, and minimum suggested dimensions are 375px wide by 200px tall)")} - % endif -
        - -
        -
        - ## Translators: This is the placeholder text for a field that requests the URL for a course video thumbnail image - - ${_("Please provide a valid path and name to your video thumbnail image (Note: only JPEG or PNG format supported)")} -
        - -
        -
        11. - % endif - - % if about_page_editable: -
      11. - -
        -
        - -
        -
        - ${_("Delete Current Video")} -
        -
        - -
        - ## Translators: This is the placeholder text for a field that requests a YouTube video ID for a course video - - ${_("Enter your YouTube video's ID (along with any restriction parameters)")} -
        -
        12. - % endif -
      -
      - - % if enable_extended_course_details: -
      -
      -
      -

      ${_("Learning Outcomes")}

      - ${_("Add the learning outcomes for this course")} -
      -
        -
      1. -
      -
      - -
      -
      - -
      -
      -
      -

      ${_("Instructors")}

      - ${_("Add details about the instructors for this course")} -
      -
        -
      1. -
      -
      - -
      -
      - % endif - - % if about_page_editable or is_prerequisite_courses_enabled or is_entrance_exams_enabled: -
      - -
      -
      -

      ${_("Requirements")}

      - ${_("Expectations of the students taking this course")} -
      - -
        - % if about_page_editable: -
      1. - - - ${_("Time spent on all course work")} -
        2. - % endif - % if is_prerequisite_courses_enabled: -
      2. - - - ${_("Course that students must complete before beginning this course")} - -
        3. - % endif - % if is_entrance_exams_enabled: -
      3. -

        ${_("Entrance Exam")}

        -
        -
        - - -
        - -
        -
        4. - % endif -
      -
      - % endif - - % if settings.FEATURES.get("LICENSING", False): -
      - -
      -
      -

      ${_("Course Content License")}

      - ## Translators: At the course settings, the editor is able to select the default course content license. - ## The course content will have this license set, some assets can override the license with their own. - ## In the form, the license selector for course content is described using the following string: - ${_("Select the default license for course content")} -
      - -
        -
      1. -
        -
        2. -
      -
      - % endif -
      -
      - -
      -
      - diff --git a/cms/templates/settings_advanced.html b/cms/templates/settings_advanced.html deleted file mode 100644 index 3eccb3528d94..000000000000 --- a/cms/templates/settings_advanced.html +++ /dev/null @@ -1,160 +0,0 @@ -<%page expression_filter="h"/> -<%inherit file="base.html" /> -<%def name="online_help_token()"><% return "advanced" %> -<%namespace name='static' file='static_content.html'/> -<%! - from six.moves.urllib.parse import quote - from django.utils.translation import gettext as _ - from cms.djangoapps.contentstore import utils - from openedx.core.djangolib.js_utils import ( - dump_js_escaped_json, js_escaped_string - ) - from openedx.core.djangolib.markup import HTML, Text -%> -<%block name="title">${_("Advanced Settings")} -<%block name="bodyclass">is-signedin course advanced view-settings - -<%block name="header_extras"> -% for template_name in ["advanced_entry", "basic-modal", "modal-button", "validation-error-modal"]: - -% endfor - - -<%block name="requirejs"> - require(["js/factories/settings_advanced"], function(SettingsAdvancedFactory) { - SettingsAdvancedFactory( - ${advanced_dict | n, dump_js_escaped_json}, - "${advanced_settings_url | n, js_escaped_string}", - ${publisher_enabled | n, dump_js_escaped_json} - ); - }); - - -<%block name="page_alert"> - %if proctoring_errors: -
      -
      - - -
      -

      ${_("This course has proctored exam settings that are incomplete or invalid.")}

      -

      - % if mfe_proctored_exam_settings_url: - <% url_encoded_course_id = quote(str(context_course.id).encode('utf-8'), safe='') %> - ${Text(_("You will be unable to make changes until the errors are resolved. To update these settings go to the {link_start}Proctored Exam Settings page{link_end}.")).format( - link_start=HTML('').format( - mfe_proctored_exam_settings_url=mfe_proctored_exam_settings_url - ), - link_end=HTML("") - )} - % else: - ${_("You will be unable to make changes until the following settings are updated on the page below.")} - % endif -

      -
      - -
      -
      -
      -
      - %endif - - -<%block name="content"> -
      -
      -

      - ${_("Settings")} - > ${_("Advanced Settings")} -

      -
      -
      - -
      -
      -
      -
      - -
      - ${_("Your policy changes have been saved.")} -
      - -
      - ${_("There was an error saving your information. Please see below.")} -
      - -
      -
      -

      ${_("Manual Policy Definition")}

      - -
      - -

      ${Text(_("{strong_start}Warning{strong_end}: Do not modify these policies unless you are familiar with their purpose.")).format( - strong_start=HTML(''), - strong_end=HTML('') - )}

      - -
      -
      - - -
      -
      - -
        - -
      -
      -
      -
      - - -
      -
      - diff --git a/cms/templates/settings_graders.html b/cms/templates/settings_graders.html deleted file mode 100644 index eb0a057b046e..000000000000 --- a/cms/templates/settings_graders.html +++ /dev/null @@ -1,185 +0,0 @@ -<%page expression_filter="h"/> -<%inherit file="base.html" /> -<%def name="online_help_token()"><% return "grading" %> -<%block name="title">${_("Grading Settings")} -<%block name="bodyclass">is-signedin course grading view-settings - -<%namespace name='static' file='static_content.html'/> -<%! - from six.moves.urllib.parse import quote - import json - from cms.djangoapps.contentstore import utils - from django.utils.translation import gettext as _ - from common.djangoapps.student.auth import has_studio_advanced_settings_access - from cms.djangoapps.models.settings.encoder import CourseSettingsEncoder - from openedx.core.djangolib.js_utils import ( - dump_js_escaped_json, js_escaped_string - ) -%> - -<%block name="header_extras"> -% for template_name in ["course_grade_policy", "course_grade_cutoff"]: - -% endfor - - -<%block name="jsextra"> - - -<%block name="requirejs"> - require(["js/factories/settings_graders"], function(SettingsGradersFactory) { - SettingsGradersFactory( - _.extend( - ${dump_js_escaped_json(course_details, cls=CourseSettingsEncoder) | n, decode.utf8}, - { is_credit_course: ${is_credit_course | n, dump_js_escaped_json} } - ), - "${grading_url | n, js_escaped_string}", - ${course_assignment_lists | n, dump_js_escaped_json}, - ${default_grade_designations | n, dump_js_escaped_json}, - ); - }); - - -<%block name="content"> -
      -
      -

      - ${_("Settings")} - > ${_("Grading")} -

      -
      -
      - -
      -
      -
      -
      -
      -
      -

      ${_("Overall Grade Range")}

      - ${_("Your overall grading scale for student final grades")} -
      - -
        -
      1. -
        - ${_("Add grade")} -
        -
        -
          -
        1. 0
          2. -
        2. 10
          3. -
        3. 20
          4. -
        4. 30
          5. -
        5. 40
          6. -
        6. 50
          7. -
        7. 60
          8. -
        8. 70
          9. -
        9. 80
          10. -
        10. 90
          11. -
        11. 100
          12. -
        -
          -
        -
        -
        -
        -
        2. -
      -
      -
      - - % if settings.FEATURES.get("ENABLE_CREDIT_ELIGIBILITY", False) and is_credit_course: -
      -
      -

      ${_("Credit Eligibility")}

      - ${_("Settings for course credit eligibility")} -
      - -
        -
      1. - - - % - ${_("Must be greater than or equal to the course passing grade")} -
        2. -
      -
      -
      - % endif - -
      -
      -

      ${_("Grading Rules & Policies")}

      - ${_("Deadlines, requirements, and logistics around grading student work")} -
      - -
        -
      1. - - - ${_("Leeway on due dates")} -
        2. -
      -
      -
      - -
      -
      -

      ${_("Assignment Types")}

      - ${_("Categories and labels for any exercises that are gradable")} -
      - -
        - -
      - -
      - - ${_("New Assignment Type")} - -
      -
      -
      -
      - - -
      -
      - diff --git a/cms/templates/studio_xblock_wrapper.html b/cms/templates/studio_xblock_wrapper.html index ae786f9ca1b6..e05bee6017bc 100644 --- a/cms/templates/studio_xblock_wrapper.html +++ b/cms/templates/studio_xblock_wrapper.html @@ -1,19 +1,19 @@ <%page expression_filter="h"/> <%! from django.utils.translation import gettext as _ -from openedx.core.djangolib.markup import Text +from openedx.core.djangolib.markup import HTML, Text from cms.djangoapps.contentstore.helpers import xblock_studio_url from cms.djangoapps.contentstore.utils import is_visible_to_specific_partition_groups, get_editor_page_base_url, determine_label from lms.lib.utils import is_unit from openedx.core.djangolib.js_utils import ( dump_js_escaped_json, js_escaped_string ) -from cms.djangoapps.contentstore.toggles import use_new_video_editor, use_video_gallery_flow +from cms.djangoapps.contentstore.toggles import use_new_pdf_editor, use_video_gallery_flow from cms.lib.xblock.upstream_sync import UpstreamLink from openedx.core.djangoapps.content_tagging.toggles import is_tagging_feature_disabled %> <% -use_new_editor_video = use_new_video_editor(xblock.context_key) +use_new_editor_pdf = use_new_pdf_editor() use_new_video_gallery_flow = use_video_gallery_flow() use_tagging = not is_tagging_feature_disabled() xblock_url = xblock_studio_url(xblock) @@ -25,7 +25,7 @@ block_is_unit = is_unit(xblock) upstream_info = UpstreamLink.try_get_for_block(xblock, log_error=False) -can_unlink = upstream_info.upstream_ref and not upstream_info.has_top_level_parent +can_unlink = upstream_info.upstream_ref and not upstream_info.top_level_parent_key %> <%namespace name='static' file='static_content.html'/> @@ -82,7 +82,7 @@ is-collapsed % endif " - use-new-editor-video = ${use_new_editor_video} + use-new-editor-pdf = ${use_new_editor_pdf} use-video-gallery-flow = ${use_new_video_gallery_flow} authoring_MFE_base_url = ${get_editor_page_base_url(xblock.location.course_key)} data-block-type = ${xblock.scope_ids.block_type} @@ -111,7 +111,7 @@ % else: % if upstream_info.upstream_ref: % if upstream_info.error_message: -
      +
      ${_("The referenced library or library object is not available.")} + ${_("The referenced library or library object is not available")}
      % elif upstream_info.ready_to_sync: - % elif len(upstream_info.downstream_customized) > 0: -
      +
      ${_("This library reference has course overrides applied.")} + ${_("This library reference has course overrides applied")}
      % else: -
      +
      {name}').format(name=upstream_info.upstream_name))}"> - ${_("This item is linked to a library item.")} + ${_("This item is linked to a library item")}
      % endif % endif diff --git a/cms/templates/videos_index.html b/cms/templates/videos_index.html deleted file mode 100644 index 5e692042552b..000000000000 --- a/cms/templates/videos_index.html +++ /dev/null @@ -1,82 +0,0 @@ -<%page expression_filter="h"/> -<%inherit file="base.html" /> -<%def name="online_help_token()"><% return "video" %> -<%! - import json - from django.core.serializers.json import DjangoJSONEncoder - from django.utils.translation import gettext as _ - from openedx.core.djangolib.js_utils import ( - dump_js_escaped_json, js_escaped_string - ) - from openedx.core.djangolib.markup import HTML, Text -%> -<%block name="title">${_("Video Uploads")} -<%block name="bodyclass">is-signedin course view-video-uploads - -<%namespace name='static' file='static_content.html'/> - -<%block name="header_extras"> -% for template_name in ["active-video-upload", "previous-video-upload-list"]: - -% endfor - - -<%block name="requirejs"> - require(["js/factories/videos_index"], function (VideosIndexFactory) { - "use strict"; - var $contentWrapper = $(".content-primary"); - VideosIndexFactory( - $contentWrapper, - "${image_upload_url | n, js_escaped_string}", - "${video_handler_url | n, js_escaped_string}", - "${encodings_download_url | n, js_escaped_string}", - "${default_video_image_url | n, js_escaped_string}", - ${concurrent_upload_limit | n, dump_js_escaped_json}, - $(".nav-actions .course-video-settings-button"), - $contentWrapper.data("previous-uploads"), - ${video_supported_file_formats | n, dump_js_escaped_json}, - ${video_upload_max_file_size | n, dump_js_escaped_json}, - ${active_transcript_preferences | n, dump_js_escaped_json}, - ${transcript_credentials | n, dump_js_escaped_json}, - ${video_transcript_settings | n, dump_js_escaped_json}, - ${is_video_transcript_enabled | n, dump_js_escaped_json}, - ${video_image_settings | n, dump_js_escaped_json}, - ${transcript_available_languages | n, dump_js_escaped_json} - ); - }); - - -<%block name="content"> - -
      -
      -
      -

      - ${_("Content")} - > ${_("Video Uploads")} -

      - - % if is_video_transcript_enabled : - - % endif -
      -
      - -
      -
      -
      -
      -
      - -% if pagination_context: - <%include file="videos_index_pagination.html"/> -% endif - - diff --git a/cms/templates/videos_index_pagination.html b/cms/templates/videos_index_pagination.html deleted file mode 100644 index a96c2916463b..000000000000 --- a/cms/templates/videos_index_pagination.html +++ /dev/null @@ -1,40 +0,0 @@ -<%page expression_filter="h"/> -<%! -from django.utils.translation import gettext as _ -from openedx.core.djangolib.js_utils import dump_js_escaped_json -%> - - - - - diff --git a/cms/templates/widgets/header.html b/cms/templates/widgets/header.html index d01ee633ea87..c67c91dd21b0 100644 --- a/cms/templates/widgets/header.html +++ b/cms/templates/widgets/header.html @@ -8,7 +8,7 @@ from urllib.parse import quote_plus from common.djangoapps.student.auth import has_studio_advanced_settings_access from cms.djangoapps.contentstore import toggles - from cms.djangoapps.contentstore.utils import get_pages_and_resources_url, get_course_outline_url, get_course_libraries_url, get_updates_url, get_files_uploads_url, get_video_uploads_url, get_schedule_details_url, get_grading_url, get_advanced_settings_url, get_import_url, get_export_url, get_studio_home_url, get_course_team_url, get_optimizer_url + from cms.djangoapps.contentstore.utils import get_pages_and_resources_url, get_course_outline_url, get_course_libraries_url, get_updates_url, get_files_uploads_url, get_video_uploads_url, get_schedule_details_url, get_grading_url, get_advanced_settings_url, get_import_url, get_export_url, get_studio_home_url, get_course_team_url, get_optimizer_url, get_certificates_url, get_group_configurations_url from openedx.core.djangoapps.discussions.config.waffle import ENABLE_PAGES_AND_RESOURCES_MICROFRONTEND from openedx.core.djangoapps.lang_pref.api import header_language_selector_is_enabled, released_languages %> @@ -30,29 +30,13 @@

      course_key = context_course.id url_encoded_course_key = quote(str(course_key).encode('utf-8'), safe='') index_url = reverse('course_handler', kwargs={'course_key_string': str(course_key)}) - course_team_url = reverse('course_team_handler', kwargs={'course_key_string': str(course_key)}) assets_url = reverse('assets_handler', kwargs={'course_key_string': str(course_key)}) textbooks_url = reverse('textbooks_list_handler', kwargs={'course_key_string': str(course_key)}) videos_url = reverse('videos_handler', kwargs={'course_key_string': str(course_key)}) - import_url = reverse('import_handler', kwargs={'course_key_string': str(course_key)}) course_info_url = reverse('course_info_handler', kwargs={'course_key_string': str(course_key)}) - export_url = reverse('export_handler', kwargs={'course_key_string': str(course_key)}) - settings_url = reverse('settings_handler', kwargs={'course_key_string': str(course_key)}) - grading_url = reverse('grading_handler', kwargs={'course_key_string': str(course_key)}) - advanced_settings_url = reverse('advanced_settings_handler', kwargs={'course_key_string': str(course_key)}) tabs_url = reverse('tabs_handler', kwargs={'course_key_string': str(course_key)}) - certificates_url = '' - if settings.FEATURES.get("CERTIFICATES_HTML_VIEW") and context_course.cert_html_view_enabled: - certificates_url = reverse('certificates_list_handler', kwargs={'course_key_string': str(course_key)}) checklists_url = reverse('checklists_handler', kwargs={'course_key_string': str(course_key)}) pages_and_resources_mfe_enabled = ENABLE_PAGES_AND_RESOURCES_MICROFRONTEND.is_enabled(context_course.id) - video_upload_mfe_enabled = toggles.use_new_video_uploads_page(context_course.id) - schedule_details_mfe_enabled = toggles.use_new_schedule_details_page(context_course.id) - grading_mfe_enabled = toggles.use_new_grading_page(context_course.id) - course_team_mfe_enabled = toggles.use_new_course_team_page(context_course.id) - advanced_settings_mfe_enabled = toggles.use_new_advanced_settings_page(context_course.id) - import_mfe_enabled = toggles.use_new_import_page(context_course.id) - export_mfe_enabled = toggles.use_new_export_page(context_course.id) optimizer_enabled = toggles.enable_course_optimizer(context_course.id) libraries_v2_enabled = toggles.libraries_v2_enabled() @@ -103,12 +87,7 @@

      ${_("Course" ${_("Textbooks")} % endif - % if context_course.video_pipeline_configured and not video_upload_mfe_enabled: -
    1. - ${_("Video Uploads")} -
      2. - % endif - % if context_course.video_pipeline_configured and video_upload_mfe_enabled: + % if context_course.video_pipeline_configured:
    2. ${_("Videos")}
      3. @@ -124,57 +103,31 @@

      ${_("Course"
        - % if not schedule_details_mfe_enabled: -
      • - ${_("Schedule & Details")} -
        • - % endif - % if schedule_details_mfe_enabled:
      • ${_("Schedule & Details")}
        • - % endif - % if not grading_mfe_enabled: -
      • - ${_("Grading")} -
        • - % endif - % if grading_mfe_enabled:
      • ${_("Grading")}
        • - % endif - % if not course_team_mfe_enabled: -
      • - ${_("Course Team")} -
        • - % endif - % if course_team_mfe_enabled:
      • ${_("Course Team")}
        • - % endif
      • - ${_("Group Configurations")} + ${_("Group Configurations")}
        • % if mfe_proctored_exam_settings_url:
      • ${_("Proctored Exam Settings")}
        • % endif - % if has_studio_advanced_settings_access(request.user) and not advanced_settings_mfe_enabled: -
      • - ${_("Advanced Settings")} -
        • - % endif - % if has_studio_advanced_settings_access(request.user) and advanced_settings_mfe_enabled: + % if has_studio_advanced_settings_access(request.user):
      • ${_("Advanced Settings")}
        • % endif - % if certificates_url: + % if get_certificates_url(course_key):
      • - ${_("Certificates")} + ${_("Certificates")}
        • % endif % if frontend_app_publisher_url: @@ -192,26 +145,12 @@

        ${_("Tools")}
          - % if not import_mfe_enabled: -
        • - ${_("Import")} -
          • - % endif - % if import_mfe_enabled:
        • ${_("Import")}
          • - % endif - % if not export_mfe_enabled: -
        • - ${_("Export")} -
          • - % endif - % if export_mfe_enabled:
        • ${_("Export")}
          • - % endif % if toggles.EXPORT_GIT.is_enabled() and context_course.giturl:
        • ${_("Export to Git")} diff --git a/cms/templates/widgets/metadata-edit.html b/cms/templates/widgets/metadata-edit.html index c70d9bd9c8dd..70d950653d53 100644 --- a/cms/templates/widgets/metadata-edit.html +++ b/cms/templates/widgets/metadata-edit.html @@ -36,4 +36,32 @@ <%include file="source-edit.html" /> % endif +## It is used to display a warning if a block (i.e. a LibraryContentBlock) uses the deprecated +## legacy libraries feature. +% if show_deprecated_warning: + +% endif +
          diff --git a/cms/urls.py b/cms/urls.py index 048339bc9fe9..faa8281cf9d3 100644 --- a/cms/urls.py +++ b/cms/urls.py @@ -2,15 +2,16 @@ Urls of Studio. """ +from auth_backends.urls import oauth2_urlpatterns from django.conf import settings from django.conf.urls.static import static +from django.contrib import admin from django.contrib.admin import autodiscover as django_autodiscover -from django.urls import include -from django.urls import path, re_path +from django.shortcuts import redirect +from django.urls import include, path, re_path from django.utils.translation import gettext_lazy as _ -from django.contrib import admin +from django.views.generic import RedirectView from drf_spectacular.views import SpectacularAPIView, SpectacularSwaggerView -from auth_backends.urls import oauth2_urlpatterns from edx_api_doc_tools import make_docs_urls import openedx.core.djangoapps.common_views.xblock @@ -20,11 +21,10 @@ from cms.djangoapps.contentstore import views as contentstore_views from cms.djangoapps.contentstore.views.block import xblock_edit_view from cms.djangoapps.contentstore.views.organization import OrganizationListView +from openedx.core import toggles as core_toggles from openedx.core.apidocs import api_info from openedx.core.djangoapps.password_policy import compliance as password_policy_compliance from openedx.core.djangoapps.password_policy.forms import PasswordPolicyAwareAdminAuthForm -from openedx.core import toggles as core_toggles - django_autodiscover() admin.site.site_header = _('Studio Administration') @@ -87,15 +87,15 @@ ), # Darklang View to change the preview language (or dark language) - path('update_lang/', include('openedx.core.djangoapps.dark_lang.urls', namespace='dark_lang')), + path('update_lang/', lambda request: redirect(f'{settings.LMS_ROOT_URL}/update_lang/')), # For redirecting to help pages. path('help_token/', include('help_tokens.urls')), path('api/', include('cms.djangoapps.api.urls', namespace='api')), # restful api - path('', contentstore_views.howitworks, name='homepage'), - path('howitworks', contentstore_views.howitworks, name='howitworks'), + path('', RedirectView.as_view(url='/home/', permanent=True), name='homepage'), + path('howitworks', RedirectView.as_view(url='/home/', permanent=True), name='howitworks'), path('signin_redirect_to_lms', contentstore_views.login_redirect_to_lms, name='login_redirect_to_lms'), path('request_course_creator', contentstore_views.request_course_creator, name='request_course_creator'), re_path(fr'^course_team/{COURSELIKE_KEY_PATTERN}(?:/(?P.+))?$', @@ -167,6 +167,9 @@ contentstore_views.grading_handler, name='grading_handler'), re_path(fr'^settings/advanced/{settings.COURSE_KEY_PATTERN}$', contentstore_views.advanced_settings_handler, name='advanced_settings_handler'), + # Backward-compat redirect: old /settings/ URL now unconditionally goes to MFE. + # Must come after all other ^settings/... patterns so it doesn't shadow them. + re_path(fr'^settings/{settings.COURSE_KEY_PATTERN}$', contentstore_views.settings_handler), re_path(fr'^textbooks/{settings.COURSE_KEY_PATTERN}$', contentstore_views.textbooks_list_handler, name='textbooks_list_handler'), re_path(fr'^textbooks/{settings.COURSE_KEY_PATTERN}/(?P\d[^/]*)$', @@ -186,7 +189,7 @@ contentstore_views.transcript_credentials_handler, name='transcript_credentials_handler'), path('transcript_download/', contentstore_views.transcript_download_handler, name='transcript_download_handler'), path('transcript_upload/', contentstore_views.transcript_upload_handler, name='transcript_upload_handler'), - re_path(r'^transcript_delete/{}(?:/(?P[-\w]+))?(?:/(?P[^/]*))?$'.format( + re_path(r'^transcript_delete/{}(?:/(?P[-\w]+))?(?:/(?P[^/]*))?$'.format( # noqa: UP032 settings.COURSE_KEY_PATTERN ), contentstore_views.transcript_delete_handler, name='transcript_delete_handler'), path('transcript_upload_api/', contentstore_views.transcript_upload_api, name='transcript_upload_api'), @@ -195,7 +198,7 @@ re_path(fr'^group_configurations/{settings.COURSE_KEY_PATTERN}$', contentstore_views.group_configurations_list_handler, name='group_configurations_list_handler'), - re_path(r'^group_configurations/{}/(?P\d+)(/)?(?P\d+)?$'.format( + re_path(r'^group_configurations/{}/(?P\d+)(/)?(?P\d+)?$'.format( # noqa: UP032 settings.COURSE_KEY_PATTERN), contentstore_views.group_configurations_detail_handler, name='group_configurations_detail_handler'), path('api/val/v0/', include('edxval.urls')), @@ -265,18 +268,18 @@ # Enable Web/HTML Certificates if settings.FEATURES.get('CERTIFICATES_HTML_VIEW'): - from cms.djangoapps.contentstore.views.certificates import ( + from cms.djangoapps.contentstore.views.certificates import ( # noqa: I001 - conditional import inside if block CertificateActivationAPIView, CertificateDetailAPIView, certificates_list_handler, - signatory_detail_handler, + signatory_detail_handler ) urlpatterns += [ re_path(fr'^certificates/activation/{settings.COURSE_KEY_PATTERN}/', CertificateActivationAPIView.as_view(), name='certificate_activation_handler'), - re_path(r'^certificates/{}/(?P\d+)/signatories/(?P\d+)?$'.format( + re_path(r'^certificates/{}/(?P\d+)/signatories/(?P\d+)?$'.format( # noqa: UP032 settings.COURSE_KEY_PATTERN), signatory_detail_handler, name='signatory_detail_handler'), re_path(fr'^certificates/{settings.COURSE_KEY_PATTERN}/(?P\d+)?$', CertificateDetailAPIView.as_view(), name='certificates_detail_handler'), @@ -344,9 +347,9 @@ ] # pylint: disable=wrong-import-position, wrong-import-order -from edx_django_utils.plugins import get_plugin_url_patterns # isort:skip +from edx_django_utils.plugins import get_plugin_url_patterns # noqa: I001 - must be after urlpatterns are built # pylint: disable=wrong-import-position -from openedx.core.djangoapps.plugins.constants import ProjectType # isort:skip +from openedx.core.djangoapps.plugins.constants import ProjectType # noqa: I001 - must be after urlpatterns are built urlpatterns.extend(get_plugin_url_patterns(ProjectType.CMS)) diff --git a/cms/urls_dev.py b/cms/urls_dev.py index 200d8576917b..1aed9c131c3a 100644 --- a/cms/urls_dev.py +++ b/cms/urls_dev.py @@ -6,6 +6,7 @@ from django.urls import path + from cms.djangoapps.contentstore.views.dev import dev_mode urlpatterns = [ diff --git a/cms/wsgi.py b/cms/wsgi.py index 9c9af4299844..953794080308 100644 --- a/cms/wsgi.py +++ b/cms/wsgi.py @@ -1,3 +1,4 @@ +# ruff: noqa: I001 """ WSGI config for CMS. @@ -8,17 +9,16 @@ ``WSGI_APPLICATION`` setting. Import sorting is intentionally disabled in this module. -isort:skip_file """ # Patch the xml libs before anything else. from openedx.core.lib.safe_lxml import defuse_xml_libs defuse_xml_libs() -import os # lint-amnesty, pylint: disable=wrong-import-order, wrong-import-position +import os # pylint: disable=wrong-import-order, wrong-import-position os.environ.setdefault("DJANGO_SETTINGS_MODULE", "cms.envs.aws") # This application object is used by the development server # as well as any WSGI server configured to use this file. -from django.core.wsgi import get_wsgi_application # lint-amnesty, pylint: disable=wrong-import-order, wrong-import-position +from django.core.wsgi import get_wsgi_application # pylint: disable=wrong-import-order, wrong-import-position application = get_wsgi_application() diff --git a/common/djangoapps/course_action_state/managers.py b/common/djangoapps/course_action_state/managers.py index 57076f11e729..2ac27913069c 100644 --- a/common/djangoapps/course_action_state/managers.py +++ b/common/djangoapps/course_action_state/managers.py @@ -33,9 +33,9 @@ def find_first(self, exclude_args=None, **kwargs): There may or may not be greater than one entry, depending on the usage pattern for this Action. """ objects = self.find_all(exclude_args=exclude_args, **kwargs) - if len(objects) == 0: # lint-amnesty, pylint: disable=no-else-raise + if len(objects) == 0: # pylint: disable=no-else-raise raise CourseActionStateItemNotFoundError( - "No entry found for action {action} with filter {filter}, excluding {exclude}".format( + "No entry found for action {action} with filter {filter}, excluding {exclude}".format( # noqa: UP032 action=self.ACTION, filter=kwargs, exclude=exclude_args, @@ -74,7 +74,7 @@ def update_state( state_object.created_user = user else: raise CourseActionStateItemNotFoundError( - "Cannot update non-existent entry for course_key {course_key} and action {action}".format( + "Cannot update non-existent entry for course_key {course_key} and action {action}".format( # noqa: UP032 # pylint: disable=line-too-long action=self.ACTION, course_key=course_key, )) @@ -151,4 +151,4 @@ def failed(self, course_key): class CourseActionStateItemNotFoundError(Exception): """An exception class for errors specific to Course Action states.""" - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass diff --git a/common/djangoapps/course_action_state/models.py b/common/djangoapps/course_action_state/models.py index 366f9e636e03..fa45aac3c5fd 100644 --- a/common/djangoapps/course_action_state/models.py +++ b/common/djangoapps/course_action_state/models.py @@ -10,7 +10,7 @@ """ -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.db import models from opaque_keys.edx.django.models import CourseKeyField @@ -35,7 +35,7 @@ class Meta: # FIELDS # Created is the time this action was initiated - created_time = models.DateTimeField(auto_now_add=True) + created_time = models.DateTimeField(auto_now_add=True) # noqa: DJ012 # Updated is the last time this entry was modified updated_time = models.DateTimeField(auto_now=True) @@ -72,7 +72,7 @@ class Meta: state = models.CharField(max_length=50) # MANAGERS - objects = CourseActionStateManager() + objects = CourseActionStateManager() # noqa: DJ012 class CourseActionUIState(CourseActionState): @@ -92,14 +92,14 @@ class Meta: # FIELDS # Whether or not the status should be displayed to users - should_display = models.BooleanField(default=False) + should_display = models.BooleanField(default=False) # noqa: DJ012 # Message related to the status message = models.CharField(max_length=MAX_MESSAGE_LENGTH) # Rerun courses also need these fields. All rerun course actions will have a row here as well. -class CourseRerunState(CourseActionUIState): +class CourseRerunState(CourseActionUIState): # noqa: DJ008 """ A concrete django model for maintaining state specifically for the Action Course Reruns. @@ -118,8 +118,8 @@ class Meta: source_course_key = CourseKeyField(max_length=255, db_index=True) # Display name for destination course - display_name = models.CharField(max_length=255, default="", blank=True) + display_name = models.CharField(max_length=255, default="", blank=True) # noqa: DJ012 # MANAGERS # Override the abstract class' manager with a Rerun-specific manager that inherits from the base class' manager. - objects = CourseRerunUIStateManager() + objects = CourseRerunUIStateManager() # noqa: DJ012 diff --git a/common/djangoapps/course_action_state/tests/test_managers.py b/common/djangoapps/course_action_state/tests/test_managers.py index d1c0a0f41b49..0cab95308d78 100644 --- a/common/djangoapps/course_action_state/tests/test_managers.py +++ b/common/djangoapps/course_action_state/tests/test_managers.py @@ -116,7 +116,7 @@ def create_course_states(starting_course_num, ending_course_num, state, should_d def assertCourseActionStatesEqual(self, expected, found): """Asserts that the set of course keys in the expected state equal those that are found""" - self.assertSetEqual( + self.assertSetEqual( # noqa: PT009 {course_action_state.course_key for course_action_state in expected}, {course_action_state.course_key for course_action_state in found}) diff --git a/common/djangoapps/course_action_state/tests/test_rerun_manager.py b/common/djangoapps/course_action_state/tests/test_rerun_manager.py index f365b91be7e6..61bafc1f59af 100644 --- a/common/djangoapps/course_action_state/tests/test_rerun_manager.py +++ b/common/djangoapps/course_action_state/tests/test_rerun_manager.py @@ -39,7 +39,7 @@ def verify_rerun_state(self): """ found_rerun = CourseRerunState.objects.find_first(course_key=self.course_key) found_rerun_state = {key: getattr(found_rerun, key) for key in self.expected_rerun_state} - self.assertDictEqual(found_rerun_state, self.expected_rerun_state) + self.assertDictEqual(found_rerun_state, self.expected_rerun_state) # noqa: PT009 return found_rerun def dismiss_ui_and_verify(self, rerun): @@ -96,7 +96,7 @@ def test_rerun_failed(self): exception = Exception("failure in rerunning") try: raise exception - except: # lint-amnesty, pylint: disable=bare-except + except: # pylint: disable=bare-except CourseRerunState.objects.failed(course_key=self.course_key) self.expected_rerun_state.update( diff --git a/common/djangoapps/course_modes/admin.py b/common/djangoapps/course_modes/admin.py index 76eabd20bf80..c8842b926531 100644 --- a/common/djangoapps/course_modes/admin.py +++ b/common/djangoapps/course_modes/admin.py @@ -11,6 +11,8 @@ from opaque_keys.edx.keys import CourseKey from common.djangoapps.course_modes.models import CourseMode, CourseModeExpirationConfig +from common.djangoapps.util.date_utils import get_time_display + # Technically, we shouldn't be doing this, since verify_student is defined # in LMS, and course_modes is defined in common. # @@ -23,7 +25,6 @@ # the verification deadline table won't exist. from lms.djangoapps.verify_student import models as verification_models from openedx.core.lib.courses import clean_course_id -from common.djangoapps.util.date_utils import get_time_display COURSE_MODE_SLUG_CHOICES = [(key, enrollment_mode['display_name']) for key, enrollment_mode in settings.COURSE_ENROLLMENT_MODES.items()] @@ -36,7 +37,7 @@ class CourseModeForm(forms.ModelForm): class Meta: model = CourseMode - fields = '__all__' + fields = '__all__' # noqa: DJ007 mode_slug = forms.ChoiceField(choices=COURSE_MODE_SLUG_CHOICES, label=_("Mode")) diff --git a/common/djangoapps/course_modes/apps.py b/common/djangoapps/course_modes/apps.py index 4140906a7039..1b9fd526beae 100644 --- a/common/djangoapps/course_modes/apps.py +++ b/common/djangoapps/course_modes/apps.py @@ -4,9 +4,9 @@ from django.apps import AppConfig -class CourseModesConfig(AppConfig): # lint-amnesty, pylint: disable=missing-class-docstring +class CourseModesConfig(AppConfig): # pylint: disable=missing-class-docstring name = 'common.djangoapps.course_modes' verbose_name = "Course Modes" def ready(self): - from . import signals # pylint: disable=unused-import + from . import signals # pylint: disable=unused-import # noqa: F401 diff --git a/common/djangoapps/course_modes/migrations/0012_historicalcoursemode.py b/common/djangoapps/course_modes/migrations/0012_historicalcoursemode.py index 48d0a39cf4ce..45c3c05357e2 100644 --- a/common/djangoapps/course_modes/migrations/0012_historicalcoursemode.py +++ b/common/djangoapps/course_modes/migrations/0012_historicalcoursemode.py @@ -1,12 +1,13 @@ # Generated by Django 1.11.21 on 2019-06-19 01:31 -from django.conf import settings +import re + import django.core.validators -from django.db import migrations, models import django.db.models.deletion -import re import simple_history.models +from django.conf import settings +from django.db import migrations, models class Migration(migrations.Migration): diff --git a/common/djangoapps/course_modes/models.py b/common/djangoapps/course_modes/models.py index 2e711a1081f4..2626b98c4dd9 100644 --- a/common/djangoapps/course_modes/models.py +++ b/common/djangoapps/course_modes/models.py @@ -3,9 +3,10 @@ """ +import logging from collections import defaultdict, namedtuple from datetime import timedelta -import logging + from config_models.models import ConfigurationModel from django.conf import settings from django.core.exceptions import ValidationError @@ -13,7 +14,6 @@ from django.db import models from django.db.models import Q from django.dispatch import receiver - from django.utils.timezone import now from django.utils.translation import gettext_lazy as _ from edx_django_utils.cache import RequestCache @@ -109,10 +109,10 @@ class CourseMode(models.Model): # optional description override # WARNING: will not be localized - description = models.TextField(null=True, blank=True) + description = models.TextField(null=True, blank=True) # noqa: DJ001 # Optional SKU for integration with the ecommerce service - sku = models.CharField( + sku = models.CharField( # noqa: DJ001 max_length=255, null=True, blank=True, @@ -124,7 +124,7 @@ class CourseMode(models.Model): ) # Optional Android SKU for integration with mobile and the ecommerce service - android_sku = models.CharField( + android_sku = models.CharField( # noqa: DJ001 max_length=255, null=True, blank=True, @@ -136,7 +136,7 @@ class CourseMode(models.Model): ) # Optional iOS SKU for integration with mobile and the ecommerce service - ios_sku = models.CharField( + ios_sku = models.CharField( # noqa: DJ001 max_length=255, null=True, blank=True, @@ -148,7 +148,7 @@ class CourseMode(models.Model): ) # Optional bulk order SKU for integration with the ecommerce service - bulk_sku = models.CharField( + bulk_sku = models.CharField( # noqa: DJ001 max_length=255, null=True, blank=True, @@ -236,7 +236,7 @@ class Meta: app_label = "course_modes" unique_together = ('course', 'mode_slug', 'currency') - def __init__(self, *args, **kwargs): # lint-amnesty, pylint: disable=useless-super-delegation + def __init__(self, *args, **kwargs): # pylint: disable=useless-super-delegation super().__init__(*args, **kwargs) def clean(self): @@ -254,14 +254,14 @@ def clean(self): if int(self.min_price) < min_price_for_mode: mode_display_name = mode_config.get('display_name', self.mode_slug) raise ValidationError( - _( # lint-amnesty, pylint: disable=translation-of-non-string - "The {course_mode} course mode has a minimum price of {min_price}. You must set a price greater than or equal to {min_price}.".format( # lint-amnesty, pylint: disable=line-too-long + _( # pylint: disable=translation-of-non-string + "The {course_mode} course mode has a minimum price of {min_price}. You must set a price greater than or equal to {min_price}.".format( # pylint: disable=line-too-long course_mode=mode_display_name, min_price=min_price_for_mode ) ) ) - def save(self, force_insert=False, force_update=False, using=None): # lint-amnesty, pylint: disable=arguments-differ + def save(self, force_insert=False, force_update=False, using=None): # pylint: disable=arguments-differ # noqa: DJ012 # Ensure currency is always lowercase. self.clean() # ensure object-level validation is performed before we save. self.currency = self.currency.lower() @@ -857,8 +857,8 @@ def to_tuple(self): self.bulk_sku ) - def __str__(self): - return "{} : {}, min={}".format( + def __str__(self): # noqa: DJ012 + return "{} : {}, min={}".format( # noqa: UP032 self.course_id, self.mode_slug, self.min_price ) @@ -930,7 +930,7 @@ def format_course_price(price): return cosmetic_display_price -class CourseModesArchive(models.Model): +class CourseModesArchive(models.Model): # noqa: DJ008 """ Store the past values of course_mode that a course had in the past. We decided on having separate model, because there is a uniqueness contraint on (course_mode, course_id) @@ -943,11 +943,11 @@ class Meta: app_label = "course_modes" # the course that this mode is attached to - course_id = CourseKeyField(max_length=255, db_index=True) + course_id = CourseKeyField(db_index=True) # the reference to this mode that can be used by Enrollments to generate # similar behavior for the same slug across courses - mode_slug = models.CharField(max_length=100) + mode_slug = models.CharField(max_length=100) # noqa: DJ012 # The 'pretty' name that can be translated and displayed mode_display_name = models.CharField(max_length=255) diff --git a/common/djangoapps/course_modes/rest_api/serializers.py b/common/djangoapps/course_modes/rest_api/serializers.py index 862bb34de3ff..c8ce6f5a46e2 100644 --- a/common/djangoapps/course_modes/rest_api/serializers.py +++ b/common/djangoapps/course_modes/rest_api/serializers.py @@ -3,8 +3,8 @@ """ -from rest_framework import serializers from opaque_keys.edx.keys import CourseKey +from rest_framework import serializers from common.djangoapps.course_modes.models import CourseMode from openedx.core.djangoapps.content.course_overviews.models import CourseOverview diff --git a/common/djangoapps/course_modes/rest_api/urls.py b/common/djangoapps/course_modes/rest_api/urls.py index 9c807b0c1138..8510b5794c56 100644 --- a/common/djangoapps/course_modes/rest_api/urls.py +++ b/common/djangoapps/course_modes/rest_api/urls.py @@ -3,8 +3,7 @@ """ -from django.urls import include -from django.urls import path +from django.urls import include, path app_name = 'common.djangoapps.course_modes.rest_api' diff --git a/common/djangoapps/course_modes/rest_api/v1/tests/test_views.py b/common/djangoapps/course_modes/rest_api/v1/tests/test_views.py index 33e06e857cd8..df0f1eacc453 100644 --- a/common/djangoapps/course_modes/rest_api/v1/tests/test_views.py +++ b/common/djangoapps/course_modes/rest_api/v1/tests/test_views.py @@ -10,14 +10,16 @@ from rest_framework import status from rest_framework.test import APITestCase -from common.djangoapps.course_modes.rest_api.v1.views import CourseModesView from common.djangoapps.course_modes.models import CourseMode +from common.djangoapps.course_modes.rest_api.v1.views import CourseModesView from common.djangoapps.course_modes.tests.factories import CourseModeFactory +from common.djangoapps.student.tests.factories import UserFactory from openedx.core.djangoapps.content.course_overviews.tests.factories import CourseOverviewFactory from openedx.core.djangoapps.user_authn.tests.utils import JWT_AUTH_TYPES, AuthAndScopesTestMixin, AuthType from openedx.core.djangolib.testing.utils import skip_unless_lms -from common.djangoapps.student.tests.factories import UserFactory -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + ModuleStoreTestCase, # pylint: disable=wrong-import-order +) @ddt.ddt diff --git a/common/djangoapps/course_modes/rest_api/v1/urls.py b/common/djangoapps/course_modes/rest_api/v1/urls.py index 6a066d7e6357..4ff01e3115a3 100644 --- a/common/djangoapps/course_modes/rest_api/v1/urls.py +++ b/common/djangoapps/course_modes/rest_api/v1/urls.py @@ -4,8 +4,8 @@ from django.conf import settings - from django.urls import re_path + from common.djangoapps.course_modes.rest_api.v1 import views app_name = 'v1' diff --git a/common/djangoapps/course_modes/rest_api/v1/views.py b/common/djangoapps/course_modes/rest_api/v1/views.py index 7c37d8596de8..60fe3341ade1 100644 --- a/common/djangoapps/course_modes/rest_api/v1/views.py +++ b/common/djangoapps/course_modes/rest_api/v1/views.py @@ -14,8 +14,8 @@ from rest_framework.generics import ListCreateAPIView, RetrieveUpdateDestroyAPIView from rest_framework.response import Response -from common.djangoapps.course_modes.rest_api.serializers import CourseModeSerializer from common.djangoapps.course_modes.models import CourseMode +from common.djangoapps.course_modes.rest_api.serializers import CourseModeSerializer from openedx.core.lib.api.authentication import BearerAuthenticationAllowInactiveUser from openedx.core.lib.api.parsers import MergePatchParser diff --git a/common/djangoapps/course_modes/tests/factories.py b/common/djangoapps/course_modes/tests/factories.py index a2fbea0190e5..51c5820314f4 100644 --- a/common/djangoapps/course_modes/tests/factories.py +++ b/common/djangoapps/course_modes/tests/factories.py @@ -15,7 +15,7 @@ # Factories are self documenting -class CourseModeFactory(DjangoModelFactory): # lint-amnesty, pylint: disable=missing-class-docstring +class CourseModeFactory(DjangoModelFactory): # pylint: disable=missing-class-docstring class Meta: model = CourseMode diff --git a/common/djangoapps/course_modes/tests/test_admin.py b/common/djangoapps/course_modes/tests/test_admin.py index 7a01b6794987..458c3a4dfd98 100644 --- a/common/djangoapps/course_modes/tests/test_admin.py +++ b/common/djangoapps/course_modes/tests/test_admin.py @@ -3,16 +3,19 @@ """ from datetime import datetime, timedelta +from zoneinfo import ZoneInfo import ddt from django.conf import settings from django.urls import reverse from pytz import timezone -from zoneinfo import ZoneInfo from common.djangoapps.course_modes.admin import CourseModeForm from common.djangoapps.course_modes.models import CourseMode from common.djangoapps.course_modes.tests.factories import CourseModeFactory +from common.djangoapps.student.tests.factories import UserFactory +from common.djangoapps.util.date_utils import get_time_display + # Technically, we shouldn't be importing verify_student, since it's # defined in the LMS and course_modes is in common. However, the benefits # of putting all this configuration in one place outweigh the downsides. @@ -20,10 +23,10 @@ from lms.djangoapps.verify_student.models import VerificationDeadline from openedx.core.djangoapps.content.course_overviews.models import CourseOverview from openedx.core.djangolib.testing.utils import skip_unless_lms -from common.djangoapps.student.tests.factories import UserFactory -from common.djangoapps.util.date_utils import get_time_display -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + ModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order # We can only test this in the LMS because the course modes admin relies diff --git a/common/djangoapps/course_modes/tests/test_models.py b/common/djangoapps/course_modes/tests/test_models.py index 35ea05f69203..26011a07e39f 100644 --- a/common/djangoapps/course_modes/tests/test_models.py +++ b/common/djangoapps/course_modes/tests/test_models.py @@ -21,12 +21,14 @@ CourseMode, Mode, get_cosmetic_display_price, - invalidate_course_mode_cache + invalidate_course_mode_cache, ) from common.djangoapps.course_modes.tests.factories import CourseModeFactory from openedx.core.djangoapps.content.course_overviews.models import CourseOverview -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + ModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order @ddt.ddt @@ -345,7 +347,7 @@ def test_invalid_mode_expiration(self, mode_slug, exp_dt_name): assert not is_error_expected, 'Expected a ValidationError to be thrown.' except ValidationError as exc: assert is_error_expected, 'Did not expect a ValidationError to be thrown.' - assert exc.messages == ['Professional education modes are not allowed to have expiration_datetime set.'] + assert exc.messages == ['Professional education modes are not allowed to have expiration_datetime set.'] # noqa: PT017 # pylint: disable=line-too-long @ddt.data( "verified", @@ -374,11 +376,11 @@ def test_hide_credit_modes(self, available_modes, expected_selectable_modes): # Check the selectable modes, which should exclude credit selectable_modes = CourseMode.modes_for_course_dict(self.course_key) - self.assertCountEqual(list(selectable_modes.keys()), expected_selectable_modes) + self.assertCountEqual(list(selectable_modes.keys()), expected_selectable_modes) # noqa: PT009 # When we get all unexpired modes, we should see credit as well all_modes = CourseMode.modes_for_course_dict(self.course_key, only_selectable=False) - self.assertCountEqual(list(all_modes.keys()), available_modes) + self.assertCountEqual(list(all_modes.keys()), available_modes) # noqa: PT009 def _enrollment_display_modes_dicts(self, mode): """ @@ -396,7 +398,7 @@ def _enrollment_display_modes_dicts(self, mode): 'professional'], } - return dict(list(zip(dict_keys, display_values.get(mode)))) + return dict(list(zip(dict_keys, display_values.get(mode)))) # noqa: B905 def test_expiration_datetime_explicitly_set(self): """ Verify that setting the expiration_date property sets the explicit flag. """ @@ -492,7 +494,7 @@ def test_is_masters_only(self, available_modes, expected_is_masters_only): assert CourseMode.is_masters_only(self.course_key) == expected_is_masters_only -class TestCourseOverviewIntegration(ModuleStoreTestCase): # lint-amnesty, pylint: disable=missing-class-docstring +class TestCourseOverviewIntegration(ModuleStoreTestCase): # pylint: disable=missing-class-docstring def test_course_overview_version_update(self): course = CourseFactory.create() course_overview = CourseOverview.get_from_id(course.id) @@ -505,7 +507,7 @@ def test_course_overview_version_update(self): assert CourseMode.objects.filter(pk=course_mode.pk).exists() -class TestDisplayPrices(ModuleStoreTestCase): # lint-amnesty, pylint: disable=missing-class-docstring +class TestDisplayPrices(ModuleStoreTestCase): # pylint: disable=missing-class-docstring @override_settings(PAID_COURSE_REGISTRATION_CURRENCY=["USD", "$"]) def test_get_cosmetic_display_price(self): """ diff --git a/common/djangoapps/course_modes/tests/test_signals.py b/common/djangoapps/course_modes/tests/test_signals.py index e4323f825a25..7f0ecf052733 100644 --- a/common/djangoapps/course_modes/tests/test_signals.py +++ b/common/djangoapps/course_modes/tests/test_signals.py @@ -12,10 +12,17 @@ from common.djangoapps.course_modes.models import CourseMode from common.djangoapps.course_modes.signals import _listen_for_course_publish -from xmodule.modulestore import ModuleStoreEnum # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory, BlockFactory # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.partitions.partitions import ENROLLMENT_TRACK_PARTITION_ID # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore import ModuleStoreEnum # pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + ModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import ( # pylint: disable=wrong-import-order + BlockFactory, + CourseFactory, +) +from xmodule.partitions.partitions import ( + ENROLLMENT_TRACK_PARTITION_ID, # pylint: disable=wrong-import-order +) @ddt.ddt diff --git a/common/djangoapps/course_modes/tests/test_views.py b/common/djangoapps/course_modes/tests/test_views.py index 65b4980eba01..d8c5c9641b99 100644 --- a/common/djangoapps/course_modes/tests/test_views.py +++ b/common/djangoapps/course_modes/tests/test_views.py @@ -28,9 +28,11 @@ from openedx.core.djangoapps.embargo.test_utils import restrict_course from openedx.core.djangoapps.theming.tests.test_util import with_comprehensive_theme from openedx.core.djangolib.testing.utils import skip_unless_lms -from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + ModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order # Name of the method to mock for Content Type Gating. GATING_METHOD_NAME = 'openedx.features.content_type_gating.models.ContentTypeGatingConfig.enabled_for_enrollment' @@ -487,7 +489,7 @@ def test_errors(self, has_perm, post_params, error_msg, status_code, mock_has_pe # Choose mode (POST request) response = self.client.post(url, post_params) - self.assertEqual(response.status_code, status_code) + self.assertEqual(response.status_code, status_code) # noqa: PT009 if has_perm: self.assertContains(response, error_msg) @@ -499,7 +501,7 @@ def test_errors(self, has_perm, post_params, error_msg, status_code, mock_has_pe self.assertContains(response, search_courses_url) self.assertContains(response, 'Explore all courses') else: - self.assertTrue(CourseEnrollment.is_enrollment_closed(self.user, self.course)) + self.assertTrue(CourseEnrollment.is_enrollment_closed(self.user, self.course)) # noqa: PT009 def _assert_fbe_page(self, response, min_price=None, **_): """ diff --git a/common/djangoapps/course_modes/urls.py b/common/djangoapps/course_modes/urls.py index 8c3e562688d8..c02486789abe 100644 --- a/common/djangoapps/course_modes/urls.py +++ b/common/djangoapps/course_modes/urls.py @@ -2,8 +2,8 @@ from django.conf import settings - from django.urls import re_path + from common.djangoapps.course_modes import views urlpatterns = [ diff --git a/common/djangoapps/course_modes/views.py b/common/djangoapps/course_modes/views.py index 09164dc40e7c..a5b40346b2d8 100644 --- a/common/djangoapps/course_modes/views.py +++ b/common/djangoapps/course_modes/views.py @@ -6,9 +6,10 @@ import decimal import json import logging +from urllib.parse import urljoin # pylint: disable=wrong-import-order import six -import waffle # lint-amnesty, pylint: disable=invalid-django-waffle-import +import waffle # pylint: disable=invalid-django-waffle-import from babel.dates import format_datetime from babel.numbers import get_currency_symbol from django.conf import settings @@ -23,12 +24,13 @@ from django.views.generic.base import View from edx_django_utils.monitoring.utils import increment from opaque_keys.edx.keys import CourseKey -from urllib.parse import urljoin # lint-amnesty, pylint: disable=wrong-import-order -from common.djangoapps.course_modes.models import CourseMode from common.djangoapps.course_modes.helpers import get_course_final_price, get_verified_track_links +from common.djangoapps.course_modes.models import CourseMode from common.djangoapps.edxmako.shortcuts import render_to_response +from common.djangoapps.student.models import CourseEnrollment from common.djangoapps.util.date_utils import strftime_localized_html +from common.djangoapps.util.db import outer_atomic from lms.djangoapps.commerce.utils import EcommerceService from lms.djangoapps.experiments.utils import get_experiment_user_metadata_context from lms.djangoapps.verify_student.services import IDVerificationService @@ -36,13 +38,11 @@ from openedx.core.djangoapps.embargo import api as embargo_api from openedx.core.djangoapps.enrollments.permissions import ENROLL_IN_COURSE from openedx.features.content_type_gating.models import ContentTypeGatingConfig -from openedx.features.course_duration_limits.models import CourseDurationLimitConfig from openedx.features.course_duration_limits.access import get_user_course_duration, get_user_course_expiration_date +from openedx.features.course_duration_limits.models import CourseDurationLimitConfig from openedx.features.course_experience import course_home_url from openedx.features.enterprise_support.api import enterprise_customer_for_request -from common.djangoapps.student.models import CourseEnrollment -from common.djangoapps.util.db import outer_atomic -from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order LOG = logging.getLogger(__name__) @@ -71,7 +71,7 @@ def dispatch(self, *args, **kwargs): @method_decorator(login_required) @method_decorator(transaction.atomic) - def get(self, request, course_id, error=None): # lint-amnesty, pylint: disable=too-many-statements + def get(self, request, course_id, error=None): # pylint: disable=too-many-statements """Displays the course mode choice page. Args: diff --git a/common/djangoapps/edxmako/README b/common/djangoapps/edxmako/README index 9896d78747c3..03674276986f 100644 --- a/common/djangoapps/edxmako/README +++ b/common/djangoapps/edxmako/README @@ -19,5 +19,5 @@ Mako: http://www.makotemplates.org/ How to install? ================================================================================ - $ sudo python setup.py install + $ pip install . diff --git a/common/djangoapps/edxmako/__init__.py b/common/djangoapps/edxmako/__init__.py index 29b1342dedd0..d3eb3b394730 100644 --- a/common/djangoapps/edxmako/__init__.py +++ b/common/djangoapps/edxmako/__init__.py @@ -1,4 +1,4 @@ -# Copyright (c) 2008 Mikeal Rogers # lint-amnesty, pylint: disable=missing-module-docstring +# Copyright (c) 2008 Mikeal Rogers # pylint: disable=missing-module-docstring # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. @@ -13,7 +13,12 @@ # limitations under the License. LOOKUP = {} -from .paths import add_lookup, clear_lookups, lookup_template, save_lookups # lint-amnesty, pylint: disable=wrong-import-position +from .paths import ( # pylint: disable=wrong-import-position + add_lookup, # noqa: F401 + clear_lookups, # noqa: F401 + lookup_template, # noqa: F401 + save_lookups, # noqa: F401 +) class Engines: diff --git a/common/djangoapps/edxmako/backend.py b/common/djangoapps/edxmako/backend.py index c37aeb3d20de..76d4bcc1ebcc 100644 --- a/common/djangoapps/edxmako/backend.py +++ b/common/djangoapps/edxmako/backend.py @@ -45,7 +45,7 @@ def from_string(self, template_code): return Template(template_code) except MakoException: message = text_error_template().render() - raise TemplateSyntaxError(message) # lint-amnesty, pylint: disable=raise-missing-from + raise TemplateSyntaxError(message) # pylint: disable=raise-missing-from # noqa: B904 def get_template(self, template_name): """ @@ -55,7 +55,7 @@ def get_template(self, template_name): try: return Template(lookup_template(self.namespace, template_name), engine=self) except TopLevelLookupException: - raise TemplateDoesNotExist(template_name) # lint-amnesty, pylint: disable=raise-missing-from + raise TemplateDoesNotExist(template_name) # pylint: disable=raise-missing-from # noqa: B904 @cached_property def template_context_processors(self): diff --git a/common/djangoapps/edxmako/makoloader.py b/common/djangoapps/edxmako/makoloader.py index f51dcf36b4ae..1f71cbba1bd5 100644 --- a/common/djangoapps/edxmako/makoloader.py +++ b/common/djangoapps/edxmako/makoloader.py @@ -1,4 +1,4 @@ -# lint-amnesty, pylint: disable=missing-module-docstring +# pylint: disable=missing-module-docstring import logging @@ -70,7 +70,7 @@ def load_template(self, template_name): try: template = Engine.get_default().from_string(source) return template - except ImproperlyConfigured: # lint-amnesty, pylint: disable=try-except-raise + except ImproperlyConfigured: # pylint: disable=try-except-raise # Either no DjangoTemplates engine was configured -or- multiple engines # were configured, making the get_default() call above fail. raise @@ -96,17 +96,17 @@ def reset(self): self.base_loader.reset() -class MakoFilesystemLoader(MakoLoader): # lint-amnesty, pylint: disable=missing-class-docstring +class MakoFilesystemLoader(MakoLoader): # pylint: disable=missing-class-docstring is_usable = True _accepts_engine_in_init = True def __init__(self, *args): - MakoLoader.__init__(self, FilesystemLoader(*args)) # lint-amnesty, pylint: disable=no-value-for-parameter + MakoLoader.__init__(self, FilesystemLoader(*args)) # pylint: disable=no-value-for-parameter -class MakoAppDirectoriesLoader(MakoLoader): # lint-amnesty, pylint: disable=missing-class-docstring +class MakoAppDirectoriesLoader(MakoLoader): # pylint: disable=missing-class-docstring is_usable = True _accepts_engine_in_init = True def __init__(self, *args): - MakoLoader.__init__(self, AppDirectoriesLoader(*args)) # lint-amnesty, pylint: disable=no-value-for-parameter + MakoLoader.__init__(self, AppDirectoriesLoader(*args)) # pylint: disable=no-value-for-parameter diff --git a/common/djangoapps/edxmako/paths.py b/common/djangoapps/edxmako/paths.py index 3da9844eedc2..68accd75ad73 100644 --- a/common/djangoapps/edxmako/paths.py +++ b/common/djangoapps/edxmako/paths.py @@ -3,8 +3,8 @@ """ import contextlib import hashlib -import os import importlib.resources as resources +import os from django.conf import settings from mako.exceptions import TopLevelLookupException @@ -22,7 +22,7 @@ class TopLevelTemplateURI(str): to the URI should be looked up straight in the standard edx-platform location instead of trying to locate an overridding template in the current theme first. """ - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass class DynamicTemplateLookup(TemplateLookup): @@ -35,7 +35,7 @@ def __init__(self, *args, **kwargs): self.__original_module_directory = self.template_args['module_directory'] def __repr__(self): - return "<{0.__class__.__name__} {0.directories}>".format(self) + return "<{0.__class__.__name__} {0.directories}>".format(self) # noqa: UP032 def add_directory(self, directory, prepend=False): """ diff --git a/common/djangoapps/edxmako/services.py b/common/djangoapps/edxmako/services.py index d300e32cf75a..79ff9c7fca4a 100644 --- a/common/djangoapps/edxmako/services.py +++ b/common/djangoapps/edxmako/services.py @@ -5,8 +5,8 @@ from django.template.utils import InvalidTemplateEngineError from xblock.reference.plugins import Service -from common.djangoapps.edxmako.shortcuts import render_to_string from common.djangoapps.edxmako import Engines +from common.djangoapps.edxmako.shortcuts import render_to_string try: engines[Engines.PREVIEW] @@ -54,7 +54,6 @@ def render_lms_template(self, template_file, dictionary): Templates which are in these dirs will only work with this function: edx-platform/lms/templates/ - edx-platform/xmodule/capa/templates/ openedx/features/course_experience/templates """ return render_to_string(template_file, dictionary, namespace=lms_mako_namespace) diff --git a/common/djangoapps/edxmako/shortcuts.py b/common/djangoapps/edxmako/shortcuts.py index a8b0e7a0d9f5..e075d413fd11 100644 --- a/common/djangoapps/edxmako/shortcuts.py +++ b/common/djangoapps/edxmako/shortcuts.py @@ -1,4 +1,4 @@ -# Copyright (c) 2008 Mikeal Rogers # lint-amnesty, pylint: disable=missing-module-docstring +# Copyright (c) 2008 Mikeal Rogers # pylint: disable=missing-module-docstring # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. @@ -16,16 +16,16 @@ import logging from django.conf import settings -from django.http import HttpResponse # lint-amnesty, pylint: disable=unused-import +from django.core.exceptions import ValidationError +from django.core.validators import URLValidator +from django.http import HttpResponse # pylint: disable=unused-import from django.template import engines -from django.urls import reverse, NoReverseMatch +from django.urls import NoReverseMatch, reverse +from edx_django_utils.monitoring import set_custom_attribute from six.moves.urllib.parse import urljoin -from django.core.validators import URLValidator -from django.core.exceptions import ValidationError -from edx_django_utils.monitoring import set_custom_attribute from openedx.core.djangoapps.site_configuration import helpers as configuration_helpers -from xmodule.util.xmodule_django import get_current_request_hostname # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.util.xmodule_django import get_current_request_hostname # pylint: disable=wrong-import-order from . import Engines @@ -85,7 +85,7 @@ def marketing_link(name): elif not enable_mktg_site and name in link_map: # don't try to reverse disabled marketing links if link_map[name] is not None: - host_name = get_current_request_hostname() # lint-amnesty, pylint: disable=unused-variable + host_name = get_current_request_hostname() # pylint: disable=unused-variable # noqa: F841 if link_map[name].startswith('http'): return link_map[name] else: diff --git a/common/djangoapps/edxmako/template.py b/common/djangoapps/edxmako/template.py index 855a2714b865..488312289958 100644 --- a/common/djangoapps/edxmako/template.py +++ b/common/djangoapps/edxmako/template.py @@ -1,4 +1,4 @@ -# Copyright (c) 2008 Mikeal Rogers # lint-amnesty, pylint: disable=missing-module-docstring +# Copyright (c) 2008 Mikeal Rogers # pylint: disable=missing-module-docstring # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. @@ -14,11 +14,11 @@ from django.conf import settings -from django.template import Context, engines, Origin +from django.template import Context, Origin, engines from edx_django_utils.cache import RequestCache from mako.template import Template as MakoTemplate -from . import Engines, LOOKUP +from . import LOOKUP, Engines from .request_context import get_template_request_context from .shortcuts import is_any_marketing_link_set, is_marketing_link_set, marketing_link @@ -39,7 +39,7 @@ def __init__(self, *args, **kwargs): self.engine = kwargs.pop('engine', engines[Engines.MAKO]) if kwargs.get('origin') is None: self.origin = Origin(UNKNOWN_SOURCE) - if len(args) and isinstance(args[0], MakoTemplate): # lint-amnesty, pylint: disable=len-as-condition + if len(args) and isinstance(args[0], MakoTemplate): # pylint: disable=len-as-condition self.mako_template = args[0] else: kwargs['lookup'] = LOOKUP['main'] diff --git a/common/djangoapps/edxmako/tests.py b/common/djangoapps/edxmako/tests.py index 51c2ab4efdd1..e81ea883910a 100644 --- a/common/djangoapps/edxmako/tests.py +++ b/common/djangoapps/edxmako/tests.py @@ -1,4 +1,4 @@ -# lint-amnesty, pylint: disable=cyclic-import, missing-module-docstring +# pylint: disable=cyclic-import, missing-module-docstring from unittest.mock import Mock, patch @@ -18,7 +18,7 @@ is_any_marketing_link_set, is_marketing_link_set, marketing_link, - render_to_string + render_to_string, ) from common.djangoapps.student.tests.factories import UserFactory from common.djangoapps.util.testing import UrlResetMixin @@ -71,7 +71,7 @@ def test_is_any_marketing_link_set(self): assert is_any_marketing_link_set(['ABOUT', 'NOT_CONFIGURED']) assert not is_any_marketing_link_set(['NOT_CONFIGURED']) - def _get_test_url_name(self): # lint-amnesty, pylint: disable=missing-function-docstring + def _get_test_url_name(self): # pylint: disable=missing-function-docstring if settings.ROOT_URLCONF == 'lms.urls': # return any lms url name return 'dashboard' diff --git a/common/djangoapps/entitlements/admin.py b/common/djangoapps/entitlements/admin.py index f635900ff2a8..eec9cdd80bb4 100644 --- a/common/djangoapps/entitlements/admin.py +++ b/common/djangoapps/entitlements/admin.py @@ -12,7 +12,7 @@ @admin.register(CourseEntitlement) -class CourseEntitlementAdmin(admin.ModelAdmin): # lint-amnesty, pylint: disable=missing-class-docstring +class CourseEntitlementAdmin(admin.ModelAdmin): # pylint: disable=missing-class-docstring list_display = ('user', 'uuid', 'course_uuid', @@ -36,7 +36,7 @@ def __init__(self, *args, **kwargs): try: self.data['unenrolled_run'] = CourseKey.from_string(self.data['unenrolled_run']) except InvalidKeyError: - raise forms.ValidationError("No valid CourseKey for id {}!".format(self.data['unenrolled_run'])) # lint-amnesty, pylint: disable=raise-missing-from + raise forms.ValidationError("No valid CourseKey for id {}!".format(self.data['unenrolled_run'])) # pylint: disable=raise-missing-from,line-too-long # noqa: B904 def clean_course_id(self): """Cleans course id and attempts to make course key from string version of key""" @@ -44,7 +44,7 @@ def clean_course_id(self): try: course_key = CourseKey.from_string(course_id) except InvalidKeyError: - raise forms.ValidationError(f"Cannot make a valid CourseKey from id {course_id}!") # lint-amnesty, pylint: disable=raise-missing-from + raise forms.ValidationError(f"Cannot make a valid CourseKey from id {course_id}!") # pylint: disable=raise-missing-from # noqa: B904 if not modulestore().has_course(course_key): raise forms.ValidationError(f"Cannot find course with id {course_id} in the modulestore") @@ -52,7 +52,7 @@ def clean_course_id(self): return course_key class Meta: - fields = '__all__' + fields = '__all__' # noqa: DJ007 model = CourseEntitlementSupportDetail @@ -77,7 +77,7 @@ def __init__(self, *args, **kwargs): self.fields['mode'].required = False class Meta: - fields = '__all__' + fields = '__all__' # noqa: DJ007 model = CourseEntitlementPolicy diff --git a/common/djangoapps/entitlements/apps.py b/common/djangoapps/entitlements/apps.py index 40a3d55e944a..cfee188a877b 100644 --- a/common/djangoapps/entitlements/apps.py +++ b/common/djangoapps/entitlements/apps.py @@ -18,5 +18,5 @@ def ready(self): """ Connect handlers to signals. """ - from . import signals # pylint: disable=unused-import - from .tasks import expire_old_entitlements # lint-amnesty, pylint: disable=unused-import + from . import signals # pylint: disable=unused-import # noqa: F401 + from .tasks import expire_old_entitlements # pylint: disable=unused-import # noqa: F401 diff --git a/common/djangoapps/entitlements/management/commands/expire_and_create_entitlements.py b/common/djangoapps/entitlements/management/commands/expire_and_create_entitlements.py index 482d8dc8fe5d..04d66dafc0a0 100644 --- a/common/djangoapps/entitlements/management/commands/expire_and_create_entitlements.py +++ b/common/djangoapps/entitlements/management/commands/expire_and_create_entitlements.py @@ -1,17 +1,17 @@ -# lint-amnesty, pylint: disable=django-not-configured +# pylint: disable=django-not-configured """ Management command for expiring entitlements older than 1 year / 18 months. """ import logging from datetime import date -from dateutil.relativedelta import relativedelta from math import ceil from textwrap import dedent +from dateutil.relativedelta import relativedelta from django.core.management import BaseCommand -from common.djangoapps.entitlements.tasks import expire_and_create_entitlements from common.djangoapps.entitlements.models import CourseEntitlement +from common.djangoapps.entitlements.tasks import expire_and_create_entitlements logger = logging.getLogger(__name__) # pylint: disable=invalid-name diff --git a/common/djangoapps/entitlements/management/commands/expire_old_entitlements.py b/common/djangoapps/entitlements/management/commands/expire_old_entitlements.py index 9abcfe1abb5e..6b66e9f8fa8b 100644 --- a/common/djangoapps/entitlements/management/commands/expire_old_entitlements.py +++ b/common/djangoapps/entitlements/management/commands/expire_old_entitlements.py @@ -1,4 +1,4 @@ -# lint-amnesty, pylint: disable=django-not-configured +# pylint: disable=django-not-configured """ Management command for expiring old entitlements. """ diff --git a/common/djangoapps/entitlements/management/commands/update_entitlement_mode.py b/common/djangoapps/entitlements/management/commands/update_entitlement_mode.py index 3d7b988bdeef..b835272223c0 100644 --- a/common/djangoapps/entitlements/management/commands/update_entitlement_mode.py +++ b/common/djangoapps/entitlements/management/commands/update_entitlement_mode.py @@ -1,4 +1,4 @@ -# lint-amnesty, pylint: disable=django-not-configured +# pylint: disable=django-not-configured """ Management command for updating entitlements modes. """ @@ -57,11 +57,11 @@ def handle(self, *args, **options): ) entitlement_to_update.mode = entitlement_mode entitlement_to_update.save() - logger.info('entitlement_mode updated to {} for ' + logger.info('entitlement_mode updated to {} for ' # noqa: UP032 'order_number {} for course with UUID {}'.format(entitlement_mode, order_number, course_uuid)) except CourseEntitlement.DoesNotExist: - logger.info('entitlement with order_number {} and course_uuid {} does not exists'.format( + logger.info('entitlement with order_number {} and course_uuid {} does not exists'.format( # noqa: UP032 order_number, course_uuid)) logger.info('Successfully updated entitlement_mode for Entitlements.') diff --git a/common/djangoapps/entitlements/migrations/0001_initial.py b/common/djangoapps/entitlements/migrations/0001_initial.py index 5b27fc4cbc9d..67a7af649651 100644 --- a/common/djangoapps/entitlements/migrations/0001_initial.py +++ b/common/djangoapps/entitlements/migrations/0001_initial.py @@ -6,7 +6,7 @@ from django.db import migrations, models -class Migration(migrations.Migration): # lint-amnesty, pylint: disable=missing-class-docstring +class Migration(migrations.Migration): # pylint: disable=missing-class-docstring dependencies = [ ('student', '0001_squashed_0031_auto_20200317_1122'), @@ -18,14 +18,14 @@ class Migration(migrations.Migration): # lint-amnesty, pylint: disable=missing- name='CourseEntitlement', fields=[ ('id', models.AutoField(verbose_name='ID', serialize=False, auto_created=True, primary_key=True)), - ('created', model_utils.fields.AutoCreatedField(default=django.utils.timezone.now, verbose_name='created', editable=False)), # lint-amnesty, pylint: disable=line-too-long - ('modified', model_utils.fields.AutoLastModifiedField(default=django.utils.timezone.now, verbose_name='modified', editable=False)), # lint-amnesty, pylint: disable=line-too-long + ('created', model_utils.fields.AutoCreatedField(default=django.utils.timezone.now, verbose_name='created', editable=False)), # pylint: disable=line-too-long + ('modified', model_utils.fields.AutoLastModifiedField(default=django.utils.timezone.now, verbose_name='modified', editable=False)), # pylint: disable=line-too-long ('uuid', models.UUIDField(default=uuid.uuid4, editable=False)), ('course_uuid', models.UUIDField()), ('expired_at', models.DateTimeField(null=True)), ('mode', models.CharField(default='audit', max_length=100)), ('order_number', models.CharField(max_length=128, null=True)), - ('enrollment_course_run', models.ForeignKey(to='student.CourseEnrollment', null=True, on_delete=models.CASCADE)), # lint-amnesty, pylint: disable=line-too-long + ('enrollment_course_run', models.ForeignKey(to='student.CourseEnrollment', null=True, on_delete=models.CASCADE)), # pylint: disable=line-too-long ('user', models.ForeignKey(to=settings.AUTH_USER_MODEL, on_delete=models.CASCADE)), ], options={ diff --git a/common/djangoapps/entitlements/migrations/0002_auto_20171102_0719.py b/common/djangoapps/entitlements/migrations/0002_auto_20171102_0719.py index 7cb69d3456db..72362bf165ba 100644 --- a/common/djangoapps/entitlements/migrations/0002_auto_20171102_0719.py +++ b/common/djangoapps/entitlements/migrations/0002_auto_20171102_0719.py @@ -19,12 +19,12 @@ class Migration(migrations.Migration): migrations.AlterField( model_name='courseentitlement', name='enrollment_course_run', - field=models.ForeignKey(to='student.CourseEnrollment', help_text='The current Course enrollment for this entitlement. If NULL the Learner has not enrolled.', null=True, on_delete=models.CASCADE), # lint-amnesty, pylint: disable=line-too-long + field=models.ForeignKey(to='student.CourseEnrollment', help_text='The current Course enrollment for this entitlement. If NULL the Learner has not enrolled.', null=True, on_delete=models.CASCADE), # pylint: disable=line-too-long ), migrations.AlterField( model_name='courseentitlement', name='expired_at', - field=models.DateTimeField(help_text='The date that an entitlement expired, if NULL the entitlement has not expired.', null=True), # lint-amnesty, pylint: disable=line-too-long + field=models.DateTimeField(help_text='The date that an entitlement expired, if NULL the entitlement has not expired.', null=True), # pylint: disable=line-too-long ), migrations.AlterField( model_name='courseentitlement', diff --git a/common/djangoapps/entitlements/migrations/0003_auto_20171205_1431.py b/common/djangoapps/entitlements/migrations/0003_auto_20171205_1431.py index 59e5cc2db7c5..f274574a50b5 100644 --- a/common/djangoapps/entitlements/migrations/0003_auto_20171205_1431.py +++ b/common/djangoapps/entitlements/migrations/0003_auto_20171205_1431.py @@ -3,7 +3,7 @@ from django.db import migrations, models -class Migration(migrations.Migration): # lint-amnesty, pylint: disable=missing-class-docstring +class Migration(migrations.Migration): # pylint: disable=missing-class-docstring dependencies = [ ('sites', '0001_initial'), @@ -15,25 +15,25 @@ class Migration(migrations.Migration): # lint-amnesty, pylint: disable=missing- name='CourseEntitlementPolicy', fields=[ ('id', models.AutoField(verbose_name='ID', serialize=False, auto_created=True, primary_key=True)), - ('expiration_period', models.DurationField(default=datetime.timedelta(450), help_text='Duration in days from when an entitlement is created until when it is expired.')), # lint-amnesty, pylint: disable=line-too-long - ('refund_period', models.DurationField(default=datetime.timedelta(60), help_text='Duration in days from when an entitlement is created until when it is no longer refundable')), # lint-amnesty, pylint: disable=line-too-long - ('regain_period', models.DurationField(default=datetime.timedelta(14), help_text='Duration in days from when an entitlement is redeemed for a course run until it is no longer able to be regained by a user.')), # lint-amnesty, pylint: disable=line-too-long + ('expiration_period', models.DurationField(default=datetime.timedelta(450), help_text='Duration in days from when an entitlement is created until when it is expired.')), # pylint: disable=line-too-long + ('refund_period', models.DurationField(default=datetime.timedelta(60), help_text='Duration in days from when an entitlement is created until when it is no longer refundable')), # pylint: disable=line-too-long + ('regain_period', models.DurationField(default=datetime.timedelta(14), help_text='Duration in days from when an entitlement is redeemed for a course run until it is no longer able to be regained by a user.')), # pylint: disable=line-too-long ('site', models.ForeignKey(to='sites.Site', on_delete=models.CASCADE)), ], ), migrations.AlterField( model_name='courseentitlement', name='enrollment_course_run', - field=models.ForeignKey(blank=True, to='student.CourseEnrollment', help_text='The current Course enrollment for this entitlement. If NULL the Learner has not enrolled.', null=True, on_delete=models.CASCADE), # lint-amnesty, pylint: disable=line-too-long + field=models.ForeignKey(blank=True, to='student.CourseEnrollment', help_text='The current Course enrollment for this entitlement. If NULL the Learner has not enrolled.', null=True, on_delete=models.CASCADE), # pylint: disable=line-too-long ), migrations.AlterField( model_name='courseentitlement', name='expired_at', - field=models.DateTimeField(help_text='The date that an entitlement expired, if NULL the entitlement has not expired.', null=True, blank=True), # lint-amnesty, pylint: disable=line-too-long + field=models.DateTimeField(help_text='The date that an entitlement expired, if NULL the entitlement has not expired.', null=True, blank=True), # pylint: disable=line-too-long ), migrations.AddField( model_name='courseentitlement', name='_policy', - field=models.ForeignKey(blank=True, to='entitlements.CourseEntitlementPolicy', null=True, on_delete=models.CASCADE), # lint-amnesty, pylint: disable=line-too-long + field=models.ForeignKey(blank=True, to='entitlements.CourseEntitlementPolicy', null=True, on_delete=models.CASCADE), # pylint: disable=line-too-long ), ] diff --git a/common/djangoapps/entitlements/migrations/0004_auto_20171206_1729.py b/common/djangoapps/entitlements/migrations/0004_auto_20171206_1729.py index c6087f03f505..4aa6a8f8c021 100644 --- a/common/djangoapps/entitlements/migrations/0004_auto_20171206_1729.py +++ b/common/djangoapps/entitlements/migrations/0004_auto_20171206_1729.py @@ -3,7 +3,7 @@ from django.db import migrations, models -class Migration(migrations.Migration): # lint-amnesty, pylint: disable=missing-class-docstring +class Migration(migrations.Migration): # pylint: disable=missing-class-docstring dependencies = [ ('entitlements', '0003_auto_20171205_1431'), diff --git a/common/djangoapps/entitlements/migrations/0005_courseentitlementsupportdetail.py b/common/djangoapps/entitlements/migrations/0005_courseentitlementsupportdetail.py index 1d64eba2829d..0306fa1acc52 100644 --- a/common/djangoapps/entitlements/migrations/0005_courseentitlementsupportdetail.py +++ b/common/djangoapps/entitlements/migrations/0005_courseentitlementsupportdetail.py @@ -4,7 +4,7 @@ from django.db import migrations, models -class Migration(migrations.Migration): # lint-amnesty, pylint: disable=missing-class-docstring +class Migration(migrations.Migration): # pylint: disable=missing-class-docstring dependencies = [ ('course_overviews', '0014_courseoverview_certificate_available_date'), @@ -17,13 +17,13 @@ class Migration(migrations.Migration): # lint-amnesty, pylint: disable=missing- name='CourseEntitlementSupportDetail', fields=[ ('id', models.AutoField(verbose_name='ID', serialize=False, auto_created=True, primary_key=True)), - ('created', model_utils.fields.AutoCreatedField(default=django.utils.timezone.now, verbose_name='created', editable=False)), # lint-amnesty, pylint: disable=line-too-long - ('modified', model_utils.fields.AutoLastModifiedField(default=django.utils.timezone.now, verbose_name='modified', editable=False)), # lint-amnesty, pylint: disable=line-too-long - ('reason', models.CharField(max_length=15, choices=[('LEAVE', 'Learner requested leave session for expired entitlement'), ('CHANGE', 'Learner requested session change for expired entitlement'), ('LEARNER_NEW', 'Learner requested new entitlement'), ('COURSE_TEAM_NEW', 'Course team requested entitlement for learnerg'), ('OTHER', 'Other')])), # lint-amnesty, pylint: disable=line-too-long + ('created', model_utils.fields.AutoCreatedField(default=django.utils.timezone.now, verbose_name='created', editable=False)), # pylint: disable=line-too-long + ('modified', model_utils.fields.AutoLastModifiedField(default=django.utils.timezone.now, verbose_name='modified', editable=False)), # pylint: disable=line-too-long + ('reason', models.CharField(max_length=15, choices=[('LEAVE', 'Learner requested leave session for expired entitlement'), ('CHANGE', 'Learner requested session change for expired entitlement'), ('LEARNER_NEW', 'Learner requested new entitlement'), ('COURSE_TEAM_NEW', 'Course team requested entitlement for learnerg'), ('OTHER', 'Other')])), # pylint: disable=line-too-long ('comments', models.TextField(null=True)), ('entitlement', models.ForeignKey(to='entitlements.CourseEntitlement', on_delete=models.CASCADE)), ('support_user', models.ForeignKey(to=settings.AUTH_USER_MODEL, on_delete=models.CASCADE)), - ('unenrolled_run', models.ForeignKey(db_constraint=False, blank=True, to='course_overviews.CourseOverview', null=True, on_delete=models.CASCADE)), # lint-amnesty, pylint: disable=line-too-long + ('unenrolled_run', models.ForeignKey(db_constraint=False, blank=True, to='course_overviews.CourseOverview', null=True, on_delete=models.CASCADE)), # pylint: disable=line-too-long ], options={ 'abstract': False, diff --git a/common/djangoapps/entitlements/migrations/0006_courseentitlementsupportdetail_action.py b/common/djangoapps/entitlements/migrations/0006_courseentitlementsupportdetail_action.py index 397dd3bc0dc2..902ff2504ccf 100644 --- a/common/djangoapps/entitlements/migrations/0006_courseentitlementsupportdetail_action.py +++ b/common/djangoapps/entitlements/migrations/0006_courseentitlementsupportdetail_action.py @@ -1,7 +1,7 @@ from django.db import migrations, models -class Migration(migrations.Migration): # lint-amnesty, pylint: disable=missing-class-docstring +class Migration(migrations.Migration): # pylint: disable=missing-class-docstring dependencies = [ ('entitlements', '0005_courseentitlementsupportdetail'), @@ -11,7 +11,7 @@ class Migration(migrations.Migration): # lint-amnesty, pylint: disable=missing- migrations.AddField( model_name='courseentitlementsupportdetail', name='action', - field=models.CharField(default='CREATE', max_length=15, choices=[('REISSUE', 'Re-issue entitlement'), ('CREATE', 'Create new entitlement')]), # lint-amnesty, pylint: disable=line-too-long + field=models.CharField(default='CREATE', max_length=15, choices=[('REISSUE', 'Re-issue entitlement'), ('CREATE', 'Create new entitlement')]), # pylint: disable=line-too-long preserve_default=False, ), ] diff --git a/common/djangoapps/entitlements/migrations/0007_change_expiration_period_default.py b/common/djangoapps/entitlements/migrations/0007_change_expiration_period_default.py index 50509209124a..2b1025453d50 100644 --- a/common/djangoapps/entitlements/migrations/0007_change_expiration_period_default.py +++ b/common/djangoapps/entitlements/migrations/0007_change_expiration_period_default.py @@ -3,7 +3,7 @@ from django.db import migrations, models -class Migration(migrations.Migration): # lint-amnesty, pylint: disable=missing-class-docstring +class Migration(migrations.Migration): # pylint: disable=missing-class-docstring dependencies = [ ('entitlements', '0006_courseentitlementsupportdetail_action'), @@ -13,6 +13,6 @@ class Migration(migrations.Migration): # lint-amnesty, pylint: disable=missing- migrations.AlterField( model_name='courseentitlementpolicy', name='expiration_period', - field=models.DurationField(default=datetime.timedelta(730), help_text='Duration in days from when an entitlement is created until when it is expired.'), # lint-amnesty, pylint: disable=line-too-long + field=models.DurationField(default=datetime.timedelta(730), help_text='Duration in days from when an entitlement is created until when it is expired.'), # pylint: disable=line-too-long ), ] diff --git a/common/djangoapps/entitlements/migrations/0008_auto_20180328_1107.py b/common/djangoapps/entitlements/migrations/0008_auto_20180328_1107.py index edaa38d98613..21b787655620 100644 --- a/common/djangoapps/entitlements/migrations/0008_auto_20180328_1107.py +++ b/common/djangoapps/entitlements/migrations/0008_auto_20180328_1107.py @@ -1,7 +1,7 @@ from django.db import migrations, models -class Migration(migrations.Migration): # lint-amnesty, pylint: disable=missing-class-docstring +class Migration(migrations.Migration): # pylint: disable=missing-class-docstring dependencies = [ ('entitlements', '0007_change_expiration_period_default'), @@ -11,7 +11,7 @@ class Migration(migrations.Migration): # lint-amnesty, pylint: disable=missing- migrations.AddField( model_name='courseentitlementpolicy', name='mode', - field=models.CharField(max_length=32, null=True, choices=[(None, '---------'), ('verified', 'verified'), ('professional', 'professional')]), # lint-amnesty, pylint: disable=line-too-long + field=models.CharField(max_length=32, null=True, choices=[(None, '---------'), ('verified', 'verified'), ('professional', 'professional')]), # pylint: disable=line-too-long ), migrations.AlterField( model_name='courseentitlementpolicy', diff --git a/common/djangoapps/entitlements/migrations/0009_courseentitlement_refund_locked.py b/common/djangoapps/entitlements/migrations/0009_courseentitlement_refund_locked.py index 23be4c694231..0751a7b2b208 100644 --- a/common/djangoapps/entitlements/migrations/0009_courseentitlement_refund_locked.py +++ b/common/djangoapps/entitlements/migrations/0009_courseentitlement_refund_locked.py @@ -4,7 +4,7 @@ from django.db import migrations, models -class Migration(migrations.Migration): # lint-amnesty, pylint: disable=missing-class-docstring +class Migration(migrations.Migration): # pylint: disable=missing-class-docstring dependencies = [ ('entitlements', '0008_auto_20180328_1107'), diff --git a/common/djangoapps/entitlements/migrations/0010_backfill_refund_lock.py b/common/djangoapps/entitlements/migrations/0010_backfill_refund_lock.py index d720a404340e..218de318f12a 100644 --- a/common/djangoapps/entitlements/migrations/0010_backfill_refund_lock.py +++ b/common/djangoapps/entitlements/migrations/0010_backfill_refund_lock.py @@ -1,23 +1,23 @@ -from datetime import datetime # lint-amnesty, pylint: disable=unused-import +from datetime import datetime # pylint: disable=unused-import -from django.db import migrations, models # lint-amnesty, pylint: disable=unused-import +from django.db import migrations, models # pylint: disable=unused-import -def backfill_refundability(apps, schema_editor): # lint-amnesty, pylint: disable=unused-argument +def backfill_refundability(apps, schema_editor): # pylint: disable=unused-argument CourseEntitlementSupportDetail = apps.get_model('entitlements', 'CourseEntitlementSupportDetail') for support_detail in CourseEntitlementSupportDetail.objects.all().select_related('entitlement'): support_detail.entitlement.refund_locked = True support_detail.entitlement.save() -def revert_backfill(apps, schema_editor): # lint-amnesty, pylint: disable=unused-argument +def revert_backfill(apps, schema_editor): # pylint: disable=unused-argument CourseEntitlementSupportDetail = apps.get_model('entitlements', 'CourseEntitlementSupportDetail') for support_detail in CourseEntitlementSupportDetail.objects.all().select_related('entitlement'): support_detail.entitlement.refund_locked = False support_detail.entitlement.save() -class Migration(migrations.Migration): # lint-amnesty, pylint: disable=missing-class-docstring +class Migration(migrations.Migration): # pylint: disable=missing-class-docstring dependencies = [ ('entitlements', '0009_courseentitlement_refund_locked'), diff --git a/common/djangoapps/entitlements/migrations/0011_historicalcourseentitlement.py b/common/djangoapps/entitlements/migrations/0011_historicalcourseentitlement.py index def96d3e9920..6d30fc232b9a 100644 --- a/common/djangoapps/entitlements/migrations/0011_historicalcourseentitlement.py +++ b/common/djangoapps/entitlements/migrations/0011_historicalcourseentitlement.py @@ -1,16 +1,17 @@ # Generated by Django 1.11.20 on 2019-05-30 21:13 -from django.conf import settings -from django.db import migrations, models +import uuid + import django.db.models.deletion import django.utils.timezone import model_utils.fields import simple_history.models -import uuid +from django.conf import settings +from django.db import migrations, models -class Migration(migrations.Migration): # lint-amnesty, pylint: disable=missing-class-docstring +class Migration(migrations.Migration): # pylint: disable=missing-class-docstring dependencies = [ ('student', '0001_squashed_0031_auto_20200317_1122'), @@ -23,22 +24,22 @@ class Migration(migrations.Migration): # lint-amnesty, pylint: disable=missing- name='HistoricalCourseEntitlement', fields=[ ('id', models.IntegerField(auto_created=True, blank=True, db_index=True, verbose_name='ID')), - ('created', model_utils.fields.AutoCreatedField(default=django.utils.timezone.now, editable=False, verbose_name='created')), # lint-amnesty, pylint: disable=line-too-long - ('modified', model_utils.fields.AutoLastModifiedField(default=django.utils.timezone.now, editable=False, verbose_name='modified')), # lint-amnesty, pylint: disable=line-too-long + ('created', model_utils.fields.AutoCreatedField(default=django.utils.timezone.now, editable=False, verbose_name='created')), # pylint: disable=line-too-long + ('modified', model_utils.fields.AutoLastModifiedField(default=django.utils.timezone.now, editable=False, verbose_name='modified')), # pylint: disable=line-too-long ('uuid', models.UUIDField(db_index=True, default=uuid.uuid4, editable=False)), ('course_uuid', models.UUIDField(help_text='UUID for the Course, not the Course Run')), - ('expired_at', models.DateTimeField(blank=True, help_text='The date that an entitlement expired, if NULL the entitlement has not expired.', null=True)), # lint-amnesty, pylint: disable=line-too-long - ('mode', models.CharField(help_text='The mode of the Course that will be applied on enroll.', max_length=100)), # lint-amnesty, pylint: disable=line-too-long + ('expired_at', models.DateTimeField(blank=True, help_text='The date that an entitlement expired, if NULL the entitlement has not expired.', null=True)), # pylint: disable=line-too-long + ('mode', models.CharField(help_text='The mode of the Course that will be applied on enroll.', max_length=100)), # pylint: disable=line-too-long ('order_number', models.CharField(max_length=128, null=True)), ('refund_locked', models.BooleanField(default=False)), ('history_id', models.AutoField(primary_key=True, serialize=False)), ('history_date', models.DateTimeField()), ('history_change_reason', models.CharField(max_length=100, null=True)), - ('history_type', models.CharField(choices=[('+', 'Created'), ('~', 'Changed'), ('-', 'Deleted')], max_length=1)), # lint-amnesty, pylint: disable=line-too-long - ('_policy', models.ForeignKey(blank=True, db_constraint=False, null=True, on_delete=django.db.models.deletion.DO_NOTHING, related_name='+', to='entitlements.CourseEntitlementPolicy')), # lint-amnesty, pylint: disable=line-too-long - ('enrollment_course_run', models.ForeignKey(blank=True, db_constraint=False, help_text='The current Course enrollment for this entitlement. If NULL the Learner has not enrolled.', null=True, on_delete=django.db.models.deletion.DO_NOTHING, related_name='+', to='student.CourseEnrollment')), # lint-amnesty, pylint: disable=line-too-long - ('history_user', models.ForeignKey(null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='+', to=settings.AUTH_USER_MODEL)), # lint-amnesty, pylint: disable=line-too-long - ('user', models.ForeignKey(blank=True, db_constraint=False, null=True, on_delete=django.db.models.deletion.DO_NOTHING, related_name='+', to=settings.AUTH_USER_MODEL)), # lint-amnesty, pylint: disable=line-too-long + ('history_type', models.CharField(choices=[('+', 'Created'), ('~', 'Changed'), ('-', 'Deleted')], max_length=1)), # pylint: disable=line-too-long + ('_policy', models.ForeignKey(blank=True, db_constraint=False, null=True, on_delete=django.db.models.deletion.DO_NOTHING, related_name='+', to='entitlements.CourseEntitlementPolicy')), # pylint: disable=line-too-long + ('enrollment_course_run', models.ForeignKey(blank=True, db_constraint=False, help_text='The current Course enrollment for this entitlement. If NULL the Learner has not enrolled.', null=True, on_delete=django.db.models.deletion.DO_NOTHING, related_name='+', to='student.CourseEnrollment')), # pylint: disable=line-too-long + ('history_user', models.ForeignKey(null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='+', to=settings.AUTH_USER_MODEL)), # pylint: disable=line-too-long + ('user', models.ForeignKey(blank=True, db_constraint=False, null=True, on_delete=django.db.models.deletion.DO_NOTHING, related_name='+', to=settings.AUTH_USER_MODEL)), # pylint: disable=line-too-long ], options={ 'ordering': ('-history_date', '-history_id'), diff --git a/common/djangoapps/entitlements/migrations/0012_allow_blank_order_number_values.py b/common/djangoapps/entitlements/migrations/0012_allow_blank_order_number_values.py index f751f5c7d99e..84fa752f43d9 100644 --- a/common/djangoapps/entitlements/migrations/0012_allow_blank_order_number_values.py +++ b/common/djangoapps/entitlements/migrations/0012_allow_blank_order_number_values.py @@ -4,7 +4,7 @@ from django.db import migrations, models -class Migration(migrations.Migration): # lint-amnesty, pylint: disable=missing-class-docstring +class Migration(migrations.Migration): # pylint: disable=missing-class-docstring dependencies = [ ('entitlements', '0011_historicalcourseentitlement'), diff --git a/common/djangoapps/entitlements/migrations/0013_historicalcourseentitlementsupportdetail.py b/common/djangoapps/entitlements/migrations/0013_historicalcourseentitlementsupportdetail.py index e80a5e9ce2c2..2ac38806ba5e 100644 --- a/common/djangoapps/entitlements/migrations/0013_historicalcourseentitlementsupportdetail.py +++ b/common/djangoapps/entitlements/migrations/0013_historicalcourseentitlementsupportdetail.py @@ -1,15 +1,15 @@ # Generated by Django 1.11.26 on 2019-12-17 14:08 -from django.conf import settings -from django.db import migrations, models import django.db.models.deletion import django.utils.timezone import model_utils.fields import simple_history.models +from django.conf import settings +from django.db import migrations, models -class Migration(migrations.Migration): # lint-amnesty, pylint: disable=missing-class-docstring +class Migration(migrations.Migration): # pylint: disable=missing-class-docstring dependencies = [ ('course_overviews', '0017_auto_20191002_0823'), @@ -22,19 +22,19 @@ class Migration(migrations.Migration): # lint-amnesty, pylint: disable=missing- name='HistoricalCourseEntitlementSupportDetail', fields=[ ('id', models.IntegerField(auto_created=True, blank=True, db_index=True, verbose_name='ID')), - ('created', model_utils.fields.AutoCreatedField(default=django.utils.timezone.now, editable=False, verbose_name='created')), # lint-amnesty, pylint: disable=line-too-long - ('modified', model_utils.fields.AutoLastModifiedField(default=django.utils.timezone.now, editable=False, verbose_name='modified')), # lint-amnesty, pylint: disable=line-too-long - ('reason', models.CharField(choices=[('LEAVE', 'Learner requested leave session for expired entitlement'), ('CHANGE', 'Learner requested session change for expired entitlement'), ('LEARNER_NEW', 'Learner requested new entitlement'), ('COURSE_TEAM_NEW', 'Course team requested entitlement for learnerg'), ('OTHER', 'Other')], max_length=15)), # lint-amnesty, pylint: disable=line-too-long - ('action', models.CharField(choices=[('REISSUE', 'Re-issue entitlement'), ('CREATE', 'Create new entitlement')], max_length=15)), # lint-amnesty, pylint: disable=line-too-long + ('created', model_utils.fields.AutoCreatedField(default=django.utils.timezone.now, editable=False, verbose_name='created')), # pylint: disable=line-too-long + ('modified', model_utils.fields.AutoLastModifiedField(default=django.utils.timezone.now, editable=False, verbose_name='modified')), # pylint: disable=line-too-long + ('reason', models.CharField(choices=[('LEAVE', 'Learner requested leave session for expired entitlement'), ('CHANGE', 'Learner requested session change for expired entitlement'), ('LEARNER_NEW', 'Learner requested new entitlement'), ('COURSE_TEAM_NEW', 'Course team requested entitlement for learnerg'), ('OTHER', 'Other')], max_length=15)), # pylint: disable=line-too-long + ('action', models.CharField(choices=[('REISSUE', 'Re-issue entitlement'), ('CREATE', 'Create new entitlement')], max_length=15)), # pylint: disable=line-too-long ('comments', models.TextField(null=True)), ('history_id', models.AutoField(primary_key=True, serialize=False)), ('history_date', models.DateTimeField()), ('history_change_reason', models.CharField(max_length=100, null=True)), - ('history_type', models.CharField(choices=[('+', 'Created'), ('~', 'Changed'), ('-', 'Deleted')], max_length=1)), # lint-amnesty, pylint: disable=line-too-long - ('entitlement', models.ForeignKey(blank=True, db_constraint=False, null=True, on_delete=django.db.models.deletion.DO_NOTHING, related_name='+', to='entitlements.CourseEntitlement')), # lint-amnesty, pylint: disable=line-too-long - ('history_user', models.ForeignKey(null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='+', to=settings.AUTH_USER_MODEL)), # lint-amnesty, pylint: disable=line-too-long - ('support_user', models.ForeignKey(blank=True, db_constraint=False, null=True, on_delete=django.db.models.deletion.DO_NOTHING, related_name='+', to=settings.AUTH_USER_MODEL)), # lint-amnesty, pylint: disable=line-too-long - ('unenrolled_run', models.ForeignKey(blank=True, db_constraint=False, null=True, on_delete=django.db.models.deletion.DO_NOTHING, related_name='+', to='course_overviews.CourseOverview')), # lint-amnesty, pylint: disable=line-too-long + ('history_type', models.CharField(choices=[('+', 'Created'), ('~', 'Changed'), ('-', 'Deleted')], max_length=1)), # pylint: disable=line-too-long + ('entitlement', models.ForeignKey(blank=True, db_constraint=False, null=True, on_delete=django.db.models.deletion.DO_NOTHING, related_name='+', to='entitlements.CourseEntitlement')), # pylint: disable=line-too-long + ('history_user', models.ForeignKey(null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='+', to=settings.AUTH_USER_MODEL)), # pylint: disable=line-too-long + ('support_user', models.ForeignKey(blank=True, db_constraint=False, null=True, on_delete=django.db.models.deletion.DO_NOTHING, related_name='+', to=settings.AUTH_USER_MODEL)), # pylint: disable=line-too-long + ('unenrolled_run', models.ForeignKey(blank=True, db_constraint=False, null=True, on_delete=django.db.models.deletion.DO_NOTHING, related_name='+', to='course_overviews.CourseOverview')), # pylint: disable=line-too-long ], options={ 'ordering': ('-history_date', '-history_id'), diff --git a/common/djangoapps/entitlements/migrations/0014_auto_20200115_2022.py b/common/djangoapps/entitlements/migrations/0014_auto_20200115_2022.py index 2cf1ba1643fa..ddddbb015449 100644 --- a/common/djangoapps/entitlements/migrations/0014_auto_20200115_2022.py +++ b/common/djangoapps/entitlements/migrations/0014_auto_20200115_2022.py @@ -5,7 +5,7 @@ from django.db import migrations, models -class Migration(migrations.Migration): # lint-amnesty, pylint: disable=missing-class-docstring +class Migration(migrations.Migration): # pylint: disable=missing-class-docstring dependencies = [ ('entitlements', '0013_historicalcourseentitlementsupportdetail'), @@ -15,6 +15,6 @@ class Migration(migrations.Migration): # lint-amnesty, pylint: disable=missing- migrations.AlterField( model_name='courseentitlementsupportdetail', name='unenrolled_run', - field=models.ForeignKey(blank=True, db_constraint=False, null=True, on_delete=django.db.models.deletion.DO_NOTHING, to='course_overviews.CourseOverview'), # lint-amnesty, pylint: disable=line-too-long + field=models.ForeignKey(blank=True, db_constraint=False, null=True, on_delete=django.db.models.deletion.DO_NOTHING, to='course_overviews.CourseOverview'), # pylint: disable=line-too-long ), ] diff --git a/common/djangoapps/entitlements/migrations/0015_add_unique_together_constraint.py b/common/djangoapps/entitlements/migrations/0015_add_unique_together_constraint.py index 340a0360b8c0..0abe6f5ddf1f 100644 --- a/common/djangoapps/entitlements/migrations/0015_add_unique_together_constraint.py +++ b/common/djangoapps/entitlements/migrations/0015_add_unique_together_constraint.py @@ -4,7 +4,7 @@ from django.db import migrations, models -class Migration(migrations.Migration): # lint-amnesty, pylint: disable=missing-class-docstring +class Migration(migrations.Migration): # pylint: disable=missing-class-docstring dependencies = [ ('entitlements', '0014_auto_20200115_2022'), diff --git a/common/djangoapps/entitlements/models.py b/common/djangoapps/entitlements/models.py index 78559c538011..d032de377c4e 100644 --- a/common/djangoapps/entitlements/models.py +++ b/common/djangoapps/entitlements/models.py @@ -8,7 +8,6 @@ from django.conf import settings from django.contrib.sites.models import Site from django.db import IntegrityError, models, transaction - from django.utils.timezone import now from model_utils import Choices from model_utils.models import TimeStampedModel @@ -57,7 +56,7 @@ class CourseEntitlementPolicy(models.Model): null=False ) site = models.ForeignKey(Site, null=True, on_delete=models.CASCADE) - mode = models.CharField(max_length=32, choices=MODES, null=True) + mode = models.CharField(max_length=32, choices=MODES, null=True) # noqa: DJ001 def get_days_until_expiration(self, entitlement): """ @@ -142,9 +141,9 @@ def is_entitlement_redeemable(self, entitlement): and not entitlement.enrollment_course_run and not entitlement.expired_at) - def __str__(self): + def __str__(self): # noqa: DJ012 return 'Course Entitlement Policy: expiration_period: {}, refund_period: {}, regain_period: {}, mode: {}'\ - .format( + .format( # noqa: UP032 self.expiration_period, self.refund_period, self.regain_period, @@ -174,7 +173,7 @@ class CourseEntitlement(TimeStampedModel): blank=True, on_delete=models.CASCADE, ) - order_number = models.CharField(max_length=128, default=None, null=True) + order_number = models.CharField(max_length=128, default=None, null=True) # noqa: DJ001 refund_locked = models.BooleanField(default=False) _policy = models.ForeignKey(CourseEntitlementPolicy, null=True, blank=True, on_delete=models.CASCADE) @@ -497,7 +496,7 @@ class CourseEntitlementSupportDetail(TimeStampedModel): reason = models.CharField(max_length=15, choices=ENTITLEMENT_SUPPORT_REASONS) action = models.CharField(max_length=15, choices=ENTITLEMENT_SUPPORT_ACTIONS) - comments = models.TextField(null=True) + comments = models.TextField(null=True) # noqa: DJ001 unenrolled_run = models.ForeignKey( CourseOverview, @@ -511,7 +510,7 @@ class CourseEntitlementSupportDetail(TimeStampedModel): def __str__(self): """Unicode representation of an Entitlement""" - return 'Course Entitlement Support Detail: entitlement: {}, support_user: {}, reason: {}'.format( + return 'Course Entitlement Support Detail: entitlement: {}, support_user: {}, reason: {}'.format( # noqa: UP032 self.entitlement, self.support_user, self.reason, diff --git a/common/djangoapps/entitlements/rest_api/urls.py b/common/djangoapps/entitlements/rest_api/urls.py index 740bce95a7c2..154e0919fe6d 100644 --- a/common/djangoapps/entitlements/rest_api/urls.py +++ b/common/djangoapps/entitlements/rest_api/urls.py @@ -2,8 +2,7 @@ URLs file for the Entitlements API. """ -from django.urls import include -from django.urls import path +from django.urls import include, path app_name = 'entitlements' urlpatterns = [ diff --git a/common/djangoapps/entitlements/rest_api/v1/tests/test_views.py b/common/djangoapps/entitlements/rest_api/v1/tests/test_views.py index 2f007ae6ed3b..9daa161cd7fb 100644 --- a/common/djangoapps/entitlements/rest_api/v1/tests/test_views.py +++ b/common/djangoapps/entitlements/rest_api/v1/tests/test_views.py @@ -23,18 +23,19 @@ from openedx.core.djangoapps.site_configuration.tests.factories import SiteFactory from openedx.core.djangoapps.user_api.models import UserOrgTag from openedx.core.djangolib.testing.utils import skip_unless_lms -from xmodule.modulestore.tests.django_utils import \ - ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + ModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order log = logging.getLogger(__name__) # Entitlements is not in CMS' INSTALLED_APPS so these imports will error during test collection if settings.ROOT_URLCONF == 'lms.urls': - from common.djangoapps.entitlements.models import ( # lint-amnesty, pylint: disable=line-too-long + from common.djangoapps.entitlements.models import ( # pylint: disable=line-too-long CourseEntitlement, CourseEntitlementPolicy, - CourseEntitlementSupportDetail + CourseEntitlementSupportDetail, ) from common.djangoapps.entitlements.rest_api.v1.serializers import CourseEntitlementSerializer from common.djangoapps.entitlements.rest_api.v1.views import set_entitlement_policy @@ -606,7 +607,7 @@ def test_staff_get_expired_entitlements(self): assert response.status_code == 200 results = response.data.get('results', []) # Make sure that the first result isn't expired, and the second one is also not for staff users - assert results[0].get('expired_at') is None and results[1].get('expired_at') is None + assert results[0].get('expired_at') is None and results[1].get('expired_at') is None # noqa: PT018 def test_get_user_expired_entitlements(self): past_datetime = now() - timedelta(days=365 * 2) @@ -627,7 +628,7 @@ def test_get_user_expired_entitlements(self): assert response.status_code == 200 results = response.data.get('results', []) - assert results[0].get('expired_at') is None and results[1].get('expired_at') + assert results[0].get('expired_at') is None and results[1].get('expired_at') # noqa: PT018 def test_get_user_entitlements(self): user2 = UserFactory() @@ -657,7 +658,7 @@ def test_get_entitlement_by_uuid(self): assert response.status_code == 200 results = response.data - assert results == CourseEntitlementSerializer(entitlement).data and results.get('expired_at') is None + assert results == CourseEntitlementSerializer(entitlement).data and results.get('expired_at') is None # noqa: PT018 # pylint: disable=line-too-long def test_get_expired_entitlement_by_uuid(self): past_datetime = now() - timedelta(days=365 * 2) @@ -1049,7 +1050,7 @@ def test_already_enrolled_course_ended(self, mock_get_course_runs): assert response.status_code == 201 assert CourseEnrollment.is_enrolled(self.user, self.course.id) (enrolled_mode, is_active) = CourseEnrollment.enrollment_mode_for_user(self.user, self.course.id) - assert is_active and (enrolled_mode == course_entitlement.mode) + assert is_active and (enrolled_mode == course_entitlement.mode) # noqa: PT018 assert course_entitlement.enrollment_course_run is not None @patch("common.djangoapps.entitlements.rest_api.v1.views.get_course_runs_for_course") @@ -1076,7 +1077,7 @@ def test_user_already_enrolled_in_unpaid_mode(self, mock_get_course_runs): assert response.status_code == 201 assert CourseEnrollment.is_enrolled(self.user, self.course.id) (enrolled_mode, is_active) = CourseEnrollment.enrollment_mode_for_user(self.user, self.course.id) - assert is_active and (enrolled_mode == course_entitlement.mode) + assert is_active and (enrolled_mode == course_entitlement.mode) # noqa: PT018 assert course_entitlement.enrollment_course_run is not None @patch("common.djangoapps.entitlements.rest_api.v1.views.get_course_runs_for_course") @@ -1147,7 +1148,7 @@ def test_user_can_revoke_and_refund(self, mock_course_uuid, mock_get_course_runs assert course_entitlement.enrollment_course_run is None assert course_entitlement.expired_at is not None - @patch('common.djangoapps.entitlements.rest_api.v1.views.CourseEntitlement.is_entitlement_refundable', return_value=False) # lint-amnesty, pylint: disable=line-too-long + @patch('common.djangoapps.entitlements.rest_api.v1.views.CourseEntitlement.is_entitlement_refundable', return_value=False) # pylint: disable=line-too-long @patch('common.djangoapps.entitlements.models.refund_entitlement', return_value=True) @patch('common.djangoapps.entitlements.rest_api.v1.views.get_course_runs_for_course') def test_user_can_revoke_and_no_refund_available( @@ -1191,7 +1192,7 @@ def test_user_can_revoke_and_no_refund_available( assert course_entitlement.enrollment_course_run is not None assert course_entitlement.expired_at is None - @patch('common.djangoapps.entitlements.rest_api.v1.views.CourseEntitlement.is_entitlement_refundable', return_value=True) # lint-amnesty, pylint: disable=line-too-long + @patch('common.djangoapps.entitlements.rest_api.v1.views.CourseEntitlement.is_entitlement_refundable', return_value=True) # pylint: disable=line-too-long @patch('common.djangoapps.entitlements.models.refund_entitlement', return_value=False) @patch("common.djangoapps.entitlements.rest_api.v1.views.get_course_runs_for_course") def test_user_is_not_unenrolled_on_failed_refund( diff --git a/common/djangoapps/entitlements/rest_api/v1/urls.py b/common/djangoapps/entitlements/rest_api/v1/urls.py index e04341b5ef50..434fb356403f 100644 --- a/common/djangoapps/entitlements/rest_api/v1/urls.py +++ b/common/djangoapps/entitlements/rest_api/v1/urls.py @@ -2,8 +2,7 @@ URLs for the V1 of the Entitlements API. """ -from django.urls import include -from django.urls import path, re_path +from django.urls import include, path, re_path from rest_framework.routers import DefaultRouter from .views import EntitlementEnrollmentViewSet, EntitlementViewSet diff --git a/common/djangoapps/entitlements/rest_api/v1/views.py b/common/djangoapps/entitlements/rest_api/v1/views.py index 4f3dd54b52a7..e1cd60ffdb5e 100644 --- a/common/djangoapps/entitlements/rest_api/v1/views.py +++ b/common/djangoapps/entitlements/rest_api/v1/views.py @@ -17,10 +17,10 @@ from rest_framework.response import Response from common.djangoapps.course_modes.models import CourseMode -from common.djangoapps.entitlements.models import ( # lint-amnesty, pylint: disable=line-too-long +from common.djangoapps.entitlements.models import ( # pylint: disable=line-too-long CourseEntitlement, CourseEntitlementPolicy, - CourseEntitlementSupportDetail + CourseEntitlementSupportDetail, ) from common.djangoapps.entitlements.rest_api.v1.filters import CourseEntitlementFilter from common.djangoapps.entitlements.rest_api.v1.permissions import IsAdminOrSupportOrAuthenticatedReadOnly @@ -225,7 +225,7 @@ def create(self, request, *args, **kwargs): status=status.HTTP_201_CREATED, headers=headers ) - def retrieve(self, request, *args, **kwargs): # lint-amnesty, pylint: disable=unused-argument + def retrieve(self, request, *args, **kwargs): # pylint: disable=unused-argument """ Override the retrieve method to expire a record that is past the policy and is requested via the API before returning that record. @@ -235,7 +235,7 @@ def retrieve(self, request, *args, **kwargs): # lint-amnesty, pylint: disable=u serializer = self.get_serializer(entitlement) return Response(serializer.data) - def list(self, request, *args, **kwargs): # lint-amnesty, pylint: disable=unused-argument + def list(self, request, *args, **kwargs): # pylint: disable=unused-argument """ Override the list method to expire records that are past the policy and requested via the API before returning those records. @@ -278,7 +278,7 @@ def partial_update(self, request, *args, **kwargs): entitlement = CourseEntitlement.objects.get(uuid=entitlement_uuid) except CourseEntitlement.DoesNotExist: return HttpResponseBadRequest( - 'Could not find entitlement {entitlement_uuid} to update'.format( + 'Could not find entitlement {entitlement_uuid} to update'.format( # noqa: UP032 entitlement_uuid=entitlement_uuid ) ) @@ -300,12 +300,12 @@ def partial_update(self, request, *args, **kwargs): support_detail['unenrolled_run'] = CourseOverview.objects.get(id=unenrolled_run_course_key) except (InvalidKeyError, CourseOverview.DoesNotExist) as error: return HttpResponseBadRequest( - 'Error raised while trying to unenroll user {user} from course run {course_id}: {error}' + 'Error raised while trying to unenroll user {user} from course run {course_id}: {error}' # noqa: UP032 # pylint: disable=line-too-long .format(user=entitlement.user.username, course_id=unenrolled_run_id, error=error) ) CourseEntitlementSupportDetail.objects.create(**support_detail) - return super().partial_update(request, *args, **kwargs) # lint-amnesty, pylint: disable=no-member, super-with-arguments + return super().partial_update(request, *args, **kwargs) # pylint: disable=no-member, super-with-arguments class EntitlementEnrollmentViewSet(viewsets.GenericViewSet): @@ -360,7 +360,7 @@ def _enroll_entitlement(self, entitlement, course_run_key, user): # Else the User is already enrolled in another paid Mode and we should # not do anything else related to Entitlements. except CourseEnrollmentException: - message = ( + message = ( # noqa: UP032 'Course Entitlement Enroll for {username} failed for course: {course_id}, ' 'mode: {mode}, and entitlement: {entitlement}' ).format( @@ -430,7 +430,7 @@ def create(self, request, uuid): return Response( status=status.HTTP_400_BAD_REQUEST, data={ - 'message': 'The User is unable to enroll in Course Run {course_id}, it is not available.'.format( + 'message': 'The User is unable to enroll in Course Run {course_id}, it is not available.'.format( # noqa: UP032 # pylint: disable=line-too-long course_id=course_run_id ) } diff --git a/common/djangoapps/entitlements/tasks.py b/common/djangoapps/entitlements/tasks.py index 9bd200bc9056..2ce2399ef847 100644 --- a/common/djangoapps/entitlements/tasks.py +++ b/common/djangoapps/entitlements/tasks.py @@ -5,7 +5,7 @@ from celery import shared_task from celery.utils.log import get_task_logger -from django.conf import settings # lint-amnesty, pylint: disable=unused-import +from django.conf import settings # pylint: disable=unused-import # noqa: F401 from django.contrib.auth import get_user_model from edx_django_utils.monitoring import set_code_owner_attribute @@ -63,9 +63,9 @@ def expire_old_entitlements(self, start, end, logid='...'): except Exception as exc: LOGGER.exception('Failed to expire entitlements [%s]', logid) # The call above is idempotent, so retry at will - raise self.retry(exc=exc, countdown=countdown, max_retries=MAX_RETRIES) + raise self.retry(exc=exc, countdown=countdown, max_retries=MAX_RETRIES) # noqa: B904 - LOGGER.info('Successfully completed the task expire_old_entitlements after examining %d entries [%s]', entitlements.count(), logid) # lint-amnesty, pylint: disable=line-too-long + LOGGER.info('Successfully completed the task expire_old_entitlements after examining %d entries [%s]', entitlements.count(), logid) # pylint: disable=line-too-long @shared_task(bind=True) @@ -143,7 +143,7 @@ def expire_and_create_entitlements(self, entitlement_ids, support_username): self.request.id ) - except Exception as exc: # pylint: disable=broad-except + except Exception as exc: # pylint: disable=broad-except # noqa: F841 log.exception('Failed to expire entitlements that reached their expiration period, task id :%s', self.request.id) diff --git a/common/djangoapps/entitlements/tests/factories.py b/common/djangoapps/entitlements/tests/factories.py index e4c5a86ad3f7..2829da0eecf9 100644 --- a/common/djangoapps/entitlements/tests/factories.py +++ b/common/djangoapps/entitlements/tests/factories.py @@ -1,4 +1,4 @@ -# lint-amnesty, pylint: disable=missing-module-docstring +# pylint: disable=missing-module-docstring import string from uuid import uuid4 @@ -22,7 +22,7 @@ class Meta: site = factory.SubFactory(SiteFactory) -class CourseEntitlementFactory(factory.django.DjangoModelFactory): # lint-amnesty, pylint: disable=missing-class-docstring +class CourseEntitlementFactory(factory.django.DjangoModelFactory): # pylint: disable=missing-class-docstring class Meta: model = CourseEntitlement diff --git a/common/djangoapps/entitlements/tests/test_models.py b/common/djangoapps/entitlements/tests/test_models.py index e0500da454a2..dee3aace5b92 100644 --- a/common/djangoapps/entitlements/tests/test_models.py +++ b/common/djangoapps/entitlements/tests/test_models.py @@ -17,13 +17,15 @@ from lms.djangoapps.certificates.tests.factories import GeneratedCertificateFactory from openedx.core.djangoapps.content.course_overviews.tests.factories import CourseOverviewFactory from openedx.core.djangolib.testing.utils import skip_unless_lms -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + ModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order # Entitlements is not in CMS' INSTALLED_APPS so these imports will error during test collection if settings.ROOT_URLCONF == 'lms.urls': - from common.djangoapps.entitlements.tests.factories import CourseEntitlementFactory from common.djangoapps.entitlements.models import CourseEntitlement + from common.djangoapps.entitlements.tests.factories import CourseEntitlementFactory @skip_unless_lms @@ -92,7 +94,7 @@ def test_check_for_no_entitlement_and_do_not_enroll(self, mock_get_course_uuid): new_course = CourseFactory() CourseModeFactory( - course_id=new_course.id, # lint-amnesty, pylint: disable=no-member + course_id=new_course.id, # pylint: disable=no-member mode_slug=CourseMode.VERIFIED, # This must be in the future to ensure it is returned by downstream code. expiration_datetime=now() + timedelta(days=1) @@ -108,7 +110,7 @@ def test_check_for_no_entitlement_and_do_not_enroll(self, mock_get_course_uuid): ) assert not CourseEnrollment.is_enrolled(user=self.user, course_key=new_course.id) except AttributeError as error: - self.fail(error.message) # lint-amnesty, pylint: disable=no-member + self.fail(error.message) # pylint: disable=no-member @skip_unless_lms @@ -235,7 +237,7 @@ def test_get_days_until_expiration(self): # or the exact same as the original expiration_period_days if somehow no time has passed assert entitlement.get_days_until_expiration() <= entitlement.policy.expiration_period.days - def test_expired_at_datetime(self): # lint-amnesty, pylint: disable=too-many-statements + def test_expired_at_datetime(self): # pylint: disable=too-many-statements """ Tests that using the getter method properly updates the expired_at field for an entitlement """ diff --git a/common/djangoapps/entitlements/tests/test_tasks.py b/common/djangoapps/entitlements/tests/test_tasks.py index c9f705940437..272af46227fc 100644 --- a/common/djangoapps/entitlements/tests/test_tasks.py +++ b/common/djangoapps/entitlements/tests/test_tasks.py @@ -17,7 +17,7 @@ from openedx.core.djangolib.testing.utils import skip_unless_lms -def make_entitlement(expired=False): # lint-amnesty, pylint: disable=missing-function-docstring +def make_entitlement(expired=False): # pylint: disable=missing-function-docstring age = CourseEntitlementPolicy.DEFAULT_EXPIRATION_PERIOD_DAYS past_datetime = datetime.now(tz=ZoneInfo("UTC")) - timedelta(days=age) expired_at = past_datetime if expired else None @@ -80,7 +80,7 @@ def test_retry(self): ) as mock_datetime: task = tasks.expire_old_entitlements.delay(1, 2) - pytest.raises(Exception, task.get) + pytest.raises(Exception, task.get) # noqa: B017 assert mock_datetime.call_count == (tasks.MAX_RETRIES + 1) diff --git a/common/djangoapps/entitlements/tests/test_utils.py b/common/djangoapps/entitlements/tests/test_utils.py index cc2235edb028..ec7a2958d5c5 100644 --- a/common/djangoapps/entitlements/tests/test_utils.py +++ b/common/djangoapps/entitlements/tests/test_utils.py @@ -11,14 +11,16 @@ from common.djangoapps.course_modes.models import CourseMode from common.djangoapps.course_modes.tests.factories import CourseModeFactory -from common.djangoapps.student.tests.factories import ( # lint-amnesty, pylint: disable=line-too-long +from common.djangoapps.student.tests.factories import ( # pylint: disable=line-too-long TEST_PASSWORD, CourseEnrollmentFactory, CourseOverviewFactory, - UserFactory + UserFactory, ) from openedx.core.djangolib.testing.utils import skip_unless_lms -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + ModuleStoreTestCase, # pylint: disable=wrong-import-order +) # Entitlements is not in CMS' INSTALLED_APPS so these imports will error during test collection if settings.ROOT_URLCONF == 'lms.urls': @@ -38,7 +40,7 @@ def setUp(self): self.user = UserFactory(is_staff=True) self.client.login(username=self.user.username, password=TEST_PASSWORD) - def create_course( # lint-amnesty, pylint: disable=missing-function-docstring + def create_course( # pylint: disable=missing-function-docstring self, start_from_now, end_from_now, diff --git a/common/djangoapps/entitlements/utils.py b/common/djangoapps/entitlements/utils.py index 89a00914de6f..3e131686ff8a 100644 --- a/common/djangoapps/entitlements/utils.py +++ b/common/djangoapps/entitlements/utils.py @@ -18,7 +18,7 @@ def is_course_run_entitlement_fulfillable( course_run_key, entitlement, - compare_date=timezone.now(), + compare_date=timezone.now(), # noqa: B008 ): """ Checks that the current run meets the following criteria for an entitlement @@ -37,7 +37,7 @@ def is_course_run_entitlement_fulfillable( try: course_overview = CourseOverview.get_from_id(course_run_key) except CourseOverview.DoesNotExist: - log.error(('There is no CourseOverview entry available for {course_run_id}, ' + log.error(('There is no CourseOverview entry available for {course_run_id}, ' # noqa: UP032 'course run cannot be applied to entitlement').format( course_run_id=str(course_run_key) )) diff --git a/common/djangoapps/pipeline_mako/__init__.py b/common/djangoapps/pipeline_mako/__init__.py index 0f5a980e4544..344513228c22 100644 --- a/common/djangoapps/pipeline_mako/__init__.py +++ b/common/djangoapps/pipeline_mako/__init__.py @@ -1,4 +1,4 @@ -# lint-amnesty, pylint: disable=missing-module-docstring +# pylint: disable=missing-module-docstring from django.conf import settings as django_settings from django.contrib.staticfiles.storage import staticfiles_storage @@ -10,7 +10,7 @@ from common.djangoapps.static_replace import try_staticfiles_lookup -def compressed_css(package_name, raw=False): # lint-amnesty, pylint: disable=missing-function-docstring +def compressed_css(package_name, raw=False): # pylint: disable=missing-function-docstring package = settings.STYLESHEETS.get(package_name, {}) if package: package = {package_name: package} @@ -25,7 +25,7 @@ def compressed_css(package_name, raw=False): # lint-amnesty, pylint: disable=mi return render_individual_css(package, paths, raw=raw) -def render_css(package, path, raw=False): # lint-amnesty, pylint: disable=missing-function-docstring +def render_css(package, path, raw=False): # pylint: disable=missing-function-docstring template_name = package.template_name or "mako/css.html" context = package.extra_context @@ -44,7 +44,7 @@ def render_individual_css(package, paths, raw=False): return '\n'.join(tags) -def compressed_js(package_name): # lint-amnesty, pylint: disable=missing-function-docstring +def compressed_js(package_name): # pylint: disable=missing-function-docstring package = settings.JAVASCRIPT.get(package_name, {}) if package: package = {package_name: package} @@ -60,7 +60,7 @@ def compressed_js(package_name): # lint-amnesty, pylint: disable=missing-functi return render_individual_js(package, paths, templates) -def render_js(package, path): # lint-amnesty, pylint: disable=missing-function-docstring +def render_js(package, path): # pylint: disable=missing-function-docstring template_name = package.template_name or "mako/js.html" context = package.extra_context context.update({ @@ -70,7 +70,7 @@ def render_js(package, path): # lint-amnesty, pylint: disable=missing-function- return render_to_string(template_name, context) -def render_inline_js(package, js): # lint-amnesty, pylint: disable=missing-function-docstring +def render_inline_js(package, js): # pylint: disable=missing-function-docstring context = package.extra_context context.update({ 'source': js diff --git a/common/djangoapps/pipeline_mako/tests/test_render.py b/common/djangoapps/pipeline_mako/tests/test_render.py index cf77657a2ce6..7e9afd7e8414 100644 --- a/common/djangoapps/pipeline_mako/tests/test_render.py +++ b/common/djangoapps/pipeline_mako/tests/test_render.py @@ -36,7 +36,7 @@ class RequireJSPathOverridesTest(TestCase): def test_requirejs_path_overrides(self): result = render_require_js_path_overrides(self.OVERRIDES) # To make the string comparision easy remove the whitespaces - self.assertCountEqual(list(map(str.strip, result.splitlines())), self.OVERRIDES_JS) + self.assertCountEqual(list(map(str.strip, result.splitlines())), self.OVERRIDES_JS) # noqa: PT009 @skip_unless_lms @@ -53,7 +53,7 @@ def mock_staticfiles_lookup(path): (True,), (False,), ) - def test_compressed_css(self, pipeline_enabled, mock_staticfiles_lookup): # lint-amnesty, pylint: disable=unused-argument + def test_compressed_css(self, pipeline_enabled, mock_staticfiles_lookup): # pylint: disable=unused-argument """ Verify the behavior of compressed_css, with the pipeline both enabled and disabled. @@ -71,7 +71,7 @@ def test_compressed_css(self, pipeline_enabled, mock_staticfiles_lookup): # lin @patch('django.contrib.staticfiles.storage.staticfiles_storage.exists', return_value=True) @patch('common.djangoapps.static_replace.try_staticfiles_lookup', side_effect=mock_staticfiles_lookup) - def test_compressed_js(self, mock_staticfiles_lookup, mock_staticfiles_exists): # lint-amnesty, pylint: disable=unused-argument + def test_compressed_js(self, mock_staticfiles_lookup, mock_staticfiles_exists): # pylint: disable=unused-argument """ Verify the behavior of compressed_css, with the pipeline both enabled and disabled. diff --git a/common/djangoapps/split_modulestore_django/migrations/0001_initial.py b/common/djangoapps/split_modulestore_django/migrations/0001_initial.py index 25b752da68d8..76041ecb0e54 100644 --- a/common/djangoapps/split_modulestore_django/migrations/0001_initial.py +++ b/common/djangoapps/split_modulestore_django/migrations/0001_initial.py @@ -1,15 +1,40 @@ # Generated by Django 2.2.20 on 2021-05-07 18:29, manually modified to make "course_id" column case sensitive -from django.conf import settings -from django.db import migrations, models import django.db.models.deletion import opaque_keys.edx.django.models import simple_history.models +from django.conf import settings +from django.db import connection, migrations, models + + +def generate_split_module_sql(db_engine): + if 'mysql' in db_engine: + return 'ALTER TABLE split_modulestore_django_splitmodulestorecourseindex MODIFY course_id varchar(255) CHARACTER SET utf8 COLLATE utf8_bin NOT NULL UNIQUE;' + elif 'postgresql' in db_engine: + return """ + ALTER TABLE split_modulestore_django_splitmodulestorecourseindex + ALTER COLUMN course_id TYPE VARCHAR(255), + ALTER COLUMN course_id SET NOT NULL; + + ALTER TABLE split_modulestore_django_splitmodulestorecourseindex + ADD CONSTRAINT course_id_unique UNIQUE (course_id); + """ +def generate_split_history_module_sql(db_engine): + if 'mysql' in db_engine: + return 'ALTER TABLE split_modulestore_django_historicalsplitmodulestorecourseindex MODIFY course_id varchar(255) CHARACTER SET utf8 COLLATE utf8_bin NOT NULL;' + elif 'postgresql' in db_engine: + return """ + ALTER TABLE split_modulestore_django_historicalsplitmodulestorecourseindex + ALTER COLUMN course_id TYPE VARCHAR(255), + ALTER COLUMN course_id SET NOT NULL, + ALTER COLUMN course_id SET DATA TYPE VARCHAR(255) COLLATE "C"; + """ class Migration(migrations.Migration): initial = True + db_engine = connection.settings_dict['ENGINE'] dependencies = [ migrations.swappable_dependency(settings.AUTH_USER_MODEL), @@ -65,11 +90,11 @@ class Migration(migrations.Migration): # Custom code: Convert columns to utf8_bin because we want to allow # case-sensitive comparisons for CourseKeys, which were case-sensitive in MongoDB migrations.RunSQL( - 'ALTER TABLE split_modulestore_django_splitmodulestorecourseindex MODIFY course_id varchar(255) CHARACTER SET utf8 COLLATE utf8_bin NOT NULL UNIQUE;', + generate_split_module_sql(db_engine), reverse_sql=migrations.RunSQL.noop, ), migrations.RunSQL( - 'ALTER TABLE split_modulestore_django_historicalsplitmodulestorecourseindex MODIFY course_id varchar(255) CHARACTER SET utf8 COLLATE utf8_bin NOT NULL;', + generate_split_history_module_sql(db_engine), reverse_sql=migrations.RunSQL.noop, ), ] diff --git a/common/djangoapps/split_modulestore_django/migrations/0002_data_migration.py b/common/djangoapps/split_modulestore_django/migrations/0002_data_migration.py index b7abc10a984c..ba9f16f44e58 100644 --- a/common/djangoapps/split_modulestore_django/migrations/0002_data_migration.py +++ b/common/djangoapps/split_modulestore_django/migrations/0002_data_migration.py @@ -1,4 +1,5 @@ import logging + from django.db import migrations, models from django.db.utils import IntegrityError diff --git a/common/djangoapps/split_modulestore_django/migrations/0004_courseid_unique_ci.py b/common/djangoapps/split_modulestore_django/migrations/0004_courseid_unique_ci.py new file mode 100644 index 000000000000..125e0b3db028 --- /dev/null +++ b/common/djangoapps/split_modulestore_django/migrations/0004_courseid_unique_ci.py @@ -0,0 +1,67 @@ +# Generated by Django 5.2.11 on 2026-02-19 23:23 + +import django.db.models.functions.text +import opaque_keys.edx.django.models +from django.db import migrations, models + + +class Migration(migrations.Migration): + """ + Force course_id to be case-insensitively unique. + + Note: due to a bug we had for several years, it's possible that this + migration will fail because you have some duplicate entries in the + split_modulestore_django_splitmodulestorecourseindex database table that + differ only in case. Note that other parts of the system (like + CourseOverview) are case-insensitive so only allow one version of the course + ID to be stored, but this table would allow multiple if they differ in case. + Such courses would likely be broken/buggy because so many other parts of the + system use a case-insensitive course_id. + + So if you encounter this issue and the migration fails due to a duplicate: + Try to figure out which is the "correct" ID (e.g. the one used in the + CourseOverview, CourseEnrollment, and CoursewareStudentModule tables) and + then delete the "incorrect" ID from this table. You can easily do + this from the Django admin at: + (studio)/admin/split_modulestore_django/splitmodulestorecourseindex/ + + Be sure to take a screenshot or record the `objectid`, `draft_version`, + `published_version`, and `wiki_slug` fields before you do so, so that you + can reverse the deletion if needed. + + Deleting rows from this table will NOT delete any actual course content from + MongoDB nor cascade the deletion to any other rows in other MySQL tables; it + just removes a duplicate record that points to [unused?] course data. + """ + + dependencies = [ + ("split_modulestore_django", "0003_alter_historicalsplitmodulestorecourseindex_options"), + ] + + operations = [ + # Make 'course_id' case-insensitively unique (in addition to its existing case-sensitively unique index) + migrations.AddConstraint( + model_name="splitmodulestorecourseindex", + constraint=models.UniqueConstraint( + django.db.models.functions.text.Lower("course_id"), + name="splitmodulestorecourseindex_courseid_unique_ci", + ), + ), + # Mark the 'course_id' field as 'case_sensitive=True' now that LearningContextKeyField supports it upstream. + # This part of the migration should have no effect on the database, as migration 0001 already explicitly set a + # case-sensitive collation. We just now have a way to indicate that in the model field definition. + migrations.AlterField( + model_name="splitmodulestorecourseindex", + name="course_id", + field=opaque_keys.edx.django.models.LearningContextKeyField( + case_sensitive=True, max_length=255, unique=True + ), + ), + migrations.AlterField( + model_name="historicalsplitmodulestorecourseindex", + name="course_id", + field=opaque_keys.edx.django.models.LearningContextKeyField( + case_sensitive=True, db_index=True, max_length=255 + ), + ), + ] diff --git a/common/djangoapps/split_modulestore_django/models.py b/common/djangoapps/split_modulestore_django/models.py index ddcdaf5308c7..8bdfa72bde8c 100644 --- a/common/djangoapps/split_modulestore_django/models.py +++ b/common/djangoapps/split_modulestore_django/models.py @@ -4,8 +4,8 @@ from bson.objectid import ObjectId from django.contrib.auth import get_user_model from django.db import models -from opaque_keys.edx.locator import CourseLocator, LibraryLocator from opaque_keys.edx.django.models import LearningContextKeyField +from opaque_keys.edx.locator import CourseLocator, LibraryLocator from simple_history.models import HistoricalRecords from xmodule.modulestore import ModuleStoreEnum @@ -34,8 +34,13 @@ class SplitModulestoreCourseIndex(models.Model): # For compatibility with MongoDB, each course index must have an ObjectId. We still have an integer primary key too. objectid = models.CharField(max_length=24, null=False, blank=False, unique=True) - # The ID of this course (or library). Must start with "course-v1:" or "library-v1:" - course_id = LearningContextKeyField(max_length=255, db_index=True, unique=True, null=False) + # course_id: The ID of this course (or library). Must start with "course-v1:" or "library-v1:" + # This is case-sensitive; however, many other parts of the system aren't case sensitive, so we add an explicit index + # on Lower(course_id) to make this case-insensitively unique as well. + # So: (1) queries of course_id by default are case-sensitive. (2) queries that want to be case-insensitive need to + # explicitly compare Lower(course_id) with the lowercase key in question. (3) Course IDs that differ only in case + # are prohibited. + course_id = LearningContextKeyField(case_sensitive=True, unique=True, null=False) # Extract the "org" value from the course_id key so that we can search by org. # This gets set automatically by clean() org = models.CharField(max_length=255, db_index=True) @@ -78,9 +83,16 @@ class SplitModulestoreCourseIndex(models.Model): def __str__(self): return f"Course Index ({self.course_id})" - class Meta: + class Meta: # noqa: DJ012 ordering = ["course_id"] verbose_name_plural = "Split modulestore course indexes" + constraints = [ + # Explicitly force "course_id" to be case-insensitively unique + models.UniqueConstraint( + models.functions.Lower("course_id"), + name="splitmodulestorecourseindex_courseid_unique_ci", + ), + ] def as_v1_schema(self): """ Return in the same format as was stored in MongoDB """ @@ -157,9 +169,9 @@ def clean(self): # Set the "org" field automatically - ensure it always matches the "org" in the course_id self.org = self.course_id.org - def save(self, *args, **kwargs): + def save(self, *args, **kwargs): # noqa: DJ012 """ Save this model """ # Override to ensure that full_clean()/clean() is always called, so that the checks in clean() above are run. - # But don't validate_unique(), it just runs extra queries and the database enforces it anyways. - self.full_clean(validate_unique=False) + # But don't run validations; they just run extra queries and the database enforces them anyways. + self.full_clean(validate_unique=False, validate_constraints=False) return super().save(*args, **kwargs) diff --git a/common/djangoapps/split_modulestore_django/tests/test_models.py b/common/djangoapps/split_modulestore_django/tests/test_models.py index cc32222f3fd7..fd92ab85a055 100644 --- a/common/djangoapps/split_modulestore_django/tests/test_models.py +++ b/common/djangoapps/split_modulestore_django/tests/test_models.py @@ -1,12 +1,14 @@ """ Unit tests for SplitModulestoreCourseIndex """ from datetime import datetime +import pytest from bson.objectid import ObjectId +from django.db import IntegrityError, transaction from django.test import TestCase from opaque_keys.edx.keys import CourseKey from common.djangoapps.split_modulestore_django.models import SplitModulestoreCourseIndex -from xmodule.modulestore import ModuleStoreEnum # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore import ModuleStoreEnum # pylint: disable=wrong-import-order class SplitModulestoreCourseIndexTest(TestCase): @@ -16,12 +18,22 @@ def test_course_id_case_sensitive(self): """ Make sure the course_id column is case sensitive. + 2021 note: + Although the platform code generally tries to prevent having two courses whose IDs differ only by case (e.g. https://git.io/J6voR , note `ignore_case=True`), we found at least one pair of courses on stage that differs only by case in its `org` ID (`edx` vs `edX`). So for backwards compatibility with MongoDB and to avoid issues for anyone else with similar course IDs that differ only by case, we've made the new version case sensitive too. The system still tries to prevent creation of courses that differ only by course (that hasn't changed), but now the MySQL version won't break if that has somehow happened. + + 2026 note: + + Due to a serious bug where the system was NOT preventing duplicate courses from being created on MySQL, we + decided to tighten this up and introduce a new UNIQUE(LOWER(course_id)) index to prevent duplicates at the + database level. This does mean that the migration will fail if anyone has such duplicates in their system, but + those duplicates are going to have other bugs anyways; in such cases we recommend deleting one of the duplicate + SplitModulestoreCourseIndex entries, or changing its course_id to a dummy value. """ course_index_common = { "course": "TL101", @@ -38,8 +50,16 @@ def test_course_id_case_sensitive(self): data1 = SplitModulestoreCourseIndex.fields_from_v1_schema(course_index_1) data2 = SplitModulestoreCourseIndex.fields_from_v1_schema(course_index_2) SplitModulestoreCourseIndex(**data1).save() - # This next line will fail if the course_id column is not case-sensitive: - SplitModulestoreCourseIndex(**data2).save() - # Also check deletion, to ensure the course_id historical record is not unique or case sensitive: - SplitModulestoreCourseIndex.objects.get(course_id=CourseKey.from_string("course-v1:edx+TL101+2015")).delete() - SplitModulestoreCourseIndex.objects.get(course_id=CourseKey.from_string("course-v1:edX+TL101+2015")).delete() + # This next line should fail, because the database itself prevents duplicates: + with pytest.raises(IntegrityError): + with transaction.atomic(): + SplitModulestoreCourseIndex(**data2).save() + + id_1 = "course-v1:edx+TL101+2015" + id_2 = "course-v1:edX+TL101+2015" + + # Retrieving a course by its exact course_id should work: + SplitModulestoreCourseIndex.objects.get(course_id=CourseKey.from_string(id_1)) + # but retrieving a course with the wrong case should throw an error: + with pytest.raises(SplitModulestoreCourseIndex.DoesNotExist): + SplitModulestoreCourseIndex.objects.get(course_id=CourseKey.from_string(id_2)) diff --git a/common/djangoapps/static_replace/__init__.py b/common/djangoapps/static_replace/__init__.py index cfab4dde8375..fbe24978da31 100644 --- a/common/djangoapps/static_replace/__init__.py +++ b/common/djangoapps/static_replace/__init__.py @@ -1,4 +1,4 @@ -# lint-amnesty, pylint: disable=missing-module-docstring +# pylint: disable=missing-module-docstring import logging import re @@ -26,7 +26,7 @@ def _url_replace_regex(prefix): (?P{prefix}) # the prefix (?P.*?) # everything else in the url (?P=quote) # the first matching closing quote - """.format(prefix=prefix) + """.format(prefix=prefix) # noqa: UP032 def try_staticfiles_lookup(path): @@ -36,15 +36,15 @@ def try_staticfiles_lookup(path): """ try: url = staticfiles_storage.url(path) - except Exception as err: # lint-amnesty, pylint: disable=broad-except - log.warning("staticfiles_storage couldn't find path {}: {}".format( + except Exception as err: # pylint: disable=broad-except + log.warning("staticfiles_storage couldn't find path {}: {}".format( # noqa: UP032 path, str(err))) # Just return the original path; don't kill everything. url = path return url -def replace_jump_to_id_urls(text, course_id, jump_to_id_base_url): # lint-amnesty, pylint: disable=unused-argument +def replace_jump_to_id_urls(text, course_id, jump_to_id_base_url): # pylint: disable=unused-argument """ This will replace a link to another piece of courseware to a 'jump_to' URL that will redirect to the right place in the courseware @@ -121,7 +121,7 @@ def wrap_part_extraction(match): return replacement_function(original, prefix, quote, rest) return re.sub( - _url_replace_regex('(?:{static_url}|/static/)(?!{data_dir})'.format( + _url_replace_regex('(?:{static_url}|/static/)(?!{data_dir})'.format( # noqa: UP032 static_url=settings.STATIC_URL, data_dir=data_dir )), @@ -203,8 +203,8 @@ def replace_static_url(original, prefix, quote, rest): exists_in_staticfiles_storage = False try: exists_in_staticfiles_storage = staticfiles_storage.exists(rest) - except Exception as err: # lint-amnesty, pylint: disable=broad-except - log.warning("staticfiles_storage couldn't find path {}: {}".format( + except Exception as err: # pylint: disable=broad-except + log.warning("staticfiles_storage couldn't find path {}: {}".format( # noqa: UP032 rest, str(err))) if exists_in_staticfiles_storage: @@ -231,8 +231,8 @@ def replace_static_url(original, prefix, quote, rest): else: url = staticfiles_storage.url(course_path) # And if that fails, assume that it's course content, and add manually data directory - except Exception as err: # lint-amnesty, pylint: disable=broad-except - log.warning("staticfiles_storage couldn't find path {}: {}".format( + except Exception as err: # pylint: disable=broad-except + log.warning("staticfiles_storage couldn't find path {}: {}".format( # noqa: UP032 rest, str(err))) url = "".join([prefix, course_path]) diff --git a/common/djangoapps/static_replace/services.py b/common/djangoapps/static_replace/services.py index 010cb96be0d3..348602b9cefb 100644 --- a/common/djangoapps/static_replace/services.py +++ b/common/djangoapps/static_replace/services.py @@ -4,11 +4,7 @@ from xblock.reference.plugins import Service -from common.djangoapps.static_replace import ( - replace_course_urls, - replace_jump_to_id_urls, - replace_static_urls -) +from common.djangoapps.static_replace import replace_course_urls, replace_jump_to_id_urls, replace_static_urls class ReplaceURLService(Service): diff --git a/common/djangoapps/static_replace/test/test_static_replace.py b/common/djangoapps/static_replace/test/test_static_replace.py index c71f8fa15c6a..1e3f0d25b8a9 100644 --- a/common/djangoapps/static_replace/test/test_static_replace.py +++ b/common/djangoapps/static_replace/test/test_static_replace.py @@ -1,10 +1,9 @@ """Tests for static_replace""" -from functools import partial - import re +from functools import partial from io import BytesIO from unittest.mock import Mock, patch -from urllib.parse import parse_qsl, quote, urlparse, urlunparse, urlencode +from urllib.parse import parse_qsl, quote, urlencode, urlparse, urlunparse import ddt import pytest @@ -18,21 +17,26 @@ make_static_urls_absolute, process_static_urls, replace_course_urls, - replace_static_urls, replace_jump_to_id_urls, + replace_static_urls, ) from common.djangoapps.static_replace.services import ReplaceURLService from common.djangoapps.static_replace.wrapper import replace_urls_wrapper -from xmodule.assetstore.assetmgr import AssetManager # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.contentstore.content import StaticContent # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.contentstore.django import contentstore # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.exceptions import NotFoundError # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore import ModuleStoreEnum # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.exceptions import ItemNotFoundError # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.mongo import MongoModuleStore # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory, check_mongo_calls # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.xml import XMLModuleStore # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.assetstore.assetmgr import AssetManager # pylint: disable=wrong-import-order +from xmodule.contentstore.content import StaticContent # pylint: disable=wrong-import-order +from xmodule.contentstore.django import contentstore # pylint: disable=wrong-import-order +from xmodule.exceptions import NotFoundError # pylint: disable=wrong-import-order +from xmodule.modulestore import ModuleStoreEnum # pylint: disable=wrong-import-order +from xmodule.modulestore.exceptions import ItemNotFoundError # pylint: disable=wrong-import-order +from xmodule.modulestore.mongo import MongoModuleStore # pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + SharedModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import ( # pylint: disable=wrong-import-order + CourseFactory, + check_mongo_calls, +) +from xmodule.modulestore.xml import XMLModuleStore # pylint: disable=wrong-import-order DATA_DIRECTORY = 'data_dir' COURSE_KEY = CourseKey.from_string('org/course/run') @@ -147,7 +151,7 @@ def test_mongo_filestore(mock_get_excluded_extensions, mock_get_base_url, mock_m @patch('common.djangoapps.static_replace.settings', autospec=True) @patch('xmodule.modulestore.django.modulestore', autospec=True) @patch('common.djangoapps.static_replace.staticfiles_storage', autospec=True) -def test_data_dir_fallback(mock_storage, mock_modulestore, mock_settings): # lint-amnesty, pylint: disable=unused-argument +def test_data_dir_fallback(mock_storage, mock_modulestore, mock_settings): # pylint: disable=unused-argument mock_modulestore.return_value = Mock(XMLModuleStore) mock_storage.url.side_effect = Exception @@ -181,8 +185,8 @@ def test_static_url_with_query(mock_modulestore, mock_storage): mock_storage.exists.return_value = False mock_modulestore.return_value = Mock(MongoModuleStore) - pre_text = 'EMBED src ="/static/LAlec04_controller.swf?csConfigFile=/static/LAlec04_config.xml&name1=value1&name2=value2"' # lint-amnesty, pylint: disable=line-too-long - post_text = 'EMBED src ="/c4x/org/course/asset/LAlec04_controller.swf?csConfigFile=%2Fc4x%2Forg%2Fcourse%2Fasset%2FLAlec04_config.xml&name1=value1&name2=value2"' # lint-amnesty, pylint: disable=line-too-long + pre_text = 'EMBED src ="/static/LAlec04_controller.swf?csConfigFile=/static/LAlec04_config.xml&name1=value1&name2=value2"' # pylint: disable=line-too-long + post_text = 'EMBED src ="/c4x/org/course/asset/LAlec04_controller.swf?csConfigFile=%2Fc4x%2Forg%2Fcourse%2Fasset%2FLAlec04_config.xml&name1=value1&name2=value2"' # pylint: disable=line-too-long assert replace_static_urls(pre_text, DATA_DIRECTORY, COURSE_KEY) == post_text @@ -201,13 +205,13 @@ def test_static_paths_out(mock_modulestore, mock_storage): mock_modulestore.return_value = Mock(MongoModuleStore) static_url = '/static/LAlec04_controller.swf?csConfigFile=/static/LAlec04_config.xml&name1=value1&name2=value2' - static_course_url = '/c4x/org/course/asset/LAlec04_controller.swf?csConfigFile=%2Fc4x%2Forg%2Fcourse%2Fasset%2FLAlec04_config.xml&name1=value1&name2=value2' # lint-amnesty, pylint: disable=line-too-long + static_course_url = '/c4x/org/course/asset/LAlec04_controller.swf?csConfigFile=%2Fc4x%2Forg%2Fcourse%2Fasset%2FLAlec04_config.xml&name1=value1&name2=value2' # pylint: disable=line-too-long raw_url = '/static/js/capa/protex/protex.nocache.js?raw' xblock_url = '/static/xblock/resources/babys_first.lil_xblock/public/images/pacifier.png' # xss-lint: disable=python-wrap-html pre_text = f'EMBED src ="{static_url}" xblock={xblock_url} text
          To override the banner message for a specific course, refer to the Course Message configuration. ' # lint-amnesty, pylint: disable=line-too-long + '

          To override the banner message for a specific course, refer to the Course Message configuration. ' # pylint: disable=line-too-long 'Course Messages will only work if the global status message is enabled, so if you only want to add ' - 'a banner to specific courses without adding a global status message, you should add a global status ' # lint-amnesty, pylint: disable=line-too-long + 'a banner to specific courses without adding a global status message, you should add a global status ' # pylint: disable=line-too-long 'message with empty message text.

          ' '

          Finally, disable the global status message by adding another empty message with "enabled" ' 'unchecked.

          ') @@ -64,8 +63,8 @@ class CourseMessage(models.Model): .. no_pii: """ global_message = models.ForeignKey(GlobalStatusMessage, on_delete=models.CASCADE) - course_key = CourseKeyField(max_length=255, blank=True, db_index=True) - message = models.TextField(blank=True, null=True) + course_key = CourseKeyField(blank=True, db_index=True) + message = models.TextField(blank=True, null=True) # noqa: DJ001 def __str__(self): return str(self.course_key) diff --git a/common/djangoapps/student/admin.py b/common/djangoapps/student/admin.py index 151c6ab5b8ca..a68d10427401 100644 --- a/common/djangoapps/student/admin.py +++ b/common/djangoapps/student/admin.py @@ -2,11 +2,10 @@ from functools import wraps -from dal_select2.views import Select2ListView -from dal_select2.widgets import ListSelect2 -from django_countries import countries from config_models.admin import ConfigurationModelAdmin +from dal_select2.views import Select2ListView +from dal_select2.widgets import ListSelect2 from django import forms from django.conf import settings from django.contrib import admin @@ -20,15 +19,16 @@ from django.db import models, router, transaction from django.http import HttpResponseRedirect from django.http.request import QueryDict -from django.urls import reverse, path +from django.urls import path, reverse from django.utils.decorators import method_decorator -from django.utils.translation import ngettext from django.utils.translation import gettext_lazy as _ +from django.utils.translation import ngettext +from django_countries import countries +from edx_toggles.toggles import WaffleSwitch from opaque_keys import InvalidKeyError from opaque_keys.edx.keys import CourseKey -from edx_toggles.toggles import WaffleSwitch -from openedx.core.lib.courses import clean_course_id +from common.djangoapps.student.constants import LANGUAGE_CHOICES from common.djangoapps.student.models import ( AccountRecovery, AccountRecoveryConfiguration, @@ -49,11 +49,11 @@ UserAttribute, UserCelebration, UserProfile, - UserTestGroup + UserTestGroup, ) -from common.djangoapps.student.constants import LANGUAGE_CHOICES from common.djangoapps.student.roles import REGISTERED_ACCESS_ROLES -from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order +from openedx.core.lib.courses import clean_course_id +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order User = get_user_model() # pylint:disable=invalid-name @@ -138,10 +138,10 @@ class CourseAccessRoleForm(forms.ModelForm): class Meta: model = CourseAccessRole - fields = '__all__' + fields = '__all__' # noqa: DJ007 email = forms.EmailField(required=True) - COURSE_ACCESS_ROLES = [(role_name, role_name) for role_name in REGISTERED_ACCESS_ROLES.keys()] # lint-amnesty, pylint: disable=consider-iterating-dictionary + COURSE_ACCESS_ROLES = [(role_name, role_name) for role_name in REGISTERED_ACCESS_ROLES.keys()] # pylint: disable=consider-iterating-dictionary role = forms.ChoiceField(choices=COURSE_ACCESS_ROLES) def clean_course_id(self): @@ -160,7 +160,7 @@ def clean_org(self): org_name = self.cleaned_data.get('course_id').org if org.lower() != org_name.lower(): raise forms.ValidationError( - "Org name {} is not valid. Valid name is {}.".format( + "Org name {} is not valid. Valid name is {}.".format( # noqa: UP032 org, org_name ) ) @@ -175,8 +175,8 @@ def clean_email(self): try: user = User.objects.get(email=email) except Exception: - raise forms.ValidationError( # lint-amnesty, pylint: disable=raise-missing-from - "Email does not exist. Could not find {email}. Please re-enter email address".format( + raise forms.ValidationError( # pylint: disable=raise-missing-from # noqa: B904 + "Email does not exist. Could not find {email}. Please re-enter email address".format( # noqa: UP032 email=email ) ) @@ -309,7 +309,7 @@ def revert_selected_history(self, request, queryset): f"{history_record.user.username} in {history_record.course_id}" ) reverted_count += 1 - except Exception as e: # lint-amnesty, pylint: disable=broad-except + except Exception as e: # pylint: disable=broad-except self.message_user(request, f"Error reverting record {history_record.id}: {e}", level='ERROR') if reverted_count > 0: @@ -339,7 +339,7 @@ def delete_selected_history_entries(self, request, queryset): try: history_record.delete() deleted_count += 1 - except Exception as e: # lint-amnesty, pylint: disable=broad-except + except Exception as e: # pylint: disable=broad-except self.message_user(request, f"Error deleting record {history_record.id}: {e}", level='ERROR') if deleted_count > 0: @@ -373,7 +373,7 @@ def __init__(self, *args, **kwargs): try: args_copy['course'] = CourseKey.from_string(args_copy['course']) except InvalidKeyError: - raise forms.ValidationError("Cannot make a valid CourseKey from id {}!".format(args_copy['course'])) # lint-amnesty, pylint: disable=raise-missing-from + raise forms.ValidationError("Cannot make a valid CourseKey from id {}!".format(args_copy['course'])) # pylint: disable=raise-missing-from,line-too-long # noqa: B904 args = [args_copy] super().__init__(*args, **kwargs) @@ -387,19 +387,19 @@ def __init__(self, *args, **kwargs): # However, the args copy above before the super() call handles this case. pass - def clean_course_id(self): # lint-amnesty, pylint: disable=missing-function-docstring + def clean_course_id(self): # pylint: disable=missing-function-docstring course_id = self.cleaned_data['course'] try: course_key = CourseKey.from_string(course_id) except InvalidKeyError: - raise forms.ValidationError(f"Cannot make a valid CourseKey from id {course_id}!") # lint-amnesty, pylint: disable=raise-missing-from + raise forms.ValidationError(f"Cannot make a valid CourseKey from id {course_id}!") # pylint: disable=raise-missing-from # noqa: B904 if not modulestore().has_course(course_key): raise forms.ValidationError(f"Cannot find course with id {course_id} in the modulestore") return course_key - def save(self, *args, **kwargs): # lint-amnesty, pylint: disable=signature-differs, unused-argument + def save(self, *args, **kwargs): # pylint: disable=signature-differs, unused-argument course_enrollment = super().save(commit=False) user = self.cleaned_data['user'] course_overview = self.cleaned_data['course'] @@ -410,7 +410,7 @@ def save(self, *args, **kwargs): # lint-amnesty, pylint: disable=signature-diff class Meta: model = CourseEnrollment - fields = '__all__' + fields = '__all__' # noqa: DJ007 @admin.register(CourseEnrollment) @@ -438,7 +438,7 @@ def get_search_results(self, request, queryset, search_term): return qs, use_distinct def get_queryset(self, request): - return super().get_queryset(request).select_related('user') # lint-amnesty, pylint: disable=no-member, super-with-arguments + return super().get_queryset(request).select_related('user') # pylint: disable=no-member, super-with-arguments @method_decorator(login_required, name='dispatch') @@ -494,7 +494,7 @@ class UserProfileInlineForm(forms.ModelForm): class Meta: model = UserProfile - fields = '__all__' + fields = '__all__' # noqa: DJ007 def __init__(self, *args, **kwargs): super().__init__(*args, **kwargs) @@ -556,7 +556,7 @@ class UserAdmin(BaseUserAdmin): def get_readonly_fields(self, request, obj=None): """ Allows editing the users while skipping the username check, so we can have Unicode username with no problems. - The username is marked read-only when editing existing users regardless of `ENABLE_UNICODE_USERNAME`, to simplify the bokchoy tests. # lint-amnesty, pylint: disable=line-too-long + The username is marked read-only when editing existing users regardless of `ENABLE_UNICODE_USERNAME`, to simplify the bokchoy tests. # pylint: disable=line-too-long """ django_readonly = super().get_readonly_fields(request, obj) if obj: @@ -709,14 +709,14 @@ def clean_email(self): email_domain = email.split('@')[-1] allowed_site_email_domain = self.cleaned_data['site'].configuration.get_value('THIRD_PARTY_AUTH_ONLY_DOMAIN') - if not allowed_site_email_domain: # lint-amnesty, pylint: disable=no-else-raise + if not allowed_site_email_domain: # pylint: disable=no-else-raise raise forms.ValidationError( _("Please add a key/value 'THIRD_PARTY_AUTH_ONLY_DOMAIN/{site_email_domain}' in SiteConfiguration " "model's site_values field.") ) elif email_domain != allowed_site_email_domain: raise forms.ValidationError( - _(f"Email doesn't have {allowed_site_email_domain} domain name.") # lint-amnesty, pylint: disable=translation-of-non-string + _(f"Email doesn't have {allowed_site_email_domain} domain name.") # pylint: disable=translation-of-non-string ) elif not User.objects.filter(email=email).exists(): raise forms.ValidationError(_("User with this email doesn't exist in system.")) diff --git a/common/djangoapps/student/api.py b/common/djangoapps/student/api.py index c5bd7b861871..402da47cc44c 100644 --- a/common/djangoapps/student/api.py +++ b/common/djangoapps/student/api.py @@ -4,34 +4,28 @@ """ -from typing import TYPE_CHECKING import logging +from typing import TYPE_CHECKING +from django.conf import settings # noqa: F401 from django.contrib.auth import get_user_model -from django.conf import settings from opaque_keys.edx.keys import CourseKey from common.djangoapps.student.models import CourseEnrollment +from common.djangoapps.student.models_api import ALLOWEDTOENROLL_TO_ENROLLED as _ALLOWEDTOENROLL_TO_ENROLLED +from common.djangoapps.student.models_api import ALLOWEDTOENROLL_TO_UNENROLLED as _ALLOWEDTOENROLL_TO_UNENROLLED +from common.djangoapps.student.models_api import DEFAULT_TRANSITION_STATE as _DEFAULT_TRANSITION_STATE +from common.djangoapps.student.models_api import ENROLLED_TO_ENROLLED as _ENROLLED_TO_ENROLLED +from common.djangoapps.student.models_api import ENROLLED_TO_UNENROLLED as _ENROLLED_TO_UNENROLLED +from common.djangoapps.student.models_api import UNENROLLED_TO_ALLOWEDTOENROLL as _UNENROLLED_TO_ALLOWEDTOENROLL +from common.djangoapps.student.models_api import UNENROLLED_TO_ENROLLED as _UNENROLLED_TO_ENROLLED +from common.djangoapps.student.models_api import UNENROLLED_TO_UNENROLLED as _UNENROLLED_TO_UNENROLLED from common.djangoapps.student.models_api import create_manual_enrollment_audit as _create_manual_enrollment_audit -from common.djangoapps.student.models_api import get_course_access_role +from common.djangoapps.student.models_api import get_course_access_role # noqa: F401 from common.djangoapps.student.models_api import get_course_enrollment as _get_course_enrollment -from common.djangoapps.student.models_api import ( - ENROLLED_TO_ENROLLED as _ENROLLED_TO_ENROLLED, - ENROLLED_TO_UNENROLLED as _ENROLLED_TO_UNENROLLED, - UNENROLLED_TO_ENROLLED as _UNENROLLED_TO_ENROLLED, - UNENROLLED_TO_UNENROLLED as _UNENROLLED_TO_UNENROLLED, - UNENROLLED_TO_ALLOWEDTOENROLL as _UNENROLLED_TO_ALLOWEDTOENROLL, - ALLOWEDTOENROLL_TO_ENROLLED as _ALLOWEDTOENROLL_TO_ENROLLED, - ALLOWEDTOENROLL_TO_UNENROLLED as _ALLOWEDTOENROLL_TO_UNENROLLED, - DEFAULT_TRANSITION_STATE as _DEFAULT_TRANSITION_STATE, -) -from common.djangoapps.student.roles import ( - CourseInstructorRole, - CourseStaffRole, - GlobalStaff, - REGISTERED_ACCESS_ROLES as _REGISTERED_ACCESS_ROLES, -) -from openedx.core.djangoapps.site_configuration import helpers as configuration_helpers +from common.djangoapps.student.roles import REGISTERED_ACCESS_ROLES as _REGISTERED_ACCESS_ROLES +from common.djangoapps.student.roles import CourseInstructorRole, CourseStaffRole, GlobalStaff +from openedx.core.djangoapps.site_configuration import helpers as configuration_helpers # noqa: F401 if TYPE_CHECKING: from django.contrib.auth.models import AnonymousUser, User # pylint: disable=imported-auth-user diff --git a/common/djangoapps/student/apps.py b/common/djangoapps/student/apps.py index e1ec51afcac7..ba7b9ca9be14 100644 --- a/common/djangoapps/student/apps.py +++ b/common/djangoapps/student/apps.py @@ -16,12 +16,13 @@ class StudentConfig(AppConfig): def ready(self): # Connect signal handlers. - from .signals import receivers # pylint: disable=unused-import + from .signals import receivers # pylint: disable=unused-import # noqa: F401 # The django-simple-history model on CourseEnrollment creates performance # problems in testing, we mock it here so that the mock impacts all tests. if os.environ.get('DISABLE_COURSEENROLLMENT_HISTORY', False): - import common.djangoapps.student.models as student_models from unittest.mock import MagicMock + import common.djangoapps.student.models as student_models + student_models.CourseEnrollment.history = MagicMock() diff --git a/common/djangoapps/student/auth.py b/common/djangoapps/student/auth.py index 047f0174a062..d7fdb0bcae3c 100644 --- a/common/djangoapps/student/auth.py +++ b/common/djangoapps/student/auth.py @@ -10,6 +10,8 @@ from django.conf import settings from django.core.exceptions import PermissionDenied from opaque_keys.edx.locator import LibraryLocator +from openedx_authz import api as authz_api +from openedx_authz.constants.permissions import COURSES_CREATE_COURSE, COURSES_MANAGE_ADVANCED_SETTINGS from common.djangoapps.student.roles import ( CourseBetaTesterRole, @@ -26,6 +28,7 @@ OrgStaffRole, strict_role_checking, ) +from openedx.core import toggles as core_toggles # Studio permissions: STUDIO_EDIT_ROLES = 8 @@ -41,7 +44,7 @@ def is_ccx_course(course_key): Check whether the course locator maps to a CCX course; this is important because we don't allow access to CCX courses in Studio. """ - return isinstance(course_key, CCXLocator) or isinstance(course_key, CCXBlockUsageLocator) # lint-amnesty, pylint: disable=consider-merging-isinstance + return isinstance(course_key, CCXLocator) or isinstance(course_key, CCXBlockUsageLocator) # pylint: disable=consider-merging-isinstance def user_has_role(user, role): @@ -177,7 +180,93 @@ def has_studio_read_access(user, course_key): return bool(STUDIO_VIEW_CONTENT & get_user_permissions(user, course_key)) +def check_course_advanced_settings_access(user, course_key, access_type='read'): + """ + Check if user has access to advanced settings for a course. + + Uses openedx-authz when AUTHZ_COURSE_AUTHORING_FLAG is enabled, + otherwise falls back to legacy permission checks. + + If the DISABLE_ADVANCED_SETTINGS feature flag is on, then authz will not be used for the + permission check. + + Args: + user: Django user object + course_key: CourseKey for the course + access_type: Type of access to check. Options: + - 'read': Check studio read access (default) + - 'write': Check studio write access + - 'feature_restricted': Check access based on the DISABLE_ADVANCED_SETTINGS feature + + Returns: + bool: True if user has permission, False otherwise + """ + if core_toggles.AUTHZ_COURSE_AUTHORING_FLAG.is_enabled(course_key): + # For feature_restricted access type, check DISABLE_ADVANCED_SETTINGS feature + if ( + access_type == 'feature_restricted' + and settings.FEATURES.get('DISABLE_ADVANCED_SETTINGS', False) + ): + # When feature is disabled, only staff/superuser can access (bypass authz) + return user.is_staff or user.is_superuser + # Otherwise check authz permission + return authz_api.is_user_allowed(user.username, COURSES_MANAGE_ADVANCED_SETTINGS.identifier, str(course_key)) + + # Legacy permission checks + if access_type == 'read': + return has_studio_read_access(user, course_key) + if access_type == 'feature_restricted': + return has_studio_advanced_settings_access(user) + if access_type == 'write': + return has_studio_write_access(user, course_key) + + raise ValueError(f"Invalid access_type: {access_type}") + + def is_content_creator(user, org): + """ + Determine whether a user is allowed to create course content for a given organization. + + This function abstracts the permission check for course creation. Depending on the + state of the AuthZ feature flag, it delegates the evaluation to either the AuthZ-based + RBAC system or the legacy role-based permission system. + + Args: + user (User): The user whose permissions are being evaluated. + org (str): The organization identifier used as the permission scope. + + Returns: + bool: True if the user has permission to create course content in the given + organization, False otherwise. + + Notes: + - When AuthZ is enabled, this checks permissions via RBAC policies. + - When AuthZ is disabled, this falls back to legacy Django role checks. + - Course creation may still be blocked by global feature flags (e.g., + DISABLE_COURSE_CREATION), which are enforced downstream. + """ + if core_toggles.AUTHZ_COURSE_AUTHORING_FLAG.is_enabled(): + return _has_content_creator_access(user, org) + return _has_legacy_content_creator_access(user, org) + + +def _has_content_creator_access(user, org): + """ + Check if the user has content creator access based on AuthZ permissions. + """ + if settings.FEATURES.get('DISABLE_COURSE_CREATION', False): + return False + # Using Org scope. e.g. "course-v1:{org}+*" + org_scope_key = authz_api.OrgCourseOverviewGlobData.build_external_key(org) + + return authz_api.is_user_allowed( + user.username, + COURSES_CREATE_COURSE.identifier, + org_scope_key + ) + + +def _has_legacy_content_creator_access(user, org): """ Check if the user has the role to create content. @@ -247,7 +336,7 @@ def _check_caller_authority(caller, role): if GlobalStaff().has_user(caller): return - if isinstance(role, (GlobalStaff, CourseCreatorRole, OrgContentCreatorRole)): # lint-amnesty, pylint: disable=no-else-raise + if isinstance(role, (GlobalStaff, CourseCreatorRole, OrgContentCreatorRole)): # pylint: disable=no-else-raise raise PermissionDenied elif isinstance(role, CourseRole): # instructors can change the roles w/in their course if not user_has_role(caller, CourseInstructorRole(role.course_key)): diff --git a/common/djangoapps/student/email_helpers.py b/common/djangoapps/student/email_helpers.py index b92f922af63b..7e885b7e0515 100644 --- a/common/djangoapps/student/email_helpers.py +++ b/common/djangoapps/student/email_helpers.py @@ -12,7 +12,7 @@ from openedx.core.djangoapps.enrollments.api import is_enrollment_valid_for_proctoring from openedx.core.djangoapps.site_configuration import helpers as configuration_helpers from openedx.core.djangoapps.theming import helpers as theming_helpers -from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order def generate_activation_email_context(user, registration): diff --git a/common/djangoapps/student/forms.py b/common/djangoapps/student/forms.py index 8e5a663dcdee..76483be71b6f 100644 --- a/common/djangoapps/student/forms.py +++ b/common/djangoapps/student/forms.py @@ -9,13 +9,13 @@ from edx_ace import ace from edx_ace.recipient import Recipient +from common.djangoapps.student.message_types import AccountRecovery as AccountRecoveryMessage from openedx.core.djangoapps.ace_common.template_context import get_base_template_context from openedx.core.djangoapps.lang_pref import LANGUAGE_KEY from openedx.core.djangoapps.site_configuration import helpers as configuration_helpers from openedx.core.djangoapps.theming.helpers import get_current_site -from openedx.core.djangoapps.user_authn.toggles import should_redirect_to_authn_microfrontend from openedx.core.djangoapps.user_api.preferences.api import get_user_preference -from common.djangoapps.student.message_types import AccountRecovery as AccountRecoveryMessage +from openedx.core.djangoapps.user_authn.toggles import should_redirect_to_authn_microfrontend def send_account_recovery_email_for_user(user, request, email=None): diff --git a/common/djangoapps/student/helpers.py b/common/djangoapps/student/helpers.py index 834c230871da..6d3ee2b7cf96 100644 --- a/common/djangoapps/student/helpers.py +++ b/common/djangoapps/student/helpers.py @@ -14,7 +14,7 @@ from completion.utilities import get_key_to_last_completed_block from django.conf import settings from django.contrib.auth import load_backend -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.core.exceptions import ObjectDoesNotExist, PermissionDenied from django.core.validators import ValidationError from django.db import IntegrityError, ProgrammingError, transaction @@ -32,34 +32,34 @@ UserProfile, email_exists_or_retired, unique_id_for_user, - username_exists_or_retired + username_exists_or_retired, ) from common.djangoapps.util.password_policy_validators import normalize_password from lms.djangoapps.certificates.api import ( + auto_certificate_generation_enabled, + certificate_status_for_student, certificates_viewable_for_course, - has_self_generated_certificates_enabled, get_certificate_url, has_html_certificates_enabled, - certificate_status_for_student, - auto_certificate_generation_enabled, + has_self_generated_certificates_enabled, ) from lms.djangoapps.certificates.data import CertificateStatuses from lms.djangoapps.course_blocks.api import get_course_blocks +from lms.djangoapps.course_home_api.dates.serializers import DateSummarySerializer +from lms.djangoapps.courseware.context_processor import user_timezone_locale_prefs +from lms.djangoapps.courseware.courses import get_course_date_blocks, get_course_with_access +from lms.djangoapps.courseware.date_summary import TodaysDate from lms.djangoapps.grades.api import CourseGradeFactory from lms.djangoapps.instructor import access from lms.djangoapps.verify_student.models import VerificationDeadline from lms.djangoapps.verify_student.services import IDVerificationService from lms.djangoapps.verify_student.utils import is_verification_expiring_soon, verification_for_datetime -from lms.djangoapps.courseware.courses import get_course_date_blocks, get_course_with_access -from lms.djangoapps.courseware.date_summary import TodaysDate -from lms.djangoapps.courseware.context_processor import user_timezone_locale_prefs -from lms.djangoapps.course_home_api.dates.serializers import DateSummarySerializer from openedx.core.djangoapps.content.block_structure.exceptions import UsageKeyNotInBlockStructure from openedx.core.djangoapps.site_configuration import helpers as configuration_helpers from openedx.core.djangoapps.theming.helpers import get_themes from openedx.core.djangoapps.user_authn.utils import is_safe_login_or_logout_redirect from openedx.core.lib.time_zone_utils import get_time_zone_offset -from xmodule.data import CertificatesDisplayBehaviors # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.data import CertificatesDisplayBehaviors # pylint: disable=wrong-import-order # Enumeration of per-course verification statuses # we display on the student dashboard. @@ -232,7 +232,7 @@ def check_verify_status_by_course(user, course_enrollments): } if recent_verification_datetime: - for key, value in status_by_course.items(): # pylint: disable=unused-variable + for key, value in status_by_course.items(): # pylint: disable=unused-variable # noqa: B007 status_by_course[key]['verification_good_until'] = recent_verification_datetime.strftime("%m/%d/%Y") return status_by_course @@ -714,14 +714,14 @@ def do_create_account(form, custom_form=None): # AccountValidationError and a consistent user message returned (i.e. both should # return "It looks like {username} belongs to an existing account. Try again with a # different username.") - if username_exists_or_retired(user.username): # lint-amnesty, pylint: disable=no-else-raise - raise AccountValidationError( # lint-amnesty, pylint: disable=raise-missing-from + if username_exists_or_retired(user.username): # pylint: disable=no-else-raise + raise AccountValidationError( # pylint: disable=raise-missing-from # noqa: B904 USERNAME_EXISTS_MSG_FMT.format(username=proposed_username), field="username", error_code='duplicate-username', ) elif email_exists_or_retired(user.email): - raise AccountValidationError( # lint-amnesty, pylint: disable=raise-missing-from + raise AccountValidationError( # pylint: disable=raise-missing-from # noqa: B904 _("An account with the Email '{email}' already exists.").format(email=user.email), field="email", error_code='duplicate-email' diff --git a/common/djangoapps/student/management/commands/_create_users.py b/common/djangoapps/student/management/commands/_create_users.py index f3e739ac48df..fa8a8e2988b7 100644 --- a/common/djangoapps/student/management/commands/_create_users.py +++ b/common/djangoapps/student/management/commands/_create_users.py @@ -1,14 +1,12 @@ """ Shared behavior between create_test_users and create_random_users """ from django.contrib.auth import get_user_model from django.core.validators import ValidationError -from xmodule.modulestore.django import modulestore - +from common.djangoapps.student.helpers import AccountValidationError, do_create_account +from common.djangoapps.student.models import CourseEnrollment from lms.djangoapps.instructor.access import allow_access from openedx.core.djangoapps.user_authn.views.registration_form import AccountCreationForm -from common.djangoapps.student.helpers import do_create_account, AccountValidationError -from common.djangoapps.student.models import CourseEnrollment - +from xmodule.modulestore.django import modulestore User = get_user_model() @@ -47,7 +45,7 @@ def create_users( raise account_creation_error except User.DoesNotExist: # If a user with the username doesn't exist the error was probably something else, so reraise - raise account_creation_error # pylint: disable=raise-missing-from + raise account_creation_error # pylint: disable=raise-missing-from # noqa: B904 if activate: user.is_active = True diff --git a/common/djangoapps/student/management/commands/add_to_group.py b/common/djangoapps/student/management/commands/add_to_group.py index ea95f0f7a5b0..b0cacd917367 100644 --- a/common/djangoapps/student/management/commands/add_to_group.py +++ b/common/djangoapps/student/management/commands/add_to_group.py @@ -1,10 +1,10 @@ -# lint-amnesty, pylint: disable=missing-module-docstring +# pylint: disable=missing-module-docstring -from django.contrib.auth.models import Group, User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import Group, User # pylint: disable=imported-auth-user from django.core.management.base import BaseCommand, CommandError -class Command(BaseCommand): # lint-amnesty, pylint: disable=missing-class-docstring +class Command(BaseCommand): # pylint: disable=missing-class-docstring def add_arguments(self, parser): parser.add_argument('name_or_email', help='Username or email address of the user to add or remove') @@ -47,7 +47,7 @@ def handle(self, *args, **options): group = Group(name=group_name) group.save() else: - raise CommandError(f'Group {group_name} does not exist') # lint-amnesty, pylint: disable=raise-missing-from + raise CommandError(f'Group {group_name} does not exist') # pylint: disable=raise-missing-from # noqa: B904 if options['remove']: user.groups.remove(group) diff --git a/common/djangoapps/student/management/commands/anonymized_id_mapping.py b/common/djangoapps/student/management/commands/anonymized_id_mapping.py index 645fad370e86..820db2c9e453 100644 --- a/common/djangoapps/student/management/commands/anonymized_id_mapping.py +++ b/common/djangoapps/student/management/commands/anonymized_id_mapping.py @@ -10,7 +10,7 @@ import csv -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.core.management.base import BaseCommand, CommandError from opaque_keys.edx.keys import CourseKey @@ -39,7 +39,7 @@ def handle(self, *args, **options): # Figure out which students are enrolled in the course students = User.objects.filter(courseenrollment__course_id=course_key) if len(students) == 0: - self.stdout.write("No students enrolled in %s" % str(course_key)) + self.stdout.write("No students enrolled in %s" % str(course_key)) # noqa: UP031 return # Write mapping to output file in CSV format with a simple header @@ -58,4 +58,4 @@ def handle(self, *args, **options): anonymous_id_for_user(student, course_key) )) except OSError: - raise CommandError("Error writing to file: %s" % output_filename) # lint-amnesty, pylint: disable=raise-missing-from + raise CommandError("Error writing to file: %s" % output_filename) # pylint: disable=raise-missing-from # noqa: B904, UP031 diff --git a/common/djangoapps/student/management/commands/assigngroups.py b/common/djangoapps/student/management/commands/assigngroups.py index eb9dc21d26d5..63402a84e66e 100644 --- a/common/djangoapps/student/management/commands/assigngroups.py +++ b/common/djangoapps/student/management/commands/assigngroups.py @@ -1,4 +1,4 @@ -# lint-amnesty, pylint: disable=missing-module-docstring +# pylint: disable=missing-module-docstring import datetime import json @@ -7,7 +7,7 @@ from textwrap import dedent from zoneinfo import ZoneInfo -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.core.management.base import BaseCommand from common.djangoapps.student.models import UserTestGroup @@ -28,10 +28,10 @@ def group_from_value(groups, v): curr_sum = curr_sum + p_value if curr_sum > v: return group - return group # For round-off errors # lint-amnesty, pylint: disable=undefined-loop-variable + return group # For round-off errors # pylint: disable=undefined-loop-variable -class Command(BaseCommand): # lint-amnesty, pylint: disable=missing-class-docstring +class Command(BaseCommand): # pylint: disable=missing-class-docstring help = dedent(""" Assign users to test groups. Takes a list of groups: a:0.3,b:0.4,c:0.3 file.txt "Testing something" @@ -54,7 +54,7 @@ def handle(self, *args, **options): print("Groups", groups) # Confirm group probabilities add up to 1 - total = sum(zip(*groups)[1]) # lint-amnesty, pylint: disable=unsubscriptable-object + total = sum(zip(*groups)[1]) # pylint: disable=unsubscriptable-object # noqa: B905 print("Total:", total) if abs(total - 1) > 0.01: print("Total not 1") @@ -68,13 +68,13 @@ def handle(self, *args, **options): group_objects = {} - f = open(options['log_name'], "a+") # lint-amnesty, pylint: disable=consider-using-with + f = open(options['log_name'], "a+") # pylint: disable=consider-using-with # Create groups for group in dict(groups): utg = UserTestGroup() utg.name = group - utg.description = json.dumps({"description": options['description']}, # lint-amnesty, pylint: disable=too-many-function-args + utg.description = json.dumps({"description": options['description']}, # pylint: disable=too-many-function-args {"time": datetime.datetime.now(ZoneInfo("UTC")).isoformat()}) group_objects[group] = utg group_objects[group].save() @@ -89,7 +89,7 @@ def handle(self, *args, **options): v = random.uniform(0, 1) group = group_from_value(groups, v) group_objects[group].users.add(user) - f.write("Assigned user {name} ({id}) to {group}\n".format( + f.write("Assigned user {name} ({id}) to {group}\n".format( # noqa: UP032 name=user.username, id=user.id, group=group diff --git a/common/djangoapps/student/management/commands/backfill_is_disabled.py b/common/djangoapps/student/management/commands/backfill_is_disabled.py index b941bbc5cb82..cfd13e8b5bbf 100644 --- a/common/djangoapps/student/management/commands/backfill_is_disabled.py +++ b/common/djangoapps/student/management/commands/backfill_is_disabled.py @@ -9,12 +9,14 @@ import logging import time -from django.core.management.base import BaseCommand + +import requests from django.contrib.auth import get_user_model from django.contrib.auth.hashers import UNUSABLE_PASSWORD_PREFIX +from django.core.management.base import BaseCommand from django.db import DatabaseError + from common.djangoapps.track import segment -import requests LOGGER = logging.getLogger(__name__) User = get_user_model() diff --git a/common/djangoapps/student/management/commands/bulk_change_enrollment.py b/common/djangoapps/student/management/commands/bulk_change_enrollment.py index 0b71ac67e254..b243741b8ba6 100644 --- a/common/djangoapps/student/management/commands/bulk_change_enrollment.py +++ b/common/djangoapps/student/management/commands/bulk_change_enrollment.py @@ -9,9 +9,9 @@ from opaque_keys.edx.keys import CourseKey from common.djangoapps.course_modes.models import CourseMode -from openedx.core.djangoapps.content.course_overviews.models import CourseOverview from common.djangoapps.student.models import CourseEnrollment -from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order +from openedx.core.djangoapps.content.course_overviews.models import CourseOverview +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order logger = logging.getLogger(__name__) # pylint: disable=invalid-name @@ -67,7 +67,7 @@ def handle(self, *args, **options): try: course_key = CourseKey.from_string(course_id) except InvalidKeyError: - raise CommandError(f'Course ID {course_id} is invalid.') # lint-amnesty, pylint: disable=raise-missing-from + raise CommandError(f'Course ID {course_id} is invalid.') # pylint: disable=raise-missing-from # noqa: B904 if modulestore().get_course(course_key) is None: raise CommandError(f'The given course {course_id} does not exist.') diff --git a/common/djangoapps/student/management/commands/bulk_change_enrollment_csv.py b/common/djangoapps/student/management/commands/bulk_change_enrollment_csv.py index 69f2e35de44a..3b307f9b0c35 100644 --- a/common/djangoapps/student/management/commands/bulk_change_enrollment_csv.py +++ b/common/djangoapps/student/management/commands/bulk_change_enrollment_csv.py @@ -6,17 +6,20 @@ import logging from os import path -import unicodecsv +import unicodecsv from django.core.exceptions import ObjectDoesNotExist from django.core.management.base import BaseCommand, CommandError from django.db import transaction from opaque_keys import InvalidKeyError from opaque_keys.edx.keys import CourseKey -from common.djangoapps.student.models import CourseEnrollment, CourseEnrollmentAttribute, User - -from common.djangoapps.student.models import BulkChangeEnrollmentConfiguration +from common.djangoapps.student.models import ( + BulkChangeEnrollmentConfiguration, + CourseEnrollment, + CourseEnrollmentAttribute, + User, +) logger = logging.getLogger('common.djangoapps.student.management.commands.bulk_change_enrollment_csv') diff --git a/common/djangoapps/student/management/commands/bulk_unenroll.py b/common/djangoapps/student/management/commands/bulk_unenroll.py index 4c73f3dbb943..c2d2acca9a90 100644 --- a/common/djangoapps/student/management/commands/bulk_unenroll.py +++ b/common/djangoapps/student/management/commands/bulk_unenroll.py @@ -7,7 +7,8 @@ from django.core.management.base import BaseCommand from opaque_keys import InvalidKeyError from opaque_keys.edx.keys import CourseKey -from common.djangoapps.student.models import CourseEnrollment, BulkUnenrollConfiguration + +from common.djangoapps.student.models import BulkUnenrollConfiguration, CourseEnrollment logger = logging.getLogger(__name__) # pylint: disable=invalid-name @@ -83,7 +84,7 @@ def unenroll_learners(self, course_id, username=None): for enrollment in enrollments: enrollment.update_enrollment(is_active=False, skip_refund=True) logger.info( - "User [{}] have been successfully unenrolled from the course: {}".format( + "User [{}] have been successfully unenrolled from the course: {}".format( # noqa: UP032 enrollment.user.username, course_key ) ) diff --git a/common/djangoapps/student/management/commands/bulk_update_email.py b/common/djangoapps/student/management/commands/bulk_update_email.py index e5c191a0ad12..7e5d0ab62fbd 100644 --- a/common/djangoapps/student/management/commands/bulk_update_email.py +++ b/common/djangoapps/student/management/commands/bulk_update_email.py @@ -7,9 +7,8 @@ import logging from os import path -from django.core.management.base import BaseCommand, CommandError - from django.contrib.auth import get_user_model +from django.core.management.base import BaseCommand, CommandError logger = logging.getLogger('common.djangoapps.student.management.commands.bulk_update_email') @@ -67,5 +66,5 @@ def handle(self, *args, **options): len(failed_updates) ) - if (failed_updates): # lint-amnesty, pylint: disable=superfluous-parens - exit(-1) # lint-amnesty, pylint: disable=consider-using-sys-exit + if (failed_updates): # pylint: disable=superfluous-parens + exit(-1) # pylint: disable=consider-using-sys-exit diff --git a/common/djangoapps/student/management/commands/change_eligibility_deadline.py b/common/djangoapps/student/management/commands/change_eligibility_deadline.py index c44611cc58d9..e6e0b9a3533d 100644 --- a/common/djangoapps/student/management/commands/change_eligibility_deadline.py +++ b/common/djangoapps/student/management/commands/change_eligibility_deadline.py @@ -9,8 +9,8 @@ from opaque_keys.edx.keys import CourseKey from common.djangoapps.course_modes.models import CourseMode -from openedx.core.djangoapps.credit.models import CreditEligibility from common.djangoapps.student.models import CourseEnrollment, User +from openedx.core.djangoapps.credit.models import CreditEligibility logger = logging.getLogger(__name__) # pylint: disable=invalid-name @@ -21,10 +21,10 @@ class IncorrectDeadline(Exception): """ Exception raised explicitly to use default date when date given by user is prior to today. """ - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass -class Command(BaseCommand): # lint-amnesty, pylint: disable=missing-class-docstring +class Command(BaseCommand): # pylint: disable=missing-class-docstring help = """ Changes the credit course eligibility deadline for a student in a particular course. @@ -75,7 +75,7 @@ def handle(self, *args, **options): logger.exception(f'Invalid or non-existent course id {course_id}') raise except CourseEnrollment.DoesNotExist: - logger.exception('No enrollment found in database for {username} in course {course_id}' + logger.exception('No enrollment found in database for {username} in course {course_id}' # noqa: UP032 .format(username=username, course_id=course_id)) raise diff --git a/common/djangoapps/student/management/commands/change_enrollment.py b/common/djangoapps/student/management/commands/change_enrollment.py index fa322fdd7be0..a6d9b5ef3ecc 100644 --- a/common/djangoapps/student/management/commands/change_enrollment.py +++ b/common/djangoapps/student/management/commands/change_enrollment.py @@ -8,8 +8,8 @@ from opaque_keys import InvalidKeyError from opaque_keys.edx.keys import CourseKey -from openedx.core.djangoapps.credit.email_utils import get_credit_provider_attribute_values from common.djangoapps.student.models import CourseEnrollment, CourseEnrollmentAttribute, User +from openedx.core.djangoapps.credit.email_utils import get_credit_provider_attribute_values logger = logging.getLogger(__name__) # pylint: disable=invalid-name @@ -18,10 +18,10 @@ class RollbackException(Exception): """ Exception raised explicitly to cause a database transaction rollback. """ - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass -class Command(BaseCommand): # lint-amnesty, pylint: disable=missing-class-docstring +class Command(BaseCommand): # pylint: disable=missing-class-docstring help = """ Changes the enrollment status for students that meet @@ -76,7 +76,7 @@ def handle(self, *args, **options): try: course_key = CourseKey.from_string(options['course_id']) except InvalidKeyError: - raise CommandError('Invalid or non-existant course id {}'.format(options['course_id'])) # lint-amnesty, pylint: disable=raise-missing-from + raise CommandError('Invalid or non-existant course id {}'.format(options['course_id'])) # pylint: disable=raise-missing-from # noqa: B904 if not options['username'] and not options['email']: raise CommandError('You must include usernames (-u) or emails (-e) to select users to update') @@ -97,7 +97,7 @@ def handle(self, *args, **options): self.report(error_users, success_users) - def update_enrollments(self, identifier, enrollment_args, options, error_users, success_users, enrollment_attrs=None): # lint-amnesty, pylint: disable=line-too-long + def update_enrollments(self, identifier, enrollment_args, options, error_users, success_users, enrollment_attrs=None): # pylint: disable=line-too-long """ Update enrollments for a specific user identifier (email or username). """ users = options[identifier].split(",") diff --git a/common/djangoapps/student/management/commands/change_enterprise_user_username.py b/common/djangoapps/student/management/commands/change_enterprise_user_username.py deleted file mode 100644 index 51d037f6a3e2..000000000000 --- a/common/djangoapps/student/management/commands/change_enterprise_user_username.py +++ /dev/null @@ -1,60 +0,0 @@ -""" -Django management command for changing an enterprise user's username. -""" - - -import logging - -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user -from django.core.management import BaseCommand - -from enterprise.models import EnterpriseCustomerUser - -LOGGER = logging.getLogger(__name__) - - -class Command(BaseCommand): - """ - Updates the username value for a given user. - - This is NOT MEANT for general use, and is specifically limited to Enterprise Users since - only they could potentially experience the issue of overwritten usernames. - - See ENT-832 for details on the bug that modified usernames for some Enterprise Users. - """ - help = 'Update the username of a given user.' - - def add_arguments(self, parser): - parser.add_argument( - '-u', - '--user_id', - action='store', - dest='user_id', - default=None, - help='The ID of the user to update.' - ) - - parser.add_argument( - '-n', - '--new_username', - action='store', - dest='new_username', - default=None, - help='The username value to set for the user.' - ) - - def handle(self, *args, **options): - user_id = options.get('user_id') - new_username = options.get('new_username') - - try: - EnterpriseCustomerUser.objects.get(user_id=user_id) - except EnterpriseCustomerUser.DoesNotExist: - LOGGER.info(f'User {user_id} must be an Enterprise User.') - return - - user = User.objects.get(id=user_id) - user.username = new_username - user.save() - - LOGGER.info(f'User {user_id} has been updated with username {new_username}.') diff --git a/common/djangoapps/student/management/commands/create_random_users.py b/common/djangoapps/student/management/commands/create_random_users.py index 8516eff83f66..433440b2b1b5 100644 --- a/common/djangoapps/student/management/commands/create_random_users.py +++ b/common/djangoapps/student/management/commands/create_random_users.py @@ -20,7 +20,7 @@ def random_user_data_generator(num_users): } -class Command(BaseCommand): # lint-amnesty, pylint: disable=missing-class-docstring +class Command(BaseCommand): # pylint: disable=missing-class-docstring help = """Create N new users, with random parameters. Usage: create_random_users.py N [course_id_to_enroll_in]. diff --git a/common/djangoapps/student/management/commands/populate_created_on_site_user_attribute.py b/common/djangoapps/student/management/commands/populate_created_on_site_user_attribute.py index 32350d6d9ed9..6e33fc13c68b 100644 --- a/common/djangoapps/student/management/commands/populate_created_on_site_user_attribute.py +++ b/common/djangoapps/student/management/commands/populate_created_on_site_user_attribute.py @@ -4,7 +4,7 @@ import six -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.contrib.sites.models import Site from django.core.management.base import BaseCommand, CommandError diff --git a/common/djangoapps/student/management/commands/recover_account.py b/common/djangoapps/student/management/commands/recover_account.py index 7b156abdc510..c6e06031bbc2 100644 --- a/common/djangoapps/student/management/commands/recover_account.py +++ b/common/djangoapps/student/management/commands/recover_account.py @@ -4,14 +4,14 @@ import logging from os import path -import unicodecsv -from django.db.models import Q -from django.contrib.sites.models import Site -from django.core.management.base import BaseCommand, CommandError -from django.contrib.auth import get_user_model +import unicodecsv from django.conf import settings +from django.contrib.auth import get_user_model from django.contrib.auth.tokens import default_token_generator +from django.contrib.sites.models import Site +from django.core.management.base import BaseCommand, CommandError +from django.db.models import Q from django.urls import reverse from django.utils.http import int_to_base36 from edx_ace import ace @@ -19,12 +19,12 @@ from eventtracking import tracker from common.djangoapps.student.models import AccountRecoveryConfiguration -from openedx.core.djangoapps.user_authn.toggles import should_redirect_to_authn_microfrontend from openedx.core.djangoapps.ace_common.template_context import get_base_template_context from openedx.core.djangoapps.lang_pref import LANGUAGE_KEY from openedx.core.djangoapps.site_configuration import helpers as configuration_helpers from openedx.core.djangoapps.user_api.preferences.api import get_user_preference from openedx.core.djangoapps.user_authn.message_types import PasswordReset +from openedx.core.djangoapps.user_authn.toggles import should_redirect_to_authn_microfrontend from openedx.core.lib.celery.task_utils import emulate_http_request logger = logging.getLogger(__name__) # pylint: disable=invalid-name @@ -96,13 +96,13 @@ def handle(self, *args, **options): self.send_password_reset_email(user, site) successful_updates.append(desired_email) except Exception as exc: # pylint: disable=broad-except - logger.exception('Unable to send email to {desired_email} and exception was {exp}'. + logger.exception('Unable to send email to {desired_email} and exception was {exp}'. # noqa: UP032 format(desired_email=desired_email, exp=exc) ) failed_updates.append(current_email) - logger.info('Successfully updated {successful} accounts. Failed to update {failed} ' + logger.info('Successfully updated {successful} accounts. Failed to update {failed} ' # noqa: UP032 'accounts'.format(successful=successful_updates, failed=failed_updates) ) diff --git a/common/djangoapps/student/management/commands/set_staff.py b/common/djangoapps/student/management/commands/set_staff.py index 579f4775e8ba..90c2879870fd 100644 --- a/common/djangoapps/student/management/commands/set_staff.py +++ b/common/djangoapps/student/management/commands/set_staff.py @@ -1,12 +1,12 @@ -# lint-amnesty, pylint: disable=missing-module-docstring +# pylint: disable=missing-module-docstring import re -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.core.management.base import BaseCommand -class Command(BaseCommand): # lint-amnesty, pylint: disable=missing-class-docstring +class Command(BaseCommand): # pylint: disable=missing-class-docstring help = """ This command will set is_staff to true for one or more users. @@ -41,7 +41,7 @@ def handle(self, *args, **options): print(f'Modified {user} sucessfully.') except Exception as err: # pylint: disable=broad-except - print("Error modifying user with identifier {}: {}: {}".format(user, type(err).__name__, + print("Error modifying user with identifier {}: {}: {}".format(user, type(err).__name__, # noqa: UP032 str(err))) print('Complete!') diff --git a/common/djangoapps/student/management/commands/set_superuser.py b/common/djangoapps/student/management/commands/set_superuser.py index aa73b7498c51..eba126646296 100644 --- a/common/djangoapps/student/management/commands/set_superuser.py +++ b/common/djangoapps/student/management/commands/set_superuser.py @@ -1,7 +1,7 @@ """Management command to grant or revoke superuser access for one or more users""" -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.core.management.base import BaseCommand @@ -41,7 +41,7 @@ def handle(self, *args, **options): print(f'Modified {user} sucessfully.') except Exception as err: # pylint: disable=broad-except - print("Error modifying user with identifier {}: {}: {}".format(user, type(err).__name__, + print("Error modifying user with identifier {}: {}: {}".format(user, type(err).__name__, # noqa: UP032 str(err))) print('Complete!') diff --git a/common/djangoapps/student/management/commands/transfer_students.py b/common/djangoapps/student/management/commands/transfer_students.py index 3d170477860b..0cb1926b555e 100644 --- a/common/djangoapps/student/management/commands/transfer_students.py +++ b/common/djangoapps/student/management/commands/transfer_students.py @@ -5,7 +5,7 @@ from textwrap import dedent -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.db import transaction from opaque_keys.edx.keys import CourseKey @@ -17,7 +17,7 @@ class TransferStudentError(Exception): """ Generic Error when handling student transfers. """ - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass class Command(TrackedCommand): diff --git a/common/djangoapps/student/management/commands/unsubscribe_user_email.py b/common/djangoapps/student/management/commands/unsubscribe_user_email.py index f24db4cef801..c6ca071ec317 100644 --- a/common/djangoapps/student/management/commands/unsubscribe_user_email.py +++ b/common/djangoapps/student/management/commands/unsubscribe_user_email.py @@ -50,11 +50,11 @@ def handle(self, *args, **options): csv_file_path = options['csv_path'] try: - with open(csv_file_path, 'r') as csv_file: + with open(csv_file_path, 'r') as csv_file: # noqa: UP015 reader = list(csv.DictReader(csv_file)) emails = [row.get('email') for row in reader] except FileNotFoundError as exc: - raise CommandError(f"Error: File not found due to exception - {exc}") # lint-amnesty, pylint: disable=raise-missing-from + raise CommandError(f"Error: File not found due to exception - {exc}") # pylint: disable=raise-missing-from # noqa: B904 except csv.Error as exc: logger.exception(f"CSV error: {exc}") else: diff --git a/common/djangoapps/student/management/tests/test_bulk_change_enrollment.py b/common/djangoapps/student/management/tests/test_bulk_change_enrollment.py index 4d98679c7cd4..a887edf7b913 100644 --- a/common/djangoapps/student/management/tests/test_bulk_change_enrollment.py +++ b/common/djangoapps/student/management/tests/test_bulk_change_enrollment.py @@ -12,8 +12,10 @@ from common.djangoapps.student.models import EVENT_NAME_ENROLLMENT_MODE_CHANGED, CourseEnrollment from common.djangoapps.student.tests.factories import CourseEnrollmentFactory, UserFactory from openedx.core.djangoapps.content.course_overviews.models import CourseOverview -from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + SharedModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order @ddt.ddt @@ -38,7 +40,7 @@ def test_bulk_convert(self, from_mode, to_mode, mock_tracker): # Verify that no users are in the `from` mode yet. assert len(CourseEnrollment.objects.filter(mode=to_mode, course_id=self.course.id)) == 0 - args = '--course {course} --from_mode {from_mode} --to_mode {to_mode} --commit'.format( + args = '--course {course} --from_mode {from_mode} --to_mode {to_mode} --commit'.format( # noqa: UP032 course=str(self.course.id), from_mode=from_mode, to_mode=to_mode @@ -73,7 +75,7 @@ def test_bulk_convert_with_org(self, from_mode, to_mode, mock_tracker): assert len(CourseEnrollment.objects.filter(mode=to_mode, course_id=self.course.id)) == 0 assert len(CourseEnrollment.objects.filter(mode=to_mode, course_id=course_2.id)) == 0 - args = '--org {org} --from_mode {from_mode} --to_mode {to_mode} --commit'.format( + args = '--org {org} --from_mode {from_mode} --to_mode {to_mode} --commit'.format( # noqa: UP032 org=self.org, from_mode=from_mode, to_mode=to_mode @@ -125,7 +127,7 @@ def test_with_org_and_invalid_to_mode(self, mock_tracker): assert len(CourseEnrollment.objects.filter(mode=to_mode, course_id=self.course.id)) == 0 assert len(CourseEnrollment.objects.filter(mode=to_mode, course_id=course_2.id)) == 0 - args = '--org {org} --from_mode {from_mode} --to_mode {to_mode} --commit'.format( + args = '--org {org} --from_mode {from_mode} --to_mode {to_mode} --commit'.format( # noqa: UP032 org=self.org, from_mode=from_mode, to_mode=to_mode @@ -152,7 +154,7 @@ def test_with_invalid_org(self): self._enroll_users(self.course, self.users, 'audit') CourseModeFactory(course_id=self.course.id, mode_slug='no-id-professional') - with pytest.raises(CommandError) as err: + with pytest.raises(CommandError) as err: # noqa: PT012 args = '--org {org} --from_mode {from_mode} --to_mode {to_mode} --commit'.format( org='fakeX', from_mode='audit', diff --git a/common/djangoapps/student/management/tests/test_bulk_change_enrollment_csv.py b/common/djangoapps/student/management/tests/test_bulk_change_enrollment_csv.py index b2b8176049ee..cb0482445029 100644 --- a/common/djangoapps/student/management/tests/test_bulk_change_enrollment_csv.py +++ b/common/djangoapps/student/management/tests/test_bulk_change_enrollment_csv.py @@ -1,4 +1,4 @@ -# lint-amnesty, pylint: disable=missing-module-docstring +# pylint: disable=missing-module-docstring from tempfile import NamedTemporaryFile @@ -13,8 +13,10 @@ from common.djangoapps.student.models import BulkChangeEnrollmentConfiguration, CourseEnrollment from common.djangoapps.student.tests.factories import UserFactory from openedx.core.djangolib.testing.utils import skip_unless_lms -from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + SharedModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order LOGGER_NAME = 'common.djangoapps.student.management.commands.bulk_change_enrollment_csv' diff --git a/common/djangoapps/student/management/tests/test_bulk_unenroll.py b/common/djangoapps/student/management/tests/test_bulk_unenroll.py index fc48af3282e1..4a504c625c91 100644 --- a/common/djangoapps/student/management/tests/test_bulk_unenroll.py +++ b/common/djangoapps/student/management/tests/test_bulk_unenroll.py @@ -9,8 +9,10 @@ from common.djangoapps.course_modes.tests.factories import CourseModeFactory from common.djangoapps.student.models import BulkUnenrollConfiguration, CourseEnrollment from common.djangoapps.student.tests.factories import UserFactory -from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + SharedModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order LOGGER_NAME = 'common.djangoapps.student.management.commands.bulk_unenroll' @@ -128,7 +130,7 @@ def test_users_unenroll_successfully_logged(self): ( LOGGER_NAME, 'INFO', - 'User [{}] have been successfully unenrolled from the course: {}'.format( + 'User [{}] have been successfully unenrolled from the course: {}'.format( # noqa: UP032 self.enrollments[0].username, self.enrollments[0].course.id ) ), diff --git a/common/djangoapps/student/management/tests/test_change_eligibility_deadline.py b/common/djangoapps/student/management/tests/test_change_eligibility_deadline.py index 1cbfa1b2c846..b04a5accf6eb 100644 --- a/common/djangoapps/student/management/tests/test_change_eligibility_deadline.py +++ b/common/djangoapps/student/management/tests/test_change_eligibility_deadline.py @@ -2,18 +2,20 @@ from datetime import datetime, timedelta -import pytest +import pytest from django.core.management import call_command from opaque_keys import InvalidKeyError from testfixtures import LogCapture from common.djangoapps.course_modes.tests.factories import CourseMode -from openedx.core.djangoapps.credit.models import CreditCourse, CreditEligibility from common.djangoapps.student.models import CourseEnrollment, User from common.djangoapps.student.tests.factories import UserFactory -from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from openedx.core.djangoapps.credit.models import CreditCourse, CreditEligibility +from xmodule.modulestore.tests.django_utils import ( + SharedModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order LOGGER_NAME = 'common.djangoapps.student.management.commands.change_eligibility_deadline' command_args = '--username {username} --course {course} --date {date}' @@ -54,14 +56,14 @@ def test_invalid_command_arguments(self): *command_args.format(username=username, course='XYZ', date='2018-12-30').split(' ') ) # Student not enrolled - with pytest.raises(CourseEnrollment.DoesNotExist): + with pytest.raises(CourseEnrollment.DoesNotExist): # noqa: PT012 unenrolled_user = UserFactory.create() call_command('change_eligibility_deadline', *command_args.format(username=unenrolled_user.username, course=course_id_str, date='2018-12-30').split(' ') ) # Date format Invalid - with pytest.raises(ValueError): + with pytest.raises(ValueError): # noqa: PT011 call_command('change_eligibility_deadline', *command_args.format(username=username, course=course_id_str, date='30-12-2018').split(' ') ) diff --git a/common/djangoapps/student/management/tests/test_change_enrollment.py b/common/djangoapps/student/management/tests/test_change_enrollment.py index 61e024cbc83a..a00d1d29d646 100644 --- a/common/djangoapps/student/management/tests/test_change_enrollment.py +++ b/common/djangoapps/student/management/tests/test_change_enrollment.py @@ -9,8 +9,10 @@ from common.djangoapps.course_modes.tests.factories import CourseModeFactory from common.djangoapps.student.models import CourseEnrollment from common.djangoapps.student.tests.factories import UserFactory -from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + SharedModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order @ddt.ddt @@ -62,7 +64,7 @@ def test_convert_users(self, method, noop, expected_conversions, mock_logger): # Hack around call_command bugs dealing with required options see: # https://stackoverflow.com/questions/32036562/call-command-argument-is-required - command_args = '--course {course} --to honor --from audit --{method} {user_str}{noop}'.format( + command_args = '--course {course} --to honor --from audit --{method} {user_str}{noop}'.format( # noqa: UP032 course=str(self.course.id), noop=noop, method=method, @@ -95,7 +97,7 @@ def test_user_not_found(self, method, fake_user, expected_success, mock_logger): # Verify users are not in honor mode yet assert len(CourseEnrollment.objects.filter(mode='honor', user_id__in=real_user_ids)) == 0 - command_args = '--course {course} --to honor --from audit --{method} {user_str}'.format( + command_args = '--course {course} --to honor --from audit --{method} {user_str}'.format( # noqa: UP032 course=str(self.course.id), method=method, user_str=user_str diff --git a/common/djangoapps/student/management/tests/test_change_enterprise_user_username.py b/common/djangoapps/student/management/tests/test_change_enterprise_user_username.py deleted file mode 100644 index a1354feab555..000000000000 --- a/common/djangoapps/student/management/tests/test_change_enterprise_user_username.py +++ /dev/null @@ -1,67 +0,0 @@ -""" -Tests for the django management command `change_enterprise_user_username`. -""" - - -from unittest import mock -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user -from django.contrib.sites.models import Site -from django.core.management import call_command -from django.db.models.signals import post_save -from django.test import TestCase -from enterprise.models import EnterpriseCustomer, EnterpriseCustomerUser -from pytest import mark - -from common.djangoapps.student.tests.factories import UserFactory - - -@mark.django_db -class ChangeEnterpriseUserUsernameCommandTests(TestCase): - """ - Test command `change_enterprise_user_username`. - """ - command = 'change_enterprise_user_username' - - @mock.patch('common.djangoapps.student.management.commands.change_enterprise_user_username.LOGGER') - def test_user_not_enterprise(self, logger_mock): - """ - Test that the command does not update a user's username if it is not linked to an Enterprise. - """ - user = UserFactory.create(is_active=True, username='old_username', email='test@example.com') - new_username = 'new_username' - - post_save_handler = mock.MagicMock() - post_save.connect(post_save_handler, sender=User) - - call_command(self.command, user_id=user.id, new_username=new_username) - - logger_mock.info.assert_called_with(f'User {user.id} must be an Enterprise User.') - post_save_handler.assert_not_called() - - @mock.patch('common.djangoapps.student.management.commands.change_enterprise_user_username.LOGGER') - def test_username_updated_successfully(self, logger_mock): - """ - Test that the command updates the user's username when the user is linked to an Enterprise. - """ - user = UserFactory.create(is_active=True, username='old_username', email='test@example.com') - site, _ = Site.objects.get_or_create(domain='example.com') - enterprise_customer = EnterpriseCustomer.objects.create( - name='Test EnterpriseCustomer', - site=site - ) - EnterpriseCustomerUser.objects.create( - user_id=user.id, - enterprise_customer=enterprise_customer - ) - new_username = 'new_username' - - post_save_handler = mock.MagicMock() - post_save.connect(post_save_handler, sender=User) - - call_command(self.command, user_id=user.id, new_username=new_username) - - logger_mock.info.assert_called_with(f'User {user.id} has been updated with username {new_username}.') - post_save_handler.assert_called() - - updated_user = User.objects.get(id=user.id) - assert updated_user.username == new_username diff --git a/common/djangoapps/student/management/tests/test_create_random_users.py b/common/djangoapps/student/management/tests/test_create_random_users.py index dace6f6fd9cf..328bb8f9a6fe 100644 --- a/common/djangoapps/student/management/tests/test_create_random_users.py +++ b/common/djangoapps/student/management/tests/test_create_random_users.py @@ -9,8 +9,10 @@ from opaque_keys import InvalidKeyError from common.djangoapps.student.models import CourseEnrollment -from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + SharedModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order class CreateRandomUserTests(SharedModuleStoreTestCase): diff --git a/common/djangoapps/student/management/tests/test_create_test_users.py b/common/djangoapps/student/management/tests/test_create_test_users.py index 9258b15f4fea..b3a1f3e5a612 100644 --- a/common/djangoapps/student/management/tests/test_create_test_users.py +++ b/common/djangoapps/student/management/tests/test_create_test_users.py @@ -13,8 +13,10 @@ from common.djangoapps.student.helpers import AccountValidationError from common.djangoapps.student.models import CourseAccessRole, CourseEnrollment from common.djangoapps.student.roles import CourseStaffRole -from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + SharedModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order @ddt.ddt @@ -226,7 +228,7 @@ def test_create_user__ignore_user_already_exists(self): self.call_command([test_username]) assert self.user_model.objects.filter(username=test_username).exists() - with self.assertRaises(ValidationError): + with self.assertRaises(ValidationError): # noqa: PT027 self.call_command([test_username], ignore_user_already_exists=False) self.call_command([test_username], ignore_user_already_exists=True) diff --git a/common/djangoapps/student/management/tests/test_populate_created_on_site_user_attribute.py b/common/djangoapps/student/management/tests/test_populate_created_on_site_user_attribute.py index 27acadc7be97..61dfe1434485 100644 --- a/common/djangoapps/student/management/tests/test_populate_created_on_site_user_attribute.py +++ b/common/djangoapps/student/management/tests/test_populate_created_on_site_user_attribute.py @@ -7,7 +7,7 @@ import ddt import pytest -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.core.management import CommandError, call_command from django.test import TestCase diff --git a/common/djangoapps/student/management/tests/test_recover_account.py b/common/djangoapps/student/management/tests/test_recover_account.py index cb637ec71989..b0cacdb5d77e 100644 --- a/common/djangoapps/student/management/tests/test_recover_account.py +++ b/common/djangoapps/student/management/tests/test_recover_account.py @@ -3,20 +3,18 @@ """ import re from tempfile import NamedTemporaryFile -import pytest -from django.core import mail +import pytest from django.conf import settings from django.contrib.auth import get_user_model -from django.core.management import call_command, CommandError +from django.core import mail from django.core.files.uploadedfile import SimpleUploadedFile -from django.test import TestCase, RequestFactory, override_settings - - +from django.core.management import CommandError, call_command +from django.test import RequestFactory, TestCase, override_settings from testfixtures import LogCapture -from common.djangoapps.student.tests.factories import UserFactory -from common.djangoapps.student.models import AccountRecoveryConfiguration +from common.djangoapps.student.models import AccountRecoveryConfiguration +from common.djangoapps.student.tests.factories import UserFactory from openedx.core.djangolib.testing.utils import skip_unless_lms LOGGER_NAME = 'common.djangoapps.student.management.commands.recover_account' @@ -84,7 +82,7 @@ def test_authn_mfe_url_in_reset_link(self): assert len(mail.outbox) == 1 authn_mfe_url = re.findall(settings.AUTHN_MICROFRONTEND_URL, mail.outbox[0].body)[0] - self.assertEqual(authn_mfe_url, settings.AUTHN_MICROFRONTEND_URL) + self.assertEqual(authn_mfe_url, settings.AUTHN_MICROFRONTEND_URL) # noqa: PT009 def test_file_not_found_error(self): """ diff --git a/common/djangoapps/student/management/tests/test_retrieve_unsubscribed_emails.py b/common/djangoapps/student/management/tests/test_retrieve_unsubscribed_emails.py index e86badf88511..43025043d2c9 100644 --- a/common/djangoapps/student/management/tests/test_retrieve_unsubscribed_emails.py +++ b/common/djangoapps/student/management/tests/test_retrieve_unsubscribed_emails.py @@ -2,8 +2,7 @@ from datetime import datetime, timedelta from tempfile import NamedTemporaryFile -from unittest.mock import call -from unittest.mock import patch, MagicMock +from unittest.mock import MagicMock, call, patch import six from django.conf import settings @@ -71,10 +70,10 @@ def test_retrieve_unsubscribed_emails_command(self, mock_logger_info, mock_get_e ] self._write_test_csv(csv, lines) - with open(filepath, 'r') as csv_file: + with open(filepath, 'r') as csv_file: # noqa: UP015 csv_data = csv_file.read() - self.assertIn('test1@example.com,2023-06-01 10:00:00', csv_data) - self.assertIn('test2@example.com,2023-06-02 12:00:00', csv_data) + self.assertIn('test1@example.com,2023-06-01 10:00:00', csv_data) # noqa: PT009 + self.assertIn('test2@example.com,2023-06-02 12:00:00', csv_data) # noqa: PT009 @override_settings( BRAZE_UNSUBSCRIBED_EMAILS_FROM_EMAIL='test@example.com', @@ -117,10 +116,10 @@ def test_retrieve_unsubscribed_emails_command_with_dates(self, mock_logger_info, ] self._write_test_csv(csv, lines) - with open(filepath, 'r') as csv_file: + with open(filepath, 'r') as csv_file: # noqa: UP015 csv_data = csv_file.read() - self.assertIn('test3@example.com,2023-06-03 08:00:00', csv_data) - self.assertIn('test4@example.com,2023-06-04 14:00:00', csv_data) + self.assertIn('test3@example.com,2023-06-03 08:00:00', csv_data) # noqa: PT009 + self.assertIn('test4@example.com,2023-06-04 14:00:00', csv_data) # noqa: PT009 @patch('common.djangoapps.student.management.commands.retrieve_unsubscribed_emails.EmailMultiAlternatives.send') @patch('common.djangoapps.student.management.commands.retrieve_unsubscribed_emails.get_email_client') @@ -134,7 +133,7 @@ def test_retrieve_unsubscribed_emails_command_braze_exception(self, mock_logger_ mock_email_client.retrieve_unsubscribed_emails.side_effect = Exception('Braze API error') mock_send.return_value = MagicMock() - with self.assertRaises(CommandError): + with self.assertRaises(CommandError): # noqa: PT027 call_command('retrieve_unsubscribed_emails') mock_logger_exception.assert_called_once_with( @@ -179,7 +178,7 @@ def test_retrieve_unsubscribed_emails_command_error_sending_email(self, mock_log ] mock_send.side_effect = Exception('Email sending error') - with self.assertRaises(CommandError): + with self.assertRaises(CommandError): # noqa: PT027 call_command('retrieve_unsubscribed_emails') mock_logger_exception.assert_called_once_with( diff --git a/common/djangoapps/student/management/tests/test_transfer_students.py b/common/djangoapps/student/management/tests/test_transfer_students.py index e25941715147..0bf6372bc20b 100644 --- a/common/djangoapps/student/management/tests/test_transfer_students.py +++ b/common/djangoapps/student/management/tests/test_transfer_students.py @@ -13,13 +13,15 @@ EVENT_NAME_ENROLLMENT_ACTIVATED, EVENT_NAME_ENROLLMENT_DEACTIVATED, EVENT_NAME_ENROLLMENT_MODE_CHANGED, - CourseEnrollment + CourseEnrollment, ) from common.djangoapps.student.signals import UNENROLL_DONE from common.djangoapps.student.tests.factories import UserFactory from openedx.core.djangolib.testing.utils import skip_unless_lms -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + ModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order @skip_unless_lms @@ -32,7 +34,7 @@ class TestTransferStudents(ModuleStoreTestCase): PASSWORD = 'test' signal_fired = False - def setUp(self, **kwargs): # lint-amnesty, pylint: disable=unused-argument + def setUp(self, **kwargs): # pylint: disable=unused-argument """ Connect a stub receiver, and analytics event tracking. """ @@ -138,7 +140,7 @@ def _create_course(self, course_location): run=course_location.run ) - def _create_and_purchase_verified(self, student, course_id): # lint-amnesty, pylint: disable=unused-argument + def _create_and_purchase_verified(self, student, course_id): # pylint: disable=unused-argument """ Creates a verified mode for the course and purchases it for the student. """ diff --git a/common/djangoapps/student/middleware.py b/common/djangoapps/student/middleware.py index 43dcda960d6e..a26412cad242 100644 --- a/common/djangoapps/student/middleware.py +++ b/common/djangoapps/student/middleware.py @@ -9,8 +9,8 @@ from django.utils.deprecation import MiddlewareMixin from django.utils.translation import gettext as _ -from openedx.core.djangolib.markup import HTML, Text from common.djangoapps.student.models import UserStanding +from openedx.core.djangolib.markup import HTML, Text class UserStandingMiddleware(MiddlewareMixin): @@ -18,7 +18,7 @@ class UserStandingMiddleware(MiddlewareMixin): Checks a user's standing on request. Returns a 403 if the user's status is 'disabled'. """ - def process_request(self, request): # lint-amnesty, pylint: disable=missing-function-docstring + def process_request(self, request): # pylint: disable=missing-function-docstring user = request.user try: user_account = UserStanding.objects.get(user=user.id) diff --git a/common/djangoapps/student/migrations/0047_courseaccessrolehistory.py b/common/djangoapps/student/migrations/0047_courseaccessrolehistory.py index ba2f1da9ef76..5a7e8fb4d0aa 100644 --- a/common/djangoapps/student/migrations/0047_courseaccessrolehistory.py +++ b/common/djangoapps/student/migrations/0047_courseaccessrolehistory.py @@ -1,11 +1,11 @@ # Generated by Django 4.2.23 on 2025-08-22 10:13 -from django.conf import settings -from django.db import migrations, models import django.db.models.deletion import django.utils.timezone import model_utils.fields import opaque_keys.edx.django.models +from django.conf import settings +from django.db import migrations, models class Migration(migrations.Migration): diff --git a/common/djangoapps/student/migrations/0049_manualenrollmentaudit_statetransition_typo.py b/common/djangoapps/student/migrations/0049_manualenrollmentaudit_statetransition_typo.py new file mode 100644 index 000000000000..c7fd288f1d00 --- /dev/null +++ b/common/djangoapps/student/migrations/0049_manualenrollmentaudit_statetransition_typo.py @@ -0,0 +1,64 @@ +# Generated by Django 5.2 + +from django.db import migrations, models + + +class Migration(migrations.Migration): + dependencies = [ + ("student", "0048_mariadb_uuid_conversion"), + ] + + operations = [ + migrations.AlterField( + model_name="historicalmanualenrollmentaudit", + name="state_transition", + field=models.CharField( + choices=[ + ( + "from unenrolled to allowed to enroll", + "from unenrolled to allowed to enroll", + ), + ( + "from allowed to enroll to enrolled", + "from allowed to enroll to enrolled", + ), + ("from enrolled to enrolled", "from enrolled to enrolled"), + ("from enrolled to unenrolled", "from enrolled to unenrolled"), + ("from unenrolled to enrolled", "from unenrolled to enrolled"), + ( + "from allowed to enroll to unenrolled", + "from allowed to enroll to unenrolled", + ), + ("from unenrolled to unenrolled", "from unenrolled to unenrolled"), + ("N/A", "N/A"), + ], + max_length=255, + ), + ), + migrations.AlterField( + model_name="manualenrollmentaudit", + name="state_transition", + field=models.CharField( + choices=[ + ( + "from unenrolled to allowed to enroll", + "from unenrolled to allowed to enroll", + ), + ( + "from allowed to enroll to enrolled", + "from allowed to enroll to enrolled", + ), + ("from enrolled to enrolled", "from enrolled to enrolled"), + ("from enrolled to unenrolled", "from enrolled to unenrolled"), + ("from unenrolled to enrolled", "from unenrolled to enrolled"), + ( + "from allowed to enroll to unenrolled", + "from allowed to enroll to unenrolled", + ), + ("from unenrolled to unenrolled", "from unenrolled to unenrolled"), + ("N/A", "N/A"), + ], + max_length=255, + ), + ), + ] diff --git a/common/djangoapps/student/models/__init__.py b/common/djangoapps/student/models/__init__.py index f9cd4c01642c..fd8c287f22b2 100644 --- a/common/djangoapps/student/models/__init__.py +++ b/common/djangoapps/student/models/__init__.py @@ -1,5 +1,5 @@ ''' Student models migrated to folder to tease out the course enrollment aspects from Student ''' -from .course_enrollment import * -from .user import * +from .course_enrollment import * # noqa: F403 +from .user import * # noqa: F403 diff --git a/common/djangoapps/student/models/course_enrollment.py b/common/djangoapps/student/models/course_enrollment.py index 8a23f89a53b3..cbf257b77f46 100644 --- a/common/djangoapps/student/models/course_enrollment.py +++ b/common/djangoapps/student/models/course_enrollment.py @@ -1,15 +1,15 @@ """Models for course enrollment""" -import hashlib # lint-amnesty, pylint: disable=wrong-import-order -import logging # lint-amnesty, pylint: disable=wrong-import-order -import uuid # lint-amnesty, pylint: disable=wrong-import-order -from collections import defaultdict, namedtuple # lint-amnesty, pylint: disable=wrong-import-order -from datetime import date, datetime, timedelta # lint-amnesty, pylint: disable=wrong-import-order +import hashlib # pylint: disable=wrong-import-order +import logging # pylint: disable=wrong-import-order +import uuid # pylint: disable=wrong-import-order +from collections import defaultdict, namedtuple # pylint: disable=wrong-import-order +from datetime import date, datetime, timedelta # pylint: disable=wrong-import-order from urllib.parse import urljoin from zoneinfo import ZoneInfo from config_models.models import ConfigurationModel from django.conf import settings -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.core.cache import cache from django.core.exceptions import MultipleObjectsReturned, ObjectDoesNotExist from django.core.validators import FileExtensionValidator @@ -80,7 +80,7 @@ class EnrollStatusChange: ENROLLED_TO_ENROLLED = 'from enrolled to enrolled' ENROLLED_TO_UNENROLLED = 'from enrolled to unenrolled' UNENROLLED_TO_ENROLLED = 'from unenrolled to enrolled' -ALLOWEDTOENROLL_TO_UNENROLLED = 'from allowed to enroll to enrolled' +ALLOWEDTOENROLL_TO_UNENROLLED = 'from allowed to enroll to unenrolled' UNENROLLED_TO_UNENROLLED = 'from unenrolled to unenrolled' DEFAULT_TRANSITION_STATE = 'N/A' SCORE_RECALCULATION_DELAY_ON_ENROLLMENT_UPDATE = 30 @@ -152,7 +152,7 @@ def with_certificates(self, username): """ return self.filter(course_id__in=self.get_user_course_ids_with_certificates(username)) - def in_progress(self, username, time_zone=ZoneInfo("UTC")): + def in_progress(self, username, time_zone=ZoneInfo("UTC")): # noqa: B008 """ Returns a queryset of CourseEnrollment objects for courses that are currently in progress. """ @@ -170,7 +170,7 @@ def completed(self, username): """ return self.active().with_certificates(username) - def expired(self, username, time_zone=ZoneInfo("UTC")): + def expired(self, username, time_zone=ZoneInfo("UTC")): # noqa: B008 """ Returns a queryset of CourseEnrollment objects for courses that have expired. """ @@ -319,7 +319,7 @@ class CourseEnrollment(models.Model): def course_price(self): return get_cosmetic_verified_display_price(self.course) - created = models.DateTimeField(auto_now_add=True, null=True, db_index=True) + created = models.DateTimeField(auto_now_add=True, null=True, db_index=True) # noqa: DJ012 # If is_active is False, then the student is not considered to be enrolled # in the course (is_enrolled() will return False) @@ -337,19 +337,19 @@ def course_price(self): table_name='student_courseenrollment_history' ) - objects = CourseEnrollmentManager() + objects = CourseEnrollmentManager() # noqa: DJ012 # cache key format e.g enrollment...mode = 'honor' COURSE_ENROLLMENT_CACHE_KEY = "enrollment.{}.{}.mode" MODE_CACHE_NAMESPACE = 'CourseEnrollment.mode_and_active' - class Meta: + class Meta: # noqa: DJ012 unique_together = (('user', 'course'),) indexes = [Index(fields=['user', '-created'])] ordering = ('user', 'course') - def __init__(self, *args, **kwargs): + def __init__(self, *args, **kwargs): # noqa: DJ012 super().__init__(*args, **kwargs) # Private variable for storing course_overview to minimize calls to the database. @@ -357,11 +357,11 @@ def __init__(self, *args, **kwargs): self._course_overview = None def __str__(self): - return ( + return ( # noqa: UP032 "[CourseEnrollment] {}: {} ({}); active: ({})" ).format(self.user, self.course_id, self.created, self.is_active) - def save(self, *args, **kwargs): + def save(self, *args, **kwargs): # noqa: DJ012 super().save(*args, **kwargs) # Delete the cached status hash, forcing the value to be recalculated the next time it is needed. @@ -602,9 +602,9 @@ def emit_event(self, event_name, enterprise_uuid=None): """ Emits an event to explicitly track course enrollment and unenrollment. """ - from openedx.core.djangoapps.schedules.config import set_up_external_updates_for_enrollment - from common.djangoapps.student.toggles import should_send_enrollment_email from common.djangoapps.student.tasks import send_course_enrollment_email + from common.djangoapps.student.toggles import should_send_enrollment_email + from openedx.core.djangoapps.schedules.config import set_up_external_updates_for_enrollment segment_properties = { 'category': 'conversion', @@ -739,7 +739,7 @@ def enroll(cls, user, course_key, mode=None, check_access=False, can_upgrade=Fal ) if check_access: log.warning("User %s failed to enroll in non-existent course %s", user.username, str(course_key)) - raise NonExistentCourseError # lint-amnesty, pylint: disable=raise-missing-from + raise NonExistentCourseError # pylint: disable=raise-missing-from # noqa: B904 if check_access: if cls.is_enrollment_closed(user, course) and not can_upgrade: @@ -1316,9 +1316,9 @@ def dynamic_upgrade_deadline(self): log.debug( 'Schedules: Pulling upgrade deadline for CourseEnrollment %d from Schedule %d.', - self.id, self.schedule.id # lint-amnesty, pylint: disable=no-member + self.id, self.schedule.id # pylint: disable=no-member ) - return self.schedule.upgrade_deadline # lint-amnesty, pylint: disable=no-member + return self.schedule.upgrade_deadline # pylint: disable=no-member except ObjectDoesNotExist: # NOTE: Schedule has a one-to-one mapping with CourseEnrollment. If no schedule is associated # with this enrollment, Django will raise an exception rather than return None. @@ -1421,7 +1421,7 @@ def bulk_fetch_enrollment_states(cls, users, course_key): RequestCache(cls.MODE_CACHE_NAMESPACE).clear() records = cls.objects.filter(user__in=users, course_id=course_key).select_related('user') - cache = cls._get_mode_active_request_cache() # lint-amnesty, pylint: disable=redefined-outer-name + cache = cls._get_mode_active_request_cache() # pylint: disable=redefined-outer-name for record in records: enrollment_state = CourseEnrollmentState(record.mode, record.is_active) cls._update_enrollment_state_in_cache(cache, record.user.id, course_key, enrollment_state) @@ -1451,7 +1451,7 @@ def _update_enrollment_state_in_request_cache(cls, user, course_key, enrollment_ user.id, course_key, enrollment_state) @classmethod - def _update_enrollment_state_in_cache(cls, cache, user_id, course_key, enrollment_state): # lint-amnesty, pylint: disable=redefined-outer-name + def _update_enrollment_state_in_cache(cls, cache, user_id, course_key, enrollment_state): # pylint: disable=redefined-outer-name """ Updates the cached value for the user's enrollment in the given cache. @@ -1515,7 +1515,7 @@ def update_expiry_email_date(sender, instance, **kwargs): # pylint: disable=unu SoftwareSecurePhotoVerification.update_expiry_email_date_for_user(instance.user, email_config) -class ManualEnrollmentAudit(models.Model): +class ManualEnrollmentAudit(models.Model): # noqa: DJ008 """ Table for tracking which enrollments were performed through manual enrollment. @@ -1528,8 +1528,8 @@ class ManualEnrollmentAudit(models.Model): enrolled_email = models.CharField(max_length=255, db_index=True) time_stamp = models.DateTimeField(auto_now_add=True, null=True) state_transition = models.CharField(max_length=255, choices=TRANSITION_STATES) - reason = models.TextField(null=True) - role = models.CharField(blank=True, null=True, max_length=64) + reason = models.TextField(null=True) # noqa: DJ001 + role = models.CharField(blank=True, null=True, max_length=64) # noqa: DJ001 history = HistoricalRecords() @classmethod @@ -1597,7 +1597,9 @@ class CourseEnrollmentAllowed(DeletableByUserValue, models.Model): the object is marked with the student who enrolled, to prevent students from changing e-mails and enrolling many accounts through the same e-mail. - .. no_pii: + .. pii: Contains email, redacted then deleted in AccountRetirementView + .. pii_types: email_address + .. pii_retirement: local_api """ email = models.CharField(max_length=255, db_index=True) course_id = CourseKeyField(max_length=255, db_index=True) @@ -1646,6 +1648,13 @@ def may_enroll_and_unenrolled(cls, course_id): """ return CourseEnrollmentAllowed.objects.filter(course_id=course_id, user__isnull=True) + @classmethod + def redact_before_delete_fields(cls): + """ + Redact email before deleting records for downstream soft-delete systems. + """ + return {'email': 'redacted-before-delete@safe.com'} + class CourseEnrollmentAttribute(models.Model): """ @@ -1669,7 +1678,7 @@ class CourseEnrollmentAttribute(models.Model): def __str__(self): """Unicode representation of the attribute. """ - return "{namespace}:{name}, {value}".format( + return "{namespace}:{name}, {value}".format( # noqa: UP032 namespace=self.namespace, name=self.name, value=self.value, @@ -1754,7 +1763,7 @@ def refund_window(self, refund_window): self.refund_window_microseconds = int(refund_window.total_seconds() * 1000000) -class BulkUnenrollConfiguration(ConfigurationModel): # lint-amnesty, pylint: disable=empty-docstring +class BulkUnenrollConfiguration(ConfigurationModel): # pylint: disable=empty-docstring """ .. no_pii: """ @@ -1802,7 +1811,7 @@ class CourseEnrollmentCelebration(TimeStampedModel): celebrate_weekly_goal = models.BooleanField(default=False) def __str__(self): - return ( + return ( # noqa: UP032 '[CourseEnrollmentCelebration] course: {}; user: {}' ).format(self.enrollment.course.id, self.enrollment.user.username) diff --git a/common/djangoapps/student/models/user.py b/common/djangoapps/student/models/user.py index 8d10db4b0f50..4789f0e47c38 100644 --- a/common/djangoapps/student/models/user.py +++ b/common/djangoapps/student/models/user.py @@ -33,7 +33,7 @@ from django.core.validators import FileExtensionValidator, RegexValidator from django.db import IntegrityError, models from django.db.models import Q -from django.db.models.signals import post_save, pre_save, post_delete +from django.db.models.signals import post_delete, post_save, pre_save from django.db.utils import ProgrammingError from django.dispatch import receiver from django.utils.translation import gettext_lazy as _ @@ -45,7 +45,6 @@ from model_utils.models import TimeStampedModel from opaque_keys.edx.django.models import CourseKeyField, LearningContextKeyField from pytz import UTC, timezone -from openedx.core.lib import user_util import openedx.core.djangoapps.django_comment_common.comment_client as cc from common.djangoapps.util.model_utils import emit_field_changed_events, get_changed_fields_dict @@ -54,6 +53,7 @@ from openedx.core.djangoapps.site_configuration import helpers as configuration_helpers from openedx.core.djangoapps.xmodule_django.models import NoneToEmptyManager from openedx.core.djangolib.model_mixins import DeletableByUserValue +from openedx.core.lib import user_util from openedx.core.toggles import ENTRANCE_EXAMS from .course_enrollment import ( @@ -62,7 +62,7 @@ CourseEnrollmentAllowed, CourseOverview, ManualEnrollmentAudit, - segment + segment, ) User = get_user_model() @@ -76,8 +76,11 @@ USER_LOGGED_OUT_EVENT_NAME = 'edx.user.logout' USER_STREAK_UPDATED_EVENT_NAME = "edx.user.celebration.streak_updated" +# Placeholder for soft-deleted pending secondary email records +PENDING_SECONDARY_EMAIL_REDACTED_VALUE = 'redact-before-delete@redacted.com' + -class AnonymousUserId(models.Model): +class AnonymousUserId(models.Model): # noqa: DJ008 """ This table contains user, course_Id and anonymous_user_id @@ -91,9 +94,9 @@ class AnonymousUserId(models.Model): objects = NoneToEmptyManager() - user = models.ForeignKey(User, db_index=True, on_delete=models.CASCADE) + user = models.ForeignKey(User, db_index=True, on_delete=models.CASCADE) # noqa: DJ012 anonymous_user_id = models.CharField(unique=True, max_length=32) - course_id = LearningContextKeyField(db_index=True, max_length=255, blank=True) + course_id = LearningContextKeyField(db_index=True, blank=True) def anonymous_id_for_user(user, course_id): @@ -381,7 +384,7 @@ def get_potentially_retired_user_by_username_and_hash(username, hashed_username) return User.objects.get(username__in=locally_hashed_usernames) -class UserStanding(models.Model): +class UserStanding(models.Model): # noqa: DJ008 """ This table contains a student's account's status. Currently, we're only disabling accounts; in the future we can imagine @@ -405,7 +408,7 @@ class UserStanding(models.Model): standing_last_changed_at = models.DateTimeField(auto_now=True) -class UserProfile(models.Model): +class UserProfile(models.Model): # noqa: DJ008 """This is where we store all the user demographic fields. We have a separate table for this rather than extending the built-in Django auth_user. @@ -437,7 +440,7 @@ class Meta: # CRITICAL TODO/SECURITY # Sanitize all fields. # This is not visible to other users, but could introduce holes later - user = models.OneToOneField(User, unique=True, db_index=True, related_name='profile', on_delete=models.CASCADE) + user = models.OneToOneField(User, unique=True, db_index=True, related_name='profile', on_delete=models.CASCADE) # noqa: DJ012 # pylint: disable=line-too-long name = models.CharField(blank=True, max_length=255, db_index=True) # How meta field works: meta will only store those fields which are available in extended_profile configuration, @@ -466,7 +469,7 @@ class Meta: # Translators: 'Other' refers to the student's gender ('o', gettext_noop('Other/Prefer Not to Say')) ) - gender = models.CharField( + gender = models.CharField( # noqa: DJ001 blank=True, null=True, max_length=6, db_index=True, choices=GENDER_CHOICES ) @@ -487,12 +490,12 @@ class Meta: # Translators: 'Other' refers to the student's level of education ('other', gettext_noop("Other education")) ) - level_of_education = models.CharField( + level_of_education = models.CharField( # noqa: DJ001 blank=True, null=True, max_length=6, db_index=True, choices=LEVEL_OF_EDUCATION_CHOICES ) - mailing_address = models.TextField(blank=True, null=True) - city = models.TextField(blank=True, null=True) + mailing_address = models.TextField(blank=True, null=True) # noqa: DJ001 + city = models.TextField(blank=True, null=True) # noqa: DJ001 country = CountryField(blank=True, null=True) COUNTRY_WITH_STATES = 'US' STATE_CHOICES = ( @@ -551,15 +554,15 @@ class Meta: ('WI', 'Wisconsin'), ('WY', 'Wyoming'), ) - state = models.CharField(blank=True, null=True, max_length=2, choices=STATE_CHOICES) - goals = models.TextField(blank=True, null=True) - bio = models.CharField(blank=True, null=True, max_length=3000, db_index=False) + state = models.CharField(blank=True, null=True, max_length=2, choices=STATE_CHOICES) # noqa: DJ001 + goals = models.TextField(blank=True, null=True) # noqa: DJ001 + bio = models.CharField(blank=True, null=True, max_length=3000, db_index=False) # noqa: DJ001 profile_image_uploaded_at = models.DateTimeField(null=True, blank=True) phone_regex = RegexValidator( regex=r'^\+?1?\d*$', message="Phone number must start with '+' (optional) followed by digits (0-9) only.", ) - phone_number = models.CharField(validators=[phone_regex], blank=True, null=True, max_length=50) + phone_number = models.CharField(validators=[phone_regex], blank=True, null=True, max_length=50) # noqa: DJ001 @property def has_profile_image(self): @@ -700,7 +703,7 @@ def user_profile_pre_save_callback(sender, **kwargs): # Cache "old" field values on the model instance so that they can be # retrieved in the post_save callback when we emit an event with new and # old field values. - user_profile._changed_fields = get_changed_fields_dict(user_profile, sender) # lint-amnesty, pylint: disable=protected-access + user_profile._changed_fields = get_changed_fields_dict(user_profile, sender) # pylint: disable=protected-access @receiver(post_save, sender=UserProfile) @@ -724,7 +727,7 @@ def user_pre_save_callback(sender, **kwargs): private field on the current model for use in the post_save callback. """ user = kwargs['instance'] - user._changed_fields = get_changed_fields_dict(user, sender) # lint-amnesty, pylint: disable=protected-access + user._changed_fields = get_changed_fields_dict(user, sender) # pylint: disable=protected-access @receiver(post_save, sender=User) @@ -738,7 +741,7 @@ def user_post_save_callback(sender, **kwargs): """ user = kwargs['instance'] - changed_fields = user._changed_fields # lint-amnesty, pylint: disable=protected-access + changed_fields = user._changed_fields # pylint: disable=protected-access if 'is_active' in changed_fields or 'email' in changed_fields: if user.is_active: @@ -803,7 +806,7 @@ def user_post_save_callback(sender, **kwargs): 'education': profile.level_of_education_display, 'address': profile.mailing_address, 'gender': profile.gender_display, - 'country': str(profile.country), + 'country': str(profile.country) if profile.country else '', 'is_marketable': False } # .. pii: Many pieces of PII are sent to Segment here. Retired directly through Segment API call in Tubular. @@ -823,7 +826,7 @@ def user_post_save_callback(sender, **kwargs): ) -class UserSignupSource(models.Model): +class UserSignupSource(models.Model): # noqa: DJ008 """ This table contains information about users registering via Micro-Sites @@ -846,7 +849,7 @@ def unique_id_for_user(user): # TODO: Should be renamed to generic UserGroup, and possibly # Given an optional field for type of group -class UserTestGroup(models.Model): +class UserTestGroup(models.Model): # noqa: DJ008 """ .. no_pii: """ @@ -855,7 +858,7 @@ class UserTestGroup(models.Model): description = models.TextField(blank=True) -class Registration(models.Model): +class Registration(models.Model): # noqa: DJ008 """ Allows us to wait for e-mail before user is registered. A registration profile is created when the user creates an @@ -868,7 +871,7 @@ class Registration(models.Model): class Meta: db_table = "auth_registration" - user = models.OneToOneField(User, on_delete=models.CASCADE) + user = models.OneToOneField(User, on_delete=models.CASCADE) # noqa: DJ012 activation_key = models.CharField(('activation key'), max_length=32, unique=True, db_index=True) activation_timestamp = models.DateTimeField(default=None, null=True, blank=True) @@ -878,7 +881,7 @@ def register(self, user): self.user = user self.save() - def activate(self): # lint-amnesty, pylint: disable=missing-function-docstring + def activate(self): # pylint: disable=missing-function-docstring self.user.is_active = True self.user.save(update_fields=['is_active']) self.activation_timestamp = datetime.utcnow() @@ -887,7 +890,7 @@ def activate(self): # lint-amnesty, pylint: disable=missing-function-docstring log.info('User %s (%s) account is successfully activated.', self.user.username, self.user.email) -class PendingNameChange(DeletableByUserValue, models.Model): +class PendingNameChange(DeletableByUserValue, models.Model): # noqa: DJ008 """ This model keeps track of pending requested changes to a user's name. @@ -900,11 +903,11 @@ class PendingNameChange(DeletableByUserValue, models.Model): rationale = models.CharField(blank=True, max_length=1024) -class PendingEmailChange(DeletableByUserValue, models.Model): +class PendingEmailChange(DeletableByUserValue, models.Model): # noqa: DJ008 """ This model keeps track of pending requested changes to a user's email address. - .. pii: Contains new_email, retired in AccountRetirementView + .. pii: Contains new_email, redacted then deleted in AccountRetirementView .. pii_types: email_address .. pii_retirement: local_api """ @@ -912,6 +915,13 @@ class PendingEmailChange(DeletableByUserValue, models.Model): new_email = models.CharField(blank=True, max_length=255, db_index=True) activation_key = models.CharField(('activation key'), max_length=32, unique=True, db_index=True) + @classmethod + def redact_before_delete_fields(cls): + """ + Redact PII fields before delete in downstream soft-delete systems. + """ + return {'new_email': 'redacted-before-delete@safe.com'} + def request_change(self, email): """Request a change to a user's email. @@ -930,18 +940,41 @@ def request_change(self, email): return self.activation_key -class PendingSecondaryEmailChange(DeletableByUserValue, models.Model): +class PendingSecondaryEmailChange(DeletableByUserValue, models.Model): # noqa: DJ008 """ This model keeps track of pending requested changes to a user's secondary email address. - .. pii: Contains new_secondary_email, not currently retired + .. pii: Contains new_secondary_email, redact and delete in `DeactivateLogoutView` .. pii_types: email_address - .. pii_retirement: retained + .. pii_retirement: local_api """ user = models.OneToOneField(User, unique=True, db_index=True, on_delete=models.CASCADE) new_secondary_email = models.CharField(blank=True, max_length=255, db_index=True) activation_key = models.CharField(('activation key'), max_length=32, unique=True, db_index=True) + @classmethod + def redact_and_delete_pending_secondary_email(cls, user_id): + """ + Redact and delete a pending secondary email change row for a user. + + Redacts the email before deletion so any downstream soft-delete mirror does + not retain the original secondary email address in the final row image. + """ + pending_secondary_email_records = cls.objects.filter(user_id=user_id) + pending_secondary_email_ids = list( + pending_secondary_email_records.values_list('id', flat=True) + ) + if not pending_secondary_email_ids: + return False + + # Converting to query set by id ensures we redact and delete the appropriate records + pending_secondary_email_records_by_id = cls.objects.filter(id__in=pending_secondary_email_ids) + pending_secondary_email_records_by_id.update( + new_secondary_email=PENDING_SECONDARY_EMAIL_REDACTED_VALUE, + ) + pending_secondary_email_records_by_id.delete() + return True + class LoginFailures(models.Model): """ @@ -1029,7 +1062,7 @@ def clear_lockout_counter(cls, user): except ObjectDoesNotExist: pass - def __str__(self): + def __str__(self): # noqa: DJ012 """Str -> Username: count - date.""" return '{username}: {count} - {date}'.format( username=self.user.username, @@ -1037,7 +1070,7 @@ def __str__(self): date=self.lockout_until.isoformat() if self.lockout_until else '-' ) - class Meta: + class Meta: # noqa: DJ012 verbose_name = 'Login Failure' verbose_name_plural = 'Login Failures' @@ -1054,11 +1087,11 @@ class CourseAccessRole(models.Model): objects = NoneToEmptyManager() - user = models.ForeignKey(User, on_delete=models.CASCADE) + user = models.ForeignKey(User, on_delete=models.CASCADE) # noqa: DJ012 # blank org is for global group based roles such as course creator (may be deprecated) org = models.CharField(max_length=64, db_index=True, blank=True) # blank course_id implies org wide role - course_id = CourseKeyField(max_length=255, db_index=True, blank=True) + course_id = CourseKeyField(db_index=True, blank=True) role = models.CharField(max_length=64, db_index=True) class Meta: @@ -1084,12 +1117,12 @@ def access_roles_in_course(cls, course_key): 'user__profile' ) - def __eq__(self, other): + def __eq__(self, other): # noqa: DJ012 """ Overriding eq b/c the django impl relies on the primary key which requires fetch. sometimes we just want to compare roles w/o doing another fetch. """ - return type(self) == type(other) and self._key == other._key # lint-amnesty, pylint: disable=protected-access, unidiomatic-typecheck + return type(self) == type(other) and self._key == other._key # pylint: disable=protected-access, unidiomatic-typecheck def __hash__(self): return hash(self._key) @@ -1101,12 +1134,14 @@ def __lt__(self, other): return self._key < other._key def __str__(self): - return f"[CourseAccessRole] user: {self.user.username} role: {self.role} org: {self.org} course: {self.course_id}" # lint-amnesty, pylint: disable=line-too-long + return f"[CourseAccessRole] user: {self.user.username} role: {self.role} org: {self.org} course: {self.course_id}" # pylint: disable=line-too-long class CourseAccessRoleHistory(TimeStampedModel): """ Stores the change history for CourseAccessRole objects. + + .. no_pii: """ ACTION_CHOICES = ( ('created', 'Created'), @@ -1116,7 +1151,7 @@ class CourseAccessRoleHistory(TimeStampedModel): user = models.ForeignKey(User, on_delete=models.CASCADE) org = models.CharField(max_length=64, db_index=True, blank=True) - course_id = CourseKeyField(max_length=255, db_index=True, blank=True) + course_id = CourseKeyField(db_index=True, blank=True) role = models.CharField(max_length=64, db_index=True) action_type = models.CharField(max_length=10, choices=ACTION_CHOICES, db_index=True) changed_by = models.ForeignKey( @@ -1177,7 +1212,7 @@ def get_user(email): return user, u_prof -def user_info(email): # lint-amnesty, pylint: disable=missing-function-docstring +def user_info(email): # pylint: disable=missing-function-docstring user, u_prof = get_user(email) print("User id", user.id) print("Username", user.username) @@ -1236,7 +1271,7 @@ def remove_user_from_group(user, group): } -def add_user_to_default_group(user, group): # lint-amnesty, pylint: disable=missing-function-docstring +def add_user_to_default_group(user, group): # pylint: disable=missing-function-docstring try: utg = UserTestGroup.objects.get(name=group) except UserTestGroup.DoesNotExist: @@ -1248,7 +1283,7 @@ def add_user_to_default_group(user, group): # lint-amnesty, pylint: disable=mis utg.save() -def create_comments_service_user(user): # lint-amnesty, pylint: disable=missing-function-docstring +def create_comments_service_user(user): # pylint: disable=missing-function-docstring if not settings.FEATURES['ENABLE_DISCUSSION_SERVICE']: # Don't try--it won't work, and it will fill the logs with lots of errors return @@ -1269,7 +1304,7 @@ def create_comments_service_user(user): # lint-amnesty, pylint: disable=missing @receiver(user_logged_in) -def log_successful_login(sender, request, user, **kwargs): # lint-amnesty, pylint: disable=unused-argument +def log_successful_login(sender, request, user, **kwargs): # pylint: disable=unused-argument """Handler to log when logins have occurred successfully.""" tracker.emit( USER_LOGGED_IN_EVENT_NAME, @@ -1285,7 +1320,7 @@ def log_successful_login(sender, request, user, **kwargs): # lint-amnesty, pyli @receiver(user_logged_out) -def log_successful_logout(sender, request, user, **kwargs): # lint-amnesty, pylint: disable=unused-argument +def log_successful_logout(sender, request, user, **kwargs): # pylint: disable=unused-argument """Handler to log when logouts have occurred successfully.""" if hasattr(request, 'user'): tracker.emit( @@ -1428,7 +1463,7 @@ def add_to_profile_url(self, course, cert_mode, cert_url, certificate=None): 'issueMonth': certificate.created_date.month, }) - return 'https://www.linkedin.com/profile/add?startTask=CERTIFICATION_NAME&{params}'.format( + return 'https://www.linkedin.com/profile/add?startTask=CERTIFICATION_NAME&{params}'.format( # noqa: UP032 params=urlencode(params) ) @@ -1493,7 +1528,7 @@ class EntranceExamConfiguration(models.Model): """ user = models.ForeignKey(User, db_index=True, on_delete=models.CASCADE) - course_id = CourseKeyField(max_length=255, db_index=True) + course_id = CourseKeyField(db_index=True) created = models.DateTimeField(auto_now_add=True, null=True, db_index=True) updated = models.DateTimeField(auto_now=True, db_index=True) @@ -1505,7 +1540,7 @@ class Meta: unique_together = (('user', 'course_id'), ) def __str__(self): - return "[EntranceExamConfiguration] {}: {} ({}) = {}".format( + return "[EntranceExamConfiguration] {}: {} ({}) = {}".format( # noqa: UP032 self.user, self.course_id, self.created, self.skip_entrance_exam ) @@ -1543,12 +1578,12 @@ def __init__(self, *args, **kwargs): max_length=16, choices=settings.ALL_LANGUAGES, help_text=help_text, - *args, + *args, # noqa: B026 **kwargs ) -class LanguageProficiency(models.Model): +class LanguageProficiency(models.Model): # noqa: DJ008 """ Represents a user's language proficiency. @@ -1563,7 +1598,7 @@ class LanguageProficiency(models.Model): class Meta: unique_together = (('code', 'user_profile'),) - user_profile = models.ForeignKey(UserProfile, db_index=True, related_name='language_proficiencies', + user_profile = models.ForeignKey(UserProfile, db_index=True, related_name='language_proficiencies', # noqa: DJ012 on_delete=models.CASCADE) code = models.CharField( max_length=16, @@ -1573,7 +1608,7 @@ class Meta: ) -class SocialLink(models.Model): +class SocialLink(models.Model): # noqa: DJ008 """ Represents a URL connecting a particular social platform to a user's social profile. @@ -1610,7 +1645,7 @@ class RegistrationCookieConfiguration(ConfigurationModel): def __str__(self): """Unicode representation of this config. """ - return "UTM: {utm_name}; AFFILIATE: {affiliate_name}".format( + return "UTM: {utm_name}; AFFILIATE: {affiliate_name}".format( # noqa: UP032 utm_name=self.utm_cookie_name, affiliate_name=self.affiliate_cookie_name ) @@ -1632,7 +1667,7 @@ class Meta: value = models.CharField(max_length=255, help_text=_("Value of this user attribute.")) def __str__(self): - return "[{username}] {name}: {value}".format( + return "[{username}] {name}: {value}".format( # noqa: UP032 name=self.name, value=self.value, username=self.user.username @@ -1684,11 +1719,11 @@ def activate(self): super().get_queryset().update(is_active=True) -class AccountRecovery(models.Model): +class AccountRecovery(models.Model): # noqa: DJ008 """ Model for storing information for user's account recovery in case of access loss. - .. pii: the field named secondary_email contains pii, retired in the `DeactivateLogoutView` + .. pii: the field named secondary_email contains pii, redact and delete in the `DeactivateLogoutView` .. pii_types: email_address .. pii_retirement: local_api """ @@ -1705,7 +1740,7 @@ class AccountRecovery(models.Model): class Meta: db_table = "auth_accountrecovery" - objects = AccountRecoveryManager() + objects = AccountRecoveryManager() # noqa: DJ012 def update_recovery_email(self, email): """ @@ -1721,24 +1756,42 @@ def update_recovery_email(self, email): @classmethod def retire_recovery_email(cls, user_id): """ - Retire user's recovery/secondary email as part of GDPR Phase I. - Returns 'True' + Redact and delete user's recovery/secondary email. - If an AccountRecovery record is found for this user it will be deleted, - if it is not found it is assumed this table has no PII for the given user. + If an AccountRecovery record is found for this user it will be redacted and + deleted. If it is not found it is assumed this table has no PII for the given user. + + Note: In retire_recovery_email, "retire" means this is part of user retirement. + The recovery email itself remains available for use with future accounts. :param user_id: int :return: bool """ - try: - cls.objects.get(user_id=user_id).delete() - except cls.DoesNotExist: - pass + account_recovery_records = cls.objects.filter(user_id=user_id) + account_recovery_ids = list( + account_recovery_records.values_list('id', flat=True) + ) + if not account_recovery_ids: + return False + + # Converting to query set by id ensures we redact and delete the appropriate records + account_recovery_records_by_id = cls.objects.filter(id__in=account_recovery_ids) + account_recovery_records_by_id.update( + secondary_email=f'redact-before-delete+{user_id}@redacted.com', + ) + account_recovery_records_by_id.delete() return True class AllowedAuthUser(TimeStampedModel): + """ + Tracks which email addresses are allowed to log in with password on a given site. + + .. pii: Contains email address. + .. pii_types: email_address + .. pii_retirement: local_api + """ site = models.ForeignKey(Site, related_name='allowed_auth_users', on_delete=models.CASCADE) email = models.EmailField( help_text=_( @@ -1789,7 +1842,7 @@ class UserCelebration(TimeStampedModel): STREAK_BREAK_LENGTH = 1 def __str__(self): - return ( + return ( # noqa: UP032 '[UserCelebration] user: {}; last_day_of_streak {}; streak_length {}; longest_ever_streak {};' ).format(self.user.username, self.last_day_of_streak, self.streak_length, self.longest_ever_streak) @@ -1939,7 +1992,7 @@ class UserPasswordToggleHistory(TimeStampedModel): .. no_pii: """ user = models.ForeignKey(User, related_name='password_toggle_history', on_delete=models.CASCADE) - comment = models.CharField(max_length=255, help_text=_("Add a reason"), blank=True, null=True) + comment = models.CharField(max_length=255, help_text=_("Add a reason"), blank=True, null=True) # noqa: DJ001 disabled = models.BooleanField(default=True) created_by = models.ForeignKey(User, on_delete=models.CASCADE) diff --git a/common/djangoapps/student/models_api.py b/common/djangoapps/student/models_api.py index c8740fd339fc..e1f800b57c6b 100644 --- a/common/djangoapps/student/models_api.py +++ b/common/djangoapps/student/models_api.py @@ -5,20 +5,17 @@ import logging from zoneinfo import ZoneInfo - +from common.djangoapps.student.models import ALLOWEDTOENROLL_TO_ENROLLED as _ALLOWEDTOENROLL_TO_ENROLLED +from common.djangoapps.student.models import ALLOWEDTOENROLL_TO_UNENROLLED as _ALLOWEDTOENROLL_TO_UNENROLLED +from common.djangoapps.student.models import DEFAULT_TRANSITION_STATE as _DEFAULT_TRANSITION_STATE +from common.djangoapps.student.models import ENROLLED_TO_ENROLLED as _ENROLLED_TO_ENROLLED +from common.djangoapps.student.models import ENROLLED_TO_UNENROLLED as _ENROLLED_TO_UNENROLLED +from common.djangoapps.student.models import UNENROLLED_TO_ALLOWEDTOENROLL as _UNENROLLED_TO_ALLOWEDTOENROLL +from common.djangoapps.student.models import UNENROLLED_TO_ENROLLED as _UNENROLLED_TO_ENROLLED +from common.djangoapps.student.models import UNENROLLED_TO_UNENROLLED as _UNENROLLED_TO_UNENROLLED from common.djangoapps.student.models import CourseAccessRole as _CourseAccessRole from common.djangoapps.student.models import CourseEnrollment as _CourseEnrollment from common.djangoapps.student.models import ManualEnrollmentAudit as _ManualEnrollmentAudit -from common.djangoapps.student.models import ( - ENROLLED_TO_ENROLLED as _ENROLLED_TO_ENROLLED, - ENROLLED_TO_UNENROLLED as _ENROLLED_TO_UNENROLLED, - UNENROLLED_TO_ENROLLED as _UNENROLLED_TO_ENROLLED, - UNENROLLED_TO_UNENROLLED as _UNENROLLED_TO_UNENROLLED, - UNENROLLED_TO_ALLOWEDTOENROLL as _UNENROLLED_TO_ALLOWEDTOENROLL, - ALLOWEDTOENROLL_TO_ENROLLED as _ALLOWEDTOENROLL_TO_ENROLLED, - ALLOWEDTOENROLL_TO_UNENROLLED as _ALLOWEDTOENROLL_TO_UNENROLLED, - DEFAULT_TRANSITION_STATE as _DEFAULT_TRANSITION_STATE, -) from common.djangoapps.student.models import PendingNameChange as _PendingNameChange from common.djangoapps.student.models import UserProfile as _UserProfile @@ -34,7 +31,7 @@ log = logging.getLogger(__name__) -def create_manual_enrollment_audit( # lint-amnesty, pylint: disable=missing-function-docstring +def create_manual_enrollment_audit( # pylint: disable=missing-function-docstring enrolled_by, user_email, state_transition, @@ -129,7 +126,7 @@ def do_name_change_request(user, new_name, rationale): user_profile = _UserProfile.objects.get(user=user) if user_profile.name == new_name: log_msg = ( - 'user_id={user_id} requested a name change, but the requested name is the same as' + 'user_id={user_id} requested a name change, but the requested name is the same as' # noqa: UP032 'their current profile name. Not taking any action.'.format(user_id=user.id) ) log.warning(log_msg) diff --git a/common/djangoapps/student/role_helpers.py b/common/djangoapps/student/role_helpers.py index 64ed5cc17efb..0f4667e279f6 100644 --- a/common/djangoapps/student/role_helpers.py +++ b/common/djangoapps/student/role_helpers.py @@ -5,16 +5,8 @@ from django.contrib.auth import get_user_model -from openedx.core.djangoapps.django_comment_common.models import ( - FORUM_ROLE_ADMINISTRATOR, - FORUM_ROLE_COMMUNITY_TA, - FORUM_ROLE_GROUP_MODERATOR, - FORUM_ROLE_MODERATOR, - Role -) -from openedx.core.lib.cache_utils import request_cached from common.djangoapps.student.roles import ( - CourseAccessRole, + AuthzCompatCourseAccessRole, CourseBetaTesterRole, CourseInstructorRole, CourseStaffRole, @@ -23,7 +15,14 @@ OrgStaffRole, RoleCache, ) - +from openedx.core.djangoapps.django_comment_common.models import ( + FORUM_ROLE_ADMINISTRATOR, + FORUM_ROLE_COMMUNITY_TA, + FORUM_ROLE_GROUP_MODERATOR, + FORUM_ROLE_MODERATOR, + Role, +) +from openedx.core.lib.cache_utils import request_cached User = get_user_model() @@ -66,7 +65,7 @@ def get_role_cache(user: User) -> RoleCache: @request_cached() -def get_course_roles(user: User) -> list[CourseAccessRole]: +def get_course_roles(user: User) -> list[AuthzCompatCourseAccessRole]: """ Returns a list of all course-level roles that this user has. diff --git a/common/djangoapps/student/roles.py b/common/djangoapps/student/roles.py index 971433c9c523..6be650d05d4e 100644 --- a/common/djangoapps/student/roles.py +++ b/common/djangoapps/student/roles.py @@ -4,16 +4,24 @@ """ -from collections import defaultdict import logging from abc import ABCMeta, abstractmethod +from collections import defaultdict from contextlib import contextmanager +from dataclasses import dataclass -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from opaque_keys.edx.django.models import CourseKeyField +from opaque_keys.edx.keys import CourseKey +from opaque_keys.edx.locator import CourseLocator +from openedx_authz.api import users as authz_api +from openedx_authz.api.data import CourseOverviewData, RoleAssignmentData +from openedx_authz.constants import roles as authz_roles -from openedx.core.lib.cache_utils import get_cache from common.djangoapps.student.models import CourseAccessRole +from common.djangoapps.student.signals.signals import emit_course_access_role_added, emit_course_access_role_removed +from openedx.core.lib.cache_utils import get_cache +from openedx.core.toggles import enable_authz_course_authoring log = logging.getLogger(__name__) @@ -27,6 +35,64 @@ ROLE_CACHE_UNGROUPED_ROLES__KEY = 'ungrouped' +def get_authz_role_from_legacy_role(legacy_role: str) -> str: + return authz_roles.LEGACY_COURSE_ROLE_EQUIVALENCES.get(legacy_role, None) + + +def get_legacy_role_from_authz_role(authz_role: str) -> str: + return next((k for k, v in authz_roles.LEGACY_COURSE_ROLE_EQUIVALENCES.items() if v == authz_role), None) + + +def authz_add_role(user: User, authz_role: str, course_key: str): + """ + Add a user's role in a course if not already added. + Args: + user (User): The user whose role is being changed. + authz_role (str): The new authorization role to assign (authz role, not legacy). + course_key (str): The course key where the role change is taking effect. + """ + course_locator = CourseLocator.from_string(course_key) + + # Check if the user is not already assigned this role for this course + existing_assignments = authz_api.get_user_role_assignments_in_scope( + user_external_key=user.username, + scope_external_key=course_key + ) + existing_roles = [existing_role.external_key + for existing_assignment in existing_assignments + for existing_role in existing_assignment.roles] + + if authz_role in existing_roles: + return + + # Assign new role + authz_api.assign_role_to_user_in_scope( + user_external_key=user.username, + role_external_key=authz_role, + scope_external_key=course_key + ) + legacy_role = get_legacy_role_from_authz_role(authz_role) + emit_course_access_role_added(user, course_locator, course_locator.org, legacy_role) + +def authz_get_all_course_assignments_for_user(user: User) -> list[RoleAssignmentData]: + """ + Get all course assignments for a user. + """ + assignments = authz_api.get_user_role_assignments(user_external_key=user.username) + # filter courses only + filtered_assignments = [ + assignment for assignment in assignments + if isinstance(assignment.scope, CourseOverviewData) + ] + return filtered_assignments + +def get_org_from_key(key: str) -> str: + """ + Get the org from a course key. + """ + parsed_key = CourseKey.from_string(key) + return parsed_key.org + def register_access_role(cls): """ Decorator that allows access roles to be registered within the roles module and referenced by their @@ -70,7 +136,43 @@ def get_role_cache_key_for_course(course_key=None): return str(course_key) if course_key else ROLE_CACHE_UNGROUPED_ROLES__KEY -class BulkRoleCache: # lint-amnesty, pylint: disable=missing-class-docstring +@dataclass(frozen=True) +class AuthzCompatCourseAccessRole: + """ + Generic data class for storing CourseAccessRole-compatible data + to be used inside BulkRoleCache and RoleCache. + This allows the cache to store both legacy and openedx-authz compatible roles + """ + user_id: int + username: str + org: str + course_id: str # Course key + role: str + + +def get_authz_compat_course_access_roles_for_user(user: User) -> set[AuthzCompatCourseAccessRole]: + """ + Retrieve all CourseAccessRole objects for a given user and convert them to AuthzCompatCourseAccessRole objects. + """ + compat_role_assignments = set() + assignments = authz_get_all_course_assignments_for_user(user) + for assignment in assignments: + for role in assignment.roles: + legacy_role = get_legacy_role_from_authz_role(authz_role=role.external_key) + course_key = assignment.scope.external_key + org = get_org_from_key(course_key) + compat_role = AuthzCompatCourseAccessRole( + user_id=user.id, + username=user.username, + org=org, + course_id=course_key, + role=legacy_role + ) + compat_role_assignments.add(compat_role) + return compat_role_assignments + + +class BulkRoleCache: # pylint: disable=missing-class-docstring """ This class provides a caching mechanism for roles grouped by users and courses, using a nested dictionary structure to optimize lookup performance. The cache structure is designed as follows: @@ -94,17 +196,33 @@ class BulkRoleCache: # lint-amnesty, pylint: disable=missing-class-docstring CACHE_KEY = 'roles_by_user' @classmethod - def prefetch(cls, users): # lint-amnesty, pylint: disable=missing-function-docstring + def prefetch(cls, users): # pylint: disable=missing-function-docstring roles_by_user = defaultdict(lambda: defaultdict(set)) get_cache(cls.CACHE_NAMESPACE)[cls.CACHE_KEY] = roles_by_user + # Legacy roles for role in CourseAccessRole.objects.filter(user__in=users).select_related('user'): user_id = role.user.id course_id = get_role_cache_key_for_course(role.course_id) # Add role to the set in roles_by_user[user_id][course_id] user_roles_set_for_course = roles_by_user[user_id][course_id] - user_roles_set_for_course.add(role) + compat_role = AuthzCompatCourseAccessRole( + user_id=role.user.id, + username=role.user.username, + org=role.org, + course_id=role.course_id, + role=role.role + ) + user_roles_set_for_course.add(compat_role) + + # openedx-authz roles + for user in users: + compat_roles = get_authz_compat_course_access_roles_for_user(user) + for role in compat_roles: + course_id = get_role_cache_key_for_course(role.course_id) + user_roles_set_for_course = roles_by_user[user.id][course_id] + user_roles_set_for_course.add(compat_role) users_without_roles = [u for u in users if u.id not in roles_by_user] for user in users_without_roles: @@ -117,7 +235,7 @@ def get_user_roles(cls, user): class RoleCache: """ - A cache of the CourseAccessRoles held by a particular user. + A cache of the AuthzCompatCourseAccessRoles held by a particular user. Internal data structures should be accessed by getter and setter methods; don't use `_roles_by_course_id` or `_roles` directly. _roles_by_course_id: This is the data structure as saved in the RequestCache. @@ -134,18 +252,35 @@ def __init__(self, user): self._roles_by_course_id = BulkRoleCache.get_user_roles(user) except KeyError: self._roles_by_course_id = {} + + # openedx-authz compatibility implementation + compat_roles = get_authz_compat_course_access_roles_for_user(user) + for compat_role in compat_roles: + course_id = get_role_cache_key_for_course(compat_role.course_id) + if not self._roles_by_course_id.get(course_id): + self._roles_by_course_id[course_id] = set() + self._roles_by_course_id[course_id].add(compat_role) + + # legacy implementation roles = CourseAccessRole.objects.filter(user=user).all() for role in roles: course_id = get_role_cache_key_for_course(role.course_id) if not self._roles_by_course_id.get(course_id): self._roles_by_course_id[course_id] = set() - self._roles_by_course_id[course_id].add(role) + compat_role = AuthzCompatCourseAccessRole( + user_id=user.id, + username=user.username, + org=role.org, + course_id=role.course_id, + role=role.role + ) + self._roles_by_course_id[course_id].add(compat_role) self._roles = set() for roles_for_course in self._roles_by_course_id.values(): self._roles.update(roles_for_course) @staticmethod - def get_roles(role): + def get_roles(role: str) -> set[str]: """ Return the roles that should have the same permissions as the specified role. """ @@ -189,14 +324,14 @@ def add_users(self, *users): """ Add the role to the supplied django users. """ - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass @abstractmethod def remove_users(self, *users): """ Remove the role from the supplied django users. """ - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass @abstractmethod def users_with_role(self): @@ -269,13 +404,34 @@ def has_user(self, user, check_user_activation=True): return user._roles.has_role(self._role_name, self.course_key, self.org) - def add_users(self, *users): + def _authz_add_users(self, users): + """ + Add the supplied django users to this role. + AuthZ compatibility layer + """ + role = get_authz_role_from_legacy_role(self.ROLE) + # silently ignores anonymous and inactive users so that any that are + # legit get updated. + for user in users: + if user.is_authenticated and user.is_active: + authz_add_role( + user=user, + authz_role=role, + course_key=str(self.course_key), + ) + if hasattr(user, '_roles'): + del user._roles + + def _legacy_add_users(self, users): """ Add the supplied django users to this role. + legacy implementation """ # silently ignores anonymous and inactive users so that any that are # legit get updated. - from common.djangoapps.student.models import CourseAccessRole # lint-amnesty, pylint: disable=redefined-outer-name, reimported + from common.djangoapps.student.models import ( # pylint: disable=redefined-outer-name, reimported + CourseAccessRole, + ) for user in users: if user.is_authenticated and user.is_active: CourseAccessRole.objects.get_or_create( @@ -284,9 +440,38 @@ def add_users(self, *users): if hasattr(user, '_roles'): del user._roles - def remove_users(self, *users): + def add_users(self, *users): + """ + Add the supplied django users to this role. + """ + if enable_authz_course_authoring(self.course_key): + self._authz_add_users(users) + else: + self._legacy_add_users(users) + + def _authz_remove_users(self, users): + """ + Remove the supplied django users from this role. + AuthZ compatibility layer + """ + usernames = [user.username for user in users] + role = get_authz_role_from_legacy_role(self.ROLE) + course_key_str = str(self.course_key) + course_locator = CourseLocator.from_string(course_key_str) + authz_api.batch_unassign_role_from_users( + users=usernames, + role_external_key=role, + scope_external_key=course_key_str + ) + for user in users: + emit_course_access_role_removed(user, course_locator, course_locator.org, self.ROLE) + if hasattr(user, '_roles'): + del user._roles + + def _legacy_remove_users(self, users): """ Remove the supplied django users from this role. + legacy implementation """ entries = CourseAccessRole.objects.filter( user__in=users, role=self._role_name, org=self.org, course_id=self.course_key @@ -296,9 +481,33 @@ def remove_users(self, *users): if hasattr(user, '_roles'): del user._roles - def users_with_role(self): + def remove_users(self, *users): + """ + Remove the supplied django users from this role. + """ + if enable_authz_course_authoring(self.course_key): + self._authz_remove_users(users) + else: + self._legacy_remove_users(users) + + def _authz_users_with_role(self): + """ + Return a django QuerySet for all of the users with this role + AuthZ compatibility layer + """ + role = get_authz_role_from_legacy_role(self.ROLE) + users_data = authz_api.get_users_for_role_in_scope( + role_external_key=role, + scope_external_key=str(self.course_key) + ) + usernames = [user_data.username for user_data in users_data] + entries = User.objects.filter(username__in=usernames) + return entries + + def _legacy_users_with_role(self): """ Return a django QuerySet for all of the users with this role + legacy implementation """ # Org roles don't query by CourseKey, so use CourseKeyField.Empty for that query if self.course_key is None: @@ -310,12 +519,67 @@ def users_with_role(self): ) return entries + def users_with_role(self): + """ + Return a django QuerySet for all of the users with this role + """ + if enable_authz_course_authoring(self.course_key): + return self._authz_users_with_role() + else: + return self._legacy_users_with_role() + + def _authz_get_orgs_for_user(self, user) -> list[str]: + """ + Returns a list of org short names for the user with given role. + AuthZ compatibility layer + """ + role = get_authz_role_from_legacy_role(self._role_name) + assignments = authz_api.get_user_role_assignments_filtered( + user_external_key=user.username, + role_external_key=role, + ) + orgs = {assignment.scope.org for assignment in assignments if assignment.scope.org is not None} + return list(orgs) + + def _legacy_get_orgs_for_user(self, user) -> list[str]: + """ + Returns a list of org short names for the user with given role. + legacy implementation + """ + return list(CourseAccessRole.objects.filter(user=user, role=self._role_name).values_list('org', flat=True)) + def get_orgs_for_user(self, user): """ Returns a list of org short names for the user with given role. """ - return CourseAccessRole.objects.filter(user=user, role=self._role_name).values_list('org', flat=True) + if enable_authz_course_authoring(self.course_key): + return self._authz_get_orgs_for_user(user) + else: + return self._legacy_get_orgs_for_user(user) + def has_org_for_user(self, user: User, org: str | None = None) -> bool: + """ + Checks whether a user has a specific role within an org. + + Arguments: + user: user to check against access to role + org: optional org to check against access to role, + if not specified, will return True if the user has access to at least one org + """ + if enable_authz_course_authoring(self.course_key): + orgs_with_role = self.get_orgs_for_user(user) + if org: + return org in orgs_with_role + return len(orgs_with_role) > 0 + else: + # Use ORM query directly for performance + filter_params = { + 'user': user, + 'role': self._role_name + } + if org: + filter_params['org'] = org + return CourseAccessRole.objects.filter(**filter_params).exists() class CourseRole(RoleBase): """ @@ -329,9 +593,25 @@ def __init__(self, role, course_key): super().__init__(role, course_key.org, course_key) @classmethod - def course_group_already_exists(self, course_key): # lint-amnesty, pylint: disable=bad-classmethod-argument + def _authz_course_group_already_exists(cls, course_key): # pylint: disable=bad-classmethod-argument + # AuthZ compatibility layer + return len(authz_api.get_all_user_role_assignments_in_scope(scope_external_key=str(course_key))) > 0 + + @classmethod + def _legacy_course_group_already_exists(cls, course_key): # pylint: disable=bad-classmethod-argument + # Legacy implementation return CourseAccessRole.objects.filter(org=course_key.org, course_id=course_key).exists() + @classmethod + def course_group_already_exists(cls, course_key): # pylint: disable=bad-classmethod-argument + """ + Returns whether role assignations for a course already exist + """ + if enable_authz_course_authoring(course_key): + return cls._authz_course_group_already_exists(course_key) + else: + return cls._legacy_course_group_already_exists(course_key) + def __repr__(self): return f'<{self.__class__.__name__}: course_key={self.course_key}>' @@ -519,9 +799,18 @@ def add_course(self, *course_keys): Grant this object's user the object's role for the supplied courses """ if self.user.is_authenticated and self.user.is_active: + authz_role = get_authz_role_from_legacy_role(self.role) for course_key in course_keys: - entry = CourseAccessRole(user=self.user, role=self.role, course_id=course_key, org=course_key.org) - entry.save() + if enable_authz_course_authoring(course_key): + # AuthZ compatibility layer + authz_add_role( + user=self.user, + authz_role=authz_role, + course_key=str(course_key), + ) + else: + entry = CourseAccessRole(user=self.user, role=self.role, course_id=course_key, org=course_key.org) + entry.save() if hasattr(self.user, '_roles'): del self.user._roles else: @@ -531,18 +820,97 @@ def remove_courses(self, *course_keys): """ Remove the supplied courses from this user's configured role. """ + # CourseAccessRoles for courses managed by AuthZ should already be removed, so always doing this is ok entries = CourseAccessRole.objects.filter(user=self.user, role=self.role, course_id__in=course_keys) entries.delete() + # Execute bulk delete on AuthZ + role = get_authz_role_from_legacy_role(self.role) + for course_key in course_keys: + course_key_str = str(course_key) + success = authz_api.unassign_role_from_user( + user_external_key=self.user.username, + role_external_key=role, + scope_external_key=course_key_str + ) + if success: + course_locator = CourseLocator.from_string(course_key_str) + emit_course_access_role_removed(self.user, course_locator, course_locator.org, self.role) + if hasattr(self.user, '_roles'): del self.user._roles - def courses_with_role(self): + def courses_with_role(self) -> set[AuthzCompatCourseAccessRole]: """ - Return a django QuerySet for all of the courses with this user x (or derived from x) role. You can access - any of these properties on each result record: - * user (will be self.user--thus uninteresting) - * org - * course_id - * role (will be self.role--thus uninteresting) + Return a set of AuthzCompatCourseAccessRole for all of the courses with this user x (or derived from x) role. """ - return CourseAccessRole.objects.filter(role__in=RoleCache.get_roles(self.role), user=self.user) + roles = RoleCache.get_roles(self.role) + legacy_assignments = CourseAccessRole.objects.filter(role__in=roles, user=self.user) + + # Get all assignments for a user to a role + new_authz_roles = [get_authz_role_from_legacy_role(role) for role in roles] + all_authz_user_assignments = authz_get_all_course_assignments_for_user(self.user) + + all_assignments = set() + + for legacy_assignment in legacy_assignments: + for role in roles: + all_assignments.add(AuthzCompatCourseAccessRole( + user_id=self.user.id, + username=self.user.username, + org=legacy_assignment.org, + course_id=legacy_assignment.course_id, + role=role + )) + + for assignment in all_authz_user_assignments: + for role in assignment.roles: + if role.external_key not in new_authz_roles: + continue + legacy_role = get_legacy_role_from_authz_role(authz_role=role.external_key) + course_key = assignment.scope.external_key + org = get_org_from_key(course_key) + all_assignments.add(AuthzCompatCourseAccessRole( + user_id=self.user.id, + username=self.user.username, + org=org, + course_id=course_key, + role=legacy_role + )) + + return all_assignments + + def has_courses_with_role(self, org: str | None = None) -> bool: + """ + Return whether this user has any courses with this role and optional org (or derived roles) + + Arguments: + org (str): Optional org to filter by + """ + roles = RoleCache.get_roles(self.role) + # First check if we have any legacy assignment with an optimized ORM query + filter_params = { + 'user': self.user, + 'role__in': roles + } + if org: + filter_params['org'] = org + has_legacy_assignments = CourseAccessRole.objects.filter(**filter_params).exists() + if has_legacy_assignments: + return True + + # Then check for authz assignments + new_authz_roles = [get_authz_role_from_legacy_role(role) for role in roles] + all_authz_user_assignments = authz_get_all_course_assignments_for_user(self.user) + + for assignment in all_authz_user_assignments: + for role in assignment.roles: + if role.external_key not in new_authz_roles: + continue + if org is None: + # There is at least one assignment, short circuit + return True + course_key = assignment.scope.external_key + parsed_org = get_org_from_key(course_key) + if org == parsed_org: + return True + return False diff --git a/common/djangoapps/student/signals/__init__.py b/common/djangoapps/student/signals/__init__.py index 06ac888896e0..32143feb931e 100644 --- a/common/djangoapps/student/signals/__init__.py +++ b/common/djangoapps/student/signals/__init__.py @@ -1,11 +1,11 @@ -# lint-amnesty, pylint: disable=missing-module-docstring +# pylint: disable=missing-module-docstring from common.djangoapps.student.signals.signals import ( - emit_course_access_role_added, - emit_course_access_role_removed, - ENROLL_STATUS_CHANGE, - ENROLLMENT_TRACK_UPDATED, - REFUND_ORDER, - UNENROLL_DONE, - USER_EMAIL_CHANGED + ENROLL_STATUS_CHANGE, # noqa: F401 + ENROLLMENT_TRACK_UPDATED, # noqa: F401 + REFUND_ORDER, # noqa: F401 + UNENROLL_DONE, # noqa: F401 + USER_EMAIL_CHANGED, # noqa: F401 + emit_course_access_role_added, # noqa: F401 + emit_course_access_role_removed, # noqa: F401 ) diff --git a/common/djangoapps/student/signals/receivers.py b/common/djangoapps/student/signals/receivers.py index 529ac261b412..d503a746bfd1 100644 --- a/common/djangoapps/student/signals/receivers.py +++ b/common/djangoapps/student/signals/receivers.py @@ -5,14 +5,13 @@ # pylint: disable=unused-argument import logging from asyncio.log import logger + from django.conf import settings from django.contrib.auth import get_user_model from django.db import IntegrityError from django.db.models.signals import post_delete, post_save, pre_save from django.dispatch import receiver -from lms.djangoapps.courseware.toggles import courseware_mfe_progress_milestones_are_active -from lms.djangoapps.utils import get_email_client from common.djangoapps.student.helpers import EMAIL_EXISTS_MSG_FMT, USERNAME_EXISTS_MSG_FMT, AccountValidationError from common.djangoapps.student.models import ( CourseAccessRole, @@ -20,18 +19,20 @@ CourseEnrollmentCelebration, PendingNameChange, is_email_retired, - is_username_retired + is_username_retired, ) from common.djangoapps.student.models_api import confirm_name_change from common.djangoapps.student.signals import ( + USER_EMAIL_CHANGED, emit_course_access_role_added, emit_course_access_role_removed, - USER_EMAIL_CHANGED, ) +from lms.djangoapps.courseware.toggles import courseware_mfe_progress_milestones_are_active +from lms.djangoapps.utils import get_email_client from openedx.core.djangoapps.safe_sessions.middleware import EmailChangeMiddleware from openedx.features.name_affirmation_api.utils import is_name_affirmation_installed -logger = logging.getLogger(__name__) +logger = logging.getLogger(__name__) # noqa: F811 @receiver(pre_save, sender=get_user_model()) @@ -148,5 +149,5 @@ def _listen_for_user_email_changed(sender, user, request, **kwargs): email_client = get_email_client() if email_client: email_client.track_user(attributes=attributes) - except Exception as exc: # pylint: disable=broad-except + except Exception as exc: # pylint: disable=broad-except # noqa: F841 logger.exception(f'Unable to sync new email [{email}] with Braze for user [{user_id}]') diff --git a/common/djangoapps/student/signals/signals.py b/common/djangoapps/student/signals/signals.py index a9fe3cf1f5e6..3aab4c732aa0 100644 --- a/common/djangoapps/student/signals/signals.py +++ b/common/djangoapps/student/signals/signals.py @@ -4,11 +4,9 @@ from django.dispatch import Signal - from openedx_events.learning.data import CourseAccessRoleData, UserData, UserPersonalData from openedx_events.learning.signals import COURSE_ACCESS_ROLE_ADDED, COURSE_ACCESS_ROLE_REMOVED - # The purely documentational providing_args argument for Signal is deprecated. # So we are moving the args to a comment. diff --git a/common/djangoapps/student/tasks.py b/common/djangoapps/student/tasks.py index 2d436c7c9b0a..cf95d56a99db 100644 --- a/common/djangoapps/student/tasks.py +++ b/common/djangoapps/student/tasks.py @@ -2,23 +2,21 @@ Celery task for course enrollment email """ import logging + from celery import shared_task from django.conf import settings from django.contrib.auth import get_user_model from edx_django_utils.monitoring import set_code_owner_attribute from opaque_keys.edx.keys import CourseKey -from common.djangoapps.track import segment from common.djangoapps.course_modes.models import CourseMode -from common.djangoapps.student.helpers import ( - get_course_dates_for_email, - get_instructors, -) +from common.djangoapps.student.helpers import get_course_dates_for_email, get_instructors +from common.djangoapps.track import segment from lms.djangoapps.utils import get_email_client from openedx.core.djangoapps.catalog.utils import ( + get_course_run_details, get_course_uuid_for_course, get_owners_for_course, - get_course_run_details, ) from openedx.core.djangoapps.site_configuration import helpers as configuration_helpers from openedx.features.course_experience import ENABLE_COURSE_GOALS @@ -110,7 +108,7 @@ def send_course_enrollment_email( "min_effort": course_run.get("min_effort"), "max_effort": course_run.get("max_effort"), "weeks_to_complete": course_run.get("weeks_to_complete"), - "learners_count": "{:,}".format(enrollment_count) if enrollment_count > 100 else "", + "learners_count": "{:,}".format(enrollment_count) if enrollment_count > 100 else "", # noqa: UP032 "banner_image_url": course_run.get("image").get("src", "") if course_run.get("image") else "", "course_title": course_run.get("title"), "short_description": course_run.get("short_description"), @@ -143,4 +141,4 @@ def send_course_enrollment_email( except Exception as exc: # pylint: disable=broad-except log.error(f"[Course Enrollment] Email sending failed with exception: {exc}") countdown = 60 * (self.request.retries + 1) - raise self.retry(exc=exc, countdown=countdown, max_retries=MAX_RETRIES) + raise self.retry(exc=exc, countdown=countdown, max_retries=MAX_RETRIES) # noqa: B904 diff --git a/common/djangoapps/student/tests/factories.py b/common/djangoapps/student/tests/factories.py index 21fa9a1b44f1..2fdefc5744ed 100644 --- a/common/djangoapps/student/tests/factories.py +++ b/common/djangoapps/student/tests/factories.py @@ -24,21 +24,23 @@ User, UserAttribute, UserProfile, - UserStanding + UserStanding, +) +from common.djangoapps.student.roles import ( + CourseBetaTesterRole, + CourseInstructorRole, + CourseStaffRole, + GlobalStaff, + OrgInstructorRole, + OrgStaffRole, ) -from common.djangoapps.student.roles import GlobalStaff -from common.djangoapps.student.roles import CourseBetaTesterRole -from common.djangoapps.student.roles import CourseInstructorRole -from common.djangoapps.student.roles import CourseStaffRole -from common.djangoapps.student.roles import OrgInstructorRole -from common.djangoapps.student.roles import OrgStaffRole from openedx.core.djangoapps.content.course_overviews.models import CourseOverview from openedx.core.djangoapps.content.course_overviews.tests.factories import CourseOverviewFactory TEST_PASSWORD = 'Password1234' -class GroupFactory(DjangoModelFactory): # lint-amnesty, pylint: disable=missing-class-docstring +class GroupFactory(DjangoModelFactory): # pylint: disable=missing-class-docstring class Meta: model = Group django_get_or_create = ('name', ) @@ -46,7 +48,7 @@ class Meta: name = factory.Sequence('group{}'.format) -class UserStandingFactory(DjangoModelFactory): # lint-amnesty, pylint: disable=missing-class-docstring +class UserStandingFactory(DjangoModelFactory): # pylint: disable=missing-class-docstring class Meta: model = UserStanding @@ -55,7 +57,7 @@ class Meta: changed_by = None -class UserProfileFactory(DjangoModelFactory): # lint-amnesty, pylint: disable=missing-class-docstring +class UserProfileFactory(DjangoModelFactory): # pylint: disable=missing-class-docstring class Meta: model = UserProfile django_get_or_create = ('user', ) @@ -68,7 +70,7 @@ class Meta: goals = 'Learn a lot' -class RegistrationFactory(DjangoModelFactory): # lint-amnesty, pylint: disable=missing-class-docstring +class RegistrationFactory(DjangoModelFactory): # pylint: disable=missing-class-docstring class Meta: model = Registration @@ -76,7 +78,7 @@ class Meta: activation_key = str(uuid4().hex) -class UserFactory(DjangoModelFactory): # lint-amnesty, pylint: disable=missing-class-docstring +class UserFactory(DjangoModelFactory): # pylint: disable=missing-class-docstring class Meta: model = User django_get_or_create = ('email', 'username') @@ -105,7 +107,7 @@ def profile(obj, create, extracted, **kwargs): # pylint: disable=unused-argumen return None @factory.post_generation - def groups(self, create, extracted, **kwargs): # lint-amnesty, pylint: disable=missing-function-docstring, unused-argument + def groups(self, create, extracted, **kwargs): # pylint: disable=missing-function-docstring, unused-argument if extracted is None: return @@ -113,10 +115,10 @@ def groups(self, create, extracted, **kwargs): # lint-amnesty, pylint: disable= extracted = [extracted] for group_name in extracted: - self.groups.add(GroupFactory.simple_generate(create, name=group_name)) # lint-amnesty, pylint: disable=no-member + self.groups.add(GroupFactory.simple_generate(create, name=group_name)) # pylint: disable=no-member -class UserAttributeFactory(DjangoModelFactory): # lint-amnesty, pylint: disable=missing-class-docstring +class UserAttributeFactory(DjangoModelFactory): # pylint: disable=missing-class-docstring class Meta: model = UserAttribute @@ -131,7 +133,7 @@ class RequestFactoryNoCsrf(RequestFactory): """ def request(self, **kwargs): request = super().request(**kwargs) - setattr(request, '_dont_enforce_csrf_checks', True) # pylint: disable=literal-used-as-attribute + setattr(request, '_dont_enforce_csrf_checks', True) # pylint: disable=literal-used-as-attribute # noqa: B010 return request @@ -148,7 +150,7 @@ class SuperuserFactory(UserFactory): is_superuser = True -class CourseEnrollmentFactory(DjangoModelFactory): # lint-amnesty, pylint: disable=missing-class-docstring +class CourseEnrollmentFactory(DjangoModelFactory): # pylint: disable=missing-class-docstring class Meta: model = CourseEnrollment @@ -204,7 +206,7 @@ class Meta: enrollment = factory.SubFactory(CourseEnrollmentFactory) -class CourseAccessRoleFactory(DjangoModelFactory): # lint-amnesty, pylint: disable=missing-class-docstring +class CourseAccessRoleFactory(DjangoModelFactory): # pylint: disable=missing-class-docstring class Meta: model = CourseAccessRole @@ -213,7 +215,7 @@ class Meta: role = 'TestRole' -class CourseEnrollmentAllowedFactory(DjangoModelFactory): # lint-amnesty, pylint: disable=missing-class-docstring +class CourseEnrollmentAllowedFactory(DjangoModelFactory): # pylint: disable=missing-class-docstring class Meta: model = CourseEnrollmentAllowed @@ -243,7 +245,7 @@ class Meta: app_label = factory.Faker('app_name') -class PermissionFactory(DjangoModelFactory): # lint-amnesty, pylint: disable=missing-class-docstring +class PermissionFactory(DjangoModelFactory): # pylint: disable=missing-class-docstring class Meta: model = Permission @@ -251,7 +253,7 @@ class Meta: content_type = factory.SubFactory(ContentTypeFactory) -class AccountRecoveryFactory(DjangoModelFactory): # lint-amnesty, pylint: disable=missing-class-docstring +class AccountRecoveryFactory(DjangoModelFactory): # pylint: disable=missing-class-docstring class Meta: model = AccountRecovery django_get_or_create = ('user',) diff --git a/common/djangoapps/student/tests/test_activate_account.py b/common/djangoapps/student/tests/test_activate_account.py index e767800155aa..12fef9f4de89 100644 --- a/common/djangoapps/student/tests/test_activate_account.py +++ b/common/djangoapps/student/tests/test_activate_account.py @@ -6,7 +6,7 @@ from uuid import uuid4 from django.conf import settings -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.test import TestCase, override_settings from django.urls import reverse from django.utils.http import urlencode @@ -114,7 +114,7 @@ def test_account_activation_message(self): email_start="", email_end="", email=self.user.email, - link_start="".format( + link_start="".format( # noqa: UP032 activation_email_support_link=self.activation_email_support_link, ), link_end="", @@ -240,7 +240,7 @@ def test_unauthenticated_user_redirects_to_mfe(self): Verify that if Authn MFE is enabled then authenticated user redirects to login page with correct query param. """ - login_page_url = "{authn_mfe}/login?account_activation_status=".format( + login_page_url = "{authn_mfe}/login?account_activation_status=".format( # noqa: UP032 authn_mfe=settings.AUTHN_MICROFRONTEND_URL ) @@ -267,7 +267,7 @@ def test_unauthenticated_user_redirects_to_mfe_with_valid_next_url(self): `next` redirect URL is provided to the activation URL, it should be included as a parameter in the login page the requesting user is redirected to. """ - login_page_url = "{authn_mfe}/login?account_activation_status=".format( + login_page_url = "{authn_mfe}/login?account_activation_status=".format( # noqa: UP032 authn_mfe=settings.AUTHN_MICROFRONTEND_URL ) diff --git a/common/djangoapps/student/tests/test_admin_views.py b/common/djangoapps/student/tests/test_admin_views.py index da8376fbbe5e..ef9d894445db 100644 --- a/common/djangoapps/student/tests/test_admin_views.py +++ b/common/djangoapps/student/tests/test_admin_views.py @@ -10,27 +10,28 @@ import ddt import pytest - from django.contrib.admin.sites import AdminSite -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.forms import ValidationError from django.test import TestCase, override_settings from django.urls import reverse from django.utils.timezone import now from edx_toggles.toggles.testutils import override_waffle_switch -from common.djangoapps.student.admin import ( # lint-amnesty, pylint: disable=line-too-long +from common.djangoapps.student.admin import ( # pylint: disable=line-too-long COURSE_ENROLLMENT_ADMIN_SWITCH, AllowedAuthUserForm, CourseEnrollmentForm, - UserAdmin + UserAdmin, ) from common.djangoapps.student.models import AllowedAuthUser, CourseEnrollment, LoginFailures from common.djangoapps.student.tests.factories import CourseEnrollmentFactory, UserFactory, UserProfileFactory from openedx.core.djangoapps.content.course_overviews.tests.factories import CourseOverviewFactory from openedx.core.djangoapps.site_configuration.tests.mixins import SiteMixin -from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + SharedModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order class AdminCourseRolesPageTest(SharedModuleStoreTestCase): @@ -144,14 +145,14 @@ def test_save_with_invalid_course(self): response = self.client.post(reverse('admin:student_courseaccessrole_add'), data=data) self.assertContains( response, - 'Course not found. Entered course id was: "{}".'.format( + 'Course not found. Entered course id was: "{}".'.format( # noqa: UP032 course ) ) self.assertContains( response, - "Email does not exist. Could not find {}. Please re-enter email address".format( + "Email does not exist. Could not find {}. Please re-enter email address".format( # noqa: UP032 email ) ) @@ -575,10 +576,10 @@ def test_language_autocomplete_returns_expected_result(self): profile = UserProfileFactory(user=self.staff_user, language='Esperanto') response = self.client.get(self.language_url) - self.assertEqual(response.status_code, 200) + self.assertEqual(response.status_code, 200) # noqa: PT009 data = json.loads(response.content.decode('utf-8')) - self.assertTrue( + self.assertTrue( # noqa: PT009 any('Esperanto' in item['text'] for item in data['results']), f"Esperanto not found in: {data['results']}" ) @@ -587,10 +588,10 @@ def test_language_autocomplete_returns_expected_result(self): profile.save() response = self.client.get(f'{self.language_url}?q=Fren') - self.assertEqual(response.status_code, 200) + self.assertEqual(response.status_code, 200) # noqa: PT009 data = json.loads(response.content.decode('utf-8')) - self.assertTrue( + self.assertTrue( # noqa: PT009 any('French' in item['text'] for item in data['results']), f"French not found in: {data['results']}" ) @@ -600,9 +601,9 @@ def test_country_autocomplete_returns_expected_result(self): profile = UserProfileFactory(user=self.staff_user, country='SE') response = self.client.get(self.country_url) - self.assertEqual(response.status_code, 200) + self.assertEqual(response.status_code, 200) # noqa: PT009 data = json.loads(response.content.decode('utf-8')) - self.assertTrue( + self.assertTrue( # noqa: PT009 any('Sweden' in item['text'] for item in data['results']), f"Sweden not found in: {data['results']}" ) @@ -611,10 +612,10 @@ def test_country_autocomplete_returns_expected_result(self): profile.save() response = self.client.get(f'{self.country_url}?q=Japan') - self.assertEqual(response.status_code, 200) + self.assertEqual(response.status_code, 200) # noqa: PT009 data = json.loads(response.content.decode('utf-8')) - self.assertTrue( + self.assertTrue( # noqa: PT009 any('Japan' in item['text'] for item in data['results']), f"Japan not found in: {data['results']}" ) @@ -622,24 +623,24 @@ def test_country_autocomplete_returns_expected_result(self): @ddt.data('eng', 'fren', 'GER') def test_language_autocomplete_filters_correctly(self, term): response = self.client.get(f'{self.language_url}?q={term}') - self.assertEqual(response.status_code, 200) + self.assertEqual(response.status_code, 200) # noqa: PT009 data = json.loads(response.content) - self.assertTrue(any(term.lower() in item['text'].lower() for item in data['results'])) + self.assertTrue(any(term.lower() in item['text'].lower() for item in data['results'])) # noqa: PT009 def test_language_autocomplete_returns_empty_on_no_match(self): response = self.client.get(f'{self.language_url}?q=not-a-lang') - self.assertEqual(json.loads(response.content)['results'], []) + self.assertEqual(json.loads(response.content)['results'], []) # noqa: PT009 @ddt.data('United', 'Kingdom', 'Pakistan') def test_country_autocomplete_filters_correctly(self, term): response = self.client.get(f'{self.country_url}?q={term}') - self.assertEqual(response.status_code, 200) + self.assertEqual(response.status_code, 200) # noqa: PT009 data = json.loads(response.content) - self.assertTrue(any(term.lower() in item['text'].lower() for item in data['results'])) + self.assertTrue(any(term.lower() in item['text'].lower() for item in data['results'])) # noqa: PT009 def test_country_autocomplete_returns_empty_on_gibberish(self): response = self.client.get(f'{self.country_url}?q=asdfghjkl') - self.assertEqual(json.loads(response.content)['results'], []) + self.assertEqual(json.loads(response.content)['results'], []) # noqa: PT009 def test_admin_inline_autocomplete_urls_render(self): admin = UserFactory(is_staff=True, is_superuser=True) @@ -652,7 +653,7 @@ def test_admin_inline_autocomplete_urls_render(self): self.client.login(username=admin.username, password='test') # re-login as admin response = self.client.get(reverse('admin:auth_user_change', args=[user.id])) - self.assertEqual(response.status_code, 200) + self.assertEqual(response.status_code, 200) # noqa: PT009 self.assertContains(response, self.language_url) self.assertContains(response, self.country_url) @@ -661,37 +662,37 @@ def test_language_autocomplete_blocks_non_staff(self): self.client.login(username=self.non_staff_user.username, password='test') response = self.client.get(f'{self.language_url}?q=english') data = json.loads(response.content) - self.assertEqual(data['results'], []) + self.assertEqual(data['results'], []) # noqa: PT009 def test_country_autocomplete_blocks_non_staff(self): self.client.logout() self.client.login(username=self.non_staff_user.username, password='test') response = self.client.get(f'{self.country_url}?q=pakistan') data = json.loads(response.content) - self.assertEqual(data['results'], []) + self.assertEqual(data['results'], []) # noqa: PT009 def test_language_autocomplete_blocks_anonymous_user(self): """Ensure anonymous user gets blocked or redirected.""" self.client.logout() response = self.client.get(f'{self.language_url}?q=English') - self.assertIn(response.status_code, [302, 403]) + self.assertIn(response.status_code, [302, 403]) # noqa: PT009 def test_country_autocomplete_blocks_anonymous_user(self): """Ensure anonymous user gets blocked or redirected.""" self.client.logout() response = self.client.get(f'{self.country_url}?q=Pakistan') - self.assertIn(response.status_code, [302, 403]) + self.assertIn(response.status_code, [302, 403]) # noqa: PT009 def test_language_autocomplete_status_for_non_staff(self): self.client.logout() self.client.login(username=self.non_staff_user.username, password='test') response = self.client.get(f'{self.language_url}?q=English') - self.assertEqual(response.status_code, 200) # still 200, but empty results expected - self.assertEqual(json.loads(response.content)['results'], []) + self.assertEqual(response.status_code, 200) # still 200, but empty results expected # noqa: PT009 + self.assertEqual(json.loads(response.content)['results'], []) # noqa: PT009 def test_unknown_autocomplete_path_404s(self): logged_in = self.client.login(username=self.staff_user.username, password='test') assert logged_in, "Login failed — test user not authenticated" response = self.client.get('/admin/myapp/mymodel/fake-autocomplete/') - self.assertEqual(response.status_code, 404) + self.assertEqual(response.status_code, 404) # noqa: PT009 diff --git a/common/djangoapps/student/tests/test_api.py b/common/djangoapps/student/tests/test_api.py index 4757790e727f..56200b8b5efd 100644 --- a/common/djangoapps/student/tests/test_api.py +++ b/common/djangoapps/student/tests/test_api.py @@ -2,13 +2,10 @@ Test Student api.py """ -from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase -from xmodule.modulestore.tests.factories import CourseFactory - from common.djangoapps.student.api import ( + get_course_enrollments, is_user_enrolled_in_course, is_user_staff_or_instructor_in_course, - get_course_enrollments, ) from common.djangoapps.student.models import CourseEnrollment from common.djangoapps.student.tests.factories import ( @@ -18,6 +15,8 @@ StaffFactory, UserFactory, ) +from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase +from xmodule.modulestore.tests.factories import CourseFactory class TestStudentApi(SharedModuleStoreTestCase): @@ -88,7 +87,7 @@ def test_get_course_enrollments(self): result = get_course_enrollments(self.user) - self.assertEqual(list(expected), list(result)) + self.assertEqual(list(expected), list(result)) # noqa: PT009 def test_get_filtered_course_enrollments(self): """Verify a filtered subset of enrollments can be retrieved""" @@ -99,4 +98,4 @@ def test_get_filtered_course_enrollments(self): result = get_course_enrollments(self.user, True, course_ids=[course_2.id]) - self.assertEqual(list(expected), list(result)) + self.assertEqual(list(expected), list(result)) # noqa: PT009 diff --git a/common/djangoapps/student/tests/test_authz.py b/common/djangoapps/student/tests/test_authz.py index 70636e04b68a..d349da4b1bf6 100644 --- a/common/djangoapps/student/tests/test_authz.py +++ b/common/djangoapps/student/tests/test_authz.py @@ -11,21 +11,21 @@ from django.test import TestCase, override_settings from opaque_keys.edx.locator import CourseLocator -from common.djangoapps.student.models.user import CourseAccessRole from common.djangoapps.student.auth import ( add_users, has_studio_read_access, has_studio_write_access, remove_users, update_org_role, - user_has_role + user_has_role, ) +from common.djangoapps.student.models.user import CourseAccessRole from common.djangoapps.student.roles import ( CourseCreatorRole, CourseInstructorRole, CourseLimitedStaffRole, CourseStaffRole, - OrgContentCreatorRole + OrgContentCreatorRole, ) from common.djangoapps.student.tests.factories import AdminFactory, UserFactory @@ -120,7 +120,7 @@ def test_add_user_not_active(self): assert not user_has_role(self.user, CourseCreatorRole()) def test_add_user_to_group_requires_staff_access(self): - with pytest.raises(PermissionDenied): + with pytest.raises(PermissionDenied): # noqa: PT012 self.admin.is_staff = False add_users(self.admin, CourseCreatorRole(), self.user) @@ -128,12 +128,12 @@ def test_add_user_to_group_requires_staff_access(self): add_users(self.user, CourseCreatorRole(), self.user) def test_add_user_to_group_requires_active(self): - with pytest.raises(PermissionDenied): + with pytest.raises(PermissionDenied): # noqa: PT012 self.admin.is_active = False add_users(self.admin, CourseCreatorRole(), self.user) def test_add_user_to_group_requires_authenticated(self): - with pytest.raises(PermissionDenied): + with pytest.raises(PermissionDenied): # noqa: PT012 with mock.patch( 'django.contrib.auth.models.User.is_authenticated', new_callable=mock.PropertyMock @@ -142,17 +142,17 @@ def test_add_user_to_group_requires_authenticated(self): add_users(self.admin, CourseCreatorRole(), self.user) def test_remove_user_from_group_requires_staff_access(self): - with pytest.raises(PermissionDenied): + with pytest.raises(PermissionDenied): # noqa: PT012 self.admin.is_staff = False remove_users(self.admin, CourseCreatorRole(), self.user) def test_remove_user_from_group_requires_active(self): - with pytest.raises(PermissionDenied): + with pytest.raises(PermissionDenied): # noqa: PT012 self.admin.is_active = False remove_users(self.admin, CourseCreatorRole(), self.user) def test_remove_user_from_group_requires_authenticated(self): - with pytest.raises(PermissionDenied): + with pytest.raises(PermissionDenied): # noqa: PT012 with mock.patch( 'django.contrib.auth.models.User.is_authenticated', new_callable=mock.PropertyMock diff --git a/common/djangoapps/student/tests/test_bulk_email_settings.py b/common/djangoapps/student/tests/test_bulk_email_settings.py index 308ccf66e09d..5c43d66c0919 100644 --- a/common/djangoapps/student/tests/test_bulk_email_settings.py +++ b/common/djangoapps/student/tests/test_bulk_email_settings.py @@ -7,14 +7,17 @@ from django.urls import reverse +from common.djangoapps.student.tests.factories import CourseEnrollmentFactory, UserFactory + # This import is for an lms djangoapp. # Its testcases are only run under lms. from lms.djangoapps.bulk_email.api import is_bulk_email_feature_enabled from lms.djangoapps.bulk_email.models import BulkEmailFlag, CourseAuthorization -from common.djangoapps.student.tests.factories import CourseEnrollmentFactory, UserFactory from openedx.core.djangolib.testing.utils import skip_unless_lms -from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + SharedModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order @skip_unless_lms diff --git a/common/djangoapps/student/tests/test_certificates.py b/common/djangoapps/student/tests/test_certificates.py index 914e255df944..a25fe5560ec8 100644 --- a/common/djangoapps/student/tests/test_certificates.py +++ b/common/djangoapps/student/tests/test_certificates.py @@ -8,17 +8,17 @@ from django.conf import settings from django.test.utils import override_settings from django.urls import reverse -from xmodule.modulestore import ModuleStoreEnum -from xmodule.modulestore.tests.django_utils import TEST_DATA_SPLIT_MODULESTORE, SharedModuleStoreTestCase -from xmodule.modulestore.tests.factories import CourseFactory -from xmodule.data import CertificatesDisplayBehaviors from common.djangoapps.student.tests.factories import CourseEnrollmentFactory, UserFactory -from openedx.core.djangolib.testing.utils import skip_unless_lms from lms.djangoapps.certificates.api import get_certificate_url from lms.djangoapps.certificates.data import CertificateStatuses from lms.djangoapps.certificates.tests.factories import GeneratedCertificateFactory from openedx.core.djangoapps.site_configuration.tests.test_util import with_site_configuration_context +from openedx.core.djangolib.testing.utils import skip_unless_lms +from xmodule.data import CertificatesDisplayBehaviors +from xmodule.modulestore import ModuleStoreEnum +from xmodule.modulestore.tests.django_utils import TEST_DATA_SPLIT_MODULESTORE, SharedModuleStoreTestCase +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=no-member @@ -89,7 +89,7 @@ def setUpClass(cls): cls.course.save() cls.store.update_item(cls.course, cls.USERNAME) - def _check_message(self, visible_date): # lint-amnesty, pylint: disable=missing-function-docstring + def _check_message(self, visible_date): # pylint: disable=missing-function-docstring response = self.client.get(reverse('dashboard')) is_past = visible_date < datetime.datetime.now(ZoneInfo("UTC")) @@ -150,7 +150,7 @@ def test_unverified_certificate_message(self, enrollment_mode): response = self.client.get(reverse('dashboard')) self.assertContains( response, - 'do not have a current verified identity with {platform_name}' + 'do not have a current verified identity with {platform_name}' # noqa: UP032 .format(platform_name=settings.PLATFORM_NAME)) @ddt.data( diff --git a/common/djangoapps/student/tests/test_configuration_overrides.py b/common/djangoapps/student/tests/test_configuration_overrides.py index fc69bdd17497..dd5f4622ea64 100644 --- a/common/djangoapps/student/tests/test_configuration_overrides.py +++ b/common/djangoapps/student/tests/test_configuration_overrides.py @@ -4,9 +4,9 @@ import json - from unittest import mock -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user + +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.test import TestCase from django.test.utils import override_settings from django.urls import reverse diff --git a/common/djangoapps/student/tests/test_course_listing.py b/common/djangoapps/student/tests/test_course_listing.py index 3034c697f2bb..df25f44cfa8e 100644 --- a/common/djangoapps/student/tests/test_course_listing.py +++ b/common/djangoapps/student/tests/test_course_listing.py @@ -4,22 +4,25 @@ """ from unittest import mock + from django.conf import settings from django.test.client import Client from milestones.tests.utils import MilestonesTestCaseMixin -from openedx.core.djangoapps.content.course_overviews.models import CourseOverview -from openedx.core.djangolib.testing.utils import skip_unless_lms -from common.djangoapps.student.models import CourseEnrollment # lint-amnesty, pylint: disable=unused-import +from common.djangoapps.student.models import CourseEnrollment # pylint: disable=unused-import from common.djangoapps.student.roles import GlobalStaff from common.djangoapps.student.tests.factories import UserFactory from common.djangoapps.student.views import get_course_enrollments from common.djangoapps.util.milestones_helpers import get_pre_requisite_courses_not_completed, set_prerequisite_courses -from xmodule.error_block import ErrorBlock # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore import ModuleStoreEnum # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from openedx.core.djangoapps.content.course_overviews.models import CourseOverview +from openedx.core.djangolib.testing.utils import skip_unless_lms +from xmodule.error_block import ErrorBlock # pylint: disable=wrong-import-order +from xmodule.modulestore import ModuleStoreEnum # pylint: disable=wrong-import-order +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + ModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order class TestCourseListing(ModuleStoreTestCase, MilestonesTestCaseMixin): diff --git a/common/djangoapps/student/tests/test_credit.py b/common/djangoapps/student/tests/test_credit.py index 20ba9cd72ebc..950b068d36bb 100644 --- a/common/djangoapps/student/tests/test_credit.py +++ b/common/djangoapps/student/tests/test_credit.py @@ -16,8 +16,10 @@ from openedx.core.djangoapps.credit import api as credit_api from openedx.core.djangoapps.credit.models import CreditCourse, CreditEligibility, CreditProvider from openedx.core.djangolib.testing.utils import skip_unless_lms -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + ModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order TEST_CREDIT_PROVIDER_SECRET_KEY = "931433d583c84ca7ba41784bad3232e6" diff --git a/common/djangoapps/student/tests/test_email.py b/common/djangoapps/student/tests/test_email.py index bcede1821376..467eae934e56 100644 --- a/common/djangoapps/student/tests/test_email.py +++ b/common/djangoapps/student/tests/test_email.py @@ -1,4 +1,4 @@ -# lint-amnesty, pylint: disable=missing-module-docstring +# pylint: disable=missing-module-docstring import json from string import capwords @@ -7,7 +7,7 @@ import ddt import pytest from django.conf import settings -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.core import mail from django.db import transaction from django.http import HttpResponse @@ -26,23 +26,25 @@ SETTING_CHANGE_INITIATED, confirm_email_change, do_email_change_request, - validate_new_email + validate_new_email, ) from common.djangoapps.third_party_auth.views import inactive_user_view from common.djangoapps.util.testing import EventTestMixin from openedx.core.djangoapps.ace_common.tests.mixins import EmailTemplateTagMixin from openedx.core.djangoapps.site_configuration import helpers as configuration_helpers from openedx.core.djangolib.testing.utils import CacheIsolationMixin, CacheIsolationTestCase, skip_unless_lms -from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + ModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order class TestException(Exception): """ Exception used for testing that nothing will catch explicitly """ - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass def mock_render_to_string(template_name, context): @@ -104,7 +106,7 @@ class ActivationEmailTests(EmailTemplateTagMixin, CacheIsolationTestCase): # sent from an OpenEdX installation. OPENEDX_FRAGMENTS = [ ( - "Use the link below to activate your account to access engaging, " + "Use the link below to activate your account to access engaging, " # noqa: UP032 "high-quality {platform_name} courses. Note that you will not be able to log back into your " "account until you have activated it.".format( platform_name=settings.PLATFORM_NAME @@ -117,7 +119,7 @@ class ActivationEmailTests(EmailTemplateTagMixin, CacheIsolationTestCase): settings.CONTACT_EMAIL, "This email message was automatically sent by ", settings.LMS_ROOT_URL, - " because someone attempted to create an account on {platform_name}".format( + " because someone attempted to create an account on {platform_name}".format( # noqa: UP032 platform_name=settings.PLATFORM_NAME ), " using this email address." @@ -143,7 +145,7 @@ def _create_account(self): } resp = self.client.post(url, params) assert resp.status_code == 200, "Could not create account (status {status}). The response was {response}"\ - .format(status=resp.status_code, response=resp.content) + .format(status=resp.status_code, response=resp.content) # noqa: UP032 def _assert_activation_email(self, subject, body_fragments, test_body_type): """ @@ -277,8 +279,8 @@ def _assert_email(self): appears = self._get_fragments() for fragment in appears: - self.assertIn(fragment, text) - self.assertIn(fragment, html) + self.assertIn(fragment, text) # noqa: PT009 + self.assertIn(fragment, html) # noqa: PT009 def _get_fragments(self): """ @@ -288,7 +290,7 @@ def _get_fragments(self): proctoring_provider = capwords(course_block.proctoring_provider.replace('_', ' ')) fragments = [ ( - "You are enrolled in {} at {}. This course contains proctored exams.".format( + "You are enrolled in {} at {}. This course contains proctored exams.".format( # noqa: UP032 self.course.display_name, settings.PLATFORM_NAME ) @@ -350,7 +352,7 @@ def assertFailedRequest(self, response_data, expected_error): assert self.user.email_user.called is False @patch('common.djangoapps.student.views.management.render_to_string', - Mock(side_effect=mock_render_to_string, autospec=True)) # lint-amnesty, pylint: disable=line-too-long + Mock(side_effect=mock_render_to_string, autospec=True)) # pylint: disable=line-too-long def test_duplicate_activation_key(self): """ Assert that if two users change Email address simultaneously, no error is thrown @@ -387,7 +389,7 @@ def test_email_failure(self, send_mail): Test the return value if sending the email for the user to click fails. """ send_mail.side_effect = [Exception, None] - with self.assertRaisesRegex(ValueError, 'Unable to send email activation link. Please try again later.'): + with self.assertRaisesRegex(ValueError, 'Unable to send email activation link. Please try again later.'): # noqa: PT027 # pylint: disable=line-too-long self.do_email_change(self.user, "valid@email.com") self.assert_no_events_were_emitted() @@ -406,7 +408,7 @@ def test_email_success(self): subject='Request to change édX account e-mail', body_fragments=[ 'We received a request to change the e-mail associated with', - 'your édX account from {old_email} to {new_email}.'.format( + 'your édX account from {old_email} to {new_email}.'.format( # noqa: UP032 old_email=old_email, new_email=new_email, ), @@ -440,9 +442,9 @@ def _assert_email(self, subject, body_fragments): @ddt.ddt @patch('common.djangoapps.student.views.management.render_to_response', - Mock(side_effect=mock_render_to_response, autospec=True)) # lint-amnesty, pylint: disable=line-too-long + Mock(side_effect=mock_render_to_response, autospec=True)) # pylint: disable=line-too-long @patch('common.djangoapps.student.views.management.render_to_string', - Mock(side_effect=mock_render_to_string, autospec=True)) # lint-amnesty, pylint: disable=line-too-long + Mock(side_effect=mock_render_to_string, autospec=True)) # pylint: disable=line-too-long class EmailChangeConfirmationTests(EmailTestMixin, EmailTemplateTagMixin, CacheIsolationMixin, TransactionTestCase): """ Test that confirmation of email change requests function even in the face of exceptions thrown while sending email @@ -461,13 +463,13 @@ def setUp(self): self.key = self.pending_change_request.activation_key # Expected subject of the email - self.email_subject = "Email Change Confirmation for {platform_name}".format( + self.email_subject = "Email Change Confirmation for {platform_name}".format( # noqa: UP032 platform_name=settings.PLATFORM_NAME ) # Text fragments we expect in the body of the confirmation email self.email_fragments = [ - "This is to confirm that you changed the e-mail associated with {platform_name}" + "This is to confirm that you changed the e-mail associated with {platform_name}" # noqa: UP032 " from {old_email} to {new_email}. If you did not make this request, please contact us immediately." " Contact information is listed at:".format( platform_name=settings.PLATFORM_NAME, @@ -677,7 +679,7 @@ def test_email_failure(self, send_mail): Test the return value if sending the email for the user to click fails. """ send_mail.side_effect = [Exception, None] - with self.assertRaisesRegex(ValueError, 'Unable to send email activation link. Please try again later.'): + with self.assertRaisesRegex(ValueError, 'Unable to send email activation link. Please try again later.'): # noqa: PT027 # pylint: disable=line-too-long self.do_secondary_email_change(self.user, "valid@email.com") self.assert_no_events_were_emitted() diff --git a/common/djangoapps/student/tests/test_enrollment.py b/common/djangoapps/student/tests/test_enrollment.py index fee4ec39906f..b7f480a8945f 100644 --- a/common/djangoapps/student/tests/test_enrollment.py +++ b/common/djangoapps/student/tests/test_enrollment.py @@ -8,9 +8,7 @@ import pytest from django.conf import settings from django.urls import reverse -from openedx_events.tests.utils import OpenEdxEventsTestMixin -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase -from xmodule.modulestore.tests.factories import CourseFactory, BlockFactory +from openedx_events.testing import OpenEdxEventsTestMixin from common.djangoapps.course_modes.models import CourseMode from common.djangoapps.course_modes.tests.factories import CourseModeFactory @@ -18,19 +16,21 @@ SCORE_RECALCULATION_DELAY_ON_ENROLLMENT_UPDATE, CourseEnrollment, CourseFullError, - EnrollmentClosedError + EnrollmentClosedError, ) from common.djangoapps.student.roles import CourseInstructorRole, CourseStaffRole from common.djangoapps.student.tests.factories import CourseEnrollmentAllowedFactory, UserFactory from common.djangoapps.util.testing import UrlResetMixin from openedx.core.djangoapps.embargo.test_utils import restrict_course from openedx.core.djangolib.testing.utils import skip_unless_lms +from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase +from xmodule.modulestore.tests.factories import BlockFactory, CourseFactory @ddt.ddt @patch.dict('django.conf.settings.FEATURES', {'ENABLE_SPECIAL_EXAMS': True}) @skip_unless_lms -class EnrollmentTest(UrlResetMixin, ModuleStoreTestCase, OpenEdxEventsTestMixin): +class EnrollmentTest(OpenEdxEventsTestMixin, UrlResetMixin, ModuleStoreTestCase): """ Test student enrollment, especially with different course modes. """ @@ -42,17 +42,6 @@ class EnrollmentTest(UrlResetMixin, ModuleStoreTestCase, OpenEdxEventsTestMixin) PASSWORD = "edx" URLCONF_MODULES = ['openedx.core.djangoapps.embargo'] - @classmethod - def setUpClass(cls): - """ - Set up class method for the Test class. - - This method starts manually events isolation. Explanation here: - openedx/core/djangoapps/user_authn/views/tests/test_events.py#L44 - """ - super().setUpClass() - cls.start_events_isolation() - @patch.dict(settings.FEATURES, {'EMBARGO': True}) def setUp(self): """ Create a course and user, then log in. """ diff --git a/common/djangoapps/student/tests/test_events.py b/common/djangoapps/student/tests/test_events.py index 7c9d625118d0..6ac0ec275c11 100644 --- a/common/djangoapps/student/tests/test_events.py +++ b/common/djangoapps/student/tests/test_events.py @@ -11,32 +11,33 @@ from django.test import TestCase from django_countries.fields import Country from opaque_keys.edx.keys import CourseKey -from openedx_events.learning.data import ( # lint-amnesty, pylint: disable=wrong-import-order +from openedx_events.learning.data import ( # pylint: disable=wrong-import-order CourseAccessRoleData, CourseData, CourseEnrollmentData, UserData, - UserPersonalData + UserPersonalData, ) -from openedx_events.learning.signals import ( # lint-amnesty, pylint: disable=wrong-import-order +from openedx_events.learning.signals import ( # pylint: disable=wrong-import-order COURSE_ACCESS_ROLE_ADDED, COURSE_ACCESS_ROLE_REMOVED, COURSE_ENROLLMENT_CHANGED, COURSE_ENROLLMENT_CREATED, - COURSE_UNENROLLMENT_COMPLETED + COURSE_UNENROLLMENT_COMPLETED, ) -from openedx_events.tests.utils import OpenEdxEventsTestMixin # lint-amnesty, pylint: disable=wrong-import-order +from openedx_events.testing import OpenEdxEventsTestMixin # pylint: disable=wrong-import-order from common.djangoapps.student.models import CourseEnrollment, CourseEnrollmentAllowed from common.djangoapps.student.roles import CourseInstructorRole, CourseStaffRole from common.djangoapps.student.tests.factories import CourseEnrollmentAllowedFactory, UserFactory, UserProfileFactory from common.djangoapps.student.tests.tests import UserSettingsEventTestMixin +from common.test.utils import assert_dict_contains_subset from openedx.core.djangoapps.content.course_overviews.tests.factories import CourseOverviewFactory from openedx.core.djangolib.testing.utils import skip_unless_lms -from xmodule.modulestore.tests.django_utils import \ - SharedModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order -from common.test.utils import assert_dict_contains_subset +from xmodule.modulestore.tests.django_utils import ( + SharedModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order class TestUserProfileEvents(UserSettingsEventTestMixin, TestCase): @@ -62,7 +63,7 @@ def test_change_one_field(self): # Verify that we remove the temporary `_changed_fields` property from # the model after we're done emitting events. with pytest.raises(AttributeError): - self.profile._changed_fields # pylint: disable=pointless-statement, protected-access + self.profile._changed_fields # pylint: disable=pointless-statement, protected-access # noqa: B018 def test_change_many_fields(self): """ @@ -101,7 +102,7 @@ def test_excluded_field(self): self.assert_no_events_were_emitted() @mock.patch('common.djangoapps.student.models.user.UserProfile.save', side_effect=IntegrityError) - def test_no_event_if_save_failed(self, _save_mock): + def test_no_event_if_save_failed(self, _save_mock): # noqa: PT019 """ Verify no event is triggered if the save does not complete. Note that the pre_save signal is not called in this case either, but the intent is to make it clear that this model @@ -162,7 +163,7 @@ def test_related_fields_ignored(self): self.assert_no_events_were_emitted() @mock.patch('django.contrib.auth.models.User.save', side_effect=IntegrityError) - def test_no_event_if_save_failed(self, _save_mock): + def test_no_event_if_save_failed(self, _save_mock): # noqa: PT019 """ Verify no event is triggered if the save does not complete. Note that the pre_save signal is not called in this case either, but the intent is to make it clear that this model @@ -186,7 +187,7 @@ def test_enrolled_after_email_change(self): """ Test that when a user's email changes, the user is enrolled in pending courses. """ - pending_enrollment = CourseEnrollmentAllowedFactory(auto_enroll=True) # lint-amnesty, pylint: disable=unused-variable + pending_enrollment = CourseEnrollmentAllowedFactory(auto_enroll=True) # pylint: disable=unused-variable # Create a CourseOverview for the enrollment course course_overview = CourseOverviewFactory.create(id=pending_enrollment.course_id) @@ -210,7 +211,7 @@ def test_enrolled_after_email_change(self): @skip_unless_lms -class EnrollmentEventsTest(SharedModuleStoreTestCase, OpenEdxEventsTestMixin): +class EnrollmentEventsTest(OpenEdxEventsTestMixin, SharedModuleStoreTestCase): """ Tests for the Open edX Events associated with the enrollment process through the enroll method. @@ -228,17 +229,6 @@ class EnrollmentEventsTest(SharedModuleStoreTestCase, OpenEdxEventsTestMixin): "org.openedx.learning.course.unenrollment.completed.v1", ] - @classmethod - def setUpClass(cls): - """ - Set up class method for the Test class. - - This method starts manually events isolation. Explanation here: - openedx/core/djangoapps/user_authn/views/tests/test_events.py#L44 - """ - super().setUpClass() - cls.start_events_isolation() - def setUp(self): # pylint: disable=arguments-differ super().setUp() self.course = CourseFactory.create() @@ -271,7 +261,7 @@ def test_enrollment_created_event_emitted(self): enrollment = CourseEnrollment.enroll(self.user, self.course.id) - self.assertTrue(self.receiver_called) + self.assertTrue(self.receiver_called) # noqa: PT009 assert_dict_contains_subset( self, { @@ -315,7 +305,7 @@ def test_enrollment_changed_event_emitted(self): enrollment.update_enrollment(mode="verified") - self.assertTrue(self.receiver_called) + self.assertTrue(self.receiver_called) # noqa: PT009 assert_dict_contains_subset( self, { @@ -359,7 +349,7 @@ def test_unenrollment_completed_event_emitted(self): CourseEnrollment.unenroll(self.user, self.course.id) - self.assertTrue(self.receiver_called) + self.assertTrue(self.receiver_called) # noqa: PT009 assert_dict_contains_subset( self, { @@ -390,7 +380,7 @@ def test_unenrollment_completed_event_emitted(self): @skip_unless_lms @ddt.ddt -class TestCourseAccessRoleEvents(TestCase, OpenEdxEventsTestMixin): +class TestCourseAccessRoleEvents(OpenEdxEventsTestMixin, TestCase): """ Tests for the events associated with the CourseAccessRole model. """ @@ -399,11 +389,6 @@ class TestCourseAccessRoleEvents(TestCase, OpenEdxEventsTestMixin): 'org.openedx.learning.user.course_access_role.removed.v1', ] - @classmethod - def setUpClass(cls): - super().setUpClass() - cls.start_events_isolation() - def setUp(self): self.course_key = CourseKey.from_string("course-v1:test+blah+blah") self.user = UserFactory.create( @@ -433,7 +418,7 @@ def test_access_role_created_event_emitted(self, AccessRole): role = AccessRole(self.course_key) role.add_users(self.user) - self.assertTrue(self.receiver_called) + self.assertTrue(self.receiver_called) # noqa: PT009 assert_dict_contains_subset( self, { @@ -472,7 +457,7 @@ def test_access_role_removed_event_emitted(self, AccessRole): COURSE_ACCESS_ROLE_REMOVED.connect(event_receiver) role.remove_users(self.user) - self.assertTrue(self.receiver_called) + self.assertTrue(self.receiver_called) # noqa: PT009 assert_dict_contains_subset( self, { diff --git a/common/djangoapps/student/tests/test_filters.py b/common/djangoapps/student/tests/test_filters.py index bf79ed7ae402..759c953dd65d 100644 --- a/common/djangoapps/student/tests/test_filters.py +++ b/common/djangoapps/student/tests/test_filters.py @@ -6,14 +6,14 @@ from django.test import override_settings from django.urls import reverse from openedx_filters import PipelineStep -from openedx_filters.learning.filters import DashboardRenderStarted, CourseEnrollmentStarted, CourseUnenrollmentStarted +from openedx_filters.learning.filters import CourseEnrollmentStarted, CourseUnenrollmentStarted, DashboardRenderStarted from rest_framework import status -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase -from xmodule.modulestore.tests.factories import CourseFactory from common.djangoapps.student.models import CourseEnrollment, EnrollmentNotAllowed, UnenrollmentNotAllowed from common.djangoapps.student.tests.factories import UserFactory, UserProfileFactory from openedx.core.djangolib.testing.utils import skip_unless_lms +from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase +from xmodule.modulestore.tests.factories import CourseFactory class TestEnrollmentPipelineStep(PipelineStep): @@ -153,7 +153,7 @@ def test_enrollment_filter_executed(self): """ enrollment = CourseEnrollment.enroll(self.user, self.course.id, mode='audit') - self.assertEqual('honor', enrollment.mode) + self.assertEqual('honor', enrollment.mode) # noqa: PT009 @override_settings( OPEN_EDX_FILTERS_CONFIG={ @@ -173,7 +173,7 @@ def test_enrollment_filter_prevent_enroll(self): - CourseEnrollmentStarted is triggered and executes TestEnrollmentPipelineStep. - The user can't enroll. """ - with self.assertRaises(EnrollmentNotAllowed): + with self.assertRaises(EnrollmentNotAllowed): # noqa: PT027 CourseEnrollment.enroll(self.user, self.course.id, mode='no-id-professional') @override_settings(OPEN_EDX_FILTERS_CONFIG={}) @@ -187,8 +187,8 @@ def test_enrollment_without_filter_configuration(self): """ enrollment = CourseEnrollment.enroll(self.user, self.course.id, mode='audit') - self.assertEqual('audit', enrollment.mode) - self.assertTrue(CourseEnrollment.is_enrolled(self.user, self.course.id)) + self.assertEqual('audit', enrollment.mode) # noqa: PT009 + self.assertTrue(CourseEnrollment.is_enrolled(self.user, self.course.id)) # noqa: PT009 @skip_unless_lms @@ -234,7 +234,7 @@ def test_unenrollment_filter_executed(self): CourseEnrollment.unenroll(self.user, self.course.id) - self.assertFalse(CourseEnrollment.is_enrolled(self.user, self.course.id)) + self.assertFalse(CourseEnrollment.is_enrolled(self.user, self.course.id)) # noqa: PT009 @override_settings( OPEN_EDX_FILTERS_CONFIG={ @@ -256,7 +256,7 @@ def test_unenrollment_filter_prevent_unenroll(self): """ CourseEnrollment.enroll(self.user, self.course.id, mode="no-id-professional") - with self.assertRaises(UnenrollmentNotAllowed): + with self.assertRaises(UnenrollmentNotAllowed): # noqa: PT027 CourseEnrollment.unenroll(self.user, self.course.id) @override_settings(OPEN_EDX_FILTERS_CONFIG={}) @@ -272,7 +272,7 @@ def test_unenrollment_without_filter_configuration(self): CourseEnrollment.unenroll(self.user, self.course.id) - self.assertFalse(CourseEnrollment.is_enrolled(self.user, self.course.id)) + self.assertFalse(CourseEnrollment.is_enrolled(self.user, self.course.id)) # noqa: PT009 @override_settings( OPEN_EDX_FILTERS_CONFIG={ @@ -301,8 +301,8 @@ def test_unenrollment_blocked_by_filter(self): response = self.client.post(reverse("change_enrollment"), params) - self.assertEqual(status.HTTP_400_BAD_REQUEST, response.status_code) - self.assertEqual("You can't un-enroll from this site.", response.content.decode("utf-8")) + self.assertEqual(status.HTTP_400_BAD_REQUEST, response.status_code) # noqa: PT009 + self.assertEqual("You can't un-enroll from this site.", response.content.decode("utf-8")) # noqa: PT009 @skip_unless_lms @@ -397,8 +397,8 @@ def test_dashboard_redirect(self): """ response = self.client.get(self.dashboard_url) - self.assertEqual(status.HTTP_302_FOUND, response.status_code) - self.assertEqual("https://custom-dashboard.com", response.url) + self.assertEqual(status.HTTP_302_FOUND, response.status_code) # noqa: PT009 + self.assertEqual("https://custom-dashboard.com", response.url) # noqa: PT009 @override_settings( OPEN_EDX_FILTERS_CONFIG={ @@ -421,8 +421,8 @@ def test_dashboard_redirect_account_settings(self): """ response = self.client.get(self.dashboard_url) - self.assertEqual(status.HTTP_302_FOUND, response.status_code) - self.assertEqual(settings.ACCOUNT_MICROFRONTEND_URL, response.url) + self.assertEqual(status.HTTP_302_FOUND, response.status_code) # noqa: PT009 + self.assertEqual(settings.ACCOUNT_MICROFRONTEND_URL, response.url) # noqa: PT009 @override_settings( OPEN_EDX_FILTERS_CONFIG={ @@ -444,7 +444,7 @@ def test_dashboard_custom_response(self): """ response = self.client.get(self.dashboard_url) - self.assertEqual("This is a custom response.", response.content.decode("utf-8")) + self.assertEqual("This is a custom response.", response.content.decode("utf-8")) # noqa: PT009 @override_settings(OPEN_EDX_FILTERS_CONFIG={}) def test_dashboard_render_without_filter_config(self): diff --git a/common/djangoapps/student/tests/test_linkedin.py b/common/djangoapps/student/tests/test_linkedin.py index 87c2d404aeff..1aca96e5c266 100644 --- a/common/djangoapps/student/tests/test_linkedin.py +++ b/common/djangoapps/student/tests/test_linkedin.py @@ -2,6 +2,7 @@ from types import SimpleNamespace from urllib.parse import quote + import ddt from django.conf import settings from django.test import TestCase @@ -68,7 +69,7 @@ def test_linked_in_url(self, cert_mode, expected_cert_name): course_mock_object, cert_mode, self.CERT_URL ) - self.assertEqual(actual_url, expected_url) + self.assertEqual(actual_url, expected_url) # noqa: PT009 @ddt.data( ('honor', 'Honor+Code+Credential+for+Test+Course+%E2%98%83'), @@ -99,7 +100,7 @@ def test_linked_in_url_with_cert_name_override(self, cert_mode, expected_cert_na actual_url = config.add_to_profile_url( course_mock_object, cert_mode, self.CERT_URL ) - self.assertEqual(actual_url, expected_url) + self.assertEqual(actual_url, expected_url) # noqa: PT009 @ddt.data( ('honor', 'Honor+Code+Credential+for+Test+Course+%E2%98%83'), @@ -136,4 +137,4 @@ def test_linked_in_url_with_course_org_name_override( course_mock_object, cert_mode, self.CERT_URL ) - self.assertEqual(actual_url, expected_url) + self.assertEqual(actual_url, expected_url) # noqa: PT009 diff --git a/common/djangoapps/student/tests/test_long_username_email.py b/common/djangoapps/student/tests/test_long_username_email.py index 337929acb271..0d8d98f25ed6 100644 --- a/common/djangoapps/student/tests/test_long_username_email.py +++ b/common/djangoapps/student/tests/test_long_username_email.py @@ -9,7 +9,7 @@ @override_settings(RATELIMIT_ENABLE=False) -class TestLongUsernameEmail(TestCase): # lint-amnesty, pylint: disable=missing-class-docstring +class TestLongUsernameEmail(TestCase): # pylint: disable=missing-class-docstring def setUp(self): super().setUp() @@ -41,7 +41,7 @@ def test_spoffed_name(self): """ Test name cannot contain html. """ - self.url_params['name'] = '


          Name
          Content spoof' # lint-amnesty, pylint: disable=line-too-long + self.url_params['name'] = '


          Name
          Content spoof' # pylint: disable=line-too-long response = self.client.post(self.url, self.url_params) assert response.status_code == 400 diff --git a/common/djangoapps/student/tests/test_models.py b/common/djangoapps/student/tests/test_models.py index 69f19da3dc18..69e6d3916e3d 100644 --- a/common/djangoapps/student/tests/test_models.py +++ b/common/djangoapps/student/tests/test_models.py @@ -1,4 +1,4 @@ -# lint-amnesty, pylint: disable=missing-module-docstring +# pylint: disable=missing-module-docstring import datetime import hashlib from unittest import mock @@ -7,11 +7,13 @@ import ddt from crum import set_current_request -from django.contrib.auth.models import AnonymousUser, User # lint-amnesty, pylint: disable=imported-auth-user -from django.core.cache import cache from django.conf import settings +from django.contrib.auth.models import AnonymousUser, User # pylint: disable=imported-auth-user +from django.core.cache import cache +from django.db import connection from django.db.models.functions import Lower from django.test import TestCase, override_settings +from django.test.utils import CaptureQueriesContext from edx_toggles.toggles.testutils import override_waffle_flag from freezegun import freeze_time from opaque_keys.edx.keys import CourseKey @@ -21,15 +23,17 @@ from common.djangoapps.student.models import ( ALLOWEDTOENROLL_TO_ENROLLED, IS_MARKETABLE, + PENDING_SECONDARY_EMAIL_REDACTED_VALUE, AccountRecovery, CourseEnrollment, CourseEnrollmentAllowed, ManualEnrollmentAudit, PendingEmailChange, PendingNameChange, + PendingSecondaryEmailChange, UserAttribute, UserCelebration, - UserProfile + UserProfile, ) from common.djangoapps.student.models_api import confirm_name_change, do_name_change_request, get_name from common.djangoapps.student.tests.factories import AccountRecoveryFactory, CourseEnrollmentFactory, UserFactory @@ -42,14 +46,17 @@ from openedx.core.djangoapps.content.course_overviews.tests.factories import CourseOverviewFactory from openedx.core.djangoapps.schedules.models import Schedule from openedx.core.djangoapps.user_api.preferences.api import set_user_preference -from openedx.core.djangolib.testing.utils import skip_unless_lms -from xmodule.modulestore import ModuleStoreEnum # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase, SharedModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from openedx.core.djangolib.testing.utils import assert_redact_before_delete, skip_unless_lms +from xmodule.modulestore import ModuleStoreEnum # pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( # pylint: disable=wrong-import-order + ModuleStoreTestCase, + SharedModuleStoreTestCase, +) +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order @ddt.ddt -class CourseEnrollmentTests(SharedModuleStoreTestCase): # lint-amnesty, pylint: disable=missing-class-docstring +class CourseEnrollmentTests(SharedModuleStoreTestCase): # pylint: disable=missing-class-docstring @classmethod def setUpClass(cls): super().setUpClass() @@ -75,7 +82,7 @@ def test_generate_enrollment_status_hash(self): assert CourseEnrollment.generate_enrollment_status_hash(AnonymousUser()) is None # No enrollments - expected = hashlib.md5(self.user.username.encode('utf-8')).hexdigest() # lint-amnesty, pylint: disable=no-member + expected = hashlib.md5(self.user.username.encode('utf-8')).hexdigest() # pylint: disable=no-member assert CourseEnrollment.generate_enrollment_status_hash(self.user) == expected self.assert_enrollment_status_hash_cached(self.user, expected) @@ -90,7 +97,7 @@ def test_generate_enrollment_status_hash(self): # One active enrollment enrollment.is_active = True enrollment.save() - expected = '{username}&{course_id}={mode}'.format( + expected = '{username}&{course_id}={mode}'.format( # noqa: UP032 username=self.user.username, course_id=str(course_id).lower(), mode=enrollment_mode.lower() ) expected = hashlib.md5(expected.encode('utf-8')).hexdigest() @@ -124,22 +131,22 @@ def test_save_deletes_cached_enrollment_status_hash(self): def test_users_enrolled_in_active_only(self): """CourseEnrollment.users_enrolled_in should return only Users with active enrollments when `include_inactive` has its default value (False).""" - CourseEnrollmentFactory.create(user=self.user, course_id=self.course.id, is_active=True) # lint-amnesty, pylint: disable=no-member - CourseEnrollmentFactory.create(user=self.user_2, course_id=self.course.id, is_active=False) # lint-amnesty, pylint: disable=no-member + CourseEnrollmentFactory.create(user=self.user, course_id=self.course.id, is_active=True) # pylint: disable=no-member + CourseEnrollmentFactory.create(user=self.user_2, course_id=self.course.id, is_active=False) # pylint: disable=no-member - active_enrolled_users = list(CourseEnrollment.objects.users_enrolled_in(self.course.id)) # lint-amnesty, pylint: disable=no-member + active_enrolled_users = list(CourseEnrollment.objects.users_enrolled_in(self.course.id)) # pylint: disable=no-member assert [self.user] == active_enrolled_users def test_users_enrolled_in_all(self): """CourseEnrollment.users_enrolled_in should return active and inactive users when `include_inactive` is True.""" - CourseEnrollmentFactory.create(user=self.user, course_id=self.course.id, is_active=True) # lint-amnesty, pylint: disable=no-member - CourseEnrollmentFactory.create(user=self.user_2, course_id=self.course.id, is_active=False) # lint-amnesty, pylint: disable=no-member + CourseEnrollmentFactory.create(user=self.user, course_id=self.course.id, is_active=True) # pylint: disable=no-member + CourseEnrollmentFactory.create(user=self.user_2, course_id=self.course.id, is_active=False) # pylint: disable=no-member all_enrolled_users = list( - CourseEnrollment.objects.users_enrolled_in(self.course.id, include_inactive=True) # lint-amnesty, pylint: disable=no-member + CourseEnrollment.objects.users_enrolled_in(self.course.id, include_inactive=True) # pylint: disable=no-member ) - self.assertListEqual([self.user, self.user_2], all_enrolled_users) + self.assertListEqual([self.user, self.user_2], all_enrolled_users) # noqa: PT009 @skip_unless_lms def test_upgrade_deadline(self): @@ -182,7 +189,7 @@ def test_upgrade_deadline_with_schedule(self): @ddt.data(*(set(CourseMode.ALL_MODES) - set(CourseMode.AUDIT_MODES))) def test_upgrade_deadline_for_non_upgradeable_enrollment(self, mode): """ The property should return None if an upgrade cannot be upgraded. """ - enrollment = CourseEnrollmentFactory(course_id=self.course.id, mode=mode) # lint-amnesty, pylint: disable=no-member + enrollment = CourseEnrollmentFactory(course_id=self.course.id, mode=mode) # pylint: disable=no-member assert enrollment.upgrade_deadline is None @skip_unless_lms @@ -525,7 +532,7 @@ def test_do_name_change_request(self): Test basic name change request functionality. """ do_name_change_request(self.user, self.new_name, self.rationale) - self.assertEqual(PendingNameChange.objects.count(), 1) + self.assertEqual(PendingNameChange.objects.count(), 1) # noqa: PT009 def test_same_name(self): """ @@ -533,7 +540,7 @@ def test_same_name(self): name will not result in a new pending name change request. """ pending_name_change = do_name_change_request(self.user, self.name, self.rationale)[0] - self.assertIsNone(pending_name_change) + self.assertIsNone(pending_name_change) # noqa: PT009 def test_update_name_change(self): """ @@ -542,9 +549,9 @@ def test_update_name_change(self): """ do_name_change_request(self.user, self.new_name, self.rationale) do_name_change_request(self.user, self.updated_name, self.rationale) - self.assertEqual(PendingNameChange.objects.count(), 1) + self.assertEqual(PendingNameChange.objects.count(), 1) # noqa: PT009 pending_name_change = PendingNameChange.objects.get(user=self.user) - self.assertEqual(pending_name_change.new_name, self.updated_name) + self.assertEqual(pending_name_change.new_name, self.updated_name) # noqa: PT009 def test_confirm_name_change(self): """ @@ -554,8 +561,8 @@ def test_confirm_name_change(self): pending_name_change = do_name_change_request(self.user, self.new_name, self.rationale)[0] confirm_name_change(self.user, pending_name_change) user_profile = UserProfile.objects.get(user=self.user) - self.assertEqual(user_profile.name, self.new_name) - self.assertEqual(PendingNameChange.objects.count(), 0) + self.assertEqual(user_profile.name, self.new_name) # noqa: PT009 + self.assertEqual(PendingNameChange.objects.count(), 0) # noqa: PT009 def test_delete_by_user_removes_pending_name_change(self): do_name_change_request(self.user, self.new_name, self.rationale) @@ -580,7 +587,7 @@ def setUpClass(cls): cls.user = UserFactory() cls.user2 = UserFactory() - def setUp(self): # lint-amnesty, pylint: disable=super-method-not-called + def setUp(self): # pylint: disable=super-method-not-called self.email_change, _ = PendingEmailChange.objects.get_or_create( user=self.user, new_email='new@example.com', @@ -597,8 +604,24 @@ def test_delete_by_user_no_effect_for_user_with_no_email_change(self): assert not record_was_deleted assert 1 == len(PendingEmailChange.objects.all()) + def test_delete_by_user_value_redacts_pending_email_before_deletion(self): + """ + Verify that delete_by_user_value redacts new_email before deletion. + """ + table = PendingEmailChange._meta.db_table + with CaptureQueriesContext(connection) as ctx: + record_was_deleted = PendingEmailChange.delete_by_user_value(self.user, field='user') + + assert_redact_before_delete( + [q['sql'] for q in ctx], + table=table, + expected_redacted_value_list=['redacted-before-delete@safe.com'], + ) + assert record_was_deleted + assert not PendingEmailChange.objects.filter(user=self.user).exists() + -class TestCourseEnrollmentAllowed(ModuleStoreTestCase): # lint-amnesty, pylint: disable=missing-class-docstring +class TestCourseEnrollmentAllowed(ModuleStoreTestCase): # pylint: disable=missing-class-docstring def setUp(self): super().setUp() @@ -612,11 +635,18 @@ def setUp(self): ) def test_retiring_user_deletes_record(self): - is_successful = CourseEnrollmentAllowed.delete_by_user_value( - value=self.email, - field='email' - ) + with CaptureQueriesContext(connection) as ctx: + is_successful = CourseEnrollmentAllowed.delete_by_user_value( + value=self.email, + field='email' + ) + assert is_successful + assert_redact_before_delete( + [q['sql'] for q in ctx], + table=CourseEnrollmentAllowed._meta.db_table, + expected_redacted_value_list=['redacted-before-delete@safe.com'], + ) user_search_results = CourseEnrollmentAllowed.objects.filter( email=self.email ) @@ -697,8 +727,8 @@ def test_retirement(self): the enrolled_email and reason columns of each row associated with that enrollment. """ - enrollment = CourseEnrollment.enroll(self.user, self.course.id) # lint-amnesty, pylint: disable=no-member - other_enrollment = CourseEnrollment.enroll(self.user, self.other_course.id) # lint-amnesty, pylint: disable=no-member + enrollment = CourseEnrollment.enroll(self.user, self.course.id) # pylint: disable=no-member + other_enrollment = CourseEnrollment.enroll(self.user, self.other_course.id) # pylint: disable=no-member ManualEnrollmentAudit.create_manual_enrollment_audit( self.instructor, self.user.email, ALLOWEDTOENROLL_TO_ENROLLED, 'manually enrolling unenrolled user', enrollment @@ -730,19 +760,66 @@ class TestAccountRecovery(TestCase): def test_retire_recovery_email(self): """ - Assert that Account Record for a given user is deleted when `retire_recovery_email` is called + Assert that AccountRecovery secondary_email is redacted before the record is deleted. """ - # Create user and associated recovery email record user = UserFactory() - AccountRecoveryFactory(user=user) + AccountRecoveryFactory(user=user, secondary_email='recovery@example.com') assert len(AccountRecovery.objects.filter(user_id=user.id)) == 1 - # Retire recovery email - AccountRecovery.retire_recovery_email(user_id=user.id) + with CaptureQueriesContext(connection) as ctx: + AccountRecovery.retire_recovery_email(user_id=user.id) + + assert_redact_before_delete( + [q['sql'] for q in ctx], + table=AccountRecovery._meta.db_table, + expected_redacted_value_list=[f'redact-before-delete+{user.id}@redacted.com'], + ) - # Assert that there is no longer an AccountRecovery record for this user assert len(AccountRecovery.objects.filter(user_id=user.id)) == 0 + def test_retire_recovery_email_when_no_record(self): + """ + Assert retirement cleanup returns False when no account recovery row exists. + """ + user = UserFactory() + assert AccountRecovery.retire_recovery_email(user_id=user.id) is False + + +class TestPendingSecondaryEmailChange(TestCase): + """ + Tests for retiring PendingSecondaryEmailChange records. + """ + + def test_redact_and_delete_pending_secondary_email(self): + """ + Assert that the pending secondary email is redacted before the record is deleted. + """ + user = UserFactory() + PendingSecondaryEmailChange.objects.create( + user=user, + new_secondary_email='new-secondary@example.com', + activation_key='a' * 32, + ) + assert len(PendingSecondaryEmailChange.objects.filter(user_id=user.id)) == 1 + + with CaptureQueriesContext(connection) as ctx: + PendingSecondaryEmailChange.redact_and_delete_pending_secondary_email(user_id=user.id) + + assert_redact_before_delete( + [query['sql'] for query in ctx], + table=PendingSecondaryEmailChange._meta.db_table, + expected_redacted_value_list=[PENDING_SECONDARY_EMAIL_REDACTED_VALUE], + ) + + assert len(PendingSecondaryEmailChange.objects.filter(user_id=user.id)) == 0 + + def test_redact_and_delete_pending_secondary_email_when_no_record(self): + """ + Assert retirement cleanup returns False when no pending secondary row exists. + """ + user = UserFactory() + assert PendingSecondaryEmailChange.redact_and_delete_pending_secondary_email(user_id=user.id) is False + @ddt.ddt class TestUserPostSaveCallback(SharedModuleStoreTestCase): diff --git a/common/djangoapps/student/tests/test_password_policy.py b/common/djangoapps/student/tests/test_password_policy.py index fb84c049de04..b52cef373cc1 100644 --- a/common/djangoapps/student/tests/test_password_policy.py +++ b/common/djangoapps/student/tests/test_password_policy.py @@ -4,10 +4,12 @@ import json + from django.test import TestCase from django.test.client import RequestFactory from django.test.utils import override_settings from django.urls import reverse + from common.djangoapps.util.password_policy_validators import create_validator_config @@ -33,7 +35,7 @@ def setUp(self): } @override_settings(AUTH_PASSWORD_VALIDATORS=[ - create_validator_config('common.djangoapps.util.password_policy_validators.MinimumLengthValidator', {'min_length': 6}) # lint-amnesty, pylint: disable=line-too-long + create_validator_config('common.djangoapps.util.password_policy_validators.MinimumLengthValidator', {'min_length': 6}) # pylint: disable=line-too-long ]) def test_password_length_too_short(self): self.url_params['password'] = 'aaa' @@ -44,7 +46,7 @@ def test_password_length_too_short(self): 'This password is too short. It must contain at least 6 characters.' @override_settings(AUTH_PASSWORD_VALIDATORS=[ - create_validator_config('common.djangoapps.util.password_policy_validators.MinimumLengthValidator', {'min_length': 6}) # lint-amnesty, pylint: disable=line-too-long + create_validator_config('common.djangoapps.util.password_policy_validators.MinimumLengthValidator', {'min_length': 6}) # pylint: disable=line-too-long ]) def test_password_length_long_enough(self): self.url_params['password'] = 'ThisIsALongerPassword' @@ -54,7 +56,7 @@ def test_password_length_long_enough(self): assert obj['success'] @override_settings(AUTH_PASSWORD_VALIDATORS=[ - create_validator_config('common.djangoapps.util.password_policy_validators.MaximumLengthValidator', {'max_length': 12}) # lint-amnesty, pylint: disable=line-too-long + create_validator_config('common.djangoapps.util.password_policy_validators.MaximumLengthValidator', {'max_length': 12}) # pylint: disable=line-too-long ]) def test_password_length_too_long(self): self.url_params['password'] = 'ThisPasswordIsWayTooLong' @@ -65,7 +67,7 @@ def test_password_length_too_long(self): 'This password is too long. It must contain no more than 12 characters.' @override_settings(AUTH_PASSWORD_VALIDATORS=[ - create_validator_config('common.djangoapps.util.password_policy_validators.UppercaseValidator', {'min_upper': 3}) # lint-amnesty, pylint: disable=line-too-long + create_validator_config('common.djangoapps.util.password_policy_validators.UppercaseValidator', {'min_upper': 3}) # pylint: disable=line-too-long ]) def test_password_not_enough_uppercase(self): self.url_params['password'] = 'thisshouldfail' @@ -75,7 +77,7 @@ def test_password_not_enough_uppercase(self): assert obj['password'][0]['user_message'] == 'This password must contain at least 3 uppercase letters.' @override_settings(AUTH_PASSWORD_VALIDATORS=[ - create_validator_config('common.djangoapps.util.password_policy_validators.UppercaseValidator', {'min_upper': 3}) # lint-amnesty, pylint: disable=line-too-long + create_validator_config('common.djangoapps.util.password_policy_validators.UppercaseValidator', {'min_upper': 3}) # pylint: disable=line-too-long ]) def test_password_enough_uppercase(self): self.url_params['password'] = 'ThisShouldPass' @@ -85,7 +87,7 @@ def test_password_enough_uppercase(self): assert obj['success'] @override_settings(AUTH_PASSWORD_VALIDATORS=[ - create_validator_config('common.djangoapps.util.password_policy_validators.LowercaseValidator', {'min_lower': 3}) # lint-amnesty, pylint: disable=line-too-long + create_validator_config('common.djangoapps.util.password_policy_validators.LowercaseValidator', {'min_lower': 3}) # pylint: disable=line-too-long ]) def test_password_not_enough_lowercase(self): self.url_params['password'] = 'THISSHOULDFAIL' @@ -95,7 +97,7 @@ def test_password_not_enough_lowercase(self): assert obj['password'][0]['user_message'] == 'This password must contain at least 3 lowercase letters.' @override_settings(AUTH_PASSWORD_VALIDATORS=[ - create_validator_config('common.djangoapps.util.password_policy_validators.LowercaseValidator', {'min_lower': 3}) # lint-amnesty, pylint: disable=line-too-long + create_validator_config('common.djangoapps.util.password_policy_validators.LowercaseValidator', {'min_lower': 3}) # pylint: disable=line-too-long ]) def test_password_enough_lowercase(self): self.url_params['password'] = 'ThisShouldPass' @@ -105,7 +107,7 @@ def test_password_enough_lowercase(self): assert obj['success'] @override_settings(AUTH_PASSWORD_VALIDATORS=[ - create_validator_config('common.djangoapps.util.password_policy_validators.PunctuationValidator', {'min_punctuation': 3}) # lint-amnesty, pylint: disable=line-too-long + create_validator_config('common.djangoapps.util.password_policy_validators.PunctuationValidator', {'min_punctuation': 3}) # pylint: disable=line-too-long ]) def test_not_enough_punctuations(self): self.url_params['password'] = 'thisshouldfail' @@ -115,7 +117,7 @@ def test_not_enough_punctuations(self): assert obj['password'][0]['user_message'] == 'This password must contain at least 3 punctuation marks.' @override_settings(AUTH_PASSWORD_VALIDATORS=[ - create_validator_config('common.djangoapps.util.password_policy_validators.PunctuationValidator', {'min_punctuation': 3}) # lint-amnesty, pylint: disable=line-too-long + create_validator_config('common.djangoapps.util.password_policy_validators.PunctuationValidator', {'min_punctuation': 3}) # pylint: disable=line-too-long ]) def test_enough_punctuations(self): self.url_params['password'] = 'Th!sSh.uldPa$*' @@ -125,7 +127,7 @@ def test_enough_punctuations(self): assert obj['success'] @override_settings(AUTH_PASSWORD_VALIDATORS=[ - create_validator_config('common.djangoapps.util.password_policy_validators.NumericValidator', {'min_numeric': 3}) # lint-amnesty, pylint: disable=line-too-long + create_validator_config('common.djangoapps.util.password_policy_validators.NumericValidator', {'min_numeric': 3}) # pylint: disable=line-too-long ]) def test_not_enough_numeric_characters(self): # The unicode ២ is the number 2 in Khmer and the ٧ is the Arabic-Indic number 7 @@ -136,7 +138,7 @@ def test_not_enough_numeric_characters(self): assert obj['password'][0]['user_message'] == 'This password must contain at least 3 numbers.' @override_settings(AUTH_PASSWORD_VALIDATORS=[ - create_validator_config('common.djangoapps.util.password_policy_validators.NumericValidator', {'min_numeric': 3}) # lint-amnesty, pylint: disable=line-too-long + create_validator_config('common.djangoapps.util.password_policy_validators.NumericValidator', {'min_numeric': 3}) # pylint: disable=line-too-long ]) def test_enough_numeric_characters(self): # The unicode ២ is the number 2 in Khmer @@ -147,7 +149,7 @@ def test_enough_numeric_characters(self): assert obj['success'] @override_settings(AUTH_PASSWORD_VALIDATORS=[ - create_validator_config('common.djangoapps.util.password_policy_validators.AlphabeticValidator', {'min_alphabetic': 3}) # lint-amnesty, pylint: disable=line-too-long + create_validator_config('common.djangoapps.util.password_policy_validators.AlphabeticValidator', {'min_alphabetic': 3}) # pylint: disable=line-too-long ]) def test_not_enough_alphabetic_characters(self): self.url_params['password'] = '123456ab' @@ -157,7 +159,7 @@ def test_not_enough_alphabetic_characters(self): assert obj['password'][0]['user_message'] == 'This password must contain at least 3 letters.' @override_settings(AUTH_PASSWORD_VALIDATORS=[ - create_validator_config('common.djangoapps.util.password_policy_validators.AlphabeticValidator', {'min_alphabetic': 3}) # lint-amnesty, pylint: disable=line-too-long + create_validator_config('common.djangoapps.util.password_policy_validators.AlphabeticValidator', {'min_alphabetic': 3}) # pylint: disable=line-too-long ]) def test_enough_alphabetic_characters(self): self.url_params['password'] = '𝒯𝓗Ï𝓼𝒫å𝓼𝓼𝔼𝓼' @@ -167,10 +169,10 @@ def test_enough_alphabetic_characters(self): assert obj['success'] @override_settings(AUTH_PASSWORD_VALIDATORS=[ - create_validator_config('common.djangoapps.util.password_policy_validators.MinimumLengthValidator', {'min_length': 3}), # lint-amnesty, pylint: disable=line-too-long - create_validator_config('common.djangoapps.util.password_policy_validators.UppercaseValidator', {'min_upper': 3}), # lint-amnesty, pylint: disable=line-too-long - create_validator_config('common.djangoapps.util.password_policy_validators.NumericValidator', {'min_numeric': 3}), # lint-amnesty, pylint: disable=line-too-long - create_validator_config('common.djangoapps.util.password_policy_validators.PunctuationValidator', {'min_punctuation': 3}), # lint-amnesty, pylint: disable=line-too-long + create_validator_config('common.djangoapps.util.password_policy_validators.MinimumLengthValidator', {'min_length': 3}), # pylint: disable=line-too-long + create_validator_config('common.djangoapps.util.password_policy_validators.UppercaseValidator', {'min_upper': 3}), # pylint: disable=line-too-long + create_validator_config('common.djangoapps.util.password_policy_validators.NumericValidator', {'min_numeric': 3}), # pylint: disable=line-too-long + create_validator_config('common.djangoapps.util.password_policy_validators.PunctuationValidator', {'min_punctuation': 3}), # pylint: disable=line-too-long ]) def test_multiple_errors_fail(self): self.url_params['password'] = 'thisshouldfail' @@ -186,11 +188,11 @@ def test_multiple_errors_fail(self): assert obj['password'][i]['user_message'] == error_strings[i] @override_settings(AUTH_PASSWORD_VALIDATORS=[ - create_validator_config('common.djangoapps.util.password_policy_validators.MinimumLengthValidator', {'min_length': 3}), # lint-amnesty, pylint: disable=line-too-long - create_validator_config('common.djangoapps.util.password_policy_validators.UppercaseValidator', {'min_upper': 3}), # lint-amnesty, pylint: disable=line-too-long - create_validator_config('common.djangoapps.util.password_policy_validators.LowercaseValidator', {'min_lower': 3}), # lint-amnesty, pylint: disable=line-too-long - create_validator_config('common.djangoapps.util.password_policy_validators.NumericValidator', {'min_numeric': 3}), # lint-amnesty, pylint: disable=line-too-long - create_validator_config('common.djangoapps.util.password_policy_validators.PunctuationValidator', {'min_punctuation': 3}), # lint-amnesty, pylint: disable=line-too-long + create_validator_config('common.djangoapps.util.password_policy_validators.MinimumLengthValidator', {'min_length': 3}), # pylint: disable=line-too-long + create_validator_config('common.djangoapps.util.password_policy_validators.UppercaseValidator', {'min_upper': 3}), # pylint: disable=line-too-long + create_validator_config('common.djangoapps.util.password_policy_validators.LowercaseValidator', {'min_lower': 3}), # pylint: disable=line-too-long + create_validator_config('common.djangoapps.util.password_policy_validators.NumericValidator', {'min_numeric': 3}), # pylint: disable=line-too-long + create_validator_config('common.djangoapps.util.password_policy_validators.PunctuationValidator', {'min_punctuation': 3}), # pylint: disable=line-too-long ]) def test_multiple_errors_pass(self): self.url_params['password'] = 'tH1s Sh0u!d P3#$!' @@ -220,8 +222,8 @@ def test_common_password_pass(self): assert obj['success'] @override_settings(AUTH_PASSWORD_VALIDATORS=[ - create_validator_config('common.djangoapps.util.password_policy_validators.MinimumLengthValidator', {'min_length': 6}), # lint-amnesty, pylint: disable=line-too-long - create_validator_config('common.djangoapps.util.password_policy_validators.MaximumLengthValidator', {'max_length': 75}), # lint-amnesty, pylint: disable=line-too-long + create_validator_config('common.djangoapps.util.password_policy_validators.MinimumLengthValidator', {'min_length': 6}), # pylint: disable=line-too-long + create_validator_config('common.djangoapps.util.password_policy_validators.MaximumLengthValidator', {'max_length': 75}), # pylint: disable=line-too-long ]) def test_with_unicode(self): self.url_params['password'] = '四節比分和七年前' diff --git a/common/djangoapps/student/tests/test_receivers.py b/common/djangoapps/student/tests/test_receivers.py index 424df4759d3e..4dacc2f1b9c5 100644 --- a/common/djangoapps/student/tests/test_receivers.py +++ b/common/djangoapps/student/tests/test_receivers.py @@ -9,9 +9,11 @@ from common.djangoapps.student.signals.signals import USER_EMAIL_CHANGED from common.djangoapps.student.tests.factories import CourseEnrollmentFactory, UserFactory, UserProfileFactory from lms.djangoapps.courseware.toggles import COURSEWARE_MICROFRONTEND_PROGRESS_MILESTONES -from openedx.core.djangolib.testing.utils import skip_unless_lms, get_mock_request +from openedx.core.djangolib.testing.utils import get_mock_request, skip_unless_lms from openedx.features.name_affirmation_api.utils import is_name_affirmation_installed -from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + SharedModuleStoreTestCase, # pylint: disable=wrong-import-order +) name_affirmation_installed = is_name_affirmation_installed() if name_affirmation_installed: diff --git a/common/djangoapps/student/tests/test_recent_enrollments.py b/common/djangoapps/student/tests/test_recent_enrollments.py index 327bf6b46e89..8993a9c50f28 100644 --- a/common/djangoapps/student/tests/test_recent_enrollments.py +++ b/common/djangoapps/student/tests/test_recent_enrollments.py @@ -10,14 +10,16 @@ from django.utils.timezone import now from opaque_keys.edx import locator -from common.test.utils import XssTestMixin from common.djangoapps.student.models import CourseEnrollment, DashboardConfiguration from common.djangoapps.student.tests.factories import UserFactory from common.djangoapps.student.views import get_course_enrollments from common.djangoapps.student.views.dashboard import _get_recently_enrolled_courses +from common.test.utils import XssTestMixin from openedx.core.djangolib.testing.utils import skip_unless_lms -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + ModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order @skip_unless_lms @@ -97,7 +99,7 @@ def test_enrollments_sorted_most_recent(self): # Create a number of new enrollments and courses, and force their creation behind # the first enrollment courses = [] - for idx, seconds_past in zip(list(range(2, 6)), [5, 10, 15, 20]): + for idx, seconds_past in zip(list(range(2, 6)), [5, 10, 15, 20]): # noqa: B905 course_location = locator.CourseLocator( f'Org{idx}', f'Course{idx}', @@ -151,7 +153,7 @@ def test_dashboard_rendering_with_two_courses(self): 'Course2', 'Run2' ) - course, _ = self._create_course_and_enrollment(course_location) # lint-amnesty, pylint: disable=unused-variable + course, _ = self._create_course_and_enrollment(course_location) # pylint: disable=unused-variable self.client.login(username=self.student.username, password=self.PASSWORD) response = self.client.get(reverse("dashboard")) diff --git a/common/djangoapps/student/tests/test_refunds.py b/common/djangoapps/student/tests/test_refunds.py index 60979d8e80d5..2b1bf8c8ab4c 100644 --- a/common/djangoapps/student/tests/test_refunds.py +++ b/common/djangoapps/student/tests/test_refunds.py @@ -10,6 +10,7 @@ import ddt import httpretty + # Explicitly import the cache from ConfigurationModel so we can reset it after each test from config_models.models import cache from django.test.client import Client @@ -26,8 +27,10 @@ from lms.djangoapps.certificates.tests.factories import GeneratedCertificateFactory from openedx.core.djangoapps.commerce.utils import ECOMMERCE_DATE_FORMAT from openedx.core.djangolib.testing.utils import skip_unless_lms -from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + SharedModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order log = logging.getLogger(__name__) TEST_API_URL = 'http://www-internal.example.com/api' @@ -292,7 +295,7 @@ def test_multiple_refunds_dashbaord_page_error(self): ) # creating multiple attributes for same order. - for attribute_count in range(2): # pylint: disable=unused-variable + for attribute_count in range(2): # pylint: disable=unused-variable # noqa: B007 self.enrollment.attributes.create( enrollment=self.enrollment, namespace='order', diff --git a/common/djangoapps/student/tests/test_retirement.py b/common/djangoapps/student/tests/test_retirement.py index ffeb1af14fa2..08d6d9ded337 100644 --- a/common/djangoapps/student/tests/test_retirement.py +++ b/common/djangoapps/student/tests/test_retirement.py @@ -9,11 +9,10 @@ import pytest from django.apps import apps from django.conf import settings -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.test import TestCase from django.urls import reverse -from openedx.core.djangolib.testing.utils import skip_unless_lms from common.djangoapps.student.models import ( get_all_retired_usernames_by_username, get_potentially_retired_user_by_username, @@ -21,9 +20,10 @@ get_retired_email_by_email, get_retired_username_by_username, is_email_retired, - is_username_retired + is_username_retired, ) from common.djangoapps.student.tests.factories import UserFactory +from openedx.core.djangolib.testing.utils import skip_unless_lms # Tell pytest it's ok to user the Django db pytestmark = pytest.mark.django_db @@ -60,7 +60,7 @@ def retirement_status(retirement_user): # pylint: disable=redefined-outer-name @pytest.fixture -def two_users_same_username_different_case(retirement_status): # lint-amnesty, pylint: disable=missing-function-docstring, redefined-outer-name, unused-argument +def two_users_same_username_different_case(retirement_status): # pylint: disable=missing-function-docstring, redefined-outer-name, unused-argument user1 = UserFactory.create(username='TestUser') user2 = UserFactory.create(username='testuser') UserRetirementStatus = apps.get_model('user_api', 'UserRetirementStatus') @@ -87,7 +87,7 @@ def check_email_against_fmt(hashed_email): assert hashed_email.endswith(settings.RETIRED_EMAIL_DOMAIN) -def test_get_retired_username(retirement_user): # lint-amnesty, pylint: disable=redefined-outer-name +def test_get_retired_username(retirement_user): # pylint: disable=redefined-outer-name """ Basic testing of getting retired usernames. The hasher is opaque to us, we just care that it's succeeding and using our format. @@ -106,7 +106,7 @@ def test_get_retired_username_status_exists(retirement_user, retirement_status): assert retirement_status.retired_username == hashed_username -def test_get_all_retired_usernames_by_username(retirement_user): # lint-amnesty, pylint: disable=redefined-outer-name +def test_get_all_retired_usernames_by_username(retirement_user): # pylint: disable=redefined-outer-name """ Check that all salts are used for this method and return expected formats. @@ -121,7 +121,7 @@ def test_get_all_retired_usernames_by_username(retirement_user): # lint-amnesty assert len(hashed_usernames) == len(set(hashed_usernames)) -def test_is_username_retired_is_retired(retirement_user): # lint-amnesty, pylint: disable=redefined-outer-name +def test_is_username_retired_is_retired(retirement_user): # pylint: disable=redefined-outer-name """ Check functionality of is_username_retired when username is retired """ @@ -135,14 +135,14 @@ def test_is_username_retired_is_retired(retirement_user): # lint-amnesty, pylin assert is_username_retired(original_username) -def test_is_username_retired_not_retired(retirement_user): # lint-amnesty, pylint: disable=redefined-outer-name +def test_is_username_retired_not_retired(retirement_user): # pylint: disable=redefined-outer-name """ Check functionality of is_username_retired when username is not retired """ assert not is_username_retired(retirement_user.username) -def test_is_email_retired_is_retired(retirement_user): # lint-amnesty, pylint: disable=redefined-outer-name +def test_is_email_retired_is_retired(retirement_user): # pylint: disable=redefined-outer-name """ Check functionality of is_email_retired when email is retired """ @@ -156,14 +156,14 @@ def test_is_email_retired_is_retired(retirement_user): # lint-amnesty, pylint: assert is_email_retired(original_email) -def test_is_email_retired_not_retired(retirement_user): # lint-amnesty, pylint: disable=redefined-outer-name +def test_is_email_retired_not_retired(retirement_user): # pylint: disable=redefined-outer-name """ Check functionality of is_email_retired when email is not retired """ assert not is_email_retired(retirement_user.email) -def test_get_retired_email(retirement_user): # lint-amnesty, pylint: disable=redefined-outer-name +def test_get_retired_email(retirement_user): # pylint: disable=redefined-outer-name """ Basic testing of retired emails. """ @@ -181,27 +181,27 @@ def test_get_retired_email_status_exists(retirement_user, retirement_status): # assert retirement_status.retired_email == hashed_email -def test_get_correct_user_varying_by_case_only(two_users_same_username_different_case): # lint-amnesty, pylint: disable=redefined-outer-name +def test_get_correct_user_varying_by_case_only(two_users_same_username_different_case): # pylint: disable=redefined-outer-name """ Check that two users - one retired, one active - with the same username except for case can be found. """ - retired_status, retired_user, active_user = two_users_same_username_different_case # lint-amnesty, pylint: disable=unused-variable + retired_status, retired_user, active_user = two_users_same_username_different_case # pylint: disable=unused-variable first_user = get_potentially_retired_user_by_username(retired_status.original_username) second_user = get_potentially_retired_user_by_username(active_user.username) assert first_user.username != second_user.username assert second_user.username == active_user.username -def test_get_potentially_retired_user_username_match(retirement_user): # lint-amnesty, pylint: disable=redefined-outer-name +def test_get_potentially_retired_user_username_match(retirement_user): # pylint: disable=redefined-outer-name """ Check that we can pass in an un-retired username and get the user-to-be-retired back. """ hashed_username = get_retired_username_by_username(retirement_user.username) - assert get_potentially_retired_user_by_username_and_hash(retirement_user.username, hashed_username) == retirement_user # lint-amnesty, pylint: disable=line-too-long + assert get_potentially_retired_user_by_username_and_hash(retirement_user.username, hashed_username) == retirement_user # pylint: disable=line-too-long -def test_get_potentially_retired_user_hashed_match(retirement_user): # lint-amnesty, pylint: disable=redefined-outer-name +def test_get_potentially_retired_user_hashed_match(retirement_user): # pylint: disable=redefined-outer-name """ Check that we can pass in a hashed username and get the user-to-be-retired back. @@ -238,7 +238,7 @@ def test_get_potentially_retired_user_bad_hash(): """ fake_username = "fake username" - with pytest.raises(Exception): + with pytest.raises(Exception): # noqa: B017, PT011 get_potentially_retired_user_by_username_and_hash(fake_username, "bad hash") diff --git a/common/djangoapps/student/tests/test_roles.py b/common/djangoapps/student/tests/test_roles.py index 92dcf1957626..312676de1c92 100644 --- a/common/djangoapps/student/tests/test_roles.py +++ b/common/djangoapps/student/tests/test_roles.py @@ -2,38 +2,48 @@ Tests of student.roles """ +from unittest.mock import patch import ddt from django.contrib.auth.models import Permission from django.test import TestCase +from edx_toggles.toggles.testutils import override_waffle_flag from opaque_keys.edx.keys import CourseKey from opaque_keys.edx.locator import LibraryLocator +from openedx_authz.api.data import ContentLibraryData, CourseOverviewData, RoleAssignmentData, RoleData, UserData +from openedx_authz.constants.roles import COURSE_ADMIN, COURSE_STAFF +from openedx_authz.engine.enforcer import AuthzEnforcer from common.djangoapps.student.admin import CourseAccessRoleHistoryAdmin from common.djangoapps.student.models import CourseAccessRoleHistory, User +from common.djangoapps.student.role_helpers import get_course_roles, has_staff_roles from common.djangoapps.student.roles import ( + ROLE_CACHE_UNGROUPED_ROLES__KEY, + AuthzCompatCourseAccessRole, CourseAccessRole, CourseBetaTesterRole, + CourseDataResearcherRole, + CourseFinanceAdminRole, CourseInstructorRole, - CourseRole, CourseLimitedStaffRole, - CourseStaffRole, - CourseFinanceAdminRole, + CourseRole, CourseSalesAdminRole, - LibraryUserRole, - CourseDataResearcherRole, + CourseStaffRole, GlobalStaff, + LibraryUserRole, OrgContentCreatorRole, OrgInstructorRole, OrgStaffRole, RoleCache, + get_authz_compat_course_access_roles_for_user, get_role_cache_key_for_course, - ROLE_CACHE_UNGROUPED_ROLES__KEY ) -from common.djangoapps.student.role_helpers import get_course_roles, has_staff_roles from common.djangoapps.student.tests.factories import AnonymousUserFactory, InstructorFactory, StaffFactory, UserFactory +from openedx.core.djangoapps.content.course_overviews.tests.factories import CourseOverviewFactory +from openedx.core.toggles import AUTHZ_COURSE_AUTHORING_FLAG +@ddt.ddt class RolesTestCase(TestCase): """ Tests of student.roles @@ -41,8 +51,10 @@ class RolesTestCase(TestCase): def setUp(self): super().setUp() + self._seed_database_with_policies() self.course_key = CourseKey.from_string('course-v1:course-v1:edX+toy+2012_Fall') self.course_loc = self.course_key.make_usage_key('course', '2012_Fall') + self.course = CourseOverviewFactory.create(id=self.course_key) self.anonymous_user = AnonymousUserFactory() self.student = UserFactory() self.global_staff = UserFactory(is_staff=True) @@ -50,37 +62,67 @@ def setUp(self): self.course_instructor = InstructorFactory(course_key=self.course_key) self.orgs = ["Marvel", "DC"] - def test_global_staff(self): - assert not GlobalStaff().has_user(self.student) - assert not GlobalStaff().has_user(self.course_staff) - assert not GlobalStaff().has_user(self.course_instructor) - assert GlobalStaff().has_user(self.global_staff) - - def test_has_staff_roles(self): - assert has_staff_roles(self.global_staff, self.course_key) - assert has_staff_roles(self.course_staff, self.course_key) - assert has_staff_roles(self.course_instructor, self.course_key) - assert not has_staff_roles(self.student, self.course_key) - - def test_get_course_roles(self): - assert not list(get_course_roles(self.student)) - assert not list(get_course_roles(self.global_staff)) - assert list(get_course_roles(self.course_staff)) == [ - CourseAccessRole( - user=self.course_staff, - course_id=self.course_key, - org=self.course_key.org, - role=CourseStaffRole.ROLE, - ) - ] - assert list(get_course_roles(self.course_instructor)) == [ - CourseAccessRole( - user=self.course_instructor, - course_id=self.course_key, - org=self.course_key.org, - role=CourseInstructorRole.ROLE, - ) - ] + @classmethod + def _seed_database_with_policies(cls): + """Seed the database with policies from the policy file for openedx_authz tests. + + This simulates the one-time database seeding that would happen + during application deployment, separate from the runtime policy loading. + """ + import casbin + import pkg_resources + from openedx_authz.engine.utils import migrate_policy_between_enforcers + + global_enforcer = AuthzEnforcer.get_enforcer() + global_enforcer.load_policy() + model_path = pkg_resources.resource_filename("openedx_authz.engine", "config/model.conf") + policy_path = pkg_resources.resource_filename("openedx_authz.engine", "config/authz.policy") + + migrate_policy_between_enforcers( + source_enforcer=casbin.Enforcer(model_path, policy_path), + target_enforcer=global_enforcer, + ) + global_enforcer.clear_policy() # Clear to simulate fresh start for each test + + @ddt.data(True, False) + def test_global_staff(self, authz_enabled): + with override_waffle_flag(AUTHZ_COURSE_AUTHORING_FLAG, active=authz_enabled): + assert not GlobalStaff().has_user(self.student) + assert not GlobalStaff().has_user(self.course_staff) + assert not GlobalStaff().has_user(self.course_instructor) + assert GlobalStaff().has_user(self.global_staff) + + @ddt.data(True, False) + def test_has_staff_roles(self, authz_enabled): + with override_waffle_flag(AUTHZ_COURSE_AUTHORING_FLAG, active=authz_enabled): + assert has_staff_roles(self.global_staff, self.course_key) + assert has_staff_roles(self.course_staff, self.course_key) + assert has_staff_roles(self.course_instructor, self.course_key) + assert not has_staff_roles(self.student, self.course_key) + + @ddt.data(True, False) + def test_get_course_roles(self, authz_enabled): + with override_waffle_flag(AUTHZ_COURSE_AUTHORING_FLAG, active=authz_enabled): + assert not list(get_course_roles(self.student)) + assert not list(get_course_roles(self.global_staff)) + assert list(get_course_roles(self.course_staff)) == [ + AuthzCompatCourseAccessRole( + user_id=self.course_staff.id, + username=self.course_staff.username, + course_id=self.course_key, + org=self.course_key.org, + role=CourseStaffRole.ROLE, + ) + ] + assert list(get_course_roles(self.course_instructor)) == [ + AuthzCompatCourseAccessRole( + user_id=self.course_instructor.id, + username=self.course_instructor.username, + course_id=self.course_key, + org=self.course_key.org, + role=CourseInstructorRole.ROLE, + ) + ] def test_group_name_case_sensitive(self): uppercase_course_id = "ORG/COURSE/NAME" @@ -100,20 +142,22 @@ def test_group_name_case_sensitive(self): assert not CourseRole(role, lowercase_course_key).has_user(uppercase_user) assert CourseRole(role, uppercase_course_key).has_user(uppercase_user) - def test_course_role(self): + @ddt.data(True, False) + def test_course_role(self, authz_enabled): """ Test that giving a user a course role enables access appropriately """ - assert not CourseStaffRole(self.course_key).has_user(self.student), \ - f'Student has premature access to {self.course_key}' - CourseStaffRole(self.course_key).add_users(self.student) - assert CourseStaffRole(self.course_key).has_user(self.student), \ - f"Student doesn't have access to {str(self.course_key)}" + with override_waffle_flag(AUTHZ_COURSE_AUTHORING_FLAG, active=authz_enabled): + assert not CourseStaffRole(self.course_key).has_user(self.student), \ + f'Student has premature access to {self.course_key}' + CourseStaffRole(self.course_key).add_users(self.student) + assert CourseStaffRole(self.course_key).has_user(self.student), \ + f"Student doesn't have access to {str(self.course_key)}" - # remove access and confirm - CourseStaffRole(self.course_key).remove_users(self.student) - assert not CourseStaffRole(self.course_key).has_user(self.student), \ - f'Student still has access to {self.course_key}' + # remove access and confirm + CourseStaffRole(self.course_key).remove_users(self.student) + assert not CourseStaffRole(self.course_key).has_user(self.student), \ + f'Student still has access to {self.course_key}' def test_org_role(self): """ @@ -158,26 +202,30 @@ def test_org_and_course_roles(self): assert not CourseInstructorRole(self.course_key).has_user(self.student), \ f"Student doesn't have access to {str(self.course_key)}" - def test_get_user_for_role(self): + @ddt.data(True, False) + def test_get_user_for_role(self, authz_enabled): """ test users_for_role """ - role = CourseStaffRole(self.course_key) - role.add_users(self.student) - assert len(role.users_with_role()) > 0 + with override_waffle_flag(AUTHZ_COURSE_AUTHORING_FLAG, active=authz_enabled): + role = CourseStaffRole(self.course_key) + role.add_users(self.student) + assert len(role.users_with_role()) > 0 - def test_add_users_doesnt_add_duplicate_entry(self): + @ddt.data(True, False) + def test_add_users_doesnt_add_duplicate_entry(self, authz_enabled): """ Tests that calling add_users multiple times before a single call to remove_users does not result in the user remaining in the group. """ - role = CourseStaffRole(self.course_key) - role.add_users(self.student) - assert role.has_user(self.student) - # Call add_users a second time, then remove just once. - role.add_users(self.student) - role.remove_users(self.student) - assert not role.has_user(self.student) + with override_waffle_flag(AUTHZ_COURSE_AUTHORING_FLAG, active=authz_enabled): + role = CourseStaffRole(self.course_key) + role.add_users(self.student) + assert role.has_user(self.student) + # Call add_users a second time, then remove just once. + role.add_users(self.student) + role.remove_users(self.student) + assert not role.has_user(self.student) def test_get_orgs_for_user(self): """ @@ -191,9 +239,68 @@ def test_get_orgs_for_user(self): role_second_org.add_users(self.student) assert len(role.get_orgs_for_user(self.student)) == 2 + @override_waffle_flag(AUTHZ_COURSE_AUTHORING_FLAG, active=True) + def test_get_orgs_for_user_authz(self): + """ + Test get_orgs_for_user using AuthZ compatibility layer + """ + role = CourseStaffRole(self.course_key) + + other_org = "MIT" + other_course_key = CourseKey.from_string(f"course-v1:{other_org}+Javascript+2026_T1") + another_course_key = CourseKey.from_string(f"course-v1:{other_org}+Python+2026_T1") + + staff_authz_role = RoleData(external_key=COURSE_STAFF) + instructor_authz_role = RoleData(external_key=COURSE_ADMIN) + + assignments = [ + RoleAssignmentData( + subject=UserData(external_key=self.student.username), + roles=[staff_authz_role], + scope=CourseOverviewData(external_key=str(self.course_key)), + ), + RoleAssignmentData( + subject=UserData(external_key=self.student.username), + roles=[staff_authz_role], + scope=CourseOverviewData(external_key=str(other_course_key)), + ), + RoleAssignmentData( + subject=UserData(external_key=self.student.username), + roles=[staff_authz_role], + scope=CourseOverviewData(external_key=str(another_course_key)), + ), + # Non-matching role should be ignored + RoleAssignmentData( + subject=UserData(external_key=self.student.username), + roles=[instructor_authz_role], + scope=CourseOverviewData(external_key=str(self.course_key)), + ), + ] + + with patch("openedx_authz.api.users.get_user_role_assignments_filtered", return_value=assignments): + result = role.get_orgs_for_user(self.student) + self.assertCountEqual(result, [self.course_key.org, other_org]) # noqa: PT009 + + def test_get_authz_compat_course_access_roles_for_user(self): + """ + Test that get_authz_compat_course_access_roles_for_user doesn't crash when the user + has Libraries V2 or other non-course roles in their assignments. + """ + lib_assignment = RoleAssignmentData( + subject=UserData(external_key=self.student.username), + roles=[RoleData(external_key='test-role')], + scope=ContentLibraryData(external_key='lib:edX:test-lib'), + ) + with patch( + 'openedx_authz.api.users.get_subject_role_assignments', + return_value=[lib_assignment], + ): + result = get_authz_compat_course_access_roles_for_user(self.student) + assert result == set() + @ddt.ddt -class RoleCacheTestCase(TestCase): # lint-amnesty, pylint: disable=missing-class-docstring +class RoleCacheTestCase(TestCase): # pylint: disable=missing-class-docstring IN_KEY_STRING = 'course-v1:edX+toy+2012_Fall' IN_KEY = CourseKey.from_string(IN_KEY_STRING) @@ -237,7 +344,7 @@ def test_only_in_role(self, role, target): @ddt.data(*ROLES) @ddt.unpack - def test_empty_cache(self, role, target): # lint-amnesty, pylint: disable=unused-argument + def test_empty_cache(self, role, target): # pylint: disable=unused-argument cache = RoleCache(self.user) assert not cache.has_role(*target) @@ -352,13 +459,13 @@ def test_create_logs_history(self): ) history = CourseAccessRoleHistory.objects.first() - self.assertIsNotNone(history) - self.assertEqual(history.user, self.user) - self.assertEqual(history.org, self.org) - self.assertEqual(history.course_id, self.course_key) - self.assertEqual(history.role, "student") - self.assertEqual(history.action_type, "created") - self.assertIsNone(history.old_values) + self.assertIsNotNone(history) # noqa: PT009 + self.assertEqual(history.user, self.user) # noqa: PT009 + self.assertEqual(history.org, self.org) # noqa: PT009 + self.assertEqual(history.course_id, self.course_key) # noqa: PT009 + self.assertEqual(history.role, "student") # noqa: PT009 + self.assertEqual(history.action_type, "created") # noqa: PT009 + self.assertIsNone(history.old_values) # noqa: PT009 def test_update_logs_history(self): """ @@ -373,13 +480,13 @@ def test_update_logs_history(self): history_entries = CourseAccessRoleHistory.objects.filter( user=self.user, course_id=self.course_key ).order_by("created") - self.assertEqual(history_entries.count(), 2) + self.assertEqual(history_entries.count(), 2) # noqa: PT009 update_history = history_entries.last() - self.assertEqual(update_history.action_type, "updated") - self.assertIsNotNone(update_history.old_values) - self.assertEqual(update_history.old_values["role"], "student") - self.assertEqual(update_history.role, "staff") + self.assertEqual(update_history.action_type, "updated") # noqa: PT009 + self.assertIsNotNone(update_history.old_values) # noqa: PT009 + self.assertEqual(update_history.old_values["role"], "student") # noqa: PT009 + self.assertEqual(update_history.role, "staff") # noqa: PT009 def test_delete_logs_history(self): """ @@ -394,12 +501,12 @@ def test_delete_logs_history(self): history_entries = CourseAccessRoleHistory.objects.filter( user=self.user, course_id=self.course_key ).order_by("created") - self.assertEqual(history_entries.count(), 2) + self.assertEqual(history_entries.count(), 2) # noqa: PT009 delete_history = history_entries.last() - self.assertEqual(delete_history.action_type, "deleted") - self.assertIsNone(delete_history.old_values) - self.assertEqual(delete_history.role, "student") + self.assertEqual(delete_history.action_type, "deleted") # noqa: PT009 + self.assertIsNone(delete_history.old_values) # noqa: PT009 + self.assertEqual(delete_history.role, "student") # noqa: PT009 class CourseAccessRoleAdminActionsTest(TestCase): @@ -458,19 +565,19 @@ def test_revert_created_action(self): CourseAccessRole.objects.create( user=self.user, org=self.org, course_id=self.course_key, role="beta_tester" ) - self.assertEqual(CourseAccessRole.objects.count(), 1) + self.assertEqual(CourseAccessRole.objects.count(), 1) # noqa: PT009 created_history = CourseAccessRoleHistory.objects.filter( action_type="created" ).first() - self.assertIsNotNone(created_history) + self.assertIsNotNone(created_history) # noqa: PT009 self._get_admin_action_response( CourseAccessRoleHistoryAdmin.revert_selected_history, CourseAccessRoleHistory.objects.filter(pk=created_history.pk), ) - self.assertEqual(CourseAccessRole.objects.count(), 0) - self.assertIn( + self.assertEqual(CourseAccessRole.objects.count(), 0) # noqa: PT009 + self.assertIn( # noqa: PT009 f"Successfully reverted creation of role for {self.user.username} in {self.course_key}", self.messages[0], ) @@ -486,20 +593,20 @@ def test_revert_updated_action(self): role_instance.role = "new_role" role_instance.save() - self.assertEqual(CourseAccessRole.objects.get().role, "new_role") + self.assertEqual(CourseAccessRole.objects.get().role, "new_role") # noqa: PT009 updated_history = CourseAccessRoleHistory.objects.filter( action_type="updated" ).first() - self.assertIsNotNone(updated_history) - self.assertEqual(updated_history.old_values["role"], "old_role") + self.assertIsNotNone(updated_history) # noqa: PT009 + self.assertEqual(updated_history.old_values["role"], "old_role") # noqa: PT009 self._get_admin_action_response( CourseAccessRoleHistoryAdmin.revert_selected_history, CourseAccessRoleHistory.objects.filter(pk=updated_history.pk), ) - self.assertEqual(CourseAccessRole.objects.get().role, "old_role") - self.assertIn( + self.assertEqual(CourseAccessRole.objects.get().role, "old_role") # noqa: PT009 + self.assertIn( # noqa: PT009 f"Successfully reverted update of role for {self.user.username} to old_role in {self.course_key}", self.messages[0], ) @@ -514,28 +621,28 @@ def test_revert_deleted_action(self): course_id=self.course_key, role="to_be_deleted", ) - self.assertEqual(CourseAccessRole.objects.count(), 1) - initial_history_count = CourseAccessRoleHistory.objects.count() + self.assertEqual(CourseAccessRole.objects.count(), 1) # noqa: PT009 + initial_history_count = CourseAccessRoleHistory.objects.count() # noqa: F841 role_instance.delete() - self.assertEqual(CourseAccessRole.objects.count(), 0) + self.assertEqual(CourseAccessRole.objects.count(), 0) # noqa: PT009 deleted_history = CourseAccessRoleHistory.objects.filter( action_type="deleted" ).first() - self.assertIsNotNone(deleted_history) + self.assertIsNotNone(deleted_history) # noqa: PT009 self._get_admin_action_response( CourseAccessRoleHistoryAdmin.revert_selected_history, CourseAccessRoleHistory.objects.filter(pk=deleted_history.pk), ) - self.assertEqual(CourseAccessRole.objects.count(), 1) + self.assertEqual(CourseAccessRole.objects.count(), 1) # noqa: PT009 reverted_role = CourseAccessRole.objects.first() - self.assertEqual(reverted_role.user, self.user) - self.assertEqual(reverted_role.org, self.org) - self.assertEqual(reverted_role.course_id, self.course_key) - self.assertEqual(reverted_role.role, "to_be_deleted") - self.assertIn( + self.assertEqual(reverted_role.user, self.user) # noqa: PT009 + self.assertEqual(reverted_role.org, self.org) # noqa: PT009 + self.assertEqual(reverted_role.course_id, self.course_key) # noqa: PT009 + self.assertEqual(reverted_role.role, "to_be_deleted") # noqa: PT009 + self.assertIn( # noqa: PT009 f"Successfully reverted deletion of role for {self.user.username} in {self.course_key}", self.messages[0], ) @@ -547,7 +654,7 @@ def test_delete_history_action(self): CourseAccessRole.objects.create( user=self.user, org=self.org, course_id=self.course_key, role="some_role" ) - self.assertEqual(CourseAccessRoleHistory.objects.count(), 1) + self.assertEqual(CourseAccessRoleHistory.objects.count(), 1) # noqa: PT009 history_entry = CourseAccessRoleHistory.objects.first() self._get_admin_action_response( @@ -555,5 +662,5 @@ def test_delete_history_action(self): CourseAccessRoleHistory.objects.filter(pk=history_entry.pk), ) - self.assertEqual(CourseAccessRoleHistory.objects.count(), 0) - self.assertIn("Successfully deleted 1 selected history entry.", self.messages[0]) + self.assertEqual(CourseAccessRoleHistory.objects.count(), 0) # noqa: PT009 + self.assertIn("Successfully deleted 1 selected history entry.", self.messages[0]) # noqa: PT009 diff --git a/common/djangoapps/student/tests/test_tasks.py b/common/djangoapps/student/tests/test_tasks.py index 0921e4684b89..9cf9d251a9bf 100644 --- a/common/djangoapps/student/tests/test_tasks.py +++ b/common/djangoapps/student/tests/test_tasks.py @@ -1,16 +1,13 @@ """ Celery task tests """ -from unittest.mock import patch, Mock, PropertyMock +from unittest.mock import Mock, PropertyMock, patch import pytest from django.conf import settings from django.test.utils import override_settings -from common.djangoapps.student.tasks import ( - MAX_RETRIES, - send_course_enrollment_email -) +from common.djangoapps.student.tasks import MAX_RETRIES, send_course_enrollment_email from common.djangoapps.student.tests.factories import UserFactory from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase from xmodule.modulestore.tests.factories import CourseFactory @@ -386,8 +383,8 @@ def test_retry_with_email_client_exception( task = send_course_enrollment_email.apply_async( kwargs=self.send_course_enrollment_email_kwargs ) - pytest.raises(Exception, task.get) - self.assertEqual(mock_get_email_client.call_count, (MAX_RETRIES + 1)) + pytest.raises(Exception, task.get) # noqa: B017 + self.assertEqual(mock_get_email_client.call_count, (MAX_RETRIES + 1)) # noqa: PT009 @patch("common.djangoapps.student.tasks.get_course_uuid_for_course") @patch("common.djangoapps.student.tasks.get_owners_for_course") diff --git a/common/djangoapps/student/tests/test_tracking_log.py b/common/djangoapps/student/tests/test_tracking_log.py index 45932b833e67..0691bf7eefbc 100644 --- a/common/djangoapps/student/tests/test_tracking_log.py +++ b/common/djangoapps/student/tests/test_tracking_log.py @@ -1,5 +1,5 @@ """Test to verify tracking logs are emitted correctly""" -from unittest.mock import patch, Mock +from unittest.mock import Mock, patch from django.test import TestCase diff --git a/common/djangoapps/student/tests/test_user_profile_properties.py b/common/djangoapps/student/tests/test_user_profile_properties.py index 886c026421e6..06ff21055644 100644 --- a/common/djangoapps/student/tests/test_user_profile_properties.py +++ b/common/djangoapps/student/tests/test_user_profile_properties.py @@ -2,14 +2,15 @@ import datetime -import pytest + import ddt +import pytest from django.core.cache import cache from django.core.exceptions import ValidationError -from openedx.core.djangolib.testing.utils import CacheIsolationTestCase from common.djangoapps.student.models import UserProfile from common.djangoapps.student.tests.factories import UserFactory +from openedx.core.djangolib.testing.utils import CacheIsolationTestCase @ddt.ddt diff --git a/common/djangoapps/student/tests/test_userstanding.py b/common/djangoapps/student/tests/test_userstanding.py index 67fcebda28f6..d98eeffbd8f8 100644 --- a/common/djangoapps/student/tests/test_userstanding.py +++ b/common/djangoapps/student/tests/test_userstanding.py @@ -67,7 +67,7 @@ def test_can_access_manage_account_page(self): @skip_unless_lms def test_disable_account(self): assert UserStanding.objects.filter(user=self.good_user).count() == 0 - response = self.admin_client.post(reverse('disable_account_ajax'), { # lint-amnesty, pylint: disable=unused-variable + response = self.admin_client.post(reverse('disable_account_ajax'), { # pylint: disable=unused-variable # noqa: F841 'username': self.good_user.username, 'account_action': 'disable', }) @@ -79,7 +79,7 @@ def test_disabled_account_403s(self): @skip_unless_lms def test_reenable_account(self): - response = self.admin_client.post(reverse('disable_account_ajax'), { # lint-amnesty, pylint: disable=unused-variable + response = self.admin_client.post(reverse('disable_account_ajax'), { # pylint: disable=unused-variable # noqa: F841 'username': self.bad_user.username, 'account_action': 'reenable' }) diff --git a/common/djangoapps/student/tests/test_views.py b/common/djangoapps/student/tests/test_views.py index ed8c98188a50..ac724d6f847b 100644 --- a/common/djangoapps/student/tests/test_views.py +++ b/common/djangoapps/student/tests/test_views.py @@ -6,7 +6,7 @@ import itertools import json import unittest -from datetime import datetime, timedelta # lint-amnesty, pylint: disable=unused-import +from datetime import datetime, timedelta # pylint: disable=unused-import from unittest.mock import patch from zoneinfo import ZoneInfo @@ -32,11 +32,11 @@ from common.djangoapps.util.milestones_helpers import ( get_course_milestones, remove_prerequisite_course, - set_prerequisite_courses + set_prerequisite_courses, ) -from common.djangoapps.util.testing import UrlResetMixin # lint-amnesty, pylint: disable=unused-import -from lms.djangoapps.certificates.tests.factories import GeneratedCertificateFactory +from common.djangoapps.util.testing import UrlResetMixin # pylint: disable=unused-import # noqa: F401 from lms.djangoapps.certificates.data import CertificateStatuses +from lms.djangoapps.certificates.tests.factories import GeneratedCertificateFactory from lms.djangoapps.commerce.utils import EcommerceService from openedx.core.djangoapps.catalog.tests.factories import ProgramFactory from openedx.core.djangoapps.content.course_overviews.models import CourseOverview @@ -45,9 +45,14 @@ from openedx.core.djangolib.testing.utils import skip_unless_lms from openedx.features.course_duration_limits.models import CourseDurationLimitConfig from openedx.features.course_experience.tests.views.helpers import add_course_mode -from xmodule.data import CertificatesDisplayBehaviors # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory, BlockFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.data import CertificatesDisplayBehaviors # pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + SharedModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import ( # pylint: disable=wrong-import-order + BlockFactory, + CourseFactory, +) TOMORROW = now() + timedelta(days=1) ONE_WEEK_AGO = now() - timedelta(weeks=1) @@ -305,8 +310,8 @@ def test_sharing_icons_for_future_course(self, set_marketing, set_social_sharing Verify that the course sharing icons show up if course is starting in future and any of marketing or social sharing urls are set. """ - self.course = CourseFactory.create(start=TOMORROW, emit_signals=True) # lint-amnesty, pylint: disable=attribute-defined-outside-init - self.course_enrollment = CourseEnrollmentFactory(course_id=self.course.id, user=self.user) # lint-amnesty, pylint: disable=attribute-defined-outside-init + self.course = CourseFactory.create(start=TOMORROW, emit_signals=True) # pylint: disable=attribute-defined-outside-init + self.course_enrollment = CourseEnrollmentFactory(course_id=self.course.id, user=self.user) # pylint: disable=attribute-defined-outside-init self.set_course_sharing_urls(set_marketing, set_social_sharing) # Assert course sharing icons @@ -321,14 +326,14 @@ def test_pre_requisites_appear_on_dashboard(self): If we remove the prerequisite and access the dashboard again, the prerequisite should not appear. """ - self.pre_requisite_course = CourseFactory.create(org='edx', number='999', display_name='Pre requisite Course') # lint-amnesty, pylint: disable=attribute-defined-outside-init - self.course = CourseFactory.create( # lint-amnesty, pylint: disable=attribute-defined-outside-init + self.pre_requisite_course = CourseFactory.create(org='edx', number='999', display_name='Pre requisite Course') # pylint: disable=attribute-defined-outside-init + self.course = CourseFactory.create( # pylint: disable=attribute-defined-outside-init org='edx', number='998', display_name='Test Course', pre_requisite_courses=[str(self.pre_requisite_course.id)] ) - self.course_enrollment = CourseEnrollmentFactory(course_id=self.course.id, user=self.user) # lint-amnesty, pylint: disable=attribute-defined-outside-init + self.course_enrollment = CourseEnrollmentFactory(course_id=self.course.id, user=self.user) # pylint: disable=attribute-defined-outside-init set_prerequisite_courses(self.course.id, [str(self.pre_requisite_course.id)]) response = self.client.get(reverse('dashboard')) @@ -542,7 +547,7 @@ def test_fulfilled_expired_entitlement(self, mock_course_overview, mock_course_r start=TOMORROW, self_paced=True, enrollment_end=TOMORROW ) mock_course_overview.return_value = mocked_course_overview - course_enrollment = CourseEnrollmentFactory(user=self.user, course_id=str(mocked_course_overview.id), created=THREE_YEARS_AGO) # lint-amnesty, pylint: disable=line-too-long + course_enrollment = CourseEnrollmentFactory(user=self.user, course_id=str(mocked_course_overview.id), created=THREE_YEARS_AGO) # pylint: disable=line-too-long mock_course_runs.return_value = [ { 'key': str(mocked_course_overview.id), @@ -552,7 +557,7 @@ def test_fulfilled_expired_entitlement(self, mock_course_overview, mock_course_r 'status': 'published' } ] - entitlement = CourseEntitlementFactory(user=self.user, enrollment_course_run=course_enrollment, created=THREE_YEARS_AGO) # lint-amnesty, pylint: disable=line-too-long + entitlement = CourseEntitlementFactory(user=self.user, enrollment_course_run=course_enrollment, created=THREE_YEARS_AGO) # pylint: disable=line-too-long program = ProgramFactory() program['courses'][0]['course_runs'] = [{'key': str(mocked_course_overview.id)}] program['courses'][0]['uuid'] = entitlement.course_uuid @@ -655,7 +660,7 @@ def _remove_whitespace_from_response(response): return ''.join(response.content.decode('utf-8').split()) @staticmethod - def _pull_course_run_from_course_key(course_key: CourseKey): # lint-amnesty, pylint: disable=missing-function-docstring + def _pull_course_run_from_course_key(course_key: CourseKey): # pylint: disable=missing-function-docstring return course_key.run.replace('_', ' ') @staticmethod @@ -669,7 +674,7 @@ def _get_html_for_view_course_button(course_key_string, course_run_string):  {course_run} - '''.format(course_key=course_key_string, course_run=course_run_string) + '''.format(course_key=course_key_string, course_run=course_run_string) # noqa: UP032 @staticmethod def _get_html_for_resume_course_button(course_key_string, resume_block_key_string, course_run_string): @@ -682,7 +687,7 @@ def _get_html_for_resume_course_button(course_key_string, resume_block_key_strin  {course_run} - '''.format( + '''.format( # noqa: UP032 course_key=course_key_string, url_to_block=resume_block_key_string, course_run=course_run_string @@ -698,7 +703,7 @@ def _get_html_for_entitlement_button(course_key: CourseKey):

          - '''.format( + '''.format( # noqa: UP032 org=course_key.org, course=course_key.course, ) diff --git a/common/djangoapps/student/tests/tests.py b/common/djangoapps/student/tests/tests.py index c4e5635be75a..c7a0b4c5037c 100644 --- a/common/djangoapps/student/tests/tests.py +++ b/common/djangoapps/student/tests/tests.py @@ -11,7 +11,7 @@ import ddt from config_models.models import cache from django.conf import settings -from django.contrib.auth.models import AnonymousUser, User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import AnonymousUser, User # pylint: disable=imported-auth-user from django.test import TestCase, override_settings from django.test.client import Client from django.urls import reverse @@ -31,7 +31,7 @@ UserAttribute, anonymous_id_for_user, unique_id_for_user, - user_by_anonymous_id + user_by_anonymous_id, ) from common.djangoapps.student.tests.factories import CourseEnrollmentFactory, UserFactory from common.djangoapps.student.toggles import REDIRECT_TO_COURSEWARE_AFTER_ENROLLMENT @@ -46,12 +46,18 @@ from openedx.core.djangoapps.content.course_overviews.tests.factories import CourseOverviewFactory from openedx.core.djangoapps.programs.tests.mixins import ProgramsApiConfigMixin from openedx.core.djangoapps.site_configuration.tests.mixins import SiteMixin +from openedx.core.djangoapps.site_configuration.tests.test_util import with_site_configuration_context from openedx.core.djangolib.testing.utils import CacheIsolationTestCase, skip_unless_lms from openedx.features.course_experience.url_helpers import make_learning_mfe_courseware_url -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase, SharedModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory, check_mongo_calls # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.data import CertificatesDisplayBehaviors # lint-amnesty, pylint: disable=wrong-import-order -from openedx.core.djangoapps.site_configuration.tests.test_util import with_site_configuration_context +from xmodule.data import CertificatesDisplayBehaviors # pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( # pylint: disable=wrong-import-order + ModuleStoreTestCase, + SharedModuleStoreTestCase, +) +from xmodule.modulestore.tests.factories import ( # pylint: disable=wrong-import-order + CourseFactory, + check_mongo_calls, +) log = logging.getLogger(__name__) @@ -661,7 +667,7 @@ class UserSettingsEventTestMixin(EventTestMixin): """ Mixin for verifying that user setting events were emitted during a test. """ - def setUp(self): # lint-amnesty, pylint: disable=arguments-differ + def setUp(self): # pylint: disable=arguments-differ super().setUp('common.djangoapps.util.model_utils.tracker') def assert_user_setting_event_emitted(self, **kwargs): @@ -688,7 +694,7 @@ def assert_user_enrollment_occurred(self, course_key): class EnrollmentEventTestMixin(EventTestMixin): """ Mixin with assertions for validating enrollment events. """ - def setUp(self): # lint-amnesty, pylint: disable=arguments-differ + def setUp(self): # pylint: disable=arguments-differ super().setUp('common.djangoapps.student.models.course_enrollment.tracker') segment_patcher = patch('common.djangoapps.student.models.course_enrollment.segment') self.mock_segment_tracker = segment_patcher.start() @@ -853,7 +859,7 @@ def test_enrollment_by_email(self): assert CourseEnrollment.enroll_by_email('not_jack@fake.edx.org', course_id) is None self.assert_no_events_were_emitted() - self.assertRaises( + self.assertRaises( # noqa: PT027 User.DoesNotExist, CourseEnrollment.enroll_by_email, "not_jack@fake.edx.org", diff --git a/common/djangoapps/student/views/__init__.py b/common/djangoapps/student/views/__init__.py index e10dd7b8a882..16b5d90ef73f 100644 --- a/common/djangoapps/student/views/__init__.py +++ b/common/djangoapps/student/views/__init__.py @@ -3,5 +3,5 @@ """ -from .dashboard import * -from .management import * +from .dashboard import * # noqa: F403 +from .management import * # noqa: F403 diff --git a/common/djangoapps/student/views/dashboard.py b/common/djangoapps/student/views/dashboard.py index be1f32160911..d38a3c3c3407 100644 --- a/common/djangoapps/student/views/dashboard.py +++ b/common/djangoapps/student/views/dashboard.py @@ -17,26 +17,36 @@ from django.utils.translation import gettext as _ from django.views.decorators.csrf import ensure_csrf_cookie from edx_django_utils import monitoring as monitoring_utils -from edx_django_utils.plugins import get_plugins_view_context +from edx_django_utils.plugins import get_plugins_view_context, pluggable_override from edx_toggles.toggles import WaffleFlag from opaque_keys.edx.keys import CourseKey from openedx_filters.learning.filters import DashboardRenderStarted -from edx_django_utils.plugins import pluggable_override -from lms.djangoapps.bulk_email.api import is_bulk_email_feature_enabled -from lms.djangoapps.bulk_email.models import Optout from common.djangoapps.course_modes.models import CourseMode from common.djangoapps.edxmako.shortcuts import render_to_response, render_to_string from common.djangoapps.entitlements.models import CourseEntitlement +from common.djangoapps.student.api import COURSE_DASHBOARD_PLUGIN_VIEW_NAME +from common.djangoapps.student.helpers import cert_info, check_verify_status_by_course, get_resume_urls_for_enrollments +from common.djangoapps.student.models import ( + AccountRecovery, + CourseEnrollment, + CourseEnrollmentAttribute, + DashboardConfiguration, + PendingSecondaryEmailChange, + UserProfile, +) +from common.djangoapps.util.milestones_helpers import get_pre_requisite_courses_not_completed +from lms.djangoapps.bulk_email.api import is_bulk_email_feature_enabled +from lms.djangoapps.bulk_email.models import Optout from lms.djangoapps.commerce.utils import EcommerceService from lms.djangoapps.courseware.access import has_access -from lms.djangoapps.learner_home.waffle import learner_home_mfe_enabled from lms.djangoapps.experiments.utils import get_dashboard_course_info, get_experiment_user_metadata_context +from lms.djangoapps.learner_home.waffle import learner_home_mfe_enabled from lms.djangoapps.verify_student.services import IDVerificationService from openedx.core.djangoapps.catalog.utils import ( get_programs, get_pseudo_session_for_entitlement, - get_visible_sessions_for_entitlement + get_visible_sessions_for_entitlement, ) from openedx.core.djangoapps.credit.email_utils import get_credit_provider_attribute_values, make_providers_strings from openedx.core.djangoapps.plugins.constants import ProjectType @@ -48,24 +58,7 @@ from openedx.core.djangolib.markup import HTML, Text from openedx.features.content_type_gating.models import ContentTypeGatingConfig from openedx.features.course_duration_limits.access import get_user_course_duration, get_user_course_expiration_date -from openedx.features.enterprise_support.api import ( - get_dashboard_consent_notification, - get_enterprise_learner_portal_context, -) -from openedx.features.enterprise_support.utils import is_enterprise_learner - -from common.djangoapps.student.api import COURSE_DASHBOARD_PLUGIN_VIEW_NAME -from common.djangoapps.student.helpers import cert_info, check_verify_status_by_course, get_resume_urls_for_enrollments -from common.djangoapps.student.models import ( - AccountRecovery, - CourseEnrollment, - CourseEnrollmentAttribute, - DashboardConfiguration, - PendingSecondaryEmailChange, - UserProfile -) -from common.djangoapps.util.milestones_helpers import get_pre_requisite_courses_not_completed -from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order log = logging.getLogger("edx.student") @@ -117,7 +110,7 @@ def _get_recently_enrolled_courses(course_enrollments): ] -def _create_recent_enrollment_message(course_enrollments, course_modes): # lint-amnesty, pylint: disable=unused-argument +def _create_recent_enrollment_message(course_enrollments, course_modes): # pylint: disable=unused-argument """ Builds a recent course enrollment message. @@ -511,7 +504,7 @@ def check_for_unacknowledged_notices(context): @login_required @ensure_csrf_cookie @add_maintenance_banner -def student_dashboard(request): # lint-amnesty, pylint: disable=too-many-statements +def student_dashboard(request): # pylint: disable=too-many-statements """ Provides the LMS dashboard view @@ -527,8 +520,12 @@ def student_dashboard(request): # lint-amnesty, pylint: disable=too-many-statem """ user = request.user + account_microfrontend_url = configuration_helpers.get_value( + 'ACCOUNT_MICROFRONTEND_URL', + settings.ACCOUNT_MICROFRONTEND_URL, + ) if not UserProfile.objects.filter(user=user).exists(): - return redirect(settings.ACCOUNT_MICROFRONTEND_URL) + return redirect(account_microfrontend_url) if learner_home_mfe_enabled(): return redirect(settings.LEARNER_HOME_MICROFRONTEND_URL) @@ -617,15 +614,13 @@ def student_dashboard(request): # lint-amnesty, pylint: disable=too-many-statem link_end=HTML(""), ) - enterprise_message = get_dashboard_consent_notification(request, user, course_enrollments) - recovery_email_message = recovery_email_activation_message = None if is_secondary_email_feature_enabled(): try: - pending_email = PendingSecondaryEmailChange.objects.get(user=user) # lint-amnesty, pylint: disable=unused-variable + pending_email = PendingSecondaryEmailChange.objects.get(user=user) # pylint: disable=unused-variable # noqa: F841 except PendingSecondaryEmailChange.DoesNotExist: try: - account_recovery_obj = AccountRecovery.objects.get(user=user) # lint-amnesty, pylint: disable=unused-variable + account_recovery_obj = AccountRecovery.objects.get(user=user) # pylint: disable=unused-variable # noqa: F841 except AccountRecovery.DoesNotExist: recovery_email_message = Text( _( @@ -633,7 +628,7 @@ def student_dashboard(request): # lint-amnesty, pylint: disable=too-many-statem "Go to {link_start}your Account Settings{link_end}.") ).format( link_start=HTML("").format( - account_setting_page=settings.ACCOUNT_MICROFRONTEND_URL, + account_setting_page=account_microfrontend_url, ), link_end=HTML("") ) @@ -645,10 +640,6 @@ def student_dashboard(request): # lint-amnesty, pylint: disable=too-many-statem ) ) - # Disable lookup of Enterprise consent_required_course due to ENT-727 - # Will re-enable after fixing WL-1315 - consent_required_courses = set() - # Account activation message account_activation_messages = [ message for message in messages.get_messages(request) if 'account-activation' in message.tags @@ -675,7 +666,7 @@ def student_dashboard(request): # lint-amnesty, pylint: disable=too-many-statem inverted_programs = meter.invert_programs() urls, programs_data = {}, {} - bundles_on_dashboard_flag = WaffleFlag(f'{EXPERIMENTS_NAMESPACE}.bundles_on_dashboard', __name__) # lint-amnesty, pylint: disable=toggle-missing-annotation + bundles_on_dashboard_flag = WaffleFlag(f'{EXPERIMENTS_NAMESPACE}.bundles_on_dashboard', __name__) # pylint: disable=toggle-missing-annotation # TODO: Delete this code and the relevant HTML code after testing LEARNER-3072 is complete if bundles_on_dashboard_flag.is_enabled() and inverted_programs and list(inverted_programs.items()): @@ -799,8 +790,6 @@ def student_dashboard(request): # lint-amnesty, pylint: disable=too-many-statem context = { 'urls': urls, 'programs_data': programs_data, - 'enterprise_message': enterprise_message, - 'consent_required_courses': consent_required_courses, 'enrollment_message': enrollment_message, 'redirect_message': Text(redirect_message), 'account_activation_messages': account_activation_messages, @@ -850,14 +839,8 @@ def student_dashboard(request): # lint-amnesty, pylint: disable=too-many-statem 'course_info': get_dashboard_course_info(user, course_enrollments), # TODO START: clean up as part of REVEM-199 (END) 'disable_unenrollment': disable_unenrollment, - # TODO: clean when experiment(Merchandise 2U LOBs - Dashboard) would be stop. [VAN-1097] - 'is_enterprise_user': is_enterprise_learner(user), } - # Include enterprise learner portal metadata and messaging - enterprise_learner_portal_context = get_enterprise_learner_portal_context(request) - context.update(enterprise_learner_portal_context) - context_from_plugins = get_plugins_view_context( ProjectType.LMS, COURSE_DASHBOARD_PLUGIN_VIEW_NAME, @@ -902,7 +885,10 @@ def student_dashboard(request): # lint-amnesty, pylint: disable=too-many-statem except DashboardRenderStarted.RenderInvalidDashboard as exc: response = render_to_response(exc.dashboard_template, exc.template_context) except DashboardRenderStarted.RedirectToPage as exc: - response = HttpResponseRedirect(exc.redirect_to or settings.ACCOUNT_MICROFRONTEND_URL) + response = HttpResponseRedirect( + exc.redirect_to or + account_microfrontend_url + ) except DashboardRenderStarted.RenderCustomResponse as exc: response = exc.response else: diff --git a/common/djangoapps/student/views/management.py b/common/djangoapps/student/views/management.py index 3af83742613d..5609afd49ddc 100644 --- a/common/djangoapps/student/views/management.py +++ b/common/djangoapps/student/views/management.py @@ -1,94 +1,121 @@ -""" # lint-amnesty, pylint: disable=cyclic-import +""" # pylint: disable=cyclic-import Student Views """ import datetime import logging +import re import urllib.parse import uuid from collections import namedtuple -import re from zoneinfo import ZoneInfo from django.conf import settings from django.contrib import messages from django.contrib.auth.decorators import login_required -from django.contrib.auth.models import AnonymousUser, User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import AnonymousUser, User # pylint: disable=imported-auth-user from django.contrib.sites.models import Site from django.core.validators import ValidationError, validate_email from django.db import transaction from django.db.models.signals import post_save -from django.dispatch import Signal, receiver # lint-amnesty, pylint: disable=unused-import +from django.dispatch import Signal, receiver # pylint: disable=unused-import # noqa: F401 from django.http import Http404, HttpResponse, HttpResponseBadRequest, HttpResponseForbidden from django.shortcuts import redirect from django.template.context_processors import csrf from django.urls import reverse from django.utils.translation import gettext as _ -from django.views.decorators.csrf import csrf_exempt, ensure_csrf_cookie # lint-amnesty, pylint: disable=unused-import -from django.views.decorators.http import require_GET, require_http_methods, require_POST # lint-amnesty, pylint: disable=unused-import +from django.views.decorators.csrf import ( # pylint: disable=unused-import # noqa: F401 + csrf_exempt, + ensure_csrf_cookie, +) +from django.views.decorators.http import ( # pylint: disable=unused-import + require_GET, + require_http_methods, # noqa: F401 + require_POST, +) from edx_ace import ace from edx_ace.recipient import Recipient from edx_django_utils import monitoring as monitoring_utils from edx_rest_framework_extensions.auth.jwt.authentication import JwtAuthentication -from edx_rest_framework_extensions.auth.session.authentication import SessionAuthenticationAllowInactiveUser # lint-amnesty, pylint: disable=wrong-import-order +from edx_rest_framework_extensions.auth.session.authentication import ( + SessionAuthenticationAllowInactiveUser, # pylint: disable=wrong-import-order +) from eventtracking import tracker + # Note that this lives in LMS, so this dependency should be refactored. from opaque_keys import InvalidKeyError from opaque_keys.edx.keys import CourseKey from rest_framework.decorators import api_view, authentication_classes, permission_classes from rest_framework.permissions import IsAuthenticated +from common.djangoapps.course_modes.models import CourseMode +from common.djangoapps.edxmako.shortcuts import ( # pylint: disable=unused-import + marketing_link, + render_to_response, + render_to_string, # noqa: F401 +) +from common.djangoapps.entitlements.models import CourseEntitlement +from common.djangoapps.student.email_helpers import generate_activation_email_context +from common.djangoapps.student.helpers import ( + DISABLE_UNENROLL_CERT_STATES, + cert_info, + get_next_url_for_login_page, + get_redirect_url_with_host, +) +from common.djangoapps.student.message_types import ( # pylint: disable=line-too-long + AccountActivation, + EmailChange, + EmailChangeConfirmation, + RecoveryEmailCreate, +) +from common.djangoapps.student.models import ( # pylint: disable=unused-import + PENDING_SECONDARY_EMAIL_REDACTED_VALUE, + AccountRecovery, + CourseEnrollment, + EnrollmentNotAllowed, + PendingEmailChange, # unimport:skip + PendingSecondaryEmailChange, + Registration, + RegistrationCookieConfiguration, # noqa: F401 + UnenrollmentNotAllowed, + UserAttribute, # noqa: F401 + UserProfile, + UserSignupSource, + UserStanding, + create_comments_service_user, # noqa: F401 + email_exists_or_retired, # noqa: F401 +) +from common.djangoapps.student.signals import REFUND_ORDER, USER_EMAIL_CHANGED from common.djangoapps.student.toggles import should_redirect_to_courseware_after_enrollment from common.djangoapps.track import views as track_views +from common.djangoapps.util.db import outer_atomic +from common.djangoapps.util.json_request import JsonResponse from lms.djangoapps.bulk_email.models import Optout -from common.djangoapps.course_modes.models import CourseMode from lms.djangoapps.courseware.courses import get_courses, sort_by_announcement, sort_by_start_date -from common.djangoapps.edxmako.shortcuts import marketing_link, render_to_response, render_to_string # lint-amnesty, pylint: disable=unused-import -from common.djangoapps.entitlements.models import CourseEntitlement -from common.djangoapps.student.helpers import get_next_url_for_login_page, get_redirect_url_with_host from openedx.core.djangoapps.ace_common.template_context import get_base_template_context from openedx.core.djangoapps.catalog.utils import get_programs_with_type from openedx.core.djangoapps.embargo import api as embargo_api from openedx.core.djangoapps.lang_pref import LANGUAGE_KEY -from openedx.core.djangoapps.programs.models import ProgramsApiConfig # lint-amnesty, pylint: disable=unused-import + +# pylint: disable-next=unused-import +from openedx.core.djangoapps.programs.models import ( + ProgramsApiConfig, # noqa: F401 +) from openedx.core.djangoapps.site_configuration import helpers as configuration_helpers from openedx.core.djangoapps.theming import helpers as theming_helpers from openedx.core.djangoapps.user_api.preferences import api as preferences_api from openedx.core.djangoapps.user_authn.tasks import send_activation_email from openedx.core.djangoapps.user_authn.toggles import ( + is_auto_generated_username_enabled, should_redirect_to_authn_microfrontend, - is_auto_generated_username_enabled ) from openedx.core.djangolib.markup import HTML, Text from openedx.core.lib.api.authentication import BearerAuthenticationAllowInactiveUser from openedx.features.course_experience.url_helpers import make_learning_mfe_courseware_url from openedx.features.discounts.applicability import FIRST_PURCHASE_DISCOUNT_OVERRIDE_FLAG from openedx.features.enterprise_support.utils import is_enterprise_learner -from common.djangoapps.student.email_helpers import generate_activation_email_context -from common.djangoapps.student.helpers import DISABLE_UNENROLL_CERT_STATES, cert_info -from common.djangoapps.student.message_types import AccountActivation, EmailChange, EmailChangeConfirmation, RecoveryEmailCreate # lint-amnesty, pylint: disable=line-too-long -from common.djangoapps.student.models import ( # lint-amnesty, pylint: disable=unused-import - AccountRecovery, - CourseEnrollment, - EnrollmentNotAllowed, - PendingEmailChange, # unimport:skip - PendingSecondaryEmailChange, - Registration, - RegistrationCookieConfiguration, - UnenrollmentNotAllowed, - UserAttribute, - UserProfile, - UserSignupSource, - UserStanding, - create_comments_service_user, - email_exists_or_retired -) -from common.djangoapps.student.signals import REFUND_ORDER -from common.djangoapps.util.db import outer_atomic -from common.djangoapps.util.json_request import JsonResponse -from common.djangoapps.student.signals import USER_EMAIL_CHANGED -from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order log = logging.getLogger("edx.student") @@ -126,7 +153,7 @@ def csrf_token(context): # branding/views.py:index(), which is cached for anonymous users. # This means that it should always return the same thing for anon # users. (in particular, no switching based on query params allowed) -def index(request, extra_context=None, user=AnonymousUser()): +def index(request, extra_context=None, user=AnonymousUser()): # noqa: B008 """ Render the edX main page. @@ -240,7 +267,7 @@ def _get_activation_confirmation_link(activation_key, redirect_url=None): is not null. """ root_url = configuration_helpers.get_value('LMS_ROOT_URL', settings.LMS_ROOT_URL) - confirmation_link = '{root_url}/activate/{activation_key}'.format( + confirmation_link = '{root_url}/activate/{activation_key}'.format( # noqa: UP032 root_url=root_url, activation_key=activation_key, ) @@ -679,7 +706,7 @@ def activate_account(request, key): params = {'account_activation_status': activation_message_type} if redirect_url: params['next'] = redirect_url - url_path = '/login?{}'.format(urllib.parse.urlencode(params)) + url_path = '/login?{}'.format(urllib.parse.urlencode(params)) # noqa: UP032 return redirect(settings.AUTHN_MICROFRONTEND_URL + url_path) response = redirect(redirect_url) if redirect_url and is_enterprise_learner(request.user) else redirect('dashboard') @@ -728,7 +755,7 @@ def validate_new_email(user, new_email): try: validate_email(new_email) except ValidationError: - raise ValueError(_('Valid e-mail address required.')) # lint-amnesty, pylint: disable=raise-missing-from + raise ValueError(_('Valid e-mail address required.')) # pylint: disable=raise-missing-from # noqa: B904 if new_email == user.email: raise ValueError(_('Old email is the same as the new email.')) @@ -739,8 +766,10 @@ def validate_secondary_email(user, new_email): Enforce valid email addresses. """ - from openedx.core.djangoapps.user_api.accounts.api import get_email_validation_error, \ - get_secondary_email_validation_error + from openedx.core.djangoapps.user_api.accounts.api import ( + get_email_validation_error, + get_secondary_email_validation_error, + ) if get_email_validation_error(new_email): raise ValueError(_('Valid e-mail address required.')) @@ -822,7 +851,7 @@ def do_email_change_request(user, new_email, activation_key=None, secondary_emai except Exception: from_address = configuration_helpers.get_value('email_from_address', settings.DEFAULT_FROM_EMAIL) log.error('Unable to send email activation link to user from "%s"', from_address, exc_info=True) - raise ValueError(_('Unable to send email activation link. Please try again later.')) # lint-amnesty, pylint: disable=raise-missing-from + raise ValueError(_('Unable to send email activation link. Please try again later.')) # pylint: disable=raise-missing-from # noqa: B904 if not secondary_email_change_request: # When the email address change is complete, a "edx.user.settings.changed" event will be emitted. @@ -862,6 +891,9 @@ def activate_secondary_email(request, key): 'secondary_email': pending_secondary_email_change.new_secondary_email }) + # Redact the pending email before deletion so downstream soft-delete mirrors do not retain the original address. + pending_secondary_email_change.new_secondary_email = PENDING_SECONDARY_EMAIL_REDACTED_VALUE + pending_secondary_email_change.save(update_fields=['new_secondary_email']) pending_secondary_email_change.delete() return render_to_response("secondary_email_change_successful.html") @@ -935,14 +967,17 @@ def confirm_email_change(request, key): user.email = pec.new_email user.save() - pec.delete() + + # Redact pending email before deletion. + PendingEmailChange.delete_by_user_value(user, field="user") + # And send it to the new email... - msg.recipient = Recipient(user.id, pec.new_email) + msg.recipient = Recipient(user.id, user.email) try: ace.send(msg) except Exception: # pylint: disable=broad-except log.warning('Unable to send confirmation email to new address', exc_info=True) - response = render_to_response("email_change_failed.html", {'email': pec.new_email}) + response = render_to_response("email_change_failed.html", {'email': user.email}) transaction.set_rollback(True) return response diff --git a/common/djangoapps/third_party_auth/admin.py b/common/djangoapps/third_party_auth/admin.py index d44da6248ee2..ee222007b415 100644 --- a/common/djangoapps/third_party_auth/admin.py +++ b/common/djangoapps/third_party_auth/admin.py @@ -21,7 +21,7 @@ OAuth2ProviderConfig, SAMLConfiguration, SAMLProviderConfig, - SAMLProviderData + SAMLProviderData, ) from .tasks import fetch_saml_metadata, update_saml_users_social_auth_uid diff --git a/common/djangoapps/third_party_auth/api/permissions.py b/common/djangoapps/third_party_auth/api/permissions.py index f6eb430a367f..d38817d24878 100644 --- a/common/djangoapps/third_party_auth/api/permissions.py +++ b/common/djangoapps/third_party_auth/api/permissions.py @@ -10,7 +10,7 @@ IsSuperuser, JwtHasScope, JwtRestrictedApplication, - NotJwtRestrictedApplication + NotJwtRestrictedApplication, ) from rest_framework.permissions import BasePermission diff --git a/common/djangoapps/third_party_auth/api/tests/test_permissions.py b/common/djangoapps/third_party_auth/api/tests/test_permissions.py index 1cb9450c49a2..4fe9678ed978 100644 --- a/common/djangoapps/third_party_auth/api/tests/test_permissions.py +++ b/common/djangoapps/third_party_auth/api/tests/test_permissions.py @@ -26,7 +26,7 @@ class SomeTpaClassView(APIView): permission_classes = (TPA_PERMISSIONS,) required_scopes = ['tpa:read'] - def get(self, request, provider_id=None): # lint-amnesty, pylint: disable=unused-argument + def get(self, request, provider_id=None): # pylint: disable=unused-argument return Response(data="Success") def _create_user(self, is_superuser=False, is_staff=False): diff --git a/common/djangoapps/third_party_auth/api/tests/test_views.py b/common/djangoapps/third_party_auth/api/tests/test_views.py index 61740268db90..8360555782e6 100644 --- a/common/djangoapps/third_party_auth/api/tests/test_views.py +++ b/common/djangoapps/third_party_auth/api/tests/test_views.py @@ -3,6 +3,7 @@ """ import urllib +from types import SimpleNamespace from unittest.mock import patch import ddt @@ -19,7 +20,7 @@ from common.djangoapps.third_party_auth.api.permissions import ( JwtHasScope, JwtHasTpaProviderFilterForRequestedProvider, - JwtRestrictedApplication + JwtRestrictedApplication, ) from common.djangoapps.third_party_auth.tests.testutil import ThirdPartyAuthTestMixin from openedx.core.djangolib.testing.utils import skip_unless_lms @@ -137,7 +138,7 @@ def test_list_connected_providers(self, request_user, target_user, expect_result assert response.status_code == expect_result if expect_result == 200: assert 'active' in response.data - self.assertCountEqual(response.data["active"], self.expected_active(target_user)) + self.assertCountEqual(response.data["active"], self.expected_active(target_user)) # noqa: PT009 @ddt.data( # A server with a valid API key can query any user's list of providers @@ -153,7 +154,7 @@ def test_list_connected_providers_with_api_key(self, api_key, target_user, expec assert response.status_code == expect_result if expect_result == 200: assert 'active' in response.data - self.assertCountEqual(response.data["active"], self.expected_active(target_user)) + self.assertCountEqual(response.data["active"], self.expected_active(target_user)) # noqa: PT009 @ddt.data( (True, ALICE_USERNAME, 200, True), @@ -417,7 +418,7 @@ def _verify_response(self, response, expect_code, expect_result): if expect_code == 200: for item in ['results', 'count', 'num_pages']: assert item in response.data - self.assertCountEqual(response.data['results'], expect_result) + self.assertCountEqual(response.data['results'], expect_result) # noqa: PT009 @skip_unless_lms @@ -447,3 +448,24 @@ def test_get(self): 'connect_url': f'/auth/login/google-oauth2/?auth_entry=account_settings&next={next_url}', 'connected': False, 'id': 'oa2-google-oauth2' }]) + + def test_get_uses_site_config_account_mfe_url(self): + """ + The providers API uses site-configured ACCOUNT_MICROFRONTEND_URL in the next link. + """ + self.client.login(username=self.user.username, password=PASSWORD) + siteconf_url = "https://accounts.siteconf.example" + + helpers_stub = SimpleNamespace( + get_value=lambda key, default=None, *args, **kwargs: + siteconf_url if key == "ACCOUNT_MICROFRONTEND_URL" else default + ) + + with patch("common.djangoapps.third_party_auth.api.views.configuration_helpers", new=helpers_stub): + response = self.client.get(self.url) + + assert response.status_code == 200 + providers = response.data + google = next(p for p in providers if p["id"].endswith("google-oauth2")) + qs = urllib.parse.parse_qs(urllib.parse.urlparse(google["connect_url"]).query) + assert qs.get("next") == [siteconf_url] diff --git a/common/djangoapps/third_party_auth/api/views.py b/common/djangoapps/third_party_auth/api/views.py index 89d55e2eecdc..3f954c034246 100644 --- a/common/djangoapps/third_party_auth/api/views.py +++ b/common/djangoapps/third_party_auth/api/views.py @@ -6,7 +6,7 @@ from collections import namedtuple from django.conf import settings -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.db.models import Q from django.http import Http404 from edx_rest_framework_extensions.auth.jwt.authentication import JwtAuthentication @@ -17,16 +17,14 @@ from rest_framework.views import APIView from social_django.models import UserSocialAuth -from openedx.core.lib.api.authentication import ( - BearerAuthentication, - BearerAuthenticationAllowInactiveUser -) -from openedx.core.lib.api.permissions import ApiKeyHeaderPermission from common.djangoapps.third_party_auth import pipeline from common.djangoapps.third_party_auth.api import serializers from common.djangoapps.third_party_auth.api.permissions import TPA_PERMISSIONS -from common.djangoapps.third_party_auth.provider import Registry from common.djangoapps.third_party_auth.api.utils import filter_user_social_auth_queryset_by_provider +from common.djangoapps.third_party_auth.provider import Registry +from openedx.core.djangoapps.site_configuration import helpers as configuration_helpers +from openedx.core.lib.api.authentication import BearerAuthentication, BearerAuthenticationAllowInactiveUser +from openedx.core.lib.api.permissions import ApiKeyHeaderPermission class ProviderBaseThrottle(throttling.UserRateThrottle): @@ -175,7 +173,7 @@ class UserView(BaseUserView): login. """ - def get(self, request, username): # lint-amnesty, pylint: disable=unused-argument + def get(self, request, username): # pylint: disable=unused-argument """Read provider information for a user. Allows reading the list of providers for a specified user. @@ -468,7 +466,10 @@ def get(self, request): state.provider.provider_id, pipeline.AUTH_ENTRY_ACCOUNT_SETTINGS, # The url the user should be directed to after the auth process has completed. - redirect_url=settings.ACCOUNT_MICROFRONTEND_URL, + redirect_url=configuration_helpers.get_value( + 'ACCOUNT_MICROFRONTEND_URL', + settings.ACCOUNT_MICROFRONTEND_URL, + ), ), 'accepts_logins': state.provider.accepts_logins, # If the user is connected, sending a POST request to this url removes the connection diff --git a/common/djangoapps/third_party_auth/appleid.py b/common/djangoapps/third_party_auth/appleid.py index c1ff6a16086a..2f1465733449 100644 --- a/common/djangoapps/third_party_auth/appleid.py +++ b/common/djangoapps/third_party_auth/appleid.py @@ -75,13 +75,12 @@ import time import jwt +import social_django +from django.apps import apps from jwt.algorithms import RSAAlgorithm from jwt.exceptions import PyJWTError - -from django.apps import apps from social_core.backends.oauth import BaseOAuth2 from social_core.exceptions import AuthFailed -import social_django from common.djangoapps.third_party_auth.toggles import is_apple_user_migration_enabled @@ -182,7 +181,7 @@ def decode_id_token(self, id_token): algorithms=['RS256'], ) except PyJWTError: - raise AuthFailed(self, 'Token validation failed') + raise AuthFailed(self, 'Token validation failed') # noqa: B904 return decoded @@ -248,6 +247,6 @@ def do_auth(self, access_token, *args, **kwargs): return super().do_auth( access_token, response=decoded_data, - *args, + *args, # noqa: B026 **kwargs ) diff --git a/common/djangoapps/third_party_auth/apps.py b/common/djangoapps/third_party_auth/apps.py index 7f6b82cfde1f..b715611bceb3 100644 --- a/common/djangoapps/third_party_auth/apps.py +++ b/common/djangoapps/third_party_auth/apps.py @@ -1,26 +1,12 @@ -# lint-amnesty, pylint: disable=missing-module-docstring +# pylint: disable=missing-module-docstring from django.apps import AppConfig -from django.conf import settings -class ThirdPartyAuthConfig(AppConfig): # lint-amnesty, pylint: disable=missing-class-docstring +class ThirdPartyAuthConfig(AppConfig): # pylint: disable=missing-class-docstring name = 'common.djangoapps.third_party_auth' verbose_name = "Third-party authentication" def ready(self): # Import signal handlers to register them from .signals import handlers # noqa: F401 pylint: disable=unused-import - - # To override the settings before loading social_django. - if settings.FEATURES.get('ENABLE_THIRD_PARTY_AUTH', False): - self._enable_third_party_auth() - - def _enable_third_party_auth(self): - """ - Enable the use of third_party_auth, which allows users to sign in to edX - using other identity providers. For configuration details, see - common/djangoapps/third_party_auth/settings.py. - """ - from common.djangoapps.third_party_auth import settings as auth_settings - auth_settings.apply_settings(settings) diff --git a/common/djangoapps/third_party_auth/decorators.py b/common/djangoapps/third_party_auth/decorators.py index 66540212e10e..58912bc98714 100644 --- a/common/djangoapps/third_party_auth/decorators.py +++ b/common/djangoapps/third_party_auth/decorators.py @@ -6,7 +6,7 @@ from functools import wraps from django.conf import settings -from six.moves.urllib.parse import urlparse # lint-amnesty, pylint: disable=unused-import +from six.moves.urllib.parse import urlparse # pylint: disable=unused-import from common.djangoapps.third_party_auth.models import LTIProviderConfig diff --git a/common/djangoapps/third_party_auth/docs/how_tos/testing_saml_locally.rst b/common/djangoapps/third_party_auth/docs/how_tos/testing_saml_locally.rst new file mode 100644 index 000000000000..2be1cc1dacf6 --- /dev/null +++ b/common/djangoapps/third_party_auth/docs/how_tos/testing_saml_locally.rst @@ -0,0 +1,156 @@ +Testing SAML Authentication Locally with MockSAML +================================================== + +This guide walks through setting up and testing SAML authentication in a local Open edX devstack environment using MockSAML.com as a test Identity Provider (IdP). + +Overview +-------- + +SAML (Security Assertion Markup Language) authentication in Open edX requires three configuration objects to work together: + +1. **SAMLConfiguration**: Configures the Service Provider (SP) metadata - entity ID, keys, and organization info +2. **SAMLProviderConfig**: Configures a specific Identity Provider (IdP) connection with metadata URL and attribute mappings +3. **SAMLProviderData**: Stores the IdP's metadata (SSO URL, public key) fetched from the IdP's metadata endpoint + +**Critical Requirement**: The SAMLConfiguration object MUST have the slug "default" because this value is hardcoded in the authentication execution path at ``common/djangoapps/third_party_auth/models.py:906``. + +Prerequisites +------------- + +* Local Open edX devstack running +* Access to Django admin at http://localhost:18000/admin/ +* MockSAML.com account (free service for SAML testing) + +Step 1: Configure SAMLConfiguration +------------------------------------ + +The SAMLConfiguration defines your Open edX instance as a SAML Service Provider (SP). + +1. Navigate to Django Admin → Third Party Auth → SAML Configurations +2. Click "Add SAML Configuration" +3. Configure with these **required** values: + + ============ =================================================== + Field Value + ============ =================================================== + Site localhost:18000 + **Slug** **default** (MUST be "default" - hardcoded in code) + Entity ID https://saml.example.com/entityid + Enabled ✓ (checked) + ============ =================================================== + +4. For local testing with MockSAML, you can leave the keys blank. + +5. Optionally configure Organization Info (use default or customize): + + .. code-block:: json + + { + "en-US": { + "url": "http://localhost:18000", + "displayname": "Local Open edX", + "name": "localhost" + } + } + +6. Click "Save" + +Step 2: Configure SAMLProviderConfig +------------------------------------- + +The SAMLProviderConfig connects to a specific SAML Identity Provider (MockSAML in this case). + +1. Navigate to Django Admin → Third Party Auth → Provider Configuration (SAML IdPs) +2. Click "Add Provider Configuration (SAML IdP)" +3. Configure with these values: + + ========================= =================================================== + Field Value + ========================= =================================================== + Name Test Localhost (or any descriptive name) + Slug default (to match test URLs) + Backend Name tpa-saml + Entity ID https://saml.example.com/entityid + Metadata Source https://mocksaml.com/api/saml/metadata + Site localhost:18000 + SAML Configuration Select the SAMLConfiguration created in Step 1 + Enabled ✓ (checked) + Visible ☐ (unchecked for testing) + Skip hinted login dialog ✓ (checked - recommended) + Skip registration form ✓ (checked - recommended) + Skip email verification ✓ (checked - recommended) + Send to registration first ✓ (checked - recommended) + ========================= =================================================== + +4. Leave all attribute mappings (User ID, Email, Full Name, etc.) blank to use defaults +5. Click "Save" + +**Important**: The Entity ID in SAMLProviderConfig MUST match the Entity ID in SAMLConfiguration. + +Step 3: Set IdP Data +-------------------- + +The SAMLProviderData stores metadata from the Identity Provider (MockSAML), create a record with + +* **Entity ID**: https://saml.example.com/entityid +* **SSO URL**: https://mocksaml.com/api/saml/sso +* **Public Key**: The IdP's signing certificate +* **Expires At**: Set to 1 year from fetch time + + +Step 4: Test SAML Authentication +--------------------------------- + +1. Navigate to: http://localhost:18000/auth/idp_redirect/saml-default +2. You should be redirected to MockSAML.com +3. Complete the authentication on MockSAML - just click "Sign In" with whatever is in the form. +4. You should be redirected back to Open edX +5. If this is a new user, you'll see the registration form +6. After registration, you should be logged in + +Expected Behavior +^^^^^^^^^^^^^^^^^ + +1. Initial redirect to MockSAML (https://mocksaml.com/api/saml/sso) +2. MockSAML displays the login page +3. After authentication, MockSAML POSTs the SAML assertion back to Open edX +4. Open edX validates the assertion and creates/logs in the user +5. User is redirected to the dashboard or registration form (if new user) + +Reference Configuration +----------------------- + +Here's a summary of a working test configuration: + +**SAMLConfiguration** (id=6): + +* Site: localhost:18000 +* Slug: **default** +* Entity ID: https://saml.example.com/entityid +* Enabled: True + +**SAMLProviderConfig** (id=11): + +* Name: Test Localhost +* Slug: default +* Entity ID: https://saml.example.com/entityid +* Metadata Source: https://mocksaml.com/api/saml/metadata +* Backend Name: tpa-saml +* Site: localhost:18000 +* SAML Configuration: → SAMLConfiguration (id=6) +* Enabled: True + +**SAMLProviderData** (id=3): + +* Entity ID: https://saml.example.com/entityid +* SSO URL: https://mocksaml.com/api/saml/sso +* Public Key: (certificate from MockSAML metadata) +* Fetched At: 2026-02-27 18:05:40+00:00 +* Expires At: 2027-02-27 18:05:41+00:00 +* Valid: True + +**MockSAML Configuration**: + +* SP Entity ID: https://saml.example.com/entityid +* ACS URL: http://localhost:18000/auth/complete/tpa-saml/ +* Test User Attributes: email, firstName, lastName, uid diff --git a/common/djangoapps/third_party_auth/identityserver3.py b/common/djangoapps/third_party_auth/identityserver3.py index 95761f449633..47064c51f083 100644 --- a/common/djangoapps/third_party_auth/identityserver3.py +++ b/common/djangoapps/third_party_auth/identityserver3.py @@ -5,8 +5,8 @@ docs for adding a new backend to python-social-auth: https://python-social-auth.readthedocs.io/en/latest/backends/implementation.html#oauth """ -from social_core.backends.oauth import BaseOAuth2 from django.utils.functional import cached_property +from social_core.backends.oauth import BaseOAuth2 class IdentityServer3(BaseOAuth2): @@ -36,7 +36,7 @@ def user_data(self, access_token, *args, **kwargs): """ url = self.get_config().get_setting('user_info_url') # The access token returned from the service's token route. - header = {"Authorization": "Bearer %s" % access_token} + header = {"Authorization": "Bearer %s" % access_token} # noqa: UP031 return self.get_json(url, headers=header) def get_setting_if_exist(self, name, default): diff --git a/common/djangoapps/third_party_auth/lti.py b/common/djangoapps/third_party_auth/lti.py index 496b7dcbbbab..d49d6e1bbbd5 100644 --- a/common/djangoapps/third_party_auth/lti.py +++ b/common/djangoapps/third_party_auth/lti.py @@ -10,11 +10,11 @@ from django.contrib.auth import REDIRECT_FIELD_NAME from oauthlib.common import Request from oauthlib.oauth1.rfc5849.signature import ( - collect_parameters, - signature_base_string, base_string_uri, + collect_parameters, normalize_parameters, - sign_hmac_sha1 + sign_hmac_sha1, + signature_base_string, ) from social_core.backends.base import BaseAuth from social_core.exceptions import AuthFailed @@ -49,7 +49,7 @@ def start(self): # Set a auth_entry here so we don't have to receive that as a custom parameter self.strategy.session_setdefault('auth_entry', 'login') - if not validated_lti_params: # lint-amnesty, pylint: disable=no-else-raise + if not validated_lti_params: # pylint: disable=no-else-raise self.strategy.session_set(LTI_PARAMS_KEY, None) raise AuthFailed(self, "LTI parameters could not be validated.") else: diff --git a/common/djangoapps/third_party_auth/management/commands/generate_and_store_apple_transfer_ids.py b/common/djangoapps/third_party_auth/management/commands/generate_and_store_apple_transfer_ids.py index ec193ba8a422..3b99df684978 100644 --- a/common/djangoapps/third_party_auth/management/commands/generate_and_store_apple_transfer_ids.py +++ b/common/djangoapps/third_party_auth/management/commands/generate_and_store_apple_transfer_ids.py @@ -5,19 +5,18 @@ import logging -import requests import time +import jwt +import requests from django.core.management.base import BaseCommand, CommandError from django.db import transaction from django.db.models import Q -import jwt from social_django.models import UserSocialAuth from social_django.utils import load_strategy - -from common.djangoapps.third_party_auth.models import AppleMigrationUserIdInfo from common.djangoapps.third_party_auth.appleid import AppleIdAuth +from common.djangoapps.third_party_auth.models import AppleMigrationUserIdInfo log = logging.getLogger(__name__) diff --git a/common/djangoapps/third_party_auth/management/commands/generate_and_store_new_apple_ids.py b/common/djangoapps/third_party_auth/management/commands/generate_and_store_new_apple_ids.py index 49ed93441165..d33ec223b93d 100644 --- a/common/djangoapps/third_party_auth/management/commands/generate_and_store_new_apple_ids.py +++ b/common/djangoapps/third_party_auth/management/commands/generate_and_store_new_apple_ids.py @@ -5,17 +5,17 @@ import logging -import requests import time +import jwt +import requests from django.core.management.base import BaseCommand, CommandError from django.db import transaction from django.db.models import Q -import jwt from social_django.utils import load_strategy -from common.djangoapps.third_party_auth.models import AppleMigrationUserIdInfo from common.djangoapps.third_party_auth.appleid import AppleIdAuth +from common.djangoapps.third_party_auth.models import AppleMigrationUserIdInfo log = logging.getLogger(__name__) diff --git a/common/djangoapps/third_party_auth/management/commands/remove_social_auth_users.py b/common/djangoapps/third_party_auth/management/commands/remove_social_auth_users.py index 798816d4c190..251e6836e659 100644 --- a/common/djangoapps/third_party_auth/management/commands/remove_social_auth_users.py +++ b/common/djangoapps/third_party_auth/management/commands/remove_social_auth_users.py @@ -7,7 +7,7 @@ import logging from django.conf import settings -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.core.management.base import BaseCommand, CommandError from django.db import transaction @@ -44,7 +44,7 @@ def handle(self, *args, **options): try: SAMLProviderConfig.objects.current_set().get(slug=slug) except SAMLProviderConfig.DoesNotExist: - raise CommandError(f'No SAML provider found for slug {slug}') # lint-amnesty, pylint: disable=raise-missing-from + raise CommandError(f'No SAML provider found for slug {slug}') # pylint: disable=raise-missing-from # noqa: B904 users = User.objects.filter(social_auth__provider=slug) user_count = len(users) diff --git a/common/djangoapps/third_party_auth/management/commands/saml.py b/common/djangoapps/third_party_auth/management/commands/saml.py index 6865ebf69987..38f5cbdcc63e 100644 --- a/common/djangoapps/third_party_auth/management/commands/saml.py +++ b/common/djangoapps/third_party_auth/management/commands/saml.py @@ -7,8 +7,8 @@ from django.core.management.base import BaseCommand, CommandError +from common.djangoapps.third_party_auth.models import SAMLConfiguration, SAMLProviderConfig from common.djangoapps.third_party_auth.tasks import fetch_saml_metadata -from common.djangoapps.third_party_auth.models import SAMLProviderConfig, SAMLConfiguration class Command(BaseCommand): @@ -49,7 +49,7 @@ def _handle_pull_metadata(self): log.addHandler(log_handler) total, skipped, attempted, updated, failed, failure_messages = fetch_saml_metadata() self.stdout.write( - "\nDone." + "\nDone." # noqa: UP032 "\n{total} provider(s) found in database." "\n{skipped} skipped and {attempted} attempted." "\n{updated} updated and {failed} failed.\n".format( diff --git a/common/djangoapps/third_party_auth/management/commands/tests/test_generate_and_store_apple_transfer_ids.py b/common/djangoapps/third_party_auth/management/commands/tests/test_generate_and_store_apple_transfer_ids.py index e80b8069c913..a34dcca94edd 100644 --- a/common/djangoapps/third_party_auth/management/commands/tests/test_generate_and_store_apple_transfer_ids.py +++ b/common/djangoapps/third_party_auth/management/commands/tests/test_generate_and_store_apple_transfer_ids.py @@ -3,8 +3,8 @@ """ import json - from unittest import mock + from django.core.management import call_command from django.core.management.base import CommandError from django.test import TestCase @@ -54,7 +54,7 @@ def test_access_token_error(self, mock_generate_client_secret, mock_generate_acc mock_generate_access_token.return_value = None error_string = 'Failed to create access token.' - with self.assertRaisesRegex(CommandError, error_string): + with self.assertRaisesRegex(CommandError, error_string): # noqa: PT027 call_command(self.command, 'sample_team_id') @mock.patch('common.djangoapps.third_party_auth.management.commands.' @@ -72,14 +72,14 @@ def test_transfer_id_created(self, mock_post, mock_generate_client_secret, mock_ mock_generate_client_secret.return_value = 'sample_client_secret' mock_generate_access_token.return_value = 'sample_access_token' - self.assertEqual(0, AppleMigrationUserIdInfo.objects.all().count()) + self.assertEqual(0, AppleMigrationUserIdInfo.objects.all().count()) # noqa: PT009 with mock.patch.object(AppleIdAuth, 'name', self.slug): call_command(self.command, 'sample_team_id') - self.assertTrue(AppleMigrationUserIdInfo.objects.filter( + self.assertTrue(AppleMigrationUserIdInfo.objects.filter( # noqa: PT009 old_apple_id='sample_old_apple_id').exists()) expected_transfer_sub = 'sample_transfer_sub' actual_transfer_sub = AppleMigrationUserIdInfo.objects.filter( old_apple_id='sample_old_apple_id').first().transfer_id - self.assertEqual(expected_transfer_sub, actual_transfer_sub) + self.assertEqual(expected_transfer_sub, actual_transfer_sub) # noqa: PT009 diff --git a/common/djangoapps/third_party_auth/management/commands/tests/test_generate_and_store_new_apple_ids.py b/common/djangoapps/third_party_auth/management/commands/tests/test_generate_and_store_new_apple_ids.py index 2d79187215b2..f048ad643727 100644 --- a/common/djangoapps/third_party_auth/management/commands/tests/test_generate_and_store_new_apple_ids.py +++ b/common/djangoapps/third_party_auth/management/commands/tests/test_generate_and_store_new_apple_ids.py @@ -3,8 +3,8 @@ """ import json - from unittest import mock + from django.core.management import call_command from django.core.management.base import CommandError from django.test import TestCase @@ -61,7 +61,7 @@ def test_access_token_error(self, mock_generate_client_secret, mock_generate_acc mock_generate_access_token.return_value = None error_string = 'Failed to create access token.' - with self.assertRaisesRegex(CommandError, error_string): + with self.assertRaisesRegex(CommandError, error_string): # noqa: PT027 call_command(self.command) @mock.patch('common.djangoapps.third_party_auth.management.commands.' @@ -82,9 +82,9 @@ def test_new_apple_id_created(self, mock_post, mock_generate_client_secret, mock with mock.patch.object(AppleIdAuth, 'name', self.slug): call_command(self.command) - self.assertTrue(AppleMigrationUserIdInfo.objects.filter( + self.assertTrue(AppleMigrationUserIdInfo.objects.filter( # noqa: PT009 transfer_id='sample_transfer_sub').exists()) expected_new_apple_id = 'sample_new_apple_id' actual_new_apple_id = AppleMigrationUserIdInfo.objects.get( transfer_id='sample_transfer_sub').new_apple_id - self.assertEqual(expected_new_apple_id, actual_new_apple_id) + self.assertEqual(expected_new_apple_id, actual_new_apple_id) # noqa: PT009 diff --git a/common/djangoapps/third_party_auth/management/commands/tests/test_remove_social_auth_users.py b/common/djangoapps/third_party_auth/management/commands/tests/test_remove_social_auth_users.py index 8da9ed626573..f019db807480 100644 --- a/common/djangoapps/third_party_auth/management/commands/tests/test_remove_social_auth_users.py +++ b/common/djangoapps/third_party_auth/management/commands/tests/test_remove_social_auth_users.py @@ -47,7 +47,7 @@ def setUp(self): self.create_social_auth_entry(self.user_viktor, self.provider_durmstrang) @contextmanager - def _replace_stdin(self, text): # lint-amnesty, pylint: disable=missing-function-docstring + def _replace_stdin(self, text): # pylint: disable=missing-function-docstring orig = sys.stdin sys.stdin = StringIO(text) yield @@ -87,7 +87,7 @@ def test_remove_users(self): def test_invalid_idp(self): invalid_slug = 'jedi-academy' err_string = f'No SAML provider found for slug {invalid_slug}' - with self.assertRaisesRegex(CommandError, err_string): + with self.assertRaisesRegex(CommandError, err_string): # noqa: PT027 call_command(self.command, invalid_slug) @override_settings(FEATURES=FEATURES_WITH_ENABLED) @@ -104,7 +104,7 @@ def test_confirmation_required(self): @override_settings(FEATURES=FEATURES_WITH_ENABLED) def test_confirmation_failure(self): err_string = 'User confirmation required. No records have been modified' - with self.assertRaisesRegex(CommandError, err_string): + with self.assertRaisesRegex(CommandError, err_string): # noqa: PT027 with self._replace_stdin('no'): call_command(self.command, self.provider_hogwarts.slug) @@ -115,5 +115,5 @@ def test_confirmation_failure(self): def test_feature_default_disabled(self): """ By default this command should not be enabled """ err_string = 'ENABLE_ENROLLMENT_RESET feature not enabled on this enviroment' - with self.assertRaisesRegex(CommandError, err_string): + with self.assertRaisesRegex(CommandError, err_string): # noqa: PT027 call_command(self.command, self.provider_hogwarts.slug, force=True) diff --git a/common/djangoapps/third_party_auth/management/commands/tests/test_saml.py b/common/djangoapps/third_party_auth/management/commands/tests/test_saml.py index 625246d3212e..76c7a1743a27 100644 --- a/common/djangoapps/third_party_auth/management/commands/tests/test_saml.py +++ b/common/djangoapps/third_party_auth/management/commands/tests/test_saml.py @@ -6,8 +6,8 @@ import os from io import StringIO - from unittest import mock + from ddt import ddt from django.contrib.sites.models import Site from django.core.management import call_command @@ -15,8 +15,8 @@ from requests import exceptions from requests.models import Response -from openedx.core.djangolib.testing.utils import CacheIsolationTestCase, skip_unless_lms from common.djangoapps.third_party_auth.tests.factories import SAMLConfigurationFactory, SAMLProviderConfigFactory +from openedx.core.djangolib.testing.utils import CacheIsolationTestCase, skip_unless_lms def mock_get(status_code=200): @@ -27,7 +27,7 @@ def mock_get(status_code=200): Returns: returns a function that can be used as a mock function for requests.get. """ - def _(url=None, *args, **kwargs): # lint-amnesty, pylint: disable=keyword-arg-before-vararg, unused-argument + def _(url=None, *args, **kwargs): # pylint: disable=keyword-arg-before-vararg, unused-argument """ mock method for requests.get, this method will read xml file, form a Response object from the contents of this file, set status code and return the Response object. @@ -185,7 +185,7 @@ def test_fetch_saml_metadata_failure(self): expected = "\nDone.\n2 provider(s) found in database.\n1 skipped and 1 attempted.\n0 updated and 1 failed.\n" - with self.assertRaisesRegex(CommandError, r"HTTPError: 404 Client Error"): + with self.assertRaisesRegex(CommandError, r"HTTPError: 404 Client Error"): # noqa: PT027 call_command("saml", pull=True, stdout=self.stdout) assert expected in self.stdout.getvalue() @@ -230,7 +230,7 @@ def test_fetch_multiple_providers_data(self): ) expected = '\n4 provider(s) found in database.\n1 skipped and 3 attempted.\n2 updated and 1 failed.\n' - with self.assertRaisesRegex(CommandError, r"MetadataParseError: Can't find EntityDescriptor for entityID"): + with self.assertRaisesRegex(CommandError, r"MetadataParseError: Can't find EntityDescriptor for entityID"): # noqa: PT027 # pylint: disable=line-too-long call_command("saml", pull=True, stdout=self.stdout) assert expected in self.stdout.getvalue() @@ -253,7 +253,7 @@ def test_fetch_multiple_providers_data(self): # Four test configurations plus setUp -- two will be skipped and three attempted, with similar results. expected = '\nDone.\n5 provider(s) found in database.\n2 skipped and 3 attempted.\n0 updated and 1 failed.\n' - with self.assertRaisesRegex(CommandError, r"MetadataParseError: Can't find EntityDescriptor for entityID"): + with self.assertRaisesRegex(CommandError, r"MetadataParseError: Can't find EntityDescriptor for entityID"): # noqa: PT027 # pylint: disable=line-too-long call_command("saml", pull=True, stdout=self.stdout) assert expected in self.stdout.getvalue() @@ -269,19 +269,19 @@ def test_saml_request_exceptions(self, mocked_get): expected = "\nDone.\n2 provider(s) found in database.\n1 skipped and 1 attempted.\n0 updated and 1 failed.\n" - with self.assertRaisesRegex(CommandError, "SSLError:"): + with self.assertRaisesRegex(CommandError, "SSLError:"): # noqa: PT027 call_command("saml", pull=True, stdout=self.stdout) assert expected in self.stdout.getvalue() mocked_get.side_effect = exceptions.ConnectionError - with self.assertRaisesRegex(CommandError, "ConnectionError:"): + with self.assertRaisesRegex(CommandError, "ConnectionError:"): # noqa: PT027 call_command("saml", pull=True, stdout=self.stdout) assert expected in self.stdout.getvalue() mocked_get.side_effect = exceptions.HTTPError - with self.assertRaisesRegex(CommandError, "HTTPError:"): + with self.assertRaisesRegex(CommandError, "HTTPError:"): # noqa: PT027 call_command("saml", pull=True, stdout=self.stdout) assert expected in self.stdout.getvalue() @@ -306,7 +306,7 @@ def test_saml_parse_exceptions(self): expected = "\nDone.\n2 provider(s) found in database.\n1 skipped and 1 attempted.\n0 updated and 1 failed.\n" - with self.assertRaisesRegex(CommandError, "MetadataParseError: Can't find EntityDescriptor for entityID"): + with self.assertRaisesRegex(CommandError, "MetadataParseError: Can't find EntityDescriptor for entityID"): # noqa: PT027 # pylint: disable=line-too-long call_command("saml", pull=True, stdout=self.stdout) assert expected in self.stdout.getvalue() @@ -326,7 +326,7 @@ def test_xml_parse_exceptions(self, mocked_get): expected = "\nDone.\n2 provider(s) found in database.\n1 skipped and 1 attempted.\n0 updated and 1 failed.\n" - with self.assertRaisesRegex(CommandError, "XMLSyntaxError:"): + with self.assertRaisesRegex(CommandError, "XMLSyntaxError:"): # noqa: PT027 call_command("saml", pull=True, stdout=self.stdout) assert expected in self.stdout.getvalue() @@ -357,9 +357,9 @@ def test_run_checks_setup_test_data(self): f'site_id={self.provider_config.site_id}) ' f'has SAML config (id={self.saml_config.id}, enabled=False).' ) - self.assertIn(expected_warning, output) - self.assertIn('Missing configs: 0', output) # No missing configs from setUp - self.assertIn('Disabled configs: 1', output) # From setUp: provider_config with disabled saml_config + self.assertIn(expected_warning, output) # noqa: PT009 + self.assertIn('Missing configs: 0', output) # No missing configs from setUp # noqa: PT009 + self.assertIn('Disabled configs: 1', output) # From setUp: provider_config with disabled saml_config # noqa: PT009 # pylint: disable=line-too-long def test_run_checks_outdated_configs(self): """ @@ -375,10 +375,10 @@ def test_run_checks_outdated_configs(self): f'has outdated SAML config (id={old_config.id}) which should be updated to ' f'the current SAML config (id={new_config.id}).' ) - self.assertIn(expected_warning, output) - self.assertIn('Outdated: 1', output) + self.assertIn(expected_warning, output) # noqa: PT009 + self.assertIn('Outdated: 1', output) # noqa: PT009 # Total includes: 1 outdated + 2 disabled configs (setUp + test's old_config which is also disabled) - self.assertIn('Total issues requiring attention: 3', output) + self.assertIn('Total issues requiring attention: 3', output) # noqa: PT009 def test_run_checks_site_mismatches(self): """ @@ -403,10 +403,10 @@ def test_run_checks_site_mismatches(self): f'slug={provider.slug}, site_id={provider.site_id}) ' f'SAML config (id={config.id}, site_id={config.site_id}) does not match the provider\'s site_id.' ) - self.assertIn(expected_warning, output) - self.assertIn('Site mismatches: 1', output) + self.assertIn(expected_warning, output) # noqa: PT009 + self.assertIn('Site mismatches: 1', output) # noqa: PT009 # Total includes: 1 site mismatch + 1 disabled config (from setUp) - self.assertIn('Total issues requiring attention: 2', output) + self.assertIn('Total issues requiring attention: 2', output) # noqa: PT009 def test_run_checks_slug_mismatches(self): """ @@ -432,8 +432,8 @@ def test_run_checks_slug_mismatches(self): f'has SAML config (id={config.id}, slug=\'{config.slug}\') ' f'that does not match the provider\'s slug.' ) - self.assertIn(expected_info, output) - self.assertIn('Slug mismatches: 1', output) + self.assertIn(expected_info, output) # noqa: PT009 + self.assertIn('Slug mismatches: 1', output) # noqa: PT009 def test_run_checks_null_configurations(self): """ @@ -455,9 +455,9 @@ def test_run_checks_null_configurations(self): f'slug={provider.slug}, site_id={provider.site_id}) ' f'has no direct SAML configuration and no matching default configuration was found.' ) - self.assertIn(expected_warning, output) - self.assertIn('Missing configs: 1', output) # 1 from this test (provider with no config and no default) - self.assertIn('Disabled configs: 1', output) # 1 from setUp data + self.assertIn(expected_warning, output) # noqa: PT009 + self.assertIn('Missing configs: 1', output) # 1 from this test (provider with no config and no default) # noqa: PT009 # pylint: disable=line-too-long + self.assertIn('Disabled configs: 1', output) # 1 from setUp data # noqa: PT009 # pylint: disable=line-too-long def test_run_checks_null_config_id(self): """ @@ -489,21 +489,21 @@ def test_run_checks_null_config_id(self): f'has no direct SAML configuration and the default configuration ' f'(id={disabled_default_config.id}, enabled=False).' ) - self.assertIn(expected_warning, output) - self.assertIn('Missing configs: 0', output) # No missing configs since default config exists - self.assertIn('Disabled configs: 2', output) # 1 from this test + 1 from setUp data + self.assertIn(expected_warning, output) # noqa: PT009 + self.assertIn('Missing configs: 0', output) # No missing configs since default config exists # noqa: PT009 + self.assertIn('Disabled configs: 2', output) # 1 from this test + 1 from setUp data # noqa: PT009 def test_run_checks_with_default_config(self): """ Test the --run-checks command correctly handles providers with default configurations. """ - provider = SAMLProviderConfigFactory.create( + provider = SAMLProviderConfigFactory.create( # noqa: F841 site=self.site, slug='default-config-provider', saml_configuration=None ) - default_config = SAMLConfigurationFactory.create( + default_config = SAMLConfigurationFactory.create( # noqa: F841 site=self.site, slug='default', entity_id='https://default.example.com' @@ -511,14 +511,14 @@ def test_run_checks_with_default_config(self): output = self._run_checks_command() - self.assertIn('Missing configs: 0', output) # This tests provider has valid default config - self.assertIn('Disabled configs: 1', output) # From setUp + self.assertIn('Missing configs: 0', output) # This tests provider has valid default config # noqa: PT009 + self.assertIn('Disabled configs: 1', output) # From setUp # noqa: PT009 def test_run_checks_disabled_functionality(self): """ Test the --run-checks command handles disabled providers and configurations. """ - disabled_provider = SAMLProviderConfigFactory.create( + disabled_provider = SAMLProviderConfigFactory.create( # noqa: F841 site=self.site, slug='disabled-provider', enabled=False @@ -545,6 +545,6 @@ def test_run_checks_disabled_functionality(self): f'site_id={provider_with_disabled_config.site_id}) ' f'has SAML config (id={disabled_config.id}, enabled=False).' ) - self.assertIn(expected_warning, output) - self.assertIn('Missing configs: 1', output) # disabled_provider has no config - self.assertIn('Disabled configs: 2', output) # setUp's provider + provider_with_disabled_config + self.assertIn(expected_warning, output) # noqa: PT009 + self.assertIn('Missing configs: 1', output) # disabled_provider has no config # noqa: PT009 + self.assertIn('Disabled configs: 2', output) # setUp's provider + provider_with_disabled_config # noqa: PT009 diff --git a/common/djangoapps/third_party_auth/management/commands/tests/test_update_new_apple_ids_in_social_auth.py b/common/djangoapps/third_party_auth/management/commands/tests/test_update_new_apple_ids_in_social_auth.py index be8f31736dcd..f4eef40c7c27 100644 --- a/common/djangoapps/third_party_auth/management/commands/tests/test_update_new_apple_ids_in_social_auth.py +++ b/common/djangoapps/third_party_auth/management/commands/tests/test_update_new_apple_ids_in_social_auth.py @@ -3,6 +3,7 @@ """ from unittest import mock + from django.core.management import call_command from django.test import TestCase from social_django.models import UserSocialAuth @@ -50,11 +51,11 @@ def create_apple_migration_user_info_entry(self): ) def test_new_apple_id_updated_in_social_auth(self): - self.assertTrue(UserSocialAuth.objects.filter(uid='sample_old_apple_id', provider=self.slug).exists()) - self.assertFalse(UserSocialAuth.objects.filter(uid='sample_new_apple_id', provider=self.slug).exists()) + self.assertTrue(UserSocialAuth.objects.filter(uid='sample_old_apple_id', provider=self.slug).exists()) # noqa: PT009 # pylint: disable=line-too-long + self.assertFalse(UserSocialAuth.objects.filter(uid='sample_new_apple_id', provider=self.slug).exists()) # noqa: PT009 # pylint: disable=line-too-long with mock.patch.object(AppleIdAuth, 'name', self.slug): call_command(self.command) - self.assertTrue(UserSocialAuth.objects.filter(uid='sample_new_apple_id', provider=self.slug).exists()) - self.assertFalse(UserSocialAuth.objects.filter(uid='sample_old_apple_id', provider=self.slug).exists()) + self.assertTrue(UserSocialAuth.objects.filter(uid='sample_new_apple_id', provider=self.slug).exists()) # noqa: PT009 # pylint: disable=line-too-long + self.assertFalse(UserSocialAuth.objects.filter(uid='sample_old_apple_id', provider=self.slug).exists()) # noqa: PT009 # pylint: disable=line-too-long diff --git a/common/djangoapps/third_party_auth/management/commands/update_new_apple_ids_in_social_auth.py b/common/djangoapps/third_party_auth/management/commands/update_new_apple_ids_in_social_auth.py index 2d39fe83be7a..7d33cb462b68 100644 --- a/common/djangoapps/third_party_auth/management/commands/update_new_apple_ids_in_social_auth.py +++ b/common/djangoapps/third_party_auth/management/commands/update_new_apple_ids_in_social_auth.py @@ -9,8 +9,8 @@ from django.db.models import Q from social_django.models import UserSocialAuth -from common.djangoapps.third_party_auth.models import AppleMigrationUserIdInfo from common.djangoapps.third_party_auth.appleid import AppleIdAuth +from common.djangoapps.third_party_auth.models import AppleMigrationUserIdInfo log = logging.getLogger(__name__) diff --git a/common/djangoapps/third_party_auth/migrations/0001_squashed_0026_auto_20200401_1932.py b/common/djangoapps/third_party_auth/migrations/0001_squashed_0026_auto_20200401_1932.py index 6b2de4549c84..715eebd5cf87 100644 --- a/common/djangoapps/third_party_auth/migrations/0001_squashed_0026_auto_20200401_1932.py +++ b/common/djangoapps/third_party_auth/migrations/0001_squashed_0026_auto_20200401_1932.py @@ -1,8 +1,8 @@ # Generated by Django 2.2.12 on 2020-04-21 20:52 +import django.db.models.deletion from django.conf import settings from django.db import migrations, models -import django.db.models.deletion import openedx.core.lib.hash_utils from common.djangoapps.third_party_auth import models as third_party_auth_models diff --git a/common/djangoapps/third_party_auth/migrations/0004_auto_20200919_0955.py b/common/djangoapps/third_party_auth/migrations/0004_auto_20200919_0955.py index a397de017707..2a4574a17583 100644 --- a/common/djangoapps/third_party_auth/migrations/0004_auto_20200919_0955.py +++ b/common/djangoapps/third_party_auth/migrations/0004_auto_20200919_0955.py @@ -1,6 +1,7 @@ # Generated by Django 2.2.16 on 2020-09-19 09:55 from django.db import migrations, models + import openedx.core.lib.hash_utils diff --git a/common/djangoapps/third_party_auth/migrations/0009_historicalusersocialauth.py b/common/djangoapps/third_party_auth/migrations/0009_historicalusersocialauth.py index 5857822d1d42..6fed97266f9c 100644 --- a/common/djangoapps/third_party_auth/migrations/0009_historicalusersocialauth.py +++ b/common/djangoapps/third_party_auth/migrations/0009_historicalusersocialauth.py @@ -1,10 +1,10 @@ # Generated by Django 3.2.12 on 2022-04-15 01:04 -from django.conf import settings -from django.db import migrations, models import django.db.models.deletion import simple_history.models import social_django.fields +from django.conf import settings +from django.db import migrations, models class Migration(migrations.Migration): diff --git a/common/djangoapps/third_party_auth/migrations/0012_alter_ltiproviderconfig_site_and_more.py b/common/djangoapps/third_party_auth/migrations/0012_alter_ltiproviderconfig_site_and_more.py index ba9854b1fc2c..ca1037d122c0 100644 --- a/common/djangoapps/third_party_auth/migrations/0012_alter_ltiproviderconfig_site_and_more.py +++ b/common/djangoapps/third_party_auth/migrations/0012_alter_ltiproviderconfig_site_and_more.py @@ -1,7 +1,7 @@ # Generated by Django 4.2.5 on 2023-09-25 09:45 -from django.db import migrations, models import django.db.models.deletion +from django.db import migrations, models class Migration(migrations.Migration): diff --git a/common/djangoapps/third_party_auth/migrations/0013_default_site_id_wrapper_function.py b/common/djangoapps/third_party_auth/migrations/0013_default_site_id_wrapper_function.py index 250e5370854e..21223b8d5ff5 100644 --- a/common/djangoapps/third_party_auth/migrations/0013_default_site_id_wrapper_function.py +++ b/common/djangoapps/third_party_auth/migrations/0013_default_site_id_wrapper_function.py @@ -1,8 +1,9 @@ # Generated by Django 4.2.13 on 2024-05-13 19:22 -import common.djangoapps.third_party_auth.models -from django.db import migrations, models import django.db.models.deletion +from django.db import migrations, models + +import common.djangoapps.third_party_auth.models class Migration(migrations.Migration): diff --git a/common/djangoapps/third_party_auth/migrations/0014_samlproviderconfig_optional_email_checkboxes.py b/common/djangoapps/third_party_auth/migrations/0014_samlproviderconfig_optional_email_checkboxes.py new file mode 100644 index 000000000000..25bb88077f65 --- /dev/null +++ b/common/djangoapps/third_party_auth/migrations/0014_samlproviderconfig_optional_email_checkboxes.py @@ -0,0 +1,26 @@ +# Generated migration for adding optional checkbox skip configuration field + +import django.utils.translation +from django.db import migrations, models + + +class Migration(migrations.Migration): + + dependencies = [ + ('third_party_auth', '0013_default_site_id_wrapper_function'), + ] + + operations = [ + migrations.AddField( + model_name='samlproviderconfig', + name='skip_registration_optional_checkboxes', + field=models.BooleanField( + default=False, + help_text=django.utils.translation.gettext_lazy( + "If enabled, optional checkboxes (marketing emails opt-in, etc.) will not be rendered " + "on the registration form for users registering via this provider. When these checkboxes " + "are skipped, their values are inferred as False (opted out)." + ), + ), + ), + ] diff --git a/common/djangoapps/third_party_auth/models.py b/common/djangoapps/third_party_auth/models.py index ceab0fa8c711..5aaeb9885c1c 100644 --- a/common/djangoapps/third_party_auth/models.py +++ b/common/djangoapps/third_party_auth/models.py @@ -60,7 +60,7 @@ def clean_json(value, of_type): try: value_python = json.loads(value) except ValueError as err: - raise ValidationError(f"Invalid JSON: {err}") # lint-amnesty, pylint: disable=raise-missing-from + raise ValidationError(f"Invalid JSON: {err}") # pylint: disable=raise-missing-from # noqa: B904 if not isinstance(value_python, of_type): raise ValidationError(f"Expected a JSON {of_type}") return json.dumps(value_python, indent=4) @@ -237,6 +237,10 @@ class ProviderConfig(ConfigurationModel): help_text="Use the presence of a profile from a trusted third party as proof of identity verification.", ) + # Enterprise-only field: excludes this provider from the EnterpriseCustomer Django admin IDP + # dropdown. Added in ENT-1366 after social auth providers (Facebook, Google, etc.) were linked + # as enterprise IDPs, incorrectly associating all their users with an enterprise. Should ideally + # be migrated into the enterprise plugin. disable_for_enterprise_sso = models.BooleanField( default=False, verbose_name='Disabled for Enterprise TPA', @@ -425,7 +429,7 @@ def current(cls, *args): site. """ site_id = Site.objects.get_current(get_current_request()).id - return super(OAuth2ProviderConfig, cls).current(site_id, *args) + return super(OAuth2ProviderConfig, cls).current(site_id, *args) # noqa: UP008 @property def provider_id(self): @@ -540,7 +544,7 @@ def __str__(self): """ Return human-readable string representation. """ - return "SAMLConfiguration {site}: {slug} on {date:%Y-%m-%d %H:%M:%S}".format( + return "SAMLConfiguration {site}: {slug} on {date:%Y-%m-%d %H:%M:%S}".format( # noqa: UP032 site=self.site.name, slug=self.slug, date=self.change_date, @@ -745,6 +749,14 @@ class SAMLProviderConfig(ProviderConfig): "immediately after authenticating with the third party instead of the login page." ), ) + skip_registration_optional_checkboxes = models.BooleanField( + default=False, + help_text=_( + "If enabled, optional checkboxes (marketing emails opt-in, etc.) will not be rendered " + "on the registration form for users registering via this provider. When these checkboxes " + "are skipped, their values are inferred as False (opted out)." + ), + ) other_settings = models.TextField( verbose_name="Advanced settings", blank=True, help_text=( @@ -901,7 +913,7 @@ def get_config(self, backend): return idp_class(backend, self.slug, **conf) -class SAMLProviderData(models.Model): +class SAMLProviderData(models.Model): # noqa: DJ008 """ Data about a SAML IdP that is fetched automatically by 'manage.py saml pull' @@ -1049,15 +1061,19 @@ class AppleMigrationUserIdInfo(models.Model): """ Model to store users' Apple Unique Identifier during migration process of Apple team from edx Inc. to edx LLC. + + .. pii: Contains Apple user identifiers (old_apple_id, transfer_id, new_apple_id). + .. pii_types: external_service + .. pii_retirement: local_api """ old_apple_id = models.CharField(max_length=255) - transfer_id = models.CharField(max_length=255, null=True, blank=True) - new_apple_id = models.CharField(max_length=255, null=True, blank=True) + transfer_id = models.CharField(max_length=255, null=True, blank=True) # noqa: DJ001 + new_apple_id = models.CharField(max_length=255, null=True, blank=True) # noqa: DJ001 def __str__(self): return self.old_apple_id - class Meta: + class Meta: # noqa: DJ012 app_label = "third_party_auth" verbose_name = "Apple User Id Migration Info" verbose_name_plural = verbose_name diff --git a/common/djangoapps/third_party_auth/pipeline.py b/common/djangoapps/third_party_auth/pipeline.py index 4b8804ca3802..757075a61221 100644 --- a/common/djangoapps/third_party_auth/pipeline.py +++ b/common/djangoapps/third_party_auth/pipeline.py @@ -64,15 +64,15 @@ def B(*args, **kwargs): import json from collections import OrderedDict from logging import getLogger +from random import randint from smtplib import SMTPException from uuid import uuid4 -from random import randint import six import social_django from django.conf import settings -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user -from django.contrib.auth import logout, REDIRECT_FIELD_NAME +from django.contrib.auth import REDIRECT_FIELD_NAME, logout +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.core.mail.message import EmailMessage from django.http import HttpResponseBadRequest from django.shortcuts import redirect @@ -84,6 +84,13 @@ def B(*args, **kwargs): from common.djangoapps import third_party_auth from common.djangoapps.edxmako.shortcuts import render_to_string +from common.djangoapps.third_party_auth.utils import ( + get_associated_user_by_email_response, + is_oauth_provider, + user_exists, +) +from common.djangoapps.track import segment +from common.djangoapps.util.json_request import JsonResponse from lms.djangoapps.verify_student.models import SSOVerification from lms.djangoapps.verify_student.utils import earliest_allowed_verification_date from openedx.core.djangoapps.site_configuration import helpers as configuration_helpers @@ -92,17 +99,6 @@ def B(*args, **kwargs): from openedx.core.djangoapps.user_authn import cookies as user_authn_cookies from openedx.core.djangoapps.user_authn.toggles import is_auto_generated_username_enabled from openedx.core.djangoapps.user_authn.utils import is_safe_login_or_logout_redirect -from openedx.core.djangoapps.user_authn.views.utils import get_auto_generated_username -from common.djangoapps.third_party_auth.utils import ( - get_associated_user_by_email_response, - get_user_from_email, - is_enterprise_customer_user, - is_oauth_provider, - is_saml_provider, - user_exists, -) -from common.djangoapps.track import segment -from common.djangoapps.util.json_request import JsonResponse from . import provider @@ -143,7 +139,7 @@ def B(*args, **kwargs): def is_api(auth_entry): """Returns whether the auth entry point is via an API call.""" - return (auth_entry == AUTH_ENTRY_LOGIN_API) or (auth_entry == AUTH_ENTRY_REGISTER_API) # lint-amnesty, pylint: disable=consider-using-in + return (auth_entry == AUTH_ENTRY_LOGIN_API) or (auth_entry == AUTH_ENTRY_REGISTER_API) # pylint: disable=consider-using-in # URLs associated with auth entry points # These are used to request additional user information @@ -316,7 +312,7 @@ def _get_enabled_provider(provider_id): enabled_provider = provider.Registry.get(provider_id) if not enabled_provider: - raise ValueError('Provider %s not enabled' % provider_id) + raise ValueError('Provider %s not enabled' % provider_id) # noqa: UP031 return enabled_provider @@ -338,7 +334,7 @@ def _get_url(view_name, backend_name, auth_entry=None, redirect_url=None, if extra_params: query_params.update(extra_params) - return "{url}?{params}".format( + return "{url}?{params}".format( # noqa: UP032 url=url, params=six.moves.urllib.parse.urlencode(query_params) ) @@ -358,7 +354,7 @@ def get_complete_url(backend_name): ValueError: if no provider is enabled with the given backend_name. """ if not any(provider.Registry.get_enabled_by_backend_name(backend_name)): - raise ValueError('Provider with backend %s not enabled' % backend_name) + raise ValueError('Provider with backend %s not enabled' % backend_name) # noqa: UP031 return _get_url('social:complete', backend_name) @@ -558,7 +554,7 @@ def redirect_to_custom_form(request, auth_entry, details, kwargs): @partial.partial -def ensure_user_information(strategy, auth_entry, backend=None, user=None, social=None, current_partial=None, # lint-amnesty, pylint: disable=keyword-arg-before-vararg +def ensure_user_information(strategy, auth_entry, backend=None, user=None, social=None, current_partial=None, # pylint: disable=keyword-arg-before-vararg allow_inactive_user=False, details=None, *args, **kwargs): """ Ensure that we have the necessary information about a user (either an @@ -656,13 +652,13 @@ def is_provider_saml(): # register anew via SSO. See SOL-1324 in JIRA. # However, we will log a warning for this case: logger.warning( - '[THIRD_PARTY_AUTH] User is using third_party_auth to login but has not yet activated their account. ' + '[THIRD_PARTY_AUTH] User is using third_party_auth to login but has not yet activated their account. ' # noqa: UP032 # pylint: disable=line-too-long 'Username: {username}'.format(username=user.username) ) @partial.partial -def set_logged_in_cookies(backend=None, user=None, strategy=None, auth_entry=None, current_partial=None, # lint-amnesty, pylint: disable=keyword-arg-before-vararg +def set_logged_in_cookies(backend=None, user=None, strategy=None, auth_entry=None, current_partial=None, # pylint: disable=keyword-arg-before-vararg *args, **kwargs): """This pipeline step sets the "logged in" cookie for authenticated users. @@ -714,7 +710,7 @@ def set_logged_in_cookies(backend=None, user=None, strategy=None, auth_entry=Non @partial.partial -def login_analytics(strategy, auth_entry, current_partial=None, *args, **kwargs): # lint-amnesty, pylint: disable=keyword-arg-before-vararg +def login_analytics(strategy, auth_entry, current_partial=None, *args, **kwargs): # pylint: disable=keyword-arg-before-vararg """ Sends login info to Segment """ event_name = None @@ -743,7 +739,7 @@ def login_analytics(strategy, auth_entry, current_partial=None, *args, **kwargs) @partial.partial -def associate_by_email_if_login_api(auth_entry, backend, details, user, current_partial=None, *args, **kwargs): # lint-amnesty, pylint: disable=keyword-arg-before-vararg +def associate_by_email_if_login_api(auth_entry, backend, details, user, current_partial=None, *args, **kwargs): # pylint: disable=keyword-arg-before-vararg """ This pipeline step associates the current social auth with the user with the same email address in the database. It defers to the social library's associate_by_email @@ -781,83 +777,21 @@ def associate_by_email_if_oauth(auth_entry, backend, details, user, strategy, *a return association_response -@partial.partial def associate_by_email_if_saml(auth_entry, backend, details, user, strategy, *args, **kwargs): """ - This pipeline step associates the current social auth with the user with the - same email address in the database. It defers to the social library's associate_by_email - implementation, which verifies that only a single database user is associated with the email. + Deprecated — enterprise SAML email association moved to + enterprise.tpa_pipeline.enterprise_associate_by_email. - This association is done ONLY if the user entered the pipeline belongs to SAML provider. + Retained as a no-op for backwards compatibility with custom pipeline configs. """ - from openedx.features.enterprise_support.api import enterprise_is_enabled - - def get_user(): - """ - This is the helper method to get the user from system by matching email. - """ - user_details = {'email': details.get('email')} if details else None - return get_user_from_email(user_details or {}) - - @enterprise_is_enabled() - def associate_by_email_if_enterprise_user(): - """ - If the learner arriving via SAML is already linked to the enterprise customer linked to the same IdP, - they should not be prompted for their edX password. - """ - try: - enterprise_customer_user = is_enterprise_customer_user(current_provider.provider_id, current_user) - logger.info( - '[Multiple_SSO_SAML_Accounts_Association_to_User] Enterprise user verification:' - 'User Email: {email}, User ID: {user_id}, Provider ID: {provider_id},' - ' is_enterprise_customer_user: {enterprise_customer_user}'.format( - email=current_user.email, - user_id=current_user.id, - provider_id=current_provider.provider_id, - enterprise_customer_user=enterprise_customer_user, - ) - ) + logger.warning( + "associate_by_email_if_saml is deprecated and is now a no-op. " + "Enterprise SAML email association has moved to " + "enterprise.tpa_pipeline.enterprise_associate_by_email." + ) + - if enterprise_customer_user: - # this is python social auth pipeline default method to automatically associate social accounts - # if the email already matches a user account. - association_response, user_is_active = get_associated_user_by_email_response( - backend, details, user, *args, **kwargs) - - if not user_is_active: - logger.info( - '[Multiple_SSO_SAML_Accounts_Association_to_User] User association account is not' - ' active: User Email: {email}, User ID: {user_id}, Provider ID: {provider_id},' - ' is_enterprise_customer_user: {enterprise_customer_user}'.format( - email=current_user.email, - user_id=current_user.id, - provider_id=current_provider.provider_id, - enterprise_customer_user=enterprise_customer_user - ) - ) - return None - - return association_response - - except Exception as ex: # pylint: disable=broad-except - logger.exception('[Multiple_SSO_SAML_Accounts_Association_to_User] Error in' - ' saml multiple accounts association: User ID: %s, User Email: %s:,' - 'Provider ID: %s, Exception: %s', current_user.id, current_user.email, - current_provider.provider_id, ex) - - saml_provider, current_provider = is_saml_provider(strategy.request.backend.name, kwargs) - - if saml_provider: - # get the user by matching email if the pipeline user is not available. - current_user = user if user else get_user() - - # Verify that the user linked to enterprise customer of current identity provider and an active user - associate_response = associate_by_email_if_enterprise_user() if current_user else None - if associate_response: - return associate_response - - -def user_details_force_sync(auth_entry, strategy, details, user=None, *args, **kwargs): # lint-amnesty, pylint: disable=keyword-arg-before-vararg +def user_details_force_sync(auth_entry, strategy, details, user=None, *args, **kwargs): # pylint: disable=keyword-arg-before-vararg """ Update normally protected user details using data from provider. @@ -897,7 +831,7 @@ def user_details_force_sync(auth_entry, strategy, details, user=None, *args, **k current_value = getattr(model, field) if provider_value is not None and current_value != provider_value: if field in integrity_conflict_fields and User.objects.filter(**{field: provider_value}).exists(): - logger.warning('[THIRD_PARTY_AUTH] Profile data synchronization conflict. ' + logger.warning('[THIRD_PARTY_AUTH] Profile data synchronization conflict. ' # noqa: UP032 'UserId: {user_id}, Provider: {provider}, ConflictField: {conflict_field}, ' 'ConflictValue: {conflict_value}'.format( user_id=user.id, @@ -910,7 +844,7 @@ def user_details_force_sync(auth_entry, strategy, details, user=None, *args, **k if changed: logger.info( - '[THIRD_PARTY_AUTH] User performed SSO and data was synchronized. ' + '[THIRD_PARTY_AUTH] User performed SSO and data was synchronized. ' # noqa: UP032 'Username: {username}, Provider: {provider}, UpdatedKeys: {updated_keys}'.format( username=user.username, provider=current_provider.name, @@ -940,11 +874,11 @@ def user_details_force_sync(auth_entry, strategy, details, user=None, *args, **k try: email.send() except SMTPException: - logger.exception('[THIRD_PARTY_AUTH] Error sending IdP learner data sync-initiated email change ' + logger.exception('[THIRD_PARTY_AUTH] Error sending IdP learner data sync-initiated email change ' # noqa: UP032 # pylint: disable=line-too-long 'notification email. Username: {username}'.format(username=user.username)) -def set_id_verification_status(auth_entry, strategy, details, user=None, *args, **kwargs): # lint-amnesty, pylint: disable=keyword-arg-before-vararg +def set_id_verification_status(auth_entry, strategy, details, user=None, *args, **kwargs): # pylint: disable=keyword-arg-before-vararg """ Use the user's authentication with the provider, if configured, as evidence of their identity being verified. """ @@ -972,7 +906,7 @@ def set_id_verification_status(auth_entry, strategy, details, user=None, *args, verification.send_approval_signal(current_provider.slug) -def get_username(strategy, details, backend, user=None, *args, **kwargs): # lint-amnesty, pylint: disable=keyword-arg-before-vararg +def get_username(strategy, details, backend, user=None, *args, **kwargs): # pylint: disable=keyword-arg-before-vararg """ Copy of social_core.pipeline.user.get_username to achieve 1. additional logging @@ -1010,6 +944,8 @@ def get_username(strategy, details, backend, user=None, *args, **kwargs): # lin slug_func = lambda val: val if is_auto_generated_username_enabled() and details.get('username') is None: + # Lazy import to avoid circular dependency + from openedx.core.djangoapps.user_authn.views.utils import get_auto_generated_username username = get_auto_generated_username(details) else: if email_as_username and details.get('email'): diff --git a/common/djangoapps/third_party_auth/provider.py b/common/djangoapps/third_party_auth/provider.py index 5eaf0f1888de..e1eecf07ad92 100644 --- a/common/djangoapps/third_party_auth/provider.py +++ b/common/djangoapps/third_party_auth/provider.py @@ -5,8 +5,6 @@ from django.contrib.sites.models import Site -from openedx.core.djangoapps.theming.helpers import get_current_request - from common.djangoapps.third_party_auth.models import ( _LTI_BACKENDS, _PSA_OAUTH2_BACKENDS, @@ -14,8 +12,9 @@ LTIProviderConfig, OAuth2ProviderConfig, SAMLConfiguration, - SAMLProviderConfig + SAMLProviderConfig, ) +from openedx.core.djangoapps.theming.helpers import get_current_request class Registry: diff --git a/common/djangoapps/third_party_auth/saml.py b/common/djangoapps/third_party_auth/saml.py index ce5375ec95fb..572360e8e84e 100644 --- a/common/djangoapps/third_party_auth/saml.py +++ b/common/djangoapps/third_party_auth/saml.py @@ -8,15 +8,15 @@ import requests from django.contrib.sites.models import Site from django.http import Http404 -from django.utils.functional import cached_property from django.utils.datastructures import MultiValueDictKeyError +from django.utils.functional import cached_property from django_countries import countries from onelogin.saml2.settings import OneLogin_Saml2_Settings from social_core.backends.saml import OID_EDU_PERSON_ENTITLEMENT, SAMLAuth, SAMLIdentityProvider -from social_core.exceptions import AuthForbidden, AuthMissingParameter, AuthInvalidParameter +from social_core.exceptions import AuthForbidden, AuthInvalidParameter, AuthMissingParameter -from openedx.core.djangoapps.theming.helpers import get_current_request from common.djangoapps.third_party_auth.exceptions import IncorrectConfigurationException +from openedx.core.djangoapps.theming.helpers import get_current_request STANDARD_SAML_PROVIDER_KEY = 'standard_saml_provider' SAP_SUCCESSFACTORS_SAML_KEY = 'sap_success_factors' @@ -141,11 +141,22 @@ def auth_url(self): def disconnect(self, *args, **kwargs): """ - Override of SAMLAuth.disconnect to unlink the learner from enterprise customer if associated. + Override of SAMLAuth.disconnect to emit a signal when a user disconnects their SAML account. """ - from openedx.features.enterprise_support.api import unlink_enterprise_user_from_idp - user = kwargs.get('user', None) - unlink_enterprise_user_from_idp(self.strategy.request, user, self.name) + from common.djangoapps.third_party_auth.signals import SAMLAccountDisconnected + # Emit the signal before super().disconnect() so that handlers (e.g. enterprise + # user unlinking) run while the social auth record still exists. + user = kwargs['user'] # Upstream social_core always passes a non-None user. + log.info( + '[THIRD_PARTY_AUTH] Emitting SAMLAccountDisconnected signal for user_id=%s, backend=%s', + user.id, self.name, + ) + SAMLAccountDisconnected.send( + sender=self.__class__, + request=self.strategy.request, + user=user, + saml_backend=self, + ) return super().disconnect(*args, **kwargs) def _check_entitlements(self, idp, attributes): @@ -160,7 +171,7 @@ def _check_entitlements(self, idp, attributes): for expected in idp.conf['requiredEntitlements']: if expected not in entitlements: log.warning( - '[THIRD_PARTY_AUTH] SAML user rejected due to missing eduPersonEntitlement. ' + '[THIRD_PARTY_AUTH] SAML user rejected due to missing eduPersonEntitlement. ' # noqa: UP032 'Provider: {provider}, Entitlement: {entitlement}'.format( provider=idp.name, entitlement=expected) @@ -413,14 +424,14 @@ def invalid_configuration(self): if not all(var in self.conf for var in self.required_variables): missing = [var for var in self.required_variables if var not in self.conf] log.warning( - '[THIRD_PARTY_AUTH] To retrieve rich user data for a SAP SuccessFactors identity provider, ' + '[THIRD_PARTY_AUTH] To retrieve rich user data for a SAP SuccessFactors identity provider, ' # noqa: UP032 # pylint: disable=line-too-long 'the following keys in other_settings are required, but were missing. MissingKeys: {keys}'.format( keys=missing ) ) return missing - def log_bizx_api_exception(self, transaction_data, err): # lint-amnesty, pylint: disable=missing-function-docstring + def log_bizx_api_exception(self, transaction_data, err): # pylint: disable=missing-function-docstring try: sys_msg = err.response.content except AttributeError: @@ -514,7 +525,7 @@ def generate_bizx_oauth_api_access_token(self, user_id): return None return token_response.json() - def get_bizx_odata_api_client(self, user_id): # lint-amnesty, pylint: disable=missing-function-docstring + def get_bizx_odata_api_client(self, user_id): # pylint: disable=missing-function-docstring session = requests.Session() access_token_data = self.generate_bizx_oauth_api_access_token(user_id) if not access_token_data: @@ -537,7 +548,7 @@ def get_user_details(self, attributes): # endpoint_url is constructed from field_mappings setting of SAML Provider config. # We convert field_mappings to make comma separated list of the fields which needs to be pulled from BizX fields = ','.join(self.field_mappings) - endpoint_url = '{root_url}User(userId=\'{user_id}\')?$select={fields}'.format( + endpoint_url = '{root_url}User(userId=\'{user_id}\')?$select={fields}'.format( # noqa: UP032 root_url=self.odata_api_root_url, user_id=user_id, fields=fields, @@ -590,7 +601,7 @@ def get_saml_idp_class(idp_identifier_string): } if idp_identifier_string not in choices: log.error( - '[THIRD_PARTY_AUTH] Invalid EdXSAMLIdentityProvider subclass--' + '[THIRD_PARTY_AUTH] Invalid EdXSAMLIdentityProvider subclass--' # noqa: UP032 'using EdXSAMLIdentityProvider base class. Provider: {provider}'.format(provider=idp_identifier_string) ) return choices.get(idp_identifier_string, EdXSAMLIdentityProvider) diff --git a/common/djangoapps/third_party_auth/saml_configuration/tests/test_saml_configuration.py b/common/djangoapps/third_party_auth/saml_configuration/tests/test_saml_configuration.py index c2796d3c1676..341adace754d 100644 --- a/common/djangoapps/third_party_auth/saml_configuration/tests/test_saml_configuration.py +++ b/common/djangoapps/third_party_auth/saml_configuration/tests/test_saml_configuration.py @@ -1,14 +1,15 @@ """ Tests for SAMLConfiguration endpoints """ -from django.urls import reverse from django.contrib.sites.models import Site - +from django.urls import reverse from rest_framework import status from rest_framework.test import APITestCase + from common.djangoapps.student.tests.factories import UserFactory from common.djangoapps.third_party_auth.models import SAMLConfiguration from common.djangoapps.third_party_auth.tests.utils import skip_unless_thirdpartyauth + SAML_CONFIGURATIONS = [ { 'site': 1, diff --git a/common/djangoapps/third_party_auth/samlproviderconfig/serializers.py b/common/djangoapps/third_party_auth/samlproviderconfig/serializers.py index 4a01d0679c87..6380dfcc862e 100644 --- a/common/djangoapps/third_party_auth/samlproviderconfig/serializers.py +++ b/common/djangoapps/third_party_auth/samlproviderconfig/serializers.py @@ -3,14 +3,15 @@ """ import logging + from rest_framework import serializers -from common.djangoapps.third_party_auth.models import SAMLProviderConfig, SAMLConfiguration +from common.djangoapps.third_party_auth.models import SAMLConfiguration, SAMLProviderConfig log = logging.getLogger(__name__) -class SAMLProviderConfigSerializer(serializers.ModelSerializer): # lint-amnesty, pylint: disable=missing-class-docstring +class SAMLProviderConfigSerializer(serializers.ModelSerializer): # pylint: disable=missing-class-docstring saml_config_id = serializers.IntegerField(required=False) class Meta: diff --git a/common/djangoapps/third_party_auth/samlproviderconfig/tests/test_samlproviderconfig.py b/common/djangoapps/third_party_auth/samlproviderconfig/tests/test_samlproviderconfig.py deleted file mode 100644 index c8e8487b659d..000000000000 --- a/common/djangoapps/third_party_auth/samlproviderconfig/tests/test_samlproviderconfig.py +++ /dev/null @@ -1,382 +0,0 @@ -""" -Tests for SAMLProviderConfig endpoints -""" -import copy -import re -from uuid import uuid4 -from django.urls import reverse -from django.contrib.sites.models import Site -from django.utils.http import urlencode -from rest_framework import status -from rest_framework.test import APITestCase - -from enterprise.models import EnterpriseCustomerIdentityProvider, EnterpriseCustomer -from enterprise.constants import ENTERPRISE_ADMIN_ROLE, ENTERPRISE_LEARNER_ROLE -from common.djangoapps.student.tests.factories import UserFactory -from common.djangoapps.third_party_auth.tests.samlutils import set_jwt_cookie -from common.djangoapps.third_party_auth.models import SAMLProviderConfig, SAMLConfiguration -from common.djangoapps.third_party_auth.tests.utils import skip_unless_thirdpartyauth -from common.djangoapps.third_party_auth.utils import convert_saml_slug_provider_id - -# country here refers to the URN provided by a user's IDP -SINGLE_PROVIDER_CONFIG = { - 'entity_id': 'id', - 'metadata_source': 'http://test.url', - 'name': 'name-of-config', - 'enabled': 'true', - 'slug': 'test-slug', - 'country': 'https://example.customer.com/countrycode', - 'attr_first_name': 'jon', - 'attr_last_name': 'snow', -} - -SINGLE_PROVIDER_CONFIG_2 = copy.copy(SINGLE_PROVIDER_CONFIG) -SINGLE_PROVIDER_CONFIG_2['name'] = 'name-of-config-2' -SINGLE_PROVIDER_CONFIG_2['slug'] = 'test-slug-2' -SINGLE_PROVIDER_CONFIG_2['display_name'] = 'display-name' -SINGLE_PROVIDER_CONFIG_2['entity_id'] = 'id-2' - -SINGLE_PROVIDER_CONFIG_3 = copy.copy(SINGLE_PROVIDER_CONFIG) -SINGLE_PROVIDER_CONFIG_3['name'] = 'name-of-config-3' -SINGLE_PROVIDER_CONFIG_3['slug'] = 'test-slug-3' -SINGLE_PROVIDER_CONFIG_3['entity_id'] = 'id-3' - - -ENTERPRISE_ID = str(uuid4()) -ENTERPRISE_ID_NON_EXISTENT = str(uuid4()) - - -@skip_unless_thirdpartyauth() -class SAMLProviderConfigTests(APITestCase): - """ - API Tests for SAMLProviderConfig REST endpoints - The skip annotation above exists because we currently cannot run this test in - the cms mode in CI builds, where the third_party_auth application is not loaded - """ - @classmethod - def setUpTestData(cls): - super().setUpTestData() - cls.user = UserFactory.create(username='testuser', password='testpwd') - cls.site, _ = Site.objects.get_or_create(domain='example.com') - cls.enterprise_customer = EnterpriseCustomer.objects.create( - uuid=ENTERPRISE_ID, - name='test-ep', - slug='test-ep', - site=cls.site) - cls.samlproviderconfig, _ = SAMLProviderConfig.objects.get_or_create( - entity_id=SINGLE_PROVIDER_CONFIG['entity_id'], - metadata_source=SINGLE_PROVIDER_CONFIG['metadata_source'], - slug=SINGLE_PROVIDER_CONFIG['slug'], - country=SINGLE_PROVIDER_CONFIG['country'], - ) - cls.samlconfiguration, _ = SAMLConfiguration.objects.get_or_create( - enabled=True, - site=cls.site, - slug='edxSideTest', - ) - - def setUp(self): # pylint: disable=super-method-not-called - set_jwt_cookie(self.client, self.user, [(ENTERPRISE_ADMIN_ROLE, ENTERPRISE_ID)]) - self.client.force_authenticate(user=self.user) - - def test_get_one_config_by_enterprise_uuid_found(self): - """ - GET auth/saml/v0/provider_config/?enterprise_customer_uuid=id=id - """ - - # for GET to work, we need an association present - EnterpriseCustomerIdentityProvider.objects.get_or_create( - provider_id=convert_saml_slug_provider_id(self.samlproviderconfig.slug), - enterprise_customer_id=ENTERPRISE_ID - ) - urlbase = reverse('saml_provider_config-list') - query_kwargs = {'enterprise_customer_uuid': ENTERPRISE_ID} - url = f'{urlbase}?{urlencode(query_kwargs)}' - - response = self.client.get(url, format='json') - - assert response.status_code == status.HTTP_200_OK - results = response.data['results'] - assert len(results) == 1 - assert results[0]['entity_id'] == SINGLE_PROVIDER_CONFIG['entity_id'] - assert results[0]['metadata_source'] == SINGLE_PROVIDER_CONFIG['metadata_source'] - assert response.data['results'][0]['country'] == SINGLE_PROVIDER_CONFIG['country'] - assert re.match(r"test-slug-\d{4}", results[0]['display_name']) - assert SAMLProviderConfig.objects.count() == 1 - - def test_get_one_config_by_enterprise_uuid_invalid_uuid(self): - """ - GET auth/saml/v0/provider_config/?enterprise_customer_uuid=invalidUUID - """ - urlbase = reverse('saml_provider_config-list') - query_kwargs = {'enterprise_customer_uuid': 'invalid_uuid'} - url = f'{urlbase}?{urlencode(query_kwargs)}' - - response = self.client.get(url, format='json') - - assert response.status_code == status.HTTP_400_BAD_REQUEST - - def test_get_one_config_by_enterprise_uuid_not_found(self): - """ - GET auth/saml/v0/provider_config/?enterprise_customer_uuid=valid-but-nonexistent-uuid - """ - - # the user must actually be authorized for this enterprise - # since we are testing auth passes but association to samlproviderconfig is not found - set_jwt_cookie(self.client, self.user, [(ENTERPRISE_ADMIN_ROLE, ENTERPRISE_ID_NON_EXISTENT)]) - self.client.force_authenticate(user=self.user) - - urlbase = reverse('saml_provider_config-list') - query_kwargs = {'enterprise_customer_uuid': ENTERPRISE_ID_NON_EXISTENT} - url = f'{urlbase}?{urlencode(query_kwargs)}' - orig_count = SAMLProviderConfig.objects.count() - - response = self.client.get(url, format='json') - - assert response.status_code == status.HTTP_404_NOT_FOUND - assert SAMLProviderConfig.objects.count() == orig_count - - def test_create_one_config(self): - """ - POST auth/saml/v0/provider_config/ -d data - """ - url = reverse('saml_provider_config-list') - data = copy.copy(SINGLE_PROVIDER_CONFIG_2) - data['enterprise_customer_uuid'] = ENTERPRISE_ID - orig_count = SAMLProviderConfig.objects.count() - - response = self.client.post(url, data) - - assert response.status_code == status.HTTP_201_CREATED - assert SAMLProviderConfig.objects.count() == (orig_count + 1) - provider_config = SAMLProviderConfig.objects.get(slug=SINGLE_PROVIDER_CONFIG_2['slug']) - assert provider_config.name == 'name-of-config-2' - assert provider_config.country == SINGLE_PROVIDER_CONFIG_2['country'] - assert provider_config.attr_username == SINGLE_PROVIDER_CONFIG['attr_first_name'] - assert provider_config.display_name == SINGLE_PROVIDER_CONFIG_2['display_name'] - - # check association has also been created - assert EnterpriseCustomerIdentityProvider.objects.filter( - provider_id=convert_saml_slug_provider_id(provider_config.slug) - ).exists(), 'Cannot find EnterpriseCustomer-->SAMLProviderConfig association' - - def test_create_one_config_fail_non_existent_enterprise_uuid(self): - """ - POST auth/saml/v0/provider_config/ -d data - """ - url = reverse('saml_provider_config-list') - data = copy.copy(SINGLE_PROVIDER_CONFIG_2) - data['enterprise_customer_uuid'] = ENTERPRISE_ID_NON_EXISTENT - orig_count = SAMLProviderConfig.objects.count() - - response = self.client.post(url, data) - - assert response.status_code == status.HTTP_403_FORBIDDEN - assert SAMLProviderConfig.objects.count() == orig_count - - # check association has NOT been created - assert not EnterpriseCustomerIdentityProvider.objects.filter( - provider_id=convert_saml_slug_provider_id(SINGLE_PROVIDER_CONFIG_2['slug']) - ).exists(), 'Did not expect to find EnterpriseCustomer-->SAMLProviderConfig association' - - def test_create_one_config_with_absent_enterprise_uuid(self): - """ - POST auth/saml/v0/provider_config/ -d data - """ - url = reverse('saml_provider_config-list') - data = copy.copy(SINGLE_PROVIDER_CONFIG_2) - orig_count = SAMLProviderConfig.objects.count() - - response = self.client.post(url, data) - - assert response.status_code == status.HTTP_400_BAD_REQUEST - assert SAMLProviderConfig.objects.count() == orig_count - - def test_create_one_config_with_no_country_urn(self): - """ - POST auth/saml/v0/provider_config/ -d data - """ - url = reverse('saml_provider_config-list') - provider_config_no_country = { - 'entity_id': 'id2', - 'metadata_source': 'http://test.url', - 'name': 'name-of-config-no-country', - 'enabled': 'true', - 'slug': 'test-slug-none', - 'enterprise_customer_uuid': ENTERPRISE_ID, - } - - response = self.client.post(url, provider_config_no_country) - assert response.status_code == status.HTTP_201_CREATED - provider_config = SAMLProviderConfig.objects.get(slug='test-slug-none') - assert provider_config.country == '' - - def test_create_one_config_with_empty_country_urn(self): - """ - POST auth/saml/v0/provider_config/ -d data - """ - url = reverse('saml_provider_config-list') - provider_config_blank_country = { - 'entity_id': 'id-empty-country-urn', - 'metadata_source': 'http://test.url', - 'name': 'name-of-config-blank-country', - 'enabled': 'true', - 'slug': 'test-slug-empty', - 'enterprise_customer_uuid': ENTERPRISE_ID, - 'country': '', - } - - response = self.client.post(url, provider_config_blank_country) - assert response.status_code == status.HTTP_201_CREATED - provider_config = SAMLProviderConfig.objects.get(slug='test-slug-empty') - assert provider_config.country == '' - - def test_unauthenticated_request_is_forbidden(self): - self.client.logout() - urlbase = reverse('saml_provider_config-list') - query_kwargs = {'enterprise_customer_uuid': ENTERPRISE_ID} - url = f'{urlbase}?{urlencode(query_kwargs)}' - set_jwt_cookie(self.client, self.user, [(ENTERPRISE_LEARNER_ROLE, ENTERPRISE_ID)]) - response = self.client.get(url, format='json') - assert response.status_code == status.HTTP_403_FORBIDDEN - - self.client.logout() - set_jwt_cookie(self.client, self.user, [(ENTERPRISE_ADMIN_ROLE, ENTERPRISE_ID_NON_EXISTENT)]) - response = self.client.get(url, format='json') - assert response.status_code == status.HTTP_403_FORBIDDEN - - def test_create_one_config_with_samlconfiguration(self): - """ - POST auth/saml/v0/provider_config/ -d data - """ - url = reverse('saml_provider_config-list') - data = copy.copy(SINGLE_PROVIDER_CONFIG_3) - data['enterprise_customer_uuid'] = ENTERPRISE_ID - data['saml_config_id'] = self.samlconfiguration.id - - response = self.client.post(url, data) - - assert response.status_code == status.HTTP_201_CREATED - provider_config = SAMLProviderConfig.objects.get(slug=SINGLE_PROVIDER_CONFIG_3['slug']) - assert provider_config.saml_configuration == self.samlconfiguration - - def test_unique_entity_id_constraint_with_different_slug(self): - """ - Test that a config cannot be created with an entity ID if another config already exists with that entity ID and - a different slug - """ - with self.assertLogs() as ctx: - url = reverse('saml_provider_config-list') - data = copy.copy(SINGLE_PROVIDER_CONFIG) - data['enterprise_customer_uuid'] = ENTERPRISE_ID - data['slug'] = 'some-other-slug' - - response = self.client.post(url, data) - - # 7/21/22 : Disabling the exception on duplicate entity ID's because of existing data. - assert ctx.records[-2].msg == f"Entity ID: {data['entity_id']} already taken" - assert response.status_code == status.HTTP_201_CREATED - # assert response.status_code == status.HTTP_400_BAD_REQUEST - # assert len(SAMLProviderConfig.objects.all()) == 1 - # assert str(response.data.get('non_field_errors')[0]) == f"Entity ID: {data['entity_id']} already taken" - - def test_unique_entity_id_constraint_with_same_slug(self): - """ - Test that a config can be created/edited using the same entity ID as an existing config as long as it shares an - entity ID. - """ - url = reverse('saml_provider_config-list') - data = copy.copy(SINGLE_PROVIDER_CONFIG) - data['enterprise_customer_uuid'] = ENTERPRISE_ID - data['name'] = 'some-other-name' - - response = self.client.post(url, data) - assert response.status_code == status.HTTP_201_CREATED - assert len(SAMLProviderConfig.objects.all()) == 2 - assert response.data.get('name') == 'some-other-name' - - def test_api_deleting_provider_configs(self): - """ - Test deleting a provider config. - """ - EnterpriseCustomerIdentityProvider.objects.get_or_create( - provider_id=convert_saml_slug_provider_id(self.samlproviderconfig.slug), - enterprise_customer_id=ENTERPRISE_ID - ) - url = reverse('saml_provider_config-list') - data = {} - data['enterprise_customer_uuid'] = ENTERPRISE_ID - - response = self.client.delete( - url + f'{str(self.samlproviderconfig.id)}/?enterprise_customer_uuid={ENTERPRISE_ID}' - ) - assert response.status_code == status.HTTP_200_OK - assert len(SAMLProviderConfig.objects.all()) == 1 - assert SAMLProviderConfig.objects.first().archived - - def test_api_deleting_config_then_using_deleted_entity_id(self): - """ - Test deleting a config then creating a new config with the entity ID of the deleted config - """ - EnterpriseCustomerIdentityProvider.objects.get_or_create( - provider_id=convert_saml_slug_provider_id(self.samlproviderconfig.slug), - enterprise_customer_id=ENTERPRISE_ID - ) - url = reverse('saml_provider_config-list') - data = {} - data['enterprise_customer_uuid'] = ENTERPRISE_ID - - response = self.client.delete( - url + f'{str(self.samlproviderconfig.id)}/?enterprise_customer_uuid={ENTERPRISE_ID}' - ) - assert response.status_code == status.HTTP_200_OK - assert len(SAMLProviderConfig.objects.all()) == 1 - assert SAMLProviderConfig.objects.first().archived - - data = copy.copy(SINGLE_PROVIDER_CONFIG) - data['enterprise_customer_uuid'] = ENTERPRISE_ID - data['entity_id'] = SINGLE_PROVIDER_CONFIG['entity_id'] - data['slug'] = 'idk-something-else' - - response = self.client.post(url, data) - assert response.status_code == status.HTTP_201_CREATED - assert len(SAMLProviderConfig.objects.all()) == 2 - - def test_using_an_edited_configs_entity_id_after_deleting(self): - """ - Test that editing an existing config then removing it still allows new configs to use the deleted config's - entity ID - """ - EnterpriseCustomerIdentityProvider.objects.get_or_create( - provider_id=convert_saml_slug_provider_id(self.samlproviderconfig.slug), - enterprise_customer_id=ENTERPRISE_ID - ) - url = reverse('saml_provider_config-list') - - data = copy.copy(SINGLE_PROVIDER_CONFIG) - data['saml_config_id'] = self.samlconfiguration.id - data['name'] = 'a new name' - - response = self.client.patch( - url + f'{str(self.samlproviderconfig.id)}/?enterprise_customer_uuid={ENTERPRISE_ID}', - data, - ) - assert response.status_code == status.HTTP_200_OK - assert len(SAMLProviderConfig.objects.all()) == 2 - - data = {} - data['enterprise_customer_uuid'] = ENTERPRISE_ID - response = self.client.delete( - url + f'{str(response.data.get("id"))}/?enterprise_customer_uuid={ENTERPRISE_ID}' - ) - - assert response.status_code == status.HTTP_200_OK - assert len(SAMLProviderConfig.objects.all()) == 2 - - data = copy.copy(SINGLE_PROVIDER_CONFIG_3) - data['enterprise_customer_uuid'] = ENTERPRISE_ID - data['saml_config_id'] = self.samlconfiguration.id - - response = self.client.post(url, data) - assert response.status_code == status.HTTP_201_CREATED - assert len(SAMLProviderConfig.objects.all()) == 3 diff --git a/common/djangoapps/third_party_auth/samlproviderconfig/urls.py b/common/djangoapps/third_party_auth/samlproviderconfig/urls.py deleted file mode 100644 index e274a572d925..000000000000 --- a/common/djangoapps/third_party_auth/samlproviderconfig/urls.py +++ /dev/null @@ -1,11 +0,0 @@ -""" - Viewset for auth/saml/v0/providerconfig/ -""" - -from rest_framework import routers - -from .views import SAMLProviderConfigViewSet - -saml_provider_config_router = routers.DefaultRouter() -saml_provider_config_router.register(r'provider_config', SAMLProviderConfigViewSet, basename="saml_provider_config") -urlpatterns = saml_provider_config_router.urls diff --git a/common/djangoapps/third_party_auth/samlproviderconfig/views.py b/common/djangoapps/third_party_auth/samlproviderconfig/views.py deleted file mode 100644 index 7286402df5bd..000000000000 --- a/common/djangoapps/third_party_auth/samlproviderconfig/views.py +++ /dev/null @@ -1,135 +0,0 @@ -""" -Viewset for auth/saml/v0/samlproviderconfig -""" - -from django.shortcuts import get_list_or_404 -from django.db.utils import IntegrityError -from edx_rbac.mixins import PermissionRequiredMixin -from rest_framework import permissions, viewsets, status -from rest_framework.response import Response -from rest_framework.exceptions import ParseError, ValidationError - -from enterprise.models import EnterpriseCustomerIdentityProvider, EnterpriseCustomer -from common.djangoapps.third_party_auth.utils import validate_uuid4_string - -from ..models import SAMLProviderConfig -from .serializers import SAMLProviderConfigSerializer -from ..utils import convert_saml_slug_provider_id - - -class SAMLProviderMixin: - permission_classes = [permissions.IsAuthenticated] - serializer_class = SAMLProviderConfigSerializer - - -class SAMLProviderConfigViewSet(PermissionRequiredMixin, SAMLProviderMixin, viewsets.ModelViewSet): - """ - A View to handle SAMLProviderConfig CRUD - - Usage: - NOTE: Only the GET request requires a request parameter, otherwise pass the uuid as part - of the post body - - GET /auth/saml/v0/provider_config/?enterprise-id=uuid - POST /auth/saml/v0/provider_config/ -d postData (must contain 'enterprise_customer_uuid') - DELETE /auth/saml/v0/provider_config/:pk -d postData (must contain 'enterprise_customer_uuid') - PATCH /auth/saml/v0/provider_config/:pk -d postData (must contain 'enterprise_customer_uuid') - - permission_required refers to the Django permission name defined - in enterprise.rules. - The associated rule will allow edx-rbac to check if the EnterpriseCustomer - returned by the get_permission_object method here, can be - accessed by the user making this request (request.user) - Access is only allowed if the user has the system role - of 'ENTERPRISE_ADMIN' which is defined in enterprise.constants - """ - permission_required = 'enterprise.can_access_admin_dashboard' - - def get_queryset(self): - """ - Find and return the matching providerconfig for the given enterprise uuid - if an association exists in EnterpriseCustomerIdentityProvider model - """ - if self.requested_enterprise_uuid is None: - raise ParseError('Required enterprise_customer_uuid is missing') - enterprise_customer_idps = get_list_or_404( - EnterpriseCustomerIdentityProvider, - enterprise_customer__uuid=self.requested_enterprise_uuid - ) - slug_list = [idp.provider_id for idp in enterprise_customer_idps] - saml_config_ids = [ - config.id for config in SAMLProviderConfig.objects.current_set() if config.provider_id in slug_list - ] - return SAMLProviderConfig.objects.filter(id__in=saml_config_ids) - - def destroy(self, request, *args, **kwargs): - saml_provider_config = self.get_object() - config_id = saml_provider_config.id - provider_config_provider_id = saml_provider_config.provider_id - customer_uuid = self.requested_enterprise_uuid - try: - enterprise_customer = EnterpriseCustomer.objects.get(pk=customer_uuid) - except EnterpriseCustomer.DoesNotExist: - raise ValidationError(f'Enterprise customer not found at uuid: {customer_uuid}') # lint-amnesty, pylint: disable=raise-missing-from - - enterprise_saml_provider = EnterpriseCustomerIdentityProvider.objects.filter( - enterprise_customer=enterprise_customer, - provider_id=provider_config_provider_id, - ) - enterprise_saml_provider.delete() - SAMLProviderConfig.objects.filter(id=saml_provider_config.id).update(archived=True, enabled=False) - return Response(data=config_id, status=status.HTTP_200_OK) - - @property - def requested_enterprise_uuid(self): - """ - The enterprise customer uuid from request params or post body - """ - if self.request.method in ('POST', 'PUT'): - uuid_str = self.request.POST.get('enterprise_customer_uuid') - if uuid_str is None: - raise ParseError('Required enterprise_customer_uuid is missing') - return uuid_str - else: - uuid_str = self.request.query_params.get('enterprise_customer_uuid') - if validate_uuid4_string(uuid_str) is False: - raise ParseError('Invalid UUID enterprise_customer_id') - return uuid_str - - def get_permission_object(self): - """ - Retrieve an EnterpriseCustomer uuid to do auth against - Right now this is the same as from the request object - meaning that only users belonging to the same enterprise - can access these endpoints, we have to sort out the operator role use case - """ - return self.requested_enterprise_uuid - - def create(self, request, *args, **kwargs): - """ - Process POST /auth/saml/v0/provider_config/ {postData} - """ - - customer_uuid = self.requested_enterprise_uuid - try: - enterprise_customer = EnterpriseCustomer.objects.get(pk=customer_uuid) - except EnterpriseCustomer.DoesNotExist: - raise ValidationError(f'Enterprise customer not found at uuid: {customer_uuid}') # lint-amnesty, pylint: disable=raise-missing-from - - # Create the samlproviderconfig model first - try: - serializer = self.get_serializer(data=request.data) - serializer.is_valid(raise_exception=True) - self.perform_create(serializer) - except IntegrityError as exc: - return Response(str(exc), status=status.HTTP_400_BAD_REQUEST) - - # Associate the enterprise customer with the provider - association_obj = EnterpriseCustomerIdentityProvider( - enterprise_customer=enterprise_customer, - provider_id=convert_saml_slug_provider_id(serializer.data['slug']) - ) - association_obj.save() - - headers = self.get_success_headers(serializer.data) - return Response(serializer.data, status=status.HTTP_201_CREATED, headers=headers) diff --git a/common/djangoapps/third_party_auth/samlproviderdata/tests/test_samlproviderdata.py b/common/djangoapps/third_party_auth/samlproviderdata/tests/test_samlproviderdata.py deleted file mode 100644 index 7cc4003bc496..000000000000 --- a/common/djangoapps/third_party_auth/samlproviderdata/tests/test_samlproviderdata.py +++ /dev/null @@ -1,229 +0,0 @@ -# pylint: disable=missing-module-docstring -import copy -from datetime import datetime # lint-amnesty, pylint: disable=wrong-import-order -from unittest import mock -from uuid import uuid4 # lint-amnesty, pylint: disable=wrong-import-order -from zoneinfo import ZoneInfo - -from django.contrib.sites.models import Site -from django.urls import reverse -from django.utils.http import urlencode -from enterprise.constants import ENTERPRISE_ADMIN_ROLE, ENTERPRISE_LEARNER_ROLE -from enterprise.models import EnterpriseCustomer, EnterpriseCustomerIdentityProvider -from rest_framework import status -from rest_framework.test import APITestCase - -from common.djangoapps.student.tests.factories import UserFactory -from common.djangoapps.third_party_auth.models import SAMLProviderConfig, SAMLProviderData -from common.djangoapps.third_party_auth.tests.samlutils import set_jwt_cookie -from common.djangoapps.third_party_auth.tests.utils import skip_unless_thirdpartyauth -from common.djangoapps.third_party_auth.utils import convert_saml_slug_provider_id - -SINGLE_PROVIDER_CONFIG = { - 'entity_id': 'http://entity-id-1', - 'metadata_source': 'http://test.url', - 'name': 'name-of-config', - 'enabled': 'true', - 'slug': 'test-slug' -} - -# entity_id here matches that of the providerconfig, intentionally -# that allows this data entity to be found -SINGLE_PROVIDER_DATA = { - 'entity_id': 'http://entity-id-1', - 'sso_url': 'http://test.url', - 'public_key': 'a-key0Aid98', - 'fetched_at': datetime.now(ZoneInfo("UTC")).replace(microsecond=0) -} - -SINGLE_PROVIDER_DATA_2 = copy.copy(SINGLE_PROVIDER_DATA) -SINGLE_PROVIDER_DATA_2['entity_id'] = 'http://entity-id-2' -SINGLE_PROVIDER_DATA_2['sso_url'] = 'http://test2.url' - -ENTERPRISE_ID = str(uuid4()) -BAD_ENTERPRISE_ID = str(uuid4()) - - -@skip_unless_thirdpartyauth() -class SAMLProviderDataTests(APITestCase): - """ - API Tests for SAMLProviderConfig REST endpoints - """ - @classmethod - def setUpTestData(cls): - super().setUpTestData() - cls.user = UserFactory.create(username='testuser', password='testpwd') - cls.site, _ = Site.objects.get_or_create(domain='example.com') - cls.enterprise_customer = EnterpriseCustomer.objects.create( - uuid=ENTERPRISE_ID, - name='test-ep', - slug='test-ep', - site=cls.site) - cls.saml_provider_config, _ = SAMLProviderConfig.objects.get_or_create( - entity_id=SINGLE_PROVIDER_CONFIG['entity_id'], - metadata_source=SINGLE_PROVIDER_CONFIG['metadata_source'] - ) - # the entity_id here must match that of the saml_provider_config - cls.saml_provider_data, _ = SAMLProviderData.objects.get_or_create( - entity_id=SINGLE_PROVIDER_DATA['entity_id'], - sso_url=SINGLE_PROVIDER_DATA['sso_url'], - fetched_at=SINGLE_PROVIDER_DATA['fetched_at'] - ) - cls.enterprise_customer_idp, _ = EnterpriseCustomerIdentityProvider.objects.get_or_create( - provider_id=convert_saml_slug_provider_id(cls.saml_provider_config.slug), - enterprise_customer_id=ENTERPRISE_ID - ) - - def setUp(self): # pylint: disable=super-method-not-called - # a cookie with roles: [{enterprise_admin_role: ent_id}] will be - # needed to rbac to authorize access for this view - set_jwt_cookie(self.client, self.user, [(ENTERPRISE_ADMIN_ROLE, ENTERPRISE_ID)]) - self.client.force_authenticate(user=self.user) - - def test_get_one_provider_data_success(self): - # GET auth/saml/v0/providerdata/?enterprise_customer_uuid=id - url_base = reverse('saml_provider_data-list') - query_kwargs = {'enterprise_customer_uuid': ENTERPRISE_ID} - url = f'{url_base}?{urlencode(query_kwargs)}' - - response = self.client.get(url, format='json') - - assert response.status_code == status.HTTP_200_OK - results = response.data['results'] - assert len(results) == 1 - assert results[0]['sso_url'] == SINGLE_PROVIDER_DATA['sso_url'] - - def test_get_one_provider_data_with_pk_success(self): - # GET auth/saml/v0/providerdata//?enterprise_customer_uuid=id - url_base = reverse('saml_provider_data-list') - query_kwargs = {'enterprise_customer_uuid': ENTERPRISE_ID} - url = f'{url_base}{self.saml_provider_data.id}/?{urlencode(query_kwargs)}' - - response = self.client.get(url, format='json') - assert response.status_code == status.HTTP_200_OK - assert response.data.get('id') == self.saml_provider_data.id - assert response.data.get('entity_id') == self.saml_provider_data.entity_id - assert response.data.get('sso_url') == self.saml_provider_data.sso_url - assert response.data.get('public_key') == self.saml_provider_data.public_key - - def test_create_one_provider_data_success(self): - # POST auth/saml/v0/providerdata/ -d data - url = reverse('saml_provider_data-list') - data = copy.copy(SINGLE_PROVIDER_DATA_2) - data['enterprise_customer_uuid'] = ENTERPRISE_ID - orig_count = SAMLProviderData.objects.count() - - response = self.client.post(url, data) - - assert response.status_code == status.HTTP_201_CREATED - assert SAMLProviderData.objects.count() == (orig_count + 1) - assert SAMLProviderData.objects.get( - entity_id=SINGLE_PROVIDER_DATA_2['entity_id'] - ).sso_url == SINGLE_PROVIDER_DATA_2['sso_url'] - - def test_create_one_data_with_absent_enterprise_uuid(self): - """ - POST auth/saml/v0/provider_data/ -d data - """ - url = reverse('saml_provider_data-list') - data = copy.copy(SINGLE_PROVIDER_DATA_2) - orig_count = SAMLProviderData.objects.count() - - response = self.client.post(url, data) - - assert response.status_code == status.HTTP_400_BAD_REQUEST - assert SAMLProviderData.objects.count() == orig_count - - def test_patch_one_provider_data(self): - # PATCH auth/saml/v0/providerdata/ -d data - url = reverse('saml_provider_data-detail', kwargs={'pk': self.saml_provider_data.id}) - data = { - 'sso_url': 'http://new.url' - } - data['enterprise_customer_uuid'] = ENTERPRISE_ID - orig_count = SAMLProviderData.objects.count() - - response = self.client.patch(url, data) - - assert response.status_code == status.HTTP_200_OK - assert SAMLProviderData.objects.count() == orig_count - - # ensure only the sso_url was updated - fetched_provider_data = SAMLProviderData.objects.get(pk=self.saml_provider_data.id) - assert fetched_provider_data.sso_url == 'http://new.url' - assert fetched_provider_data.fetched_at == SINGLE_PROVIDER_DATA['fetched_at'] - assert fetched_provider_data.entity_id == SINGLE_PROVIDER_DATA['entity_id'] - - def test_delete_one_provider_data(self): - # DELETE auth/saml/v0/providerdata/ -d data - url_base = reverse('saml_provider_data-detail', kwargs={'pk': self.saml_provider_data.id}) - query_kwargs = {'enterprise_customer_uuid': ENTERPRISE_ID} - url = f'{url_base}?{urlencode(query_kwargs)}' - orig_count = SAMLProviderData.objects.count() - - response = self.client.delete(url) - - assert response.status_code == status.HTTP_204_NO_CONTENT - assert SAMLProviderData.objects.count() == (orig_count - 1) - - # ensure only the sso_url was updated - query_set_count = SAMLProviderData.objects.filter(pk=self.saml_provider_data.id).count() - assert query_set_count == 0 - - def test_get_one_provider_data_failure(self): - set_jwt_cookie(self.client, self.user, [(ENTERPRISE_ADMIN_ROLE, BAD_ENTERPRISE_ID)]) - self.client.force_authenticate(user=self.user) - url_base = reverse('saml_provider_data-list') - query_kwargs = {'enterprise_customer_uuid': BAD_ENTERPRISE_ID} - url = f'{url_base}?{urlencode(query_kwargs)}' - - response = self.client.get(url, format='json') - - assert response.status_code == status.HTTP_404_NOT_FOUND - - def test_unauthenticated_request_is_forbidden(self): - self.client.logout() - urlbase = reverse('saml_provider_data-list') - query_kwargs = {'enterprise_customer_uuid': ENTERPRISE_ID} - url = f'{urlbase}?{urlencode(query_kwargs)}' - set_jwt_cookie(self.client, self.user, [(ENTERPRISE_LEARNER_ROLE, ENTERPRISE_ID)]) - response = self.client.get(url, format='json') - assert response.status_code == status.HTTP_403_FORBIDDEN - - # manually running second case as DDT is having issues. - self.client.logout() - set_jwt_cookie(self.client, self.user, [(ENTERPRISE_ADMIN_ROLE, BAD_ENTERPRISE_ID)]) - response = self.client.get(url, format='json') - assert response.status_code == status.HTTP_403_FORBIDDEN - - @mock.patch('common.djangoapps.third_party_auth.samlproviderdata.views.fetch_metadata_xml') - @mock.patch('common.djangoapps.third_party_auth.samlproviderdata.views.parse_metadata_xml') - def test_sync_one_provider_data_success(self, mock_parse, mock_fetch): - """ - POST auth/saml/v0/provider_data/sync_provider_data -d data - """ - mock_fetch.return_value = 'tag' - public_key = ['askdjf;sakdjfs;adkfjas;dkfjas;dkfjas;dlkfj'] - sso_url = 'https://fake-test.id' - expires_at = datetime.now() - mock_parse.return_value = (public_key, sso_url, expires_at) - url = reverse('saml_provider_data-sync-provider-data') - data = { - 'entity_id': 'http://entity-id-1', - 'metadata_url': 'http://a-url', - 'enterprise_customer_uuid': ENTERPRISE_ID, - } - SAMLProviderData.objects.all().delete() - orig_count = SAMLProviderData.objects.count() - - response = self.client.post(url, data) - - assert response.status_code == status.HTTP_201_CREATED - assert response.data == " Created new record(s) for SAMLProviderData for entityID http://entity-id-1" - assert SAMLProviderData.objects.count() == orig_count + 1 - - # should only update this time - response = self.client.post(url, data) - assert response.status_code == status.HTTP_200_OK - assert response.data == (" Updated existing SAMLProviderData record(s) for entityID http://entity-id-1") - assert SAMLProviderData.objects.count() == orig_count + 1 diff --git a/common/djangoapps/third_party_auth/samlproviderdata/urls.py b/common/djangoapps/third_party_auth/samlproviderdata/urls.py deleted file mode 100644 index 18b908dc6f39..000000000000 --- a/common/djangoapps/third_party_auth/samlproviderdata/urls.py +++ /dev/null @@ -1,11 +0,0 @@ -""" - url mappings for auth/saml/v0/providerdata/ -""" - -from rest_framework import routers - -from .views import SAMLProviderDataViewSet - -saml_provider_data_router = routers.DefaultRouter() -saml_provider_data_router.register(r'provider_data', SAMLProviderDataViewSet, basename="saml_provider_data") -urlpatterns = saml_provider_data_router.urls diff --git a/common/djangoapps/third_party_auth/samlproviderdata/views.py b/common/djangoapps/third_party_auth/samlproviderdata/views.py deleted file mode 100644 index b5d044bd0498..000000000000 --- a/common/djangoapps/third_party_auth/samlproviderdata/views.py +++ /dev/null @@ -1,146 +0,0 @@ -""" - Viewset for auth/saml/v0/samlproviderdata -""" -from datetime import datetime -import logging -from requests.exceptions import SSLError, MissingSchema, HTTPError - -from django.http import Http404 -from django.shortcuts import get_object_or_404 -from edx_rbac.mixins import PermissionRequiredMixin -from enterprise.models import EnterpriseCustomerIdentityProvider -from rest_framework import permissions, status, viewsets -from rest_framework.decorators import action -from rest_framework.exceptions import ParseError -from rest_framework.response import Response - -from common.djangoapps.third_party_auth.utils import ( - convert_saml_slug_provider_id, - create_or_update_bulk_saml_provider_data, - fetch_metadata_xml, - parse_metadata_xml, - validate_uuid4_string -) - -from ..models import SAMLProviderConfig, SAMLProviderData -from .serializers import SAMLProviderDataSerializer - -log = logging.getLogger(__name__) - - -class SAMLProviderDataMixin: - permission_classes = [permissions.IsAuthenticated] - serializer_class = SAMLProviderDataSerializer - - -class SAMLProviderDataViewSet(PermissionRequiredMixin, SAMLProviderDataMixin, viewsets.ModelViewSet): - """ - A View to handle SAMLProviderData CRUD. - Uses the edx-rbac mixin PermissionRequiredMixin to apply enterprise authorization - - Usage: - NOTE: Only the GET request requires a request parameter, otherwise pass the uuid as part - of the post body - - GET /auth/saml/v0/provider_data/?enterprise-id=uuid - POST /auth/saml/v0/provider_data/ -d postData (must contain 'enterprise_customer_uuid') - DELETE /auth/saml/v0/provider_data/:pk -d postData (must contain 'enterprise_customer_uuid') - PATCH /auth/saml/v0/provider_data/:pk -d postData (must contain 'enterprise_customer_uuid') - POST /auth/saml/v0/provider_data/sync_provider_data (fetches metadata info from metadata url provided) - - """ - permission_required = 'enterprise.can_access_admin_dashboard' - - def get_queryset(self): - """ - Find and return the matching providerid for the given enterprise uuid - Note: There is no direct association between samlproviderdata and enterprisecustomer. - So we make that association in code via samlproviderdata > samlproviderconfig ( via entity_id ) - then, we fetch enterprisecustomer via samlproviderconfig > enterprisecustomer ( via association table ) - """ - if self.requested_enterprise_uuid is None: - raise ParseError('Required enterprise_customer_uuid is missing') - enterprise_customer_idp = get_object_or_404( - EnterpriseCustomerIdentityProvider, - enterprise_customer__uuid=self.requested_enterprise_uuid - ) - try: - saml_provider = SAMLProviderConfig.objects.current_set().get( - slug=convert_saml_slug_provider_id(enterprise_customer_idp.provider_id)) - except SAMLProviderConfig.DoesNotExist: - raise Http404('No matching SAML provider found.') # lint-amnesty, pylint: disable=raise-missing-from - provider_data_id = self.request.parser_context.get('kwargs').get('pk') - if provider_data_id: - return SAMLProviderData.objects.filter(id=provider_data_id) - return SAMLProviderData.objects.filter(entity_id=saml_provider.entity_id) - - @property - def requested_enterprise_uuid(self): - """ - The enterprise customer uuid from request params or post body - """ - if self.request.method in ('POST', 'PATCH'): - uuid_str = self.request.POST.get('enterprise_customer_uuid') - if uuid_str is None: - raise ParseError('Required enterprise_customer_uuid is missing') - return uuid_str - else: - uuid_str = self.request.query_params.get('enterprise_customer_uuid') - if validate_uuid4_string(uuid_str) is False: - raise ParseError('Invalid UUID enterprise_customer_id') - return uuid_str - - def get_permission_object(self): - """ - Retrieve an EnterpriseCustomer to do auth against - """ - return self.requested_enterprise_uuid - - @action(detail=False, methods=['post', 'put']) - def sync_provider_data(self, request): - """ - Creates or updates a SAMProviderData record using info fetched from remote SAML metadata - For now we will require entityID but in future we will enhance this to try and extract entityID - from the metadata file, and make entityId optional, and return error response if there are - multiple entityIDs listed so that the user can choose and retry with a specified entityID - """ - entity_id = request.POST.get('entity_id') - metadata_url = request.POST.get('metadata_url') - sso_url = request.POST.get('sso_url') - public_keys = request.POST.get('public_key') - if not entity_id: - return Response('entity_id is required', status.HTTP_400_BAD_REQUEST) - if not metadata_url and not (sso_url and public_keys): - return Response('either metadata_url or sso and public key are required', status.HTTP_400_BAD_REQUEST) - if metadata_url and (sso_url or public_keys): - return Response( - 'either metadata_url or sso and public key can be provided, not both', status.HTTP_400_BAD_REQUEST - ) - - if metadata_url: - # part 1: fetch information from remote metadata based on metadataUrl in samlproviderconfig - try: - xml = fetch_metadata_xml(metadata_url) - except (SSLError, MissingSchema, HTTPError) as ex: - msg = f'Could not verify provider metadata url. Exc type: {type(ex).__name__}' - log.warning(msg) - return Response(msg, status.HTTP_406_NOT_ACCEPTABLE) - - # part 2: create/update samlproviderdata - log.info("Processing IdP with entityID %s", entity_id) - public_keys, sso_url, expires_at = parse_metadata_xml(xml, entity_id) - else: - now = datetime.now() - expires_at = now.replace(year=now.year + 10) - changed = create_or_update_bulk_saml_provider_data(entity_id, public_keys, sso_url, expires_at) - if changed: - str_message = f" Created new record(s) for SAMLProviderData for entityID {entity_id}" - log.info(str_message) - response = str_message - http_status = status.HTTP_201_CREATED - else: - str_message = f" Updated existing SAMLProviderData record(s) for entityID {entity_id}" - log.info(str_message) - response = str_message - http_status = status.HTTP_200_OK - return Response(response, status=http_status) diff --git a/common/djangoapps/third_party_auth/settings.py b/common/djangoapps/third_party_auth/settings.py deleted file mode 100644 index 0aeb94fbd498..000000000000 --- a/common/djangoapps/third_party_auth/settings.py +++ /dev/null @@ -1,107 +0,0 @@ -"""Settings for the third-party auth module. - -The flow for settings registration is: - -The base settings file contains a boolean, ENABLE_THIRD_PARTY_AUTH, indicating -whether this module is enabled. startup.py probes the ENABLE_THIRD_PARTY_AUTH. -If true, it: - - a) loads this module. - b) calls apply_settings(), passing in the Django settings -""" - - -from django.conf import settings -from openedx.features.enterprise_support.api import insert_enterprise_pipeline_elements - - -def apply_settings(django_settings): - """Set provider-independent settings.""" - - # Whitelisted URL query parameters retrained in the pipeline session. - # Params not in this whitelist will be silently dropped. - django_settings.FIELDS_STORED_IN_SESSION = ['auth_entry', 'next'] - - # Inject exception middleware to make redirects fire. - django_settings.MIDDLEWARE.extend( - ['common.djangoapps.third_party_auth.middleware.ExceptionMiddleware'] - ) - - # Where to send the user if there's an error during social authentication - # and we cannot send them to a more specific URL - # (see middleware.ExceptionMiddleware). - django_settings.SOCIAL_AUTH_LOGIN_ERROR_URL = '/' - - # Where to send the user once social authentication is successful. - django_settings.SOCIAL_AUTH_LOGIN_REDIRECT_URL = '/dashboard' - - # Disable sanitizing of redirect urls in social-auth since the platform - # already does its own sanitization via the LOGIN_REDIRECT_WHITELIST setting. - django_settings.SOCIAL_AUTH_SANITIZE_REDIRECTS = False - - # Adding extra key value pair in the url query string for microsoft as per request - django_settings.SOCIAL_AUTH_AZUREAD_OAUTH2_AUTH_EXTRA_ARGUMENTS = {'msafed': 0} - - # Avoid default username check to allow non-ascii characters - django_settings.SOCIAL_AUTH_CLEAN_USERNAMES = not settings.FEATURES.get("ENABLE_UNICODE_USERNAME") - - # Inject our customized auth pipeline. All auth backends must work with - # this pipeline. - django_settings.SOCIAL_AUTH_PIPELINE = [ - 'common.djangoapps.third_party_auth.pipeline.parse_query_params', - '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', - 'common.djangoapps.third_party_auth.pipeline.associate_by_email_if_login_api', - 'common.djangoapps.third_party_auth.pipeline.associate_by_email_if_saml', - 'common.djangoapps.third_party_auth.pipeline.associate_by_email_if_oauth', - 'common.djangoapps.third_party_auth.pipeline.get_username', - 'common.djangoapps.third_party_auth.pipeline.set_pipeline_timeout', - 'common.djangoapps.third_party_auth.pipeline.ensure_user_information', - 'social_core.pipeline.user.create_user', - 'social_core.pipeline.social_auth.associate_user', - 'social_core.pipeline.social_auth.load_extra_data', - 'social_core.pipeline.user.user_details', - 'common.djangoapps.third_party_auth.pipeline.user_details_force_sync', - 'common.djangoapps.third_party_auth.pipeline.set_id_verification_status', - 'common.djangoapps.third_party_auth.pipeline.set_logged_in_cookies', - 'common.djangoapps.third_party_auth.pipeline.login_analytics', - 'common.djangoapps.third_party_auth.pipeline.ensure_redirect_url_is_safe', - ] - - # Add enterprise pipeline elements if the enterprise app is installed - insert_enterprise_pipeline_elements(django_settings.SOCIAL_AUTH_PIPELINE) - - # Required so that we can use unmodified PSA OAuth2 backends: - django_settings.SOCIAL_AUTH_STRATEGY = 'common.djangoapps.third_party_auth.strategy.ConfigurationModelStrategy' - - # We let the user specify their email address during signup. - django_settings.SOCIAL_AUTH_PROTECTED_USER_FIELDS = ['email'] - - # Disable exceptions by default for prod so you get redirect behavior - # instead of a Django error page. During development you may want to - # enable this when you want to get stack traces rather than redirections. - django_settings.SOCIAL_AUTH_RAISE_EXCEPTIONS = False - - # Clean username to make sure username is compatible with our system requirements - django_settings.SOCIAL_AUTH_CLEAN_USERNAME_FUNCTION = 'common.djangoapps.third_party_auth.models.clean_username' - - # Allow users to login using social auth even if their account is not verified yet - # This is required since we [ab]use django's 'is_active' flag to indicate verified - # accounts; without this set to True, python-social-auth won't allow us to link the - # user's account to the third party account during registration (since the user is - # not verified at that point). - # We also generally allow unverified third party auth users to login (see the logic - # in ensure_user_information in pipeline.py) because otherwise users who use social - # auth to register with an invalid email address can become "stuck". - # TODO: Remove the following if/when email validation is separated from the is_active flag. - django_settings.SOCIAL_AUTH_INACTIVE_USER_LOGIN = True - django_settings.SOCIAL_AUTH_INACTIVE_USER_URL = '/auth/inactive' - - # Context processors required under Django. - django_settings.SOCIAL_AUTH_UUID_LENGTH = 10 - django_settings.DEFAULT_TEMPLATE_ENGINE['OPTIONS']['context_processors'] += ( - 'social_django.context_processors.backends', - 'social_django.context_processors.login_redirect', - ) diff --git a/common/djangoapps/third_party_auth/signals/__init__.py b/common/djangoapps/third_party_auth/signals/__init__.py index cf255a847f6c..50b81f139d9a 100644 --- a/common/djangoapps/third_party_auth/signals/__init__.py +++ b/common/djangoapps/third_party_auth/signals/__init__.py @@ -1 +1,5 @@ -# Signal handlers for third_party_auth app +""" +Signals and signal handlers for third_party_auth app +""" + +from common.djangoapps.third_party_auth.signals.signals import SAMLAccountDisconnected # noqa: F401 diff --git a/common/djangoapps/third_party_auth/signals/signals.py b/common/djangoapps/third_party_auth/signals/signals.py new file mode 100644 index 000000000000..6925c9d896ab --- /dev/null +++ b/common/djangoapps/third_party_auth/signals/signals.py @@ -0,0 +1,12 @@ +""" +Signals defined by the third_party_auth app. +""" +from django.dispatch import Signal + +# Signal fired when a user disconnects a SAML account. +# +# Keyword arguments sent with this signal: +# request (HttpRequest): The HTTP request during which the disconnect occurred. +# user (User): The Django User disconnecting the social auth account. +# saml_backend (social_core.backends.saml.SAMLAuth): The SAMLAuth backend instance (has a ``name`` attribute). +SAMLAccountDisconnected = Signal() diff --git a/common/djangoapps/third_party_auth/signals/tests/test_handlers.py b/common/djangoapps/third_party_auth/signals/tests/test_handlers.py index a948dc5b8fc2..850e62fe7072 100644 --- a/common/djangoapps/third_party_auth/signals/tests/test_handlers.py +++ b/common/djangoapps/third_party_auth/signals/tests/test_handlers.py @@ -2,13 +2,15 @@ Tests for SAML configuration signal handlers. """ -import ddt from unittest import mock from unittest.mock import call -from django.test import TestCase + +import ddt from django.contrib.sites.models import Site -from common.djangoapps.third_party_auth.tests.factories import SAMLConfigurationFactory, SAMLProviderConfigFactory +from django.test import TestCase + from common.djangoapps.third_party_auth.models import SAMLProviderConfig +from common.djangoapps.third_party_auth.tests.factories import SAMLConfigurationFactory, SAMLProviderConfigFactory @ddt.ddt @@ -138,11 +140,11 @@ def test_saml_provider_config_updates(self, provider_site_id, provider_slug, if is_provider_updated: mock_set_custom_attribute.assert_any_call('saml_config_signal.updated_count', 1) - self.assertEqual(current_provider.saml_configuration_id, new_saml_config.id, + self.assertEqual(current_provider.saml_configuration_id, new_saml_config.id, # noqa: PT009 "Provider should be updated when signal SAML config matches") else: mock_set_custom_attribute.assert_any_call('saml_config_signal.updated_count', 0) - self.assertEqual(current_provider.saml_configuration_id, original_config_id, + self.assertEqual(current_provider.saml_configuration_id, original_config_id, # noqa: PT009 "Provider should NOT be updated when signal SAML config doesn't match") @ddt.data( @@ -164,18 +166,18 @@ def test_saml_provider_with_null_config_not_updated(self, provider_site_id, prov provider_site = self._get_site(provider_site_id) signal_saml_site = self._get_site(signal_saml_site_id) - null_provider = SAMLProviderConfigFactory( + null_provider = SAMLProviderConfigFactory( # noqa: F841 slug=provider_slug, site=provider_site, saml_configuration=None ) - new_saml_config = SAMLConfigurationFactory( + new_saml_config = SAMLConfigurationFactory( # noqa: F841 site=signal_saml_site, slug=signal_saml_slug, entity_id='https://new.example.com' ) current_provider = self._get_current_provider(provider_slug) - self.assertIsNone(current_provider.saml_configuration_id, + self.assertIsNone(current_provider.saml_configuration_id, # noqa: PT009 "Provider with NULL SAML config should never be updated") diff --git a/common/djangoapps/third_party_auth/tasks.py b/common/djangoapps/third_party_auth/tasks.py index 5778db4b7252..ad942814ae56 100644 --- a/common/djangoapps/third_party_auth/tasks.py +++ b/common/djangoapps/third_party_auth/tasks.py @@ -16,8 +16,10 @@ from common.djangoapps.third_party_auth.models import SAMLConfiguration, SAMLProviderConfig from common.djangoapps.third_party_auth.utils import ( MetadataParseError, + SAMLMetadataURLError, create_or_update_bulk_saml_provider_data, parse_metadata_xml, + validate_saml_metadata_url, ) log = logging.getLogger(__name__) @@ -74,16 +76,15 @@ def fetch_saml_metadata(): failure_messages = [] # We return the length of this array for num_failed for url, entity_ids in url_map.items(): try: + validate_saml_metadata_url(url) log.info("Fetching %s", url) - if not url.lower().startswith('https'): - log.warning("This SAML metadata URL is not secure! It should use HTTPS. (%s)", url) - response = requests.get(url, verify=True) # May raise HTTPError or SSLError or ConnectionError + response = requests.get(url, verify=True, timeout=30) # May raise HTTPError or SSLError or ConnectionError response.raise_for_status() # May raise an HTTPError try: parser = etree.XMLParser(remove_comments=True) xml = etree.fromstring(response.content, parser) - except etree.XMLSyntaxError: # lint-amnesty, pylint: disable=try-except-raise + except etree.XMLSyntaxError: # pylint: disable=try-except-raise raise # TODO: Can use OneLogin_Saml2_Utils to validate signed XML if anyone is using that @@ -96,7 +97,13 @@ def fetch_saml_metadata(): num_updated += 1 else: log.info(f"→ Updated existing SAMLProviderData. Nothing has changed for entityID {entity_id}") - except (exceptions.SSLError, exceptions.HTTPError, exceptions.RequestException, MetadataParseError) as error: + except ( + exceptions.SSLError, + exceptions.HTTPError, + exceptions.RequestException, + MetadataParseError, + SAMLMetadataURLError, + ) as error: # Catch and process exception in case of errors during fetching and processing saml metadata. # Here is a description of each exception. # SSLError is raised in case of errors caused by SSL (e.g. SSL cer verification failure etc.) @@ -119,7 +126,7 @@ def fetch_saml_metadata(): log.exception(str(error)) failure_messages.append( "XMLSyntaxError: {error_message}\nMetadata Source: {url}\nEntity IDs: \n{entity_ids}.".format( - error_message=str(error.error_log), # lint-amnesty, pylint: disable=no-member + error_message=str(error.error_log), # pylint: disable=no-member url=url, entity_ids="\n".join( [f"\t{count}: {item}" for count, item in enumerate(entity_ids, start=1)], diff --git a/common/djangoapps/third_party_auth/tests/data/saml_identity_provider_mock_data.py b/common/djangoapps/third_party_auth/tests/data/saml_identity_provider_mock_data.py index dc05b549e23b..3632badc854a 100644 --- a/common/djangoapps/third_party_auth/tests/data/saml_identity_provider_mock_data.py +++ b/common/djangoapps/third_party_auth/tests/data/saml_identity_provider_mock_data.py @@ -1,7 +1,7 @@ """Mock data for SAMLIdentityProvider""" -from social_core.backends.saml import OID_MAIL, OID_GIVEN_NAME, OID_SURNAME, OID_COMMON_NAME, OID_USERID +from social_core.backends.saml import OID_COMMON_NAME, OID_GIVEN_NAME, OID_MAIL, OID_SURNAME, OID_USERID expected_user_details = { 'username': 'myself', diff --git a/common/djangoapps/third_party_auth/tests/factories.py b/common/djangoapps/third_party_auth/tests/factories.py index b47da33d81e2..58acf574c1d8 100644 --- a/common/djangoapps/third_party_auth/tests/factories.py +++ b/common/djangoapps/third_party_auth/tests/factories.py @@ -7,9 +7,7 @@ from factory.django import DjangoModelFactory from faker import Factory as FakerFactory -from common.djangoapps.third_party_auth.models import ( - OAuth2ProviderConfig, SAMLConfiguration, SAMLProviderConfig -) +from common.djangoapps.third_party_auth.models import OAuth2ProviderConfig, SAMLConfiguration, SAMLProviderConfig from openedx.core.djangoapps.site_configuration.tests.factories import SiteFactory FAKER = FakerFactory.create() diff --git a/common/djangoapps/third_party_auth/tests/specs/base.py b/common/djangoapps/third_party_auth/tests/specs/base.py index 524cd64ff366..739806569963 100644 --- a/common/djangoapps/third_party_auth/tests/specs/base.py +++ b/common/djangoapps/third_party_auth/tests/specs/base.py @@ -9,29 +9,28 @@ import pytest from django import test -from django.conf import settings +from django.conf import settings # pylint: disable=reimported +from django.conf import settings as django_settings # pylint: disable=reimported from django.contrib import auth, messages from django.contrib.auth import models as auth_models from django.contrib.messages.storage import fallback from django.contrib.sessions.backends import cache -from django.urls import reverse from django.test import utils as django_utils -from django.conf import settings as django_settings # lint-amnesty, pylint: disable=reimported +from django.urls import reverse from social_core import actions, exceptions from social_django import utils as social_utils from social_django import views as social_views -from lms.djangoapps.commerce.tests import TEST_API_URL -from openedx.core.djangoapps.user_authn.views.login import login_user -from openedx.core.djangoapps.user_authn.views.login_form import login_and_registration_form -from openedx.core.djangoapps.user_authn.views.register import RegistrationView -from openedx.core.djangoapps.site_configuration import helpers as configuration_helpers -from openedx.core.djangoapps.site_configuration.tests.factories import SiteFactory from common.djangoapps.student import models as student_models from common.djangoapps.student.tests.factories import UserFactory - from common.djangoapps.third_party_auth import middleware, pipeline from common.djangoapps.third_party_auth.tests import testutil +from lms.djangoapps.commerce.tests import TEST_API_URL +from openedx.core.djangoapps.site_configuration import helpers as configuration_helpers +from openedx.core.djangoapps.site_configuration.tests.factories import SiteFactory +from openedx.core.djangoapps.user_authn.views.login import login_user +from openedx.core.djangoapps.user_authn.views.login_form import login_and_registration_form +from openedx.core.djangoapps.user_authn.views.register import RegistrationView def create_account(request): @@ -72,7 +71,7 @@ def assert_redirect_to_provider_looks_correct(self, response): def assert_register_response_in_pipeline_looks_correct( self, response, pipeline_kwargs, required_fields - ): # lint-amnesty, pylint: disable=invalid-name + ): # pylint: disable=invalid-name """Performs spot checks of the rendered register.html page. When we display the new account registration form after the user signs @@ -139,7 +138,7 @@ def assert_third_party_accounts_state(self, request, duplicate=False, linked=Non def assert_register_form_populates_unicode_username_correctly( self, request - ): # lint-amnesty, pylint: disable=invalid-name + ): # pylint: disable=invalid-name """ Check the registration form username field behaviour with unicode values. @@ -604,7 +603,7 @@ def test_canceling_authentication_redirects_to_root_when_auth_entry_not_set(self self.assert_exception_redirect_looks_correct("/") @mock.patch("common.djangoapps.third_party_auth.pipeline.segment.track") - def test_full_pipeline_succeeds_for_linking_account(self, _mock_segment_track): + def test_full_pipeline_succeeds_for_linking_account(self, _mock_segment_track): # noqa: PT019 # First, create, the GET request and strategy that store pipeline state, # configure the backend, and mock out wire traffic. get_request, strategy = self.get_request_and_strategy( @@ -772,7 +771,7 @@ def test_already_associated_exception_populates_dashboard_with_error(self): self.assert_third_party_accounts_state(post_request, duplicate=True, linked=True) @mock.patch("common.djangoapps.third_party_auth.pipeline.segment.track") - def test_full_pipeline_succeeds_for_signing_in_to_existing_active_account(self, _mock_segment_track): + def test_full_pipeline_succeeds_for_signing_in_to_existing_active_account(self, _mock_segment_track): # noqa: PT019 # First, create, the GET request and strategy that store pipeline state, # configure the backend, and mock out wire traffic. get_request, strategy = self.get_request_and_strategy( @@ -1140,7 +1139,7 @@ def do_complete(self, strategy, request, partial_pipeline_token, partial_data, u # pylint: disable=abstract-method @django_utils.override_settings(ECOMMERCE_API_URL=TEST_API_URL) -class Oauth2IntegrationTest(IntegrationTest): # lint-amnesty, pylint: disable=test-inherits-tests +class Oauth2IntegrationTest(IntegrationTest): # pylint: disable=test-inherits-tests """Base test case for integration tests of Oauth2 providers.""" # Dict of string -> object. Information about the token granted to the diff --git a/common/djangoapps/third_party_auth/tests/specs/test_azuread.py b/common/djangoapps/third_party_auth/tests/specs/test_azuread.py index 283cbc521da7..a1cbfb4cc806 100644 --- a/common/djangoapps/third_party_auth/tests/specs/test_azuread.py +++ b/common/djangoapps/third_party_auth/tests/specs/test_azuread.py @@ -4,7 +4,7 @@ from common.djangoapps.third_party_auth.tests.specs import base -class AzureADOauth2IntegrationTest(base.Oauth2IntegrationTest): # lint-amnesty, pylint: disable=test-inherits-tests +class AzureADOauth2IntegrationTest(base.Oauth2IntegrationTest): # pylint: disable=test-inherits-tests """Integration tests for Azure Active Directory / Microsoft Account provider.""" PROVIDER_NAME = "azure" diff --git a/common/djangoapps/third_party_auth/tests/specs/test_generic.py b/common/djangoapps/third_party_auth/tests/specs/test_generic.py index b9a41914e9e3..cb82c780c1d9 100644 --- a/common/djangoapps/third_party_auth/tests/specs/test_generic.py +++ b/common/djangoapps/third_party_auth/tests/specs/test_generic.py @@ -3,6 +3,7 @@ """ from common.djangoapps.third_party_auth.tests import testutil from common.djangoapps.third_party_auth.tests.utils import skip_unless_thirdpartyauth + from .base import IntegrationTestMixin diff --git a/common/djangoapps/third_party_auth/tests/specs/test_google.py b/common/djangoapps/third_party_auth/tests/specs/test_google.py index 0592f50734a7..05a065600f04 100644 --- a/common/djangoapps/third_party_auth/tests/specs/test_google.py +++ b/common/djangoapps/third_party_auth/tests/specs/test_google.py @@ -16,7 +16,7 @@ from common.djangoapps.third_party_auth.tests.specs import base -class GoogleOauth2IntegrationTest(base.Oauth2IntegrationTest): # lint-amnesty, pylint: disable=test-inherits-tests +class GoogleOauth2IntegrationTest(base.Oauth2IntegrationTest): # pylint: disable=test-inherits-tests """Integration tests for provider.GoogleOauth2.""" PROVIDER_NAME = "google" diff --git a/common/djangoapps/third_party_auth/tests/specs/test_linkedin.py b/common/djangoapps/third_party_auth/tests/specs/test_linkedin.py index f8184cd109c8..9d2818d7dccd 100644 --- a/common/djangoapps/third_party_auth/tests/specs/test_linkedin.py +++ b/common/djangoapps/third_party_auth/tests/specs/test_linkedin.py @@ -13,7 +13,7 @@ def get_localized_name(name): return name['localized'].get(locale, '') -class LinkedInOauth2IntegrationTest(base.Oauth2IntegrationTest): # lint-amnesty, pylint: disable=test-inherits-tests +class LinkedInOauth2IntegrationTest(base.Oauth2IntegrationTest): # pylint: disable=test-inherits-tests """Integration tests for provider.LinkedInOauth2.""" PROVIDER_NAME = "linkedin" diff --git a/common/djangoapps/third_party_auth/tests/specs/test_lti.py b/common/djangoapps/third_party_auth/tests/specs/test_lti.py index 9b7935e550e6..dccdea50e5c7 100644 --- a/common/djangoapps/third_party_auth/tests/specs/test_lti.py +++ b/common/djangoapps/third_party_auth/tests/specs/test_lti.py @@ -2,9 +2,9 @@ Integration tests for third_party_auth LTI auth providers """ -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.urls import reverse -from oauthlib.oauth1.rfc5849 import Client, SIGNATURE_TYPE_BODY +from oauthlib.oauth1.rfc5849 import SIGNATURE_TYPE_BODY, Client from common.djangoapps.third_party_auth.tests import testutil from openedx.core.djangolib.testing.utils import skip_unless_lms diff --git a/common/djangoapps/third_party_auth/tests/specs/test_testshib.py b/common/djangoapps/third_party_auth/tests/specs/test_testshib.py index 47fcfa5b0bac..eddc4dd9c514 100644 --- a/common/djangoapps/third_party_auth/tests/specs/test_testshib.py +++ b/common/djangoapps/third_party_auth/tests/specs/test_testshib.py @@ -8,12 +8,11 @@ import os from unittest import skip from unittest.mock import MagicMock, patch +from urllib.parse import parse_qs, quote, urlparse import ddt import httpretty -from django.conf import settings from django.contrib import auth -from enterprise.models import EnterpriseCustomerIdentityProvider, EnterpriseCustomerUser from freezegun import freeze_time from social_core import actions from social_django import views as social_views @@ -24,14 +23,13 @@ from common.djangoapps.third_party_auth.exceptions import IncorrectConfigurationException from common.djangoapps.third_party_auth.saml import SapSuccessFactorsIdentityProvider from common.djangoapps.third_party_auth.saml import log as saml_log +from common.djangoapps.third_party_auth.signals import SAMLAccountDisconnected from common.djangoapps.third_party_auth.tasks import fetch_saml_metadata from common.djangoapps.third_party_auth.tests import testutil, utils +from common.test.utils import assert_dict_contains_subset from openedx.core.djangoapps.user_authn.views.login import login_user -from openedx.features.enterprise_support.tests.factories import EnterpriseCustomerFactory from .base import IntegrationTestMixin -from common.test.utils import assert_dict_contains_subset -from urllib.parse import urlparse, parse_qs, quote TESTSHIB_ENTITY_ID = "https://idp.testshib.org/idp/shibboleth" TESTSHIB_METADATA_URL = "https://mock.testshib.org/metadata/testshib-providers.xml" @@ -55,17 +53,17 @@ class SamlIntegrationTestUtilities: USER_USERNAME = "myself" def setUp(self): - super().setUp() # lint-amnesty, pylint: disable=no-member, super-with-arguments - self.enable_saml( # lint-amnesty, pylint: disable=no-member - private_key=self._get_private_key(), # lint-amnesty, pylint: disable=no-member - public_key=self._get_public_key(), # lint-amnesty, pylint: disable=no-member + super().setUp() # pylint: disable=no-member, super-with-arguments + self.enable_saml( # pylint: disable=no-member + private_key=self._get_private_key(), # pylint: disable=no-member + public_key=self._get_public_key(), # pylint: disable=no-member entity_id="https://saml.example.none", ) # Mock out HTTP requests that may be made to TestShib: httpretty.enable() httpretty.reset() - self.addCleanup(httpretty.reset) # lint-amnesty, pylint: disable=no-member - self.addCleanup(httpretty.disable) # lint-amnesty, pylint: disable=no-member + self.addCleanup(httpretty.reset) # pylint: disable=no-member + self.addCleanup(httpretty.disable) # pylint: disable=no-member def metadata_callback(_request, _uri, headers): """Return a cached copy of TestShib's metadata by reading it from disk""" @@ -73,7 +71,7 @@ def metadata_callback(_request, _uri, headers): 200, headers, self.read_data_file("testshib_metadata.xml"), - ) # lint-amnesty, pylint: disable=no-member + ) # pylint: disable=no-member httpretty.register_uri(httpretty.GET, TESTSHIB_METADATA_URL, content_type="text/xml", body=metadata_callback) @@ -83,7 +81,7 @@ def cache_duration_metadata_callback(_request, _uri, headers): 200, headers, self.read_data_file("testshib_metadata_with_cache_duration.xml"), - ) # lint-amnesty, pylint: disable=no-member + ) # pylint: disable=no-member httpretty.register_uri( httpretty.GET, @@ -96,14 +94,14 @@ def cache_duration_metadata_callback(_request, _uri, headers): # Doing this and freezing the time allows us to play back recorded request/response pairs uid_patch = patch("onelogin.saml2.utils.OneLogin_Saml2_Utils.generate_unique_id", return_value="TESTID") uid_patch.start() - self.addCleanup(uid_patch.stop) # lint-amnesty, pylint: disable=no-member + self.addCleanup(uid_patch.stop) # pylint: disable=no-member self._freeze_time(timestamp=1434326820) # This is the time when the saved request/response was recorded. def _freeze_time(self, timestamp): """Mock the current time for SAML, so we can replay canned requests/responses""" now_patch = patch("onelogin.saml2.utils.OneLogin_Saml2_Utils.now", return_value=timestamp) now_patch.start() - self.addCleanup(now_patch.stop) # lint-amnesty, pylint: disable=no-member + self.addCleanup(now_patch.stop) # pylint: disable=no-member def _configure_testshib_provider(self, **kwargs): """Enable and configure the TestShib SAML IdP as a third_party_auth provider""" @@ -124,21 +122,21 @@ def _configure_testshib_provider(self, **kwargs): saml_provider = self.configure_saml_provider(**kwargs) # pylint: disable=no-member if fetch_metadata: - assert httpretty.is_enabled() # lint-amnesty, pylint: disable=no-member + assert httpretty.is_enabled() # pylint: disable=no-member num_total, num_skipped, num_attempted, num_updated, num_failed, failure_messages = fetch_saml_metadata() if assert_metadata_updates: - assert num_total == 1 # lint-amnesty, pylint: disable=no-member - assert num_skipped == 0 # lint-amnesty, pylint: disable=no-member - assert num_attempted == 1 # lint-amnesty, pylint: disable=no-member - assert num_updated == 1 # lint-amnesty, pylint: disable=no-member - assert num_failed == 0 # lint-amnesty, pylint: disable=no-member - assert len(failure_messages) == 0 # lint-amnesty, pylint: disable=no-member + assert num_total == 1 # pylint: disable=no-member + assert num_skipped == 0 # pylint: disable=no-member + assert num_attempted == 1 # pylint: disable=no-member + assert num_updated == 1 # pylint: disable=no-member + assert num_failed == 0 # pylint: disable=no-member + assert len(failure_messages) == 0 # pylint: disable=no-member return saml_provider def do_provider_login(self, provider_redirect_url): """Mocked: the user logs in to TestShib and then gets redirected back""" # The SAML provider (TestShib) will authenticate the user, then get the browser to POST a response: - assert provider_redirect_url.startswith(TESTSHIB_SSO_URL) # lint-amnesty, pylint: disable=no-member + assert provider_redirect_url.startswith(TESTSHIB_SSO_URL) # pylint: disable=no-member saml_response_xml = utils.read_and_pre_process_xml( os.path.join(os.path.dirname(os.path.dirname(__file__)), "data", "testshib_saml_response.xml") @@ -154,8 +152,8 @@ def do_provider_login(self, provider_redirect_url): if relay_state: data += '&RelayState=' + quote(relay_state) # Append as string to the URL-encoded data - return self.client.post( # lint-amnesty, pylint: disable=no-member - self.complete_url, # lint-amnesty, pylint: disable=no-member + return self.client.post( # pylint: disable=no-member + self.complete_url, # pylint: disable=no-member content_type="application/x-www-form-urlencoded", data=data, ) @@ -190,7 +188,7 @@ def test_index_error_from_empty_list_saml_attribute(self): request, strategy = self.get_request_and_strategy( auth_entry=pipeline.AUTH_ENTRY_LOGIN, redirect_uri="social:complete" ) - with self.assertRaises(IncorrectConfigurationException): + with self.assertRaises(IncorrectConfigurationException): # noqa: PT027 request.backend.auth_complete = MagicMock(return_value=self.fake_auth_complete(strategy)) def get_response_data(self): @@ -220,13 +218,7 @@ class TestShibIntegrationTest(SamlIntegrationTestUtilities, IntegrationTestMixin "session_index": "1", } - @patch("openedx.features.enterprise_support.api.enterprise_customer_for_request") - @patch("openedx.features.enterprise_support.utils.third_party_auth.provider.Registry.get") - def test_full_pipeline_succeeds_for_unlinking_testshib_account( - self, - mock_auth_provider, - mock_enterprise_customer_for_request, - ): + def test_full_pipeline_succeeds_for_unlinking_testshib_account(self): # First, create, the request and strategy that store pipeline state, # configure the backend, and mock out wire traffic. @@ -245,30 +237,6 @@ def test_full_pipeline_succeeds_for_unlinking_testshib_account( # We're already logged in, so simulate that the cookie is set correctly self.set_logged_in_cookies(request) - # linking a learner with enterprise customer. - enterprise_customer = EnterpriseCustomerFactory() - assert EnterpriseCustomerUser.objects.count() == 0, "Precondition check: no link records should exist" - EnterpriseCustomerUser.objects.link_user(enterprise_customer, user.email) - assert ( - EnterpriseCustomerUser.objects.filter(enterprise_customer=enterprise_customer, user_id=user.id).count() == 1 - ) - EnterpriseCustomerIdentityProvider.objects.get_or_create( - enterprise_customer=enterprise_customer, provider_id=self.provider.provider_id - ) - - enterprise_customer_data = { - "uuid": enterprise_customer.uuid, - "name": enterprise_customer.name, - "identity_provider": "saml-default", - "identity_providers": [ - { - "provider_id": "saml-default", - } - ], - } - mock_auth_provider.return_value.backend_name = "tpa-saml" - mock_enterprise_customer_for_request.return_value = enterprise_customer_data - # Instrument the pipeline to get to the dashboard with the full expected state. self.client.get(pipeline.get_login_url(self.provider.provider_id, pipeline.AUTH_ENTRY_LOGIN)) @@ -285,31 +253,30 @@ def test_full_pipeline_succeeds_for_unlinking_testshib_account( # First we expect that we're in the linked state, with a backend entry. self.assert_social_auth_exists_for_user(request.user, strategy) - FEATURES_WITH_ENTERPRISE_ENABLED = settings.FEATURES.copy() - FEATURES_WITH_ENTERPRISE_ENABLED["ENABLE_ENTERPRISE_INTEGRATION"] = True - with patch.dict("django.conf.settings.FEATURES", FEATURES_WITH_ENTERPRISE_ENABLED): - # Fire off the disconnect pipeline without the user information. - actions.do_disconnect( - request.backend, None, None, redirect_field_name=auth.REDIRECT_FIELD_NAME, request=request - ) - assert ( - EnterpriseCustomerUser.objects.filter(enterprise_customer=enterprise_customer, user_id=user.id).count() - != 0 - ) + # Track signal emissions to verify the disconnect signal is sent. + signal_calls = [] + def signal_receiver(sender, **kwargs): + signal_calls.append(kwargs) + + SAMLAccountDisconnected.connect(signal_receiver) + try: # Fire off the disconnect pipeline to unlink. self.assert_redirect_after_pipeline_completes( actions.do_disconnect( request.backend, user, None, redirect_field_name=auth.REDIRECT_FIELD_NAME, request=request ) ) - # Now we expect to be in the unlinked state, with no backend entry. - self.assert_third_party_accounts_state(request, linked=False) - self.assert_social_auth_does_not_exist_for_user(user, strategy) - assert ( - EnterpriseCustomerUser.objects.filter(enterprise_customer=enterprise_customer, user_id=user.id).count() - == 0 - ) + finally: + SAMLAccountDisconnected.disconnect(signal_receiver) + + # Now we expect to be in the unlinked state, with no backend entry. + self.assert_third_party_accounts_state(request, linked=False) + self.assert_social_auth_does_not_exist_for_user(user, strategy) + # Verify that the SAMLAccountDisconnected signal was emitted. + # The actual enterprise user unlinking is handled by edx-enterprise's + # signal handler, not by openedx-platform. + assert len(signal_calls) == 1, f"Expected 1 signal emission, got {len(signal_calls)}" def get_response_data(self): """Gets dict (string -> object) of merged data about the user.""" @@ -529,7 +496,7 @@ def _mock_odata_api_for_error(self, odata_api_root_url, username): Mock an error response when calling the OData API for user details. """ - def callback(request, uri, headers): # lint-amnesty, pylint: disable=unused-argument + def callback(request, uri, headers): # pylint: disable=unused-argument """ Return a 500 error when someone tries to call the URL. """ @@ -538,7 +505,7 @@ def callback(request, uri, headers): # lint-amnesty, pylint: disable=unused-arg return 500, headers, "Failure!" fields = ",".join(SapSuccessFactorsIdentityProvider.default_field_mapping.copy()) - url = "{root_url}User(userId='{user_id}')?$select={fields}".format( + url = "{root_url}User(userId='{user_id}')?$select={fields}".format( # noqa: UP032 root_url=odata_api_root_url, user_id=username, fields=fields, diff --git a/common/djangoapps/third_party_auth/tests/specs/test_twitter.py b/common/djangoapps/third_party_auth/tests/specs/test_twitter.py index d67373ccf679..e98a34260c77 100644 --- a/common/djangoapps/third_party_auth/tests/specs/test_twitter.py +++ b/common/djangoapps/third_party_auth/tests/specs/test_twitter.py @@ -1,13 +1,14 @@ -""" # lint-amnesty, pylint: disable=cyclic-import +""" # pylint: disable=cyclic-import Separate integration test for Twitter which is an OAuth1 provider. """ from unittest.mock import patch + from common.djangoapps.third_party_auth.tests.specs import base -class TwitterIntegrationTest(base.Oauth2IntegrationTest): # lint-amnesty, pylint: disable=test-inherits-tests +class TwitterIntegrationTest(base.Oauth2IntegrationTest): # pylint: disable=test-inherits-tests """Integration tests for Twitter backend.""" PROVIDER_NAME = "twitter" diff --git a/common/djangoapps/third_party_auth/tests/test_admin.py b/common/djangoapps/third_party_auth/tests/test_admin.py index 0acfb3492a6f..fdba2106244f 100644 --- a/common/djangoapps/third_party_auth/tests/test_admin.py +++ b/common/djangoapps/third_party_auth/tests/test_admin.py @@ -13,7 +13,6 @@ from common.djangoapps.third_party_auth.tests import testutil from common.djangoapps.third_party_auth.tests.utils import skip_unless_thirdpartyauth - TEST_PASSWORD = 'Password1234' diff --git a/common/djangoapps/third_party_auth/tests/test_identityserver3.py b/common/djangoapps/third_party_auth/tests/test_identityserver3.py index d25a6c81dfca..53499b661978 100644 --- a/common/djangoapps/third_party_auth/tests/test_identityserver3.py +++ b/common/djangoapps/third_party_auth/tests/test_identityserver3.py @@ -2,7 +2,9 @@ Unit tests for the IdentityServer3 OAuth2 Backend """ import json + import ddt + from common.djangoapps.third_party_auth.identityserver3 import IdentityServer3 from common.djangoapps.third_party_auth.tests import testutil from common.djangoapps.third_party_auth.tests.utils import skip_unless_thirdpartyauth diff --git a/common/djangoapps/third_party_auth/tests/test_middleware.py b/common/djangoapps/third_party_auth/tests/test_middleware.py index d99488b02aa1..503907202061 100644 --- a/common/djangoapps/third_party_auth/tests/test_middleware.py +++ b/common/djangoapps/third_party_auth/tests/test_middleware.py @@ -4,15 +4,16 @@ from unittest import mock + from django.contrib.messages.middleware import MessageMiddleware from django.http import HttpResponse from django.test.client import RequestFactory from requests.exceptions import HTTPError -from openedx.core.djangolib.testing.utils import skip_unless_lms from common.djangoapps.student.helpers import get_next_url_for_login_page from common.djangoapps.third_party_auth.middleware import ExceptionMiddleware from common.djangoapps.third_party_auth.tests.testutil import TestCase +from openedx.core.djangolib.testing.utils import skip_unless_lms class ThirdPartyAuthMiddlewareTestCase(TestCase): diff --git a/common/djangoapps/third_party_auth/tests/test_models.py b/common/djangoapps/third_party_auth/tests/test_models.py index ed0b74ebb396..4db68fec5d8c 100644 --- a/common/djangoapps/third_party_auth/tests/test_models.py +++ b/common/djangoapps/third_party_auth/tests/test_models.py @@ -2,10 +2,11 @@ Tests for third_party_auth/models.py. """ import unittest + from django.test import TestCase, override_settings -from .factories import SAMLProviderConfigFactory from ..models import SAMLProviderConfig, clean_username +from .factories import SAMLProviderConfigFactory class TestSamlProviderConfigModel(TestCase, unittest.TestCase): diff --git a/common/djangoapps/third_party_auth/tests/test_pipeline_integration.py b/common/djangoapps/third_party_auth/tests/test_pipeline_integration.py index 66c57118bfb9..75771b9fbfec 100644 --- a/common/djangoapps/third_party_auth/tests/test_pipeline_integration.py +++ b/common/djangoapps/third_party_auth/tests/test_pipeline_integration.py @@ -8,7 +8,7 @@ import ddt import pytest from django import test -from django.contrib.auth import models, REDIRECT_FIELD_NAME +from django.contrib.auth import REDIRECT_FIELD_NAME, models from django.core import mail from social_django import models as social_models @@ -156,7 +156,7 @@ def test_complete_url_raises_value_error_if_provider_not_enabled(self): assert provider.Registry.get(provider_name) is None - with pytest.raises(ValueError): + with pytest.raises(ValueError): # noqa: PT011 pipeline.get_complete_url(provider_name) def test_complete_url_returns_expected_format(self): @@ -170,21 +170,21 @@ def test_disconnect_url_raises_value_error_if_provider_not_enabled(self): assert provider.Registry.get(provider_name) is None - with pytest.raises(ValueError): + with pytest.raises(ValueError): # noqa: PT011 pipeline.get_disconnect_url(provider_name, 1000) def test_disconnect_url_returns_expected_format(self): disconnect_url = pipeline.get_disconnect_url(self.enabled_provider.provider_id, 1000) disconnect_url = disconnect_url.rstrip('?') assert disconnect_url == '/auth/disconnect_json/{backend}/{association_id}/'\ - .format(backend=self.enabled_provider.backend_name, association_id=1000) + .format(backend=self.enabled_provider.backend_name, association_id=1000) # noqa: UP032 def test_login_url_raises_value_error_if_provider_not_enabled(self): provider_id = 'oa2-not-enabled' assert provider.Registry.get(provider_id) is None - with pytest.raises(ValueError): + with pytest.raises(ValueError): # noqa: PT011 pipeline.get_login_url(provider_id, pipeline.AUTH_ENTRY_LOGIN) def test_login_url_returns_expected_format(self): @@ -197,16 +197,16 @@ def test_login_url_returns_expected_format(self): def test_for_value_error_if_provider_id_invalid(self): provider_id = 'invalid' # Format is normally "{prefix}-{identifier}" - with pytest.raises(ValueError): + with pytest.raises(ValueError): # noqa: PT011 provider.Registry.get(provider_id) - with pytest.raises(ValueError): + with pytest.raises(ValueError): # noqa: PT011 pipeline.get_login_url(provider_id, pipeline.AUTH_ENTRY_LOGIN) - with pytest.raises(ValueError): + with pytest.raises(ValueError): # noqa: PT011 pipeline.get_disconnect_url(provider_id, 1000) - with pytest.raises(ValueError): + with pytest.raises(ValueError): # noqa: PT011 pipeline.get_complete_url(provider_id) @@ -321,12 +321,12 @@ def test_provider_settings_redirect_to_registration(self, send_to_registration_f based on the provider's setting for send_to_registration_first. """ - provider = mock.MagicMock( # lint-amnesty, pylint: disable=redefined-outer-name + provider = mock.MagicMock( # pylint: disable=redefined-outer-name send_to_registration_first=send_to_registration_first, skip_email_verification=False ) - with mock.patch('common.djangoapps.third_party_auth.pipeline.provider.Registry.get_from_pipeline') as get_from_pipeline: # lint-amnesty, pylint: disable=line-too-long + with mock.patch('common.djangoapps.third_party_auth.pipeline.provider.Registry.get_from_pipeline') as get_from_pipeline: # pylint: disable=line-too-long get_from_pipeline.return_value = provider with mock.patch('social_core.pipeline.partial.partial_prepare') as partial_prepare: partial_prepare.return_value = mock.MagicMock(token='') @@ -359,7 +359,7 @@ def test_redirect_for_saml_based_on_email_only(self, email, expected_redirect_ur send_to_registration_first=True, skip_email_verification=False ) - with mock.patch('common.djangoapps.third_party_auth.pipeline.provider.Registry.get_from_pipeline') as get_from_pipeline: # lint-amnesty, pylint: disable=line-too-long + with mock.patch('common.djangoapps.third_party_auth.pipeline.provider.Registry.get_from_pipeline') as get_from_pipeline: # pylint: disable=line-too-long get_from_pipeline.return_value = saml_provider with mock.patch( 'common.djangoapps.third_party_auth.pipeline.provider.Registry.get_enabled_by_backend_name' @@ -400,7 +400,7 @@ def setUp(self): self.strategy = mock.MagicMock() self.strategy.storage.user.changed.side_effect = lambda user: user.save() - get_from_pipeline = mock.patch('common.djangoapps.third_party_auth.pipeline.provider.Registry.get_from_pipeline') # lint-amnesty, pylint: disable=line-too-long + get_from_pipeline = mock.patch('common.djangoapps.third_party_auth.pipeline.provider.Registry.get_from_pipeline') # pylint: disable=line-too-long self.get_from_pipeline = get_from_pipeline.start() self.get_from_pipeline.return_value = mock.MagicMock(sync_learner_profile_data=True) self.addCleanup(get_from_pipeline.stop) @@ -497,7 +497,7 @@ def setUp(self): self.strategy = mock.MagicMock() self.strategy.storage.user.changed.side_effect = lambda user: user.save() - get_from_pipeline = mock.patch('common.djangoapps.third_party_auth.pipeline.provider.Registry.get_from_pipeline') # lint-amnesty, pylint: disable=line-too-long + get_from_pipeline = mock.patch('common.djangoapps.third_party_auth.pipeline.provider.Registry.get_from_pipeline') # pylint: disable=line-too-long self.get_from_pipeline = get_from_pipeline.start() self.get_from_pipeline.return_value = mock.MagicMock( enable_sso_id_verification=True, @@ -561,7 +561,7 @@ def test_set_id_verification_status_expired(self): identity_provider_slug=self.provider_slug, ) - with mock.patch('common.djangoapps.third_party_auth.pipeline.earliest_allowed_verification_date') as earliest_date: # lint-amnesty, pylint: disable=line-too-long + with mock.patch('common.djangoapps.third_party_auth.pipeline.earliest_allowed_verification_date') as earliest_date: # pylint: disable=line-too-long earliest_date.return_value = datetime.datetime.now(ZoneInfo("UTC")) + datetime.timedelta(days=1) # Begin the pipeline. pipeline.set_id_verification_status( @@ -615,7 +615,7 @@ def test_login_url_with_auth_entry(self): query_params = pipeline.parse_query_params(self.strategy, self.response) - self.assertDictEqual(expected_query_params, query_params) + self.assertDictEqual(expected_query_params, query_params) # noqa: PT009 def test_login_url_with_auth_entry_none(self): """ @@ -630,7 +630,7 @@ def test_login_url_with_auth_entry_none(self): query_params = pipeline.parse_query_params(self.strategy, self.response) - self.assertDictEqual(expected_query_params, query_params) + self.assertDictEqual(expected_query_params, query_params) # noqa: PT009 def test_login_url_without_auth_entry(self): """ @@ -643,7 +643,7 @@ def test_login_url_without_auth_entry(self): query_params = pipeline.parse_query_params(self.strategy, self.response) - self.assertDictEqual(expected_query_params, query_params) + self.assertDictEqual(expected_query_params, query_params) # noqa: PT009 def test_login_url_invalid_auth_entry(self): """ @@ -653,7 +653,7 @@ def test_login_url_invalid_auth_entry(self): "auth_entry": "not-valid", } - with self.assertRaises(pipeline.AuthEntryError): + with self.assertRaises(pipeline.AuthEntryError): # noqa: PT027 pipeline.parse_query_params(self.strategy, self.response) diff --git a/common/djangoapps/third_party_auth/tests/test_provider.py b/common/djangoapps/third_party_auth/tests/test_provider.py index 28e95c16b8f9..7dbb79a72cd7 100644 --- a/common/djangoapps/third_party_auth/tests/test_provider.py +++ b/common/djangoapps/third_party_auth/tests/test_provider.py @@ -12,7 +12,8 @@ from common.djangoapps.third_party_auth.tests import testutil from common.djangoapps.third_party_auth.tests.utils import skip_unless_thirdpartyauth from openedx.core.djangoapps.site_configuration.tests.test_util import ( - with_site_configuration, with_site_configuration_context + with_site_configuration, + with_site_configuration_context, ) SITE_DOMAIN_A = 'professionalx.example.com' diff --git a/common/djangoapps/third_party_auth/tests/test_saml.py b/common/djangoapps/third_party_auth/tests/test_saml.py index d6d3e0e27c24..69ebc0a6d6cd 100644 --- a/common/djangoapps/third_party_auth/tests/test_saml.py +++ b/common/djangoapps/third_party_auth/tests/test_saml.py @@ -8,11 +8,11 @@ from social_core.exceptions import AuthMissingParameter from common.djangoapps.third_party_auth.dummy import DummyBackend -from common.djangoapps.third_party_auth.saml import EdXSAMLIdentityProvider, get_saml_idp_class, SAMLAuthBackend +from common.djangoapps.third_party_auth.saml import EdXSAMLIdentityProvider, SAMLAuthBackend, get_saml_idp_class from common.djangoapps.third_party_auth.tests.data.saml_identity_provider_mock_data import ( expected_user_details, mock_attributes, - mock_conf + mock_conf, ) from common.djangoapps.third_party_auth.tests.testutil import SAMLTestCase @@ -45,7 +45,7 @@ class TestSAMLAuthBackend(SAMLTestCase): def test_saml_auth_complete(self, super_auth_complete): super_auth_complete.side_effect = MultiValueDictKeyError('RelayState') backend = SAMLAuthBackend() - with self.assertRaises(AuthMissingParameter) as cm: + with self.assertRaises(AuthMissingParameter) as cm: # noqa: PT027 backend.auth_complete() assert cm.exception.parameter == 'RelayState' diff --git a/common/djangoapps/third_party_auth/tests/test_settings.py b/common/djangoapps/third_party_auth/tests/test_settings.py index accecca09ec8..2bc647fee616 100644 --- a/common/djangoapps/third_party_auth/tests/test_settings.py +++ b/common/djangoapps/third_party_auth/tests/test_settings.py @@ -1,67 +1,70 @@ -"""Unit tests for settings.py.""" +"""Unit tests for third-party auth settings in lms/envs/common.py.""" -from unittest.mock import patch -from common.djangoapps.third_party_auth import provider, settings -from common.djangoapps.third_party_auth.tests import testutil +from django.conf import settings +from django.test import TestCase, override_settings + +from common.djangoapps.third_party_auth import provider from common.djangoapps.third_party_auth.tests.utils import skip_unless_thirdpartyauth -_ORIGINAL_AUTHENTICATION_BACKENDS = ['first_authentication_backend'] -_ORIGINAL_INSTALLED_APPS = ['first_installed_app'] -_ORIGINAL_MIDDLEWARE_CLASSES = ['first_middleware_class'] -_ORIGINAL_TEMPLATE_CONTEXT_PROCESSORS = ['first_template_context_preprocessor'] -_SETTINGS_MAP = { - 'AUTHENTICATION_BACKENDS': _ORIGINAL_AUTHENTICATION_BACKENDS, - 'INSTALLED_APPS': _ORIGINAL_INSTALLED_APPS, - 'MIDDLEWARE': _ORIGINAL_MIDDLEWARE_CLASSES, - 'TEMPLATES': [{ - 'OPTIONS': { - 'context_processors': _ORIGINAL_TEMPLATE_CONTEXT_PROCESSORS - } - }], - 'FEATURES': {}, -} -_SETTINGS_MAP['DEFAULT_TEMPLATE_ENGINE'] = _SETTINGS_MAP['TEMPLATES'][0] +from openedx.core.djangolib.testing.utils import skip_unless_lms -class SettingsUnitTest(testutil.TestCase): - """Unit tests for settings management code.""" +@skip_unless_lms +class SettingsUnitTest(TestCase): + """Unit tests for third-party auth settings defined in lms/envs/common.py.""" - # Suppress spurious no-member warning on fakes. - # pylint: disable=no-member + def test_exception_middleware_in_middleware_list(self): + """Verify ExceptionMiddleware is included in MIDDLEWARE.""" + assert 'common.djangoapps.third_party_auth.middleware.ExceptionMiddleware' in settings.MIDDLEWARE - def setUp(self): - super().setUp() - self.settings = testutil.FakeDjangoSettings(_SETTINGS_MAP) + def test_fields_stored_in_session_defined(self): + """Verify FIELDS_STORED_IN_SESSION is defined with expected values.""" + assert settings.FIELDS_STORED_IN_SESSION == ['auth_entry', 'next'] - def test_apply_settings_adds_exception_middleware(self): - settings.apply_settings(self.settings) - assert 'common.djangoapps.third_party_auth.middleware.ExceptionMiddleware' in self.settings.MIDDLEWARE + @skip_unless_thirdpartyauth() + def test_no_providers_enabled_by_default(self): + """Providers are only enabled via ConfigurationModels in the database.""" + assert provider.Registry.enabled() == [] - def test_apply_settings_adds_fields_stored_in_session(self): - settings.apply_settings(self.settings) - assert ['auth_entry', 'next'] == self.settings.FIELDS_STORED_IN_SESSION + def test_social_auth_raise_exceptions_is_false(self): + """Guard against submitting a conf change that's convenient in dev but bad in prod.""" + assert settings.SOCIAL_AUTH_RAISE_EXCEPTIONS is False - @skip_unless_thirdpartyauth() - def test_apply_settings_enables_no_providers_by_default(self): - # Providers are only enabled via ConfigurationModels in the database - settings.apply_settings(self.settings) - assert [] == provider.Registry.enabled() + def test_social_auth_sanitize_redirects_is_false(self): + """Verify redirect sanitization is disabled (platform does its own).""" + assert settings.SOCIAL_AUTH_SANITIZE_REDIRECTS is False + + def test_social_auth_login_error_url(self): + """Verify SOCIAL_AUTH_LOGIN_ERROR_URL is set.""" + assert settings.SOCIAL_AUTH_LOGIN_ERROR_URL == '/' + + def test_social_auth_login_redirect_url(self): + """Verify SOCIAL_AUTH_LOGIN_REDIRECT_URL is set.""" + assert settings.SOCIAL_AUTH_LOGIN_REDIRECT_URL == '/dashboard' + + def test_social_auth_strategy(self): + """Verify SOCIAL_AUTH_STRATEGY is set to use ConfigurationModelStrategy.""" + assert settings.SOCIAL_AUTH_STRATEGY == 'common.djangoapps.third_party_auth.strategy.ConfigurationModelStrategy' - def test_apply_settings_turns_off_raising_social_exceptions(self): - # Guard against submitting a conf change that's convenient in dev but - # bad in prod. - settings.apply_settings(self.settings) - assert not self.settings.SOCIAL_AUTH_RAISE_EXCEPTIONS + def test_social_auth_pipeline_defined(self): + """Verify SOCIAL_AUTH_PIPELINE is defined and includes expected steps.""" + pipeline = settings.SOCIAL_AUTH_PIPELINE + assert isinstance(pipeline, list) + assert len(pipeline) > 0 + # Verify some key pipeline steps are present + assert 'common.djangoapps.third_party_auth.pipeline.parse_query_params' in pipeline + assert 'social_core.pipeline.user.create_user' in pipeline + assert 'common.djangoapps.third_party_auth.pipeline.ensure_redirect_url_is_safe' in pipeline - def test_apply_settings_turns_off_redirect_sanitization(self): - settings.apply_settings(self.settings) - assert not self.settings.SOCIAL_AUTH_SANITIZE_REDIRECTS + def test_social_auth_context_processors(self): + """Verify social_django context processors are included.""" + # CONTEXT_PROCESSORS is used to build TEMPLATES, so check there + context_processors = settings.TEMPLATES[0]['OPTIONS']['context_processors'] + assert 'social_django.context_processors.backends' in context_processors + assert 'social_django.context_processors.login_redirect' in context_processors - def test_apply_settings_avoids_default_username_check(self): - # Avoid the default username check where non-ascii characters are not - # allowed when unicode username is enabled - settings.apply_settings(self.settings) - assert self.settings.SOCIAL_AUTH_CLEAN_USERNAMES - # verify default behavior - with patch.dict('django.conf.settings.FEATURES', {'ENABLE_UNICODE_USERNAME': True}): - settings.apply_settings(self.settings) - assert not self.settings.SOCIAL_AUTH_CLEAN_USERNAMES + @override_settings(FEATURES={'ENABLE_UNICODE_USERNAME': False}) + def test_social_auth_clean_usernames_default(self): + """Verify SOCIAL_AUTH_CLEAN_USERNAMES is True when unicode usernames disabled.""" + # Note: SOCIAL_AUTH_CLEAN_USERNAMES is a Derived setting, computed at settings load time. + # This test verifies the default behavior (unicode usernames disabled). + assert settings.SOCIAL_AUTH_CLEAN_USERNAMES is True diff --git a/common/djangoapps/third_party_auth/tests/test_utils.py b/common/djangoapps/third_party_auth/tests/test_utils.py index c1b3fd98b545..9571f4834f31 100644 --- a/common/djangoapps/third_party_auth/tests/test_utils.py +++ b/common/djangoapps/third_party_auth/tests/test_utils.py @@ -6,24 +6,24 @@ from unittest.mock import MagicMock import ddt +import pytest +from django.test import override_settings from lxml import etree from common.djangoapps.student.tests.factories import UserFactory +from common.djangoapps.third_party_auth.models import SAMLProviderData from common.djangoapps.third_party_auth.tests.testutil import TestCase from common.djangoapps.third_party_auth.utils import ( + SAMLMetadataURLError, + create_or_update_bulk_saml_provider_data, get_associated_user_by_email_response, get_user_from_email, - is_enterprise_customer_user, is_oauth_provider, parse_metadata_xml, user_exists, - convert_saml_slug_provider_id, + validate_saml_metadata_url, ) from openedx.core.djangolib.testing.utils import skip_unless_lms -from openedx.features.enterprise_support.tests.factories import ( - EnterpriseCustomerIdentityProviderFactory, - EnterpriseCustomerUserFactory, -) @ddt.ddt @@ -45,17 +45,6 @@ def test_user_exists(self): assert not user_exists({'username': 'invalid_user'}) assert user_exists({'username': 'TesT_User'}) - def test_convert_saml_slug_provider_id(self): - """ - Verify saml provider id/slug map to each other correctly. - """ - provider_names = {'saml-samltest': 'samltest', 'saml-example': 'example'} - for provider_id in provider_names: - # provider_id -> slug - assert convert_saml_slug_provider_id(provider_id) == provider_names[provider_id] - # slug -> provider_id - assert convert_saml_slug_provider_id(provider_names[provider_id]) == provider_id - def test_get_user(self): """ Match the email and return user if exists. @@ -65,26 +54,6 @@ def test_get_user(self): assert get_user_from_email({'email': 'test_user@example.com'}) assert not get_user_from_email({'email': 'invalid@example.com'}) - def test_is_enterprise_customer_user(self): - """ - Verify that if user is an enterprise learner. - """ - # Create users from factory - - user = UserFactory(username='test_user', email='test_user@example.com') - other_user = UserFactory(username='other_user', email='other_user@example.com') - customer_idp = EnterpriseCustomerIdentityProviderFactory.create( - provider_id='the-provider', - ) - customer = customer_idp.enterprise_customer - EnterpriseCustomerUserFactory.create( - enterprise_customer=customer, - user_id=user.id, - ) - - assert is_enterprise_customer_user('the-provider', user) - assert not is_enterprise_customer_user('the-provider', other_user) - @ddt.data( ('saml-farkle', False), ('oa2-fergus', True), @@ -100,7 +69,7 @@ def test_is_oauth_provider(self, provider_id, oauth_provider): ) as get_from_pipeline: get_from_pipeline.return_value.provider_id = provider_id - self.assertEqual(is_oauth_provider('backend_name'), oauth_provider) + self.assertEqual(is_oauth_provider('backend_name'), oauth_provider) # noqa: PT009 @ddt.data( (None, False), @@ -124,11 +93,11 @@ def test_get_associated_user_by_email_response(self, user, user_is_active): backend=None, details=None, user=mock_user) if association_response: - self.assertEqual(association_response['user'](), user) - self.assertEqual(user_is_active_resonse, user_is_active) + self.assertEqual(association_response['user'](), user) # noqa: PT009 + self.assertEqual(user_is_active_resonse, user_is_active) # noqa: PT009 else: - self.assertIsNone(association_response) - self.assertFalse(user_is_active_resonse) + self.assertIsNone(association_response) # noqa: PT009 + self.assertFalse(user_is_active_resonse) # noqa: PT009 def test_parse_metadata_uses_signing_cert(self): entity_id = 'http://testid' @@ -216,3 +185,126 @@ def test_parse_metadata_with_use_attribute_missing(self): public_keys, sso_url, _ = parse_metadata_xml(xml, entity_id) assert public_keys == ['abc+hkIuUktxkg='] assert sso_url == 'https://idp/SSOService.php' + + +@skip_unless_lms +class TestCreateOrUpdateBulkSAMLProviderData(TestCase): + """Tests for create_or_update_bulk_saml_provider_data.""" + + def test_creates_new_record(self): + result = create_or_update_bulk_saml_provider_data( + 'http://entity1', ['pubkey1'], + 'https://sso.example.com', None, + ) + assert result is True + assert SAMLProviderData.objects.filter( + entity_id='http://entity1', public_key='pubkey1', + ).exists() + + def test_updates_existing_record(self): + create_or_update_bulk_saml_provider_data( + 'http://entity1', ['pubkey1'], + 'https://sso.example.com', None, + ) + result = create_or_update_bulk_saml_provider_data( + 'http://entity1', ['pubkey1'], + 'https://sso2.example.com', None, + ) + assert result is False + data = SAMLProviderData.objects.get( + entity_id='http://entity1', public_key='pubkey1', + ) + assert data.sso_url == 'https://sso2.example.com' + + def test_bulk_updates_multiple_existing(self): + from django.utils.timezone import now + SAMLProviderData.objects.create( + entity_id='http://entity1', + public_key='pubkey1', + sso_url='https://old.example.com', + fetched_at=now(), + ) + SAMLProviderData.objects.create( + entity_id='http://entity1', + public_key='pubkey1', + sso_url='https://old.example.com', + fetched_at=now(), + ) + result = create_or_update_bulk_saml_provider_data( + 'http://entity1', ['pubkey1'], + 'https://new.example.com', None, + ) + assert result is True + qs = SAMLProviderData.objects.filter( + entity_id='http://entity1', public_key='pubkey1', + ) + for obj in qs: + assert obj.sso_url == 'https://new.example.com' + + def test_multiple_keys(self): + result = create_or_update_bulk_saml_provider_data( + 'http://entity1', ['key1', 'key2'], + 'https://sso.example.com', None, + ) + assert result is True + count = SAMLProviderData.objects.filter( + entity_id='http://entity1', + ).count() + assert count == 2 + + +@ddt.ddt +@skip_unless_lms +class TestValidateSAMLMetadataURL(TestCase): + """Tests for validate_saml_metadata_url.""" + + @ddt.data( + 'https://idp.example.com/metadata', + 'https://1.1.1.1/metadata', + ) + def test_valid_urls_pass(self, url): + validate_saml_metadata_url(url) # should not raise + + @ddt.data( + ('http://idp.example.com/metadata', 'must use HTTPS'), + ('ftp://idp.example.com/metadata', 'must use HTTPS'), + ('https://', 'no hostname'), + ) + @ddt.unpack + def test_invalid_scheme_or_missing_hostname(self, url, expected_fragment): + with pytest.raises(SAMLMetadataURLError, match=expected_fragment): + validate_saml_metadata_url(url) + + @ddt.data( + 'https://127.0.0.1/metadata', # IPv4 loopback + 'https://[::1]/metadata', # IPv6 loopback + 'https://169.254.169.254/latest', # AWS metadata endpoint + 'https://169.254.0.1/metadata', # other link-local + 'https://[fe80::1]/metadata', # IPv6 link-local + 'https://240.0.0.1/metadata', # reserved (Class E) + ) + def test_always_blocked_regardless_of_setting(self, url): + for allow_private in (False, True): + with override_settings(SAML_METADATA_URL_ALLOW_PRIVATE_IPS=allow_private): + with pytest.raises(SAMLMetadataURLError): + validate_saml_metadata_url(url) + + @ddt.data( + 'https://10.0.0.1/metadata', + 'https://172.16.0.1/metadata', + 'https://192.168.1.1/metadata', + 'https://[fc00::1]/metadata', # IPv6 unique local + ) + def test_private_ip_blocked_by_default(self, url): + with pytest.raises(SAMLMetadataURLError): + validate_saml_metadata_url(url) + + @ddt.data( + 'https://10.0.0.1/metadata', + 'https://172.16.0.1/metadata', + 'https://192.168.1.1/metadata', + 'https://[fc00::1]/metadata', # IPv6 unique local + ) + @override_settings(SAML_METADATA_URL_ALLOW_PRIVATE_IPS=True) + def test_private_ip_allowed_when_setting_enabled(self, url): + validate_saml_metadata_url(url) # should not raise diff --git a/common/djangoapps/third_party_auth/tests/test_views.py b/common/djangoapps/third_party_auth/tests/test_views.py index 859967ffa05f..3a5f46a44d41 100644 --- a/common/djangoapps/third_party_auth/tests/test_views.py +++ b/common/djangoapps/third_party_auth/tests/test_views.py @@ -18,6 +18,7 @@ from common.djangoapps.student.models import Registration from common.djangoapps.student.tests.factories import UserFactory from common.djangoapps.third_party_auth import pipeline + # Define some XML namespaces: from common.djangoapps.third_party_auth.utils import SAML_XML_NS from common.djangoapps.third_party_auth.views import inactive_user_view diff --git a/common/djangoapps/third_party_auth/tests/testutil.py b/common/djangoapps/third_party_auth/tests/testutil.py index 33eb30009b41..af2696536945 100644 --- a/common/djangoapps/third_party_auth/tests/testutil.py +++ b/common/djangoapps/third_party_auth/tests/testutil.py @@ -11,7 +11,7 @@ import django.test from django.conf import settings -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.contrib.sites.models import Site from mako.template import Template from oauth2_provider.models import Application @@ -20,7 +20,7 @@ LTIProviderConfig, OAuth2ProviderConfig, SAMLConfiguration, - SAMLProviderConfig + SAMLProviderConfig, ) from common.djangoapps.third_party_auth.models import cache as config_cache from openedx.core.djangolib.testing.utils import CacheIsolationMixin diff --git a/common/djangoapps/third_party_auth/tests/utils.py b/common/djangoapps/third_party_auth/tests/utils.py index 8d1bafcdd887..e753a14ceca4 100644 --- a/common/djangoapps/third_party_auth/tests/utils.py +++ b/common/djangoapps/third_party_auth/tests/utils.py @@ -6,15 +6,15 @@ from unittest import skip import httpretty -from onelogin.saml2.utils import OneLogin_Saml2_Utils from oauth2_provider.models import Application +from onelogin.saml2.utils import OneLogin_Saml2_Utils from social_core.backends.facebook import API_VERSION as FACEBOOK_API_VERSION from social_core.backends.facebook import FacebookOAuth2 from social_django.models import Partial, UserSocialAuth from common.djangoapps.student.tests.factories import UserFactory -from .testutil import ThirdPartyAuthTestMixin, AUTH_FEATURE_ENABLED, AUTH_FEATURES_KEY +from .testutil import AUTH_FEATURE_ENABLED, AUTH_FEATURES_KEY, ThirdPartyAuthTestMixin @httpretty.activate @@ -33,7 +33,7 @@ class ThirdPartyOAuthTestMixin(ThirdPartyAuthTestMixin): CREATE_USER = True - def setUp(self): # lint-amnesty, pylint: disable=arguments-differ + def setUp(self): # pylint: disable=arguments-differ super().setUp() if self.CREATE_USER: self.user = UserFactory.create(password='secret') @@ -140,7 +140,7 @@ def prepare_saml_response_from_xml(xml, relay_state='testshib'): (str): Base64 and URL encoded XML. """ b64encoded_xml = b64encode(xml.encode()) - return 'RelayState={relay_state}&SAMLResponse={saml_response}'.format( + return 'RelayState={relay_state}&SAMLResponse={saml_response}'.format( # noqa: UP032 relay_state=OneLogin_Saml2_Utils.escape_url(relay_state), saml_response=OneLogin_Saml2_Utils.escape_url(b64encoded_xml) ) @@ -152,4 +152,4 @@ def skip_unless_thirdpartyauth(): """ if AUTH_FEATURE_ENABLED: return lambda func: func - return skip("%s not enabled" % AUTH_FEATURES_KEY) + return skip("%s not enabled" % AUTH_FEATURES_KEY) # noqa: UP031 diff --git a/common/djangoapps/third_party_auth/urls.py b/common/djangoapps/third_party_auth/urls.py index a5908da26fd0..814790bba961 100644 --- a/common/djangoapps/third_party_auth/urls.py +++ b/common/djangoapps/third_party_auth/urls.py @@ -1,7 +1,6 @@ """Url configuration for the auth module.""" -from django.urls import include -from django.urls import path, re_path +from django.urls import include, path, re_path from .views import ( IdPRedirectView, @@ -9,7 +8,7 @@ inactive_user_view, lti_login_and_complete_view, post_to_custom_auth_form, - saml_metadata_view + saml_metadata_view, ) urlpatterns = [ @@ -26,7 +25,11 @@ name='custom_disconnect_json_individual' ), path('auth/', include('social_django.urls', namespace='social')), - path('auth/saml/v0/', include('common.djangoapps.third_party_auth.samlproviderconfig.urls')), - path('auth/saml/v0/', include('common.djangoapps.third_party_auth.samlproviderdata.urls')), path('auth/saml/v0/', include('common.djangoapps.third_party_auth.saml_configuration.urls')), + # NOTE: The following routes under auth/saml/v0/ are registered by the + # edx-enterprise plugin (enterprise/api/v1/urls.py). Do not re-register + # routes at these paths: + # auth/saml/v0/provider_config/ + # auth/saml/v0/provider_data/ + # See docs/decisions/0025-saml-admin-views-in-enterprise-plugin.rst ] diff --git a/common/djangoapps/third_party_auth/utils.py b/common/djangoapps/third_party_auth/utils.py index 52474c343a5f..27544eea0efa 100644 --- a/common/djangoapps/third_party_auth/utils.py +++ b/common/djangoapps/third_party_auth/utils.py @@ -3,24 +3,19 @@ """ import datetime -import logging -from uuid import UUID +import ipaddress +from urllib.parse import urlparse from zoneinfo import ZoneInfo import dateutil.parser -import requests -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.conf import settings +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.utils.timezone import now -from enterprise.models import EnterpriseCustomerIdentityProvider, EnterpriseCustomerUser from lxml import etree from onelogin.saml2.utils import OneLogin_Saml2_Utils -from requests import exceptions from social_core.pipeline.social_auth import associate_by_email -from common.djangoapps.student.models import ( - email_exists_or_retired, - username_exists_or_retired -) +from common.djangoapps.student.models import email_exists_or_retired, username_exists_or_retired from common.djangoapps.third_party_auth.models import OAuth2ProviderConfig, SAMLProviderData from openedx.core.djangolib.markup import Text @@ -28,45 +23,71 @@ SAML_XML_NS = 'urn:oasis:names:tc:SAML:2.0:metadata' # The SAML Metadata XML namespace -log = logging.getLogger(__name__) - class MetadataParseError(Exception): """ An error occurred while parsing the SAML metadata from an IdP """ - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass + +class SAMLMetadataURLError(Exception): + """ A SAML metadata URL failed security validation """ + pass # pylint: disable=unnecessary-pass -def fetch_metadata_xml(url): + +def validate_saml_metadata_url(url): """ - Fetches IDP metadata from provider url - Returns: xml document + Validate that a SAML metadata URL is safe to fetch. + + Enforces HTTPS and blocks requests to loopback, link-local, and reserved IP + addresses. Link-local specifically covers cloud instance metadata endpoints + (169.254.0.0/16, e.g. the AWS metadata service at 169.254.169.254). + Reserved addresses (e.g. 240.0.0.0/4) are IETF-assigned ranges that are + never routable on real networks. + + Private IP ranges (RFC 1918: 10.x, 172.16.x, 192.168.x) are also blocked by + default, since most Open edX deployments fetch SAML metadata from public IdPs. + Operators running in a private network where the SAML IdP has a private IP can + opt out by setting SAML_METADATA_URL_ALLOW_PRIVATE_IPS = True in Django settings. + + Limitation: IP address checks only apply to literal IPs in the URL. Hostname- + based URLs are not validated against the IP blocklists. Operators are encouraged + to complement this with network-level egress filtering that blocks outbound + connections from the Open edX server to link-local (169.254.0.0/16) and RFC + 1918 private address ranges. + + Raises SAMLMetadataURLError if the URL fails validation. """ + parsed = urlparse(url) + + if parsed.scheme != 'https': + raise SAMLMetadataURLError( + f"SAML metadata URL must use HTTPS, got scheme: {parsed.scheme!r}" + ) + + hostname = parsed.hostname + if not hostname: + raise SAMLMetadataURLError("SAML metadata URL has no hostname") + try: - log.info("Fetching %s", url) - if not url.lower().startswith('https'): - log.warning("This SAML metadata URL is not secure! It should use HTTPS. (%s)", url) - response = requests.get(url, verify=True) # May raise HTTPError or SSLError or ConnectionError - response.raise_for_status() # May raise an HTTPError - - try: - parser = etree.XMLParser(remove_comments=True) - xml = etree.fromstring(response.content, parser) - except etree.XMLSyntaxError: # lint-amnesty, pylint: disable=try-except-raise - raise - # TODO: Can use OneLogin_Saml2_Utils to validate signed XML if anyone is using that - return xml - except (exceptions.SSLError, exceptions.HTTPError, exceptions.RequestException, MetadataParseError) as error: - # Catch and process exception in case of errors during fetching and processing saml metadata. - # Here is a description of each exception. - # SSLError is raised in case of errors caused by SSL (e.g. SSL cer verification failure etc.) - # HTTPError is raised in case of unexpected status code (e.g. 500 error etc.) - # RequestException is the base exception for any request related error that "requests" lib raises. - # MetadataParseError is raised if there is error in the fetched meta data (e.g. missing @entityID etc.) - log.exception(str(error), exc_info=error) - raise error - except etree.XMLSyntaxError as error: - log.exception(str(error), exc_info=error) - raise error + addr = ipaddress.ip_address(hostname) + except ValueError: + # hostname is a domain name, not a numeric IP literal — pass through. + return + + # Loopback, link-local, and reserved ranges are never legitimate SAML IdP + # addresses regardless of deployment topology. + if addr.is_loopback or addr.is_link_local or addr.is_reserved: + raise SAMLMetadataURLError( + f"SAML metadata URL hostname is a forbidden IP address: {addr}" + ) + + # Private ranges are blocked by default but can be allowed via Django settings + # for deployments where the SAML IdP lives on the same private network. + if addr.is_private and not settings.SAML_METADATA_URL_ALLOW_PRIVATE_IPS: + raise SAMLMetadataURLError( + f"SAML metadata URL hostname is a private IP address: {addr}. " + "Set SAML_METADATA_URL_ALLOW_PRIVATE_IPS = True in Django settings to allow this." + ) def parse_metadata_xml(xml, entity_id): @@ -129,7 +150,7 @@ def parse_metadata_xml(xml, entity_id): # The only binding supported by python-saml and python-social-auth is HTTP-Redirect: sso_url = sso_bindings['urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect'] except KeyError: - raise MetadataParseError("Unable to find SSO URL with HTTP-Redirect binding.") # lint-amnesty, pylint: disable=raise-missing-from + raise MetadataParseError("Unable to find SSO URL with HTTP-Redirect binding.") # pylint: disable=raise-missing-from # noqa: B904 return public_keys, sso_url, expires_at @@ -198,35 +219,6 @@ def create_or_update_bulk_saml_provider_data(entity_id, public_keys, sso_url, ex return new_records_created -def convert_saml_slug_provider_id(provider): # lint-amnesty, pylint: disable=redefined-outer-name - """ - Provider id is stored with the backend type prefixed to it (ie "saml-") - Slug is stored without this prefix. - This just converts between them whenever you expect the opposite of what you currently have. - - Arguments: - provider (string): provider_id or slug - - Returns: - (string): Opposite of what you inputted (slug -> provider_id; provider_id -> slug) - """ - if provider.startswith('saml-'): - return provider[5:] - else: - return 'saml-' + provider - - -def validate_uuid4_string(uuid_string): - """ - Returns True if valid uuid4 string, or False - """ - try: - UUID(uuid_string, version=4) - except ValueError: - return False - return True - - def is_saml_provider(backend, kwargs): """ Verify that the third party provider uses SAML """ current_provider = provider.Registry.get_from_pipeline({'backend': backend, 'kwargs': kwargs}) @@ -235,14 +227,6 @@ def is_saml_provider(backend, kwargs): current_provider.slug in [saml_provider.slug for saml_provider in saml_providers_list]), current_provider -def is_enterprise_customer_user(provider_id, user): - """ Verify that the user linked to enterprise customer of current identity provider""" - enterprise_idp = EnterpriseCustomerIdentityProvider.objects.get(provider_id=provider_id) - - return EnterpriseCustomerUser.objects.filter(enterprise_customer=enterprise_idp.enterprise_customer, - user_id=user.id).exists() - - def is_oauth_provider(backend_name, **kwargs): """ Verify that the third party provider uses oauth diff --git a/common/djangoapps/third_party_auth/views.py b/common/djangoapps/third_party_auth/views.py index 2153354cbf9e..f31dde61005c 100644 --- a/common/djangoapps/third_party_auth/views.py +++ b/common/djangoapps/third_party_auth/views.py @@ -6,10 +6,15 @@ from django.conf import settings from django.contrib.auth.decorators import login_required -from django.core.exceptions import ValidationError, PermissionDenied +from django.core.exceptions import PermissionDenied, ValidationError from django.db import DatabaseError from django.http import ( - Http404, HttpResponse, HttpResponseNotAllowed, HttpResponseNotFound, HttpResponseServerError, JsonResponse + Http404, + HttpResponse, + HttpResponseNotAllowed, + HttpResponseNotFound, + HttpResponseServerError, + JsonResponse, ) from django.shortcuts import redirect, render from django.urls import reverse @@ -144,7 +149,7 @@ class IdPRedirectView(View): GET auth/idp_redirect/saml-default """ - def get(self, request, *args, **kwargs): # lint-amnesty, pylint: disable=unused-argument + def get(self, request, *args, **kwargs): # pylint: disable=unused-argument """ Return either a redirect to the login page of an identity provider that corresponds to the provider_slug keyword argument or a 404 if the @@ -189,7 +194,7 @@ def disconnect_json_view(request, backend, association_id=None): strategy = load_strategy(request) backend_instance = load_backend(strategy, backend, redirect_uri=request.build_absolute_uri()) # Use backend.disconnect method - simplified approach without partial pipeline - response = backend_instance.disconnect(user=user, association_id=association_id) + response = backend_instance.disconnect(user=user, association_id=association_id) # noqa: F841 # Always return JSON response regardless of what backend.disconnect returns return JsonResponse({ 'success': True, diff --git a/common/djangoapps/track/backends/__init__.py b/common/djangoapps/track/backends/__init__.py index 4a752f4aaea1..e8874303a8bf 100644 --- a/common/djangoapps/track/backends/__init__.py +++ b/common/djangoapps/track/backends/__init__.py @@ -9,7 +9,7 @@ import abc -import six +import six # noqa: F401 class BaseBackend(metaclass=abc.ABCMeta): @@ -18,10 +18,10 @@ class BaseBackend(metaclass=abc.ABCMeta): """ - def __init__(self, **kwargs): + def __init__(self, **kwargs): # noqa: B027 pass @abc.abstractmethod def send(self, event): """Send event to tracker.""" - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass diff --git a/common/djangoapps/track/backends/logger.py b/common/djangoapps/track/backends/logger.py index b44489e879b3..1b1c42978c8a 100644 --- a/common/djangoapps/track/backends/logger.py +++ b/common/djangoapps/track/backends/logger.py @@ -28,7 +28,7 @@ def __init__(self, name, **kwargs): been configured using the default python mechanisms. """ - super().__init__(**kwargs) # lint-amnesty, pylint: disable=super-with-arguments + super().__init__(**kwargs) # pylint: disable=super-with-arguments self.event_logger = logging.getLogger(name) diff --git a/common/djangoapps/track/backends/mongodb.py b/common/djangoapps/track/backends/mongodb.py index 4f0d8b7354d4..e9fe09e7537e 100644 --- a/common/djangoapps/track/backends/mongodb.py +++ b/common/djangoapps/track/backends/mongodb.py @@ -33,7 +33,7 @@ def __init__(self, **kwargs): """ - super().__init__(**kwargs) # lint-amnesty, pylint: disable=super-with-arguments + super().__init__(**kwargs) # pylint: disable=super-with-arguments # Extract connection parameters from kwargs diff --git a/common/djangoapps/track/backends/tests/test_mongodb.py b/common/djangoapps/track/backends/tests/test_mongodb.py index 6937438a70d9..0cdbcbad1709 100644 --- a/common/djangoapps/track/backends/tests/test_mongodb.py +++ b/common/djangoapps/track/backends/tests/test_mongodb.py @@ -1,12 +1,13 @@ -# lint-amnesty, pylint: disable=missing-module-docstring +# pylint: disable=missing-module-docstring from unittest.mock import patch + from django.test import TestCase from common.djangoapps.track.backends.mongodb import MongoBackend -class TestMongoBackend(TestCase): # lint-amnesty, pylint: disable=missing-class-docstring +class TestMongoBackend(TestCase): # pylint: disable=missing-class-docstring def setUp(self): super().setUp() self.mongo_patcher = patch('common.djangoapps.track.backends.mongodb.MongoClient') diff --git a/common/djangoapps/track/contexts.py b/common/djangoapps/track/contexts.py index 0ac8292e258d..2498ee8581a1 100644 --- a/common/djangoapps/track/contexts.py +++ b/common/djangoapps/track/contexts.py @@ -25,7 +25,7 @@ def course_context_from_url(url, course_id_string=None): course_id_string = match.group('course_id') if not course_id_string: log.debug( - 'no course_id found in "{url}"'.format( + 'no course_id found in "{url}"'.format( # noqa: UP032 url=str(url)[0:256] ), exc_info=True @@ -35,7 +35,7 @@ def course_context_from_url(url, course_id_string=None): course_id = CourseKey.from_string(course_id_string) except InvalidKeyError: log.warning( - 'unable to parse course_id "{course_id}"'.format( + 'unable to parse course_id "{course_id}"'.format( # noqa: UP032 course_id=str(course_id_string)[0:256] ), exc_info=True @@ -48,7 +48,7 @@ def course_context_from_course_id(course_id): """ Creates a course context from a `course_id`. - For newer parts of the system (i.e. Learning-Core-based libraries/courses/etc.) + For newer parts of the system (i.e. openedx_content-based libraries/courses/etc.) use context_dict_for_learning_context instead of this method. Example Returned Context:: diff --git a/common/djangoapps/track/management/tests/test_tracked_command.py b/common/djangoapps/track/management/tests/test_tracked_command.py index 95d94c9ec04b..dec6c952343c 100644 --- a/common/djangoapps/track/management/tests/test_tracked_command.py +++ b/common/djangoapps/track/management/tests/test_tracked_command.py @@ -1,10 +1,10 @@ -# lint-amnesty, pylint: disable=missing-module-docstring +# pylint: disable=missing-module-docstring import json -from six import StringIO from django.core.management import call_command from django.test import TestCase +from six import StringIO class CommandsTestBase(TestCase): diff --git a/common/djangoapps/track/management/tracked_command.py b/common/djangoapps/track/management/tracked_command.py index 36f725a3e5e7..9a1e489ff4bf 100644 --- a/common/djangoapps/track/management/tracked_command.py +++ b/common/djangoapps/track/management/tracked_command.py @@ -5,7 +5,7 @@ from eventtracking import tracker -class TrackedCommand(BaseCommand): # lint-amnesty, pylint: disable=abstract-method +class TrackedCommand(BaseCommand): # pylint: disable=abstract-method """ Provides management command calling info to tracking context. @@ -44,10 +44,10 @@ class TrackedCommand(BaseCommand): # lint-amnesty, pylint: disable=abstract-met """ prog_name = 'unknown' - def create_parser(self, prog_name, subcommand): # lint-amnesty, pylint: disable=arguments-differ + def create_parser(self, prog_name, subcommand): # pylint: disable=arguments-differ """Wraps create_parser to snag command line info.""" self.prog_name = f"{prog_name} {subcommand}" - return super().create_parser(prog_name, subcommand) # lint-amnesty, pylint: disable=super-with-arguments + return super().create_parser(prog_name, subcommand) # pylint: disable=super-with-arguments def execute(self, *args, **options): """Wraps base execute() to add command line to tracking context.""" @@ -56,4 +56,4 @@ def execute(self, *args, **options): } COMMAND_CONTEXT_NAME = 'edx.mgmt.command' with tracker.get_tracker().context(COMMAND_CONTEXT_NAME, context): - super().execute(*args, **options) # lint-amnesty, pylint: disable=super-with-arguments + super().execute(*args, **options) # pylint: disable=super-with-arguments diff --git a/common/djangoapps/track/middleware.py b/common/djangoapps/track/middleware.py index 482079b3bc4c..2c4bc86c69b9 100644 --- a/common/djangoapps/track/middleware.py +++ b/common/djangoapps/track/middleware.py @@ -12,7 +12,7 @@ import re import sys -import six # lint-amnesty, pylint: disable=unused-import +import six # pylint: disable=unused-import # noqa: F401 from django.conf import settings from django.utils.deprecation import MiddlewareMixin from eventtracking import tracker @@ -40,7 +40,7 @@ class TrackMiddleware(MiddlewareMixin): emitted events. """ - def process_request(self, request): # lint-amnesty, pylint: disable=missing-function-docstring + def process_request(self, request): # pylint: disable=missing-function-docstring try: self.enter_request_context(request) @@ -81,7 +81,7 @@ def process_request(self, request): # lint-amnesty, pylint: disable=missing-fun event = event[:512] views.server_track(request, request.META['PATH_INFO'], event) - except: # lint-amnesty, pylint: disable=bare-except + except: # pylint: disable=bare-except ## Why do we have the overly broad except? ## ## I added instrumentation so if we drop events on the @@ -93,7 +93,7 @@ def process_request(self, request): # lint-amnesty, pylint: disable=missing-fun event = {'event-type': 'exception', 'exception': repr(sys.exc_info()[0])} try: views.server_track(request, request.META['PATH_INFO'], event) - except: # lint-amnesty, pylint: disable=bare-except + except: # pylint: disable=bare-except # At this point, things are really broken. We really # should fail return a 500 to the user here. However, # the interim decision is to just fail in order to be diff --git a/common/djangoapps/track/segment.py b/common/djangoapps/track/segment.py index 5411df7b38aa..77185f7f754c 100644 --- a/common/djangoapps/track/segment.py +++ b/common/djangoapps/track/segment.py @@ -29,7 +29,7 @@ def track(user_id, event_name, properties=None, context=None, traits=None): if 'ip' not in segment_context and 'ip' in tracking_context: segment_context['ip'] = tracking_context.get('ip') - if ('Google Analytics' not in segment_context or 'clientId' not in segment_context['Google Analytics']) and 'client_id' in tracking_context: # lint-amnesty, pylint: disable=line-too-long + if ('Google Analytics' not in segment_context or 'clientId' not in segment_context['Google Analytics']) and 'client_id' in tracking_context: # pylint: disable=line-too-long segment_context['Google Analytics'] = { 'clientId': tracking_context.get('client_id') } diff --git a/common/djangoapps/track/tests/__init__.py b/common/djangoapps/track/tests/__init__.py index 1a24fd72155f..e30f81e6f73b 100644 --- a/common/djangoapps/track/tests/__init__.py +++ b/common/djangoapps/track/tests/__init__.py @@ -22,7 +22,7 @@ class InMemoryBackend: """A backend that simply stores all events in memory""" def __init__(self): - super().__init__() # lint-amnesty, pylint: disable=super-with-arguments + super().__init__() # pylint: disable=super-with-arguments self.events = [] def send(self, event): @@ -48,7 +48,7 @@ def setUp(self): freezer.start() self.addCleanup(freezer.stop) - super().setUp() # lint-amnesty, pylint: disable=super-with-arguments + super().setUp() # pylint: disable=super-with-arguments self.recreate_tracker() diff --git a/common/djangoapps/track/tests/test_contexts.py b/common/djangoapps/track/tests/test_contexts.py index fc3a7d97d00d..e1bac58b0aa1 100644 --- a/common/djangoapps/track/tests/test_contexts.py +++ b/common/djangoapps/track/tests/test_contexts.py @@ -1,4 +1,4 @@ -# lint-amnesty, pylint: disable=missing-module-docstring +# pylint: disable=missing-module-docstring from unittest import TestCase import ddt @@ -7,7 +7,7 @@ @ddt.ddt -class TestContexts(TestCase): # lint-amnesty, pylint: disable=missing-class-docstring +class TestContexts(TestCase): # pylint: disable=missing-class-docstring COURSE_ID = 'test/course_name/course_run' SPLIT_COURSE_ID = 'course-v1:test+course_name+course_run' diff --git a/common/djangoapps/track/tests/test_middleware.py b/common/djangoapps/track/tests/test_middleware.py index 87f063ee262a..8944e8330c22 100644 --- a/common/djangoapps/track/tests/test_middleware.py +++ b/common/djangoapps/track/tests/test_middleware.py @@ -3,7 +3,7 @@ from unittest.mock import patch, sentinel import ddt -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.contrib.sessions.middleware import SessionMiddleware from django.test import TestCase from django.test.client import RequestFactory diff --git a/common/djangoapps/track/tests/test_segment.py b/common/djangoapps/track/tests/test_segment.py index 52abf1432e14..b73fefc97c9f 100644 --- a/common/djangoapps/track/tests/test_segment.py +++ b/common/djangoapps/track/tests/test_segment.py @@ -44,7 +44,7 @@ def test_missing_name(self): def test_track_without_tracking_context(self): segment.track(sentinel.user_id, sentinel.name, self.properties) assert self.mock_segment_track.called - args, kwargs = self.mock_segment_track.call_args # lint-amnesty, pylint: disable=unused-variable + args, kwargs = self.mock_segment_track.call_args # pylint: disable=unused-variable expected_segment_context = {} assert (sentinel.user_id, sentinel.name, self.properties, expected_segment_context) == args @@ -53,16 +53,16 @@ def test_track_without_tracking_context(self): ({'ip': sentinel.ip}, {'ip': sentinel.provided_ip}, {'ip': sentinel.ip}), ({'agent': sentinel.agent}, {'userAgent': sentinel.provided_agent}, {'userAgent': sentinel.agent}), ({'path': sentinel.path}, {'page': {'path': sentinel.provided_path}}, {'page': {'path': sentinel.path}}), - ({'referer': sentinel.referer}, {'page': {'referrer': sentinel.provided_referer}}, {'page': {'referrer': sentinel.referer}}), # lint-amnesty, pylint: disable=line-too-long + ({'referer': sentinel.referer}, {'page': {'referrer': sentinel.provided_referer}}, {'page': {'referrer': sentinel.referer}}), # pylint: disable=line-too-long ({'page': sentinel.page}, {'page': {'url': sentinel.provided_page}}, {'page': {'url': sentinel.page}}), - ({'client_id': sentinel.client_id}, {'Google Analytics': {'clientId': sentinel.provided_client_id}}, {'Google Analytics': {'clientId': sentinel.client_id}}), # lint-amnesty, pylint: disable=line-too-long + ({'client_id': sentinel.client_id}, {'Google Analytics': {'clientId': sentinel.provided_client_id}}, {'Google Analytics': {'clientId': sentinel.client_id}}), # pylint: disable=line-too-long ) @override_settings(LMS_SEGMENT_KEY="testkey") def test_track_context_with_stuff(self, tracking_context, provided_context, expected_segment_context): # Test first with tracking and no provided context. with self.tracker.context('test', tracking_context): segment.track(sentinel.user_id, sentinel.name, self.properties) - args, kwargs = self.mock_segment_track.call_args # lint-amnesty, pylint: disable=unused-variable + args, kwargs = self.mock_segment_track.call_args # pylint: disable=unused-variable assert (sentinel.user_id, sentinel.name, self.properties, expected_segment_context) == args # Test with provided context and no tracking context. @@ -99,7 +99,7 @@ def test_track_with_standard_context(self): segment.track(sentinel.user_id, sentinel.name, self.properties) assert self.mock_segment_track.called - args, kwargs = self.mock_segment_track.call_args # lint-amnesty, pylint: disable=unused-variable + args, kwargs = self.mock_segment_track.call_args # pylint: disable=unused-variable expected_segment_context = { 'ip': sentinel.ip, @@ -139,7 +139,7 @@ def test_null_key(self): def test_normal_call(self): segment.identify(sentinel.user_id, self.properties) assert self.mock_segment_identify.called - args, kwargs = self.mock_segment_identify.call_args # lint-amnesty, pylint: disable=unused-variable + args, kwargs = self.mock_segment_identify.call_args # pylint: disable=unused-variable assert (sentinel.user_id, self.properties, {}) == args @override_settings(LMS_SEGMENT_KEY="testkey") @@ -147,5 +147,5 @@ def test_call_with_context(self): provided_context = {sentinel.context_key: sentinel.context_value} segment.identify(sentinel.user_id, self.properties, provided_context) assert self.mock_segment_identify.called - args, kwargs = self.mock_segment_identify.call_args # lint-amnesty, pylint: disable=unused-variable + args, kwargs = self.mock_segment_identify.call_args # pylint: disable=unused-variable assert (sentinel.user_id, self.properties, provided_context) == args diff --git a/common/djangoapps/track/tests/test_shim.py b/common/djangoapps/track/tests/test_shim.py index 68500594fe7a..33170be8ad39 100644 --- a/common/djangoapps/track/tests/test_shim.py +++ b/common/djangoapps/track/tests/test_shim.py @@ -3,18 +3,18 @@ from collections import namedtuple from unittest.mock import sentinel -import pytest + import ddt +import pytest from django.test.utils import override_settings +from opaque_keys.edx.locator import CourseLocator # pylint: disable=wrong-import-order from openedx.core.lib.tests.assertions.events import assert_events_equal -from opaque_keys.edx.locator import CourseLocator # lint-amnesty, pylint: disable=wrong-import-order from .. import transformers from ..shim import PrefixedEventProcessor from . import FROZEN_TIME, EventTrackingTestCase - LEGACY_SHIM_PROCESSOR = [ { 'ENGINE': 'common.djangoapps.track.shim.LegacyFieldMappingProcessor' diff --git a/common/djangoapps/track/tests/test_tracker.py b/common/djangoapps/track/tests/test_tracker.py index 2b42e6b2f8ca..04521d0dfbec 100644 --- a/common/djangoapps/track/tests/test_tracker.py +++ b/common/djangoapps/track/tests/test_tracker.py @@ -1,4 +1,4 @@ -# lint-amnesty, pylint: disable=missing-module-docstring +# pylint: disable=missing-module-docstring from django.conf import settings from django.test import TestCase @@ -30,7 +30,7 @@ class TestTrackerInstantiation(TestCase): """Test that a helper function can instantiate backends from their name.""" def setUp(self): # pylint: disable=protected-access - super().setUp() # lint-amnesty, pylint: disable=super-with-arguments + super().setUp() # pylint: disable=super-with-arguments self.get_backend = tracker._instantiate_backend_from_name def test_instatiate_backend(self): @@ -47,16 +47,16 @@ def get_invalid_backend(name, parameters): options = {} name = 'common.djangoapps.track.backends.logger' - self.assertRaises(ValueError, get_invalid_backend, name, options) + self.assertRaises(ValueError, get_invalid_backend, name, options) # noqa: PT027 name = 'common.djangoapps.track.backends.logger.Foo' - self.assertRaises(ValueError, get_invalid_backend, name, options) + self.assertRaises(ValueError, get_invalid_backend, name, options) # noqa: PT027 name = 'this.package.does.not.exists' - self.assertRaises(ValueError, get_invalid_backend, name, options) + self.assertRaises(ValueError, get_invalid_backend, name, options) # noqa: PT027 name = 'unittest.TestCase' - self.assertRaises(ValueError, get_invalid_backend, name, options) + self.assertRaises(ValueError, get_invalid_backend, name, options) # noqa: PT027 class TestTrackerDjangoInstantiation(TestCase): @@ -99,7 +99,7 @@ def test_django_remove_settings(self): assert len(backends) == 1 - def _reload_backends(self): # lint-amnesty, pylint: disable=missing-function-docstring + def _reload_backends(self): # pylint: disable=missing-function-docstring # pylint: disable=protected-access # Reset backends @@ -108,9 +108,9 @@ def _reload_backends(self): # lint-amnesty, pylint: disable=missing-function-do return tracker.backends -class DummyBackend(BaseBackend): # lint-amnesty, pylint: disable=missing-class-docstring +class DummyBackend(BaseBackend): # pylint: disable=missing-class-docstring def __init__(self, **options): - super().__init__(**options) # lint-amnesty, pylint: disable=super-with-arguments + super().__init__(**options) # pylint: disable=super-with-arguments self.flag = options.get('flag', False) self.count = 0 diff --git a/common/djangoapps/track/tests/test_util.py b/common/djangoapps/track/tests/test_util.py index f0414da221c9..7f98694babac 100644 --- a/common/djangoapps/track/tests/test_util.py +++ b/common/djangoapps/track/tests/test_util.py @@ -1,4 +1,4 @@ -# lint-amnesty, pylint: disable=missing-module-docstring +# pylint: disable=missing-module-docstring import json from datetime import datetime @@ -9,7 +9,7 @@ from common.djangoapps.track.utils import DateTimeJSONEncoder -class TestDateTimeJSONEncoder(TestCase): # lint-amnesty, pylint: disable=missing-class-docstring +class TestDateTimeJSONEncoder(TestCase): # pylint: disable=missing-class-docstring def test_datetime_encoding(self): a_naive_datetime = datetime(2012, 5, 1, 7, 27, 10, 20000) a_tz_datetime = datetime(2012, 5, 1, 7, 27, 10, 20000, tzinfo=ZoneInfo("UTC")) diff --git a/common/djangoapps/track/tracker.py b/common/djangoapps/track/tracker.py index 53ae9f238746..6cb8d60a5194 100644 --- a/common/djangoapps/track/tracker.py +++ b/common/djangoapps/track/tracker.py @@ -24,7 +24,7 @@ import warnings from importlib import import_module -import six # lint-amnesty, pylint: disable=unused-import +import six # pylint: disable=unused-import # noqa: F401 from django.conf import settings from common.djangoapps.track.backends import BaseBackend @@ -67,7 +67,7 @@ def _instantiate_backend_from_name(name, options): module_name = '.'.join(parts[:-1]) class_name = parts[-1] except IndexError: - raise ValueError('Invalid event track backend %s' % name) # lint-amnesty, pylint: disable=raise-missing-from + raise ValueError('Invalid event track backend %s' % name) # pylint: disable=raise-missing-from # noqa: B904, UP031 # Get and verify the backend class @@ -77,7 +77,7 @@ def _instantiate_backend_from_name(name, options): if not inspect.isclass(cls) or not issubclass(cls, BaseBackend): raise TypeError except (ValueError, AttributeError, TypeError, ImportError): - raise ValueError('Cannot find event track backend %s' % name) # lint-amnesty, pylint: disable=raise-missing-from + raise ValueError('Cannot find event track backend %s' % name) # pylint: disable=raise-missing-from # noqa: B904, UP031 backend = cls(**options) @@ -89,10 +89,10 @@ def send(event): Send an event object to all the initialized backends. """ - warnings.warn( + warnings.warn( # noqa: B028 'track.tracker module is deprecated. Please use eventtracking to send events.', DeprecationWarning ) - for name, backend in backends.items(): # lint-amnesty, pylint: disable=unused-variable + for name, backend in backends.items(): # pylint: disable=unused-variable # noqa: B007 backend.send(event) diff --git a/common/djangoapps/track/transformers.py b/common/djangoapps/track/transformers.py index 8ff9a86f4f65..7883632a2eb1 100644 --- a/common/djangoapps/track/transformers.py +++ b/common/djangoapps/track/transformers.py @@ -9,7 +9,7 @@ import json import logging -import six # lint-amnesty, pylint: disable=unused-import +import six # pylint: disable=unused-import # noqa: F401 from opaque_keys import InvalidKeyError from opaque_keys.edx.keys import UsageKey @@ -184,7 +184,7 @@ class EventTransformer(dict): always be run. """ def __init__(self, *args, **kwargs): - super().__init__(*args, **kwargs) # lint-amnesty, pylint: disable=super-with-arguments + super().__init__(*args, **kwargs) # pylint: disable=super-with-arguments self.load_payload() # Properties to be overridden @@ -261,14 +261,14 @@ def process_legacy_fields(self): Override this method to specify how to update event fields to maintain compatibility with legacy events. """ - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass def process_event(self): """ Override this method to make unconditional modifications to event fields. """ - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass @EventTransformerRegistry.register @@ -395,7 +395,7 @@ def transform(self): expected types of events. """ if self.name in self.name_to_event_type_map: - super().transform() # lint-amnesty, pylint: disable=super-with-arguments + super().transform() # pylint: disable=super-with-arguments def process_event(self): """ diff --git a/common/djangoapps/track/utils.py b/common/djangoapps/track/utils.py index 5efdde4c5ad0..37547b2d4b67 100644 --- a/common/djangoapps/track/utils.py +++ b/common/djangoapps/track/utils.py @@ -10,7 +10,7 @@ class DateTimeJSONEncoder(json.JSONEncoder): """JSON encoder aware of datetime.datetime and datetime.date objects""" - def default(self, obj): # lint-amnesty, pylint: disable=arguments-differ, method-hidden + def default(self, obj): # pylint: disable=arguments-differ, method-hidden """ Serialize datetime and date objects of iso format. @@ -20,7 +20,7 @@ def default(self, obj): # lint-amnesty, pylint: disable=arguments-differ, metho if isinstance(obj, datetime): if obj.tzinfo is None: # Localize to UTC naive datetime objects - obj = UTC.localize(obj) # lint-amnesty, pylint: disable=no-value-for-parameter + obj = UTC.localize(obj) # pylint: disable=no-value-for-parameter else: # Convert to UTC datetime objects from other timezones obj = obj.astimezone(UTC) @@ -28,4 +28,4 @@ def default(self, obj): # lint-amnesty, pylint: disable=arguments-differ, metho elif isinstance(obj, date): return obj.isoformat() - return super().default(obj) # lint-amnesty, pylint: disable=super-with-arguments + return super().default(obj) # pylint: disable=super-with-arguments diff --git a/common/djangoapps/track/views/__init__.py b/common/djangoapps/track/views/__init__.py index 140afbd0e640..aa0e4e5d1a5c 100644 --- a/common/djangoapps/track/views/__init__.py +++ b/common/djangoapps/track/views/__init__.py @@ -1,14 +1,14 @@ -# lint-amnesty, pylint: disable=missing-module-docstring +# pylint: disable=missing-module-docstring import json -import six -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +import six # noqa: F401 +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.http import HttpResponse from eventtracking import tracker as eventtracker from ipware.ip import get_client_ip -from common.djangoapps.track import contexts, shim, tracker +from common.djangoapps.track import contexts, shim, tracker # noqa: F401 from lms.djangoapps.utils import OptimizelyClient @@ -75,7 +75,7 @@ def user_track(request): """ try: username = request.user.username - except: # lint-amnesty, pylint: disable=bare-except + except: # pylint: disable=bare-except username = "anonymous" name = _get_request_value(request, 'event_type') @@ -123,7 +123,7 @@ def server_track(request, event_type, event, page=None): try: username = request.user.username - except: # lint-amnesty, pylint: disable=bare-except + except: # pylint: disable=bare-except username = "anonymous" context_override = _get_course_context(page) diff --git a/common/djangoapps/track/views/segmentio.py b/common/djangoapps/track/views/segmentio.py index 8a35a0e421cf..09cab7874bea 100644 --- a/common/djangoapps/track/views/segmentio.py +++ b/common/djangoapps/track/views/segmentio.py @@ -6,7 +6,7 @@ from dateutil import parser from django.conf import settings -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.http import HttpResponse from django.views.decorators.csrf import csrf_exempt from django.views.decorators.http import require_POST @@ -86,7 +86,7 @@ def segmentio_event(request): class EventValidationError(Exception): """Raised when an invalid event is received.""" - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass def track_segmentio_event(request): # pylint: disable=too-many-statements @@ -165,13 +165,13 @@ def track_segmentio_event(request): # pylint: disable=too-many-statements if 'data' not in segment_properties: raise EventValidationError(ERROR_MISSING_DATA) segment_event_data = segment_properties.get('data', {}) - if type(segment_event_data) is not dict: # lint-amnesty, pylint: disable=unidiomatic-typecheck + if type(segment_event_data) is not dict: # pylint: disable=unidiomatic-typecheck set_custom_attribute('segment_unexpected_data', str(segment_event_data)) raise EventValidationError(ERROR_INVALID_DATA_FIELD_TYPE) # create and populate application field if it doesn't exist app_context = segment_properties.get('context', {}) - if type(app_context) is not dict: # lint-amnesty, pylint: disable=unidiomatic-typecheck + if type(app_context) is not dict: # pylint: disable=unidiomatic-typecheck set_custom_attribute('segment_unexpected_context', str(app_context)) raise EventValidationError(ERROR_INVALID_CONTEXT_FIELD_TYPE) if 'application' not in app_context: @@ -202,9 +202,9 @@ def track_segmentio_event(request): # pylint: disable=too-many-statements try: user = User.objects.get(pk=user_id) except User.DoesNotExist: - raise EventValidationError(ERROR_USER_NOT_EXIST) # lint-amnesty, pylint: disable=raise-missing-from + raise EventValidationError(ERROR_USER_NOT_EXIST) # pylint: disable=raise-missing-from # noqa: B904 except ValueError: - raise EventValidationError(ERROR_INVALID_USER_ID) # lint-amnesty, pylint: disable=raise-missing-from + raise EventValidationError(ERROR_INVALID_USER_ID) # pylint: disable=raise-missing-from # noqa: B904 context['user_id'] = user.id context['username'] = user.username @@ -216,7 +216,7 @@ def track_segmentio_event(request): # pylint: disable=too-many-statements context['org_id'] = course_key.org except InvalidKeyError: log.warning( - 'unable to parse course_id "{course_id}" from event: {event}'.format( + 'unable to parse course_id "{course_id}" from event: {event}'.format( # noqa: UP032 course_id=course_id, event=json.dumps(full_segment_event), ), diff --git a/common/djangoapps/track/views/tests/base.py b/common/djangoapps/track/views/tests/base.py index 69a68760234d..d85a8529a6b4 100644 --- a/common/djangoapps/track/views/tests/base.py +++ b/common/djangoapps/track/views/tests/base.py @@ -5,8 +5,8 @@ import json - from unittest.mock import sentinel + from django.test.client import RequestFactory from django.test.utils import override_settings diff --git a/common/djangoapps/track/views/tests/test_segmentio.py b/common/djangoapps/track/views/tests/test_segmentio.py index 2edb8395ebe8..9b8e71eb9d67 100644 --- a/common/djangoapps/track/views/tests/test_segmentio.py +++ b/common/djangoapps/track/views/tests/test_segmentio.py @@ -6,20 +6,24 @@ from dateutil import parser from ddt import data, ddt, unpack -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.test.utils import override_settings -from openedx.core.lib.tests.assertions.events import assert_event_matches from common.djangoapps.track.middleware import TrackMiddleware from common.djangoapps.track.views import segmentio -from common.djangoapps.track.views.tests.base import SEGMENTIO_TEST_ENDPOINT, SEGMENTIO_TEST_USER_ID, SegmentIOTrackingTestCaseBase # lint-amnesty, pylint: disable=line-too-long +from common.djangoapps.track.views.tests.base import ( # pylint: disable=line-too-long + SEGMENTIO_TEST_ENDPOINT, + SEGMENTIO_TEST_USER_ID, + SegmentIOTrackingTestCaseBase, +) +from openedx.core.lib.tests.assertions.events import assert_event_matches def expect_failure_with_message(message): """Ensure the test raises an exception and does not emit an event""" def test_decorator(func): def test_decorated(self, *args, **kwargs): - self.assertRaisesRegex(segmentio.EventValidationError, message, func, self, *args, **kwargs) + self.assertRaisesRegex(segmentio.EventValidationError, message, func, self, *args, **kwargs) # noqa: PT027 self.assert_no_events_emitted() return test_decorated return test_decorator @@ -367,29 +371,29 @@ def test_video_event(self, name, event_type): # Verify positive slide case. Verify slide to onSlideSeek. Verify # edx.video.seeked emitted from iOS v1.0.02 is changed to # edx.video.position.changed. - (1, 1, "seek_type", "slide", "onSlideSeek", "edx.video.seeked", "edx.video.position.changed", 'edx.mobileapp.iOS', '1.0.02'), # lint-amnesty, pylint: disable=line-too-long + (1, 1, "seek_type", "slide", "onSlideSeek", "edx.video.seeked", "edx.video.position.changed", 'edx.mobileapp.iOS', '1.0.02'), # pylint: disable=line-too-long # Verify negative slide case. Verify slide to onSlideSeek. Verify # edx.video.seeked to edx.video.position.changed. - (-2, -2, "seek_type", "slide", "onSlideSeek", "edx.video.seeked", "edx.video.position.changed", 'edx.mobileapp.iOS', '1.0.02'), # lint-amnesty, pylint: disable=line-too-long + (-2, -2, "seek_type", "slide", "onSlideSeek", "edx.video.seeked", "edx.video.position.changed", 'edx.mobileapp.iOS', '1.0.02'), # pylint: disable=line-too-long # Verify +30 is changed to -30 which is incorrectly emitted in iOS # v1.0.02. Verify skip to onSkipSeek - (30, -30, "seek_type", "skip", "onSkipSeek", "edx.video.position.changed", "edx.video.position.changed", 'edx.mobileapp.iOS', '1.0.02'), # lint-amnesty, pylint: disable=line-too-long + (30, -30, "seek_type", "skip", "onSkipSeek", "edx.video.position.changed", "edx.video.position.changed", 'edx.mobileapp.iOS', '1.0.02'), # pylint: disable=line-too-long # Verify the correct case of -30 is also handled as well. Verify skip # to onSkipSeek - (-30, -30, "seek_type", "skip", "onSkipSeek", "edx.video.position.changed", "edx.video.position.changed", 'edx.mobileapp.iOS', '1.0.02'), # lint-amnesty, pylint: disable=line-too-long + (-30, -30, "seek_type", "skip", "onSkipSeek", "edx.video.position.changed", "edx.video.position.changed", 'edx.mobileapp.iOS', '1.0.02'), # pylint: disable=line-too-long # Verify positive slide case where onSkipSeek is changed to # onSlideSkip. Verify edx.video.seeked emitted from Android v1.0.02 is # changed to edx.video.position.changed. - (1, 1, "type", "onSkipSeek", "onSlideSeek", "edx.video.seeked", "edx.video.position.changed", 'edx.mobileapp.android', '1.0.02'), # lint-amnesty, pylint: disable=line-too-long + (1, 1, "type", "onSkipSeek", "onSlideSeek", "edx.video.seeked", "edx.video.position.changed", 'edx.mobileapp.android', '1.0.02'), # pylint: disable=line-too-long # Verify positive slide case where onSkipSeek is changed to # onSlideSkip. Verify edx.video.seeked emitted from Android v1.0.02 is # changed to edx.video.position.changed. - (-2, -2, "type", "onSkipSeek", "onSlideSeek", "edx.video.seeked", "edx.video.position.changed", 'edx.mobileapp.android', '1.0.02'), # lint-amnesty, pylint: disable=line-too-long + (-2, -2, "type", "onSkipSeek", "onSlideSeek", "edx.video.seeked", "edx.video.position.changed", 'edx.mobileapp.android', '1.0.02'), # pylint: disable=line-too-long # Verify positive skip case where onSkipSeek is not changed and does # not become negative. - (30, 30, "type", "onSkipSeek", "onSkipSeek", "edx.video.position.changed", "edx.video.position.changed", 'edx.mobileapp.android', '1.0.02'), # lint-amnesty, pylint: disable=line-too-long + (30, 30, "type", "onSkipSeek", "onSkipSeek", "edx.video.position.changed", "edx.video.position.changed", 'edx.mobileapp.android', '1.0.02'), # pylint: disable=line-too-long # Verify positive skip case where onSkipSeek is not changed. - (-30, -30, "type", "onSkipSeek", "onSkipSeek", "edx.video.position.changed", "edx.video.position.changed", 'edx.mobileapp.android', '1.0.02') # lint-amnesty, pylint: disable=line-too-long + (-30, -30, "type", "onSkipSeek", "onSkipSeek", "edx.video.position.changed", "edx.video.position.changed", 'edx.mobileapp.android', '1.0.02') # pylint: disable=line-too-long ) @unpack def test_previous_builds(self, diff --git a/common/djangoapps/track/views/tests/test_views.py b/common/djangoapps/track/views/tests/test_views.py index 1d77e2e5b925..c590996e3d17 100644 --- a/common/djangoapps/track/views/tests/test_views.py +++ b/common/djangoapps/track/views/tests/test_views.py @@ -1,23 +1,23 @@ -# lint-amnesty, pylint: disable=missing-module-docstring +# pylint: disable=missing-module-docstring from unittest.mock import patch, sentinel import ddt -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.test.client import RequestFactory from django.test.utils import override_settings -from openedx.core.lib.tests.assertions.events import assert_event_matches from common.djangoapps.track import views from common.djangoapps.track.middleware import TrackMiddleware from common.djangoapps.track.tests import FROZEN_TIME, EventTrackingTestCase +from openedx.core.lib.tests.assertions.events import assert_event_matches TEST_USERNAME = 'test-username' TEST_USER_ID = 1000 @ddt.ddt -class TestTrackViews(EventTrackingTestCase): # lint-amnesty, pylint: disable=missing-class-docstring +class TestTrackViews(EventTrackingTestCase): # pylint: disable=missing-class-docstring @classmethod def setUpTestData(cls): diff --git a/common/djangoapps/util/cache.py b/common/djangoapps/util/cache.py index 3ec99efc636d..a6c29faf433b 100644 --- a/common/djangoapps/util/cache.py +++ b/common/djangoapps/util/cache.py @@ -11,13 +11,14 @@ from urllib.parse import urlencode from django.core import cache + # If we can't find a 'general' CACHE defined in settings.py, we simply fall back # to returning the default cache. This will happen with dev machines. from django.utils.translation import get_language try: cache = cache.caches['general'] # pylint: disable=invalid-name -except Exception: # lint-amnesty, pylint: disable=broad-except +except Exception: # pylint: disable=broad-except cache = cache.cache diff --git a/common/djangoapps/util/course.py b/common/djangoapps/util/course.py index abef18a3263d..6eeaec0966f6 100644 --- a/common/djangoapps/util/course.py +++ b/common/djangoapps/util/course.py @@ -8,10 +8,10 @@ from django.conf import settings from opaque_keys.edx.keys import CourseKey, UsageKey +from openedx_filters.learning.filters import CourseAboutPageURLRequested from lms.djangoapps.branding.toggles import use_catalog_mfe from openedx.core.djangoapps.site_configuration import helpers as configuration_helpers -from openedx_filters.learning.filters import CourseAboutPageURLRequested log = logging.getLogger(__name__) diff --git a/common/djangoapps/util/date_utils.py b/common/djangoapps/util/date_utils.py index 968fb55d7cda..f742b02f76b3 100644 --- a/common/djangoapps/util/date_utils.py +++ b/common/djangoapps/util/date_utils.py @@ -29,7 +29,7 @@ def get_default_time_display(dtime): return "" if dtime.tzinfo is not None: try: - timezone = " " + dtime.tzinfo.tzname(dtime) # lint-amnesty, pylint: disable=redefined-outer-name + timezone = " " + dtime.tzinfo.tzname(dtime) # pylint: disable=redefined-outer-name except NotImplementedError: timezone = dtime.strftime('%z') else: @@ -137,7 +137,7 @@ def strftime_localized(dtime, format): # pylint: disable=redefined-builtin if format == "SHORT_DATE": format = "%x" - elif format == "LONG_DATE": # lint-amnesty, pylint: disable=comparison-with-callable + elif format == "LONG_DATE": # pylint: disable=comparison-with-callable # Translators: the translation for "LONG_DATE_FORMAT" must be a format # string for formatting dates in a long form. For example, the # American English form is "%A, %B %d %Y". @@ -145,7 +145,7 @@ def strftime_localized(dtime, format): # pylint: disable=redefined-builtin format = gettext("LONG_DATE_FORMAT") if format == "LONG_DATE_FORMAT": format = DEFAULT_LONG_DATE_FORMAT - elif format == "DATE_TIME": # lint-amnesty, pylint: disable=comparison-with-callable + elif format == "DATE_TIME": # pylint: disable=comparison-with-callable # Translators: the translation for "DATE_TIME_FORMAT" must be a format # string for formatting dates with times. For example, the American # English form is "%b %d, %Y at %H:%M". @@ -153,9 +153,9 @@ def strftime_localized(dtime, format): # pylint: disable=redefined-builtin format = gettext("DATE_TIME_FORMAT") if format == "DATE_TIME_FORMAT": format = DEFAULT_DATE_TIME_FORMAT - elif format == "DAY_AND_TIME": # lint-amnesty, pylint: disable=comparison-with-callable + elif format == "DAY_AND_TIME": # pylint: disable=comparison-with-callable format = DEFAULT_DAY_AND_TIME_FORMAT - elif format == "TIME": # lint-amnesty, pylint: disable=comparison-with-callable + elif format == "TIME": # pylint: disable=comparison-with-callable format = "%X" def process_percent_code(match): @@ -236,7 +236,7 @@ def strftime_localized_html(dtime, fmt): format_mapping = { 'SHORT_DATE': 'shortDate', } - assert fmt in format_mapping.keys(), 'format "%s" not yet supported in strftime_localized_html' % fmt # pylint: disable=consider-iterating-dictionary + assert fmt in format_mapping.keys(), 'format "%s" not yet supported in strftime_localized_html' % fmt # pylint: disable=consider-iterating-dictionary # noqa: UP031 date_html = '{formatted_date_localized}' diff --git a/common/djangoapps/util/db.py b/common/djangoapps/util/db.py index 6291c6ea0075..a95b04774671 100644 --- a/common/djangoapps/util/db.py +++ b/common/djangoapps/util/db.py @@ -1,14 +1,16 @@ -# lint-amnesty, pylint: disable=django-not-configured +# pylint: disable=django-not-configured """ Utility functions related to databases. """ import random + # TransactionManagementError used below actually *does* derive from the standard "Exception" class. -# lint-amnesty, pylint: disable=bad-option-value, nonstandard-exception +# pylint: disable=bad-option-value, nonstandard-exception from contextlib import contextmanager -from django.db import DEFAULT_DB_ALIAS, transaction # lint-amnesty, pylint: disable=unused-import + +from django.db import DEFAULT_DB_ALIAS, transaction # pylint: disable=unused-import from openedx.core.lib.cache_utils import get_cache @@ -74,7 +76,7 @@ def __enter__(self): # The inner atomic starts a savepoint around the test. # So, for tests only, there should be exactly one savepoint_id and two atomic_for_testcase_calls. # atomic_for_testcase_calls below is added in a monkey-patch for tests only. - if self.ALLOW_NESTED and (self.atomic_for_testcase_calls - len(connection.savepoint_ids)) < 1: # lint-amnesty, pylint: disable=no-member + if self.ALLOW_NESTED and (self.atomic_for_testcase_calls - len(connection.savepoint_ids)) < 1: # pylint: disable=no-member raise transaction.TransactionManagementError('Cannot be inside an atomic block.') # Otherwise, this shouldn't be nested in any atomic block. diff --git a/common/djangoapps/util/disable_rate_limit.py b/common/djangoapps/util/disable_rate_limit.py index d649583f5f9c..980064e3eaf5 100644 --- a/common/djangoapps/util/disable_rate_limit.py +++ b/common/djangoapps/util/disable_rate_limit.py @@ -72,7 +72,7 @@ def can_disable_rate_limit(clz): """ # No-op if the class isn't a Django Rest Framework view. if not issubclass(clz, APIView): - msg = ( + msg = ( # noqa: UP032 "{clz} is not a Django Rest Framework APIView subclass." ).format(clz=clz) LOGGER.warning(msg) diff --git a/common/djangoapps/util/file.py b/common/djangoapps/util/file.py index 57ac2c8534c4..514cb8a862cf 100644 --- a/common/djangoapps/util/file.py +++ b/common/djangoapps/util/file.py @@ -20,7 +20,7 @@ class FileValidationException(Exception): """ An exception thrown during file validation. """ - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass def store_uploaded_file( diff --git a/common/djangoapps/util/json_request.py b/common/djangoapps/util/json_request.py index 7cbd38fcb237..f3f730768ccf 100644 --- a/common/djangoapps/util/json_request.py +++ b/common/djangoapps/util/json_request.py @@ -1,4 +1,4 @@ -# lint-amnesty, pylint: disable=missing-module-docstring +# pylint: disable=missing-module-docstring import decimal import json @@ -83,7 +83,7 @@ class JsonResponse(HttpResponse): Django HttpResponse subclass that has sensible defaults for outputting JSON. """ - def __init__( # lint-amnesty, pylint: disable=keyword-arg-before-vararg + def __init__( # pylint: disable=keyword-arg-before-vararg self, resp_obj=None, status=None, @@ -117,7 +117,7 @@ class JsonResponseBadRequest(HttpResponseBadRequest): def __init__( self, obj=None, status=400, encoder=DjangoJSONEncoder, *args, **kwargs - ): # lint-amnesty, pylint: disable=keyword-arg-before-vararg + ): # pylint: disable=keyword-arg-before-vararg if obj in (None, ""): content = "" else: diff --git a/common/djangoapps/util/keyword_substitution.py b/common/djangoapps/util/keyword_substitution.py index 7422027a580a..ac1bcd2c23c2 100644 --- a/common/djangoapps/util/keyword_substitution.py +++ b/common/djangoapps/util/keyword_substitution.py @@ -19,7 +19,7 @@ """ -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from common.djangoapps.student.models import anonymous_id_for_user @@ -50,7 +50,7 @@ def substitute_keywords(string, user_id, context): '%%COURSE_END_DATE%%': lambda: context.get('course_end_date'), } - for key in KEYWORD_FUNCTION_MAP.keys(): # lint-amnesty, pylint: disable=consider-iterating-dictionary + for key in KEYWORD_FUNCTION_MAP.keys(): # pylint: disable=consider-iterating-dictionary if key in string: substitutor = KEYWORD_FUNCTION_MAP[key] string = string.replace(key, substitutor()) diff --git a/common/djangoapps/util/milestones_helpers.py b/common/djangoapps/util/milestones_helpers.py index 94ec358f9286..81954ede7f16 100644 --- a/common/djangoapps/util/milestones_helpers.py +++ b/common/djangoapps/util/milestones_helpers.py @@ -13,8 +13,7 @@ from openedx.core.djangoapps.content.course_overviews.models import CourseOverview from openedx.core.lib.cache_utils import get_cache -from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order - +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order NAMESPACE_CHOICES = { 'ENTRANCE_EXAM': 'entrance_exams' @@ -233,7 +232,7 @@ def get_required_content(course_key, user): # For each outstanding milestone, see if this content is one of its fulfillment paths for path_key in milestone_paths: milestone_path = milestone_paths[path_key] - if milestone_path.get('content') and len(milestone_path['content']): # lint-amnesty, pylint: disable=len-as-condition + if milestone_path.get('content') and len(milestone_path['content']): # pylint: disable=len-as-condition for content in milestone_path['content']: required_content.append(content) else: diff --git a/common/djangoapps/util/model_utils.py b/common/djangoapps/util/model_utils.py index f41e2c171d29..dffbea74f403 100644 --- a/common/djangoapps/util/model_utils.py +++ b/common/djangoapps/util/model_utils.py @@ -2,7 +2,7 @@ Utilities for django models. """ -from typing import Dict, Any, Tuple +from typing import Any, Dict, Tuple # noqa: UP035 from django.conf import settings from django.dispatch import Signal @@ -130,7 +130,7 @@ def truncate_fields(old_value, new_value): return {'old': serialized_old_value, 'new': serialized_new_value, 'truncated': truncated_values} -def emit_settings_changed_event(user, db_table, changed_fields: Dict[str, Tuple[Any, Any]]): +def emit_settings_changed_event(user, db_table, changed_fields: Dict[str, Tuple[Any, Any]]): # noqa: UP006 """Emits an event for a change in a setting. Args: diff --git a/common/djangoapps/util/models.py b/common/djangoapps/util/models.py index 9f55d41b8edf..b13f88835a56 100644 --- a/common/djangoapps/util/models.py +++ b/common/djangoapps/util/models.py @@ -40,7 +40,7 @@ def decompress_string(value): zfile = gzip.GzipFile(fileobj=zbuf) ret = zfile.read() zfile.close() - except Exception as e: # lint-amnesty, pylint: disable=broad-except + except Exception as e: # pylint: disable=broad-except logger.error('String decompression failed. There may be corrupted data in the database: %s', e) ret = value return ret diff --git a/common/djangoapps/util/password_policy_validators.py b/common/djangoapps/util/password_policy_validators.py index 3efe0d2fc3cd..3c88028ea8f1 100644 --- a/common/djangoapps/util/password_policy_validators.py +++ b/common/djangoapps/util/password_policy_validators.py @@ -22,7 +22,7 @@ DEFAULT_MAX_PASSWORD_LENGTH = 5000 -def create_validator_config(name, options={}): # lint-amnesty, pylint: disable=dangerous-default-value +def create_validator_config(name, options={}): # pylint: disable=dangerous-default-value # noqa: B006 """ This function is meant to be used for testing purposes to create validators easily. It returns a validator config of the form: @@ -70,7 +70,7 @@ def password_validators_instruction_texts(): complexity_instructions=' & '.join(complexity_instructions) ) else: - return _(f'Your password must contain {length_instruction}.') # lint-amnesty, pylint: disable=translation-of-non-string + return _(f'Your password must contain {length_instruction}.') # pylint: disable=translation-of-non-string def password_validators_restrictions(): @@ -98,7 +98,7 @@ def normalize_password(password): password = str(password, encoding='utf8') except UnicodeDecodeError: # no reason to get into weeds - raise ValidationError([_('Invalid password.')]) # lint-amnesty, pylint: disable=raise-missing-from + raise ValidationError([_('Invalid password.')]) # pylint: disable=raise-missing-from # noqa: B904 return unicodedata.normalize('NFKC', password) @@ -143,7 +143,7 @@ def _validate_condition(password, fn, min_count): return valid_count >= min_count -class MinimumLengthValidator(DjangoMinimumLengthValidator): # lint-amnesty, pylint: disable=missing-class-docstring +class MinimumLengthValidator(DjangoMinimumLengthValidator): # pylint: disable=missing-class-docstring def get_instruction_text(self): return ngettext( 'at least %(min_length)d character', @@ -168,7 +168,7 @@ class MaximumLengthValidator: def __init__(self, max_length=75): self.max_length = max_length - def validate(self, password, user=None): # lint-amnesty, pylint: disable=unused-argument + def validate(self, password, user=None): # pylint: disable=unused-argument if len(password) > self.max_length: raise ValidationError( ngettext( @@ -205,7 +205,7 @@ class AlphabeticValidator: def __init__(self, min_alphabetic=0): self.min_alphabetic = min_alphabetic - def validate(self, password, user=None): # lint-amnesty, pylint: disable=unused-argument + def validate(self, password, user=None): # pylint: disable=unused-argument if _validate_condition(password, lambda c: c.isalpha(), self.min_alphabetic): return raise ValidationError( @@ -225,7 +225,7 @@ def get_help_text(self): self.min_alphabetic ) % {'min_alphabetic': self.min_alphabetic} - def get_instruction_text(self): # lint-amnesty, pylint: disable=missing-function-docstring + def get_instruction_text(self): # pylint: disable=missing-function-docstring if self.min_alphabetic > 0: return ngettext( '%(num)d letter', @@ -253,7 +253,7 @@ class NumericValidator: def __init__(self, min_numeric=0): self.min_numeric = min_numeric - def validate(self, password, user=None): # lint-amnesty, pylint: disable=unused-argument + def validate(self, password, user=None): # pylint: disable=unused-argument if _validate_condition(password, lambda c: c.isnumeric(), self.min_numeric): return raise ValidationError( @@ -273,7 +273,7 @@ def get_help_text(self): self.min_numeric ) % {'min_numeric': self.min_numeric} - def get_instruction_text(self): # lint-amnesty, pylint: disable=missing-function-docstring + def get_instruction_text(self): # pylint: disable=missing-function-docstring if self.min_numeric > 0: return ngettext( '%(num)d number', @@ -301,7 +301,7 @@ class UppercaseValidator: def __init__(self, min_upper=0): self.min_upper = min_upper - def validate(self, password, user=None): # lint-amnesty, pylint: disable=unused-argument + def validate(self, password, user=None): # pylint: disable=unused-argument if _validate_condition(password, lambda c: c.isupper(), self.min_upper): return raise ValidationError( @@ -321,7 +321,7 @@ def get_help_text(self): self.min_upper ) % {'min_upper': self.min_upper} - def get_instruction_text(self): # lint-amnesty, pylint: disable=missing-function-docstring + def get_instruction_text(self): # pylint: disable=missing-function-docstring if self.min_upper > 0: return ngettext( '%(num)d uppercase letter', @@ -349,7 +349,7 @@ class LowercaseValidator: def __init__(self, min_lower=0): self.min_lower = min_lower - def validate(self, password, user=None): # lint-amnesty, pylint: disable=unused-argument + def validate(self, password, user=None): # pylint: disable=unused-argument if _validate_condition(password, lambda c: c.islower(), self.min_lower): return raise ValidationError( @@ -369,7 +369,7 @@ def get_help_text(self): self.min_lower ) % {'min_lower': self.min_lower} - def get_instruction_text(self): # lint-amnesty, pylint: disable=missing-function-docstring + def get_instruction_text(self): # pylint: disable=missing-function-docstring if self.min_lower > 0: return ngettext( '%(num)d lowercase letter', @@ -398,7 +398,7 @@ class PunctuationValidator: def __init__(self, min_punctuation=0): self.min_punctuation = min_punctuation - def validate(self, password, user=None): # lint-amnesty, pylint: disable=unused-argument + def validate(self, password, user=None): # pylint: disable=unused-argument if _validate_condition(password, lambda c: 'P' in unicodedata.category(c), self.min_punctuation): return raise ValidationError( @@ -418,7 +418,7 @@ def get_help_text(self): self.min_punctuation ) % {'min_punctuation': self.min_punctuation} - def get_instruction_text(self): # lint-amnesty, pylint: disable=missing-function-docstring + def get_instruction_text(self): # pylint: disable=missing-function-docstring if self.min_punctuation > 0: return ngettext( '%(num)d punctuation mark', @@ -446,7 +446,7 @@ class SymbolValidator: def __init__(self, min_symbol=0): self.min_symbol = min_symbol - def validate(self, password, user=None): # lint-amnesty, pylint: disable=unused-argument + def validate(self, password, user=None): # pylint: disable=unused-argument if _validate_condition(password, lambda c: 'S' in unicodedata.category(c), self.min_symbol): return raise ValidationError( @@ -466,7 +466,7 @@ def get_help_text(self): self.min_symbol ) % {'min_symbol': self.min_symbol} - def get_instruction_text(self): # lint-amnesty, pylint: disable=missing-function-docstring + def get_instruction_text(self): # pylint: disable=missing-function-docstring if self.min_symbol > 0: return ngettext( '%(num)d symbol', diff --git a/common/djangoapps/util/query.py b/common/djangoapps/util/query.py index 55c80e9d4024..917ab01df7e7 100644 --- a/common/djangoapps/util/query.py +++ b/common/djangoapps/util/query.py @@ -3,7 +3,6 @@ from django.conf import settings - _READ_REPLICA_DB_ALIAS = "read_replica" diff --git a/common/djangoapps/util/storage.py b/common/djangoapps/util/storage.py index b818acf90017..a718534381e6 100644 --- a/common/djangoapps/util/storage.py +++ b/common/djangoapps/util/storage.py @@ -1,20 +1,19 @@ """ Utility functions related to django storages """ import logging +from typing import List, Optional # noqa: UP035 -from typing import Optional, List from django.conf import settings from django.core.files.storage import storages from django.utils.module_loading import import_string - logger = logging.getLogger(__name__) def resolve_storage_backend( storage_key: str, legacy_setting_key: str, - legacy_sec_setting_keys: List[str] = None, - options: Optional[dict] = None): + legacy_sec_setting_keys: List[str] = None, # noqa: UP006 + options: Optional[dict] = None): # noqa: UP045 """ Configures and returns a Django `Storage` instance, compatible with both Django 4 and Django 5. Params: diff --git a/common/djangoapps/util/string_utils.py b/common/djangoapps/util/string_utils.py index ddb4b98d10b7..30c7e37aca39 100644 --- a/common/djangoapps/util/string_utils.py +++ b/common/djangoapps/util/string_utils.py @@ -3,7 +3,7 @@ """ -def str_to_bool(str): # lint-amnesty, pylint: disable=redefined-builtin +def str_to_bool(str): # pylint: disable=redefined-builtin """ Converts "true" (case-insensitive) to the boolean True. Everything else will return False (including None). diff --git a/common/djangoapps/util/tests/mixins/discovery.py b/common/djangoapps/util/tests/mixins/discovery.py index b47a2c9fe15c..c673047d5e72 100644 --- a/common/djangoapps/util/tests/mixins/discovery.py +++ b/common/djangoapps/util/tests/mixins/discovery.py @@ -14,7 +14,7 @@ class CourseCatalogServiceMockMixin: """ Mocks for the Open edX service 'Course Catalog Service' responses. """ - COURSE_DISCOVERY_CATALOGS_URL = '{}/catalogs/'.format( + COURSE_DISCOVERY_CATALOGS_URL = '{}/catalogs/'.format( # noqa: UP032 settings.COURSE_CATALOG_API_URL, ) diff --git a/common/djangoapps/util/tests/test_course.py b/common/djangoapps/util/tests/test_course.py index f0baf5581479..880d64735ad7 100644 --- a/common/djangoapps/util/tests/test_course.py +++ b/common/djangoapps/util/tests/test_course.py @@ -7,11 +7,13 @@ from django.conf import settings from django.test import override_settings -from openedx.core.djangoapps.content.course_overviews.models import CourseOverview from common.djangoapps.util.course import get_link_for_about_page -from xmodule.modulestore import ModuleStoreEnum # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from openedx.core.djangoapps.content.course_overviews.models import CourseOverview +from xmodule.modulestore import ModuleStoreEnum # pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + ModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order @ddt.ddt diff --git a/common/djangoapps/util/tests/test_date_utils.py b/common/djangoapps/util/tests/test_date_utils.py index f5f26d6eff9a..e6c711632188 100644 --- a/common/djangoapps/util/tests/test_date_utils.py +++ b/common/djangoapps/util/tests/test_date_utils.py @@ -10,12 +10,15 @@ import crum import ddt import pytest -from markupsafe import Markup - from django.test.client import RequestFactory +from markupsafe import Markup from common.djangoapps.util.date_utils import ( - almost_same_datetime, get_default_time_display, get_time_display, strftime_localized, strftime_localized_html + almost_same_datetime, + get_default_time_display, + get_time_display, + strftime_localized, + strftime_localized_html, ) @@ -62,7 +65,7 @@ def test_get_time_display_coerce(): assert get_time_display(test_time_daylight, '%b %d %H:%M', coerce_tz="US/Pacific") == "Jul 12 08:03" -class NamelessTZ(tzinfo): # lint-amnesty, pylint: disable=abstract-method +class NamelessTZ(tzinfo): # pylint: disable=abstract-method """Static timezone for testing""" def utcoffset(self, _dt): @@ -211,7 +214,7 @@ def test_recursion_protection(self, fmt_expected): ) def test_invalid_format_strings(self, fmt): dtime = datetime(2013, 2, 14, 16, 41, 17) - with pytest.raises(ValueError): + with pytest.raises(ValueError): # noqa: PT011 strftime_localized(dtime, fmt) @@ -236,11 +239,11 @@ def test_happy_path(self, timezone): return_value={'user_timezone': timezone}): html = strftime_localized_html(dtime, 'SHORT_DATE') assert isinstance(html, Markup) - self.assertRegex(html, - 'Feb 14, 2013') def test_invalid_format_string(self): dtime = datetime(2013, 2, 14, 16, 41, 17) - with self.assertRaisesRegex(AssertionError, 'format "NOPE" not yet supported in strftime_localized_html'): + with self.assertRaisesRegex(AssertionError, 'format "NOPE" not yet supported in strftime_localized_html'): # noqa: PT027 # pylint: disable=line-too-long strftime_localized_html(dtime, 'NOPE') diff --git a/common/djangoapps/util/tests/test_db.py b/common/djangoapps/util/tests/test_db.py index 4a16c2a20aa6..f8fff127ad68 100644 --- a/common/djangoapps/util/tests/test_db.py +++ b/common/djangoapps/util/tests/test_db.py @@ -34,11 +34,11 @@ def test_outer_atomic_nesting(self): with outer_atomic(): atomic()(do_nothing)() # pylint: disable=not-callable - with self.assertRaisesRegex(TransactionManagementError, 'Cannot be inside an atomic block.'): + with self.assertRaisesRegex(TransactionManagementError, 'Cannot be inside an atomic block.'): # noqa: PT027 with atomic(): outer_atomic()(do_nothing)() # pylint: disable=not-callable - with self.assertRaisesRegex(TransactionManagementError, 'Cannot be inside an atomic block.'): + with self.assertRaisesRegex(TransactionManagementError, 'Cannot be inside an atomic block.'): # noqa: PT027 with outer_atomic(): outer_atomic()(do_nothing)() # pylint: disable=not-callable @@ -59,7 +59,7 @@ def test_named_outer_atomic_nesting(self): with atomic(): outer_atomic(name='pqr')(do_nothing)() # pylint: disable=not-callable # Not enabled. - with self.assertRaisesRegex(TransactionManagementError, 'Cannot be inside an atomic block.'): + with self.assertRaisesRegex(TransactionManagementError, 'Cannot be inside an atomic block.'): # noqa: PT027 with atomic(): outer_atomic(name='abc')(do_nothing)() # pylint: disable=not-callable @@ -70,19 +70,19 @@ def test_named_outer_atomic_nesting(self): with atomic(): outer_atomic(name='pqr')(do_nothing)() # pylint: disable=not-callable # Not enabled. - with self.assertRaisesRegex(TransactionManagementError, 'Cannot be inside an atomic block.'): + with self.assertRaisesRegex(TransactionManagementError, 'Cannot be inside an atomic block.'): # noqa: PT027 with atomic(): outer_atomic(name='def')(do_nothing)() # pylint: disable=not-callable - with self.assertRaisesRegex(TransactionManagementError, 'Cannot be inside an atomic block.'): + with self.assertRaisesRegex(TransactionManagementError, 'Cannot be inside an atomic block.'): # noqa: PT027 with outer_atomic(): outer_atomic(name='def')(do_nothing)() # pylint: disable=not-callable - with self.assertRaisesRegex(TransactionManagementError, 'Cannot be inside an atomic block.'): + with self.assertRaisesRegex(TransactionManagementError, 'Cannot be inside an atomic block.'): # noqa: PT027 with atomic(): outer_atomic(name='abc')(do_nothing)() # pylint: disable=not-callable - with self.assertRaisesRegex(TransactionManagementError, 'Cannot be inside an atomic block.'): + with self.assertRaisesRegex(TransactionManagementError, 'Cannot be inside an atomic block.'): # noqa: PT027 with outer_atomic(): outer_atomic(name='abc')(do_nothing)() # pylint: disable=not-callable diff --git a/common/djangoapps/util/tests/test_file.py b/common/djangoapps/util/tests/test_file.py index e90ac4e5b524..a8e40aaf1aca 100644 --- a/common/djangoapps/util/tests/test_file.py +++ b/common/djangoapps/util/tests/test_file.py @@ -9,8 +9,9 @@ from unittest.mock import Mock, patch from zoneinfo import ZoneInfo -import pytest import ddt +import pytest +from ccx_keys.locator import CCXLocator from django.core import exceptions from django.core.files.uploadedfile import SimpleUploadedFile from django.http import HttpRequest @@ -19,15 +20,13 @@ from opaque_keys.edx.keys import CourseKey from opaque_keys.edx.locations import CourseLocator -from ccx_keys.locator import CCXLocator - import common.djangoapps.util.file from common.djangoapps.util.file import ( FileValidationException, UniversalNewlineIterator, course_and_time_based_filename_generator, course_filename_prefix_generator, - store_uploaded_file + store_uploaded_file, ) @@ -150,27 +149,27 @@ def test_error_conditions(self): """ Verifies that exceptions are thrown in the expected cases. """ - with pytest.raises(ValueError) as error: + with pytest.raises(ValueError) as error: # noqa: PT011, PT012 self.request.FILES = {"uploaded_file": SimpleUploadedFile("tempfile.csv", self.file_content)} store_uploaded_file(self.request, "wrong_key", [".txt", ".csv"], "stored_file", self.default_max_size) self.verify_exception("No file uploaded with key 'wrong_key'.", error) - with pytest.raises(exceptions.PermissionDenied) as error: + with pytest.raises(exceptions.PermissionDenied) as error: # noqa: PT012 self.request.FILES = {"uploaded_file": SimpleUploadedFile("tempfile.csv", self.file_content)} store_uploaded_file(self.request, "uploaded_file", [], "stored_file", self.default_max_size) self.verify_exception("The file must end with one of the following extensions: ''.", error) - with pytest.raises(exceptions.PermissionDenied) as error: + with pytest.raises(exceptions.PermissionDenied) as error: # noqa: PT012 self.request.FILES = {"uploaded_file": SimpleUploadedFile("tempfile.csv", self.file_content)} store_uploaded_file(self.request, "uploaded_file", [".bar"], "stored_file", self.default_max_size) self.verify_exception("The file must end with the extension '.bar'.", error) - with pytest.raises(exceptions.PermissionDenied) as error: + with pytest.raises(exceptions.PermissionDenied) as error: # noqa: PT012 self.request.FILES = {"uploaded_file": SimpleUploadedFile("tempfile.csv", self.file_content)} store_uploaded_file(self.request, "uploaded_file", [".xxx", ".bar"], "stored_file", self.default_max_size) self.verify_exception("The file must end with one of the following extensions: '.xxx', '.bar'.", error) - with pytest.raises(exceptions.PermissionDenied) as error: + with pytest.raises(exceptions.PermissionDenied) as error: # noqa: PT012 self.request.FILES = {"uploaded_file": SimpleUploadedFile("tempfile.csv", self.file_content)} store_uploaded_file(self.request, "uploaded_file", [".csv"], "stored_file", 2) self.verify_exception("Maximum upload file size is 2 bytes.", error) @@ -204,7 +203,7 @@ def success_validator(storage, filename): assert 'success_file' in os.path.basename(filename) store_file_data(storage, filename) - with pytest.raises(FileValidationException) as error: + with pytest.raises(FileValidationException) as error: # noqa: PT012 self.request.FILES = {"uploaded_file": SimpleUploadedFile("tempfile.csv", self.file_content)} store_uploaded_file( self.request, "uploaded_file", [".csv"], "error_file", diff --git a/common/djangoapps/util/tests/test_filters.py b/common/djangoapps/util/tests/test_filters.py index 9e8d6d5fdffa..e541b5e19502 100644 --- a/common/djangoapps/util/tests/test_filters.py +++ b/common/djangoapps/util/tests/test_filters.py @@ -2,11 +2,13 @@ Test that various filters are fired for models/views in the student app. """ from django.test import override_settings -from common.djangoapps.util import course from openedx_filters import PipelineStep +from openedx_filters.learning.filters import InstructorDashboardTabsRequested + +from common.djangoapps.util import course +from openedx.core.djangolib.testing.utils import skip_unless_lms from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase from xmodule.modulestore.tests.factories import CourseFactory -from openedx.core.djangolib.testing.utils import skip_unless_lms class TestPageURLRequestedPipelineStep(PipelineStep): @@ -56,7 +58,7 @@ def test_course_about_page_url_requested_filter_executed(self): """ course_about_url = course.get_link_for_about_page(self.course) - self.assertEqual("https://lms-url-creation", course_about_url) + self.assertEqual("https://lms-url-creation", course_about_url) # noqa: PT009 @override_settings(OPEN_EDX_FILTERS_CONFIG={}, LMS_ROOT_URL="https://lms-base") def test_course_about_page_url_requested_without_filter_configuration(self): @@ -74,4 +76,54 @@ def test_course_about_page_url_requested_without_filter_configuration(self): course_key=str(self.course.id), ) - self.assertEqual(expected_course_about, course_about_url) + self.assertEqual(expected_course_about, course_about_url) # noqa: PT009 + + +class TestInstructorDashCustomTab(PipelineStep): + """ + Utility class used when getting steps for pipeline. + """ + + def run_filter(self, tabs, user, course_key): # pylint: disable=arguments-differ,unused-argument + """Pipeline step that appends a custom instructor dashboard tab.""" + result = { + "tabs": tabs + [{ + "tab_id": "custom", + "title": "Custom Tab", + "url": f"/courses/{course_key}/instructor/custom", + "sort_order": 999, + }], + } + return result + + +class TestPreventTabsGenerationWithTabs(PipelineStep): + """ + Pipeline step that raises PreventTabsGeneration with a custom tabs list. + Used to test that the exception handler in get_tabs uses exc.tabs when present. + """ + + def run_filter(self, tabs, user, course_key): # pylint: disable=arguments-differ,unused-argument + """Pipeline step that raises PreventTabsGeneration with custom tabs.""" + raise InstructorDashboardTabsRequested.PreventTabsGeneration( + "Preventing default tabs in favor of custom ones.", + tabs=[{ + "tab_id": "plugin_tab", + "title": "Plugin Tab", + "url": f"/courses/{course_key}/instructor/plugin", + "sort_order": 5, + }], + ) + + +class TestPreventTabsGenerationWithoutTabs(PipelineStep): + """ + Pipeline step that raises PreventTabsGeneration without a tabs list. + Used to test that the exception handler in get_tabs falls back to an empty list. + """ + + def run_filter(self, tabs, user, course_key): # pylint: disable=arguments-differ,unused-argument + """Pipeline step that raises PreventTabsGeneration without providing tabs.""" + raise InstructorDashboardTabsRequested.PreventTabsGeneration( + "Preventing all tabs from being generated." + ) diff --git a/common/djangoapps/util/tests/test_json_request.py b/common/djangoapps/util/tests/test_json_request.py index ad4ec9156bc0..3ede50ad1f36 100644 --- a/common/djangoapps/util/tests/test_json_request.py +++ b/common/djangoapps/util/tests/test_json_request.py @@ -5,8 +5,8 @@ import json import unittest - from unittest import mock + from django.http import HttpResponse, HttpResponseBadRequest from common.djangoapps.util.json_request import JsonResponse, JsonResponseBadRequest diff --git a/common/djangoapps/util/tests/test_keyword_sub_utils.py b/common/djangoapps/util/tests/test_keyword_sub_utils.py index 1478e39a4fdd..7dae7cad1e24 100644 --- a/common/djangoapps/util/tests/test_keyword_sub_utils.py +++ b/common/djangoapps/util/tests/test_keyword_sub_utils.py @@ -8,8 +8,10 @@ from common.djangoapps.student.tests.factories import UserFactory from common.djangoapps.util import keyword_substitution as Ks from common.djangoapps.util.date_utils import get_default_time_display -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + ModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order @ddt diff --git a/common/djangoapps/util/tests/test_milestones_helpers.py b/common/djangoapps/util/tests/test_milestones_helpers.py index efff367d75bb..3808760659e7 100644 --- a/common/djangoapps/util/tests/test_milestones_helpers.py +++ b/common/djangoapps/util/tests/test_milestones_helpers.py @@ -12,8 +12,10 @@ from milestones.models import MilestoneRelationshipType from common.djangoapps.util import milestones_helpers -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + ModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order @override_settings(MILESTONES_APP=False) diff --git a/common/djangoapps/util/tests/test_password_policy_validators.py b/common/djangoapps/util/tests/test_password_policy_validators.py index f5eea255bff2..894359c573a1 100644 --- a/common/djangoapps/util/tests/test_password_policy_validators.py +++ b/common/djangoapps/util/tests/test_password_policy_validators.py @@ -5,14 +5,14 @@ import pytest from ddt import data, ddt, unpack -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.core.exceptions import ValidationError from django.test.utils import override_settings from common.djangoapps.util.password_policy_validators import ( create_validator_config, password_validators_instruction_texts, - validate_password + validate_password, ) @@ -83,25 +83,25 @@ def test_password_unicode_normalization(self): 'This password is too short. It must contain at least 4 characters.') @data( - ([create_validator_config('common.djangoapps.util.password_policy_validators.MinimumLengthValidator', {'min_length': 2})], # lint-amnesty, pylint: disable=line-too-long + ([create_validator_config('common.djangoapps.util.password_policy_validators.MinimumLengthValidator', {'min_length': 2})], # pylint: disable=line-too-long 'at least 2 characters.'), ([ - create_validator_config('common.djangoapps.util.password_policy_validators.MinimumLengthValidator', {'min_length': 2}), # lint-amnesty, pylint: disable=line-too-long - create_validator_config('common.djangoapps.util.password_policy_validators.AlphabeticValidator', {'min_alphabetic': 2}), # lint-amnesty, pylint: disable=line-too-long + create_validator_config('common.djangoapps.util.password_policy_validators.MinimumLengthValidator', {'min_length': 2}), # pylint: disable=line-too-long + create_validator_config('common.djangoapps.util.password_policy_validators.AlphabeticValidator', {'min_alphabetic': 2}), # pylint: disable=line-too-long ], 'characters, including 2 letters.'), ([ - create_validator_config('common.djangoapps.util.password_policy_validators.MinimumLengthValidator', {'min_length': 2}), # lint-amnesty, pylint: disable=line-too-long - create_validator_config('common.djangoapps.util.password_policy_validators.AlphabeticValidator', {'min_alphabetic': 2}), # lint-amnesty, pylint: disable=line-too-long - create_validator_config('common.djangoapps.util.password_policy_validators.NumericValidator', {'min_numeric': 1}), # lint-amnesty, pylint: disable=line-too-long + create_validator_config('common.djangoapps.util.password_policy_validators.MinimumLengthValidator', {'min_length': 2}), # pylint: disable=line-too-long + create_validator_config('common.djangoapps.util.password_policy_validators.AlphabeticValidator', {'min_alphabetic': 2}), # pylint: disable=line-too-long + create_validator_config('common.djangoapps.util.password_policy_validators.NumericValidator', {'min_numeric': 1}), # pylint: disable=line-too-long ], 'characters, including 2 letters & 1 number.'), ([ - create_validator_config('common.djangoapps.util.password_policy_validators.MinimumLengthValidator', {'min_length': 2}), # lint-amnesty, pylint: disable=line-too-long - create_validator_config('common.djangoapps.util.password_policy_validators.UppercaseValidator', {'min_upper': 3}), # lint-amnesty, pylint: disable=line-too-long - create_validator_config('common.djangoapps.util.password_policy_validators.NumericValidator', {'min_numeric': 1}), # lint-amnesty, pylint: disable=line-too-long - create_validator_config('common.djangoapps.util.password_policy_validators.SymbolValidator', {'min_symbol': 2}), # lint-amnesty, pylint: disable=line-too-long + create_validator_config('common.djangoapps.util.password_policy_validators.MinimumLengthValidator', {'min_length': 2}), # pylint: disable=line-too-long + create_validator_config('common.djangoapps.util.password_policy_validators.UppercaseValidator', {'min_upper': 3}), # pylint: disable=line-too-long + create_validator_config('common.djangoapps.util.password_policy_validators.NumericValidator', {'min_numeric': 1}), # pylint: disable=line-too-long + create_validator_config('common.djangoapps.util.password_policy_validators.SymbolValidator', {'min_symbol': 2}), # pylint: disable=line-too-long ], 'including 3 uppercase letters & 1 number & 2 symbols.'), ) @unpack @@ -126,13 +126,13 @@ def test_user_attribute_similarity_validation_errors(self, password, username, e self.validation_errors_checker(password, msg, user) @data( - ([create_validator_config('common.djangoapps.util.password_policy_validators.MinimumLengthValidator', {'min_length': 1})], # lint-amnesty, pylint: disable=line-too-long + ([create_validator_config('common.djangoapps.util.password_policy_validators.MinimumLengthValidator', {'min_length': 1})], # pylint: disable=line-too-long '', 'This password is too short. It must contain at least 1 character.'), - ([create_validator_config('common.djangoapps.util.password_policy_validators.MinimumLengthValidator', {'min_length': 8})], # lint-amnesty, pylint: disable=line-too-long + ([create_validator_config('common.djangoapps.util.password_policy_validators.MinimumLengthValidator', {'min_length': 8})], # pylint: disable=line-too-long 'd', 'This password is too short. It must contain at least 8 characters.'), - ([create_validator_config('common.djangoapps.util.password_policy_validators.MinimumLengthValidator', {'min_length': 8})], # lint-amnesty, pylint: disable=line-too-long + ([create_validator_config('common.djangoapps.util.password_policy_validators.MinimumLengthValidator', {'min_length': 8})], # pylint: disable=line-too-long 'longpassword', None), ) @unpack @@ -142,13 +142,13 @@ def test_minimum_length_validation_errors(self, config, password, msg): self.validation_errors_checker(password, msg) @data( - ([create_validator_config('common.djangoapps.util.password_policy_validators.MaximumLengthValidator', {'max_length': 1})], # lint-amnesty, pylint: disable=line-too-long + ([create_validator_config('common.djangoapps.util.password_policy_validators.MaximumLengthValidator', {'max_length': 1})], # pylint: disable=line-too-long 'longpassword', 'This password is too long. It must contain no more than 1 character.'), - ([create_validator_config('common.djangoapps.util.password_policy_validators.MaximumLengthValidator', {'max_length': 10})], # lint-amnesty, pylint: disable=line-too-long + ([create_validator_config('common.djangoapps.util.password_policy_validators.MaximumLengthValidator', {'max_length': 10})], # pylint: disable=line-too-long 'longpassword', 'This password is too long. It must contain no more than 10 characters.'), - ([create_validator_config('common.djangoapps.util.password_policy_validators.MaximumLengthValidator', {'max_length': 20})], # lint-amnesty, pylint: disable=line-too-long + ([create_validator_config('common.djangoapps.util.password_policy_validators.MaximumLengthValidator', {'max_length': 20})], # pylint: disable=line-too-long 'shortpassword', None), ) @unpack @@ -170,13 +170,13 @@ def test_common_password_validation_errors(self, password, msg): self.validation_errors_checker(password, msg) @data( - ([create_validator_config('common.djangoapps.util.password_policy_validators.AlphabeticValidator', {'min_alphabetic': 1})], # lint-amnesty, pylint: disable=line-too-long + ([create_validator_config('common.djangoapps.util.password_policy_validators.AlphabeticValidator', {'min_alphabetic': 1})], # pylint: disable=line-too-long '12345', 'This password must contain at least 1 letter.'), - ([create_validator_config('common.djangoapps.util.password_policy_validators.AlphabeticValidator', {'min_alphabetic': 5})], # lint-amnesty, pylint: disable=line-too-long + ([create_validator_config('common.djangoapps.util.password_policy_validators.AlphabeticValidator', {'min_alphabetic': 5})], # pylint: disable=line-too-long 'test123', 'This password must contain at least 5 letters.'), - ([create_validator_config('common.djangoapps.util.password_policy_validators.AlphabeticValidator', {'min_alphabetic': 2})], # lint-amnesty, pylint: disable=line-too-long + ([create_validator_config('common.djangoapps.util.password_policy_validators.AlphabeticValidator', {'min_alphabetic': 2})], # pylint: disable=line-too-long 'password', None), ) @unpack @@ -186,13 +186,13 @@ def test_alphabetic_validation_errors(self, config, password, msg): self.validation_errors_checker(password, msg) @data( - ([create_validator_config('common.djangoapps.util.password_policy_validators.NumericValidator', {'min_numeric': 1})], # lint-amnesty, pylint: disable=line-too-long + ([create_validator_config('common.djangoapps.util.password_policy_validators.NumericValidator', {'min_numeric': 1})], # pylint: disable=line-too-long 'test', 'This password must contain at least 1 number.'), - ([create_validator_config('common.djangoapps.util.password_policy_validators.NumericValidator', {'min_numeric': 4})], # lint-amnesty, pylint: disable=line-too-long + ([create_validator_config('common.djangoapps.util.password_policy_validators.NumericValidator', {'min_numeric': 4})], # pylint: disable=line-too-long 'test123', 'This password must contain at least 4 numbers.'), - ([create_validator_config('common.djangoapps.util.password_policy_validators.NumericValidator', {'min_numeric': 2})], # lint-amnesty, pylint: disable=line-too-long + ([create_validator_config('common.djangoapps.util.password_policy_validators.NumericValidator', {'min_numeric': 2})], # pylint: disable=line-too-long 'password123', None), ) @unpack @@ -202,13 +202,13 @@ def test_numeric_validation_errors(self, config, password, msg): self.validation_errors_checker(password, msg) @data( - ([create_validator_config('common.djangoapps.util.password_policy_validators.UppercaseValidator', {'min_upper': 1})], # lint-amnesty, pylint: disable=line-too-long + ([create_validator_config('common.djangoapps.util.password_policy_validators.UppercaseValidator', {'min_upper': 1})], # pylint: disable=line-too-long 'lowercase', 'This password must contain at least 1 uppercase letter.'), - ([create_validator_config('common.djangoapps.util.password_policy_validators.UppercaseValidator', {'min_upper': 6})], # lint-amnesty, pylint: disable=line-too-long + ([create_validator_config('common.djangoapps.util.password_policy_validators.UppercaseValidator', {'min_upper': 6})], # pylint: disable=line-too-long 'NOTenough', 'This password must contain at least 6 uppercase letters.'), - ([create_validator_config('common.djangoapps.util.password_policy_validators.UppercaseValidator', {'min_upper': 1})], # lint-amnesty, pylint: disable=line-too-long + ([create_validator_config('common.djangoapps.util.password_policy_validators.UppercaseValidator', {'min_upper': 1})], # pylint: disable=line-too-long 'camelCase', None), ) @unpack @@ -218,13 +218,13 @@ def test_upper_case_validation_errors(self, config, password, msg): self.validation_errors_checker(password, msg) @data( - ([create_validator_config('common.djangoapps.util.password_policy_validators.LowercaseValidator', {'min_lower': 1})], # lint-amnesty, pylint: disable=line-too-long + ([create_validator_config('common.djangoapps.util.password_policy_validators.LowercaseValidator', {'min_lower': 1})], # pylint: disable=line-too-long 'UPPERCASE', 'This password must contain at least 1 lowercase letter.'), - ([create_validator_config('common.djangoapps.util.password_policy_validators.LowercaseValidator', {'min_lower': 4})], # lint-amnesty, pylint: disable=line-too-long + ([create_validator_config('common.djangoapps.util.password_policy_validators.LowercaseValidator', {'min_lower': 4})], # pylint: disable=line-too-long 'notENOUGH', 'This password must contain at least 4 lowercase letters.'), - ([create_validator_config('common.djangoapps.util.password_policy_validators.LowercaseValidator', {'min_lower': 1})], # lint-amnesty, pylint: disable=line-too-long + ([create_validator_config('common.djangoapps.util.password_policy_validators.LowercaseValidator', {'min_lower': 1})], # pylint: disable=line-too-long 'goodPassword', None), ) @unpack @@ -234,13 +234,13 @@ def test_lower_case_validation_errors(self, config, password, msg): self.validation_errors_checker(password, msg) @data( - ([create_validator_config('common.djangoapps.util.password_policy_validators.PunctuationValidator', {'min_punctuation': 1})], # lint-amnesty, pylint: disable=line-too-long + ([create_validator_config('common.djangoapps.util.password_policy_validators.PunctuationValidator', {'min_punctuation': 1})], # pylint: disable=line-too-long 'no punctuation', 'This password must contain at least 1 punctuation mark.'), - ([create_validator_config('common.djangoapps.util.password_policy_validators.PunctuationValidator', {'min_punctuation': 7})], # lint-amnesty, pylint: disable=line-too-long + ([create_validator_config('common.djangoapps.util.password_policy_validators.PunctuationValidator', {'min_punctuation': 7})], # pylint: disable=line-too-long 'p@$$w0rd$!', 'This password must contain at least 7 punctuation marks.'), - ([create_validator_config('common.djangoapps.util.password_policy_validators.PunctuationValidator', {'min_punctuation': 3})], # lint-amnesty, pylint: disable=line-too-long + ([create_validator_config('common.djangoapps.util.password_policy_validators.PunctuationValidator', {'min_punctuation': 3})], # pylint: disable=line-too-long 'excl@m@t!on', None), ) @unpack @@ -250,13 +250,13 @@ def test_punctuation_validation_errors(self, config, password, msg): self.validation_errors_checker(password, msg) @data( - ([create_validator_config('common.djangoapps.util.password_policy_validators.SymbolValidator', {'min_symbol': 1})], # lint-amnesty, pylint: disable=line-too-long + ([create_validator_config('common.djangoapps.util.password_policy_validators.SymbolValidator', {'min_symbol': 1})], # pylint: disable=line-too-long 'no symbol', 'This password must contain at least 1 symbol.'), - ([create_validator_config('common.djangoapps.util.password_policy_validators.SymbolValidator', {'min_symbol': 3})], # lint-amnesty, pylint: disable=line-too-long + ([create_validator_config('common.djangoapps.util.password_policy_validators.SymbolValidator', {'min_symbol': 3})], # pylint: disable=line-too-long '☹️boo☹️', 'This password must contain at least 3 symbols.'), - ([create_validator_config('common.djangoapps.util.password_policy_validators.SymbolValidator', {'min_symbol': 2})], # lint-amnesty, pylint: disable=line-too-long + ([create_validator_config('common.djangoapps.util.password_policy_validators.SymbolValidator', {'min_symbol': 2})], # pylint: disable=line-too-long '☪symbols!☹️', None), ) @unpack diff --git a/common/djangoapps/util/tests/test_resolve_storage_backend.py b/common/djangoapps/util/tests/test_resolve_storage_backend.py index cf0e0cbd0e94..9a30f8ba776b 100644 --- a/common/djangoapps/util/tests/test_resolve_storage_backend.py +++ b/common/djangoapps/util/tests/test_resolve_storage_backend.py @@ -2,13 +2,13 @@ Tests for the resolve_storage_backend function in common.djangoapps.util.storage. """ +from unittest.mock import MagicMock, patch + from django.test import TestCase from django.test.utils import override_settings -from unittest.mock import patch, MagicMock from common.djangoapps.util.storage import resolve_storage_backend - DEFAULT_STORAGE_CLASS_NAME = "FileSystemStorage" diff --git a/common/djangoapps/util/tests/test_sandboxing.py b/common/djangoapps/util/tests/test_sandboxing.py index e544a07e8585..b044a1c5be67 100644 --- a/common/djangoapps/util/tests/test_sandboxing.py +++ b/common/djangoapps/util/tests/test_sandboxing.py @@ -11,7 +11,7 @@ from xmodule.contentstore.django import contentstore from xmodule.modulestore.tests.django_utils import upload_file_to_course -from xmodule.util.sandboxing import can_execute_unsafe_code, SandboxService +from xmodule.util.sandboxing import SandboxService, can_execute_unsafe_code class SandboxingTest(TestCase): @@ -37,7 +37,7 @@ def test_sandbox_inclusion(self): def test_courselikes_with_unsafe_code_default(self): """ - Test that the default setting for COURSES_WITH_UNSAFE_CODE is an empty setting, e.g. we don't use @override_settings in these tests # lint-amnesty, pylint: disable=line-too-long + Test that the default setting for COURSES_WITH_UNSAFE_CODE is an empty setting, e.g. we don't use @override_settings in these tests # pylint: disable=line-too-long """ assert not can_execute_unsafe_code(CourseLocator('edX', 'full', '2012_Fall')) assert not can_execute_unsafe_code(CourseLocator('edX', 'full', '2013_Spring')) diff --git a/common/djangoapps/util/views.py b/common/djangoapps/util/views.py index 8a7901b2fccd..0998ef1527e0 100644 --- a/common/djangoapps/util/views.py +++ b/common/djangoapps/util/views.py @@ -1,4 +1,4 @@ -# lint-amnesty, pylint: disable=missing-module-docstring +# pylint: disable=missing-module-docstring import json import logging import sys @@ -9,19 +9,19 @@ from django.conf import settings from django.contrib.auth.decorators import login_required from django.http import Http404, HttpResponse, HttpResponseForbidden, HttpResponseServerError +from django.shortcuts import redirect from django.views.decorators.csrf import ensure_csrf_cookie, requires_csrf_token from django.views.defaults import server_error -from django.shortcuts import redirect from opaque_keys import InvalidKeyError from opaque_keys.edx.keys import CourseKey, UsageKey +from common.djangoapps.edxmako.shortcuts import render_to_response +from common.djangoapps.student.roles import GlobalStaff +from common.djangoapps.track import views as track_views from lms.djangoapps.courseware.access import has_access from lms.djangoapps.courseware.masquerade import setup_masquerade from openedx.core.djangoapps.schedules.utils import reset_self_paced_schedule from openedx.features.course_experience.utils import dates_banner_should_display -from common.djangoapps.track import views as track_views -from common.djangoapps.edxmako.shortcuts import render_to_response -from common.djangoapps.student.roles import GlobalStaff log = logging.getLogger(__name__) @@ -38,7 +38,7 @@ def inner(request, *args, **kwargs): try: CourseKey.from_string(course_key) except InvalidKeyError: - raise Http404 # lint-amnesty, pylint: disable=raise-missing-from + raise Http404 # pylint: disable=raise-missing-from # noqa: B904 response = view_func(request, *args, **kwargs) return response @@ -58,7 +58,7 @@ def inner(request, *args, **kwargs): try: UsageKey.from_string(usage_key) except InvalidKeyError: - raise Http404 # lint-amnesty, pylint: disable=raise-missing-from + raise Http404 # pylint: disable=raise-missing-from # noqa: B904 response = view_func(request, *args, **kwargs) return response @@ -74,7 +74,7 @@ def wrapped(request, *args, **kwargs): return func(request, *args, **kwargs) else: return HttpResponseForbidden( - "Must be {platform_name} staff to perform this action.".format( + "Must be {platform_name} staff to perform this action.".format( # noqa: UP032 platform_name=settings.PLATFORM_NAME ) ) @@ -138,7 +138,7 @@ def inner(request, *args, **kwargs): try: return func(request, *args, **kwargs) except Exception: # pylint: disable=broad-except - if settings.DEBUG: # lint-amnesty, pylint: disable=no-else-raise + if settings.DEBUG: # pylint: disable=no-else-raise # In debug mode let django process the 500 errors and display debug info for the developer raise elif test_func is None or test_func(request): @@ -159,12 +159,12 @@ def calculate(request): equation = request.GET['equation'] try: result = calc.evaluator({}, {}, equation) - except: # lint-amnesty, pylint: disable=bare-except + except: # pylint: disable=bare-except event = {'error': list(map(str, sys.exc_info())), 'equation': equation} track_views.server_track(request, 'error:calc', event, page='calc') - return HttpResponse(json.dumps({'result': 'Invalid syntax'})) # lint-amnesty, pylint: disable=http-response-with-json-dumps - return HttpResponse(json.dumps({'result': str(result)})) # lint-amnesty, pylint: disable=http-response-with-json-dumps + return HttpResponse(json.dumps({'result': 'Invalid syntax'})) # pylint: disable=http-response-with-json-dumps + return HttpResponse(json.dumps({'result': str(result)})) # pylint: disable=http-response-with-json-dumps def add_p3p_header(view_func): diff --git a/common/djangoapps/xblock_django/admin.py b/common/djangoapps/xblock_django/admin.py index 0aba207a6237..a36553dc0645 100644 --- a/common/djangoapps/xblock_django/admin.py +++ b/common/djangoapps/xblock_django/admin.py @@ -7,7 +7,11 @@ from django.contrib import admin from django.utils.translation import gettext_lazy as _ -from common.djangoapps.xblock_django.models import XBlockConfiguration, XBlockStudioConfiguration, XBlockStudioConfigurationFlag # lint-amnesty, pylint: disable=line-too-long +from common.djangoapps.xblock_django.models import ( # pylint: disable=line-too-long + XBlockConfiguration, + XBlockStudioConfiguration, + XBlockStudioConfigurationFlag, +) class XBlockConfigurationAdmin(KeyedConfigurationModelAdmin): diff --git a/common/djangoapps/xblock_django/api.py b/common/djangoapps/xblock_django/api.py index 163683ab0c38..1470ae3a7cc9 100644 --- a/common/djangoapps/xblock_django/api.py +++ b/common/djangoapps/xblock_django/api.py @@ -3,8 +3,8 @@ """ -from openedx.core.lib.cache_utils import CacheInvalidationManager from common.djangoapps.xblock_django.models import XBlockConfiguration, XBlockStudioConfiguration +from openedx.core.lib.cache_utils import CacheInvalidationManager cacher = CacheInvalidationManager(model=XBlockConfiguration) diff --git a/common/djangoapps/xblock_django/management/commands/compile_xblock_translations.py b/common/djangoapps/xblock_django/management/commands/compile_xblock_translations.py index 77662a37388b..3623cd6b1565 100644 --- a/common/djangoapps/xblock_django/management/commands/compile_xblock_translations.py +++ b/common/djangoapps/xblock_django/management/commands/compile_xblock_translations.py @@ -4,13 +4,10 @@ from django.core.management.base import BaseCommand -from xmodule.modulestore import api as xmodule_api - from openedx.core.djangoapps.plugins.i18n_api import compile_po_files +from xmodule.modulestore import api as xmodule_api -from ...translation import ( - compile_xblock_js_messages, -) +from ...translation import compile_xblock_js_messages class Command(BaseCommand): diff --git a/common/djangoapps/xblock_django/models.py b/common/djangoapps/xblock_django/models.py index 50c8da22819e..cb76d713641a 100644 --- a/common/djangoapps/xblock_django/models.py +++ b/common/djangoapps/xblock_django/models.py @@ -28,7 +28,7 @@ class Meta(ConfigurationModel.Meta): ) def __str__(self): - return ( + return ( # noqa: UP032 "XBlockConfiguration(name={}, enabled={}, deprecated={})" ).format(self.name, self.enabled, self.deprecated) @@ -76,6 +76,6 @@ class Meta: app_label = "xblock_django" def __str__(self): - return ( + return ( # noqa: UP032 "XBlockStudioConfiguration(name={}, template={}, enabled={}, support_level={})" ).format(self.name, self.template, self.enabled, self.support_level) diff --git a/common/djangoapps/xblock_django/tests/test_api.py b/common/djangoapps/xblock_django/tests/test_api.py index 886020f173a6..14d39a994710 100644 --- a/common/djangoapps/xblock_django/tests/test_api.py +++ b/common/djangoapps/xblock_django/tests/test_api.py @@ -1,9 +1,13 @@ """ Tests related to XBlock support API. """ -from openedx.core.djangolib.testing.utils import CacheIsolationTestCase from common.djangoapps.xblock_django.api import authorable_xblocks, deprecated_xblocks, disabled_xblocks -from common.djangoapps.xblock_django.models import XBlockConfiguration, XBlockStudioConfiguration, XBlockStudioConfigurationFlag # lint-amnesty, pylint: disable=line-too-long +from common.djangoapps.xblock_django.models import ( # pylint: disable=line-too-long + XBlockConfiguration, + XBlockStudioConfiguration, + XBlockStudioConfigurationFlag, +) +from openedx.core.djangolib.testing.utils import CacheIsolationTestCase class XBlockSupportTestCase(CacheIsolationTestCase): @@ -43,23 +47,23 @@ def test_deprecated_blocks(self): """ Tests the deprecated_xblocks method """ deprecated_xblock_names = [block.name for block in deprecated_xblocks()] - self.assertCountEqual(["poll", "survey"], deprecated_xblock_names) + self.assertCountEqual(["poll", "survey"], deprecated_xblock_names) # noqa: PT009 XBlockConfiguration(name="poll", enabled=True, deprecated=False).save() deprecated_xblock_names = [block.name for block in deprecated_xblocks()] - self.assertCountEqual(["survey"], deprecated_xblock_names) + self.assertCountEqual(["survey"], deprecated_xblock_names) # noqa: PT009 def test_disabled_blocks(self): """ Tests the disabled_xblocks method """ disabled_xblock_names = [block.name for block in disabled_xblocks()] - self.assertCountEqual(["survey"], disabled_xblock_names) + self.assertCountEqual(["survey"], disabled_xblock_names) # noqa: PT009 XBlockConfiguration(name="poll", enabled=False, deprecated=True).save() disabled_xblock_names = [block.name for block in disabled_xblocks()] - self.assertCountEqual(["survey", "poll"], disabled_xblock_names) + self.assertCountEqual(["survey", "poll"], disabled_xblock_names) # noqa: PT009 def test_authorable_blocks_empty_model(self): """ @@ -77,7 +81,7 @@ def test_authorable_blocks(self): Tests authorable_xblocks when name is not specified. """ authorable_xblock_names = [block.name for block in authorable_xblocks()] - self.assertCountEqual(["done", "problem", "problem", "html"], authorable_xblock_names) + self.assertCountEqual(["done", "problem", "problem", "html"], authorable_xblock_names) # noqa: PT009 # Note that "survey" is disabled in XBlockConfiguration, but it is still returned by # authorable_xblocks because it is marked as enabled and unsupported in XBlockStudioConfiguration. @@ -85,7 +89,7 @@ def test_authorable_blocks(self): # is a whitelist and uses a combination of xblock type and template (and in addition has a global feature flag), # it is expected that Studio code will need to filter by both disabled_xblocks and authorable_xblocks. authorable_xblock_names = [block.name for block in authorable_xblocks(allow_unsupported=True)] - self.assertCountEqual( + self.assertCountEqual( # noqa: PT009 ["survey", "done", "problem", "problem", "problem", "html", "split_module"], authorable_xblock_names ) diff --git a/common/djangoapps/xblock_django/tests/test_commands.py b/common/djangoapps/xblock_django/tests/test_commands.py index 8a558b6bebe6..8940ac1d8965 100644 --- a/common/djangoapps/xblock_django/tests/test_commands.py +++ b/common/djangoapps/xblock_django/tests/test_commands.py @@ -2,18 +2,14 @@ Tests for the pull_xblock_translations management command. """ -from path import Path from unittest.mock import patch from django.core.management import call_command - from done import DoneXBlock +from path import Path -from xmodule.modulestore.api import ( - get_python_locale_root, - get_javascript_i18n_file_path, -) -from xmodule.modulestore.tests.conftest import tmp_translations_dir +from xmodule.modulestore.api import get_javascript_i18n_file_path, get_python_locale_root +from xmodule.modulestore.tests.conftest import tmp_translations_dir # noqa: F401 def test_pull_xblock_translations(tmp_path): @@ -47,7 +43,7 @@ def test_pull_xblock_translations(tmp_path): ] -def test_compile_xblock_translations(tmp_translations_dir): +def test_compile_xblock_translations(tmp_translations_dir): # noqa: F811 """ Test the compile_xblock_translations management command. """ diff --git a/common/djangoapps/xblock_django/tests/test_translation.py b/common/djangoapps/xblock_django/tests/test_translation.py index 4e4ed937c513..0b25cc66502d 100644 --- a/common/djangoapps/xblock_django/tests/test_translation.py +++ b/common/djangoapps/xblock_django/tests/test_translation.py @@ -4,10 +4,7 @@ from done import DoneXBlock -from ..translation import ( - get_non_xmodule_xblock_module_names, - get_non_xmodule_xblocks, -) +from ..translation import get_non_xmodule_xblock_module_names, get_non_xmodule_xblocks def test_get_non_xmodule_xblock_module_names(): diff --git a/common/djangoapps/xblock_django/tests/test_user_service.py b/common/djangoapps/xblock_django/tests/test_user_service.py index 603069d7400a..e6310bb1ff7e 100644 --- a/common/djangoapps/xblock_django/tests/test_user_service.py +++ b/common/djangoapps/xblock_django/tests/test_user_service.py @@ -7,13 +7,11 @@ from django.test import TestCase from opaque_keys.edx.keys import CourseKey -from openedx.core.djangoapps.user_api.preferences.api import set_user_preference -from openedx.core.djangoapps.external_user_ids.models import ExternalIdType from common.djangoapps.student.models import anonymous_id_for_user from common.djangoapps.student.tests.factories import AnonymousUserFactory, UserFactory from common.djangoapps.xblock_django.user_service import ( - ATTR_KEY_IS_AUTHENTICATED, ATTR_KEY_ANONYMOUS_USER_ID, + ATTR_KEY_IS_AUTHENTICATED, ATTR_KEY_REQUEST_COUNTRY_CODE, ATTR_KEY_USER_ID, ATTR_KEY_USER_IS_BETA_TESTER, @@ -23,8 +21,10 @@ ATTR_KEY_USER_ROLE, ATTR_KEY_USERNAME, USER_PREFERENCES_WHITE_LIST, - DjangoXBlockUserService + DjangoXBlockUserService, ) +from openedx.core.djangoapps.external_user_ids.models import ExternalIdType +from openedx.core.djangoapps.user_api.preferences.api import set_user_preference @ddt.ddt @@ -48,7 +48,7 @@ def assert_is_anon_xb_user(self, xb_user, request_country_code): assert not xb_user.opt_attrs[ATTR_KEY_IS_AUTHENTICATED] assert xb_user.opt_attrs[ATTR_KEY_REQUEST_COUNTRY_CODE] == request_country_code assert xb_user.full_name is None - self.assertListEqual(xb_user.emails, []) + self.assertListEqual(xb_user.emails, []) # noqa: PT009 def assert_xblock_user_matches_django( self, @@ -201,7 +201,7 @@ def test_external_id(self): ext_id1 = django_user_service.get_external_user_id('test1') ext_id2 = django_user_service.get_external_user_id('test2') assert ext_id1 != ext_id2 - with pytest.raises(ValueError): + with pytest.raises(ValueError): # noqa: PT011 django_user_service.get_external_user_id('unknown') def test_get_user_by_anonymous_id_assume_id(self): diff --git a/common/djangoapps/xblock_django/translation.py b/common/djangoapps/xblock_django/translation.py index 66f964268255..cdc21c0322b7 100644 --- a/common/djangoapps/xblock_django/translation.py +++ b/common/djangoapps/xblock_django/translation.py @@ -2,12 +2,12 @@ XBlock translations pulling and compilation logic. """ -import os import gettext +import os from django.utils.encoding import force_str +from django.utils.translation import get_language, override, to_locale from django.views.i18n import JavaScriptCatalog -from django.utils.translation import override, to_locale, get_language from statici18n.management.commands.compilejsi18n import Command as CompileI18NJSCommand from xblock.core import XBlock diff --git a/common/djangoapps/xblock_django/user_service.py b/common/djangoapps/xblock_django/user_service.py index 01221ddfa698..e5633e907933 100644 --- a/common/djangoapps/xblock_django/user_service.py +++ b/common/djangoapps/xblock_django/user_service.py @@ -3,13 +3,13 @@ """ -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from opaque_keys.edx.keys import CourseKey from xblock.reference.user_service import UserService, XBlockUser +from common.djangoapps.student.models import anonymous_id_for_user, get_user_by_username_or_email, user_by_anonymous_id from openedx.core.djangoapps.external_user_ids.models import ExternalId from openedx.core.djangoapps.user_api.preferences.api import get_user_preferences -from common.djangoapps.student.models import anonymous_id_for_user, get_user_by_username_or_email, user_by_anonymous_id from .constants import ( ATTR_KEY_ANONYMOUS_USER_ID, @@ -17,15 +17,14 @@ ATTR_KEY_IS_AUTHENTICATED, ATTR_KEY_REQUEST_COUNTRY_CODE, ATTR_KEY_USER_ID, - ATTR_KEY_USERNAME, ATTR_KEY_USER_IS_BETA_TESTER, ATTR_KEY_USER_IS_GLOBAL_STAFF, ATTR_KEY_USER_IS_STAFF, ATTR_KEY_USER_PREFERENCES, ATTR_KEY_USER_ROLE, + ATTR_KEY_USERNAME, ) - USER_PREFERENCES_WHITE_LIST = ['pref-lang', 'time_zone'] @@ -72,7 +71,7 @@ def get_external_user_id(self, type_name): """ external_id, _ = ExternalId.add_new_user_id(self._django_user, type_name) if not external_id: - raise ValueError("External ID type: %s does not exist" % type_name) + raise ValueError("External ID type: %s does not exist" % type_name) # noqa: UP031 return str(external_id.external_user_id) def get_anonymous_user_id(self, username, course_id): diff --git a/common/static/applets/capa/Protex.jar b/common/static/applets/capa/Protex.jar deleted file mode 100644 index 2c6a819ec5d1..000000000000 Binary files a/common/static/applets/capa/Protex.jar and /dev/null differ diff --git a/common/static/applets/capa/genex.jar b/common/static/applets/capa/genex.jar deleted file mode 100644 index 75f784b59245..000000000000 Binary files a/common/static/applets/capa/genex.jar and /dev/null differ diff --git a/common/static/common/js/karma.common.conf.js b/common/static/common/js/karma.common.conf.js index 91a2d78085cb..ece7f1b5c42b 100644 --- a/common/static/common/js/karma.common.conf.js +++ b/common/static/common/js/karma.common.conf.js @@ -60,7 +60,9 @@ var commonFiles = { ], sourceFiles: [ - {pattern: 'common/js/!(spec_helpers)/**/!(*spec).js'} + // Split common/js/ to exclude spec/main*.js test entry points (handled by runFiles) + {pattern: 'common/js/!(spec_helpers|spec)/**/!(*spec).js'}, // all non-spec, non-spec_helpers dirs + {pattern: 'common/js/spec/**/!(*spec|main*).js'} // spec dir, excluding spec and main* files ], specFiles: [ diff --git a/common/static/common/js/spec/components/paginated_view_spec.js b/common/static/common/js/spec/components/paginated_view_spec.js index 21797a854a3c..b0d059a2256b 100644 --- a/common/static/common/js/spec/components/paginated_view_spec.js +++ b/common/static/common/js/spec/components/paginated_view_spec.js @@ -2,10 +2,11 @@ define([ 'jquery', 'backbone', 'underscore', + 'sinon', 'edx-ui-toolkit/js/pagination/paging-collection', 'edx-ui-toolkit/js/utils/spec-helpers/ajax-helpers', 'common/js/components/views/paginated_view' -], function($, Backbone, _, PagingCollection, AjaxHelpers, PaginatedView) { +], function($, Backbone, _, sinon, PagingCollection, AjaxHelpers, PaginatedView) { 'use strict'; describe('PaginatedView', function() { @@ -23,6 +24,8 @@ define([ TestPaginatedView = PaginatedView.extend({type: 'test', itemViewClass: TestItemView}), testCollection, testView, + requests, + xhrFactory, initialItems, nextPageButtonCss = '.next-page-link', previousPageButtonCss = '.previous-page-link', @@ -35,6 +38,11 @@ define([ }; beforeEach(function() { + xhrFactory = sinon.useFakeXMLHttpRequest(); + requests = []; + requests.currentIndex = 0; + requests.restore = function() { xhrFactory.restore(); }; + xhrFactory.onCreate = function(req) { requests.push(req); }; setFixtures('
          '); initialItems = generateItems(5); var TestPagingCollection = PagingCollection.extend({ @@ -54,6 +62,10 @@ define([ testView = new TestPaginatedView({el: '.test-container', collection: testCollection}).render(); }); + afterEach(function() { + requests.restore(); + }); + /** * Verify that the view's header reflects the page we're currently viewing. * @param matchString the header we expect to see @@ -112,8 +124,7 @@ define([ }); it('can change to the next page', function() { - var requests = AjaxHelpers.requests(this), - newItems = generateItems(1); + var newItems = generateItems(1); expectHeader('Showing 1-5 out of 6 total'); expectItems(initialItems); expectFooter({currentPage: 1, totalPages: 2, isHidden: false}); @@ -131,8 +142,7 @@ define([ }); it('can change to the previous page', function() { - var requests = AjaxHelpers.requests(this), - previousPageItems; + var previousPageItems; initialItems = generateItems(1); testCollection.set( { @@ -160,7 +170,6 @@ define([ }); it('sets focus for screen readers', function() { - var requests = AjaxHelpers.requests(this); spyOn($.fn, 'focus'); testView.$(nextPageButtonCss).click(); AjaxHelpers.respondWithJson(requests, { @@ -173,8 +182,7 @@ define([ }); it('does not change on server error', function() { - var requests = AjaxHelpers.requests(this), - expectInitialState = function() { + var expectInitialState = function() { expectHeader('Showing 1-5 out of 6 total'); expectItems(initialItems); expectFooter({currentPage: 1, totalPages: 2, isHidden: false}); diff --git a/common/static/common/js/spec/components/paging_footer_spec.js b/common/static/common/js/spec/components/paging_footer_spec.js index 39bd93b909b8..887d6240662c 100644 --- a/common/static/common/js/spec/components/paging_footer_spec.js +++ b/common/static/common/js/spec/components/paging_footer_spec.js @@ -2,14 +2,17 @@ define([ 'jquery', 'URI', 'underscore', + 'sinon', 'edx-ui-toolkit/js/pagination/paging-collection', 'edx-ui-toolkit/js/utils/spec-helpers/ajax-helpers', 'common/js/components/views/paging_footer' -], function($, URI, _, PagingCollection, AjaxHelpers, PagingFooter) { +], function($, URI, _, sinon, PagingCollection, AjaxHelpers, PagingFooter) { 'use strict'; describe('PagingFooter', function() { var pagingFooter, + requests, + xhrFactory, mockPage = function(currentPage, numPages, collectionLength) { if (_.isUndefined(collectionLength)) { collectionLength = 1; @@ -29,6 +32,11 @@ define([ pageNumberInputCss = '.page-number-input'; beforeEach(function() { + xhrFactory = sinon.useFakeXMLHttpRequest(); + requests = []; + requests.currentIndex = 0; + requests.restore = function() { xhrFactory.restore(); }; + xhrFactory.onCreate = function(req) { requests.push(req); }; setFixtures('
          '); var collection = new PagingCollection(mockPage(1, 2), {parse: true}); collection.url = '/test/url/'; @@ -39,6 +47,10 @@ define([ }).render(); }); + afterEach(function() { + requests.restore(); + }); + describe('when hideWhenOnePage is true', function() { beforeEach(function() { pagingFooter.hideWhenOnePage = true; @@ -69,14 +81,12 @@ define([ describe('Next page button', function() { it('does not move forward if a server error occurs', function() { - var requests = AjaxHelpers.requests(this); pagingFooter.$(nextPageCss).click(); requests[0].respond(500); expect(pagingFooter.$(currentPageCss)).toHaveText('1'); }); it('can move to the next page', function() { - var requests = AjaxHelpers.requests(this); pagingFooter.$(nextPageCss).click(); AjaxHelpers.respondWithJson(requests, mockPage(2, 2)); expect(pagingFooter.collection.getPageNumber()).toBe(2); @@ -88,7 +98,6 @@ define([ }); it('should be disabled on the final page', function() { - var requests = AjaxHelpers.requests(this); pagingFooter.$(nextPageCss).click(); AjaxHelpers.respondWithJson(requests, mockPage(2, 2)); expect(pagingFooter.$(nextPageCss)).toHaveClass('is-disabled'); @@ -97,7 +106,6 @@ define([ describe('Previous page button', function() { it('does not move back if a server error occurs', function() { - var requests = AjaxHelpers.requests(this); pagingFooter.collection.reset(mockPage(2, 2), {parse: true}); pagingFooter.$(previousPageCss).click(); requests[0].respond(500); @@ -105,7 +113,6 @@ define([ }); it('can go back a page', function() { - var requests = AjaxHelpers.requests(this); pagingFooter.$(nextPageCss).click(); AjaxHelpers.respondWithJson(requests, mockPage(2, 2)); pagingFooter.$(previousPageCss).click(); @@ -118,7 +125,6 @@ define([ }); it('should be enabled on the second page', function() { - var requests = AjaxHelpers.requests(this); pagingFooter.$(nextPageCss).click(); AjaxHelpers.respondWithJson(requests, mockPage(2, 2)); expect(pagingFooter.$(previousPageCss)).not.toHaveClass('is-disabled'); @@ -131,7 +137,6 @@ define([ }); it('should show 2 on the second page', function() { - var requests = AjaxHelpers.requests(this); pagingFooter.$(nextPageCss).click(); AjaxHelpers.respondWithJson(requests, mockPage(2, 2)); expect(pagingFooter.$(currentPageCss)).toHaveText('2'); @@ -154,7 +159,6 @@ define([ }); it('should handle invalid page requests', function() { - var requests = AjaxHelpers.requests(this); pagingFooter.$(pageNumberInputCss).val('abc'); pagingFooter.$(pageNumberInputCss).trigger('change'); expect(pagingFooter.$(currentPageCss)).toHaveText('1'); @@ -162,7 +166,6 @@ define([ }); it('should switch pages via the input field', function() { - var requests = AjaxHelpers.requests(this); pagingFooter.$(pageNumberInputCss).val('2'); pagingFooter.$(pageNumberInputCss).trigger('change'); AjaxHelpers.respondWithJson(requests, mockPage(2, 2)); @@ -171,7 +174,6 @@ define([ }); it('should handle AJAX failures when switching pages via the input field', function() { - var requests = AjaxHelpers.requests(this); pagingFooter.$(pageNumberInputCss).val('2'); pagingFooter.$(pageNumberInputCss).trigger('change'); requests[0].respond(500); diff --git a/common/static/common/js/spec/components/search_field_spec.js b/common/static/common/js/spec/components/search_field_spec.js index dbd4fa1bd29b..b82106822a87 100644 --- a/common/static/common/js/spec/components/search_field_spec.js +++ b/common/static/common/js/spec/components/search_field_spec.js @@ -1,14 +1,17 @@ define([ 'underscore', 'URI', + 'sinon', 'edx-ui-toolkit/js/utils/spec-helpers/ajax-helpers', 'edx-ui-toolkit/js/pagination/paging-collection', 'common/js/components/views/search_field' -], function(_, URI, AjaxHelpers, PagingCollection, SearchFieldView) { +], function(_, URI, sinon, AjaxHelpers, PagingCollection, SearchFieldView) { 'use strict'; describe('SearchFieldView', function() { var searchFieldView, + requests, + xhrFactory, mockUrl = '/api/mock_collection'; var newCollection = function(size, perPage) { @@ -55,9 +58,18 @@ define([ }; beforeEach(function() { + xhrFactory = sinon.useFakeXMLHttpRequest(); + requests = []; + requests.currentIndex = 0; + requests.restore = function() { xhrFactory.restore(); }; + xhrFactory.onCreate = function(req) { requests.push(req); }; setFixtures('
          '); }); + afterEach(function() { + requests.restore(); + }); + it('correctly displays itself', function() { searchFieldView = createSearchFieldView().render(); expect(searchFieldView.$('.search-field').val(), ''); @@ -72,7 +84,6 @@ define([ }); it('refreshes the collection when performing a search', function() { - var requests = AjaxHelpers.requests(this); searchFieldView = createSearchFieldView().render(); searchFieldView.$('.search-field').val('foo'); searchFieldView.$('.action-search').click(); @@ -92,7 +103,6 @@ define([ }); it('can clear the search', function() { - var requests = AjaxHelpers.requests(this); searchFieldView = createSearchFieldView({ searchString: 'foo' }).render(); diff --git a/common/static/common/js/spec_helpers/view_helpers.js b/common/static/common/js/spec_helpers/view_helpers.js index a0e11f4825b3..885e874a38a1 100644 --- a/common/static/common/js/spec_helpers/view_helpers.js +++ b/common/static/common/js/spec_helpers/view_helpers.js @@ -12,6 +12,13 @@ function(_, $, NotificationView, Prompt, AjaxHelpers) { installMockAnalytics, removeMockAnalytics, verifyPromptShowing, verifyPromptHidden, clickDeleteItem, patchAndVerifyRequest, submitAndVerifyFormSuccess, submitAndVerifyFormError; + // Register a single global afterEach to clean up jasmine.stealth constructor spies. + // Jasmine 2.99.x prohibits calling afterEach() from inside it()/beforeEach() callbacks, + // so we cannot register this inside createFeedbackSpy (which is called from it() blocks). + // Calling afterEach() at module scope (outside any describe/it) registers a global hook + // that runs after every spec. AMD caches this module, so the hook is registered exactly once. + afterEach(jasmine.stealth.clearSpies); + installViewTemplates = function() { appendSetFixtures('
          '); }; @@ -19,9 +26,6 @@ function(_, $, NotificationView, Prompt, AjaxHelpers) { createFeedbackSpy = function(type, intent) { var feedbackSpy = jasmine.stealth.spyOnConstructor(type, intent, ['show', 'hide']); feedbackSpy.show.and.returnValue(feedbackSpy); - if (afterEach) { - afterEach(jasmine.stealth.clearSpies); - } return feedbackSpy; }; diff --git a/common/static/data/geoip/GeoLite2-Country.mmdb b/common/static/data/geoip/GeoLite2-Country.mmdb index e29f4f18bb9a..606fa9447a93 100644 Binary files a/common/static/data/geoip/GeoLite2-Country.mmdb and b/common/static/data/geoip/GeoLite2-Country.mmdb differ diff --git a/common/static/images/capa/vsepr/AX2E0-3D-balls.png b/common/static/images/capa/vsepr/AX2E0-3D-balls.png deleted file mode 100644 index 7595cf2a6c96..000000000000 Binary files a/common/static/images/capa/vsepr/AX2E0-3D-balls.png and /dev/null differ diff --git a/common/static/images/capa/vsepr/AX2E1-3D-balls.png b/common/static/images/capa/vsepr/AX2E1-3D-balls.png deleted file mode 100644 index c8816feb114f..000000000000 Binary files a/common/static/images/capa/vsepr/AX2E1-3D-balls.png and /dev/null differ diff --git a/common/static/images/capa/vsepr/AX2E2-3D-balls.png b/common/static/images/capa/vsepr/AX2E2-3D-balls.png deleted file mode 100644 index 00faa7e6beef..000000000000 Binary files a/common/static/images/capa/vsepr/AX2E2-3D-balls.png and /dev/null differ diff --git a/common/static/images/capa/vsepr/AX2E3-3D-balls.png b/common/static/images/capa/vsepr/AX2E3-3D-balls.png deleted file mode 100644 index 4fb7022f8c03..000000000000 Binary files a/common/static/images/capa/vsepr/AX2E3-3D-balls.png and /dev/null differ diff --git a/common/static/images/capa/vsepr/AX3E0-3D-balls.png b/common/static/images/capa/vsepr/AX3E0-3D-balls.png deleted file mode 100644 index eeff5b22a244..000000000000 Binary files a/common/static/images/capa/vsepr/AX3E0-3D-balls.png and /dev/null differ diff --git a/common/static/images/capa/vsepr/AX3E1-3D-balls.png b/common/static/images/capa/vsepr/AX3E1-3D-balls.png deleted file mode 100644 index e5386bf0d79a..000000000000 Binary files a/common/static/images/capa/vsepr/AX3E1-3D-balls.png and /dev/null differ diff --git a/common/static/images/capa/vsepr/AX3E2-3D-balls.png b/common/static/images/capa/vsepr/AX3E2-3D-balls.png deleted file mode 100644 index 185abaa4ea61..000000000000 Binary files a/common/static/images/capa/vsepr/AX3E2-3D-balls.png and /dev/null differ diff --git a/common/static/images/capa/vsepr/AX4E0-3D-balls.png b/common/static/images/capa/vsepr/AX4E0-3D-balls.png deleted file mode 100644 index f690ad1f5a09..000000000000 Binary files a/common/static/images/capa/vsepr/AX4E0-3D-balls.png and /dev/null differ diff --git a/common/static/images/capa/vsepr/AX4E1-3D-balls.png b/common/static/images/capa/vsepr/AX4E1-3D-balls.png deleted file mode 100644 index 1e940f7576c3..000000000000 Binary files a/common/static/images/capa/vsepr/AX4E1-3D-balls.png and /dev/null differ diff --git a/common/static/images/capa/vsepr/AX4E2-3D-balls.png b/common/static/images/capa/vsepr/AX4E2-3D-balls.png deleted file mode 100644 index ec74eb90fc20..000000000000 Binary files a/common/static/images/capa/vsepr/AX4E2-3D-balls.png and /dev/null differ diff --git a/common/static/images/capa/vsepr/AX5E1-3D-balls.png b/common/static/images/capa/vsepr/AX5E1-3D-balls.png deleted file mode 100644 index dc12dd9f749d..000000000000 Binary files a/common/static/images/capa/vsepr/AX5E1-3D-balls.png and /dev/null differ diff --git a/common/static/images/capa/vsepr/AX5E2-3D-balls.png b/common/static/images/capa/vsepr/AX5E2-3D-balls.png deleted file mode 100644 index 38755c144de0..000000000000 Binary files a/common/static/images/capa/vsepr/AX5E2-3D-balls.png and /dev/null differ diff --git a/common/static/images/capa/vsepr/AX6E0-3D-balls.png b/common/static/images/capa/vsepr/AX6E0-3D-balls.png deleted file mode 100644 index 775ffc46b981..000000000000 Binary files a/common/static/images/capa/vsepr/AX6E0-3D-balls.png and /dev/null differ diff --git a/common/static/images/capa/vsepr/AX6E1-3D-balls.png b/common/static/images/capa/vsepr/AX6E1-3D-balls.png deleted file mode 100644 index 3e51b877c1b6..000000000000 Binary files a/common/static/images/capa/vsepr/AX6E1-3D-balls.png and /dev/null differ diff --git a/common/static/images/capa/vsepr/AX7E0-3D-balls.png b/common/static/images/capa/vsepr/AX7E0-3D-balls.png deleted file mode 100644 index 95d7aebffd5f..000000000000 Binary files a/common/static/images/capa/vsepr/AX7E0-3D-balls.png and /dev/null differ diff --git a/common/static/images/capa/vsepr/AX8E0-3D-balls.png b/common/static/images/capa/vsepr/AX8E0-3D-balls.png deleted file mode 100644 index 3a24f7794a88..000000000000 Binary files a/common/static/images/capa/vsepr/AX8E0-3D-balls.png and /dev/null differ diff --git a/common/static/images/capa/vsepr/AX9E0-3D-balls.png b/common/static/images/capa/vsepr/AX9E0-3D-balls.png deleted file mode 100644 index b457f58eb5f0..000000000000 Binary files a/common/static/images/capa/vsepr/AX9E0-3D-balls.png and /dev/null differ diff --git a/common/static/images/capa/vsepr/Bent-3D-balls.png b/common/static/images/capa/vsepr/Bent-3D-balls.png deleted file mode 100644 index 71bb9526a89c..000000000000 Binary files a/common/static/images/capa/vsepr/Bent-3D-balls.png and /dev/null differ diff --git a/common/static/images/capa/vsepr/Linear-3D-balls.png b/common/static/images/capa/vsepr/Linear-3D-balls.png deleted file mode 100644 index af5f92c7b102..000000000000 Binary files a/common/static/images/capa/vsepr/Linear-3D-balls.png and /dev/null differ diff --git a/common/static/images/capa/vsepr/Linear-stick.png b/common/static/images/capa/vsepr/Linear-stick.png deleted file mode 100644 index e1306f9a0d31..000000000000 Binary files a/common/static/images/capa/vsepr/Linear-stick.png and /dev/null differ diff --git a/common/static/images/capa/vsepr/Octahedral-3D-balls.png b/common/static/images/capa/vsepr/Octahedral-3D-balls.png deleted file mode 100644 index 0032fe1ed31d..000000000000 Binary files a/common/static/images/capa/vsepr/Octahedral-3D-balls.png and /dev/null differ diff --git a/common/static/images/capa/vsepr/Octahedral-stick.png b/common/static/images/capa/vsepr/Octahedral-stick.png deleted file mode 100644 index 3d2b7ca5fd1e..000000000000 Binary files a/common/static/images/capa/vsepr/Octahedral-stick.png and /dev/null differ diff --git a/common/static/images/capa/vsepr/Pentagonal-bipyramidal-3D-balls.png b/common/static/images/capa/vsepr/Pentagonal-bipyramidal-3D-balls.png deleted file mode 100644 index 23e02daf25b3..000000000000 Binary files a/common/static/images/capa/vsepr/Pentagonal-bipyramidal-3D-balls.png and /dev/null differ diff --git a/common/static/images/capa/vsepr/Pentagonal-planar-3D-balls.png b/common/static/images/capa/vsepr/Pentagonal-planar-3D-balls.png deleted file mode 100644 index 0768ec750463..000000000000 Binary files a/common/static/images/capa/vsepr/Pentagonal-planar-3D-balls.png and /dev/null differ diff --git a/common/static/images/capa/vsepr/Pentagonal-pyramidal-3D-balls.png b/common/static/images/capa/vsepr/Pentagonal-pyramidal-3D-balls.png deleted file mode 100644 index 511db1ea16f2..000000000000 Binary files a/common/static/images/capa/vsepr/Pentagonal-pyramidal-3D-balls.png and /dev/null differ diff --git a/common/static/images/capa/vsepr/Pyramidal-3D-balls.png b/common/static/images/capa/vsepr/Pyramidal-3D-balls.png deleted file mode 100644 index 0383528d3d59..000000000000 Binary files a/common/static/images/capa/vsepr/Pyramidal-3D-balls.png and /dev/null differ diff --git a/common/static/images/capa/vsepr/Seesaw-3D-balls.png b/common/static/images/capa/vsepr/Seesaw-3D-balls.png deleted file mode 100644 index b7665da3b5ef..000000000000 Binary files a/common/static/images/capa/vsepr/Seesaw-3D-balls.png and /dev/null differ diff --git a/common/static/images/capa/vsepr/Square-antiprismatic-3D-balls.png b/common/static/images/capa/vsepr/Square-antiprismatic-3D-balls.png deleted file mode 100644 index 675ba88c5c24..000000000000 Binary files a/common/static/images/capa/vsepr/Square-antiprismatic-3D-balls.png and /dev/null differ diff --git a/common/static/images/capa/vsepr/Square-planar-3D-balls.png b/common/static/images/capa/vsepr/Square-planar-3D-balls.png deleted file mode 100644 index 6a90a0c361d6..000000000000 Binary files a/common/static/images/capa/vsepr/Square-planar-3D-balls.png and /dev/null differ diff --git a/common/static/images/capa/vsepr/T-shaped-3D-balls.png b/common/static/images/capa/vsepr/T-shaped-3D-balls.png deleted file mode 100644 index b3eaa47f8acc..000000000000 Binary files a/common/static/images/capa/vsepr/T-shaped-3D-balls.png and /dev/null differ diff --git a/common/static/images/capa/vsepr/Tetrahedral-3D-balls.png b/common/static/images/capa/vsepr/Tetrahedral-3D-balls.png deleted file mode 100644 index 9ff8731ac0ea..000000000000 Binary files a/common/static/images/capa/vsepr/Tetrahedral-3D-balls.png and /dev/null differ diff --git a/common/static/images/capa/vsepr/Tetrahedral-stick.png b/common/static/images/capa/vsepr/Tetrahedral-stick.png deleted file mode 100644 index 09a41164b65d..000000000000 Binary files a/common/static/images/capa/vsepr/Tetrahedral-stick.png and /dev/null differ diff --git a/common/static/images/capa/vsepr/Trigonal-3D-balls.png b/common/static/images/capa/vsepr/Trigonal-3D-balls.png deleted file mode 100644 index 20e7c957d879..000000000000 Binary files a/common/static/images/capa/vsepr/Trigonal-3D-balls.png and /dev/null differ diff --git a/common/static/images/capa/vsepr/Trigonal-bipyramidal-3D-balls.png b/common/static/images/capa/vsepr/Trigonal-bipyramidal-3D-balls.png deleted file mode 100644 index ab5f0133965e..000000000000 Binary files a/common/static/images/capa/vsepr/Trigonal-bipyramidal-3D-balls.png and /dev/null differ diff --git a/common/static/images/capa/vsepr/Trigonal-bipyramidal-stick.png b/common/static/images/capa/vsepr/Trigonal-bipyramidal-stick.png deleted file mode 100644 index 3b36dcd5c66b..000000000000 Binary files a/common/static/images/capa/vsepr/Trigonal-bipyramidal-stick.png and /dev/null differ diff --git a/common/static/images/capa/vsepr/Trigonal-planar-stick.png b/common/static/images/capa/vsepr/Trigonal-planar-stick.png deleted file mode 100644 index f2fd25c56f80..000000000000 Binary files a/common/static/images/capa/vsepr/Trigonal-planar-stick.png and /dev/null differ diff --git a/common/static/js/capa/README b/common/static/js/capa/README deleted file mode 100644 index ca845717fe53..000000000000 --- a/common/static/js/capa/README +++ /dev/null @@ -1 +0,0 @@ -These files really should be in the capa block, but we don't have a way to load js from there at the moment. (TODO) diff --git a/common/static/js/capa/annotationinput.js b/common/static/js/capa/annotationinput.js deleted file mode 100644 index 09adde930c83..000000000000 --- a/common/static/js/capa/annotationinput.js +++ /dev/null @@ -1,98 +0,0 @@ -(function() { - var debug = false; - - var module = { - debug: debug, - inputSelector: '.annotation-input', - tagSelector: '.tag', - tagsSelector: '.tags', - commentSelector: 'textarea.comment', - valueSelector: 'input.value', // stash tag selections and comment here as a JSON string... - - singleSelect: true, - - init: function() { - var that = this; - - if (this.debug) { console.log('annotation input loaded: '); } - - $(this.inputSelector).each(function(index, el) { - if (!$(el).data('listening')) { - $(el).delegate(that.tagSelector, 'click', $.proxy(that.onClickTag, that)); - $(el).delegate(that.commentSelector, 'change', $.proxy(that.onChangeComment, that)); - $(el).data('listening', 'yes'); - } - }); - }, - onChangeComment: function(e) { - var value_el = this.findValueEl(e.target); - var current_value = this.loadValue(value_el); - var target_value = $(e.target).val(); - - current_value.comment = target_value; - this.storeValue(value_el, current_value); - }, - onClickTag: function(e) { - var target_el = e.target, - target_value, target_index; - var value_el, current_value; - - value_el = this.findValueEl(e.target); - current_value = this.loadValue(value_el); - target_value = $(e.target).data('id'); - - if (!$(target_el).hasClass('selected')) { - if (this.singleSelect) { - current_value.options = [target_value]; - } else { - current_value.options.push(target_value); - } - } else { - if (this.singleSelect) { - current_value.options = []; - } else { - target_index = current_value.options.indexOf(target_value); - if (target_index !== -1) { - current_value.options.splice(target_index, 1); - } - } - } - - this.storeValue(value_el, current_value); - - if (this.singleSelect) { - $(target_el).closest(this.tagsSelector) - .find(this.tagSelector) - .not(target_el) - .removeClass('selected'); - } - $(target_el).toggleClass('selected'); - }, - findValueEl: function(target_el) { - var input_el = $(target_el).closest(this.inputSelector); - return $(this.valueSelector, input_el); - }, - loadValue: function(value_el) { - var json = $(value_el).val(); - - var result = JSON.parse(json); - if (result === null) { - result = {}; - } - if (!result.hasOwnProperty('options')) { - result.options = []; - } - if (!result.hasOwnProperty('comment')) { - result.comment = ''; - } - - return result; - }, - storeValue: function(value_el, new_value) { - var json = JSON.stringify(new_value); - $(value_el).val(json); - } - }; - - module.init(); -}).call(this); diff --git a/common/static/js/capa/chemical_equation_preview.js b/common/static/js/capa/chemical_equation_preview.js deleted file mode 100644 index d23d8e51d3f6..000000000000 --- a/common/static/js/capa/chemical_equation_preview.js +++ /dev/null @@ -1,36 +0,0 @@ -(function() { - update = function() { - function create_handler(saved_div) { - return (function(response) { - if (response.error) { - edx.HtmlUtils.setHtml( - saved_div, - edx.HtmlUtils.joinHtml( - edx.HtmlUtils.HTML(""), - response.error, - edx.HtmlUtils.HTML('') - ) - ); - } else { - saved_div.html(edx.HtmlUtils.HTML(response.preview).toString()); - } - }); - } - - prev_id = '#' + this.id + '_preview'; - preview_div = $(prev_id); - - // find the closest parent problems-wrapper and use that url - url = $(this).closest('.problems-wrapper').data('url'); - // grab the input id from the input - input_id = $(this).data('input-id'); - - Problem.inputAjax(url, input_id, 'preview_chemcalc', {formula: this.value}, create_handler(preview_div)); - }; - - inputs = $('.chemicalequationinput input'); - // update on load - inputs.each(update); - // and on every change - inputs.bind('input', update); -}).call(this); diff --git a/common/static/js/capa/choicetextinput.js b/common/static/js/capa/choicetextinput.js deleted file mode 100644 index 3d08c94ba7f2..000000000000 --- a/common/static/js/capa/choicetextinput.js +++ /dev/null @@ -1,73 +0,0 @@ -(function() { - var update = function() { - // Whenever a value changes create a new serialized version of this - // problem's inputs and set the hidden input field's value to equal it. - var parent = $(this).closest('section.choicetextinput'); - // find the closest parent problems-wrapper and use that as the problem - // grab the input id from the input - // real_input is the hidden input field - var $real_input = $('input.choicetextvalue', parent); - var $all_inputs = $('input.ctinput', parent); - var user_inputs = {}; - $($all_inputs).each(function(index, elt) { - var $node = $(elt); - var name = $node.attr('id'); - var val = $node.val(); - var radio_value = $node.attr('value'); - var type = $node.attr('type'); - var is_checked = $node.attr('checked'); - if (type === 'radio' || type === 'checkbox') { - if (is_checked === 'checked' || is_checked === 'true') { - user_inputs[name] = radio_value; - } - } else { - user_inputs[name] = val; - } - }); - var val_string = JSON.stringify(user_inputs); - // this is what gets submitted as the answer, we deserialize it later - $real_input.val(val_string); - }; - - var check_parent = function(event) { - // This looks for the containing choice of a textinput - // and sets it to be checked. - var $elt = $(event.target); - var parent_container = $elt.closest('section[id^="forinput"]'); - var choice = parent_container.find("input[type='checkbox'], input[type='radio']"); - choice.attr('checked', 'checked'); - choice.change(); - // need to check it then trigger the change event - }; - - var imitate_label = function(event) { - // This causes a section to check and uncheck - // a radiobutton/checkbox whenever a user clicks on it - // If the button/checkbox is disabled, nothing happens - var $elt = $(event.target); - var parent_container = $elt.closest('section[id^="forinput"]'); - var choice = parent_container.find("input[type='checkbox'], input[type='radio']"); - if (choice.attr('type') === 'radio') { - choice.attr('checked', 'checked'); - } else { - if (choice.attr('checked')) { - choice.prop('checked', false); - } else { - choice.prop('checked', true); - } - } - choice.change(); - update(); - }; - var $choices = $('.mock_label'); - var $inputs = $('.choicetextinput .ctinput'); - var $text_inputs = $('.choicetextinput .ctinput[type="text"]'); - // update on load - $inputs.each(update); - // and on every change - // This allows text inside of choices to behave as if they were part of - // a label for the choice's button/checkbox - $choices.click(imitate_label); - $inputs.bind('change', update); - $text_inputs.click(check_parent); -}).call(this); diff --git a/common/static/js/capa/design-protein-2d.js b/common/static/js/capa/design-protein-2d.js deleted file mode 100644 index 84a372156e00..000000000000 --- a/common/static/js/capa/design-protein-2d.js +++ /dev/null @@ -1,85 +0,0 @@ -(function() { - var timeout = 1000; - - waitForProtex(); - - function waitForProtex() { - if (typeof protex !== 'undefined' && protex) { - protex.onInjectionDone('protex'); - // eslint-disable-next-line brace-style - } - /* if (typeof(protex) !== "undefined") { - //initializeProtex(); - } */ - else { - setTimeout(function() { waitForProtex(); }, timeout); - } - } - - // NOTE: - // Protex uses three global functions: - // protexSetTargetShape (exported from GWT) - // exported protexCheckAnswer (exported from GWT) - // It calls protexIsReady with a deferred command when it has finished - // initialization and has drawn itself - - function updateProtexField() { - var problem = $('#protex_container').parents('.problem'); - var input_field = problem.find('input[type=hidden]'); - var protex_answer = protexCheckAnswer(); - var value = {protex_answer: protex_answer}; - // console.log(JSON.stringify(value)); - input_field.val(JSON.stringify(value)); - } - - protexIsReady = function() { - // Load target shape - var target_shape = $('#target_shape').val(); - protexSetTargetShape(target_shape); - - // Get answer from protex and store it into the hidden input field - // when Check button is clicked - var $fold_button = $('#fold-button'); - $fold_button.on('click', function() { - var problem = $('#protex_container').parents('.problem'); - var input_field = problem.find('input[type=hidden]'); - var protex_answer = protexCheckAnswer(); - var value = {protex_answer: protex_answer}; - // console.log(JSON.stringify(value)); - input_field.val(JSON.stringify(value)); - }); - updateProtexField(); - }; - - /* function initializeProtex() { - //Check to see if the two exported GWT functions protexSetTargetShape - // and protexCheckAnswer have been appended to global scope -- this - //happens at the end of onModuleLoad() in GWT - if (typeof(protexSetTargetShape) === "function" && - typeof(protexCheckAnswer) === "function") { - - //Load target shape - var target_shape = $('#target_shape').val(); - //protexSetTargetShape(target_shape); - - //Get answer from protex and store it into the hidden input field - //when Check button is clicked - var problem = $('#protex_container').parents('.problem'); - var check_button = problem.find('input.check'); - var input_field = problem.find('input[type=hidden]'); - check_button.on('click', function() { - var protex_answer = protexCheckAnswer(); - var value = {protex_answer: protex_answer}; - input_field.val(JSON.stringify(value)); - }); - - //TO DO: Fix this, it works but is utterly ugly and unreliable - setTimeout(function() { - protexSetTargetShape(target_shape);}, 2000); - - } - else { - setTimeout(function() {initializeProtex(); }, timeout); - } - } */ -}).call(this); diff --git a/common/static/js/capa/drag_and_drop.js b/common/static/js/capa/drag_and_drop.js deleted file mode 100644 index aedf86612f11..000000000000 --- a/common/static/js/capa/drag_and_drop.js +++ /dev/null @@ -1,25 +0,0 @@ -// Wrapper for RequireJS. It will make the standard requirejs(), require(), and -// define() functions from Require JS available inside the anonymous function. -// -// See https://openedx.atlassian.net/wiki/display/PLAT/Integration+of+Require+JS+into+the+system -(function(requirejs, require, define) { -// HACK: this should be removed when it is safe to do so - if (window.baseUrl) { - requirejs.config({baseUrl: baseUrl}); - } - - // The current JS file will be loaded and run each time. It will require a - // single dependency which will be loaded and stored by RequireJS. On - // subsequent runs, RequireJS will return the dependency from memory, rather - // than loading it again from the server. For that reason, it is a good idea to - // keep the current JS file as small as possible, and move everything else into - // RequireJS module dependencies. - require(['js/capa/drag_and_drop/main'], function(Main) { - Main(); - }); - -// End of wrapper for RequireJS. As you can see, we are passing -// namespaced Require JS variables to an anonymous function. Within -// it, you can use the standard requirejs(), require(), and define() -// functions as if they were in the global namespace. -}(RequireJS.requirejs, RequireJS.require, RequireJS.define)); // End-of: (function (requirejs, require, define) diff --git a/common/static/js/capa/drag_and_drop/base_image.js b/common/static/js/capa/drag_and_drop/base_image.js deleted file mode 100644 index 736d8d343812..000000000000 --- a/common/static/js/capa/drag_and_drop/base_image.js +++ /dev/null @@ -1,45 +0,0 @@ -(function(requirejs, require, define) { - define(['edx-ui-toolkit/js/utils/html-utils'], function(HtmlUtils) { - return BaseImage; - - function BaseImage(state) { - var $baseImageElContainer; - - $baseImageElContainer = $(HtmlUtils.joinHtml( - HtmlUtils.HTML('
          ') - ).toString()); - - state.baseImageEl = $('', { - alt: gettext('Drop target image') - }); - - state.baseImageEl.attr('src', state.config.baseImage); - state.baseImageEl.load(function() { - $baseImageElContainer.css({ - width: this.width, - height: this.height - }); - - state.baseImageEl.appendTo($baseImageElContainer); - $baseImageElContainer.appendTo(state.containerEl); - - state.baseImageEl.mousedown(function(event) { - event.preventDefault(); - }); - - state.baseImageLoaded = true; - }); - state.baseImageEl.error(function() { - var errorMsg = HtmlUtils.joinHtml( - HtmlUtils.HTML(''), - HtmlUtils.HTML('ERROR: Image "'), state.config.baseImage, HtmlUtils.HTML('" was not found!'), - HtmlUtils.HTML('') - ); - console.log('ERROR: Image "' + state.config.baseImage + '" was not found!'); - HtmlUtils.setHtml($baseImageElContainer, errorMsg); - $baseImageElContainer.appendTo(state.containerEl); - }); - } - }); // End-of: define([], function () { -}(RequireJS.requirejs, RequireJS.require, RequireJS.define)); // End-of: (function (requirejs, require, define) { diff --git a/common/static/js/capa/drag_and_drop/config_parser.js b/common/static/js/capa/drag_and_drop/config_parser.js deleted file mode 100644 index bbd574b0d33a..000000000000 --- a/common/static/js/capa/drag_and_drop/config_parser.js +++ /dev/null @@ -1,271 +0,0 @@ -(function(requirejs, require, define) { - define([], function() { - return configParser; - - function configParser(state, config) { - state.config = { - draggables: [], - baseImage: '', - targets: [], - onePerTarget: null, // Specified by user. No default. - targetOutline: true, - labelBgColor: '#d6d6d6', - individualTargets: null, // Depends on 'targets'. - foundErrors: false // Whether or not we find errors while processing the config. - }; - - getDraggables(state, config); - getBaseImage(state, config); - getTargets(state, config); - getOnePerTarget(state, config); - getTargetOutline(state, config); - getLabelBgColor(state, config); - - setIndividualTargets(state); - - if (state.config.foundErrors !== false) { - return false; - } - - return true; - } - - function getDraggables(state, config) { - if (config.hasOwnProperty('draggables') === false) { - console.log('ERROR: "config" does not have a property "draggables".'); - state.config.foundErrors = true; - } else if ($.isArray(config.draggables) === true) { - config.draggables.every(function(draggable) { - if (processDraggable(state, draggable) !== true) { - state.config.foundErrors = true; - - // Exit immediately from .every() call. - return false; - } - - // Continue to next .every() call. - return true; - }); - } else { - console.log('ERROR: The type of config.draggables is no supported.'); - state.config.foundErrors = true; - } - } - - function getBaseImage(state, config) { - if (config.hasOwnProperty('base_image') === false) { - console.log('ERROR: "config" does not have a property "base_image".'); - state.config.foundErrors = true; - } else if (typeof config.base_image === 'string') { - state.config.baseImage = config.base_image; - } else { - console.log('ERROR: Property config.base_image is not of type "string".'); - state.config.foundErrors = true; - } - } - - function getTargets(state, config) { - if (config.hasOwnProperty('targets') === false) { - // It is possible that no "targets" were specified. This is not an error. - // In this case the default value of "[]" (empty array) will be used. - // Draggables can be positioned anywhere on the image, and the server will - // get an answer in the form of (x, y) coordinates for each draggable. - } else if ($.isArray(config.targets) === true) { - config.targets.every(function(target) { - if (processTarget(state, target) !== true) { - state.config.foundErrors = true; - - // Exit immediately from .every() call. - return false; - } - - // Continue to next .every() call. - return true; - }); - } else { - console.log('ERROR: Property config.targets is not of a supported type.'); - state.config.foundErrors = true; - } - } - - function getOnePerTarget(state, config) { - if (config.hasOwnProperty('one_per_target') === false) { - console.log('ERROR: "config" does not have a property "one_per_target".'); - state.config.foundErrors = true; - } else if (typeof config.one_per_target === 'string') { - if (config.one_per_target.toLowerCase() === 'true') { - state.config.onePerTarget = true; - } else if (config.one_per_target.toLowerCase() === 'false') { - state.config.onePerTarget = false; - } else { - console.log('ERROR: Property config.one_per_target can either be "true", or "false".'); - state.config.foundErrors = true; - } - } else { - console.log('ERROR: Property config.one_per_target is not of a supported type.'); - state.config.foundErrors = true; - } - } - - function getTargetOutline(state, config) { - // It is possible that no "target_outline" was specified. This is not an error. - // In this case the default value of 'true' (boolean) will be used. - - if (config.hasOwnProperty('target_outline') === true) { - if (typeof config.target_outline === 'string') { - if (config.target_outline.toLowerCase() === 'true') { - state.config.targetOutline = true; - } else if (config.target_outline.toLowerCase() === 'false') { - state.config.targetOutline = false; - } else { - console.log('ERROR: Property config.target_outline can either be "true", or "false".'); - state.config.foundErrors = true; - } - } else { - console.log('ERROR: Property config.target_outline is not of a supported type.'); - state.config.foundErrors = true; - } - } - } - - function getLabelBgColor(state, config) { - // It is possible that no "label_bg_color" was specified. This is not an error. - // In this case the default value of '#d6d6d6' (string) will be used. - - if (config.hasOwnProperty('label_bg_color') === true) { - if (typeof config.label_bg_color === 'string') { - state.config.labelBgColor = config.label_bg_color; - } else { - console.log('ERROR: Property config.label_bg_color is not of a supported type.'); - } - } - } - - function setIndividualTargets(state) { - if (state.config.targets.length === 0) { - state.config.individualTargets = false; - } else { - state.config.individualTargets = true; - } - } - - function processDraggable(state, obj) { - if ( - (attrIsString(obj, 'id') === false) - || (attrIsString(obj, 'icon') === false) - || (attrIsString(obj, 'label') === false) - - || (attrIsBoolean(obj, 'can_reuse', false) === false) - - || (obj.hasOwnProperty('target_fields') === false) - ) { - return false; - } - - // Check that all targets in the 'target_fields' property are proper target objects. - // We will be testing the return value from .every() call (it can be 'true' or 'false'). - if (obj.target_fields.every( - function(targetObj) { - return processTarget(state, targetObj, false); - } - ) === false) { - return false; - } - - state.config.draggables.push(obj); - - return true; - } - - // We need 'pushToState' parameter in order to simply test an object for the fact that it is a - // proper target (without pushing it to the 'state' object). When - // - // pushToState === false - // - // the object being tested is not going to be pushed to 'state'. The function will onyl return - // 'true' or 'false. - function processTarget(state, obj, pushToState) { - if ( - (attrIsString(obj, 'id') === false) - - || (attrIsInteger(obj, 'w') === false) - || (attrIsInteger(obj, 'h') === false) - - || (attrIsInteger(obj, 'x') === false) - || (attrIsInteger(obj, 'y') === false) - ) { - return false; - } - - if (pushToState !== false) { - state.config.targets.push(obj); - } - - return true; - } - - function attrIsString(obj, attr) { - if (obj.hasOwnProperty(attr) === false) { - console.log('ERROR: Attribute "obj.' + attr + '" is not present.'); - - return false; - } else if (typeof obj[attr] !== 'string') { - console.log('ERROR: Attribute "obj.' + attr + '" is not a string.'); - - return false; - } - - return true; - } - - function attrIsInteger(obj, attr) { - var tempInt; - - if (obj.hasOwnProperty(attr) === false) { - console.log('ERROR: Attribute "obj.' + attr + '" is not present.'); - - return false; - } - - tempInt = parseInt(obj[attr], 10); - - if (isFinite(tempInt) === false) { - console.log('ERROR: Attribute "obj.' + attr + '" is not an integer.'); - - return false; - } - - obj[attr] = tempInt; - - return true; - } - - function attrIsBoolean(obj, attr, defaultVal) { - if (obj.hasOwnProperty(attr) === false) { - if (defaultVal === undefined) { - console.log('ERROR: Attribute "obj.' + attr + '" is not present.'); - - return false; - } else { - obj[attr] = defaultVal; - - return true; - } - } - - if (obj[attr] === '') { - obj[attr] = defaultVal; - } else if ((obj[attr] === 'false') || (obj[attr] === false)) { - obj[attr] = false; - } else if ((obj[attr] === 'true') || (obj[attr] === true)) { - obj[attr] = true; - } else { - console.log('ERROR: Attribute "obj.' + attr + '" is not a boolean.'); - - return false; - } - - return true; - } - }); // End-of: define([], function () { -}(RequireJS.requirejs, RequireJS.require, RequireJS.define)); // End-of: (function (requirejs, require, define) { diff --git a/common/static/js/capa/drag_and_drop/container.js b/common/static/js/capa/drag_and_drop/container.js deleted file mode 100644 index 35107a8b0df4..000000000000 --- a/common/static/js/capa/drag_and_drop/container.js +++ /dev/null @@ -1,13 +0,0 @@ -(function(requirejs, require, define) { - define(['edx-ui-toolkit/js/utils/html-utils'], function(HtmlUtils) { - return Container; - - function Container(state) { - state.containerEl = $( - '
          ' - ); - - $('#inputtype_' + state.problemId).before(HtmlUtils.HTML(state.containerEl).toString()); - } - }); // End-of: define([], function () { -}(RequireJS.requirejs, RequireJS.require, RequireJS.define)); // End-of: (function (requirejs, require, define) { diff --git a/common/static/js/capa/drag_and_drop/draggable_events.js b/common/static/js/capa/drag_and_drop/draggable_events.js deleted file mode 100644 index 667cd54fe3ae..000000000000 --- a/common/static/js/capa/drag_and_drop/draggable_events.js +++ /dev/null @@ -1,143 +0,0 @@ -(function(requirejs, require, define) { - define([], function() { - return { - attachMouseEventsTo: function(element) { - var self; - - self = this; - - this[element].mousedown(function(event) { - self.mouseDown(event); - }); - this[element].mouseup(function(event) { - self.mouseUp(event); - }); - this[element].mousemove(function(event) { - self.mouseMove(event); - }); - }, - - mouseDown: function(event) { - if (this.mousePressed === false) { - // So that the browser does not perform a default drag. - // If we don't do this, each drag operation will - // potentially cause the highlghting of the dragged element. - event.preventDefault(); - event.stopPropagation(); - - if (this.numDraggablesOnMe > 0) { - return; - } - - // If this draggable is just being dragged out of the - // container, we must perform some additional tasks. - if (this.inContainer === true) { - if ((this.isReusable === true) && (this.isOriginal === true)) { - this.makeDraggableCopy(function(draggableCopy) { - draggableCopy.mouseDown(event); - }); - - return; - } - - if (this.isOriginal === true) { - this.containerEl.hide(); - this.iconEl.detach(); - } - - if (this.iconImgEl !== null) { - this.iconImgEl.css({ - width: this.iconWidth, - height: this.iconHeight - }); - } - this.iconEl.css({ - 'background-color': this.iconElBGColor, - 'padding-left': this.iconElPadding, - 'padding-right': this.iconElPadding, - border: this.iconElBorder, - width: this.iconWidth, - height: this.iconHeight, - left: event.pageX - this.state.baseImageEl.offset().left - this.iconWidth * 0.5 - this.iconElLeftOffset, - top: event.pageY - this.state.baseImageEl.offset().top - this.iconHeight * 0.5 - }); - this.iconEl.appendTo(this.state.baseImageEl.parent()); - - if (this.labelEl !== null) { - if (this.isOriginal === true) { - this.labelEl.detach(); - } - this.labelEl.css({ - 'background-color': this.state.config.labelBgColor, - 'padding-left': 8, - 'padding-right': 8, - border: '1px solid black', - left: event.pageX - this.state.baseImageEl.offset().left - this.labelWidth * 0.5 - 9, // Account for padding, border. - top: event.pageY - this.state.baseImageEl.offset().top + this.iconHeight * 0.5 + 5 - }); - this.labelEl.appendTo(this.state.baseImageEl.parent()); - } - - this.inContainer = false; - if (this.isOriginal === true) { - this.state.numDraggablesInSlider -= 1; - } - // SR: global "screen reader" object in accessibility_tools.js - window.SR.readText(gettext('dragging out of slider')); - } else { - window.SR.readText(gettext('dragging')); - } - - this.zIndex = 1000; - this.iconEl.css('z-index', '1000'); - if (this.labelEl !== null) { - this.labelEl.css('z-index', '1000'); - } - this.iconEl.attr('aria-grabbed', 'true').focus(); - this.toggleTargets(true); - this.mousePressed = true; - this.state.currentMovingDraggable = this; - } - }, - - mouseUp: function() { - if (this.mousePressed === true) { - this.state.currentMovingDraggable = null; - this.iconEl.attr('aria-grabbed', 'false'); - - this.checkLandingElement(); - if (this.inContainer === true) { - window.SR.readText(gettext('dropped in slider')); - } else { - window.SR.readText(gettext('dropped on target')); - } - this.toggleTargets(false); - } - }, - - mouseMove: function(event) { - if (this.mousePressed === true) { - // Because we have also attached a 'mousemove' event to the - // 'document' (that will do the same thing), let's tell the - // browser not to bubble up this event. The attached event - // on the 'document' will only be triggered when the mouse - // pointer leaves the draggable while it is in the middle - // of a drag operation (user moves the mouse very quickly). - event.stopPropagation(); - - this.iconEl.css({ - left: event.pageX - this.state.baseImageEl.offset().left - this.iconWidth * 0.5 - this.iconElLeftOffset, - top: event.pageY - this.state.baseImageEl.offset().top - this.iconHeight * 0.5 - }); - - if (this.labelEl !== null) { - this.labelEl.css({ - left: event.pageX - this.state.baseImageEl.offset().left - this.labelWidth * 0.5 - 9, // Acoount for padding, border. - top: event.pageY - this.state.baseImageEl.offset().top + this.iconHeight * 0.5 + 5 - }); - } - } - } - }; // End-of: return { - }); // End-of: define([], function () { -}(RequireJS.requirejs, RequireJS.require, RequireJS.define)); // End-of: (function (requirejs, require, define) { diff --git a/common/static/js/capa/drag_and_drop/draggable_logic.js b/common/static/js/capa/drag_and_drop/draggable_logic.js deleted file mode 100644 index 5de987fd128c..000000000000 --- a/common/static/js/capa/drag_and_drop/draggable_logic.js +++ /dev/null @@ -1,400 +0,0 @@ -(function(requirejs, require, define) { - define(['js/capa/drag_and_drop/update_input', 'js/capa/drag_and_drop/targets'], function(updateInput, Targets) { - return { - moveDraggableTo: function(moveType, target, funcCallback) { - var self, offset; - - if (this.hasLoaded === false) { - self = this; - - setTimeout(function() { - self.moveDraggableTo(moveType, target, funcCallback); - }, 50); - - return; - } - - if ((this.isReusable === true) && (this.isOriginal === true)) { - this.makeDraggableCopy(function(draggableCopy) { - draggableCopy.moveDraggableTo(moveType, target, funcCallback); - }); - - return; - } - - offset = 0; - if (this.state.config.targetOutline === true) { - offset = 1; - } - - this.inContainer = false; - - if (this.isOriginal === true) { - this.containerEl.hide(); - this.iconEl.detach(); - } - - if (this.iconImgEl !== null) { - this.iconImgEl.css({ - width: this.iconWidth, - height: this.iconHeight - }); - } - - this.iconEl.css({ - 'background-color': this.iconElBGColor, - 'padding-left': this.iconElPadding, - 'padding-right': this.iconElPadding, - border: this.iconElBorder, - width: this.iconWidth, - height: this.iconHeight - }); - if (moveType === 'target') { - this.iconEl.css({ - left: target.offset.left + 0.5 * target.w - this.iconWidth * 0.5 + offset - this.iconElLeftOffset, - top: target.offset.top + 0.5 * target.h - this.iconHeight * 0.5 + offset - }); - } else { - this.iconEl.css({ - left: target.x - this.iconWidth * 0.5 + offset - this.iconElLeftOffset, - top: target.y - this.iconHeight * 0.5 + offset - }); - } - this.iconEl.appendTo(this.state.baseImageEl.parent()); - - if (this.labelEl !== null) { - if (this.isOriginal === true) { - this.labelEl.detach(); - } - this.labelEl.css({ - 'background-color': this.state.config.labelBgColor, - 'padding-left': 8, - 'padding-right': 8, - border: '1px solid black' - }); - if (moveType === 'target') { - this.labelEl.css({ - left: target.offset.left + 0.5 * target.w - this.labelWidth * 0.5 + offset - 9, // Account for padding, border. - top: target.offset.top + 0.5 * target.h + this.iconHeight * 0.5 + 5 + offset - }); - } else { - this.labelEl.css({ - left: target.x - this.labelWidth * 0.5 + offset - 9, // Account for padding, border. - top: target.y - this.iconHeight * 0.5 + this.iconHeight + 5 + offset - }); - } - this.labelEl.appendTo(this.state.baseImageEl.parent()); - } - - if (moveType === 'target') { - target.addDraggable(this); - } else { - this.x = target.x; - this.y = target.y; - } - - this.zIndex = 1000; - this.correctZIndexes(); - - Targets.initializeTargetField(this); - - if (this.isOriginal === true) { - this.state.numDraggablesInSlider -= 1; - this.state.updateArrowOpacity(); - } - - if ($.isFunction(funcCallback) === true) { - funcCallback(); - } - }, - - // At this point the mouse was realeased, and we need to check - // where the draggable eneded up. Based on several things, we - // will either move the draggable back to the slider, or update - // the input with the user's answer (X-Y position of the draggable, - // or the ID of the target where it landed. - checkLandingElement: function() { - var positionIE; - - this.mousePressed = false; - positionIE = this.iconEl.position(); - - if (this.state.config.individualTargets === true) { - if (this.checkIfOnTarget(positionIE) === true) { - this.correctZIndexes(); - - Targets.initializeTargetField(this); - } else { - if (this.onTarget !== null) { - this.onTarget.removeDraggable(this); - } - - this.moveBackToSlider(); - - if (this.isOriginal === true) { - this.state.numDraggablesInSlider += 1; - } - } - } else { - if ( - (positionIE.left < 0) - || (positionIE.left + this.iconWidth > this.state.baseImageEl.width()) - || (positionIE.top < 0) - || (positionIE.top + this.iconHeight > this.state.baseImageEl.height()) - ) { - this.moveBackToSlider(); - - this.x = -1; - this.y = -1; - - if (this.isOriginal === true) { - this.state.numDraggablesInSlider += 1; - } - } else { - this.correctZIndexes(); - - this.x = positionIE.left + this.iconWidth * 0.5; - this.y = positionIE.top + this.iconHeight * 0.5; - - Targets.initializeTargetField(this); - } - } - - if (this.isOriginal === true) { - this.state.updateArrowOpacity(); - } - updateInput.update(this.state); - }, - - // Determine if a draggable, after it was relased, ends up on a - // target. We do this by iterating over all of the targets, and - // for each one we check whether the draggable's center is - // within the target's dimensions. - // - // positionIE is the object as returned by - // - // this.iconEl.position() - checkIfOnTarget: function(positionIE) { - var c1, target; - - for (c1 = 0; c1 < this.state.targets.length; c1 += 1) { - target = this.state.targets[c1]; - - // If only one draggable per target is allowed, and - // the current target already has a draggable on it - // (with an ID different from the one we are checking - // against), then go to next target. - if ( - (this.state.config.onePerTarget === true) - && (target.draggableList.length === 1) - && (target.draggableList[0].uniqueId !== this.uniqueId) - ) { - // eslint-disable-next-line no-continue - continue; - } - - // If the target is on a draggable (from target field), we must make sure that - // this draggable is not the same as "this" one. - if ((target.type === 'on_drag') && (target.draggableObj.uniqueId === this.uniqueId)) { - // eslint-disable-next-line no-continue - continue; - } - - // Check if the draggable's center coordinate is within - // the target's dimensions. If not, go to next target. - if ( - (positionIE.top + this.iconHeight * 0.5 < target.offset.top) - || (positionIE.top + this.iconHeight * 0.5 > target.offset.top + target.h) - || (positionIE.left + this.iconWidth * 0.5 < target.offset.left) - || (positionIE.left + this.iconWidth * 0.5 > target.offset.left + target.w) - ) { - // eslint-disable-next-line no-continue - continue; - } - - // If the draggable was moved from one target to - // another, then we need to remove it from the - // previous target's draggables list, and add it to the - // new target's draggables list. - if ((this.onTarget !== null) && (this.onTarget.uniqueId !== target.uniqueId)) { - this.onTarget.removeDraggable(this); - target.addDraggable(this); - // eslint-disable-next-line brace-style - } - // If the draggable was moved from the slider to a - // target, remember the target, and add ID to the - // target's draggables list. - else if (this.onTarget === null) { - target.addDraggable(this); - } - - // Reposition the draggable so that it's center - // coincides with the center of the target. - this.snapToTarget(target); - - // Target was found. - return true; - } - - // Target was not found. - return false; - }, - - toggleTargets: function(isEnabled) { - var effect = isEnabled ? 'move' : null; - - this.state.baseImageEl.attr('aria-dropeffect', effect); - $.each(this.state.targets, function(index, target) { - target.targetEl.attr('aria-dropeffect', effect); - }); - }, - - snapToTarget: function(target) { - var offset; - - offset = 0; - if (this.state.config.targetOutline === true) { - offset = 1; - } - - this.iconEl.css({ - left: target.offset.left + 0.5 * target.w - this.iconWidth * 0.5 + offset - this.iconElLeftOffset, - top: target.offset.top + 0.5 * target.h - this.iconHeight * 0.5 + offset - }); - - if (this.labelEl !== null) { - this.labelEl.css({ - left: target.offset.left + 0.5 * target.w - this.labelWidth * 0.5 + offset - 9, // Acoount for padding, border. - top: target.offset.top + 0.5 * target.h + this.iconHeight * 0.5 + 5 + offset - }); - } - }, - - // Go through all of the draggables subtract 1 from the z-index - // of all whose z-index is higher than the old z-index of the - // current element. After, set the z-index of the current - // element to 1 + N (where N is the number of draggables - i.e. - // the highest z-index possible). - // - // This will make sure that after releasing a draggable, it - // will be on top of all of the other draggables. Also, the - // ordering of the visibility (z-index) of the other draggables - // will not change. - correctZIndexes: function() { - var c1, highestZIndex; - - highestZIndex = -10000; - - if (this.state.config.individualTargets === true) { - if (this.onTarget.draggableList.length > 0) { - for (c1 = 0; c1 < this.onTarget.draggableList.length; c1 += 1) { - if ( - (this.onTarget.draggableList[c1].zIndex > highestZIndex) - && (this.onTarget.draggableList[c1].zIndex !== 1000) - ) { - highestZIndex = this.onTarget.draggableList[c1].zIndex; - } - } - } else { - highestZIndex = 0; - } - } else { - for (c1 = 0; c1 < this.state.draggables.length; c1++) { - if (this.inContainer === false) { - if ( - (this.state.draggables[c1].zIndex > highestZIndex) - && (this.state.draggables[c1].zIndex !== 1000) - ) { - highestZIndex = this.state.draggables[c1].zIndex; - } - } - } - } - - if (highestZIndex === -10000) { - highestZIndex = 0; - } - - this.zIndex = highestZIndex + 1; - - this.iconEl.css('z-index', this.zIndex); - if (this.labelEl !== null) { - this.labelEl.css('z-index', this.zIndex); - } - }, - - // If a draggable was released in a wrong positione, we will - // move it back to the slider, placing it in the same position - // that it was dragged out of. - moveBackToSlider: function() { - var c1; - - Targets.destroyTargetField(this); - - if (this.isOriginal === false) { - this.iconEl.remove(); - if (this.labelEl !== null) { - this.labelEl.remove(); - } - - this.state.draggables.splice(this.stateDraggablesIndex, 1); - - for (c1 = 0; c1 < this.state.draggables.length; c1 += 1) { - if (this.state.draggables[c1].stateDraggablesIndex > this.stateDraggablesIndex) { - this.state.draggables[c1].stateDraggablesIndex -= 1; - } - } - - return; - } - - this.containerEl.show(); - this.zIndex = 1; - - this.iconEl.detach(); - if (this.iconImgEl !== null) { - this.iconImgEl.css({ - width: this.iconWidthSmall, - height: this.iconHeightSmall - }); - } - this.iconEl.css({ - border: 'none', - 'background-color': 'transparent', - 'padding-left': 0, - 'padding-right': 0, - 'z-index': this.zIndex, - width: this.iconWidthSmall, - height: this.iconHeightSmall, - left: 50 - this.iconWidthSmall * 0.5, - - // Before: - // 'top': ((this.labelEl !== null) ? (100 - this.iconHeightSmall - 25) * 0.5 : 50 - this.iconHeightSmall * 0.5) - // After: - top: ((this.labelEl !== null) ? 37.5 : 50.0) - 0.5 * this.iconHeightSmall - }); - this.iconEl.appendTo(this.containerEl); - - if (this.labelEl !== null) { - this.labelEl.detach(); - this.labelEl.css({ - border: 'none', - 'background-color': 'transparent', - 'padding-left': 0, - 'padding-right': 0, - 'z-index': this.zIndex, - left: 50 - this.labelWidth * 0.5, - - // Before: - // 'top': (100 - this.iconHeightSmall - 25) * 0.5 + this.iconHeightSmall + 5 - // After: - top: 42.5 + 0.5 * this.iconHeightSmall - }); - this.labelEl.appendTo(this.containerEl); - } - - this.inContainer = true; - } - }; // End-of: return { - }); // End-of: define(['update_input', 'targets'], function (updateInput, Targets) { -}(RequireJS.requirejs, RequireJS.require, RequireJS.define)); // End-of: (function (requirejs, require, define) { diff --git a/common/static/js/capa/drag_and_drop/draggables.js b/common/static/js/capa/drag_and_drop/draggables.js deleted file mode 100644 index 13e26c28de49..000000000000 --- a/common/static/js/capa/drag_and_drop/draggables.js +++ /dev/null @@ -1,281 +0,0 @@ -(function(requirejs, require, define) { - define(['js/capa/drag_and_drop/draggable_events', 'js/capa/drag_and_drop/draggable_logic', - 'edx-ui-toolkit/js/utils/html-utils'], - function(draggableEvents, draggableLogic, HtmlUtils) { - return { - init: init - }; - - function init(state) { - state.config.draggables.every(function(draggable) { - processDraggable(state, draggable); - - return true; - }); - } - - function makeDraggableCopy(callbackFunc) { - var draggableObj, property; - - // Make a full proper copy of the draggable object, with some modifications. - draggableObj = {}; - for (property in this) { - if (this.hasOwnProperty(property) === true) { - draggableObj[property] = this[property]; - } - } - // The modifications to the draggable copy. - draggableObj.isOriginal = false; // This new draggable is a copy. - draggableObj.uniqueId = draggableObj.state.getUniqueId(); // Is newly set. - draggableObj.stateDraggablesIndex = null; // Will be set. - draggableObj.containerEl = null; // Not needed, since a copy will never return to a container element. - draggableObj.iconEl = null; // Will be created. - draggableObj.iconImgEl = null; // Will be created. - draggableObj.labelEl = null; // Will be created. - draggableObj.targetField = []; // Will be populated. - - // Create DOM elements and attach events. - if (draggableObj.originalConfigObj.icon.length > 0) { - draggableObj.iconEl = $('
          '); - draggableObj.iconImgEl = $(''); - draggableObj.iconImgEl.attr('src', draggableObj.originalConfigObj.icon); - draggableObj.iconImgEl.load(function() { - draggableObj.iconEl.css({ - position: 'absolute', - width: draggableObj.iconWidthSmall, - height: draggableObj.iconHeightSmall, - left: 50 - draggableObj.iconWidthSmall * 0.5, - top: ((draggableObj.originalConfigObj.label.length > 0) ? 5 : 50 - draggableObj.iconHeightSmall * 0.5) - }); - draggableObj.iconImgEl.css({ - position: 'absolute', - width: draggableObj.iconWidthSmall, - height: draggableObj.iconHeightSmall, - left: 0, - top: 0 - }); - draggableObj.iconImgEl.appendTo(draggableObj.iconEl); - - if (draggableObj.originalConfigObj.label.length > 0) { - draggableObj.labelEl = $(HtmlUtils.joinHtml( - HtmlUtils.HTML( - '
          ' - ), - draggableObj.originalConfigObj.label, - HtmlUtils.HTML('
          ') - ).toString()); - draggableObj.labelEl.css({ - left: 50 - draggableObj.labelWidth * 0.5, - top: 5 + draggableObj.iconHeightSmall + 5 - }); - - draggableObj.attachMouseEventsTo('labelEl'); - } - - draggableObj.attachMouseEventsTo('iconEl'); - - draggableObj.stateDraggablesIndex = draggableObj.state.draggables.push(draggableObj) - 1; - - setTimeout(function() { - callbackFunc(draggableObj); - }, 0); - }); - } else { - if (draggableObj.originalConfigObj.label.length > 0) { - draggableObj.iconEl = $(HtmlUtils.joinHtml( - HtmlUtils.HTML('
          '), - draggableObj.originalConfigObj.label, - HtmlUtils.HTML('
          ') - ).toString()); - draggableObj.iconEl.css({ - left: 50 - draggableObj.iconWidthSmall * 0.5, - top: 50 - draggableObj.iconHeightSmall * 0.5 - }); - - draggableObj.attachMouseEventsTo('iconEl'); - - draggableObj.stateDraggablesIndex = draggableObj.state.draggables.push(draggableObj) - 1; - - setTimeout(function() { - callbackFunc(draggableObj); - }, 0); - } - } - } - - function processDraggable(state, obj) { - var draggableObj; - - draggableObj = { - uniqueId: state.getUniqueId(), - originalConfigObj: obj, - stateDraggablesIndex: null, - id: obj.id, - isReusable: obj.can_reuse, - isOriginal: true, - x: -1, - y: -1, - zIndex: 1, - containerEl: null, - iconEl: null, - iconImgEl: null, - iconElBGColor: null, - iconElPadding: null, - iconElBorder: null, - iconElLeftOffset: null, - iconWidth: null, - iconHeight: null, - iconWidthSmall: null, - iconHeightSmall: null, - labelEl: null, - labelWidth: null, - hasLoaded: false, - inContainer: true, - mousePressed: false, - onTarget: null, - onTargetIndex: null, - state: state, - - mouseDown: draggableEvents.mouseDown, - mouseUp: draggableEvents.mouseUp, - mouseMove: draggableEvents.mouseMove, - - checkLandingElement: draggableLogic.checkLandingElement, - checkIfOnTarget: draggableLogic.checkIfOnTarget, - snapToTarget: draggableLogic.snapToTarget, - correctZIndexes: draggableLogic.correctZIndexes, - moveBackToSlider: draggableLogic.moveBackToSlider, - moveDraggableTo: draggableLogic.moveDraggableTo, - toggleTargets: draggableLogic.toggleTargets, - - makeDraggableCopy: makeDraggableCopy, - - attachMouseEventsTo: draggableEvents.attachMouseEventsTo, - - targetField: [], - numDraggablesOnMe: 0 - }; - - draggableObj.containerEl = $(HtmlUtils.joinHtml( - HtmlUtils.HTML('
          ') - ).toString()); - - draggableObj.containerEl.appendTo(state.sliderEl); - - if (obj.icon.length > 0) { - draggableObj.iconElBGColor = 'transparent'; - draggableObj.iconElPadding = 0; - draggableObj.iconElBorder = 'none'; - draggableObj.iconElLeftOffset = 0; - - draggableObj.iconEl = $('
          '); - - draggableObj.iconImgEl = $(''); - draggableObj.iconImgEl.attr('src', obj.icon); - draggableObj.iconImgEl.load(function() { - draggableObj.iconWidth = this.width; - draggableObj.iconHeight = this.height; - - if (draggableObj.iconWidth >= draggableObj.iconHeight) { - draggableObj.iconWidthSmall = 60; - draggableObj.iconHeightSmall = draggableObj.iconWidthSmall * (draggableObj.iconHeight / draggableObj.iconWidth); - } else { - draggableObj.iconHeightSmall = 60; - draggableObj.iconWidthSmall = draggableObj.iconHeightSmall * (draggableObj.iconWidth / draggableObj.iconHeight); - } - - draggableObj.iconEl.css({ - position: 'absolute', - width: draggableObj.iconWidthSmall, - height: draggableObj.iconHeightSmall, - left: 50 - draggableObj.iconWidthSmall * 0.5, - - // Before: - // 'top': ((obj.label.length > 0) ? (100 - draggableObj.iconHeightSmall - 25) * 0.5 : 50 - draggableObj.iconHeightSmall * 0.5) - // After: - top: ((obj.label.length > 0) ? 37.5 : 50.0) - 0.5 * draggableObj.iconHeightSmall - }); - draggableObj.iconImgEl.css({ - position: 'absolute', - width: draggableObj.iconWidthSmall, - height: draggableObj.iconHeightSmall, - left: 0, - top: 0 - }); - draggableObj.iconImgEl.appendTo(draggableObj.iconEl); - draggableObj.iconEl.appendTo(draggableObj.containerEl); - - if (obj.label.length > 0) { - draggableObj.labelEl = $(HtmlUtils.joinHtml( - HtmlUtils.HTML( - '
          ' - ), - obj.label, - HtmlUtils.HTML('
          ') - ).toString()); - - draggableObj.labelEl.appendTo(draggableObj.containerEl); - draggableObj.labelWidth = draggableObj.labelEl.width(); - draggableObj.labelEl.css({ - left: 50 - draggableObj.labelWidth * 0.5, - - // Before: - // 'top': (100 - this.iconHeightSmall - 25) * 0.5 + this.iconHeightSmall + 5 - // After: - top: 42.5 + 0.5 * draggableObj.iconHeightSmall - }); - - draggableObj.attachMouseEventsTo('labelEl'); - } - - draggableObj.hasLoaded = true; - }); - } else { - // To make life easier, if there is no icon, but there is a - // label, we will create a label and store it as if it was an - // icon. All the existing code will work, and the user will - // see a label instead of an icon. - if (obj.label.length > 0) { - draggableObj.iconElBGColor = state.config.labelBgColor; - draggableObj.iconElPadding = 8; - draggableObj.iconElBorder = '1px solid black'; - draggableObj.iconElLeftOffset = 9; - - draggableObj.iconEl = $(HtmlUtils.joinHtml( - HtmlUtils.HTML( - '
          '), - obj.label, - HtmlUtils.HTML('
          ') - ).toString()); - - draggableObj.iconEl.appendTo(draggableObj.containerEl); - - draggableObj.iconWidth = draggableObj.iconEl.width() + 1; - draggableObj.iconHeight = draggableObj.iconEl.height(); - draggableObj.iconWidthSmall = draggableObj.iconWidth; - draggableObj.iconHeightSmall = draggableObj.iconHeight; - - draggableObj.iconEl.css({ - left: 50 - draggableObj.iconWidthSmall * 0.5, - top: 50 - draggableObj.iconHeightSmall * 0.5 - }); - - draggableObj.hasLoaded = true; - } else { - // If no icon and no label, don't create a draggable. - return; - } - } - - draggableObj.attachMouseEventsTo('iconEl'); - draggableObj.attachMouseEventsTo('containerEl'); - - state.numDraggablesInSlider += 1; - draggableObj.stateDraggablesIndex = state.draggables.push(draggableObj) - 1; - } - }); // End-of: define(['draggable_events', 'draggable_logic'], function (draggableEvents, draggableLogic) { -}(RequireJS.requirejs, RequireJS.require, RequireJS.define)); // End-of: (function (requirejs, require, define) { diff --git a/common/static/js/capa/drag_and_drop/main.js b/common/static/js/capa/drag_and_drop/main.js deleted file mode 100644 index 3cd15971bfd6..000000000000 --- a/common/static/js/capa/drag_and_drop/main.js +++ /dev/null @@ -1,107 +0,0 @@ -(function(requirejs, require, define) { - define( - ['js/capa/drag_and_drop/state', - 'js/capa/drag_and_drop/config_parser', 'js/capa/drag_and_drop/container', - 'js/capa/drag_and_drop/base_image', 'js/capa/drag_and_drop/scroller', - 'js/capa/drag_and_drop/draggables', 'js/capa/drag_and_drop/targets', - 'js/capa/drag_and_drop/update_input'], - function(State, configParser, Container, BaseImage, Scroller, Draggables, Targets, updateInput) { - return Main; - - function Main() { - // https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Array/every - // - // Array.prototype.every is a recent addition to the ECMA-262 standard; as such it may not be present in - // other implementations of the standard. - if (!Array.prototype.every) { - // eslint-disable-next-line no-extend-native - Array.prototype.every = function(fun /* , thisp */) { - var thisp, t, len, i; - - if (this == null) { - throw new TypeError(); - } - - t = Object(this); - // eslint-disable-next-line no-bitwise - len = t.length >>> 0; - if (typeof fun !== 'function') { - throw new TypeError(); - } - - thisp = arguments[1]; - - for (i = 0; i < len; i++) { - if (i in t && !fun.call(thisp, t[i], i, t)) { - return false; - } - } - - return true; - }; - } - - $('.drag_and_drop_problem_div').each(processProblem); - } - - // $(value) - get the element of the entire problem - function processProblem(index, value) { - var problemId, config, state; - - if ($(value).attr('data-problem-processed') === 'true') { - // This problem was already processed by us before, so we will - // skip it. - - return; - } - $(value).attr('data-problem-processed', 'true'); - - problemId = $(value).attr('data-plain-id'); - if (typeof problemId !== 'string') { - console.log('ERROR: Could not find the ID of the problem DOM element.'); - - return; - } - - try { - config = JSON.parse($('#drag_and_drop_json_' + problemId).html()); - } catch (err) { - console.log('ERROR: Could not parse the JSON configuration options.'); - console.log('Error message: "' + err.message + '".'); - - return; - } - - state = State(problemId); - - if (configParser(state, config) !== true) { - console.log('ERROR: Could not make sense of the JSON configuration options.'); - - return; - } - - Container(state); - BaseImage(state); - - (function addContent() { - if (state.baseImageLoaded !== true) { - setTimeout(addContent, 50); - - return; - } - - Targets.initializeBaseTargets(state); - Scroller(state); - Draggables.init(state); - - state.updateArrowOpacity(); - - // Update the input element, checking first that it is not filled with - // an answer from the server. - if (updateInput.check(state) === false) { - updateInput.update(state); - } - }()); - } - }); // End-of: define( -}(RequireJS.requirejs, RequireJS.require, RequireJS.define)); // End-of: (function (requirejs, require, define) { diff --git a/common/static/js/capa/drag_and_drop/scroller.js b/common/static/js/capa/drag_and_drop/scroller.js deleted file mode 100644 index eb6646141d3d..000000000000 --- a/common/static/js/capa/drag_and_drop/scroller.js +++ /dev/null @@ -1,162 +0,0 @@ -(function(requirejs, require, define) { - define(['edx-ui-toolkit/js/utils/html-utils'], function(HtmlUtils) { - return Scroller; - - function Scroller(state) { - var $parentEl, $moveLeftEl, $showEl, $moveRightEl, showElLeftMargin; - - $parentEl = $(HtmlUtils.HTML( - '
          ' - ).toString()); - - $moveLeftEl = $(HtmlUtils.joinHtml( - HtmlUtils.HTML('
          '), - HtmlUtils.HTML('
          '), - HtmlUtils.HTML('
          '), - HtmlUtils.HTML('
          ') - ).toString()); - $moveLeftEl.appendTo($parentEl); - - // The below is necessary to prevent the browser thinking that we want - // to perform a drag operation, or a highlight operation. If we don't - // do this, the browser will then highlight with a gray shade the - // element. - $moveLeftEl.mousemove(function(event) { event.preventDefault(); }); - $moveLeftEl.mousedown(function(event) { event.preventDefault(); }); - - // This event will be responsible for moving the scroller left. - // Hidden draggables will be shown. - $moveLeftEl.mouseup(function(event) { - event.preventDefault(); - - // When there are no more hidden draggables, prevent from - // scrolling infinitely. - if (showElLeftMargin > -102) { - return; - } - - showElLeftMargin += 102; - - // We scroll by changing the 'margin-left' CSS property smoothly. - state.sliderEl.animate({ - 'margin-left': showElLeftMargin + 'px' - }, 100, function() { - updateArrowOpacity(); - }); - }); - - $showEl = $(HtmlUtils.HTML( - '
          ' - ).toString()); - $showEl.appendTo($parentEl); - - showElLeftMargin = 0; - - // Element where the draggables will be contained. It is very long - // so that any SANE number of draggables will fit in a single row. It - // will be contained in a parent element whose 'overflow' CSS value - // will be hidden, preventing the long row from fully being visible. - // eslint-disable-next-line no-param-reassign - state.sliderEl = $(HtmlUtils.joinHtml( - HtmlUtils.HTML('
          ') - ).toString()); - state.sliderEl.appendTo($showEl); - - state.sliderEl.mousedown(function(event) { - event.preventDefault(); - }); - - $moveRightEl = $(HtmlUtils.joinHtml( - HtmlUtils.HTML('
          '), - HtmlUtils.HTML('
          '), - HtmlUtils.HTML('
          '), - HtmlUtils.HTML('
          ') - ).toString()); - $moveRightEl.appendTo($parentEl); - - // The below is necessary to prevent the browser thinking that we want - // to perform a drag operation, or a highlight operation. If we don't - // do this, the browser will then highlight with a gray shade the - // element. - $moveRightEl.mousemove(function(event) { event.preventDefault(); }); - $moveRightEl.mousedown(function(event) { event.preventDefault(); }); - - // This event will be responsible for moving the scroller right. - // Hidden draggables will be shown. - $moveRightEl.mouseup(function(event) { - event.preventDefault(); - - // When there are no more hidden draggables, prevent from - // scrolling infinitely. - if (showElLeftMargin < -102 * (state.numDraggablesInSlider - 6)) { - return; - } - - showElLeftMargin -= 102; - - // We scroll by changing the 'margin-left' CSS property smoothly. - state.sliderEl.animate({ - 'margin-left': showElLeftMargin + 'px' - }, 100, function() { - updateArrowOpacity(); - }); - }); - - $parentEl.appendTo(state.containerEl); - - // Make the function available throughout the application. We need to - // call it in several places: - // - // 1.) When initially reading answer from server, if draggables will be - // positioned on the base image, the scroller's right and left arrows - // opacity must be updated. - // - // 2.) When creating draggable elements, the scroller's right and left - // arrows opacity must be updated according to the number of - // draggables. - state.updateArrowOpacity = updateArrowOpacity; - - // eslint-disable-next-line no-useless-return - return; - - function updateArrowOpacity() { - $moveLeftEl.children('div').css('opacity', '1'); - $moveRightEl.children('div').css('opacity', '1'); - - if (showElLeftMargin < -102 * (state.numDraggablesInSlider - 6)) { - $moveRightEl.children('div').css('opacity', '.4'); - } - if (showElLeftMargin > -102) { - $moveLeftEl.children('div').css('opacity', '.4'); - } - } - } // End-of: function Scroller(state) - }); // End-of: define([], function () { -}(RequireJS.requirejs, RequireJS.require, RequireJS.define)); // End-of: (function (requirejs, require, define) { diff --git a/common/static/js/capa/drag_and_drop/state.js b/common/static/js/capa/drag_and_drop/state.js deleted file mode 100644 index 6ea9d5b62374..000000000000 --- a/common/static/js/capa/drag_and_drop/state.js +++ /dev/null @@ -1,95 +0,0 @@ -(function(requirejs, require, define) { - define([], function() { - return State; - - function State(problemId) { - var state; - - state = { - config: null, - - baseImageEl: null, - baseImageLoaded: false, - - containerEl: null, - - sliderEl: null, - - problemId: problemId, - - draggables: [], - numDraggablesInSlider: 0, - currentMovingDraggable: null, - - targets: [], - - updateArrowOpacity: null, - - uniqueId: 0, - salt: makeSalt(), - - getUniqueId: getUniqueId - }; - - $(document).mousemove(function(event) { - documentMouseMove(state, event); - }); - - return state; - } - - function getUniqueId() { - this.uniqueId += 1; - - return this.salt + '_' + this.uniqueId.toFixed(0); - } - - function makeSalt() { - var text, possible, i; - - text = ''; - possible = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789'; - - for (i = 0; i < 5; i += 1) { - text += possible.charAt(Math.floor(Math.random() * possible.length)); - } - - return text; - } - - function documentMouseMove(state, event) { - if (state.currentMovingDraggable !== null) { - state.currentMovingDraggable.iconEl.css( - 'left', - event.pageX - - state.baseImageEl.offset().left - - state.currentMovingDraggable.iconWidth * 0.5 - - state.currentMovingDraggable.iconElLeftOffset - ); - state.currentMovingDraggable.iconEl.css( - 'top', - event.pageY - - state.baseImageEl.offset().top - - state.currentMovingDraggable.iconHeight * 0.5 - ); - - if (state.currentMovingDraggable.labelEl !== null) { - state.currentMovingDraggable.labelEl.css( - 'left', - event.pageX - - state.baseImageEl.offset().left - - state.currentMovingDraggable.labelWidth * 0.5 - - 9 // Account for padding, border. - ); - state.currentMovingDraggable.labelEl.css( - 'top', - event.pageY - - state.baseImageEl.offset().top - + state.currentMovingDraggable.iconHeight * 0.5 - + 5 - ); - } - } - } - }); // End-of: define([], function () { -}(RequireJS.requirejs, RequireJS.require, RequireJS.define)); // End-of: (function (requirejs, require, define) { diff --git a/common/static/js/capa/drag_and_drop/targets.js b/common/static/js/capa/drag_and_drop/targets.js deleted file mode 100644 index 553053fbc063..000000000000 --- a/common/static/js/capa/drag_and_drop/targets.js +++ /dev/null @@ -1,266 +0,0 @@ -(function(requirejs, require, define) { - define(['edx-ui-toolkit/js/utils/html-utils'], function(HtmlUtils) { - return { - initializeBaseTargets: initializeBaseTargets, - initializeTargetField: initializeTargetField, - destroyTargetField: destroyTargetField - }; - - function initializeBaseTargets(state) { - (function(c1) { - while (c1 < state.config.targets.length) { - processTarget(state, state.config.targets[c1]); - - c1 += 1; - } - }(0)); - } - - function initializeTargetField(draggableObj) { - var iconElOffset; - - if (draggableObj.targetField.length === 0) { - draggableObj.originalConfigObj.target_fields.every(function(targetObj) { - processTarget(draggableObj.state, targetObj, true, draggableObj); - - return true; - }); - } else { - iconElOffset = draggableObj.iconEl.position(); - - draggableObj.targetField.every(function(targetObj) { - targetObj.offset.top = iconElOffset.top + targetObj.y; - targetObj.offset.left = iconElOffset.left + targetObj.x; - - return true; - }); - } - } - - function destroyTargetField(draggableObj) { - var indexOffset, lowestRemovedIndex; - - indexOffset = 0; - lowestRemovedIndex = draggableObj.state.targets.length + 1; - - draggableObj.targetField.every(function(target) { - target.el.remove(); - - if (lowestRemovedIndex > target.indexInStateArray) { - lowestRemovedIndex = target.indexInStateArray; - } - - draggableObj.state.targets.splice(target.indexInStateArray - indexOffset, 1); - indexOffset += 1; - - return true; - }); - - draggableObj.state.targets.every(function(target) { - if (target.indexInStateArray > lowestRemovedIndex) { - target.indexInStateArray -= indexOffset; - } - - return true; - }); - - draggableObj.targetField = []; - } - - function processTarget(state, obj, fromTargetField, draggableObj) { - var $targetEl, borderCss, $numTextEl, targetObj; - - borderCss = ''; - if (state.config.targetOutline === true) { - borderCss = 'border: 1px dashed gray; '; - } - - $targetEl = $( - HtmlUtils.joinHtml( - HtmlUtils.HTML('
          ') - ).toString() - ); - if (fromTargetField === true) { - $targetEl.appendTo(draggableObj.iconEl); - } else { - $targetEl.appendTo(state.baseImageEl.parent()); - } - - $targetEl.mousedown(function(event) { - event.preventDefault(); - }); - - if (state.config.onePerTarget === false) { - $numTextEl = $( - HtmlUtils.joinHtml( - HtmlUtils.HTML('
          0
          ') - ).toString() - ); - } else { - $numTextEl = null; - } - - targetObj = { - uniqueId: state.getUniqueId(), - - id: obj.id, - - x: obj.x, - y: obj.y, - - w: obj.w, - h: obj.h, - - el: $targetEl, - offset: $targetEl.position(), - - draggableList: [], - - state: state, - - targetEl: $targetEl, - - numTextEl: $numTextEl, - updateNumTextEl: updateNumTextEl, - - removeDraggable: removeDraggable, - addDraggable: addDraggable, - - type: 'base', - draggableObj: null - }; - - if (fromTargetField === true) { - targetObj.offset = draggableObj.iconEl.position(); - targetObj.offset.top += obj.y; - targetObj.offset.left += obj.x; - - targetObj.type = 'on_drag'; - targetObj.draggableObj = draggableObj; - } - - if (state.config.onePerTarget === false) { - $numTextEl.appendTo(state.baseImageEl.parent()); - $numTextEl.mousedown(function(event) { - event.preventDefault(); - }); - $numTextEl.mouseup(function() { - cycleDraggableOrder.call(targetObj); - }); - } - - targetObj.indexInStateArray = state.targets.push(targetObj) - 1; - - if (fromTargetField === true) { - draggableObj.targetField.push(targetObj); - } - } - - function removeDraggable(draggable) { - var c1; - - this.draggableList.splice(draggable.onTargetIndex, 1); - - // An item from the array was removed. We need to updated all indexes accordingly. - // Shift all indexes down by one if they are higher than the index of the removed item. - c1 = 0; - while (c1 < this.draggableList.length) { - if (this.draggableList[c1].onTargetIndex > draggable.onTargetIndex) { - this.draggableList[c1].onTargetIndex -= 1; - } - - c1 += 1; - } - - draggable.onTarget = null; - draggable.onTargetIndex = null; - - if (this.type === 'on_drag') { - this.draggableObj.numDraggablesOnMe -= 1; - } - - this.updateNumTextEl(); - } - - function addDraggable(draggable) { - draggable.onTarget = this; - draggable.onTargetIndex = this.draggableList.push(draggable) - 1; - - if (this.type === 'on_drag') { - this.draggableObj.numDraggablesOnMe += 1; - } - - this.updateNumTextEl(); - } - - /* - * function cycleDraggableOrder - * - * Parameters: - * none - This function does not expect any parameters. - * - * Returns: - * undefined - The return value of this function is not used. - * - * Description: - * Go through all draggables that are on the current target, and decrease their - * z-index by 1, making sure that the bottom-most draggable ends up on the top. - */ - function cycleDraggableOrder() { - var c1, lowestZIndex, highestZIndex; - - if (this.draggableList.length < 2) { - return; - } - - highestZIndex = -10000; - lowestZIndex = 10000; - - for (c1 = 0; c1 < this.draggableList.length; c1 += 1) { - if (this.draggableList[c1].zIndex < lowestZIndex) { - lowestZIndex = this.draggableList[c1].zIndex; - } - - if (this.draggableList[c1].zIndex > highestZIndex) { - highestZIndex = this.draggableList[c1].zIndex; - } - } - - for (c1 = 0; c1 < this.draggableList.length; c1 += 1) { - if (this.draggableList[c1].zIndex === lowestZIndex) { - this.draggableList[c1].zIndex = highestZIndex; - } else { - this.draggableList[c1].zIndex -= 1; - } - - this.draggableList[c1].iconEl.css('z-index', this.draggableList[c1].zIndex); - if (this.draggableList[c1].labelEl !== null) { - this.draggableList[c1].labelEl.css('z-index', this.draggableList[c1].zIndex); - } - } - } - - function updateNumTextEl() { - if (this.numTextEl !== null) { - this.numTextEl.text(this.draggableList.length); - } - } - }); // End-of: define([], function () { -}(RequireJS.requirejs, RequireJS.require, RequireJS.define)); // End-of: (function (requirejs, require, define) { diff --git a/common/static/js/capa/drag_and_drop/update_input.js b/common/static/js/capa/drag_and_drop/update_input.js deleted file mode 100644 index c7769c4891ec..000000000000 --- a/common/static/js/capa/drag_and_drop/update_input.js +++ /dev/null @@ -1,373 +0,0 @@ -(function(requirejs, require, define) { - define([], function() { - return { - check: check, - update: update - }; - - function update(state) { - var draggables, tempObj; - - draggables = []; - - if (state.config.individualTargets === false) { - (function(c1) { - while (c1 < state.draggables.length) { - if (state.draggables[c1].x !== -1) { - tempObj = {}; - tempObj[state.draggables[c1].id] = [ - state.draggables[c1].x, - state.draggables[c1].y - ]; - draggables.push(tempObj); - tempObj = null; - } - - c1 += 1; - } - }(0)); - } else { - (function(c1) { - while (c1 < state.targets.length) { - // eslint-disable-next-line no-loop-func - (function(c2) { - while (c2 < state.targets[c1].draggableList.length) { - tempObj = {}; - - if (state.targets[c1].type === 'base') { - tempObj[state.targets[c1].draggableList[c2].id] = state.targets[c1].id; - } else { - addTargetRecursively(tempObj, state.targets[c1].draggableList[c2], state.targets[c1]); - } - draggables.push(tempObj); - tempObj = null; - - c2 += 1; - } - }(0)); - - c1 += 1; - } - }(0)); - } - - $('#input_' + state.problemId).val(JSON.stringify(draggables)); - } - - function addTargetRecursively(tempObj, draggable, target) { - if (target.type === 'base') { - tempObj[draggable.id] = target.id; - } else { - tempObj[draggable.id] = {}; - tempObj[draggable.id][target.id] = {}; - - addTargetRecursively(tempObj[draggable.id][target.id], target.draggableObj, target.draggableObj.onTarget); - } - } - - // Check if input has an answer from server. If yes, then position - // all draggables according to answer. - function check(state) { - var inputElVal; - - inputElVal = $('#input_' + state.problemId).val(); - - if (inputElVal.length === 0) { - return false; - } - - repositionDraggables(state, JSON.parse(inputElVal)); - - return true; - } - - function processAnswerTargets(state, answerSortedByDepth, minDepth, maxDepth, depth, i) { - var baseDraggableId, baseDraggable, baseTargetId, baseTarget, - layeredDraggableId, layeredDraggable, layeredTargetId, layeredTarget, - chain; - - if (depth === 0) { - // We are at the lowest depth? The end. - - return; - } - - if (answerSortedByDepth.hasOwnProperty(depth) === false) { - // We have a depth that ts not valid, we decrease the depth by one. - processAnswerTargets(state, answerSortedByDepth, minDepth, maxDepth, depth - 1, 0); - - return; - } - - if (answerSortedByDepth[depth].length <= i) { - // We ran out of answers at this depth, go to the next depth down. - processAnswerTargets(state, answerSortedByDepth, minDepth, maxDepth, depth - 1, 0); - - return; - } - - chain = answerSortedByDepth[depth][i]; - - baseDraggableId = Object.keys(chain)[0]; - - // This is a hack. For now we will work with depths 1 and 3. - if (depth === 1) { - baseTargetId = chain[baseDraggableId]; - - layeredTargetId = null; - layeredDraggableId = null; - - // createBaseDraggableOnTarget(state, baseDraggableId, baseTargetId); - } else if (depth === 3) { - layeredDraggableId = baseDraggableId; - - layeredTargetId = Object.keys(chain[layeredDraggableId])[0]; - - baseDraggableId = Object.keys(chain[layeredDraggableId][layeredTargetId])[0]; - - baseTargetId = chain[layeredDraggableId][layeredTargetId][baseDraggableId]; - } - - checkBaseDraggable(); - - // eslint-disable-next-line no-useless-return - return; - - function checkBaseDraggable() { - // eslint-disable-next-line no-cond-assign - if ((baseDraggable = getById(state, 'draggables', baseDraggableId, null, false, baseTargetId)) === null) { - createBaseDraggableOnTarget(state, baseDraggableId, baseTargetId, true, function() { - // eslint-disable-next-line no-cond-assign - if ((baseDraggable = getById(state, 'draggables', baseDraggableId, null, false, baseTargetId)) === null) { - console.log('ERROR: Could not successfully create a base draggable on a base target.'); - } else { - baseTarget = baseDraggable.onTarget; - - if ((layeredTargetId === null) || (layeredDraggableId === null)) { - processAnswerTargets(state, answerSortedByDepth, minDepth, maxDepth, depth, i + 1); - } else { - checklayeredDraggable(); - } - } - }); - } else { - baseTarget = baseDraggable.onTarget; - - if ((layeredTargetId === null) || (layeredDraggableId === null)) { - processAnswerTargets(state, answerSortedByDepth, minDepth, maxDepth, depth, i + 1); - } else { - checklayeredDraggable(); - } - } - } - - function checklayeredDraggable() { - // eslint-disable-next-line no-cond-assign - if ((layeredDraggable = getById(state, 'draggables', layeredDraggableId, null, false, layeredTargetId, baseDraggableId, baseTargetId)) === null) { - layeredDraggable = getById(state, 'draggables', layeredDraggableId); - layeredTarget = null; - baseDraggable.targetField.every(function(target) { - if (target.id === layeredTargetId) { - layeredTarget = target; - } - - return true; - }); - - if ((layeredDraggable !== null) && (layeredTarget !== null)) { - layeredDraggable.moveDraggableTo('target', layeredTarget, function() { - processAnswerTargets(state, answerSortedByDepth, minDepth, maxDepth, depth, i + 1); - }); - } else { - processAnswerTargets(state, answerSortedByDepth, minDepth, maxDepth, depth, i + 1); - } - } else { - processAnswerTargets(state, answerSortedByDepth, minDepth, maxDepth, depth, i + 1); - } - } - } - - function createBaseDraggableOnTarget(state, draggableId, targetId, reportError, funcCallback) { - var draggable, target; - - // eslint-disable-next-line no-cond-assign - if ((draggable = getById(state, 'draggables', draggableId)) === null) { - if (reportError !== false) { - console.log( - 'ERROR: In answer there exists a ' - + 'draggable ID "' + draggableId + '". No ' - + 'draggable with this ID could be found.' - ); - } - - return false; - } - - // eslint-disable-next-line no-cond-assign - if ((target = getById(state, 'targets', targetId)) === null) { - if (reportError !== false) { - console.log( - 'ERROR: In answer there exists a target ' - + 'ID "' + targetId + '". No target with this ' - + 'ID could be found.' - ); - } - - return false; - } - - draggable.moveDraggableTo('target', target, funcCallback); - - return true; - } - - function processAnswerPositions(state, answer) { - var draggableId, draggable; - - (function(c1) { - while (c1 < answer.length) { - for (draggableId in answer[c1]) { - if (answer[c1].hasOwnProperty(draggableId) === false) { - // eslint-disable-next-line no-continue - continue; - } - - // eslint-disable-next-line no-cond-assign - if ((draggable = getById(state, 'draggables', draggableId)) === null) { - console.log( - 'ERROR: In answer there exists a ' - + 'draggable ID "' + draggableId + '". No ' - + 'draggable with this ID could be found.' - ); - - // eslint-disable-next-line no-continue - continue; - } - - draggable.moveDraggableTo('XY', { - x: answer[c1][draggableId][0], - y: answer[c1][draggableId][1] - }); - } - - c1 += 1; - } - }(0)); - } - - function repositionDraggables(state, answer) { - var answerSortedByDepth, minDepth, maxDepth; - - answerSortedByDepth = {}; - minDepth = 1000; - maxDepth = 0; - - answer.every(function(chain) { - var depth; - - depth = findDepth(chain, 0); - - if (depth < minDepth) { - minDepth = depth; - } - if (depth > maxDepth) { - maxDepth = depth; - } - - if (answerSortedByDepth.hasOwnProperty(depth) === false) { - answerSortedByDepth[depth] = []; - } - - answerSortedByDepth[depth].push(chain); - - return true; - }); - - if (answer.length === 0) { - return; - } - - // For now we support only one case. - if ((minDepth < 1) || (maxDepth > 3)) { - return; - } - - if (state.config.individualTargets === true) { - processAnswerTargets(state, answerSortedByDepth, minDepth, maxDepth, maxDepth, 0); - } else if (state.config.individualTargets === false) { - processAnswerPositions(state, answer); - } - } - - function findDepth(tempObj, depth) { - var i; - - if ($.isPlainObject(tempObj) === false) { - return depth; - } - - depth += 1; - - for (i in tempObj) { - if (tempObj.hasOwnProperty(i) === true) { - depth = findDepth(tempObj[i], depth); - } - } - - return depth; - } - - function getById(state, type, id, fromTargetField, inContainer, targetId, baseDraggableId, baseTargetId) { - return (function(c1) { - while (c1 < state[type].length) { - if (type === 'draggables') { - if ((targetId !== undefined) && (inContainer === false) && (baseDraggableId !== undefined) && (baseTargetId !== undefined)) { - if ( - (state[type][c1].id === id) - && (state[type][c1].inContainer === false) - && (state[type][c1].onTarget.id === targetId) - && (state[type][c1].onTarget.type === 'on_drag') - && (state[type][c1].onTarget.draggableObj.id === baseDraggableId) - && (state[type][c1].onTarget.draggableObj.onTarget.id === baseTargetId) - ) { - return state[type][c1]; - } - } else if ((targetId !== undefined) && (inContainer === false)) { - if ( - (state[type][c1].id === id) - && (state[type][c1].inContainer === false) - && (state[type][c1].onTarget.id === targetId) - ) { - return state[type][c1]; - } - } else { - if (inContainer === false) { - if ((state[type][c1].id === id) && (state[type][c1].inContainer === false)) { - return state[type][c1]; - } - } else { - if ((state[type][c1].id === id) && (state[type][c1].inContainer === true)) { - return state[type][c1]; - } - } - } - } else { // 'targets' - if (fromTargetField === true) { - if ((state[type][c1].id === id) && (state[type][c1].type === 'on_drag')) { - return state[type][c1]; - } - } else { - if ((state[type][c1].id === id) && (state[type][c1].type === 'base')) { - return state[type][c1]; - } - } - } - - c1 += 1; - } - - return null; - }(0)); - } - }); // End-of: define([], function () { -}(RequireJS.requirejs, RequireJS.require, RequireJS.define)); // End-of: (function (requirejs, require, define) { diff --git a/common/static/js/capa/edit-a-gene.js b/common/static/js/capa/edit-a-gene.js deleted file mode 100644 index 0ef55a06fb12..000000000000 --- a/common/static/js/capa/edit-a-gene.js +++ /dev/null @@ -1,71 +0,0 @@ -(function() { - var timeout = 1000; - - waitForGenex(); - - function waitForGenex() { - if (typeof genex !== 'undefined' && genex) { - genex.onInjectionDone('genex'); - } else { - setTimeout(function() { waitForGenex(); }, timeout); - } - } - - // NOTE: - // Genex uses 8 global functions, all prefixed with genex: - // 6 are exported from GWT: - // genexSetDefaultDNASequence - // genexSetDNASequence - // genexGetDNASequence - // genexSetClickEvent - // genexSetKeyEvent - // genexSetProblemNumber - // - // It calls genexIsReady with a deferred command when it has finished - // initialization and has drawn itself - // genexStoreAnswer(answer) is called each time the DNA sequence changes - // through user interaction - - // Genex does not call the following function - genexGetInputField = function() { - var problem = $('#genex_container').parents('.problem'); - return problem.find('input[type="hidden"][name!="genex_dna_sequence"][name!="genex_problem_number"]'); - }; - - genexIsReady = function() { - var input_field = genexGetInputField(); - var genex_saved_state = input_field.val(); - var genex_default_dna_sequence; - var genex_dna_sequence; - - // Get the DNA sequence from xml file - genex_default_dna_sequence = $('#genex_dna_sequence').val(); - // Set the default DNA - genexSetDefaultDNASequence(genex_default_dna_sequence); - - // Now load problem - var genex_problem_number = $('#genex_problem_number').val(); - genexSetProblemNumber(genex_problem_number); - - // Set the DNA sequence that is displayed - if (genex_saved_state === '') { - // Load DNA sequence from xml file - genex_dna_sequence = genex_default_dna_sequence; - } else { - // Load DNA sequence from saved value - genex_saved_state = JSON.parse(genex_saved_state); - genex_dna_sequence = genex_saved_state.genex_dna_sequence; - } - genexSetDNASequence(genex_dna_sequence); - - // Now load mouse and keyboard handlers - genexSetClickEvent(); - genexSetKeyEvent(); - }; - - genexStoreAnswer = function(answer) { - var input_field = genexGetInputField(); - var value = {genex_dna_sequence: genexGetDNASequence(), genex_answer: answer}; - input_field.val(JSON.stringify(value)); - }; -}).call(this); diff --git a/common/static/js/capa/fixtures/jsinput.html b/common/static/js/capa/fixtures/jsinput.html deleted file mode 100644 index 039fe3d8d1df..000000000000 --- a/common/static/js/capa/fixtures/jsinput.html +++ /dev/null @@ -1,53 +0,0 @@ -
          -
          - -
          - - -
          -
          -
          - -
          - - -
          -
          -
          diff --git a/common/static/js/capa/genex/21B31BA00E7CE7B6BD63DD13A8586A45.cache.html b/common/static/js/capa/genex/21B31BA00E7CE7B6BD63DD13A8586A45.cache.html deleted file mode 100644 index ec8170eb4793..000000000000 --- a/common/static/js/capa/genex/21B31BA00E7CE7B6BD63DD13A8586A45.cache.html +++ /dev/null @@ -1,652 +0,0 @@ - - - - \ No newline at end of file diff --git a/common/static/js/capa/genex/63308EE54E8033A708B414CAC05B0C32.cache.html b/common/static/js/capa/genex/63308EE54E8033A708B414CAC05B0C32.cache.html deleted file mode 100644 index 952e3b5f37dc..000000000000 --- a/common/static/js/capa/genex/63308EE54E8033A708B414CAC05B0C32.cache.html +++ /dev/null @@ -1,642 +0,0 @@ - - - - \ No newline at end of file diff --git a/common/static/js/capa/genex/7AC57DC6EC8C1D8672DDF6E6D4EF57CC.cache.html b/common/static/js/capa/genex/7AC57DC6EC8C1D8672DDF6E6D4EF57CC.cache.html deleted file mode 100644 index 95cb962805c7..000000000000 --- a/common/static/js/capa/genex/7AC57DC6EC8C1D8672DDF6E6D4EF57CC.cache.html +++ /dev/null @@ -1,628 +0,0 @@ - - - \ No newline at end of file diff --git a/common/static/js/capa/genex/9B4F4D4EFA24CDE2E4287CC07897F249.cache.html b/common/static/js/capa/genex/9B4F4D4EFA24CDE2E4287CC07897F249.cache.html deleted file mode 100644 index 5c828c120943..000000000000 --- a/common/static/js/capa/genex/9B4F4D4EFA24CDE2E4287CC07897F249.cache.html +++ /dev/null @@ -1,654 +0,0 @@ - - - - \ No newline at end of file diff --git a/common/static/js/capa/genex/A069AC107D79C29D6237614AC340F0C0.cache.html b/common/static/js/capa/genex/A069AC107D79C29D6237614AC340F0C0.cache.html deleted file mode 100644 index bcf15330d988..000000000000 --- a/common/static/js/capa/genex/A069AC107D79C29D6237614AC340F0C0.cache.html +++ /dev/null @@ -1,652 +0,0 @@ - - - - \ No newline at end of file diff --git a/common/static/js/capa/genex/C6220FCC8B9234FEAD8D826A73C6D2A4.cache.html b/common/static/js/capa/genex/C6220FCC8B9234FEAD8D826A73C6D2A4.cache.html deleted file mode 100644 index 5ab12af71887..000000000000 --- a/common/static/js/capa/genex/C6220FCC8B9234FEAD8D826A73C6D2A4.cache.html +++ /dev/null @@ -1,642 +0,0 @@ - - - - \ No newline at end of file diff --git a/common/static/js/capa/genex/clear.cache.gif b/common/static/js/capa/genex/clear.cache.gif deleted file mode 100644 index e565824aafaf..000000000000 Binary files a/common/static/js/capa/genex/clear.cache.gif and /dev/null differ diff --git a/common/static/js/capa/genex/genex.css b/common/static/js/capa/genex/genex.css deleted file mode 100644 index 459c854f92e4..000000000000 --- a/common/static/js/capa/genex/genex.css +++ /dev/null @@ -1,122 +0,0 @@ -.genex-button { - margin-right: -8px; - height: 40px !important; -} - -.genex-label { - /*font: normal normal normal 10pt/normal 'Open Sans', Verdana, Geneva, sans-serif !important;*/ - /*padding: 4px 0px 0px 10px !important;*/ - font-family: sans-serif !important; - font-size: 13px !important; - font-style: normal !important; - font-variant: normal !important; - font-weight: bold !important; - padding-top: 6px !important; - margin-left: 18px; -} - -.gwt-HTML { - cursor: default; - overflow-x: auto !important; - overflow-y: auto !important; - background-color: rgb(248, 248, 248) !important; -} - -.genex-scrollpanel { - word-wrap: normal !important; - white-space: pre !important; -} - -pre, #dna-strand { - font-family: 'courier new', courier !important; - font-size: 13px !important; - font-style: normal !important; - font-variant: normal !important; - font-weight: normal !important; - border-style: none !important; - background-color: rgb(248, 248, 248) !important; - word-wrap: normal !important; - white-space: pre !important; - overflow-x: visible !important; - overflow-y: visible !important; -} - -.gwt-DialogBox .Caption { - background: #F1F1F1; - padding: 4px 8px 4px 4px; - cursor: default; - font-family: Arial Unicode MS, Arial, sans-serif; - font-weight: bold; - border-bottom: 1px solid #bbbbbb; - border-top: 1px solid #D2D2D2; -} -.gwt-DialogBox .dialogContent { -} -.gwt-DialogBox .dialogMiddleCenter { - padding: 3px; - background: white; -} -.gwt-DialogBox .dialogBottomCenter { - background: url(images/hborder.png) repeat-x 0px -2945px; - -background: url(images/hborder_ie6.png) repeat-x 0px -2144px; -} -.gwt-DialogBox .dialogMiddleLeft { - background: url(images/vborder.png) repeat-y -31px 0px; -} -.gwt-DialogBox .dialogMiddleRight { - background: url(images/vborder.png) repeat-y -32px 0px; - -background: url(images/vborder_ie6.png) repeat-y -32px 0px; -} -.gwt-DialogBox .dialogTopLeftInner { - width: 10px; - height: 8px; - zoom: 1; -} -.gwt-DialogBox .dialogTopRightInner { - width: 12px; - zoom: 1; -} -.gwt-DialogBox .dialogBottomLeftInner { - width: 10px; - height: 12px; - zoom: 1; -} -.gwt-DialogBox .dialogBottomRightInner { - width: 12px; - height: 12px; - zoom: 1; -} -.gwt-DialogBox .dialogTopLeft { - background: url(images/circles.png) no-repeat -20px 0px; - -background: url(images/circles_ie6.png) no-repeat -20px 0px; -} -.gwt-DialogBox .dialogTopRight { - background: url(images/circles.png) no-repeat -28px 0px; - -background: url(images/circles_ie6.png) no-repeat -28px 0px; -} -.gwt-DialogBox .dialogBottomLeft { - background: url(images/circles.png) no-repeat 0px -36px; - -background: url(images/circles_ie6.png) no-repeat 0px -36px; -} -.gwt-DialogBox .dialogBottomRight { - background: url(images/circles.png) no-repeat -8px -36px; - -background: url(images/circles_ie6.png) no-repeat -8px -36px; -} -* html .gwt-DialogBox .dialogTopLeftInner { - width: 10px; - overflow: hidden; -} -* html .gwt-DialogBox .dialogTopRightInner { - width: 12px; - overflow: hidden; -} -* html .gwt-DialogBox .dialogBottomLeftInner { - width: 10px; - height: 12px; - overflow: hidden; -} -* html .gwt-DialogBox .dialogBottomRightInner { - width: 12px; - height: 12px; - overflow: hidden; -} \ No newline at end of file diff --git a/common/static/js/capa/genex/genex.nocache.js b/common/static/js/capa/genex/genex.nocache.js deleted file mode 100644 index 11f9714afbe1..000000000000 --- a/common/static/js/capa/genex/genex.nocache.js +++ /dev/null @@ -1,18 +0,0 @@ -function genex(){var P='',xb='" for "gwt:onLoadErrorFn"',vb='" for "gwt:onPropertyErrorFn"',ib='"><\/script>',Z='#',Xb='.cache.html',_='/',lb='//',Qb='21B31BA00E7CE7B6BD63DD13A8586A45',Rb='63308EE54E8033A708B414CAC05B0C32',Sb='7AC57DC6EC8C1D8672DDF6E6D4EF57CC',Tb='9B4F4D4EFA24CDE2E4287CC07897F249',Wb=':',pb='::',dc=' - -This html file is for Development Mode support. - diff --git a/common/static/js/capa/genex/images/circles.png b/common/static/js/capa/genex/images/circles.png deleted file mode 100644 index ba580a3acf7f..000000000000 Binary files a/common/static/js/capa/genex/images/circles.png and /dev/null differ diff --git a/common/static/js/capa/genex/images/circles_ie6.png b/common/static/js/capa/genex/images/circles_ie6.png deleted file mode 100644 index 466f11923f25..000000000000 Binary files a/common/static/js/capa/genex/images/circles_ie6.png and /dev/null differ diff --git a/common/static/js/capa/genex/images/corner.png b/common/static/js/capa/genex/images/corner.png deleted file mode 100644 index d0b8aad882a9..000000000000 Binary files a/common/static/js/capa/genex/images/corner.png and /dev/null differ diff --git a/common/static/js/capa/genex/images/corner_ie6.png b/common/static/js/capa/genex/images/corner_ie6.png deleted file mode 100644 index 853d5b038d3b..000000000000 Binary files a/common/static/js/capa/genex/images/corner_ie6.png and /dev/null differ diff --git a/common/static/js/capa/genex/images/hborder.png b/common/static/js/capa/genex/images/hborder.png deleted file mode 100644 index bbc37366ff86..000000000000 Binary files a/common/static/js/capa/genex/images/hborder.png and /dev/null differ diff --git a/common/static/js/capa/genex/images/hborder_ie6.png b/common/static/js/capa/genex/images/hborder_ie6.png deleted file mode 100644 index 2add622a5881..000000000000 Binary files a/common/static/js/capa/genex/images/hborder_ie6.png and /dev/null differ diff --git a/common/static/js/capa/genex/images/thumb_horz.png b/common/static/js/capa/genex/images/thumb_horz.png deleted file mode 100644 index 6c9baa03c7bf..000000000000 Binary files a/common/static/js/capa/genex/images/thumb_horz.png and /dev/null differ diff --git a/common/static/js/capa/genex/images/thumb_vertical.png b/common/static/js/capa/genex/images/thumb_vertical.png deleted file mode 100644 index 5ea57dbd77a9..000000000000 Binary files a/common/static/js/capa/genex/images/thumb_vertical.png and /dev/null differ diff --git a/common/static/js/capa/genex/images/vborder.png b/common/static/js/capa/genex/images/vborder.png deleted file mode 100644 index 070d25184ff6..000000000000 Binary files a/common/static/js/capa/genex/images/vborder.png and /dev/null differ diff --git a/common/static/js/capa/genex/images/vborder_ie6.png b/common/static/js/capa/genex/images/vborder_ie6.png deleted file mode 100644 index 061736f01d66..000000000000 Binary files a/common/static/js/capa/genex/images/vborder_ie6.png and /dev/null differ diff --git a/common/static/js/capa/jsinput/jsinput_example.css b/common/static/js/capa/jsinput/jsinput_example.css deleted file mode 100644 index 8f1144ac40aa..000000000000 --- a/common/static/js/capa/jsinput/jsinput_example.css +++ /dev/null @@ -1,9 +0,0 @@ -.directions { - font-size: large -} - -.feedback { - font-size: medium; - border: 2px solid cornflowerblue; - padding: 5px; -} diff --git a/common/static/js/capa/jsinput/jsinput_example.html b/common/static/js/capa/jsinput/jsinput_example.html deleted file mode 100644 index caa034fff95d..000000000000 --- a/common/static/js/capa/jsinput/jsinput_example.html +++ /dev/null @@ -1,15 +0,0 @@ - - - - Dropdown with Dynamic Text - - - - - - - - - diff --git a/common/static/js/capa/jsinput/jsinput_example.js b/common/static/js/capa/jsinput/jsinput_example.js deleted file mode 100644 index f3ee144a2ca1..000000000000 --- a/common/static/js/capa/jsinput/jsinput_example.js +++ /dev/null @@ -1,86 +0,0 @@ -/* globals Channel */ - -(function() { - 'use strict'; - - // state will be populated via initial_state via the `setState` method. Defining dummy values here - // to make the expected structure clear. - var state = { - availableChoices: [], - selectedChoice: '' - }, - channel, - select = document.getElementsByClassName('choices')[0], - feedback = document.getElementsByClassName('feedback')[0]; - - function populateSelect() { - // Populate the select from `state.availableChoices`. - var i, option; - - // Clear out any pre-existing options. - while (select.firstChild) { - select.removeChild(select.firstChild); - } - - // Populate the select with the available choices. - for (i = 0; i < state.availableChoices.length; i++) { - option = document.createElement('option'); - option.value = i; - option.innerHTML = state.availableChoices[i]; - if (state.availableChoices[i] === state.selectedChoice) { - option.selected = true; - } - select.appendChild(option); - } - feedback.innerText = "The currently selected answer is '" + state.selectedChoice + "'."; - } - - function getGrade() { - // The following return value may or may not be used to grade server-side. - // If getState and setState are used, then the Python grader also gets access - // to the return value of getState and can choose it instead to grade. - return JSON.stringify(state.selectedChoice); - } - - function getState() { - // Returns the current state (which can be used for grading). - return JSON.stringify(state); - } - - // This function will be called with 1 argument when JSChannel is not used, - // 2 otherwise. In the latter case, the first argument is a transaction - // object that will not be used here - // (see http://mozilla.github.io/jschannel/docs/) - function setState() { - var stateString = arguments.length === 1 ? arguments[0] : arguments[1]; - state = JSON.parse(stateString); - populateSelect(); - } - - // Establish a channel only if this application is embedded in an iframe. - // This will let the parent window communicate with this application using - // RPC and bypass SOP restrictions. - if (window.parent !== window) { - channel = Channel.build({ - window: window.parent, - origin: '*', - scope: 'JSInput' - }); - - channel.bind('getGrade', getGrade); - channel.bind('getState', getState); - channel.bind('setState', setState); - } - - select.addEventListener('change', function() { - state.selectedChoice = select.options[select.selectedIndex].text; - feedback.innerText = "You have selected '" + state.selectedChoice - + "'. Click Submit to grade your answer."; - }); - - return { - getState: getState, - setState: setState, - getGrade: getGrade - }; -}()); diff --git a/common/static/js/capa/protex/39CC89519B0E1FCB47B935AC9FE13D7B.cache.html b/common/static/js/capa/protex/39CC89519B0E1FCB47B935AC9FE13D7B.cache.html deleted file mode 100644 index e5db692aaca7..000000000000 --- a/common/static/js/capa/protex/39CC89519B0E1FCB47B935AC9FE13D7B.cache.html +++ /dev/null @@ -1,743 +0,0 @@ - - - - \ No newline at end of file diff --git a/common/static/js/capa/protex/6E05B1CD5BFCAF7D53C7C64D84318178.cache.html b/common/static/js/capa/protex/6E05B1CD5BFCAF7D53C7C64D84318178.cache.html deleted file mode 100644 index ce6b444862d6..000000000000 --- a/common/static/js/capa/protex/6E05B1CD5BFCAF7D53C7C64D84318178.cache.html +++ /dev/null @@ -1,750 +0,0 @@ - - - - \ No newline at end of file diff --git a/common/static/js/capa/protex/C824A958AB642DC2213DFFDAC640BEAA.cache.html b/common/static/js/capa/protex/C824A958AB642DC2213DFFDAC640BEAA.cache.html deleted file mode 100644 index f84a8b982238..000000000000 --- a/common/static/js/capa/protex/C824A958AB642DC2213DFFDAC640BEAA.cache.html +++ /dev/null @@ -1,760 +0,0 @@ - - - - \ No newline at end of file diff --git a/common/static/js/capa/protex/D9267DE8FB02F8B995B4A58C66C76E29.cache.html b/common/static/js/capa/protex/D9267DE8FB02F8B995B4A58C66C76E29.cache.html deleted file mode 100644 index b6fc4f6a081a..000000000000 --- a/common/static/js/capa/protex/D9267DE8FB02F8B995B4A58C66C76E29.cache.html +++ /dev/null @@ -1,758 +0,0 @@ - - - - \ No newline at end of file diff --git a/common/static/js/capa/protex/F275492F7098103BCB05F4F86ABF6218.cache.html b/common/static/js/capa/protex/F275492F7098103BCB05F4F86ABF6218.cache.html deleted file mode 100644 index 311c82b3a0f0..000000000000 --- a/common/static/js/capa/protex/F275492F7098103BCB05F4F86ABF6218.cache.html +++ /dev/null @@ -1,750 +0,0 @@ - - - - \ No newline at end of file diff --git a/common/static/js/capa/protex/F3301B0E65F38C7FCF2EF3764B3BB0B6.cache.html b/common/static/js/capa/protex/F3301B0E65F38C7FCF2EF3764B3BB0B6.cache.html deleted file mode 100644 index f39f0d68d26b..000000000000 --- a/common/static/js/capa/protex/F3301B0E65F38C7FCF2EF3764B3BB0B6.cache.html +++ /dev/null @@ -1,754 +0,0 @@ - - - - \ No newline at end of file diff --git a/common/static/js/capa/protex/clear.cache.gif b/common/static/js/capa/protex/clear.cache.gif deleted file mode 100644 index e565824aafaf..000000000000 Binary files a/common/static/js/capa/protex/clear.cache.gif and /dev/null differ diff --git a/common/static/js/capa/protex/hosted.html b/common/static/js/capa/protex/hosted.html deleted file mode 100644 index 48b87f39b57a..000000000000 --- a/common/static/js/capa/protex/hosted.html +++ /dev/null @@ -1,365 +0,0 @@ - - - -This html file is for Development Mode support. - diff --git a/common/static/js/capa/protex/protex.css b/common/static/js/capa/protex/protex.css deleted file mode 100644 index b0300c33ea83..000000000000 --- a/common/static/js/capa/protex/protex.css +++ /dev/null @@ -1,57 +0,0 @@ -.protex-absolute-panel { - background-color: #BBBBBB; -} - -.protex-canvas { - outline: none; -} - -.protex-caption-panel { - padding: 10px 10px 10px 10px; - margin: 0px 0px 0px 0px; - border:2px solid #4E4E4E; - font: normal normal normal 14pt/normal 'Open Sans', sans-serif; - background-color: #B2B2FF; -} - -.protex-textbox { - font: normal normal normal 12pt/normal 'Open Sans', sans-serif !important; - padding: 2px 2px 2px 2px !important; -} - -.protex-caption-panel-ss-bonds-on { - padding: 10px 10px 10px 10px; - margin: 0px 0px 0px 0px; - border:2px solid #4E4E4E; - font: normal normal normal 14pt/normal 'Open Sans', sans-serif; - background-color: #B2FFFF; -} - -.protex-button { - margin-right: 15px; -} - -.protex-listbox { -} - -.gwt-ProgressBar-shell { - border: 2px solid #faf9f7; - border-right: 2px solid #848280; - border-bottom: 2px solid #848280; - background-color: #AAAAAA; - height: 14pt; - width: 50%; - margin-left: 15px; -} -.gwt-ProgressBar-shell .gwt-ProgressBar-bar { - background-color: #67A7E3; -} -.gwt-ProgressBar-shell .gwt-ProgressBar-text { - padding: 0px; - margin: 0px; - color: white; -} - -div#protex-panel[style] { - overflow: scroll !important; -} diff --git a/common/static/js/capa/protex/protex.nocache.js b/common/static/js/capa/protex/protex.nocache.js deleted file mode 100644 index 77f770bf9c9a..000000000000 --- a/common/static/js/capa/protex/protex.nocache.js +++ /dev/null @@ -1,18 +0,0 @@ -function protex(){var P='',xb='" for "gwt:onLoadErrorFn"',vb='" for "gwt:onPropertyErrorFn"',ib='"><\/script>',Z='#',Xb='.cache.html',_='/',lb='//',Qb='39CC89519B0E1FCB47B935AC9FE13D7B',Rb='6E05B1CD5BFCAF7D53C7C64D84318178',Wb=':',pb='::',dc=' diff --git a/lms/djangoapps/teams/templates/teams/_underscore_templates.html b/lms/djangoapps/teams/templates/teams/_underscore_templates.html new file mode 100644 index 000000000000..fde2766bce35 --- /dev/null +++ b/lms/djangoapps/teams/templates/teams/_underscore_templates.html @@ -0,0 +1,23 @@ +<%page expression_filter="h"/> +<%namespace name='static' file='../static_content.html'/> +<% +from openedx.core.djangolib.js_utils import dump_js_escaped_json, js_escaped_string +enable_discussion_home_panel = settings.FEATURES.get('ENABLE_DISCUSSION_HOME_PANEL', False) +%> + + +<%static:include path="common/templates/discussion/templates.underscore" /> diff --git a/lms/djangoapps/teams/templates/teams/teams.html b/lms/djangoapps/teams/templates/teams/teams.html index 3dfa5b51aeb6..d2ab817d4c3a 100644 --- a/lms/djangoapps/teams/templates/teams/teams.html +++ b/lms/djangoapps/teams/templates/teams/teams.html @@ -64,5 +64,5 @@ -<%include file="../discussion/_underscore_templates.html" /> -<%include file="../discussion/_thread_list_template.html" /> +<%include file="_underscore_templates.html" /> +<%include file="_thread_list_template.html" /> diff --git a/lms/djangoapps/teams/tests/test_api.py b/lms/djangoapps/teams/tests/test_api.py index dceb940ef560..f40190ea61a9 100644 --- a/lms/djangoapps/teams/tests/test_api.py +++ b/lms/djangoapps/teams/tests/test_api.py @@ -16,8 +16,10 @@ from lms.djangoapps.teams.models import CourseTeam from lms.djangoapps.teams.tests.factories import CourseTeamFactory from openedx.core.lib.teams_config import TeamsConfig, TeamsetType -from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + SharedModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order COURSE_KEY1 = CourseKey.from_string('course-v1:edx+history+1') COURSE_KEY2 = CourseKey.from_string('course-v1:edx+math+1') @@ -212,13 +214,13 @@ def test_anonymous_user_ids_for_team_not_on_team(self): """ A learner should not be able to get IDs from members of a team they are not a member of """ - self.assertRaises(Exception, teams_api.anonymous_user_ids_for_team, self.user1, self.team2) + self.assertRaises(Exception, teams_api.anonymous_user_ids_for_team, self.user1, self.team2) # noqa: B017, PT027 def test_anonymous_user_ids_for_team_bad_user_or_team(self): """ An exception should be thrown when a bad user or team are passed to the endpoint """ - self.assertRaises(Exception, teams_api.anonymous_user_ids_for_team, None, self.team1) + self.assertRaises(Exception, teams_api.anonymous_user_ids_for_team, None, self.team1) # noqa: B017, PT027 def test_anonymous_user_ids_for_team_staff(self): """ diff --git a/lms/djangoapps/teams/tests/test_csv.py b/lms/djangoapps/teams/tests/test_csv.py index c9ad9c1bde75..37382c81ef24 100644 --- a/lms/djangoapps/teams/tests/test_csv.py +++ b/lms/djangoapps/teams/tests/test_csv.py @@ -1,15 +1,18 @@ """ Tests for the functionality in csv """ from csv import DictReader, DictWriter from io import BytesIO, StringIO, TextIOWrapper + from common.djangoapps.student.tests.factories import CourseEnrollmentFactory, UserFactory from common.djangoapps.util.testing import EventTestMixin -from lms.djangoapps.program_enrollments.tests.factories import ProgramEnrollmentFactory, ProgramCourseEnrollmentFactory +from lms.djangoapps.program_enrollments.tests.factories import ProgramCourseEnrollmentFactory, ProgramEnrollmentFactory from lms.djangoapps.teams import csv from lms.djangoapps.teams.models import CourseTeam, CourseTeamMembership from lms.djangoapps.teams.tests.factories import CourseTeamFactory from openedx.core.lib.teams_config import TeamsConfig -from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + SharedModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order def csv_import(course, csv_dict_rows): @@ -202,7 +205,7 @@ def test_load_team_membership_csv(self): reader = csv_export(self.course) assert expected_csv_headers == reader.fieldnames actual_data = _user_keyed_dict(reader) - self.assertDictEqual(expected_data, actual_data) + self.assertDictEqual(expected_data, actual_data) # noqa: PT009 def _add_blanks_to_expected_data(self, expected_data, headers): """ Helper method to fill in the "blanks" in test data """ @@ -388,7 +391,7 @@ def test_exceed_max_size(self): assert self.import_manager.validation_errors[0] == 'New membership for team team_1 would exceed max size of 3.' # Confirm that memberships were not altered - for i in range(2): + for i in range(2): # noqa: B007 assert CourseTeamMembership.is_user_on_team(user, team) def test_remove_from_team(self): @@ -405,7 +408,7 @@ def test_remove_from_team(self): ['username', 'mode', 'teamset_1'], [user.username, mode, ''], ]) - result = self.import_manager.set_team_memberships(csv_data) # lint-amnesty, pylint: disable=unused-variable + result = self.import_manager.set_team_memberships(csv_data) # pylint: disable=unused-variable # noqa: F841 # Then they are removed from the team and the correct events are issued assert not CourseTeamMembership.is_user_on_team(user, team) @@ -458,7 +461,7 @@ def test_create_new_team_from_import(self): ['username', 'mode', 'teamset_1'], [user.username, mode, 'new_exciting_team'], ]) - result = self.import_manager.set_team_memberships(csv_data) # lint-amnesty, pylint: disable=unused-variable + result = self.import_manager.set_team_memberships(csv_data) # pylint: disable=unused-variable # noqa: F841 # Then a new team is created assert CourseTeam.objects.all().count() == 1 @@ -669,4 +672,4 @@ def _assert_test_users_on_team(self, data, no_external_key_value): (self.user_in_program.username, self.external_user_key) ] } - self.assertDictEqual(expected_data, data) + self.assertDictEqual(expected_data, data) # noqa: PT009 diff --git a/lms/djangoapps/teams/tests/test_models.py b/lms/djangoapps/teams/tests/test_models.py index 60190076004c..922406ef457c 100644 --- a/lms/djangoapps/teams/tests/test_models.py +++ b/lms/djangoapps/teams/tests/test_models.py @@ -29,11 +29,13 @@ thread_created, thread_deleted, thread_edited, - thread_voted + thread_voted, ) from openedx.core.lib.teams_config import TeamsConfig -from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + SharedModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order COURSE_KEY1 = CourseKey.from_string('edx/history/1') COURSE_KEY2 = CourseKey.from_string('edx/math/1') diff --git a/lms/djangoapps/teams/tests/test_partition_scheme.py b/lms/djangoapps/teams/tests/test_partition_scheme.py index 4ea230c42981..5ac661a1c7e2 100644 --- a/lms/djangoapps/teams/tests/test_partition_scheme.py +++ b/lms/djangoapps/teams/tests/test_partition_scheme.py @@ -6,12 +6,14 @@ from unittest.mock import MagicMock, patch from common.djangoapps.student.tests.factories import UserFactory -from lms.djangoapps.teams.tests.factories import CourseTeamFactory from lms.djangoapps.teams.team_partition_scheme import TeamPartitionScheme +from lms.djangoapps.teams.tests.factories import CourseTeamFactory from openedx.core.lib.teams_config import create_team_set_partitions_with_course_id -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import ToyCourseFactory from xmodule.modulestore.django import modulestore +from xmodule.modulestore.tests.django_utils import ( + ModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import ToyCourseFactory from xmodule.partitions.partitions import Group diff --git a/lms/djangoapps/teams/tests/test_serializers.py b/lms/djangoapps/teams/tests/test_serializers.py index 384039bd661c..b0f1fb80bd72 100644 --- a/lms/djangoapps/teams/tests/test_serializers.py +++ b/lms/djangoapps/teams/tests/test_serializers.py @@ -10,9 +10,15 @@ from common.djangoapps.student.tests.factories import CourseEnrollmentFactory, UserFactory from lms.djangoapps.teams.serializers import BulkTeamCountTopicSerializer, MembershipSerializer, TopicSerializer from lms.djangoapps.teams.tests.factories import CourseTeamFactory, CourseTeamMembershipFactory +from openedx.core.djangoapps.waffle_utils.testutils import WAFFLE_TABLES +from openedx.core.djangolib.testing.utils import AUTHZ_TABLES from openedx.core.lib.teams_config import TeamsConfig -from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + SharedModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order + +QUERY_COUNT_TABLE_IGNORELIST = WAFFLE_TABLES + AUTHZ_TABLES class SerializerTestCase(SharedModuleStoreTestCase): @@ -75,7 +81,9 @@ def test_topic_with_no_team_count(self): Verifies that the `TopicSerializer` correctly displays a topic with a team count of 0, and that it takes a known number of SQL queries. """ - with self.assertNumQueries(3): # 2 split modulestore MySQL queries, 1 for Teams + with self.assertNumQueries( + 3, table_ignorelist=QUERY_COUNT_TABLE_IGNORELIST + ): # 2 split modulestore MySQL queries, 1 for Teams serializer = TopicSerializer( self.course.teamsets[0].cleaned_data, context={'course_id': self.course.id}, @@ -91,7 +99,9 @@ def test_topic_with_team_count(self): CourseTeamFactory.create( course_id=self.course.id, topic_id=self.course.teamsets[0].teamset_id ) - with self.assertNumQueries(3): # 2 split modulestore MySQL queries, 1 for Teams + with self.assertNumQueries( + 3, table_ignorelist=QUERY_COUNT_TABLE_IGNORELIST + ): # 2 split modulestore MySQL queries, 1 for Teams serializer = TopicSerializer( self.course.teamsets[0].cleaned_data, context={'course_id': self.course.id}, @@ -110,7 +120,9 @@ def test_scoped_within_course(self): ) CourseTeamFactory.create(course_id=self.course.id, topic_id=duplicate_topic['id']) CourseTeamFactory.create(course_id=second_course.id, topic_id=duplicate_topic['id']) - with self.assertNumQueries(3): # 2 split modulestore MySQL queries, 1 for Teams + with self.assertNumQueries( + 3, table_ignorelist=QUERY_COUNT_TABLE_IGNORELIST + ): # 2 split modulestore MySQL queries, 1 for Teams serializer = TopicSerializer( self.course.teamsets[0].cleaned_data, context={'course_id': self.course.id}, @@ -163,7 +175,7 @@ def assert_serializer_output(self, topics, num_teams_per_topic, num_queries): """ Verify that the serializer produced the expected topics. """ - with self.assertNumQueries(num_queries): + with self.assertNumQueries(num_queries, table_ignorelist=QUERY_COUNT_TABLE_IGNORELIST): page = Paginator( self.course.teams_configuration.cleaned_data['teamsets'], self.PAGE_SIZE, @@ -203,7 +215,7 @@ def test_topics_with_no_team_counts(self): query. """ topics = self.setup_topics(teams_per_topic=0) - self.assert_serializer_output(topics, num_teams_per_topic=0, num_queries=2) + self.assert_serializer_output(topics, num_teams_per_topic=0, num_queries=4) def test_topics_with_team_counts(self): """ @@ -212,7 +224,7 @@ def test_topics_with_team_counts(self): """ teams_per_topic = 10 topics = self.setup_topics(teams_per_topic=teams_per_topic) - self.assert_serializer_output(topics, num_teams_per_topic=teams_per_topic, num_queries=2) + self.assert_serializer_output(topics, num_teams_per_topic=teams_per_topic, num_queries=4) def test_subset_of_topics(self): """ @@ -221,7 +233,7 @@ def test_subset_of_topics(self): """ teams_per_topic = 10 topics = self.setup_topics(num_topics=self.NUM_TOPICS, teams_per_topic=teams_per_topic) - self.assert_serializer_output(topics, num_teams_per_topic=teams_per_topic, num_queries=2) + self.assert_serializer_output(topics, num_teams_per_topic=teams_per_topic, num_queries=4) def test_scoped_within_course(self): """Verify that team counts are scoped within a course.""" @@ -235,7 +247,7 @@ def test_scoped_within_course(self): }), ) CourseTeamFactory.create(course_id=second_course.id, topic_id=duplicate_topic['id']) - self.assert_serializer_output(first_course_topics, num_teams_per_topic=teams_per_topic, num_queries=2) + self.assert_serializer_output(first_course_topics, num_teams_per_topic=teams_per_topic, num_queries=4) def _merge_dicts(self, first, second): """Convenience method to merge two dicts in a single expression""" @@ -251,7 +263,9 @@ def assert_serializer_output(self, topics, num_teams_per_topic, num_queries): request = RequestFactory().get('/api/team/v0/topics') request.user = self.user - with self.assertNumQueries(num_queries + 2): # num_queries on teams tables, plus 2 split modulestore queries + with self.assertNumQueries( + num_queries + 2, table_ignorelist=QUERY_COUNT_TABLE_IGNORELIST + ): # num_queries on teams tables, plus 2 split modulestore queries serializer = self.serializer( topics, context={ @@ -269,4 +283,4 @@ def test_no_topics(self): with no topics. """ self.course.teams_configuration = TeamsConfig({'topics': []}) - self.assert_serializer_output([], num_teams_per_topic=0, num_queries=1) + self.assert_serializer_output([], num_teams_per_topic=0, num_queries=3) diff --git a/lms/djangoapps/teams/tests/test_services.py b/lms/djangoapps/teams/tests/test_services.py index 22baeefadf64..c730da3ac0ef 100644 --- a/lms/djangoapps/teams/tests/test_services.py +++ b/lms/djangoapps/teams/tests/test_services.py @@ -7,7 +7,9 @@ from lms.djangoapps.teams.services import TeamsService from lms.djangoapps.teams.tests.factories import CourseTeamFactory from openedx.core.djangoapps.catalog.tests.factories import CourseRunFactory -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + ModuleStoreTestCase, # pylint: disable=wrong-import-order +) class TeamsServiceTests(ModuleStoreTestCase): diff --git a/lms/djangoapps/teams/tests/test_views.py b/lms/djangoapps/teams/tests/test_views.py index 9c4ca5feab47..bfb17002bc07 100644 --- a/lms/djangoapps/teams/tests/test_views.py +++ b/lms/djangoapps/teams/tests/test_views.py @@ -13,13 +13,13 @@ import pytz from dateutil import parser from django.conf import settings -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.core.files.uploadedfile import SimpleUploadedFile from django.db.models.signals import post_save from django.test import override_settings from django.urls import reverse from django.utils import translation -from elasticsearch.exceptions import ConnectionError # lint-amnesty, pylint: disable=redefined-builtin +from elasticsearch.exceptions import ConnectionError # pylint: disable=redefined-builtin from rest_framework.test import APIClient, APITestCase from search.search_engine_base import SearchEngine @@ -32,11 +32,17 @@ from openedx.core.djangoapps.django_comment_common.models import FORUM_ROLE_COMMUNITY_TA, Role from openedx.core.djangoapps.django_comment_common.utils import seed_permissions_roles from openedx.core.lib.teams_config import TeamsConfig -from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory, BlockFactory # lint-amnesty, pylint: disable=wrong-import-order -from .factories import CourseTeamFactory, LAST_ACTIVITY_AT +from xmodule.modulestore.tests.django_utils import ( + SharedModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import ( # pylint: disable=wrong-import-order + BlockFactory, + CourseFactory, +) + from ..models import CourseTeamMembership from ..search_indexes import CourseTeam, CourseTeamIndexer, course_team_post_save_callback +from .factories import LAST_ACTIVITY_AT, CourseTeamFactory @ddt.ddt @@ -213,7 +219,7 @@ def test_team_dashboard_user_course_specific_team_list(self): # Create teams in both courses course_one_team = CourseTeamFactory.create(name="Course one team", course_id=self.course.id, topic_id=1) - course_two_team = CourseTeamFactory.create( # pylint: disable=unused-variable + course_two_team = CourseTeamFactory.create( # pylint: disable=unused-variable # noqa: F841 name="Course two team", course_id=course_two.id, topic_id=1, ) @@ -656,7 +662,7 @@ def make_call(self, url, expected_status=200, method='get', data=None, content_t else: response = func(url, data=data) assert expected_status == response.status_code, "Expected status {expected} but got {actual}: {content}" \ - .format( + .format( # noqa: UP032 expected=expected_status, actual=response.status_code, content=response.content.decode(response.charset), @@ -805,7 +811,7 @@ def setUp(self): # pylint: disable=arguments-differ ('student_masters', 200, 1) ) @ddt.unpack - def test_access(self, user, status, expected_teams_count=0): + def test_access(self, user, status, expected_teams_count=0): # noqa: PT028 teams = self.get_teams_list(user=user, expected_status=status) if status == 200: assert expected_teams_count == teams['count'] @@ -1711,7 +1717,7 @@ def setUpClass(cls): parent=subsection, category="vertical" ) - off_team_open_assessment = BlockFactory.create( # pylint: disable=unused-variable + off_team_open_assessment = BlockFactory.create( # pylint: disable=unused-variable # noqa: F841 parent=unit_2, category="openassessment", teams_enabled=True, @@ -2771,7 +2777,7 @@ class TestElasticSearchErrors(TeamAPITestCase): ES_ERROR = ConnectionError('N/A', 'connection error', {}) @patch.object(SearchEngine, 'get_search_engine', side_effect=ES_ERROR) - def test_list_teams(self, __): + def test_list_teams(self, __): # noqa: PT019 """Test that text searches return a 503 when Elasticsearch is down. The endpoint should still return 200 when a search is not supplied.""" @@ -2787,7 +2793,7 @@ def test_list_teams(self, __): ) @patch.object(SearchEngine, 'get_search_engine', side_effect=ES_ERROR) - def test_create_team(self, __): + def test_create_team(self, __): # noqa: PT019 """Test that team creation is robust to Elasticsearch errors.""" self.post_create_team( expected_status=200, @@ -2796,12 +2802,12 @@ def test_create_team(self, __): ) @patch.object(SearchEngine, 'get_search_engine', side_effect=ES_ERROR) - def test_delete_team(self, __): + def test_delete_team(self, __): # noqa: PT019 """Test that team deletion is robust to Elasticsearch errors.""" self.delete_team(self.wind_team.team_id, 204, user='staff') @patch.object(SearchEngine, 'get_search_engine', side_effect=ES_ERROR) - def test_patch_team(self, __): + def test_patch_team(self, __): # noqa: PT019 """Test that team updates are robust to Elasticsearch errors.""" self.patch_team_detail( self.wind_team.team_id, @@ -2947,11 +2953,11 @@ def test_upload_only_existing_courses(self): ) csv_content = 'username,mode,topic_1,topic_2\n' - csv_content += 'a_user,masters,{},{}\n'.format( + csv_content += 'a_user,masters,{},{}\n'.format( # noqa: UP032 existing_team_1.name, existing_team_2.name ) - csv_content += 'b_user,masters,{},{}\n'.format( + csv_content += 'b_user,masters,{},{}\n'.format( # noqa: UP032 existing_team_1.name, existing_team_2.name ) @@ -3202,7 +3208,7 @@ def test_upload_assign_masters_learner_to_non_protected_team(self): user='staff' ) response_text = json.loads(response.content.decode('utf-8')) - expected_message = 'Team {} cannot have Master’s track users mixed with users in other tracks.'.format( + expected_message = "Team {} cannot have Master’s track users mixed with users in other tracks.".format( # noqa: UP032 # pylint: disable=line-too-long team.name ) assert response_text['errors'][0] == expected_message diff --git a/lms/djangoapps/teams/urls.py b/lms/djangoapps/teams/urls.py index 5bdbc56c1389..9bfb8473053d 100644 --- a/lms/djangoapps/teams/urls.py +++ b/lms/djangoapps/teams/urls.py @@ -3,8 +3,8 @@ """ -from django.urls import path from django.contrib.auth.decorators import login_required +from django.urls import path from .views import TeamsDashboardView diff --git a/lms/djangoapps/teams/views.py b/lms/djangoapps/teams/views.py index dcce36382096..65dbec3f5bdd 100644 --- a/lms/djangoapps/teams/views.py +++ b/lms/djangoapps/teams/views.py @@ -7,7 +7,7 @@ from collections import Counter from django.conf import settings -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.core.exceptions import PermissionDenied from django.db.models.signals import post_save from django.dispatch import receiver @@ -33,17 +33,17 @@ from lms.djangoapps.courseware.courses import get_course_with_access, has_access from lms.djangoapps.discussion.django_comment_client.utils import has_discussion_privileges from lms.djangoapps.teams.models import CourseTeam, CourseTeamMembership -from openedx.core.lib.api.authentication import BearerAuthenticationAllowInactiveUser, BearerAuthentication +from openedx.core.lib.api.authentication import BearerAuthentication, BearerAuthenticationAllowInactiveUser from openedx.core.lib.api.parsers import MergePatchParser from openedx.core.lib.api.permissions import IsCourseStaffInstructor, IsStaffOrReadOnly from openedx.core.lib.api.view_utils import ( ExpandableFieldViewMixin, RetrievePatchAPIView, add_serializer_errors, - build_api_error + build_api_error, ) from openedx.core.lib.teams_config import TeamsetType -from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order from . import is_feature_enabled from .api import ( @@ -56,7 +56,7 @@ has_specific_team_access, has_specific_teamset_access, has_team_api_access, - user_organization_protection_status + user_organization_protection_status, ) from .csv import TeamMembershipImportManager, load_team_membership_csv from .errors import AlreadyOnTeamInTeamset, ElasticSearchConnectionError, NotEnrolledInCourseForTeam @@ -66,7 +66,7 @@ CourseTeamCreationSerializer, CourseTeamSerializer, MembershipSerializer, - TopicSerializer + TopicSerializer, ) from .toggles import are_team_submissions_enabled from .utils import emit_team_event @@ -526,7 +526,7 @@ def get(self, request): if order_by_input not in ordering_schemes: return Response( { - 'developer_message': "unsupported order_by value {ordering}".format( + 'developer_message': "unsupported order_by value {ordering}".format( # noqa: UP032 ordering=order_by_input, ), # Translators: 'ordering' is a string describing a way @@ -916,7 +916,7 @@ def _display_name_for_ora_block(self, block): unit = modulestore().get_item(block.parent) section = modulestore().get_item(unit.parent) - return "{section}: {unit}".format( + return "{section}: {unit}".format( # noqa: UP032 section=section.display_name, unit=unit.display_name ) @@ -1329,7 +1329,7 @@ class MembershipListView(ExpandableFieldViewMixin, GenericAPIView): permission_classes = (permissions.IsAuthenticated,) serializer_class = MembershipSerializer - def get(self, request): # lint-amnesty, pylint: disable=too-many-statements + def get(self, request): # pylint: disable=too-many-statements """GET /api/team/v0/team_membership""" specified_username_or_team = False username = None @@ -1594,14 +1594,14 @@ def get_team(self, team_id): try: return CourseTeam.objects.get(team_id=team_id) except CourseTeam.DoesNotExist: - raise Http404 # lint-amnesty, pylint: disable=raise-missing-from + raise Http404 # pylint: disable=raise-missing-from # noqa: B904 def get_membership(self, username, team): """Returns the membership for the given user and team, or throws Http404 if it does not exist.""" try: return CourseTeamMembership.objects.get(user__username=username, team=team) except CourseTeamMembership.DoesNotExist: - raise Http404 # lint-amnesty, pylint: disable=raise-missing-from + raise Http404 # pylint: disable=raise-missing-from # noqa: B904 def get(self, request, team_id, username): """GET /api/team/v0/team_membership/{team_id},{username}""" @@ -1663,7 +1663,7 @@ def get(self, request, **_kwargs): """ self.check_access() response = HttpResponse(content_type='text/csv') - filename = "team-membership_{}_{}_{}.csv".format( + filename = "team-membership_{}_{}_{}.csv".format( # noqa: UP032 self.course.id.org, self.course.id.course, self.course.id.run ) response['Content-Disposition'] = f'attachment; filename="{filename}"' @@ -1694,7 +1694,7 @@ def check_access(self): """ if not has_course_staff_privileges(self.request.user, self.course.id): raise PermissionDenied( - "To manage team membership of {}, you must be course staff.".format( + "To manage team membership of {}, you must be course staff.".format( # noqa: UP032 self.course.id ) ) @@ -1711,7 +1711,7 @@ def course(self): try: course_id = CourseKey.from_string(course_id_string) except InvalidKeyError: - raise Http404(f'Invalid course key: {course_id_string}') # lint-amnesty, pylint: disable=raise-missing-from + raise Http404(f'Invalid course key: {course_id_string}') # pylint: disable=raise-missing-from # noqa: B904 course_block = modulestore().get_course(course_id) if not course_block: raise Http404(f'Course not found: {course_id}') diff --git a/lms/djangoapps/tests/test_utils.py b/lms/djangoapps/tests/test_utils.py index 6781abc5d17a..2bc78b158386 100644 --- a/lms/djangoapps/tests/test_utils.py +++ b/lms/djangoapps/tests/test_utils.py @@ -12,7 +12,7 @@ @ddt.ddt -class UtilsTests(TestCase): # lint-amnesty, pylint: disable=missing-class-docstring +class UtilsTests(TestCase): # pylint: disable=missing-class-docstring @ddt.data( ['edX/DemoX/Demo_Course', CourseKey.from_string('edX/DemoX/Demo_Course'), CourseKey], diff --git a/lms/djangoapps/user_tours/apps.py b/lms/djangoapps/user_tours/apps.py index 7ec2de59a973..7d60da23bdd5 100644 --- a/lms/djangoapps/user_tours/apps.py +++ b/lms/djangoapps/user_tours/apps.py @@ -10,4 +10,4 @@ class UserTourConfig(AppConfig): def ready(self): """ Code to run when getting the app ready. """ # Connect signal handlers. - from lms.djangoapps.user_tours import handlers # pylint: disable=unused-import + from lms.djangoapps.user_tours import handlers # pylint: disable=unused-import # noqa: F401 diff --git a/lms/djangoapps/user_tours/handlers.py b/lms/djangoapps/user_tours/handlers.py index 60d14827c5cc..ccb16c852389 100644 --- a/lms/djangoapps/user_tours/handlers.py +++ b/lms/djangoapps/user_tours/handlers.py @@ -25,5 +25,5 @@ def init_user_tour(sender, instance, created, **kwargs): # pylint: disable=unus # feel free to remove this try/except. # The exact error we are catching is # django.db.utils.ProgrammingError: (1146, "Table 'edxtest.user_tours_usertour' doesn't exist") - except ProgrammingError as e: + except ProgrammingError as e: # noqa: F841 pass diff --git a/lms/djangoapps/user_tours/management/commands/tests/test_backpopulate_user_tours.py b/lms/djangoapps/user_tours/management/commands/tests/test_backpopulate_user_tours.py index 3812083999e4..b2c2a9be7868 100644 --- a/lms/djangoapps/user_tours/management/commands/tests/test_backpopulate_user_tours.py +++ b/lms/djangoapps/user_tours/management/commands/tests/test_backpopulate_user_tours.py @@ -6,8 +6,8 @@ from django.test import TestCase from common.djangoapps.student.tests.factories import CourseEnrollmentFactory, UserFactory -from lms.djangoapps.user_tours.models import UserTour from lms.djangoapps.user_tours.handlers import init_user_tour +from lms.djangoapps.user_tours.models import UserTour from openedx.core.djangolib.testing.utils import skip_unless_lms User = get_user_model() diff --git a/lms/djangoapps/user_tours/migrations/0001_initial.py b/lms/djangoapps/user_tours/migrations/0001_initial.py index b5393473885d..6a6f95b82f96 100644 --- a/lms/djangoapps/user_tours/migrations/0001_initial.py +++ b/lms/djangoapps/user_tours/migrations/0001_initial.py @@ -1,8 +1,8 @@ # Generated by Django 3.2.8 on 2021-11-19 15:58 +import django.db.models.deletion from django.conf import settings from django.db import migrations, models -import django.db.models.deletion class Migration(migrations.Migration): diff --git a/lms/djangoapps/user_tours/migrations/0002_auto_20230110_0905.py b/lms/djangoapps/user_tours/migrations/0002_auto_20230110_0905.py index 27db0c0add12..b3024b5920f8 100644 --- a/lms/djangoapps/user_tours/migrations/0002_auto_20230110_0905.py +++ b/lms/djangoapps/user_tours/migrations/0002_auto_20230110_0905.py @@ -1,8 +1,8 @@ # Generated by Django 3.2.16 on 2023-01-10 09:05 +import django.db.models.deletion from django.conf import settings from django.db import migrations, models -import django.db.models.deletion class Migration(migrations.Migration): diff --git a/lms/djangoapps/user_tours/models.py b/lms/djangoapps/user_tours/models.py index 23baacc15e1c..cc6789a07165 100644 --- a/lms/djangoapps/user_tours/models.py +++ b/lms/djangoapps/user_tours/models.py @@ -7,7 +7,7 @@ User = get_user_model() -class UserTour(models.Model): +class UserTour(models.Model): # noqa: DJ008 """ Model to track which tours a user needs to be shown. @@ -27,7 +27,7 @@ class CourseHomeChoices(models.TextChoices): user = models.OneToOneField(User, related_name='tour', on_delete=models.CASCADE) -class UserDiscussionsTours(models.Model): +class UserDiscussionsTours(models.Model): # noqa: DJ008 """ Model to track which discussions tours a user has seen. diff --git a/lms/djangoapps/user_tours/urls.py b/lms/djangoapps/user_tours/urls.py index 63e2e2e06f0e..6403bd15ea85 100644 --- a/lms/djangoapps/user_tours/urls.py +++ b/lms/djangoapps/user_tours/urls.py @@ -3,8 +3,7 @@ from django.conf import settings from django.urls import re_path -from lms.djangoapps.user_tours.v1.views import UserTourView, UserDiscussionsToursView - +from lms.djangoapps.user_tours.v1.views import UserDiscussionsToursView, UserTourView urlpatterns = [ re_path(fr'^v1/{settings.USERNAME_PATTERN}$', UserTourView.as_view(), name='user-tours'), diff --git a/lms/djangoapps/user_tours/v1/serializers.py b/lms/djangoapps/user_tours/v1/serializers.py index 32bb636571d5..58bafaf5ee5c 100644 --- a/lms/djangoapps/user_tours/v1/serializers.py +++ b/lms/djangoapps/user_tours/v1/serializers.py @@ -2,7 +2,7 @@ from rest_framework import serializers -from lms.djangoapps.user_tours.models import UserTour, UserDiscussionsTours +from lms.djangoapps.user_tours.models import UserDiscussionsTours, UserTour class UserTourSerializer(serializers.ModelSerializer): diff --git a/lms/djangoapps/user_tours/v1/tests/test_views.py b/lms/djangoapps/user_tours/v1/tests/test_views.py index f78586b78dec..354b80bb34d0 100644 --- a/lms/djangoapps/user_tours/v1/tests/test_views.py +++ b/lms/djangoapps/user_tours/v1/tests/test_views.py @@ -10,7 +10,7 @@ from common.djangoapps.student.tests.factories import UserFactory from lms.djangoapps.user_tours.handlers import init_user_tour -from lms.djangoapps.user_tours.models import UserTour, UserDiscussionsTours +from lms.djangoapps.user_tours.models import UserDiscussionsTours, UserTour from lms.djangoapps.user_tours.toggles import USER_TOURS_DISABLED from openedx.core.djangoapps.oauth_dispatch.jwt import create_jwt_for_user @@ -187,20 +187,20 @@ def test_get_tours(self): # Send a GET request to the view response = self.client.get(self.url, **headers) # Check that the response status code is correct - self.assertEqual(response.status_code, status.HTTP_200_OK) + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 # Check that the returned data is correct - self.assertEqual(len(response.data), 2) - self.assertEqual(response.data[0]['tour_name'], 'Test Tour') - self.assertFalse(response.data[0]['show_tour']) + self.assertEqual(len(response.data), 2) # noqa: PT009 + self.assertEqual(response.data[0]['tour_name'], 'Test Tour') # noqa: PT009 + self.assertFalse(response.data[0]['show_tour']) # noqa: PT009 - self.assertEqual(response.data[1]['tour_name'], 'not_responded_filter') - self.assertTrue(response.data[1]['show_tour']) + self.assertEqual(response.data[1]['tour_name'], 'not_responded_filter') # noqa: PT009 + self.assertTrue(response.data[1]['show_tour']) # noqa: PT009 # Test that the view can be disabled by a waffle flag. with override_waffle_flag(USER_TOURS_DISABLED, active=True): response = self.client.get(self.url, **headers) - self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN) + self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN) # noqa: PT009 def test_get_tours_unauthenticated(self): """ @@ -210,7 +210,7 @@ def test_get_tours_unauthenticated(self): response = self.client.get(self.url) # Check that the response status code is correct - self.assertEqual(response.status_code, status.HTTP_401_UNAUTHORIZED) + self.assertEqual(response.status_code, status.HTTP_401_UNAUTHORIZED) # noqa: PT009 def test_update_tour(self): """ @@ -224,13 +224,13 @@ def test_update_tour(self): response = self.client.put(url, updated_data, content_type='application/json', **headers) # Check that the response status code is correct - self.assertEqual(response.status_code, status.HTTP_200_OK) + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 # Check that the tour was updated in the database updated_tour = UserDiscussionsTours.objects.get(id=self.tour.id) - self.assertEqual(updated_tour.show_tour, False) + self.assertEqual(updated_tour.show_tour, False) # noqa: PT009 # Test that the view can be disabled by a waffle flag. with override_waffle_flag(USER_TOURS_DISABLED, active=True): response = self.client.put(url, updated_data, content_type='application/json', **headers) - self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN) + self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN) # noqa: PT009 diff --git a/lms/djangoapps/user_tours/v1/views.py b/lms/djangoapps/user_tours/v1/views.py index 65db60bcacf8..4c5ffc8f5baf 100644 --- a/lms/djangoapps/user_tours/v1/views.py +++ b/lms/djangoapps/user_tours/v1/views.py @@ -1,17 +1,16 @@ """ API for User Tours. """ from django.conf import settings -from django.db import transaction, IntegrityError +from django.db import IntegrityError, transaction from django.shortcuts import get_object_or_404 +from rest_framework import status from rest_framework.generics import RetrieveUpdateAPIView from rest_framework.permissions import IsAuthenticated from rest_framework.response import Response -from rest_framework import status +from rest_framework.views import APIView -from lms.djangoapps.user_tours.models import UserTour, UserDiscussionsTours +from lms.djangoapps.user_tours.models import UserDiscussionsTours, UserTour from lms.djangoapps.user_tours.toggles import USER_TOURS_DISABLED -from lms.djangoapps.user_tours.v1.serializers import UserTourSerializer, UserDiscussionsToursSerializer - -from rest_framework.views import APIView +from lms.djangoapps.user_tours.v1.serializers import UserDiscussionsToursSerializer, UserTourSerializer class UserTourView(RetrieveUpdateAPIView): @@ -51,7 +50,7 @@ def get(self, request, username): # pylint: disable=arguments-differ try: user_tour = UserTour.objects.get(user__username=username) # Should never really happen, but better safe than sorry. - except UserTour.DoesNotExist as e: + except UserTour.DoesNotExist as e: # noqa: F841 return Response(status=status.HTTP_404_NOT_FOUND) return Response(self.get_serializer_class()(user_tour).data, status=status.HTTP_200_OK) diff --git a/lms/djangoapps/utils.py b/lms/djangoapps/utils.py index cabf13b84f1a..d892c8f633f5 100644 --- a/lms/djangoapps/utils.py +++ b/lms/djangoapps/utils.py @@ -7,6 +7,7 @@ except ImportError: BrazeClient = None from django.conf import settings + try: from optimizely import optimizely from optimizely.config_manager import PollingConfigManager diff --git a/lms/djangoapps/verify_student/admin.py b/lms/djangoapps/verify_student/admin.py index 1d3124580ad1..d18d6289980c 100644 --- a/lms/djangoapps/verify_student/admin.py +++ b/lms/djangoapps/verify_student/admin.py @@ -9,7 +9,7 @@ SoftwareSecurePhotoVerification, SSOVerification, SSPVerificationRetryConfig, - VerificationAttempt + VerificationAttempt, ) @@ -49,7 +49,7 @@ class SSPVerificationRetryAdmin(admin.ModelAdmin): """ Admin for the SSPVerificationRetryConfig table. """ - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass @admin.register(VerificationAttempt) diff --git a/lms/djangoapps/verify_student/api.py b/lms/djangoapps/verify_student/api.py index 7b8310fde030..2887c654593e 100644 --- a/lms/djangoapps/verify_student/api.py +++ b/lms/djangoapps/verify_student/api.py @@ -2,14 +2,13 @@ API module. """ import logging +from datetime import datetime +from typing import Optional from django.conf import settings from django.contrib.auth import get_user_model from django.utils.translation import gettext as _ -from datetime import datetime -from typing import Optional - from lms.djangoapps.verify_student.emails import send_verification_approved_email from lms.djangoapps.verify_student.exceptions import VerificationAttemptInvalidStatus from lms.djangoapps.verify_student.models import VerificationAttempt @@ -58,8 +57,8 @@ def create_verification_attempt( user: User, name: str, status: str, - expiration_datetime: Optional[datetime] = None, - hide_status_from_user: Optional[bool] = False, + expiration_datetime: Optional[datetime] = None, # noqa: UP045 + hide_status_from_user: Optional[bool] = False, # noqa: UP045 ): """ Create a verification attempt. @@ -96,9 +95,9 @@ def create_verification_attempt( def update_verification_attempt( attempt_id: int, - name: Optional[str] = None, - status: Optional[str] = None, - expiration_datetime: Optional[datetime] = None, + name: Optional[str] = None, # noqa: UP045 + status: Optional[str] = None, # noqa: UP045 + expiration_datetime: Optional[datetime] = None, # noqa: UP045 ): """ Update a verification attempt. diff --git a/lms/djangoapps/verify_student/apps.py b/lms/djangoapps/verify_student/apps.py index 1cc499f4972f..3db6b4f91681 100644 --- a/lms/djangoapps/verify_student/apps.py +++ b/lms/djangoapps/verify_student/apps.py @@ -17,5 +17,8 @@ def ready(self): """ Connect signal handlers. """ - from lms.djangoapps.verify_student.signals import handlers, signals # pylint: disable=unused-import - from lms.djangoapps.verify_student import tasks # pylint: disable=unused-import + from lms.djangoapps.verify_student import tasks # pylint: disable=unused-import # noqa: F401 + from lms.djangoapps.verify_student.signals import ( # pylint: disable=unused-import # noqa: F401 + handlers, + signals, + ) diff --git a/lms/djangoapps/verify_student/image.py b/lms/djangoapps/verify_student/image.py index 597c74b915a6..59c2366f0094 100644 --- a/lms/djangoapps/verify_student/image.py +++ b/lms/djangoapps/verify_student/image.py @@ -13,7 +13,7 @@ class InvalidImageData(Exception): """ The provided image data could not be decoded. """ - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass def decode_image_data(data): @@ -34,4 +34,4 @@ def decode_image_data(data): return base64.b64decode(data.split(",")[1]) except (IndexError, UnicodeEncodeError): log.exception("Could not decode image data") - raise InvalidImageData # lint-amnesty, pylint: disable=raise-missing-from + raise InvalidImageData # pylint: disable=raise-missing-from # noqa: B904 diff --git a/lms/djangoapps/verify_student/management/commands/approve_id_verifications.py b/lms/djangoapps/verify_student/management/commands/approve_id_verifications.py index 4c45f415cf63..a0e55a9499ac 100644 --- a/lms/djangoapps/verify_student/management/commands/approve_id_verifications.py +++ b/lms/djangoapps/verify_student/management/commands/approve_id_verifications.py @@ -16,7 +16,6 @@ from lms.djangoapps.verify_student.utils import earliest_allowed_verification_date from openedx.features.name_affirmation_api.utils import get_name_affirmation_service - log = logging.getLogger(__name__) @@ -76,7 +75,7 @@ def handle(self, *args, **options): ) if failed_user_ids: - log.error('Completed ID verification approvals. {} of {} failed.'.format( + log.error('Completed ID verification approvals. {} of {} failed.'.format( # noqa: UP032 len(failed_user_ids), total_users, )) diff --git a/lms/djangoapps/verify_student/management/commands/backfill_sso_verifications_for_old_account_links.py b/lms/djangoapps/verify_student/management/commands/backfill_sso_verifications_for_old_account_links.py index e50c67d11d1f..b1ef7f1027b0 100644 --- a/lms/djangoapps/verify_student/management/commands/backfill_sso_verifications_for_old_account_links.py +++ b/lms/djangoapps/verify_student/management/commands/backfill_sso_verifications_for_old_account_links.py @@ -48,8 +48,8 @@ def handle(self, *args, **options): try: provider = Registry.get(provider_slug) - except ValueError as e: # lint-amnesty, pylint: disable=unused-variable - raise CommandError(f'provider slug {provider_slug} does not exist') # lint-amnesty, pylint: disable=raise-missing-from + except ValueError as e: # pylint: disable=unused-variable # noqa: F841 + raise CommandError(f'provider slug {provider_slug} does not exist') # pylint: disable=raise-missing-from # noqa: B904 query_set = UserSocialAuth.objects.select_related('user__profile') query_set = filter_user_social_auth_queryset_by_provider(query_set, provider) diff --git a/lms/djangoapps/verify_student/management/commands/manual_verifications.py b/lms/djangoapps/verify_student/management/commands/manual_verifications.py index d73a49b7429e..bb84fabb2713 100644 --- a/lms/djangoapps/verify_student/management/commands/manual_verifications.py +++ b/lms/djangoapps/verify_student/management/commands/manual_verifications.py @@ -7,7 +7,7 @@ import os from pprint import pformat -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.core.management.base import BaseCommand, CommandError from lms.djangoapps.verify_student.models import ManualVerification @@ -66,7 +66,7 @@ def handle(self, *args, **options): total_emails, failed_emails = self._generate_manual_verification_from_file(email_ids_file, batch_size) if failed_emails: - log.error('Completed manual verification. {} of {} failed.'.format( + log.error('Completed manual verification. {} of {} failed.'.format( # noqa: UP032 len(failed_emails), total_emails )) diff --git a/lms/djangoapps/verify_student/management/commands/retry_failed_photo_verifications.py b/lms/djangoapps/verify_student/management/commands/retry_failed_photo_verifications.py index c8e589a1af7f..a03c2c66df1f 100644 --- a/lms/djangoapps/verify_student/management/commands/retry_failed_photo_verifications.py +++ b/lms/djangoapps/verify_student/management/commands/retry_failed_photo_verifications.py @@ -2,9 +2,9 @@ Django admin commands related to verify_student """ -from datetime import datetime import logging import time +from datetime import datetime from django.core.management.base import BaseCommand diff --git a/lms/djangoapps/verify_student/management/commands/send_verification_expiry_email.py b/lms/djangoapps/verify_student/management/commands/send_verification_expiry_email.py index 0bfef6d0ac91..20a741ac5019 100644 --- a/lms/djangoapps/verify_student/management/commands/send_verification_expiry_email.py +++ b/lms/djangoapps/verify_student/management/commands/send_verification_expiry_email.py @@ -8,20 +8,22 @@ from datetime import timedelta from django.conf import settings -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user, wrong-import-order +from django.contrib.auth.models import User # pylint: disable=imported-auth-user, wrong-import-order +from django.contrib.sites.models import Site # pylint: disable=wrong-import-order +from django.core.management.base import BaseCommand, CommandError # pylint: disable=wrong-import-order +from django.db.models import Q # pylint: disable=wrong-import-order +from django.utils.timezone import now # pylint: disable=wrong-import-order +from edx_ace import ace # pylint: disable=wrong-import-order +from edx_ace.recipient import Recipient # pylint: disable=wrong-import-order + from common.djangoapps.course_modes.models import CourseMode -from django.contrib.sites.models import Site # lint-amnesty, pylint: disable=wrong-import-order -from django.core.management.base import BaseCommand, CommandError # lint-amnesty, pylint: disable=wrong-import-order -from django.db.models import Q # lint-amnesty, pylint: disable=wrong-import-order -from django.utils.timezone import now # lint-amnesty, pylint: disable=wrong-import-order -from edx_ace import ace # lint-amnesty, pylint: disable=wrong-import-order -from edx_ace.recipient import Recipient # lint-amnesty, pylint: disable=wrong-import-order from common.djangoapps.student.models import CourseEnrollment from common.djangoapps.util.query import use_read_replica_if_available from lms.djangoapps.verify_student.message_types import VerificationExpiry from lms.djangoapps.verify_student.models import ManualVerification, SoftwareSecurePhotoVerification, SSOVerification from openedx.core.djangoapps.ace_common.template_context import get_base_template_context from openedx.core.djangoapps.lang_pref import LANGUAGE_KEY +from openedx.core.djangoapps.site_configuration import helpers as configuration_helpers from openedx.core.djangoapps.user_api.preferences.api import get_user_preference from openedx.core.lib.celery.task_utils import emulate_http_request @@ -112,11 +114,11 @@ def handle(self, *args, **options): total_verification = sspv.count() if not total_verification: - logger.info("No approved expired entries found in SoftwareSecurePhotoVerification for the " + logger.info("No approved expired entries found in SoftwareSecurePhotoVerification for the " # noqa: UP032 "date range {} - {}".format(start_date.date(), now().date())) return - logger.info("For the date range {} - {}, total Software Secure Photo verification filtered are {}" + logger.info("For the date range {} - {}, total Software Secure Photo verification filtered are {}" # noqa: UP032 # pylint: disable=line-too-long .format(start_date.date(), now().date(), total_verification)) batch_verifications = [] @@ -182,13 +184,19 @@ def send_verification_expiry_email(self, batch_verifications, email_config): """ if email_config['dry_run']: logger.info( - "This was a dry run, no email was sent. For the actual run email would have been sent " + "This was a dry run, no email was sent. For the actual run email would have been sent " # noqa: UP032 "to {} learner(s)".format(len(batch_verifications)) ) return True site = Site.objects.get_current() - account_base_url = (settings.ACCOUNT_MICROFRONTEND_URL or "").rstrip('/') + account_base_url = ( + configuration_helpers.get_value( + 'ACCOUNT_MICROFRONTEND_URL', + settings.ACCOUNT_MICROFRONTEND_URL, + ) or + "" + ).rstrip('/') message_context = get_base_template_context(site) message_context.update({ 'platform_name': settings.PLATFORM_NAME, diff --git a/lms/djangoapps/verify_student/management/commands/tests/test_approve_id_verifications.py b/lms/djangoapps/verify_student/management/commands/tests/test_approve_id_verifications.py index 6eccee194795..935178209db3 100644 --- a/lms/djangoapps/verify_student/management/commands/tests/test_approve_id_verifications.py +++ b/lms/djangoapps/verify_student/management/commands/tests/test_approve_id_verifications.py @@ -1,14 +1,14 @@ -""" # lint-amnesty, pylint: disable=cyclic-import +""" # pylint: disable=cyclic-import Tests for django admin commands in the verify_student module """ -import ddt import logging import os import tempfile from unittest import skipUnless from unittest.mock import MagicMock, patch +import ddt import pytest from django.core import mail from django.core.management import CommandError, call_command diff --git a/lms/djangoapps/verify_student/management/commands/tests/test_backfill_sso_verifications_for_old_account_links.py b/lms/djangoapps/verify_student/management/commands/tests/test_backfill_sso_verifications_for_old_account_links.py index d9f356758dd8..84c2be1e6ed7 100644 --- a/lms/djangoapps/verify_student/management/commands/tests/test_backfill_sso_verifications_for_old_account_links.py +++ b/lms/djangoapps/verify_student/management/commands/tests/test_backfill_sso_verifications_for_old_account_links.py @@ -55,7 +55,7 @@ def test_performance(self): def test_signal_called(self): with patch('openedx.core.djangoapps.signals.signals.LEARNER_SSO_VERIFIED.send_robust') as mock_signal: - call_command('backfill_sso_verifications_for_old_account_links', '--provider-slug', self.provider.provider_id) # lint-amnesty, pylint: disable=line-too-long + call_command('backfill_sso_verifications_for_old_account_links', '--provider-slug', self.provider.provider_id) # pylint: disable=line-too-long assert mock_signal.call_count == 1 def test_fine_with_multiple_verification_records(self): diff --git a/lms/djangoapps/verify_student/management/commands/tests/test_manual_verify_student.py b/lms/djangoapps/verify_student/management/commands/tests/test_manual_verify_student.py index 704a66dc7bfe..5cbcb353614c 100644 --- a/lms/djangoapps/verify_student/management/commands/tests/test_manual_verify_student.py +++ b/lms/djangoapps/verify_student/management/commands/tests/test_manual_verify_student.py @@ -1,4 +1,4 @@ -""" # lint-amnesty, pylint: disable=cyclic-import +""" # pylint: disable=cyclic-import Tests for django admin commands in the verify_student module """ @@ -77,7 +77,7 @@ def test_manual_verifications_created_date(self): created_at__gte=earliest_allowed_verification_date() ) - self.assertEqual(list(map(repr, verification1)), list(map(repr, verification2))) + self.assertEqual(list(map(repr, verification1)), list(map(repr, verification2))) # noqa: PT009 def test_user_doesnot_exist_log(self): """ diff --git a/lms/djangoapps/verify_student/management/commands/tests/test_retry_failed_photo_verifications.py b/lms/djangoapps/verify_student/management/commands/tests/test_retry_failed_photo_verifications.py index 8fa84efe3a85..b921789c899b 100644 --- a/lms/djangoapps/verify_student/management/commands/tests/test_retry_failed_photo_verifications.py +++ b/lms/djangoapps/verify_student/management/commands/tests/test_retry_failed_photo_verifications.py @@ -4,21 +4,21 @@ Lots of imports from verify_student's model tests, since they cover similar ground """ -from freezegun import freeze_time -from unittest.mock import call, patch, ANY +from unittest.mock import ANY, call, patch from django.conf import settings from django.core.management import call_command +from django.test.utils import override_settings +from freezegun import freeze_time from testfixtures import LogCapture -from django.test.utils import override_settings from common.test.utils import MockS3Boto3Mixin from lms.djangoapps.verify_student.models import SoftwareSecurePhotoVerification, SSPVerificationRetryConfig from lms.djangoapps.verify_student.tests import TestVerificationBase from lms.djangoapps.verify_student.tests.test_models import ( FAKE_SETTINGS, mock_software_secure_post, - mock_software_secure_post_error + mock_software_secure_post_error, ) LOGGER_NAME = 'retry_photo_verification' @@ -163,5 +163,5 @@ def test_resubmit_in_date_range(self, send_idv_update_mock): photo_id_name=ANY, full_name=ANY ), ] - self.assertEqual(send_idv_update_mock.call_count, 8) + self.assertEqual(send_idv_update_mock.call_count, 8) # noqa: PT009 send_idv_update_mock.assert_has_calls(expected_calls, any_order=True) diff --git a/lms/djangoapps/verify_student/management/commands/tests/test_send_verification_expiry_email.py b/lms/djangoapps/verify_student/management/commands/tests/test_send_verification_expiry_email.py index 874051c0c8d2..b3ae087c8f5b 100644 --- a/lms/djangoapps/verify_student/management/commands/tests/test_send_verification_expiry_email.py +++ b/lms/djangoapps/verify_student/management/commands/tests/test_send_verification_expiry_email.py @@ -3,6 +3,7 @@ """ +from contextlib import nullcontext from datetime import timedelta from unittest.mock import patch @@ -184,7 +185,7 @@ def test_no_verification_found(self): call_command('send_verification_expiry_email') logger.check( (LOGGER_NAME, - 'INFO', "No approved expired entries found in SoftwareSecurePhotoVerification for the " + 'INFO', "No approved expired entries found in SoftwareSecurePhotoVerification for the " # noqa: UP032 "date range {} - {}".format(start_date.date(), now().date())) ) @@ -206,12 +207,12 @@ def test_dry_run_flag(self): logger.check( (LOGGER_NAME, 'INFO', - "For the date range {} - {}, total Software Secure Photo verification filtered are {}" + "For the date range {} - {}, total Software Secure Photo verification filtered are {}" # noqa: UP032 .format(start_date.date(), now().date(), count) ), (LOGGER_NAME, 'INFO', - "This was a dry run, no email was sent. For the actual run email would have been sent " + "This was a dry run, no email was sent. For the actual run email would have been sent " # noqa: UP032 "to {} learner(s)".format(count) )) assert len(mail.outbox) == 0 @@ -271,7 +272,7 @@ def test_number_of_emails_sent(self): def test_command_error(self): err_string = "DEFAULT_EMAILS must be a positive integer. If you do not wish to send " \ "emails use --dry-run flag instead." - with self.assertRaisesRegex(CommandError, err_string): + with self.assertRaisesRegex(CommandError, err_string): # noqa: PT027 call_command('send_verification_expiry_email') def test_one_failed_but_others_succeeded(self): @@ -289,7 +290,7 @@ def test_one_failed_but_others_succeeded(self): with patch('lms.djangoapps.verify_student.management.commands.send_verification_expiry_email.ace') as mock_ace: mock_ace.send.side_effect = (Exception('Aw shucks'), None) - with self.assertRaisesRegex(CommandError, 'One or more email attempts failed.*'): + with self.assertRaisesRegex(CommandError, 'One or more email attempts failed.*'): # noqa: PT027 with LogCapture(LOGGER_NAME) as logger: call_command('send_verification_expiry_email') @@ -302,3 +303,68 @@ def test_one_failed_but_others_succeeded(self): assert verifications[0].expiry_email_date is None assert verifications[1].expiry_email_date is not None assert mock_ace.send.call_count == 2 + + def _run_cmd_and_get_verification_link(self, get_value_side_effect, *, fallback=None): + """ + Create one expired, approved verification; run the command with patches; + return the lms_verification_link computed in the message context. + """ + self.create_expired_software_secure_photo_verification() + + captured_contexts = [] + + class FakeVerificationExpiry: + """Mock message class capturing context for verification expiry tests.""" + def __init__(self, context): + captured_contexts.append(context) + + def personalize(self, recipient, language=None, user_context=None): + return object() + + settings_ctx = ( + override_settings(ACCOUNT_MICROFRONTEND_URL=fallback) + if fallback is not None else + nullcontext() + ) + + module = ( + "lms.djangoapps.verify_student.management.commands." + "send_verification_expiry_email" + ) + + with ( + settings_ctx, + patch(f"{module}.VerificationExpiry", new=FakeVerificationExpiry), + patch(f"{module}.ace.send") as mock_send, + patch( + f"{module}.configuration_helpers.get_value", + side_effect=get_value_side_effect, + ), + ): + call_command("send_verification_expiry_email") + assert mock_send.called, "Expected at least one email to be sent" + assert captured_contexts, ("VerificationExpiry(context=...) should have been called") + + return captured_contexts[0]["lms_verification_link"] + + def test_account_mfe_link_uses_site_config_value(self): + """Test verification link uses site-configured ACCOUNT_MICROFRONTEND_URL.""" + siteconf_url = "https://accounts.siteconf.example/" + + link = self._run_cmd_and_get_verification_link( + get_value_side_effect=lambda key, default=None, *a, **k: + siteconf_url if key == "ACCOUNT_MICROFRONTEND_URL" else default + ) + + assert link == "https://accounts.siteconf.example/id-verification" + + def test_account_mfe_link_falls_back_to_settings(self): + """Test verification link falls back to settings when site config is absent.""" + fallback = "https://accounts.settings.example/" + + link = self._run_cmd_and_get_verification_link( + get_value_side_effect=lambda key, default=None, *a, **k: default, + fallback=fallback, + ) + + assert link == "https://accounts.settings.example/id-verification" diff --git a/lms/djangoapps/verify_student/management/commands/tests/test_trigger_softwaresecurephotoverifications_post_save_signal.py b/lms/djangoapps/verify_student/management/commands/tests/test_trigger_softwaresecurephotoverifications_post_save_signal.py index c9e98a94dec0..1960fa9ff2d4 100644 --- a/lms/djangoapps/verify_student/management/commands/tests/test_trigger_softwaresecurephotoverifications_post_save_signal.py +++ b/lms/djangoapps/verify_student/management/commands/tests/test_trigger_softwaresecurephotoverifications_post_save_signal.py @@ -4,18 +4,15 @@ """ +from unittest.mock import ANY, call, patch # pylint: disable=wrong-import-order + from django.conf import settings from django.core.management import call_command - from freezegun import freeze_time -from unittest.mock import call, patch, ANY # lint-amnesty, pylint: disable=wrong-import-order from common.test.utils import MockS3Boto3Mixin from lms.djangoapps.verify_student.tests import TestVerificationBase -from lms.djangoapps.verify_student.tests.test_models import ( - FAKE_SETTINGS, - mock_software_secure_post, -) +from lms.djangoapps.verify_student.tests.test_models import FAKE_SETTINGS, mock_software_secure_post # Lots of patching to stub in our own settings, and HTTP posting @@ -69,5 +66,5 @@ def test_command(self, send_idv_update_mock): ), ] print(send_idv_update_mock.mock_calls) - self.assertEqual(send_idv_update_mock.call_count, 4) + self.assertEqual(send_idv_update_mock.call_count, 4) # noqa: PT009 send_idv_update_mock.assert_has_calls(expected_calls, any_order=True) diff --git a/lms/djangoapps/verify_student/message_types.py b/lms/djangoapps/verify_student/message_types.py index 12f1e790c88e..6a7f9ab9f57e 100644 --- a/lms/djangoapps/verify_student/message_types.py +++ b/lms/djangoapps/verify_student/message_types.py @@ -16,7 +16,7 @@ def __init__(self, *args, **kwargs): self.options['transactional'] = True -class VerificationExpiry(BaseMessageType): # lint-amnesty, pylint: disable=missing-class-docstring +class VerificationExpiry(BaseMessageType): # pylint: disable=missing-class-docstring APP_LABEL = 'verify_student' Name = 'verificationexpiry' diff --git a/lms/djangoapps/verify_student/migrations/0012_sspverificationretryconfig.py b/lms/djangoapps/verify_student/migrations/0012_sspverificationretryconfig.py index b4f042bdaef5..e73b69b77564 100644 --- a/lms/djangoapps/verify_student/migrations/0012_sspverificationretryconfig.py +++ b/lms/djangoapps/verify_student/migrations/0012_sspverificationretryconfig.py @@ -1,9 +1,9 @@ # Generated by Django 1.11.26 on 2019-12-10 11:19 +import django.db.models.deletion from django.conf import settings from django.db import migrations, models -import django.db.models.deletion class Migration(migrations.Migration): diff --git a/lms/djangoapps/verify_student/migrations/0013_add_expiration_date_field.py b/lms/djangoapps/verify_student/migrations/0013_add_expiration_date_field.py index cbacb9bb76e6..e0c39f3558fd 100644 --- a/lms/djangoapps/verify_student/migrations/0013_add_expiration_date_field.py +++ b/lms/djangoapps/verify_student/migrations/0013_add_expiration_date_field.py @@ -1,6 +1,7 @@ # Generated by Django 2.2.16 on 2020-11-06 21:29 from django.db import migrations, models + import lms.djangoapps.verify_student.models diff --git a/lms/djangoapps/verify_student/migrations/0015_verificationattempt.py b/lms/djangoapps/verify_student/migrations/0015_verificationattempt.py index 3f01047f9f51..6d67f61b1be5 100644 --- a/lms/djangoapps/verify_student/migrations/0015_verificationattempt.py +++ b/lms/djangoapps/verify_student/migrations/0015_verificationattempt.py @@ -1,10 +1,10 @@ # Generated by Django 4.2.15 on 2024-08-26 14:05 -from django.conf import settings -from django.db import migrations, models import django.db.models.deletion import django.utils.timezone import model_utils.fields +from django.conf import settings +from django.db import migrations, models class Migration(migrations.Migration): diff --git a/lms/djangoapps/verify_student/migrations/0016_remove_verificationattempt_created_and_more.py b/lms/djangoapps/verify_student/migrations/0016_remove_verificationattempt_created_and_more.py index d972dba3dbbd..c57a187dd83f 100644 --- a/lms/djangoapps/verify_student/migrations/0016_remove_verificationattempt_created_and_more.py +++ b/lms/djangoapps/verify_student/migrations/0016_remove_verificationattempt_created_and_more.py @@ -1,9 +1,10 @@ # Generated by Django 4.2.15 on 2024-09-26 20:08 -from django.db import migrations, models import django.utils.timezone -import lms.djangoapps.verify_student.statuses import model_utils.fields +from django.db import migrations, models + +import lms.djangoapps.verify_student.statuses class Migration(migrations.Migration): diff --git a/lms/djangoapps/verify_student/models.py b/lms/djangoapps/verify_student/models.py index cee18ca8d35d..64ea239215df 100644 --- a/lms/djangoapps/verify_student/models.py +++ b/lms/djangoapps/verify_student/models.py @@ -15,36 +15,33 @@ import logging import os.path import uuid - from datetime import timedelta from email.utils import formatdate - import requests from config_models.models import ConfigurationModel from django.conf import settings -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.core.files.base import ContentFile from django.db import models, transaction from django.urls import reverse - from django.utils.functional import cached_property from django.utils.timezone import now from django.utils.translation import gettext_lazy from model_utils import Choices from model_utils.models import StatusModel, TimeStampedModel -from lms.djangoapps.verify_student.statuses import VerificationAttemptStatus from opaque_keys.edx.django.models import CourseKeyField +from common.djangoapps.util.storage import resolve_storage_backend from lms.djangoapps.verify_student.ssencrypt import ( decode_and_decrypt, encrypt_and_encode, generate_signed_message, random_aes_key, rsa_decrypt, - rsa_encrypt + rsa_encrypt, ) -from common.djangoapps.util.storage import resolve_storage_backend +from lms.djangoapps.verify_student.statuses import VerificationAttemptStatus from openedx.core.djangoapps.signals.signals import LEARNER_SSO_VERIFIED, PHOTO_VERIFICATION_APPROVED from .utils import auto_verify_for_testing_enabled, earliest_allowed_verification_date, submit_request_to_ss @@ -83,7 +80,7 @@ def decorator_func(func): @functools.wraps(func) def with_status_check(obj, *args, **kwargs): if obj.status not in valid_start_statuses: - exception_msg = ( + exception_msg = ( # noqa: UP032 "Error calling {} {}: status is '{}', must be one of: {}" ).format(func, obj, obj.status, valid_start_statuses) raise VerificationException(exception_msg) @@ -116,7 +113,7 @@ class IDVerificationAttempt(StatusModel): created_at = models.DateTimeField(auto_now_add=True, db_index=True) updated_at = models.DateTimeField(auto_now=True, db_index=True) - def expiration_default(): # lint-amnesty, pylint: disable=no-method-argument + def expiration_default(): # pylint: disable=no-method-argument return now() + timedelta(days=settings.VERIFY_STUDENT["DAYS_GOOD_FOR"]) # Datetime that the verification will expire. @@ -183,7 +180,7 @@ class Meta: app_label = 'verify_student' def __str__(self): - return 'ManualIDVerification for {name}, status: {status}'.format( + return 'ManualIDVerification for {name}, status: {status}'.format( # noqa: UP032 name=self.name, status=self.status, ) @@ -233,7 +230,7 @@ class Meta: app_label = "verify_student" def __str__(self): - return 'SSOIDVerification for {name}, status: {status}'.format( + return 'SSOIDVerification for {name}, status: {status}'.format( # noqa: UP032 name=self.name, status=self.status, ) @@ -246,7 +243,7 @@ def send_approval_signal(self, approved_by='None'): """ Send a signal indicating that this verification was approved. """ - log.info("Verification for user '{user_id}' approved by '{reviewer}' SSO.".format( + log.info("Verification for user '{user_id}' approved by '{reviewer}' SSO.".format( # noqa: UP032 user_id=self.user, reviewer=approved_by )) @@ -441,7 +438,7 @@ def approve(self, user_id=None, service=""): if self.status == self.STATUS.approved: return - log.info("Verification for user '{user_id}' approved by '{reviewer}'.".format( + log.info("Verification for user '{user_id}' approved by '{reviewer}'.".format( # noqa: UP032 user_id=self.user, reviewer=user_id )) self.error_msg = "" # reset, in case this attempt was denied before @@ -544,7 +541,7 @@ def deny(self, lets you amend the error message in case there were additional details to be made. """ - log.info("Verification for user '{user_id}' denied by '{reviewer}'.".format( + log.info("Verification for user '{user_id}' denied by '{reviewer}'.".format( # noqa: UP032 user_id=self.user, reviewer=reviewing_user )) self.error_msg = error_msg @@ -1064,7 +1061,7 @@ def update_expiry_email_date_for_user(cls, user, email_config): verification = SoftwareSecurePhotoVerification.get_recent_verification(user) - if verification and verification.expiration_datetime < recently_expired_date and not verification.expiry_email_date: # lint-amnesty, pylint: disable=line-too-long + if verification and verification.expiration_datetime < recently_expired_date and not verification.expiry_email_date: # pylint: disable=line-too-long expiry_email_date = today - timedelta(days=email_config['RESEND_DAYS']) SoftwareSecurePhotoVerification.objects.filter(pk=verification.pk).update( expiry_email_date=expiry_email_date) @@ -1091,7 +1088,6 @@ class Meta: app_label = "verify_student" course_key = CourseKeyField( - max_length=255, db_index=True, unique=True, help_text=gettext_lazy("The course for which this deadline applies"), diff --git a/lms/djangoapps/verify_student/services.py b/lms/djangoapps/verify_student/services.py index 5caede3dab83..3eabc35cd999 100644 --- a/lms/djangoapps/verify_student/services.py +++ b/lms/djangoapps/verify_student/services.py @@ -251,7 +251,13 @@ def get_verify_location(cls, course_id=None): Returns a string: Returns URL for IDV on Account Microfrontend """ - account_base_url = (settings.ACCOUNT_MICROFRONTEND_URL or "").rstrip('/') + account_base_url = ( + configuration_helpers.get_value( + 'ACCOUNT_MICROFRONTEND_URL', + settings.ACCOUNT_MICROFRONTEND_URL, + ) or + "" + ).rstrip('/') location = f'{account_base_url}/id-verification' if course_id: location += f'?course_id={quote(str(course_id))}' diff --git a/lms/djangoapps/verify_student/signals/handlers.py b/lms/djangoapps/verify_student/signals/handlers.py index 8a1d7b542b00..f5c6c8e588ff 100644 --- a/lms/djangoapps/verify_student/signals/handlers.py +++ b/lms/djangoapps/verify_student/signals/handlers.py @@ -6,18 +6,17 @@ from django.core.exceptions import ObjectDoesNotExist from django.db.models.signals import post_save from django.dispatch.dispatcher import receiver -from xmodule.modulestore.django import SignalHandler, modulestore from common.djangoapps.student.models_api import get_name, get_pending_name_change -from lms.djangoapps.verify_student.apps import VerifyStudentConfig # pylint: disable=unused-import -from lms.djangoapps.verify_student.signals.signals import idv_update_signal -from openedx.core.djangoapps.user_api.accounts.signals import USER_RETIRE_LMS_CRITICAL, USER_RETIRE_LMS_MISC - +from lms.djangoapps.verify_student.apps import VerifyStudentConfig # pylint: disable=unused-import # noqa: F401 from lms.djangoapps.verify_student.models import ( SoftwareSecurePhotoVerification, + VerificationAttempt, VerificationDeadline, - VerificationAttempt ) +from lms.djangoapps.verify_student.signals.signals import idv_update_signal +from openedx.core.djangoapps.user_api.accounts.signals import USER_RETIRE_LMS_CRITICAL, USER_RETIRE_LMS_MISC +from xmodule.modulestore.django import SignalHandler, modulestore log = logging.getLogger(__name__) @@ -60,7 +59,7 @@ def send_idv_update(sender, instance, **kwargs): # pylint: disable=unused-argum full_name = get_name(instance.user.id) log.info( - 'IDV sending name_affirmation task (idv_id={idv_id}, user_id={user_id}) to update status={status}'.format( + 'IDV sending name_affirmation task (idv_id={idv_id}, user_id={user_id}) to update status={status}'.format( # noqa: UP032 # pylint: disable=line-too-long user_id=instance.user.id, status=instance.status, idv_id=instance.id diff --git a/lms/djangoapps/verify_student/signals/signals.py b/lms/djangoapps/verify_student/signals/signals.py index 9fe47467c983..68b2ff6d8893 100644 --- a/lms/djangoapps/verify_student/signals/signals.py +++ b/lms/djangoapps/verify_student/signals/signals.py @@ -3,13 +3,12 @@ """ from django.dispatch import Signal - from openedx_events.learning.data import UserData, UserPersonalData, VerificationAttemptData from openedx_events.learning.signals import ( - IDV_ATTEMPT_CREATED, - IDV_ATTEMPT_PENDING, IDV_ATTEMPT_APPROVED, + IDV_ATTEMPT_CREATED, IDV_ATTEMPT_DENIED, + IDV_ATTEMPT_PENDING, ) # Signal for emitting IDV submission and review updates diff --git a/lms/djangoapps/verify_student/tasks.py b/lms/djangoapps/verify_student/tasks.py index 182f8027a58c..ca0548cdd082 100644 --- a/lms/djangoapps/verify_student/tasks.py +++ b/lms/djangoapps/verify_student/tasks.py @@ -19,7 +19,7 @@ log = logging.getLogger(__name__) -class BaseSoftwareSecureTask(Task): # lint-amnesty, pylint: disable=abstract-method +class BaseSoftwareSecureTask(Task): # pylint: disable=abstract-method """ Base task class for use with Software Secure request. diff --git a/lms/djangoapps/verify_student/tests/__init__.py b/lms/djangoapps/verify_student/tests/__init__.py index 015cd354aba7..bdef7db5a4f1 100644 --- a/lms/djangoapps/verify_student/tests/__init__.py +++ b/lms/djangoapps/verify_student/tests/__init__.py @@ -1,9 +1,9 @@ -# lint-amnesty, pylint: disable=missing-module-docstring +# pylint: disable=missing-module-docstring from contextlib import contextmanager from datetime import timedelta from unittest import mock -from django.conf import settings +from django.conf import settings # noqa: F401 from django.db import DEFAULT_DB_ALIAS from django.test import TestCase from django.utils.timezone import now diff --git a/lms/djangoapps/verify_student/tests/factories.py b/lms/djangoapps/verify_student/tests/factories.py index d7eaeaf30211..e1e1648159f2 100644 --- a/lms/djangoapps/verify_student/tests/factories.py +++ b/lms/djangoapps/verify_student/tests/factories.py @@ -17,7 +17,7 @@ class Meta: class SSOVerificationFactory(DjangoModelFactory): - class Meta(): + class Meta(): # noqa: UP039 model = SSOVerification diff --git a/lms/djangoapps/verify_student/tests/test_api.py b/lms/djangoapps/verify_student/tests/test_api.py index 2be7b6580905..abea28e8dbe3 100644 --- a/lms/djangoapps/verify_student/tests/test_api.py +++ b/lms/djangoapps/verify_student/tests/test_api.py @@ -1,9 +1,9 @@ """ Tests of API module. """ +from datetime import datetime, timezone from unittest.mock import patch -from datetime import datetime, timezone import ddt from django.conf import settings from django.core import mail @@ -65,39 +65,39 @@ def setUp(self): user=self.user, name='Tester McTest', status=VerificationAttemptStatus.CREATED, - expiration_datetime=datetime(2024, 12, 31, tzinfo=timezone.utc) + expiration_datetime=datetime(2024, 12, 31, tzinfo=timezone.utc) # noqa: UP017 ) self.attempt.save() @patch('lms.djangoapps.verify_student.api.emit_idv_attempt_created_event') def test_create_verification_attempt(self, mock_created_event): expected_id = 2 - self.assertEqual( + self.assertEqual( # noqa: PT009 create_verification_attempt( user=self.user, name='Tester McTest', status=VerificationAttemptStatus.CREATED, - expiration_datetime=datetime(2024, 12, 31, tzinfo=timezone.utc) + expiration_datetime=datetime(2024, 12, 31, tzinfo=timezone.utc) # noqa: UP017 ), expected_id ) verification_attempt = VerificationAttempt.objects.get(id=expected_id) - self.assertEqual(verification_attempt.user, self.user) - self.assertEqual(verification_attempt.name, 'Tester McTest') - self.assertEqual(verification_attempt.status, VerificationAttemptStatus.CREATED) - self.assertEqual(verification_attempt.expiration_datetime, datetime(2024, 12, 31, tzinfo=timezone.utc)) + self.assertEqual(verification_attempt.user, self.user) # noqa: PT009 + self.assertEqual(verification_attempt.name, 'Tester McTest') # noqa: PT009 + self.assertEqual(verification_attempt.status, VerificationAttemptStatus.CREATED) # noqa: PT009 + self.assertEqual(verification_attempt.expiration_datetime, datetime(2024, 12, 31, tzinfo=timezone.utc)) # noqa: PT009, UP017 # pylint: disable=line-too-long mock_created_event.assert_called_with( attempt_id=verification_attempt.id, user=self.user, status=VerificationAttemptStatus.CREATED, name='Tester McTest', - expiration_date=datetime(2024, 12, 31, tzinfo=timezone.utc), + expiration_date=datetime(2024, 12, 31, tzinfo=timezone.utc), # noqa: UP017 ) def test_create_verification_attempt_no_expiration_datetime(self): expected_id = 2 - self.assertEqual( + self.assertEqual( # noqa: PT009 create_verification_attempt( user=self.user, name='Tester McTest', @@ -107,10 +107,10 @@ def test_create_verification_attempt_no_expiration_datetime(self): ) verification_attempt = VerificationAttempt.objects.get(id=expected_id) - self.assertEqual(verification_attempt.user, self.user) - self.assertEqual(verification_attempt.name, 'Tester McTest') - self.assertEqual(verification_attempt.status, VerificationAttemptStatus.CREATED) - self.assertEqual(verification_attempt.expiration_datetime, None) + self.assertEqual(verification_attempt.user, self.user) # noqa: PT009 + self.assertEqual(verification_attempt.name, 'Tester McTest') # noqa: PT009 + self.assertEqual(verification_attempt.status, VerificationAttemptStatus.CREATED) # noqa: PT009 + self.assertEqual(verification_attempt.expiration_datetime, None) # noqa: PT009 @ddt.ddt @@ -127,14 +127,14 @@ def setUp(self): user=self.user, name='Tester McTest', status=VerificationAttemptStatus.CREATED, - expiration_datetime=datetime(2024, 12, 31, tzinfo=timezone.utc) + expiration_datetime=datetime(2024, 12, 31, tzinfo=timezone.utc) # noqa: UP017 ) self.attempt.save() @ddt.data( - ('Tester McTest', VerificationAttemptStatus.PENDING, datetime(2024, 12, 31, tzinfo=timezone.utc)), - ('Tester McTest2', VerificationAttemptStatus.APPROVED, datetime(2025, 12, 31, tzinfo=timezone.utc)), - ('Tester McTest3', VerificationAttemptStatus.DENIED, datetime(2026, 12, 31, tzinfo=timezone.utc)), + ('Tester McTest', VerificationAttemptStatus.PENDING, datetime(2024, 12, 31, tzinfo=timezone.utc)), # noqa: UP017 # pylint: disable=line-too-long + ('Tester McTest2', VerificationAttemptStatus.APPROVED, datetime(2025, 12, 31, tzinfo=timezone.utc)), # noqa: UP017 # pylint: disable=line-too-long + ('Tester McTest3', VerificationAttemptStatus.DENIED, datetime(2026, 12, 31, tzinfo=timezone.utc)), # noqa: UP017 # pylint: disable=line-too-long ) @ddt.unpack @patch('lms.djangoapps.verify_student.api.emit_idv_attempt_pending_event') @@ -159,10 +159,10 @@ def test_update_verification_attempt( verification_attempt = VerificationAttempt.objects.get(id=self.attempt.id) # Values should change as a result of this update. - self.assertEqual(verification_attempt.user, self.user) - self.assertEqual(verification_attempt.name, name) - self.assertEqual(verification_attempt.status, status) - self.assertEqual(verification_attempt.expiration_datetime, expiration_datetime) + self.assertEqual(verification_attempt.user, self.user) # noqa: PT009 + self.assertEqual(verification_attempt.name, name) # noqa: PT009 + self.assertEqual(verification_attempt.status, status) # noqa: PT009 + self.assertEqual(verification_attempt.expiration_datetime, expiration_datetime) # noqa: PT009 if status == VerificationAttemptStatus.PENDING: mock_pending_event.assert_called_with( @@ -200,13 +200,13 @@ def test_update_verification_attempt_none_values(self): verification_attempt = VerificationAttempt.objects.get(id=self.attempt.id) # Values should not change as a result of the values passed in being None, except for expiration_datetime. - self.assertEqual(verification_attempt.user, self.user) - self.assertEqual(verification_attempt.name, self.attempt.name) - self.assertEqual(verification_attempt.status, self.attempt.status) - self.assertEqual(verification_attempt.expiration_datetime, None) + self.assertEqual(verification_attempt.user, self.user) # noqa: PT009 + self.assertEqual(verification_attempt.name, self.attempt.name) # noqa: PT009 + self.assertEqual(verification_attempt.status, self.attempt.status) # noqa: PT009 + self.assertEqual(verification_attempt.expiration_datetime, None) # noqa: PT009 def test_update_verification_attempt_not_found(self): - self.assertRaises( + self.assertRaises( # noqa: PT027 VerificationAttempt.DoesNotExist, update_verification_attempt, attempt_id=999999, @@ -221,7 +221,7 @@ def test_update_verification_attempt_not_found(self): 'expired', ) def test_update_verification_attempt_invalid(self, status): - self.assertRaises( + self.assertRaises( # noqa: PT027 VerificationAttemptInvalidStatus, update_verification_attempt, attempt_id=self.attempt.id, diff --git a/lms/djangoapps/verify_student/tests/test_fake_software_secure.py b/lms/djangoapps/verify_student/tests/test_fake_software_secure.py index ce5efbdacef5..5b0f750e477f 100644 --- a/lms/djangoapps/verify_student/tests/test_fake_software_secure.py +++ b/lms/djangoapps/verify_student/tests/test_fake_software_secure.py @@ -35,7 +35,7 @@ class SoftwareSecureFakeViewDisabledTest(SoftwareSecureFakeViewTest): 'ENABLE_SOFTWARE_SECURE_FAKE' is not enabled. """ - def setUp(self): # lint-amnesty, pylint: disable=arguments-differ + def setUp(self): # pylint: disable=arguments-differ super().setUp(enable_software_secure_fake=False) def test_get_method_without_enable_feature_flag(self): @@ -56,7 +56,7 @@ class SoftwareSecureFakeViewEnabledTest(SoftwareSecureFakeViewTest): 'ENABLE_SOFTWARE_SECURE_FAKE' is enabled. """ - def setUp(self): # lint-amnesty, pylint: disable=arguments-differ + def setUp(self): # pylint: disable=arguments-differ super().setUp(enable_software_secure_fake=True) def test_get_method_without_logged_in_user(self): diff --git a/lms/djangoapps/verify_student/tests/test_handlers.py b/lms/djangoapps/verify_student/tests/test_handlers.py index 40d80712f19d..31128c5cb2cd 100644 --- a/lms/djangoapps/verify_student/tests/test_handlers.py +++ b/lms/djangoapps/verify_student/tests/test_handlers.py @@ -4,29 +4,31 @@ from datetime import timedelta +from unittest.mock import patch # pylint: disable=wrong-import-order from django.utils.timezone import now -from unittest.mock import patch # lint-amnesty, pylint: disable=wrong-import-order from common.djangoapps.student.models_api import do_name_change_request from common.djangoapps.student.tests.factories import UserFactory from lms.djangoapps.verify_student.models import ( SoftwareSecurePhotoVerification, + VerificationAttempt, VerificationDeadline, - VerificationAttempt ) from lms.djangoapps.verify_student.signals.handlers import ( _listen_for_course_publish, _listen_for_lms_retire, - _listen_for_lms_retire_verification_attempts + _listen_for_lms_retire_verification_attempts, ) from lms.djangoapps.verify_student.tests.factories import ( SoftwareSecurePhotoVerificationFactory, - VerificationAttemptFactory + VerificationAttemptFactory, ) from openedx.core.djangoapps.user_api.accounts.tests.retirement_helpers import fake_completed_retirement -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + ModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order class VerificationDeadlineHandlerTest(ModuleStoreTestCase): @@ -142,7 +144,7 @@ def test_post_save_signal(self, mock_signal): photo_id_image_url=self.photo_id_image_url, photo_id_key=self.photo_id_key ) - self.assertTrue(mock_signal.called) + self.assertTrue(mock_signal.called) # noqa: PT009 mock_signal.assert_called_with( sender='idv_update', attempt_id=attempt.id, @@ -155,7 +157,7 @@ def test_post_save_signal(self, mock_signal): attempt.mark_ready() - self.assertTrue(mock_signal.called) + self.assertTrue(mock_signal.called) # noqa: PT009 mock_signal.assert_called_with( sender='idv_update', attempt_id=attempt.id, @@ -201,10 +203,10 @@ def setUp(self): def test_retirement_signal(self): _listen_for_lms_retire_verification_attempts(sender=self.__class__, user=self.user) - self.assertEqual(len(VerificationAttempt.objects.filter(user=self.user)), 0) - self.assertEqual(len(VerificationAttempt.objects.filter(user=self.other_user)), 1) + self.assertEqual(len(VerificationAttempt.objects.filter(user=self.user)), 0) # noqa: PT009 + self.assertEqual(len(VerificationAttempt.objects.filter(user=self.other_user)), 1) # noqa: PT009 def test_retirement_signal_no_attempts(self): no_attempt_user = UserFactory.create() _listen_for_lms_retire_verification_attempts(sender=self.__class__, user=no_attempt_user) - self.assertEqual(len(VerificationAttempt.objects.all()), 2) + self.assertEqual(len(VerificationAttempt.objects.all()), 2) # noqa: PT009 diff --git a/lms/djangoapps/verify_student/tests/test_integration.py b/lms/djangoapps/verify_student/tests/test_integration.py index cccdf239134e..7ba28159684d 100644 --- a/lms/djangoapps/verify_student/tests/test_integration.py +++ b/lms/djangoapps/verify_student/tests/test_integration.py @@ -7,8 +7,10 @@ from common.djangoapps.course_modes.tests.factories import CourseModeFactory from common.djangoapps.student.models import CourseEnrollment from common.djangoapps.student.tests.factories import UserFactory -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + ModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order from ..services import IDVerificationService diff --git a/lms/djangoapps/verify_student/tests/test_models.py b/lms/djangoapps/verify_student/tests/test_models.py index fb94b28a3ce1..959751ad062f 100644 --- a/lms/djangoapps/verify_student/tests/test_models.py +++ b/lms/djangoapps/verify_student/tests/test_models.py @@ -1,12 +1,12 @@ -# lint-amnesty, pylint: disable=missing-module-docstring +# pylint: disable=missing-module-docstring import base64 from datetime import datetime, timedelta from unittest import mock from unittest.mock import patch -import pytest import ddt +import pytest import requests.exceptions import simplejson as json from django.conf import settings @@ -21,10 +21,12 @@ SoftwareSecurePhotoVerification, SSOVerification, VerificationAttempt, - VerificationException + VerificationException, ) from lms.djangoapps.verify_student.tests import TestVerificationBase -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + ModuleStoreTestCase, # pylint: disable=wrong-import-order +) FAKE_SETTINGS = { "SOFTWARE_SECURE": { @@ -51,7 +53,7 @@ } -def mock_software_secure_post(url, headers=None, data=None, **kwargs): # lint-amnesty, pylint: disable=unused-argument +def mock_software_secure_post(url, headers=None, data=None, **kwargs): # pylint: disable=unused-argument """ Mocks our interface when we post to Software Secure. Does basic assertions on the fields we send over to make sure we're not missing headers or giving @@ -77,7 +79,7 @@ def mock_software_secure_post(url, headers=None, data=None, **kwargs): # lint-a return response -def mock_software_secure_post_error(url, headers=None, data=None, **kwargs): # lint-amnesty, pylint: disable=unused-argument +def mock_software_secure_post_error(url, headers=None, data=None, **kwargs): # pylint: disable=unused-argument """ Simulates what happens if our post to Software Secure is rejected, for whatever reason. @@ -96,7 +98,7 @@ def mock_software_secure_post_unavailable(url, headers=None, data=None, **kwargs @patch.dict(settings.VERIFY_STUDENT, FAKE_SETTINGS) @patch('lms.djangoapps.verify_student.models.requests.post', new=mock_software_secure_post) @ddt.ddt -class TestPhotoVerification(TestVerificationBase, MockS3Boto3Mixin, ModuleStoreTestCase): # lint-amnesty, pylint: disable=missing-class-docstring +class TestPhotoVerification(TestVerificationBase, MockS3Boto3Mixin, ModuleStoreTestCase): # pylint: disable=missing-class-docstring def test_state_transitions(self): """ diff --git a/lms/djangoapps/verify_student/tests/test_services.py b/lms/djangoapps/verify_student/tests/test_services.py index 4bfa8c27d5b3..0acf2103a337 100644 --- a/lms/djangoapps/verify_student/tests/test_services.py +++ b/lms/djangoapps/verify_student/tests/test_services.py @@ -3,8 +3,10 @@ """ import itertools +from contextlib import nullcontext from datetime import datetime, timedelta, timezone from unittest.mock import patch +from urllib.parse import quote import ddt from django.conf import settings @@ -20,13 +22,14 @@ ManualVerification, SoftwareSecurePhotoVerification, SSOVerification, - VerificationAttempt + VerificationAttempt, ) from lms.djangoapps.verify_student.services import IDVerificationService from openedx.core.djangoapps.site_configuration import helpers as configuration_helpers -from xmodule.modulestore.tests.django_utils import \ - ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + ModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order FAKE_SETTINGS = { "DAYS_GOOD_FOR": 365, @@ -204,10 +207,10 @@ def test_get_expiration_datetime(self): user_a = UserFactory.create() SSOVerification.objects.create( - user=user_a, status='approved', expiration_date=datetime(2021, 11, 12, 0, 0, tzinfo=timezone.utc) + user=user_a, status='approved', expiration_date=datetime(2021, 11, 12, 0, 0, tzinfo=timezone.utc) # noqa: UP017 # pylint: disable=line-too-long ) newer_record = SSOVerification.objects.create( - user=user_a, status='approved', expiration_date=datetime(2022, 1, 12, 0, 0, tzinfo=timezone.utc) + user=user_a, status='approved', expiration_date=datetime(2022, 1, 12, 0, 0, tzinfo=timezone.utc) # noqa: UP017 # pylint: disable=line-too-long ) expiration_datetime = IDVerificationService.get_expiration_datetime(user_a, ['approved']) @@ -221,15 +224,98 @@ def test_get_expiration_datetime_mixed_models(self): user = UserFactory.create() SoftwareSecurePhotoVerification.objects.create( - user=user, status='approved', expiration_date=datetime(2021, 11, 12, 0, 0, tzinfo=timezone.utc) + user=user, status='approved', expiration_date=datetime(2021, 11, 12, 0, 0, tzinfo=timezone.utc) # noqa: UP017 # pylint: disable=line-too-long ) newest = VerificationAttempt.objects.create( - user=user, status='approved', expiration_datetime=datetime(2022, 1, 12, 0, 0, tzinfo=timezone.utc) + user=user, status='approved', expiration_datetime=datetime(2022, 1, 12, 0, 0, tzinfo=timezone.utc) # noqa: UP017 # pylint: disable=line-too-long ) expiration_datetime = IDVerificationService.get_expiration_datetime(user, ['approved']) assert expiration_datetime == newest.expiration_datetime + def _get_verify_url_with_config( + self, + *, + get_value_side_effect, + course_id=None, + settings_account_mfe=None, + ): + """ + Build the IDV URL using a patched configuration helper and optional settings override. + Returns the final URL after the (stubbed) filter runs. + """ + settings_ctx = ( + override_settings(ACCOUNT_MICROFRONTEND_URL=settings_account_mfe) + if settings_account_mfe is not None + else nullcontext() + ) + + with settings_ctx: + with patch( + "lms.djangoapps.verify_student.services.configuration_helpers.get_value", + side_effect=get_value_side_effect, + ): + with patch( + "lms.djangoapps.verify_student.services.IDVPageURLRequested.run_filter", + side_effect=lambda url: url, + ): + return IDVerificationService.get_verify_location(course_id) + + def test_get_verify_location_uses_site_config_value(self): + """ + If site config defines ACCOUNT_MICROFRONTEND_URL (with trailing slash), + the base should come from it and the slash should be stripped. + """ + siteconf_url = "https://accounts.siteconf.example/" # trailing slash on purpose + + url = self._get_verify_url_with_config( + get_value_side_effect=lambda key, default=None, *a, **k: + siteconf_url if key == "ACCOUNT_MICROFRONTEND_URL" else default + ) + + assert url == "https://accounts.siteconf.example/id-verification" + + def test_get_verify_location_uses_site_config_value_with_course_id(self): + """ + Same as above, but with a course_id. Ensure proper quoting and base from site config. + """ + course = CourseFactory.create(org='Robot', number='999', display_name='Test Course') + siteconf_url = "https://accounts.siteconf.example/" + + url = self._get_verify_url_with_config( + get_value_side_effect=lambda key, default=None, *a, **k: + siteconf_url if key == "ACCOUNT_MICROFRONTEND_URL" else default, + course_id=course.id, + ) + + expected = f"https://accounts.siteconf.example/id-verification?course_id={quote(str(course.id), safe='')}" + assert url == expected + + def test_get_verify_location_falls_back_to_settings(self): + """ + If site config does not override, fall back to settings.ACCOUNT_MICROFRONTEND_URL + (and strip any trailing slash). + """ + fallback = "https://accounts.settings.example/" # trailing slash on purpose + + url = self._get_verify_url_with_config( + get_value_side_effect=lambda key, default=None, *a, **k: default, + settings_account_mfe=fallback, + ) + + assert url == "https://accounts.settings.example/id-verification" + + def test_get_verify_location_when_site_config_empty(self): + """ + If site config explicitly returns an empty string, we should still produce a valid + absolute path under the LMS domain. + """ + url = self._get_verify_url_with_config( + get_value_side_effect=lambda key, default=None, *a, **k: "" + ) + + assert url == "/id-verification" + @patch.dict(settings.VERIFY_STUDENT, FAKE_SETTINGS) @ddt.ddt @@ -249,7 +335,7 @@ def test_no_verification(self): status = IDVerificationService.user_status(self.user) expected_status = {'status': 'none', 'error': '', 'should_display': True, 'verification_expiry': '', 'status_date': ''} - self.assertDictEqual(status, expected_status) + self.assertDictEqual(status, expected_status) # noqa: PT009 def test_approved_software_secure_verification(self): with freeze_time('2015-01-02'): @@ -258,7 +344,7 @@ def test_approved_software_secure_verification(self): status = IDVerificationService.user_status(self.user) expected_status = {'status': 'approved', 'error': '', 'should_display': True, 'verification_expiry': '', 'status_date': datetime.now(utc)} - self.assertDictEqual(status, expected_status) + self.assertDictEqual(status, expected_status) # noqa: PT009 def test_denied_software_secure_verification(self): with freeze_time('2015-2-02'): @@ -272,7 +358,7 @@ def test_denied_software_secure_verification(self): 'status': 'must_reverify', 'error': ['id_image_missing'], 'should_display': True, 'verification_expiry': '', 'status_date': '', } - self.assertDictEqual(status, expected_status) + self.assertDictEqual(status, expected_status) # noqa: PT009 def test_approved_verification_attempt_verification(self): with freeze_time('2015-01-02'): @@ -281,7 +367,7 @@ def test_approved_verification_attempt_verification(self): status = IDVerificationService.user_status(self.user) expected_status = {'status': 'approved', 'error': '', 'should_display': True, 'verification_expiry': '', 'status_date': datetime.now(utc)} - self.assertDictEqual(status, expected_status) + self.assertDictEqual(status, expected_status) # noqa: PT009 def test_denied_verification_attempt_verification(self): with freeze_time('2015-2-02'): @@ -295,7 +381,7 @@ def test_denied_verification_attempt_verification(self): 'status': 'must_reverify', 'error': '', 'should_display': True, 'verification_expiry': '', 'status_date': '', } - self.assertDictEqual(status, expected_status) + self.assertDictEqual(status, expected_status) # noqa: PT009 def test_approved_sso_verification(self): with freeze_time('2015-03-02'): @@ -304,7 +390,7 @@ def test_approved_sso_verification(self): status = IDVerificationService.user_status(self.user) expected_status = {'status': 'approved', 'error': '', 'should_display': False, 'verification_expiry': '', 'status_date': datetime.now(utc)} - self.assertDictEqual(status, expected_status) + self.assertDictEqual(status, expected_status) # noqa: PT009 def test_denied_sso_verification(self): with freeze_time('2015-04-02'): @@ -316,7 +402,7 @@ def test_denied_sso_verification(self): 'status': 'must_reverify', 'error': '', 'should_display': False, 'verification_expiry': '', 'status_date': '' } - self.assertDictEqual(status, expected_status) + self.assertDictEqual(status, expected_status) # noqa: PT009 def test_manual_verification(self): with freeze_time('2015-05-02'): @@ -325,7 +411,7 @@ def test_manual_verification(self): status = IDVerificationService.user_status(self.user) expected_status = {'status': 'approved', 'error': '', 'should_display': False, 'verification_expiry': '', 'status_date': datetime.now(utc)} - self.assertDictEqual(status, expected_status) + self.assertDictEqual(status, expected_status) # noqa: PT009 @ddt.idata(itertools.product( [SoftwareSecurePhotoVerification, VerificationAttempt], @@ -346,7 +432,7 @@ def test_expiring_software_secure_verification(self, value): expected_status = {'status': 'approved', 'error': '', 'should_display': True, 'verification_expiry': '', 'status_date': status_date} status = IDVerificationService.user_status(self.user) - self.assertDictEqual(status, expected_status) + self.assertDictEqual(status, expected_status) # noqa: PT009 @ddt.data(SoftwareSecurePhotoVerification, VerificationAttempt) def test_expired_verification(self, verification_model): @@ -370,7 +456,7 @@ def test_expired_verification(self, verification_model): 'status_date': '' } status = IDVerificationService.user_status(self.user) - self.assertDictEqual(status, expected_status) + self.assertDictEqual(status, expected_status) # noqa: PT009 @ddt.idata(itertools.product( [SoftwareSecurePhotoVerification, VerificationAttempt], @@ -410,7 +496,7 @@ def test_reverify_after_expired(self, value): expected_status = {'status': check_status, 'error': '', 'should_display': True, 'verification_expiry': '', 'status_date': status_date} status = IDVerificationService.user_status(self.user) - self.assertDictEqual(status, expected_status) + self.assertDictEqual(status, expected_status) # noqa: PT009 @ddt.data( SSOVerification, @@ -439,7 +525,7 @@ def test_override_verification(self, verification_model): 'verification_expiry': '', 'status_date': now() } status = IDVerificationService.user_status(self.user) - self.assertDictEqual(status, expected_status) + self.assertDictEqual(status, expected_status) # noqa: PT009 @ddt.data( SSOVerification, @@ -468,4 +554,4 @@ def test_denied_after_approved_verification(self, verification_model): 'verification_expiry': '', 'status_date': expected_date } status = IDVerificationService.user_status(self.user) - self.assertDictEqual(status, expected_status) + self.assertDictEqual(status, expected_status) # noqa: PT009 diff --git a/lms/djangoapps/verify_student/tests/test_ssencrypt.py b/lms/djangoapps/verify_student/tests/test_ssencrypt.py index ac0f54c1ab0c..73e0e6d748c4 100644 --- a/lms/djangoapps/verify_student/tests/test_ssencrypt.py +++ b/lms/djangoapps/verify_student/tests/test_ssencrypt.py @@ -12,7 +12,7 @@ decode_and_decrypt, encrypt_and_encode, rsa_decrypt, - rsa_encrypt + rsa_encrypt, ) AES_KEY_BYTES = binascii.unhexlify(b'32fe72aaf2abb44de9e161131b5435c8d37cbdb6f5df242ae860b283115f2dae') diff --git a/lms/djangoapps/verify_student/tests/test_tasks.py b/lms/djangoapps/verify_student/tests/test_tasks.py index ec6c9e6ffa51..21b702508fde 100644 --- a/lms/djangoapps/verify_student/tests/test_tasks.py +++ b/lms/djangoapps/verify_student/tests/test_tasks.py @@ -1,4 +1,4 @@ -# lint-amnesty, pylint: disable=missing-module-docstring +# pylint: disable=missing-module-docstring # Lots of patching to stub in our own settings, and HTTP posting from unittest import mock from unittest.mock import patch @@ -9,14 +9,16 @@ from common.test.utils import MockS3Boto3Mixin from lms.djangoapps.verify_student.tests import TestVerificationBase from lms.djangoapps.verify_student.tests.test_models import FAKE_SETTINGS, mock_software_secure_post_unavailable -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + ModuleStoreTestCase, # pylint: disable=wrong-import-order +) LOGGER_NAME = 'lms.djangoapps.verify_student.tasks' @patch.dict(settings.VERIFY_STUDENT, FAKE_SETTINGS) @ddt.ddt -class TestPhotoVerificationTasks(TestVerificationBase, MockS3Boto3Mixin, ModuleStoreTestCase): # lint-amnesty, pylint: disable=missing-class-docstring +class TestPhotoVerificationTasks(TestVerificationBase, MockS3Boto3Mixin, ModuleStoreTestCase): # pylint: disable=missing-class-docstring @mock.patch('lms.djangoapps.verify_student.tasks.log') def test_logs_for_retry_until_failure(self, mock_log): diff --git a/lms/djangoapps/verify_student/tests/test_utils.py b/lms/djangoapps/verify_student/tests/test_utils.py index b2f0edf334cf..6efe040f0285 100644 --- a/lms/djangoapps/verify_student/tests/test_utils.py +++ b/lms/djangoapps/verify_student/tests/test_utils.py @@ -11,14 +11,14 @@ import ddt from django.conf import settings from django.utils import timezone -from pytest import mark +from pytest import mark # noqa: PT013 from common.djangoapps.student.tests.factories import UserFactory from lms.djangoapps.verify_student.models import ManualVerification, SoftwareSecurePhotoVerification, SSOVerification from lms.djangoapps.verify_student.utils import ( most_recent_verification, submit_request_to_ss, - verification_for_datetime + verification_for_datetime, ) FAKE_SETTINGS = { @@ -152,7 +152,7 @@ def test_most_recent_verification( @mock.patch('lms.djangoapps.verify_student.utils.log') @mock.patch( - 'lms.djangoapps.verify_student.tasks.send_request_to_ss_for_user.delay', mock.Mock(side_effect=Exception('error')) # lint-amnesty, pylint: disable=line-too-long + 'lms.djangoapps.verify_student.tasks.send_request_to_ss_for_user.delay', mock.Mock(side_effect=Exception('error')) # pylint: disable=line-too-long ) def test_submit_request_to_ss(self, mock_log): """Tests that we log appropriate information when celery task creation fails.""" diff --git a/lms/djangoapps/verify_student/tests/test_views.py b/lms/djangoapps/verify_student/tests/test_views.py index f3c5fe46ead6..74e8da1fcf97 100644 --- a/lms/djangoapps/verify_student/tests/test_views.py +++ b/lms/djangoapps/verify_student/tests/test_views.py @@ -42,10 +42,12 @@ from openedx.core.djangoapps.embargo.test_utils import restrict_course from openedx.core.djangoapps.theming.tests.test_util import with_comprehensive_theme from openedx.core.djangoapps.user_api.accounts.api import get_account_settings -from xmodule.modulestore import ModuleStoreEnum # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore import ModuleStoreEnum # pylint: disable=wrong-import-order +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + ModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order def mock_render_to_response(*args, **kwargs): @@ -128,7 +130,7 @@ def test_start_new_verification(self): self.client.login(username="rusty", password=TEST_PASSWORD) def must_be_logged_in(self): - self.assertHttpForbidden(self.client.get(self.start_url())) # lint-amnesty, pylint: disable=no-member + self.assertHttpForbidden(self.client.get(self.start_url())) # pylint: disable=no-member @ddt.ddt @@ -858,7 +860,7 @@ def _set_verification_status(self, status): attempt.system_error("Error!") if status == "expired": - days_good_for = settings.VERIFY_STUDENT["DAYS_GOOD_FOR"] # lint-amnesty, pylint: disable=unused-variable + days_good_for = settings.VERIFY_STUDENT["DAYS_GOOD_FOR"] # pylint: disable=unused-variable # noqa: F841 attempt.expiration_date = now() - timedelta(days=1) attempt.save() @@ -1181,7 +1183,7 @@ def make_sku(self): def _get_checkout_args(self, patched_create_order): """ Assuming patched_create_order was called, return a mapping containing the call arguments.""" - return dict(list(zip(('user', 'course_key', 'course_mode', 'processor'), patched_create_order.call_args[0]))) + return dict(list(zip(('user', 'course_key', 'course_mode', 'processor'), patched_create_order.call_args[0]))) # noqa: B905 # pylint: disable=line-too-long class TestCheckoutWithEcommerceService(ModuleStoreTestCase): @@ -1270,7 +1272,7 @@ def test_submit_photos_and_change_name(self, flag_on): # Since we are giving a full name, it should be written into the attempt # whether or not the user name was updated attempt = SoftwareSecurePhotoVerification.objects.get(user=self.user) - self.assertEqual(attempt.name, self.FULL_NAME) + self.assertEqual(attempt.name, self.FULL_NAME) # noqa: PT009 def test_submit_photos_sends_confirmation_email(self): self._submit_photos( @@ -1582,7 +1584,7 @@ def test_wrong_edx_id(self): ) @patch('lms.djangoapps.verify_student.views.log.error') @patch('lms.djangoapps.verify_student.views.segment.track') - def test_passed_status_template(self, mock_segment_track, _mock_log_error): + def test_passed_status_template(self, mock_segment_track, _mock_log_error): # noqa: PT019 """ Test for verification passed. """ @@ -1647,7 +1649,7 @@ def test_approved_email_without_ace(self): ) @patch('lms.djangoapps.verify_student.views.log.error') @patch('lms.djangoapps.verify_student.views.segment.track') - def test_first_time_verification(self, mock_segment_track, _mock_log_error): + def test_first_time_verification(self, mock_segment_track, _mock_log_error): # noqa: PT019 """ Test for verification passed if the learner does not have any previous verification """ @@ -1681,7 +1683,7 @@ def test_first_time_verification(self, mock_segment_track, _mock_log_error): ) @patch('lms.djangoapps.verify_student.views.log.error') @patch('lms.djangoapps.verify_student.views.segment.track') - def test_failed_status_template(self, mock_segment_track, _mock_log_error): + def test_failed_status_template(self, mock_segment_track, _mock_log_error): # noqa: PT019 """ Test for failed verification. """ @@ -1757,6 +1759,73 @@ def test_unknown_result(self): ) self.assertContains(response, 'Result Unknown not understood', status_code=400) + @patch("lms.djangoapps.verify_student.views.send_verification_status_email.delay") + def test_failed_status_reverify_url_uses_site_config_value(self, mock_delay): + """ + When site config defines ACCOUNT_MICROFRONTEND_URL (with a trailing slash), + the reverify_url in the denial email context should use it and strip the slash. + """ + siteconf_url = "https://accounts.siteconf.example/" + access_key = settings.VERIFY_STUDENT["SOFTWARE_SECURE"]["API_ACCESS_KEY"] + + with patch( + "lms.djangoapps.verify_student.views.configuration_helpers.get_value", + side_effect=lambda key, default=None, *a, **k: + siteconf_url if key == "ACCOUNT_MICROFRONTEND_URL" else default, + ): + data = { + "EdX-ID": self.receipt_id, + "Result": "FAIL", + "Reason": [{"photoIdReasons": ["Not provided"]}], + "MessageType": "Your photo doesn't meet standards.", + } + json_data = json.dumps(data) + response = self.client.post( + reverse("verify_student_results_callback"), + data=json_data, + content_type="application/json", + HTTP_AUTHORIZATION=f"test {access_key}:testing", + HTTP_DATE="testdate", + ) + + assert response.status_code == 200 + assert mock_delay.called + context = mock_delay.call_args[0][0] + assert context["email_vars"]["reverify_url"] == "https://accounts.siteconf.example/id-verification" + + @patch("lms.djangoapps.verify_student.views.send_verification_status_email.delay") + def test_failed_status_reverify_url_falls_back_to_settings(self, mock_delay): + """ + If site config doesn't override, reverify_url should come from + settings.ACCOUNT_MICROFRONTEND_URL (with trailing slash stripped). + """ + fallback = "https://accounts.settings.example/" + access_key = settings.VERIFY_STUDENT["SOFTWARE_SECURE"]["API_ACCESS_KEY"] + + with override_settings(ACCOUNT_MICROFRONTEND_URL=fallback), patch( + "lms.djangoapps.verify_student.views.configuration_helpers.get_value", + side_effect=lambda key, default=None, *a, **k: default, + ): + data = { + "EdX-ID": self.receipt_id, + "Result": "FAIL", + "Reason": [{"photoIdReasons": ["Not provided"]}], + "MessageType": "Your photo doesn't meet standards.", + } + json_data = json.dumps(data) + response = self.client.post( + reverse("verify_student_results_callback"), + data=json_data, + content_type="application/json", + HTTP_AUTHORIZATION=f"test {access_key}:testing", + HTTP_DATE="testdate", + ) + + assert response.status_code == 200 + assert mock_delay.called + context = mock_delay.call_args[0][0] + assert context["email_vars"]["reverify_url"] == "https://accounts.settings.example/id-verification" + class TestReverifyView(TestVerificationBase): """ @@ -1886,9 +1955,9 @@ def test_photo_url_view_returns_data(self): assert response.status_code == 200 assert response.data['EdX-ID'] == self.receipt_id assert response.data['PhotoID'] == 'https://{bucket}/photo_id/{receipt_id}'\ - .format(bucket=settings.AWS_S3_CUSTOM_DOMAIN, receipt_id=self.receipt_id) + .format(bucket=settings.AWS_S3_CUSTOM_DOMAIN, receipt_id=self.receipt_id) # noqa: UP032 assert response.data['UserPhoto'] == 'https://{bucket}/face/{receipt_id}'\ - .format(bucket=settings.AWS_S3_CUSTOM_DOMAIN, receipt_id=self.receipt_id) + .format(bucket=settings.AWS_S3_CUSTOM_DOMAIN, receipt_id=self.receipt_id) # noqa: UP032 def test_photo_url_view_returns_404_if_invalid_receipt_id(self): url = reverse('verification_photo_urls', @@ -1980,7 +2049,7 @@ def _decode_image(self, receipt_id, img_type): @ddt.data("face", "photo_id") @patch.object(SoftwareSecurePhotoVerification, '_get_image_from_storage') - def test_download_image_response(self, img_type, _mock_get_storage): + def test_download_image_response(self, img_type, _mock_get_storage): # noqa: PT019 _mock_get_storage.return_value = encrypt_and_encode( b'\xd7m\xf8', codecs.decode(settings.VERIFY_STUDENT["SOFTWARE_SECURE"]["FACE_IMAGE_AES_KEY"], "hex") @@ -2042,7 +2111,7 @@ def test_404_if_invalid_receipt_id(self, img_type): @ddt.data("face", "photo_id") @patch.object(SoftwareSecurePhotoVerification, '_get_image_from_storage') - def test_404_for_decryption_error(self, img_type, _mock_get_storage): + def test_404_for_decryption_error(self, img_type, _mock_get_storage): # noqa: PT019 _mock_get_storage.return_value = None # create verification with no img data attempt = SoftwareSecurePhotoVerification( diff --git a/lms/djangoapps/verify_student/views.py b/lms/djangoapps/verify_student/views.py index deda08e0c741..d19c96e2a24e 100644 --- a/lms/djangoapps/verify_student/views.py +++ b/lms/djangoapps/verify_student/views.py @@ -26,7 +26,6 @@ from requests.exceptions import RequestException from rest_framework.response import Response from rest_framework.views import APIView -from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order from common.djangoapps.course_modes.models import CourseMode from common.djangoapps.edxmako.shortcuts import render_to_response @@ -46,6 +45,7 @@ from openedx.core.djangoapps.embargo import api as embargo_api from openedx.core.djangoapps.site_configuration import helpers as configuration_helpers from openedx.core.lib.log_utils import audit_log +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order from .services import IDVerificationService @@ -195,7 +195,7 @@ def _get_user_active_status(self, user): return user.is_active or is_account_activation_requirement_disabled() @method_decorator(login_required) - def get( # lint-amnesty, pylint: disable=too-many-statements + def get( # pylint: disable=too-many-statements self, request, course_id, always_show_payment=False, current_step=None, @@ -421,7 +421,7 @@ def get( # lint-amnesty, pylint: disable=too-many-statements return render_to_response("verify_student/pay_and_verify.html", context) - def add_utm_params_to_url(self, url): # lint-amnesty, pylint: disable=missing-function-docstring + def add_utm_params_to_url(self, url): # pylint: disable=missing-function-docstring # utm_params is [(u'utm_content', u'course-v1:IDBx IDB20.1x 1T2017'),... utm_params = [item for item in self.request.GET.items() if 'utm_' in item[0]] # utm_params is utm_content=course-v1%3AIDBx+IDB20.1x+1T2017&... @@ -916,7 +916,7 @@ def _validate_parameters(self, request, has_initial_verification): # The face image is always required. if "face_image" not in params: msg = _("Missing required parameter face_image") - log.error(("User {user_id} missing required parameter face_image").format(user_id=request.user.id)) + log.error(("User {user_id} missing required parameter face_image").format(user_id=request.user.id)) # noqa: UP032 # pylint: disable=line-too-long return None, HttpResponseBadRequest(msg) return params, None @@ -942,12 +942,12 @@ def _validate_and_decode_image_data(self, request, face_data, photo_id_data=None data_type = image_data.split(',')[0] if data_type: log.error( - "Image data for user_id={user_id} was uploaded in an unsupported " + "Image data for user_id={user_id} was uploaded in an unsupported " # noqa: UP032 "format: {data_type}".format(user_id=request.user.id, data_type=data_type) ) else: log.error( - "Image data type for user_id={user_id} could not be identified.".format( + "Image data type for user_id={user_id} could not be identified.".format( # noqa: UP032 user_id=request.user.id ) ) @@ -967,7 +967,7 @@ def _validate_and_decode_image_data(self, request, face_data, photo_id_data=None except InvalidImageData: msg = _("Image data is not valid.") - log.error(("Image data for user {user_id} is not valid").format(user_id=request.user.id)) + log.error(("Image data for user {user_id} is not valid").format(user_id=request.user.id)) # noqa: UP032 return None, None, HttpResponseBadRequest(msg) def _submit_attempt(self, user, face_image, photo_id_image=None, initial_verification=None, provided_name=None): @@ -1036,7 +1036,7 @@ def _fire_event(self, user, event_name, parameters): @require_POST @csrf_exempt # SS does its own message signing, and their API won't have a cookie value -def results_callback(request): # lint-amnesty, pylint: disable=too-many-statements +def results_callback(request): # pylint: disable=too-many-statements """ Software Secure will call this callback to tell us whether a user is verified to be who they said they are. @@ -1077,7 +1077,7 @@ def results_callback(request): # lint-amnesty, pylint: disable=too-many-stateme # TODO: These logs must be removed once the investigation in COSMO-184 is complete. # COSMO-196 was created to track the cleanup of these logs. log.info( - "[COSMO-184] Software Secure review received for receipt_id={receipt_id}, " + "[COSMO-184] Software Secure review received for receipt_id={receipt_id}, " # noqa: UP032 "with result={result} and reason={reason}." .format( receipt_id=receipt_id, @@ -1097,13 +1097,13 @@ def results_callback(request): # lint-amnesty, pylint: disable=too-many-stateme 'platform_name': settings.PLATFORM_NAME, } if result == "PASS": - # If this verification is not an outdated version then make expiry email date of previous approved verification NULL # lint-amnesty, pylint: disable=line-too-long + # If this verification is not an outdated version then make expiry email date of previous approved verification NULL # pylint: disable=line-too-long # Setting expiry email date to NULL is important so that it does not get filtered in the management command # that sends email when verification expires : verify_student/send_verification_expiry_email if attempt.status != 'approved': verification = SoftwareSecurePhotoVerification.objects.filter(status='approved', user_id=attempt.user_id) if verification: - log.info(f'Making expiry email date of previous approved verification NULL for {attempt.user_id}') # lint-amnesty, pylint: disable=line-too-long + log.info(f'Making expiry email date of previous approved verification NULL for {attempt.user_id}') # pylint: disable=line-too-long # The updated_at field in sspv model has auto_now set to True, which means any time save() is called on # the model instance, `updated_at` will change. Some of the existing functionality of verification # (showing your verification has expired on dashboard) relies on updated_at. @@ -1116,7 +1116,7 @@ def results_callback(request): # lint-amnesty, pylint: disable=too-many-stateme # TODO: These logs must be removed once the investigation in COSMO-184 is complete. # COSMO-196 was created to track the cleanup of these logs. - log.info("[COSMO-184] Approved verification for receipt_id={receipt_id}.".format(receipt_id=receipt_id)) + log.info("[COSMO-184] Approved verification for receipt_id={receipt_id}.".format(receipt_id=receipt_id)) # noqa: UP032 attempt.approve() send_approval_email(attempt) @@ -1125,10 +1125,16 @@ def results_callback(request): # lint-amnesty, pylint: disable=too-many-stateme # TODO: These logs must be removed once the investigation in COSMO-184 is complete. # COSMO-196 was created to track the cleanup of these logs. - log.info("[COSMO-184] Denied verification for receipt_id={receipt_id}.".format(receipt_id=receipt_id)) + log.info("[COSMO-184] Denied verification for receipt_id={receipt_id}.".format(receipt_id=receipt_id)) # noqa: UP032 attempt.deny(json.dumps(reason), error_code=error_code) - account_base_url = (settings.ACCOUNT_MICROFRONTEND_URL or "").rstrip('/') + account_base_url = ( + configuration_helpers.get_value( + 'ACCOUNT_MICROFRONTEND_URL', + settings.ACCOUNT_MICROFRONTEND_URL, + ) or + "" + ).rstrip('/') reverify_url = f'{account_base_url}/id-verification' verification_status_email_vars['reasons'] = reason verification_status_email_vars['reverify_url'] = reverify_url diff --git a/lms/envs/common.py b/lms/envs/common.py index 34f8db0f54bc..828c7874152b 100644 --- a/lms/envs/common.py +++ b/lms/envs/common.py @@ -43,29 +43,30 @@ import os from corsheaders.defaults import default_headers as corsheaders_default_headers -from path import Path as path from django.utils.translation import gettext_lazy as _ +from edx_django_utils.plugins import add_plugins, get_plugin_apps from enterprise.constants import ( + DEFAULT_ENTERPRISE_ENROLLMENT_INTENTIONS_ROLE, ENTERPRISE_ADMIN_ROLE, - ENTERPRISE_LEARNER_ROLE, ENTERPRISE_CATALOG_ADMIN_ROLE, ENTERPRISE_DASHBOARD_ADMIN_ROLE, ENTERPRISE_ENROLLMENT_API_ADMIN_ROLE, ENTERPRISE_FULFILLMENT_OPERATOR_ROLE, + ENTERPRISE_LEARNER_ROLE, + ENTERPRISE_OPERATOR_ROLE, ENTERPRISE_REPORTING_CONFIG_ADMIN_ROLE, ENTERPRISE_SSO_ORCHESTRATOR_OPERATOR_ROLE, - ENTERPRISE_OPERATOR_ROLE, - SYSTEM_ENTERPRISE_PROVISIONING_ADMIN_ROLE, PROVISIONING_ENTERPRISE_CUSTOMER_ADMIN_ROLE, PROVISIONING_PENDING_ENTERPRISE_CUSTOMER_ADMIN_ROLE, - DEFAULT_ENTERPRISE_ENROLLMENT_INTENTIONS_ROLE, + SYSTEM_ENTERPRISE_PROVISIONING_ADMIN_ROLE, ) -from openedx_learning.api.django import openedx_learning_apps_to_install +from openedx_content.settings_api import openedx_content_backcompat_apps_to_install +from path import Path as path +from openedx.core.djangoapps.plugins.constants import ProjectType, SettingsType from openedx.core.lib.derived import Derived -from openedx.envs.common import * # pylint: disable=wildcard-import - from openedx.core.lib.features_setting_proxy import FeaturesProxy +from openedx.envs.common import * # pylint: disable=wildcard-import # noqa: F403 # A proxy for feature flags stored in the settings namespace FEATURES = FeaturesProxy(globals()) @@ -301,6 +302,67 @@ # .. toggle_creation_date: 2014-09-15 ENABLE_THIRD_PARTY_AUTH = False +# Third-party auth settings for python-social-auth +# These are defined unconditionally; they only take effect when +# AUTHENTICATION_BACKENDS includes social auth backends. + +# Where to send the user if there's an error during social authentication +SOCIAL_AUTH_LOGIN_ERROR_URL = '/' +# Where to send the user once social authentication is successful +SOCIAL_AUTH_LOGIN_REDIRECT_URL = '/dashboard' +# Disable sanitizing of redirect urls in social-auth since the platform +# already does its own sanitization via the LOGIN_REDIRECT_WHITELIST setting. +SOCIAL_AUTH_SANITIZE_REDIRECTS = False +# Adding extra key value pair in the url query string for microsoft as per request +SOCIAL_AUTH_AZUREAD_OAUTH2_AUTH_EXTRA_ARGUMENTS = {'msafed': 0} +# Required so that we can use unmodified PSA OAuth2 backends: +SOCIAL_AUTH_STRATEGY = 'common.djangoapps.third_party_auth.strategy.ConfigurationModelStrategy' +# We let the user specify their email address during signup. +SOCIAL_AUTH_PROTECTED_USER_FIELDS = ['email'] +# Disable exceptions by default for prod so you get redirect behavior +# instead of a Django error page. +SOCIAL_AUTH_RAISE_EXCEPTIONS = False +# Clean username to make sure username is compatible with our system requirements +SOCIAL_AUTH_CLEAN_USERNAME_FUNCTION = 'common.djangoapps.third_party_auth.models.clean_username' +# Allow users to login using social auth even if their account is not verified yet +SOCIAL_AUTH_INACTIVE_USER_LOGIN = True +SOCIAL_AUTH_INACTIVE_USER_URL = '/auth/inactive' +SOCIAL_AUTH_UUID_LENGTH = 10 +# Whitelisted URL query parameters retained in the pipeline session. +FIELDS_STORED_IN_SESSION = ['auth_entry', 'next'] + +# Computed setting: disable clean usernames check when unicode usernames are enabled +SOCIAL_AUTH_CLEAN_USERNAMES = Derived( + lambda settings: not settings.ENABLE_UNICODE_USERNAME +) + +# Social auth pipeline for third-party authentication. +# Operators can override SOCIAL_AUTH_PIPELINE directly in their settings +# to customize the pipeline. +# Note: Enterprise pipeline steps (enterprise_associate_by_email, handle_enterprise_logistration) +# are inserted dynamically via enterprise/settings/common.py plugin_settings(). +SOCIAL_AUTH_PIPELINE = [ + 'common.djangoapps.third_party_auth.pipeline.parse_query_params', + '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', + 'common.djangoapps.third_party_auth.pipeline.associate_by_email_if_login_api', + 'common.djangoapps.third_party_auth.pipeline.associate_by_email_if_oauth', + 'common.djangoapps.third_party_auth.pipeline.get_username', + 'common.djangoapps.third_party_auth.pipeline.set_pipeline_timeout', + 'common.djangoapps.third_party_auth.pipeline.ensure_user_information', + 'social_core.pipeline.user.create_user', + 'social_core.pipeline.social_auth.associate_user', + 'social_core.pipeline.social_auth.load_extra_data', + 'social_core.pipeline.user.user_details', + 'common.djangoapps.third_party_auth.pipeline.user_details_force_sync', + 'common.djangoapps.third_party_auth.pipeline.set_id_verification_status', + 'common.djangoapps.third_party_auth.pipeline.set_logged_in_cookies', + 'common.djangoapps.third_party_auth.pipeline.login_analytics', + 'common.djangoapps.third_party_auth.pipeline.ensure_redirect_url_is_safe', +] + # Prevent concurrent logins per user PREVENT_CONCURRENT_LOGINS = True @@ -714,14 +776,14 @@ ############################# SET PATH INFORMATION ############################# PROJECT_ROOT = path(__file__).abspath().dirname().dirname() # /edx-platform/lms -NODE_MODULES_ROOT = REPO_ROOT / "node_modules" +NODE_MODULES_ROOT = REPO_ROOT / "node_modules" # noqa: F405 # Where to look for a status message -STATUS_MESSAGE_PATH = ENV_ROOT / "status_message.json" +STATUS_MESSAGE_PATH = ENV_ROOT / "status_message.json" # noqa: F405 ############################ Global Database Configuration ##################### -DATABASE_ROUTERS.append('edx_django_utils.db.read_replica.ReadReplicaRouter') +DATABASE_ROUTERS.append('edx_django_utils.db.read_replica.ReadReplicaRouter') # noqa: F405 ################################## DJANGO OAUTH TOOLKIT ####################################### @@ -778,10 +840,10 @@ ################################## TEMPLATE CONFIGURATION ##################################### -MAKO_TEMPLATE_DIRS_BASE = lms_mako_template_dirs_base +MAKO_TEMPLATE_DIRS_BASE = lms_mako_template_dirs_base # noqa: F405 -CONTEXT_PROCESSORS.remove('django.contrib.messages.context_processors.messages') -CONTEXT_PROCESSORS[5:5] = [ +CONTEXT_PROCESSORS.remove('django.contrib.messages.context_processors.messages') # noqa: F405 +CONTEXT_PROCESSORS[5:5] = [ # noqa: F405 # Added for django-wiki 'django.template.context_processors.media', 'django.template.context_processors.tz', @@ -794,12 +856,16 @@ # Timezone processor (sends language and time_zone preference) 'lms.djangoapps.courseware.context_processor.user_timezone_locale_prefs', ] -CONTEXT_PROCESSORS += [ +CONTEXT_PROCESSORS += [ # noqa: F405 # Mobile App processor (Detects if request is from the mobile app) 'lms.djangoapps.mobile_api.context_processor.is_from_mobile_app', # Context processor necessary for the survey report message appear on the admin site 'openedx.features.survey_report.context_processors.admin_extra_context', + + # Third-party auth context processors for social_django + 'social_django.context_processors.backends', + 'social_django.context_processors.login_redirect', ] DEFAULT_TEMPLATE_ENGINE_DIRS = Derived(lambda settings: settings.TEMPLATES[0]['DIRS'][:]) @@ -822,8 +888,8 @@ EDX_API_KEY = None -LOGIN_REDIRECT_URL = EDX_ROOT_URL + '/login' -LOGIN_URL = EDX_ROOT_URL + '/login' +LOGIN_REDIRECT_URL = EDX_ROOT_URL + '/login' # noqa: F405 +LOGIN_URL = EDX_ROOT_URL + '/login' # noqa: F405 CERT_QUEUE = 'test-pull' @@ -852,7 +918,7 @@ DEBUG_TRACK_LOG = False -TRACKING_IGNORE_URL_PATTERNS += [r'^/segmentio/event', r'^/performance'] +TRACKING_IGNORE_URL_PATTERNS += [r'^/segmentio/event', r'^/performance'] # noqa: F405 TRACKING_SEGMENTIO_WEBHOOK_SECRET = None TRACKING_SEGMENTIO_ALLOWED_TYPES = ['track'] @@ -879,8 +945,8 @@ ############# ModuleStore Configuration ########## -CONTENTSTORE['DOC_STORE_CONFIG']['password'] = 'password' -CONTENTSTORE['DOC_STORE_CONFIG']['read_preference'] = 'SECONDARY_PREFERRED' +CONTENTSTORE['DOC_STORE_CONFIG']['password'] = 'password' # noqa: F405 +CONTENTSTORE['DOC_STORE_CONFIG']['read_preference'] = 'SECONDARY_PREFERRED' # noqa: F405 MODULESTORE_BRANCH = 'published-only' @@ -957,9 +1023,9 @@ # Static content STATIC_URL = '/static/' -STATIC_ROOT = os.environ.get('STATIC_ROOT_LMS', ENV_ROOT / "staticfiles") +STATIC_ROOT = os.environ.get('STATIC_ROOT_LMS', ENV_ROOT / "staticfiles") # noqa: F405 -STATICFILES_DIRS.insert(2, NODE_MODULES_ROOT / "@edx") +STATICFILES_DIRS.insert(2, NODE_MODULES_ROOT / "@edx") # noqa: F405 # Guidelines for translators TRANSLATORS_GUIDE = 'https://docs.openedx.org/en/latest/translators/index.html' @@ -1212,13 +1278,16 @@ # Handles automatically storing user ids in django-simple-history tables when possible. 'simple_history.middleware.HistoryRequestMiddleware', + # Third-party auth exception handling for social auth redirects + 'common.djangoapps.third_party_auth.middleware.ExceptionMiddleware', + # This must be last 'openedx.core.djangoapps.site_configuration.middleware.SessionCookieDomainOverrideMiddleware', ] ############################### PIPELINE ####################################### -PIPELINE['JS_COMPRESSOR'] = 'pipeline.compressors.uglifyjs.UglifyJSCompressor' +PIPELINE['JS_COMPRESSOR'] = 'pipeline.compressors.uglifyjs.UglifyJSCompressor' # noqa: F405 from openedx.core.lib.rooted_paths import rooted_glob # pylint: disable=wrong-import-position @@ -1288,7 +1357,7 @@ rooted_glob(PROJECT_ROOT / 'static', 'js/customwmd.js') + rooted_glob(PROJECT_ROOT / 'static', 'js/mathjax_accessible.js') + rooted_glob(PROJECT_ROOT / 'static', 'js/mathjax_delay_renderer.js') + - sorted(rooted_glob(COMMON_ROOT / 'static', 'common/js/discussion/**/*.js')) + sorted(rooted_glob(COMMON_ROOT / 'static', 'common/js/discussion/**/*.js')) # noqa: F405 ) discussion_vendor_js = [ @@ -1362,7 +1431,7 @@ 'js/src/logger.js', ] -PIPELINE['STYLESHEETS'] = { +PIPELINE['STYLESHEETS'] = { # noqa: F405 'style-vendor': { 'source_filenames': [ 'css/vendor/font-awesome.css', @@ -1500,7 +1569,7 @@ 'js/main.js', ] -PIPELINE['JAVASCRIPT'] = { +PIPELINE['JAVASCRIPT'] = { # noqa: F405 'base_application': { 'source_filenames': base_application_js, 'output_filename': 'js/lms-base-application.js', @@ -1682,7 +1751,7 @@ ############################# Email Opt In #################################### # Minimum age for organization-wide email opt in -EMAIL_OPTIN_MINIMUM_AGE = PARENTAL_CONSENT_AGE_LIMIT +EMAIL_OPTIN_MINIMUM_AGE = PARENTAL_CONSENT_AGE_LIMIT # noqa: F405 ################################### APPS ###################################### @@ -1780,7 +1849,7 @@ # User tours 'lms.djangoapps.user_tours', - # New (Learning-Core-based) XBlock runtime + # New XBlock runtime, based on openedx_content 'openedx.core.djangoapps.xblock.apps.LmsXBlockAppConfig', # Student support tools @@ -1950,7 +2019,7 @@ 'lms.djangoapps.course_goals.apps.CourseGoalsConfig', # Tagging - 'openedx_tagging.core.tagging.apps.TaggingConfig', + 'openedx_tagging', 'openedx.core.djangoapps.content_tagging', # Features @@ -2018,14 +2087,21 @@ # Notifications 'openedx.core.djangoapps.notifications', + # Authz + 'openedx.core.djangoapps.authz', + 'openedx_events', - # Learning Core apps that power libraries - *openedx_learning_apps_to_install(), + # Core models to represent courses + "openedx_catalog", + + # Core apps that power libraries + "openedx_content", + *openedx_content_backcompat_apps_to_install(), ] # Add LMS specific optional apps -OPTIONAL_APPS += [ +OPTIONAL_APPS += [ # noqa: F405 # Channel Integrations Apps ('channel_integrations.integrated_channel', None), ('channel_integrations.degreed2', None), @@ -2040,7 +2116,7 @@ ('django_object_actions', None), # https://github.com/crccheck/django-object-actions ] -add_optional_apps(OPTIONAL_APPS, INSTALLED_APPS) +add_optional_apps(OPTIONAL_APPS, INSTALLED_APPS) # noqa: F405 ######################### Django Rest Framework ######################## @@ -2051,7 +2127,7 @@ ######################### MARKETING SITE ############################### -MKTG_URL_LINK_MAP.update({ +MKTG_URL_LINK_MAP.update({ # noqa: F405 'ABOUT': 'about', 'CONTACT': 'contact', 'FAQ': 'help', @@ -2086,7 +2162,7 @@ ############################# SOCIAL MEDIA SHARING ############################# # Social Media Sharing on Student Dashboard -SOCIAL_SHARING_SETTINGS.update({ +SOCIAL_SHARING_SETTINGS.update({ # noqa: F405 'FACEBOOK_BRAND': None, 'CERTIFICATE_FACEBOOK_TEXT': None, 'TWITTER_BRAND': None, @@ -2396,7 +2472,6 @@ "secondary_email_enabled", "year_of_birth", "phone_number", - "activation_key", "pending_name_change", ] ) @@ -2524,7 +2599,7 @@ ################################ Settings for JWTs ################################ # Allows JWT authentication to find the LMS user id for verification -EDX_DRF_EXTENSIONS['VERIFY_LMS_USER_ID_PROPERTY_NAME'] = 'id' +EDX_DRF_EXTENSIONS['VERIFY_LMS_USER_ID_PROPERTY_NAME'] = 'id' # noqa: F405 ################################ Settings for rss_proxy ################################ @@ -2553,8 +2628,33 @@ # Note: If you want to use a model to store the results of the form, you will # need to add the model's app to the ADDL_INSTALLED_APPS array in your # lms.yml file. +# +# REGISTRATION_EXTENSION_FORM is deprecated but will continue to work for backward compatibility. +# Sites using this setting will maintain the old behavior: +# - Data is stored in UserProfile.meta JSON field +# - No ability to update extended fields after registration via account settings API +# +# To get new capabilities (model-based storage), migrate to PROFILE_EXTENSION_FORM. +REGISTRATION_EXTENSION_FORM = None # DEPRECATED: Use PROFILE_EXTENSION_FORM instead -REGISTRATION_EXTENSION_FORM = None +# PROFILE_EXTENSION_FORM is a Django ModelForm class used for extending user profiles +# beyond the default fields. This setting enables new capabilities for profile management: +# - Data is stored in a dedicated model (not just UserProfile.meta) +# - Users can update their extended profile fields via the account settings API +# +# This setting supersedes REGISTRATION_EXTENSION_FORM and provides more accurate naming +# for profile extension functionality. +# +# Example: PROFILE_EXTENSION_FORM = 'myapp.forms.ExtendedProfileForm' +# +# The custom form's model should have: +# - A OneToOneField to User (typically named 'user') +# - Additional fields for extended profile data +# +# MIGRATION NOTE: If you're currently using REGISTRATION_EXTENSION_FORM (deprecated), +# your custom fields will continue working as before (data in meta field). +# To get the new capabilities, migrate to PROFILE_EXTENSION_FORM. +PROFILE_EXTENSION_FORM = None # Identifier included in the User Agent from Open edX mobile apps. MOBILE_APP_USER_AGENT_REGEXES = [ @@ -2768,6 +2868,10 @@ # .. setting_default: None # .. setting_description: Base URL of the micro-frontend-based instructor app. INSTRUCTOR_MICROFRONTEND_URL = None +# .. setting_name: COMMUNICATIONS_MICROFRONTEND_URL +# .. setting_default: None +# .. setting_description: Base URL of the micro-frontend-based communications app. +COMMUNICATIONS_MICROFRONTEND_URL = None # .. setting_name: DISCUSSION_SPAM_URLS # .. setting_default: [] # .. setting_description: Urls to filter from discussion content to avoid spam @@ -2860,6 +2964,7 @@ # Note that all settings are actually defined by the plugin # pylint: disable=wrong-import-position from openedx.core.djangoapps.ace_common.settings import common as ace_common_settings + ACE_ROUTING_KEY = ace_common_settings.ACE_ROUTING_KEY ############### Settings for facebook ############################## @@ -2873,8 +2978,6 @@ ############## Plugin Django Apps ######################### -from edx_django_utils.plugins import get_plugin_apps, add_plugins # pylint: disable=wrong-import-position,wrong-import-order -from openedx.core.djangoapps.plugins.constants import ProjectType, SettingsType # pylint: disable=wrong-import-position INSTALLED_APPS.extend(get_plugin_apps(ProjectType.LMS)) add_plugins(__name__, ProjectType.LMS, SettingsType.COMMON) @@ -2994,6 +3097,25 @@ # .. setting_creation_date: 2022-08-05 MFE_CONFIG_OVERRIDES = {} +# .. setting_name: FRONTEND_SITE_CONFIG +# .. setting_implementation: DjangoSetting +# .. setting_default: {} +# .. setting_description: Frontend site configuration in frontend-base's native camelCase +# format. Unlike MFE_CONFIG, values here require no translation and are passed through +# to the /api/frontend_site_config/v1/ endpoint as-is, at the highest precedence (overriding any +# values translated from MFE_CONFIG). +# See https://github.com/openedx/frontend-base/blob/main/types.ts for the expected +# SiteConfig schema. +# Example: { +# "externalRoutes": [ +# {"role": "learnerDashboard", "url": "https://courses.example.com/dashboard"} +# ], +# "logoutUrl": "https://courses.example.com/logout" +# } +# .. setting_use_cases: open_edx +# .. setting_creation_date: 2026-04-04 +FRONTEND_SITE_CONFIG = {} + # .. setting_name: MFE_CONFIG_API_CACHE_TIMEOUT # .. setting_default: 60*5 # .. setting_description: The MFE Config API response will be cached during the @@ -3039,7 +3161,7 @@ def _should_send_certificate_events(settings): return settings.SEND_LEARNING_CERTIFICATE_LIFECYCLE_EVENTS_TO_BUS -EVENT_BUS_PRODUCER_CONFIG.update({ +EVENT_BUS_PRODUCER_CONFIG.update({ # noqa: F405 'org.openedx.learning.certificate.created.v1': { 'learning-certificate-lifecycle': {'event_key_field': 'certificate.course.course_key', 'enabled': Derived(_should_send_certificate_events)}, diff --git a/lms/envs/devstack.py b/lms/envs/devstack.py index dd7097df7178..1043016a6b2b 100644 --- a/lms/envs/devstack.py +++ b/lms/envs/devstack.py @@ -1,3 +1,4 @@ +# ruff: noqa: I001 - settings file: star-import order is semantically significant """ Specific overrides to the base prod settings to make development easier. """ @@ -8,19 +9,18 @@ from os.path import abspath, dirname, join from urllib.parse import urlparse -# pylint: enable=unicode-format-string # lint-amnesty, pylint: disable=bad-option-value +# pylint: enable=unicode-format-string # pylint: disable=bad-option-value ##################################################################### from edx_django_utils.plugins import add_plugins from openedx.core.djangoapps.plugins.constants import ProjectType, SettingsType - from openedx.core.lib.features_setting_proxy import FeaturesProxy -from .production import * # pylint: disable=wildcard-import, unused-wildcard-import +from .production import * # pylint: disable=wildcard-import, unused-wildcard-import # noqa: F403 FEATURES = FeaturesProxy(globals()) # Don't use S3 in devstack, fall back to filesystem -STORAGES['default']['BACKEND'] = 'django.core.files.storage.FileSystemStorage' +STORAGES['default']['BACKEND'] = 'django.core.files.storage.FileSystemStorage' # noqa: F405 ORA2_FILEUPLOAD_BACKEND = 'django' @@ -28,7 +28,7 @@ INTERNAL_IPS = ('127.0.0.1',) USE_I18N = True -DEFAULT_TEMPLATE_ENGINE['OPTIONS']['debug'] = True +DEFAULT_TEMPLATE_ENGINE['OPTIONS']['debug'] = True # noqa: F405 LMS_BASE = 'localhost:18000' CMS_BASE = 'localhost:18010' SITE_NAME = LMS_BASE @@ -64,11 +64,11 @@ logging.getLogger(log_name).setLevel(log_level) # Docker does not support the syslog socket at /dev/log. Rely on the console. -LOGGING['handlers']['local'] = LOGGING['handlers']['tracking'] = { +LOGGING['handlers']['local'] = LOGGING['handlers']['tracking'] = { # noqa: F405 'class': 'logging.NullHandler', } -LOGGING['loggers']['tracking']['handlers'] = ['console'] +LOGGING['loggers']['tracking']['handlers'] = ['console'] # noqa: F405 ################################ EMAIL ######################################## @@ -116,7 +116,7 @@ } -def should_show_debug_toolbar(request): # lint-amnesty, pylint: disable=missing-function-docstring +def should_show_debug_toolbar(request): # pylint: disable=missing-function-docstring # We always want the toolbar on devstack unless running tests from another Docker container hostname = request.get_host() if hostname.startswith('edx.devstack.lms:') or hostname.startswith('lms.devstack.edx:'): @@ -125,8 +125,8 @@ def should_show_debug_toolbar(request): # lint-amnesty, pylint: disable=missing ########################### PIPELINE ################################# -PIPELINE['PIPELINE_ENABLED'] = False -STORAGES['staticfiles']['BACKEND'] = 'openedx.core.storage.DevelopmentStorage' +PIPELINE['PIPELINE_ENABLED'] = False # noqa: F405 +STORAGES['staticfiles']['BACKEND'] = 'openedx.core.storage.DevelopmentStorage' # noqa: F405 # Revert to the default set of finders as we don't want the production pipeline STATICFILES_FINDERS = [ @@ -136,12 +136,12 @@ def should_show_debug_toolbar(request): # lint-amnesty, pylint: disable=missing ] # Disable JavaScript compression in development -PIPELINE['JS_COMPRESSOR'] = None +PIPELINE['JS_COMPRESSOR'] = None # noqa: F405 # Whether to run django-require in debug mode. REQUIRE_DEBUG = DEBUG -PIPELINE['SASS_ARGUMENTS'] = '--debug-info' +PIPELINE['SASS_ARGUMENTS'] = '--debug-info' # noqa: F405 ########################### VERIFIED CERTIFICATES ################################# @@ -190,7 +190,7 @@ def should_show_debug_toolbar(request): # lint-amnesty, pylint: disable=missing ########################## Course Discovery ####################### LANGUAGE_MAP = { - 'terms': dict(ALL_LANGUAGES), + 'terms': dict(ALL_LANGUAGES), # noqa: F405 'name': 'Language', } COURSE_DISCOVERY_MEANINGS = { @@ -217,7 +217,7 @@ def should_show_debug_toolbar(request): # lint-amnesty, pylint: disable=missing ENABLE_SOFTWARE_SECURE_FAKE = True # Setting for the testing of Software Secure Result Callback -VERIFY_STUDENT["SOFTWARE_SECURE"] = { +VERIFY_STUDENT["SOFTWARE_SECURE"] = { # noqa: F405 "API_ACCESS_KEY": "BBBBBBBBBBBBBBBBBBBB", "API_SECRET_KEY": "CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC", } @@ -235,10 +235,10 @@ def should_show_debug_toolbar(request): # lint-amnesty, pylint: disable=missing ########################## Third Party Auth ####################### -if ENABLE_THIRD_PARTY_AUTH and ( - 'common.djangoapps.third_party_auth.dummy.DummyBackend' not in AUTHENTICATION_BACKENDS +if ENABLE_THIRD_PARTY_AUTH and ( # noqa: F405 + 'common.djangoapps.third_party_auth.dummy.DummyBackend' not in AUTHENTICATION_BACKENDS # noqa: F405 ): - AUTHENTICATION_BACKENDS = ['common.djangoapps.third_party_auth.dummy.DummyBackend'] + list(AUTHENTICATION_BACKENDS) + AUTHENTICATION_BACKENDS = ['common.djangoapps.third_party_auth.dummy.DummyBackend'] + list(AUTHENTICATION_BACKENDS) # noqa: F405 # pylint: disable=line-too-long ########################## Authn MFE Context API ####################### ENABLE_DYNAMIC_REGISTRATION_FIELDS = True @@ -257,7 +257,7 @@ def should_show_debug_toolbar(request): # lint-amnesty, pylint: disable=missing ############## Exams CONFIGURATION SETTINGS #################### EXAMS_SERVICE_URL = 'http://localhost:8740/api/v1' -TOKEN_SIGNING.update({ +TOKEN_SIGNING.update({ # noqa: F405 'JWT_PUBLIC_SIGNING_JWK_SET': ( '{"keys": [{"kid": "localdev_exam_token_key", "e": "AQAB", "kty": "RSA", "n": "o5cn3ljSRi6FaDEKTn0PS-oL9EFyv1pI' '7dRgffQLD1qf5D6sprmYfWWokSsrWig8u2y0HChSygR6Jn5KXBqQn6FpM0dDJLnWQDRXHLl3Ey1iPYgDSmOIsIGrV9ZyNCQwk03wAgWbfdBTig' @@ -278,7 +278,7 @@ def should_show_debug_toolbar(request): # lint-amnesty, pylint: disable=missing ENTERPRISE_ADMIN_PORTAL_BASE_URL = 'http://' + ENTERPRISE_ADMIN_PORTAL_NETLOC ########################## GRADEBOOK APP ############################## -WRITABLE_GRADEBOOK_URL = 'http://localhost:1994' +WRITABLE_GRADEBOOK_URL = 'http://localhost:1994/gradebook' ########################## ORA STAFF GRADING APP ############################## ORA_GRADING_MICROFRONTEND_URL = 'http://localhost:1993' @@ -291,8 +291,8 @@ def should_show_debug_toolbar(request): # lint-amnesty, pylint: disable=missing ########################## LEARNING MFE ############################## # pylint: disable=line-too-long -LEARNING_MICROFRONTEND_URL = os.environ.get("LEARNING_MICROFRONTEND_URL", "http://localhost:2000") -LEARNING_MICROFRONTEND_NETLOC = os.environ.get("LEARNING_MICROFRONTEND_NETLOC", urlparse(LEARNING_MICROFRONTEND_URL).netloc) +LEARNING_MICROFRONTEND_URL = os.environ.get("LEARNING_MICROFRONTEND_URL", "http://localhost:2000") # noqa: F405 +LEARNING_MICROFRONTEND_NETLOC = os.environ.get("LEARNING_MICROFRONTEND_NETLOC", urlparse(LEARNING_MICROFRONTEND_URL).netloc) # noqa: F405 ###################### Cross-domain requests ###################### ENABLE_CORS_HEADERS = True @@ -300,7 +300,7 @@ def should_show_debug_toolbar(request): # lint-amnesty, pylint: disable=missing CORS_ORIGIN_WHITELIST = () CORS_ORIGIN_ALLOW_ALL = True -LOGIN_REDIRECT_WHITELIST.extend([ +LOGIN_REDIRECT_WHITELIST.extend([ # noqa: F405 CMS_BASE, # Allow redirection to all micro-frontends. # Please add your MFE if is not already listed here. @@ -324,7 +324,7 @@ def should_show_debug_toolbar(request): # lint-amnesty, pylint: disable=missing ]) ###################### JWTs ###################### -JWT_AUTH.update({ +JWT_AUTH.update({ # noqa: F405 'JWT_AUDIENCE': 'lms-key', 'JWT_ISSUER': f'{LMS_ROOT_URL}/oauth2', 'JWT_ISSUERS': [{ @@ -363,7 +363,7 @@ def should_show_debug_toolbar(request): # lint-amnesty, pylint: disable=missing ######################### Django Rest Framework ######################## -REST_FRAMEWORK['DEFAULT_RENDERER_CLASSES'] += ( +REST_FRAMEWORK['DEFAULT_RENDERER_CLASSES'] += ( # noqa: F405 'rest_framework.renderers.BrowsableAPIRenderer', ) @@ -371,18 +371,18 @@ def should_show_debug_toolbar(request): # lint-amnesty, pylint: disable=missing ##################################################################### # set replica set of contentstore to none as we haven't setup any for lms in devstack -CONTENTSTORE['DOC_STORE_CONFIG']['replicaSet'] = None +CONTENTSTORE['DOC_STORE_CONFIG']['replicaSet'] = None # noqa: F405 ##################################################################### # set replica sets of moduelstore to none as we haven't setup any for lms in devstack -for store in MODULESTORE['default']['OPTIONS']['stores']: +for store in MODULESTORE['default']['OPTIONS']['stores']: # noqa: F405 if 'DOC_STORE_CONFIG' in store and 'replicaSet' in store['DOC_STORE_CONFIG']: store['DOC_STORE_CONFIG']['replicaSet'] = None ##################################################################### # Lastly, run any migrations, if needed. -MODULESTORE = convert_module_store_setting_if_needed(MODULESTORE) +MODULESTORE = convert_module_store_setting_if_needed(MODULESTORE) # noqa: F405 SECRET_KEY = '85920908f28904ed733fe576320db18cabd7b6cd' @@ -398,7 +398,10 @@ def should_show_debug_toolbar(request): # lint-amnesty, pylint: disable=missing AUTHN_MICROFRONTEND_URL = 'http://localhost:1999' AUTHN_MICROFRONTEND_DOMAIN = 'localhost:1999' EXAMS_DASHBOARD_MICROFRONTEND_URL = 'http://localhost:2020' +INSTRUCTOR_MICROFRONTEND_URL = 'http://localhost:2003/instructor-dashboard' CATALOG_MICROFRONTEND_URL = 'http://localhost:1998/catalog' +COURSE_AUTHORING_MICROFRONTEND_URL = 'http://localhost:2001/authoring' +ADMIN_CONSOLE_MICROFRONTEND_URL = 'http://localhost:2025/admin-console' ################### FRONTEND APPLICATION DISCUSSIONS ################### DISCUSSIONS_MICROFRONTEND_URL = 'http://localhost:2002' @@ -420,8 +423,8 @@ def should_show_debug_toolbar(request): # lint-amnesty, pylint: disable=missing # Toggle this off if you don't want anything to do with enterprise in devstack. ENABLE_ENTERPRISE_INTEGRATION = True -ENABLE_MKTG_SITE = os.environ.get('ENABLE_MARKETING_SITE', False) -MARKETING_SITE_ROOT = os.environ.get('MARKETING_SITE_ROOT', 'http://localhost:8080') +ENABLE_MKTG_SITE = os.environ.get('ENABLE_MARKETING_SITE', False) # noqa: F405 +MARKETING_SITE_ROOT = os.environ.get('MARKETING_SITE_ROOT', 'http://localhost:8080') # noqa: F405 MKTG_URLS = { 'ABOUT': '/about', @@ -459,7 +462,7 @@ def should_show_debug_toolbar(request): # lint-amnesty, pylint: disable=missing COURSE_CATALOG_URL_ROOT = 'http://edx.devstack.discovery:18381' COURSE_CATALOG_API_URL = f'{COURSE_CATALOG_URL_ROOT}/api/v1' -SYSTEM_WIDE_ROLE_CLASSES = os.environ.get("SYSTEM_WIDE_ROLE_CLASSES", SYSTEM_WIDE_ROLE_CLASSES) +SYSTEM_WIDE_ROLE_CLASSES = os.environ.get("SYSTEM_WIDE_ROLE_CLASSES", SYSTEM_WIDE_ROLE_CLASSES) # noqa: F405 SYSTEM_WIDE_ROLE_CLASSES.append( 'system_wide_roles.SystemWideRoleAssignment', ) @@ -507,7 +510,7 @@ def should_show_debug_toolbar(request): # lint-amnesty, pylint: disable=missing PROCTORING_USER_OBFUSCATION_KEY = '85920908f28904ed733fe576320db18cabd7b6cd' #################### Webpack Configuration Settings ############################## -WEBPACK_LOADER['DEFAULT']['TIMEOUT'] = 5 +WEBPACK_LOADER['DEFAULT']['TIMEOUT'] = 5 # noqa: F405 #################### Network configuration #################### # Devstack is directly exposed to the caller @@ -519,22 +522,22 @@ def should_show_debug_toolbar(request): # lint-amnesty, pylint: disable=missing EVENT_BUS_TOPIC_PREFIX = 'dev' EVENT_BUS_CONSUMER = 'edx_event_bus_redis.RedisEventConsumer' -certificate_revoked_event_config = EVENT_BUS_PRODUCER_CONFIG['org.openedx.learning.certificate.revoked.v1'] +certificate_revoked_event_config = EVENT_BUS_PRODUCER_CONFIG['org.openedx.learning.certificate.revoked.v1'] # noqa: F405 certificate_revoked_event_config['learning-certificate-lifecycle']['enabled'] = True -certificate_created_event_config = EVENT_BUS_PRODUCER_CONFIG['org.openedx.learning.certificate.created.v1'] +certificate_created_event_config = EVENT_BUS_PRODUCER_CONFIG['org.openedx.learning.certificate.created.v1'] # noqa: F405 certificate_created_event_config['learning-certificate-lifecycle']['enabled'] = True -course_access_role_added_event_setting = EVENT_BUS_PRODUCER_CONFIG[ +course_access_role_added_event_setting = EVENT_BUS_PRODUCER_CONFIG[ # noqa: F405 'org.openedx.learning.user.course_access_role.added.v1' ] course_access_role_added_event_setting['learning-course-access-role-lifecycle']['enabled'] = True -course_access_role_removed_event_setting = EVENT_BUS_PRODUCER_CONFIG[ +course_access_role_removed_event_setting = EVENT_BUS_PRODUCER_CONFIG[ # noqa: F405 'org.openedx.learning.user.course_access_role.removed.v1' ] course_access_role_removed_event_setting['learning-course-access-role-lifecycle']['enabled'] = True lc_enrollment_revoked_setting = \ - EVENT_BUS_PRODUCER_CONFIG['org.openedx.enterprise.learner_credit_course_enrollment.revoked.v1'] + EVENT_BUS_PRODUCER_CONFIG['org.openedx.enterprise.learner_credit_course_enrollment.revoked.v1'] # noqa: F405 lc_enrollment_revoked_setting['learner-credit-course-enrollment-lifecycle']['enabled'] = True # API access management @@ -582,5 +585,5 @@ def should_show_debug_toolbar(request): # lint-amnesty, pylint: disable=missing ################# New settings must go ABOVE this line ################# ######################################################################## # See if the developer has any local overrides. -if os.path.isfile(join(dirname(abspath(__file__)), 'private.py')): - from .private import * # pylint: disable=import-error,wildcard-import +if os.path.isfile(join(dirname(abspath(__file__)), 'private.py')): # noqa: F405 + from .private import * # pylint: disable=import-error,wildcard-import # noqa: F403 diff --git a/lms/envs/mock.yml b/lms/envs/mock.yml index 38e3dd39db40..e26ce4351b28 100644 --- a/lms/envs/mock.yml +++ b/lms/envs/mock.yml @@ -1108,10 +1108,6 @@ SOCIAL_SHARING_SETTINGS: DASHBOARD_TWITTER: true SOFTWARE_SECURE_RETRY_MAX_ATTEMPTS: 5 SOFTWARE_SECURE_VERIFICATION_ROUTING_KEY: hello -STATICFILES_STORAGE_KWARGS: - openedx.core.storage.ProductionS3Storage: - bucket_name: hello - default_acl: hello STATIC_ROOT_BASE: /tmp/static STATIC_URL_BASE: /static STUDIO_NAME: Studio @@ -1246,4 +1242,3 @@ ZENDESK_GROUP_ID_MAPPING: ZENDESK_OAUTH_ACCESS_TOKEN: test_zendesk_oauth ZENDESK_URL: https://12345.zendesk.com ZENDESK_USER: daemon@example.com - diff --git a/lms/envs/pact.py b/lms/envs/pact.py index df3e3ee51a54..b14acf90ba67 100644 --- a/lms/envs/pact.py +++ b/lms/envs/pact.py @@ -2,7 +2,7 @@ Settings for Pact Verification Tests. """ -from .test import * # pylint: disable=wildcard-import, unused-wildcard-import +from .test import * # pylint: disable=wildcard-import, unused-wildcard-import # noqa: F403 #### Allow Pact Provider States URL #### PROVIDER_STATES_URL = True @@ -11,4 +11,4 @@ MOCK_USERNAME = 'Mock User' ######################### Add Authentication Middleware for Pact Verification Calls ######################### -MIDDLEWARE = MIDDLEWARE + ['common.test.pacts.middleware.AuthenticationMiddleware', ] +MIDDLEWARE = MIDDLEWARE + ['common.test.pacts.middleware.AuthenticationMiddleware', ] # noqa: F405 diff --git a/lms/envs/production.py b/lms/envs/production.py index 63246821d954..b954841d59bc 100644 --- a/lms/envs/production.py +++ b/lms/envs/production.py @@ -1,3 +1,4 @@ +# ruff: noqa: I001 - settings file: star-import order is semantically significant """ Override common.py with key-value pairs from YAML (plus some extra defaults & post-processing). @@ -27,12 +28,12 @@ from openedx.core.djangoapps.plugins.constants import ProjectType, SettingsType from openedx.core.lib.derived import derive_settings +from openedx.core.lib.features_setting_proxy import FeaturesProxy from openedx.core.lib.logsettings import get_logger_config -from xmodule.modulestore.modulestore_settings import convert_module_store_setting_if_needed # lint-amnesty, pylint: disable=wrong-import-order - -from .common import * +from xmodule.modulestore.modulestore_settings import \ + convert_module_store_setting_if_needed # pylint: disable=wrong-import-order -from openedx.core.lib.features_setting_proxy import FeaturesProxy +from .common import * # noqa: F403 # A proxy for feature flags stored in the settings namespace FEATURES = FeaturesProxy(globals()) @@ -43,8 +44,8 @@ def get_env_setting(setting): try: return os.environ[setting] except KeyError: - error_msg = "Set the %s env variable" % setting - raise ImproperlyConfigured(error_msg) # lint-amnesty, pylint: disable=raise-missing-from + error_msg = "Set the %s env variable" % setting # noqa: UP031 + raise ImproperlyConfigured(error_msg) # pylint: disable=raise-missing-from # noqa: B904 ####################################################################################################################### #### YAML LOADING @@ -101,7 +102,7 @@ def get_env_setting(setting): REVISION_CONFIG = {} # Do NOT calculate this dynamically at startup with git because it's *slow*. -EDX_PLATFORM_REVISION = REVISION_CONFIG.get('EDX_PLATFORM_REVISION', EDX_PLATFORM_REVISION) +EDX_PLATFORM_REVISION = REVISION_CONFIG.get('EDX_PLATFORM_REVISION', EDX_PLATFORM_REVISION) # noqa: F405 ####################################################################################################################### @@ -120,34 +121,34 @@ def get_env_setting(setting): # STATIC_ROOT specifies the directory where static files are # collected -if STATIC_ROOT_BASE: - STATIC_ROOT = path(STATIC_ROOT_BASE) +if STATIC_ROOT_BASE: # noqa: F405 + STATIC_ROOT = path(STATIC_ROOT_BASE) # noqa: F405 # STATIC_URL_BASE specifies the base url to use for static files -if STATIC_URL_BASE: - STATIC_URL = STATIC_URL_BASE +if STATIC_URL_BASE: # noqa: F405 + STATIC_URL = STATIC_URL_BASE # noqa: F405 if not STATIC_URL.endswith("/"): STATIC_URL += "/" -DATA_DIR = path(DATA_DIR) +DATA_DIR = path(DATA_DIR) # noqa: F405 # TODO: This was for backwards compatibility back when installed django-cookie-samesite (not since 2022). # The DCS_ version of the setting can be DEPR'd at this point. -SESSION_COOKIE_SAMESITE = DCS_SESSION_COOKIE_SAMESITE +SESSION_COOKIE_SAMESITE = DCS_SESSION_COOKIE_SAMESITE # noqa: F405 for feature, value in _YAML_TOKENS.get('FEATURES', {}).items(): FEATURES[feature] = value # Cache used for location mapping -- called many times with the same key/value # in a given request. -if 'loc_cache' not in CACHES: - CACHES['loc_cache'] = { +if 'loc_cache' not in CACHES: # noqa: F405 + CACHES['loc_cache'] = { # noqa: F405 'BACKEND': 'django.core.cache.backends.locmem.LocMemCache', 'LOCATION': 'edx_location_mem_cache', } -if 'staticfiles' in CACHES: - CACHES['staticfiles']['KEY_PREFIX'] = EDX_PLATFORM_REVISION +if 'staticfiles' in CACHES: # noqa: F405 + CACHES['staticfiles']['KEY_PREFIX'] = EDX_PLATFORM_REVISION # noqa: F405 # In order to transition from local disk asset storage to S3 backed asset storage, # we need to run asset collection twice, once for local disk and once for S3. @@ -162,7 +163,7 @@ def get_env_setting(setting): # Then add alternate environment queues _YAML_ALTERNATE_WORKER_QUEUES = _YAML_TOKENS.get('ALTERNATE_WORKER_QUEUES', '').split() ALTERNATE_QUEUES = [ - DEFAULT_PRIORITY_QUEUE.replace(SERVICE_VARIANT, alternate) + DEFAULT_PRIORITY_QUEUE.replace(SERVICE_VARIANT, alternate) # noqa: F405 for alternate in _YAML_ALTERNATE_WORKER_QUEUES ] @@ -174,28 +175,28 @@ def get_env_setting(setting): } ) -MKTG_URL_LINK_MAP.update(_YAML_TOKENS.get('MKTG_URL_LINK_MAP', {})) +MKTG_URL_LINK_MAP.update(_YAML_TOKENS.get('MKTG_URL_LINK_MAP', {})) # noqa: F405 # Timezone overrides -TIME_ZONE = CELERY_TIMEZONE +TIME_ZONE = CELERY_TIMEZONE # noqa: F405 # Translation overrides -LANGUAGE_DICT = dict(LANGUAGES) +LANGUAGE_DICT = dict(LANGUAGES) # noqa: F405 -LANGUAGE_COOKIE_NAME = _YAML_TOKENS.get('LANGUAGE_COOKIE') or LANGUAGE_COOKIE_NAME +LANGUAGE_COOKIE_NAME = _YAML_TOKENS.get('LANGUAGE_COOKIE') or LANGUAGE_COOKIE_NAME # noqa: F405 # Additional installed apps for app in _YAML_TOKENS.get('ADDL_INSTALLED_APPS', []): - INSTALLED_APPS.append(app) + INSTALLED_APPS.append(app) # noqa: F405 LOGGING = get_logger_config( - LOG_DIR, - logging_env=LOGGING_ENV, - local_loglevel=LOCAL_LOGLEVEL, - service_variant=SERVICE_VARIANT, + LOG_DIR, # noqa: F405 + logging_env=LOGGING_ENV, # noqa: F405 + local_loglevel=LOCAL_LOGLEVEL, # noqa: F405 + service_variant=SERVICE_VARIANT, # noqa: F405 ) -if ENABLE_CORS_HEADERS or ENABLE_CROSS_DOMAIN_CSRF_COOKIE: +if ENABLE_CORS_HEADERS or ENABLE_CROSS_DOMAIN_CSRF_COOKIE: # noqa: F405 CORS_ALLOW_CREDENTIALS = True CORS_ORIGIN_WHITELIST = _YAML_TOKENS.get('CORS_ORIGIN_WHITELIST', ()) CORS_ORIGIN_ALLOW_ALL = _YAML_TOKENS.get('CORS_ORIGIN_ALLOW_ALL', False) @@ -205,9 +206,9 @@ def get_env_setting(setting): ############### Mixed Related(Secure/Not-Secure) Items ########## LMS_SEGMENT_KEY = _YAML_TOKENS.get('SEGMENT_KEY') -if AWS_ACCESS_KEY_ID == "": +if AWS_ACCESS_KEY_ID == "": # noqa: F405 AWS_ACCESS_KEY_ID = None -if AWS_SECRET_ACCESS_KEY == "": +if AWS_SECRET_ACCESS_KEY == "": # noqa: F405 AWS_SECRET_ACCESS_KEY = None # these variable already exists in cms with `private` value. django-storages starting `1.10.1` @@ -229,18 +230,18 @@ def get_env_setting(setting): # without overwriting user-defined STORAGES and AWS creds are treated only as a fallback. if _storages_default_backend_is_missing: if 'DEFAULT_FILE_STORAGE' in _YAML_TOKENS: - STORAGES['default']['BACKEND'] = _YAML_TOKENS['DEFAULT_FILE_STORAGE'] + STORAGES['default']['BACKEND'] = _YAML_TOKENS['DEFAULT_FILE_STORAGE'] # noqa: F405 elif AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY: - STORAGES['default']['BACKEND'] = 'storages.backends.s3boto3.S3Boto3Storage' + STORAGES['default']['BACKEND'] = 'storages.backends.s3boto3.S3Boto3Storage' # noqa: F405 # Apply legacy STATICFILES_STORAGE if no backend is defined for "staticfiles" if 'STATICFILES_STORAGE' in _YAML_TOKENS and not _yaml_storages.get('staticfiles', {}).get('BACKEND'): - STORAGES['staticfiles']['BACKEND'] = _YAML_TOKENS['STATICFILES_STORAGE'] + STORAGES['staticfiles']['BACKEND'] = _YAML_TOKENS['STATICFILES_STORAGE'] # noqa: F405 # The normal database user does not have enough permissions to run migrations. # Migrations are run with separate credentials, given as DB_MIGRATION_* # environment variables -for name, database in DATABASES.items(): +for name, database in DATABASES.items(): # noqa: F405 if name != 'read_replica': database.update({ 'ENGINE': os.environ.get('DB_MIGRATION_ENGINE', database['ENGINE']), @@ -253,13 +254,13 @@ def get_env_setting(setting): # Get the MODULESTORE from auth.json, but if it doesn't exist, # use the one from common.py -MODULESTORE = convert_module_store_setting_if_needed(MODULESTORE) +MODULESTORE = convert_module_store_setting_if_needed(MODULESTORE) # noqa: F405 -BROKER_URL = "{}://{}:{}@{}/{}".format(CELERY_BROKER_TRANSPORT, - CELERY_BROKER_USER, - CELERY_BROKER_PASSWORD, - CELERY_BROKER_HOSTNAME, - CELERY_BROKER_VHOST) +BROKER_URL = "{}://{}:{}@{}/{}".format(CELERY_BROKER_TRANSPORT, # noqa: F405, UP032 + CELERY_BROKER_USER, # noqa: F405 + CELERY_BROKER_PASSWORD, # noqa: F405 + CELERY_BROKER_HOSTNAME, # noqa: F405 + CELERY_BROKER_VHOST) # noqa: F405 try: BROKER_TRANSPORT_OPTIONS = { 'fanout_patterns': True, @@ -270,15 +271,15 @@ def get_env_setting(setting): raise ImproperlyConfigured('CELERY_BROKER_TRANSPORT_OPTIONS must be a dict') from exc # Event tracking -TRACKING_BACKENDS.update(_YAML_TOKENS.get("TRACKING_BACKENDS", {})) -EVENT_TRACKING_BACKENDS['tracking_logs']['OPTIONS']['backends'].update( +TRACKING_BACKENDS.update(_YAML_TOKENS.get("TRACKING_BACKENDS", {})) # noqa: F405 +EVENT_TRACKING_BACKENDS['tracking_logs']['OPTIONS']['backends'].update( # noqa: F405 _YAML_TOKENS.get("EVENT_TRACKING_BACKENDS", {}) ) -EVENT_TRACKING_BACKENDS['segmentio']['OPTIONS']['processors'][0]['OPTIONS']['whitelist'].extend( - EVENT_TRACKING_SEGMENTIO_EMIT_WHITELIST +EVENT_TRACKING_BACKENDS['segmentio']['OPTIONS']['processors'][0]['OPTIONS']['whitelist'].extend( # noqa: F405 + EVENT_TRACKING_SEGMENTIO_EMIT_WHITELIST # noqa: F405 ) -if ENABLE_THIRD_PARTY_AUTH: +if ENABLE_THIRD_PARTY_AUTH: # noqa: F405 AUTHENTICATION_BACKENDS = _YAML_TOKENS.get('THIRD_PARTY_AUTH_BACKENDS', [ 'social_core.backends.google.GoogleOAuth2', 'social_core.backends.linkedin.LinkedinOAuth2', @@ -288,7 +289,7 @@ def get_env_setting(setting): 'common.djangoapps.third_party_auth.identityserver3.IdentityServer3', 'common.djangoapps.third_party_auth.saml.SAMLAuthBackend', 'common.djangoapps.third_party_auth.lti.LTIAuthBackend', - ]) + list(AUTHENTICATION_BACKENDS) + ]) + list(AUTHENTICATION_BACKENDS) # noqa: F405 # The reduced session expiry time during the third party login pipeline. (Value in seconds) SOCIAL_AUTH_PIPELINE_TIMEOUT = _YAML_TOKENS.get('SOCIAL_AUTH_PIPELINE_TIMEOUT', 600) @@ -304,7 +305,7 @@ def get_env_setting(setting): if hours := _YAML_TOKENS.get('THIRD_PARTY_AUTH_SAML_FETCH_PERIOD_HOURS', 24): # If we didn't override the value in YAML, OR we overrode it to a truthy value, # then update CELERYBEAT_SCHEDULE. - CELERYBEAT_SCHEDULE['refresh-saml-metadata'] = { + CELERYBEAT_SCHEDULE['refresh-saml-metadata'] = { # noqa: F405 'task': 'common.djangoapps.third_party_auth.tasks.fetch_saml_metadata', 'schedule': datetime.timedelta(hours=hours), } @@ -318,14 +319,14 @@ def get_env_setting(setting): OAUTH_ENFORCE_SECURE = True OAUTH_ENFORCE_CLIENT_SECURE = True # Defaults for the following are defined in lms.envs.common -OAUTH_EXPIRE_DELTA = datetime.timedelta(days=OAUTH_EXPIRE_CONFIDENTIAL_CLIENT_DAYS) -OAUTH_EXPIRE_DELTA_PUBLIC = datetime.timedelta(days=OAUTH_EXPIRE_PUBLIC_CLIENT_DAYS) +OAUTH_EXPIRE_DELTA = datetime.timedelta(days=OAUTH_EXPIRE_CONFIDENTIAL_CLIENT_DAYS) # noqa: F405 +OAUTH_EXPIRE_DELTA_PUBLIC = datetime.timedelta(days=OAUTH_EXPIRE_PUBLIC_CLIENT_DAYS) # noqa: F405 if ( - ENABLE_COURSEWARE_SEARCH or - ENABLE_DASHBOARD_SEARCH or - ENABLE_COURSE_DISCOVERY or - ENABLE_TEAMS + ENABLE_COURSEWARE_SEARCH or # noqa: F405 + ENABLE_DASHBOARD_SEARCH or # noqa: F405 + ENABLE_COURSE_DISCOVERY or # noqa: F405 + ENABLE_TEAMS # noqa: F405 ): # Use ElasticSearch as the search engine herein SEARCH_ENGINE = "search.elastic.ElasticSearchEngine" @@ -333,20 +334,20 @@ def get_env_setting(setting): # TODO: Once we have successfully upgraded to ES7, switch this back to ELASTIC_SEARCH_CONFIG. ELASTIC_SEARCH_CONFIG = _YAML_TOKENS.get('ELASTIC_SEARCH_CONFIG_ES7', [{}]) -XBLOCK_SETTINGS.setdefault("VideoBlock", {})["licensing_enabled"] = FEATURES["LICENSING"] -XBLOCK_SETTINGS.setdefault("VideoBlock", {})['YOUTUBE_API_KEY'] = YOUTUBE_API_KEY +XBLOCK_SETTINGS.setdefault("VideoBlock", {})["licensing_enabled"] = FEATURES["LICENSING"] # noqa: F405 +XBLOCK_SETTINGS.setdefault("VideoBlock", {})['YOUTUBE_API_KEY'] = YOUTUBE_API_KEY # noqa: F405 ##### Custom Courses for EdX ##### -if CUSTOM_COURSES_EDX: - INSTALLED_APPS += ['lms.djangoapps.ccx', 'openedx.core.djangoapps.ccxcon.apps.CCXConnectorConfig'] - MODULESTORE_FIELD_OVERRIDE_PROVIDERS += ( +if CUSTOM_COURSES_EDX: # noqa: F405 + INSTALLED_APPS += ['lms.djangoapps.ccx', 'openedx.core.djangoapps.ccxcon.apps.CCXConnectorConfig'] # noqa: F405 + MODULESTORE_FIELD_OVERRIDE_PROVIDERS += ( # noqa: F405 'lms.djangoapps.ccx.overrides.CustomCoursesForEdxOverrideProvider', ) -FIELD_OVERRIDE_PROVIDERS = tuple(FIELD_OVERRIDE_PROVIDERS) +FIELD_OVERRIDE_PROVIDERS = tuple(FIELD_OVERRIDE_PROVIDERS) # noqa: F405 ##### Individual Due Date Extensions ##### -if INDIVIDUAL_DUE_DATES: +if INDIVIDUAL_DUE_DATES: # noqa: F405 FIELD_OVERRIDE_PROVIDERS += ( 'lms.djangoapps.courseware.student_field_overrides.IndividualStudentOverrideProvider', ) @@ -357,7 +358,7 @@ def get_env_setting(setting): ) ##### Self-Paced Course Due Dates ##### -XBLOCK_FIELD_DATA_WRAPPERS += ( +XBLOCK_FIELD_DATA_WRAPPERS += ( # noqa: F405 'lms.djangoapps.courseware.field_overrides:OverrideModulestoreFieldData.wrap', ) @@ -371,14 +372,14 @@ def get_env_setting(setting): ##### Credit Provider Integration ##### ##################### LTI Provider ##################### -if ENABLE_LTI_PROVIDER: +if ENABLE_LTI_PROVIDER: # noqa: F405 INSTALLED_APPS.append('lms.djangoapps.lti_provider.apps.LtiProviderConfig') AUTHENTICATION_BACKENDS.append('lms.djangoapps.lti_provider.users.LtiBackend') ##################### Credit Provider help link #################### #### JWT configuration #### -JWT_AUTH.update(_YAML_TOKENS.get('JWT_AUTH', {})) +JWT_AUTH.update(_YAML_TOKENS.get('JWT_AUTH', {})) # noqa: F405 ############## ENTERPRISE SERVICE LMS CONFIGURATION ################################## @@ -386,14 +387,14 @@ def get_env_setting(setting): # which are not provided by the Enterprise service. These settings override the # base values for the parameters as defined in common.py -ENTERPRISE_EXCLUDED_REGISTRATION_FIELDS = set(ENTERPRISE_EXCLUDED_REGISTRATION_FIELDS) +ENTERPRISE_EXCLUDED_REGISTRATION_FIELDS = set(ENTERPRISE_EXCLUDED_REGISTRATION_FIELDS) # noqa: F405 ########################## Extra middleware classes ####################### # Allow extra middleware classes to be added to the app through configuration. # TODO: Declare `EXTRA_MIDDLEWARE_CLASSES = []` in lms/envs/common.py so that we can simplify this # next line. See CMS settings for the example of what we want. -MIDDLEWARE.extend(_YAML_TOKENS.get('EXTRA_MIDDLEWARE_CLASSES', [])) +MIDDLEWARE.extend(_YAML_TOKENS.get('EXTRA_MIDDLEWARE_CLASSES', [])) # noqa: F405 ####################################################################################################################### @@ -441,69 +442,69 @@ def get_env_setting(setting): # Defines the task -> alternate worker queue to be used when routing. EXPLICIT_QUEUES = { 'openedx.core.djangoapps.content.course_overviews.tasks.async_course_overview_update': { - 'queue': GRADES_DOWNLOAD_ROUTING_KEY}, + 'queue': GRADES_DOWNLOAD_ROUTING_KEY}, # noqa: F405 'lms.djangoapps.bulk_email.tasks.send_course_email': { - 'queue': BULK_EMAIL_ROUTING_KEY}, + 'queue': BULK_EMAIL_ROUTING_KEY}, # noqa: F405 'openedx.core.djangoapps.heartbeat.tasks.sample_task': { - 'queue': HEARTBEAT_CELERY_ROUTING_KEY}, + 'queue': HEARTBEAT_CELERY_ROUTING_KEY}, # noqa: F405 'lms.djangoapps.instructor_task.tasks.calculate_grades_csv': { - 'queue': GRADES_DOWNLOAD_ROUTING_KEY}, + 'queue': GRADES_DOWNLOAD_ROUTING_KEY}, # noqa: F405 'lms.djangoapps.instructor_task.tasks.calculate_problem_grade_report': { - 'queue': GRADES_DOWNLOAD_ROUTING_KEY}, + 'queue': GRADES_DOWNLOAD_ROUTING_KEY}, # noqa: F405 'lms.djangoapps.instructor_task.tasks.generate_certificates': { - 'queue': GRADES_DOWNLOAD_ROUTING_KEY}, + 'queue': GRADES_DOWNLOAD_ROUTING_KEY}, # noqa: F405 'lms.djangoapps.verify_student.tasks.send_verification_status_email': { - 'queue': ACE_ROUTING_KEY}, + 'queue': ACE_ROUTING_KEY}, # noqa: F405 'lms.djangoapps.verify_student.tasks.send_ace_message': { - 'queue': ACE_ROUTING_KEY}, + 'queue': ACE_ROUTING_KEY}, # noqa: F405 'lms.djangoapps.verify_student.tasks.send_request_to_ss_for_user': { - 'queue': SOFTWARE_SECURE_VERIFICATION_ROUTING_KEY}, + 'queue': SOFTWARE_SECURE_VERIFICATION_ROUTING_KEY}, # noqa: F405 'openedx.core.djangoapps.schedules.tasks._recurring_nudge_schedule_send': { - 'queue': ACE_ROUTING_KEY}, + 'queue': ACE_ROUTING_KEY}, # noqa: F405 'openedx.core.djangoapps.schedules.tasks._upgrade_reminder_schedule_send': { - 'queue': ACE_ROUTING_KEY}, + 'queue': ACE_ROUTING_KEY}, # noqa: F405 'openedx.core.djangoapps.schedules.tasks._course_update_schedule_send': { - 'queue': ACE_ROUTING_KEY}, + 'queue': ACE_ROUTING_KEY}, # noqa: F405 'openedx.core.djangoapps.schedules.tasks.v1.tasks.send_grade_to_credentials': { - 'queue': CREDENTIALS_GENERATION_ROUTING_KEY}, + 'queue': CREDENTIALS_GENERATION_ROUTING_KEY}, # noqa: F405 'common.djangoapps.entitlements.tasks.expire_old_entitlements': { - 'queue': ENTITLEMENTS_EXPIRATION_ROUTING_KEY}, + 'queue': ENTITLEMENTS_EXPIRATION_ROUTING_KEY}, # noqa: F405 'lms.djangoapps.grades.tasks.recalculate_course_and_subsection_grades_for_user': { - 'queue': POLICY_CHANGE_GRADES_ROUTING_KEY}, + 'queue': POLICY_CHANGE_GRADES_ROUTING_KEY}, # noqa: F405 'lms.djangoapps.grades.tasks.recalculate_subsection_grade_v3': { - 'queue': SINGLE_LEARNER_COURSE_REGRADE_ROUTING_KEY}, + 'queue': SINGLE_LEARNER_COURSE_REGRADE_ROUTING_KEY}, # noqa: F405 'openedx.core.djangoapps.programs.tasks.award_program_certificates': { - 'queue': PROGRAM_CERTIFICATES_ROUTING_KEY}, + 'queue': PROGRAM_CERTIFICATES_ROUTING_KEY}, # noqa: F405 'openedx.core.djangoapps.programs.tasks.revoke_program_certificates': { - 'queue': PROGRAM_CERTIFICATES_ROUTING_KEY}, + 'queue': PROGRAM_CERTIFICATES_ROUTING_KEY}, # noqa: F405 'openedx.core.djangoapps.programs.tasks.update_certificate_available_date_on_course_update': { - 'queue': PROGRAM_CERTIFICATES_ROUTING_KEY}, + 'queue': PROGRAM_CERTIFICATES_ROUTING_KEY}, # noqa: F405 'openedx.core.djangoapps.programs.tasks.award_course_certificate': { - 'queue': PROGRAM_CERTIFICATES_ROUTING_KEY}, + 'queue': PROGRAM_CERTIFICATES_ROUTING_KEY}, # noqa: F405 'openassessment.workflow.tasks.update_workflows_for_all_blocked_submissions_task': { - 'queue': ORA_WORKFLOW_UPDATE_ROUTING_KEY}, + 'queue': ORA_WORKFLOW_UPDATE_ROUTING_KEY}, # noqa: F405 'openassessment.workflow.tasks.update_workflows_for_course_task': { - 'queue': ORA_WORKFLOW_UPDATE_ROUTING_KEY}, + 'queue': ORA_WORKFLOW_UPDATE_ROUTING_KEY}, # noqa: F405 'openassessment.workflow.tasks.update_workflows_for_ora_block_task': { - 'queue': ORA_WORKFLOW_UPDATE_ROUTING_KEY}, + 'queue': ORA_WORKFLOW_UPDATE_ROUTING_KEY}, # noqa: F405 'openassessment.workflow.tasks.update_workflow_for_submission_task': { - 'queue': ORA_WORKFLOW_UPDATE_ROUTING_KEY}, + 'queue': ORA_WORKFLOW_UPDATE_ROUTING_KEY}, # noqa: F405 } ############## XBlock extra mixins ############################ -XBLOCK_MIXINS += tuple(XBLOCK_EXTRA_MIXINS) +XBLOCK_MIXINS += tuple(XBLOCK_EXTRA_MIXINS) # noqa: F405 ############## DRF overrides ############## -REST_FRAMEWORK.update(_YAML_TOKENS.get('REST_FRAMEWORK', {})) +REST_FRAMEWORK.update(_YAML_TOKENS.get('REST_FRAMEWORK', {})) # noqa: F405 ############################# CELERY ############################ -CELERY_IMPORTS.extend(_YAML_TOKENS.get('CELERY_EXTRA_IMPORTS', [])) +CELERY_IMPORTS.extend(_YAML_TOKENS.get('CELERY_EXTRA_IMPORTS', [])) # noqa: F405 # keys for big blue button live provider # TODO: This should not be in the core platform. If it has to stay for now, though, then we should move these # defaults into common.py -COURSE_LIVE_GLOBAL_CREDENTIALS["BIG_BLUE_BUTTON"] = { +COURSE_LIVE_GLOBAL_CREDENTIALS["BIG_BLUE_BUTTON"] = { # noqa: F405 "KEY": _YAML_TOKENS.get('BIG_BLUE_BUTTON_GLOBAL_KEY'), "SECRET": _YAML_TOKENS.get('BIG_BLUE_BUTTON_GLOBAL_SECRET'), "URL": _YAML_TOKENS.get('BIG_BLUE_BUTTON_GLOBAL_URL'), @@ -511,7 +512,7 @@ def get_env_setting(setting): ############## Event bus producer ############## EVENT_BUS_PRODUCER_CONFIG = merge_producer_configs( - EVENT_BUS_PRODUCER_CONFIG, + EVENT_BUS_PRODUCER_CONFIG, # noqa: F405 _YAML_TOKENS.get('EVENT_BUS_PRODUCER_CONFIG', {}) ) diff --git a/lms/envs/test.py b/lms/envs/test.py index e396549501c1..236781831a2d 100644 --- a/lms/envs/test.py +++ b/lms/envs/test.py @@ -13,22 +13,21 @@ # pylint: disable=wildcard-import, unused-wildcard-import -import logging +import logging # noqa: I001 - suppresses linting for this whole block, sort imports manually as needed from collections import OrderedDict from edx_django_utils.plugins import add_plugins from openedx.core.djangoapps.plugins.constants import ProjectType, SettingsType from openedx.core.lib.derived import derive_settings -from openedx.core.lib.tempdir import mkdtemp_clean -from xmodule.modulestore.modulestore_settings import update_module_store_settings # lint-amnesty, pylint: disable=wrong-import-order - from openedx.core.lib.features_setting_proxy import FeaturesProxy +from openedx.core.lib.tempdir import mkdtemp_clean +from xmodule.modulestore.modulestore_settings import ( + update_module_store_settings, # pylint: disable=wrong-import-order +) -from .common import * - -from openedx.envs.test import * - +from .common import * # noqa: F403 +from openedx.envs.test import * # must come after .common to override Derived values with literals # noqa: F403 # A proxy for feature flags stored in the settings namespace FEATURES = FeaturesProxy(globals()) @@ -51,18 +50,18 @@ ENABLE_BULK_USER_RETIREMENT = True -COMMON_TEST_DATA_ROOT = COMMON_ROOT / "test" / "data" +COMMON_TEST_DATA_ROOT = COMMON_ROOT / "test" / "data" # noqa: F405 -COMPREHENSIVE_THEME_DIRS = [REPO_ROOT / "themes", REPO_ROOT / "common/test"] +COMPREHENSIVE_THEME_DIRS = [REPO_ROOT / "themes", REPO_ROOT / "common/test"] # noqa: F405 -WEBPACK_LOADER['DEFAULT']['LOADER_CLASS'] = 'webpack_loader.loader.FakeWebpackLoader' +WEBPACK_LOADER['DEFAULT']['LOADER_CLASS'] = 'webpack_loader.loader.FakeWebpackLoader' # noqa: F405 -STATUS_MESSAGE_PATH = TEST_ROOT / "status_message.json" +STATUS_MESSAGE_PATH = TEST_ROOT / "status_message.json" # noqa: F405 -COURSES_ROOT = TEST_ROOT / "data" +COURSES_ROOT = TEST_ROOT / "data" # noqa: F405 # Where the content data is checked out. -GITHUB_REPO_ROOT = ENV_ROOT / "data" +GITHUB_REPO_ROOT = ENV_ROOT / "data" # noqa: F405 USE_I18N = True LANGUAGE_CODE = 'en' # tests assume they will get English. @@ -85,7 +84,7 @@ DJFS = { 'type': 'osfs', - 'directory_root': f'{DATA_DIR}/django-pyfs/static/django-pyfs', + 'directory_root': f'{DATA_DIR}/django-pyfs/static/django-pyfs', # noqa: F405 'url_root': '/static/django-pyfs', } @@ -97,23 +96,23 @@ # If we don't add these settings, then Django templates that can't # find pipelined assets will raise a ValueError. # http://stackoverflow.com/questions/12816941/unit-testing-with-django-pipeline -STORAGES['staticfiles']['BACKEND'] = 'pipeline.storage.NonPackagingPipelineStorage' +STORAGES['staticfiles']['BACKEND'] = 'pipeline.storage.NonPackagingPipelineStorage' # noqa: F405 # Don't use compression during tests -PIPELINE['JS_COMPRESSOR'] = None +PIPELINE['JS_COMPRESSOR'] = None # noqa: F405 update_module_store_settings( - MODULESTORE, + MODULESTORE, # noqa: F405 module_store_options={ - 'fs_root': TEST_ROOT / "data", + 'fs_root': TEST_ROOT / "data", # noqa: F405 }, xml_store_options={ - 'data_dir': mkdtemp_clean(dir=TEST_ROOT), # never inadvertently load all the XML courses + 'data_dir': mkdtemp_clean(dir=TEST_ROOT), # never inadvertently load all the XML courses # noqa: F405 }, doc_store_settings={ - 'host': MONGO_HOST, - 'port': MONGO_PORT_NUM, - 'db': f'test_xmodule_{THIS_UUID}', + 'host': MONGO_HOST, # noqa: F405 + 'port': MONGO_PORT_NUM, # noqa: F405 + 'db': f'test_xmodule_{THIS_UUID}', # noqa: F405 'collection': 'test_modulestore', }, ) @@ -121,9 +120,9 @@ CONTENTSTORE = { 'ENGINE': 'xmodule.contentstore.mongo.MongoContentStore', 'DOC_STORE_CONFIG': { - 'host': MONGO_HOST, - 'db': f'test_xcontent_{THIS_UUID}', - 'port': MONGO_PORT_NUM, + 'host': MONGO_HOST, # noqa: F405 + 'db': f'test_xcontent_{THIS_UUID}', # noqa: F405 + 'port': MONGO_PORT_NUM, # noqa: F405 } } @@ -185,7 +184,7 @@ 'common.djangoapps.third_party_auth.dummy.DummyBackend', 'common.djangoapps.third_party_auth.saml.SAMLAuthBackend', 'common.djangoapps.third_party_auth.lti.LTIAuthBackend', -] + AUTHENTICATION_BACKENDS +] + AUTHENTICATION_BACKENDS # noqa: F405 THIRD_PARTY_AUTH_CUSTOM_AUTH_FORMS = { 'custom1': { @@ -241,22 +240,22 @@ CLASS_DASHBOARD = True # add extra template directory for test-only templates -MAKO_TEMPLATE_DIRS_BASE.extend([ - COMMON_ROOT / 'test' / 'templates', - COMMON_ROOT / 'test' / 'test_sites', - REPO_ROOT / 'openedx' / 'core' / 'djangolib' / 'tests' / 'templates', +MAKO_TEMPLATE_DIRS_BASE.extend([ # noqa: F405 + COMMON_ROOT / 'test' / 'templates', # noqa: F405 + COMMON_ROOT / 'test' / 'test_sites', # noqa: F405 + REPO_ROOT / 'openedx' / 'core' / 'djangolib' / 'tests' / 'templates', # noqa: F405 ]) # Setting for the testing of Software Secure Result Callback -VERIFY_STUDENT["SOFTWARE_SECURE"] = { +VERIFY_STUDENT["SOFTWARE_SECURE"] = { # noqa: F405 "API_ACCESS_KEY": "BBBBBBBBBBBBBBBBBBBB", "API_SECRET_KEY": "CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC", } ######### dashboard git log settings ######### MONGODB_LOG = { - 'host': MONGO_HOST, - 'port': MONGO_PORT_NUM, + 'host': MONGO_HOST, # noqa: F405 + 'port': MONGO_PORT_NUM, # noqa: F405 'user': '', 'password': '', 'db': 'xlog', @@ -275,13 +274,13 @@ FACEBOOK_API_VERSION = "v2.8" ######### custom courses ######### -INSTALLED_APPS += ['lms.djangoapps.ccx', 'openedx.core.djangoapps.ccxcon.apps.CCXConnectorConfig'] +INSTALLED_APPS += ['lms.djangoapps.ccx', 'openedx.core.djangoapps.ccxcon.apps.CCXConnectorConfig'] # noqa: F405 # Set dummy values for profile image settings. PROFILE_IMAGE_BACKEND = { 'class': 'openedx.core.storage.OverwriteStorage', 'options': { - 'location': MEDIA_ROOT, + 'location': MEDIA_ROOT, # noqa: F405 'base_url': 'http://example-storage.com/profile-images/', }, } @@ -307,7 +306,7 @@ COURSE_CATALOG_URL_ROOT = 'https://catalog.example.com' COURSE_CATALOG_API_URL = f'{COURSE_CATALOG_URL_ROOT}/api/v1' -COMPREHENSIVE_THEME_LOCALE_PATHS = [REPO_ROOT / "themes/conf/locale", ] +COMPREHENSIVE_THEME_LOCALE_PATHS = [REPO_ROOT / "themes/conf/locale", ] # noqa: F405 PREPEND_LOCALE_PATHS = [] @@ -331,16 +330,16 @@ ACTIVATION_EMAIL_FROM_ADDRESS = 'test_activate@edx.org' -TEMPLATES[0]['OPTIONS']['debug'] = True -TEMPLATES.append( +TEMPLATES[0]['OPTIONS']['debug'] = True # noqa: F405 +TEMPLATES.append( # noqa: F405 { # This separate copy of the Mako backend is used to test rendering previews in the 'lms.main' namespace 'NAME': 'preview', 'BACKEND': 'common.djangoapps.edxmako.backend.Mako', 'APP_DIRS': False, - 'DIRS': MAKO_TEMPLATE_DIRS_BASE, + 'DIRS': MAKO_TEMPLATE_DIRS_BASE, # noqa: F405 'OPTIONS': { - 'context_processors': CONTEXT_PROCESSORS, + 'context_processors': CONTEXT_PROCESSORS, # noqa: F405 'debug': False, 'namespace': 'lms.main', } @@ -351,7 +350,7 @@ # Most of the JWT_AUTH settings come from lms/envs/common.py (from openedx/envs/common.py), # but here we update to use JWKS values from openedx/envs/test.py for testing. -JWT_AUTH.update(jwt_jwks_values) +JWT_AUTH.update(jwt_jwks_values) # noqa: F405 ####################### Plugin Settings ########################## @@ -362,23 +361,23 @@ derive_settings(__name__) ############################ STATIC FILES ############################# -STATICFILES_DIRS.append(("uploads", MEDIA_ROOT)) +STATICFILES_DIRS.append(("uploads", MEDIA_ROOT)) # noqa: F405 _NEW_STATICFILES_DIRS = [] # Strip out any static files that aren't in the repository root # so that the tests can run with only the edx-platform directory checked out -for static_dir in STATICFILES_DIRS: # pylint: disable=not-an-iterable +for static_dir in STATICFILES_DIRS: # pylint: disable=not-an-iterable # noqa: F405 # Handle both tuples and non-tuple directory definitions try: _, data_dir = static_dir except ValueError: data_dir = static_dir - if data_dir.startswith(REPO_ROOT): + if data_dir.startswith(REPO_ROOT): # noqa: F405 _NEW_STATICFILES_DIRS.append(static_dir) STATICFILES_DIRS = _NEW_STATICFILES_DIRS -FILE_UPLOAD_TEMP_DIR = TEST_ROOT / "uploads" +FILE_UPLOAD_TEMP_DIR = TEST_ROOT / "uploads" # noqa: F405 FILE_UPLOAD_HANDLERS = [ 'django.core.files.uploadhandler.MemoryFileUploadHandler', 'django.core.files.uploadhandler.TemporaryFileUploadHandler', @@ -494,7 +493,7 @@ } ### Course Live -COURSE_LIVE_GLOBAL_CREDENTIALS["BIG_BLUE_BUTTON"] = big_blue_button_credentials +COURSE_LIVE_GLOBAL_CREDENTIALS["BIG_BLUE_BUTTON"] = big_blue_button_credentials # noqa: F405 ### Override default production settings for testing purposes @@ -504,19 +503,19 @@ CERT_QUEUE = "certificates" CMS_BASE = "localhost:18010" COMMENTS_SERVICE_KEY = "password" -del BROKER_HEARTBEAT -del BROKER_HEARTBEAT_CHECKRATE -del BROKER_USE_SSL -del DEFAULT_ENTERPRISE_API_URL -del DEFAULT_ENTERPRISE_CONSENT_API_URL -del EMAIL_FILE_PATH -del ENABLE_REQUIRE_THIRD_PARTY_AUTH -del ENTITLEMENTS_EXPIRATION_ROUTING_KEY -del PYTHON_LIB_FILENAME -del REGISTRATION_CODE_LENGTH -del SESSION_INACTIVITY_TIMEOUT_IN_SECONDS -del SSL_AUTH_DN_FORMAT_STRING -del SSL_AUTH_EMAIL_DOMAIN +del BROKER_HEARTBEAT # noqa: F821 +del BROKER_HEARTBEAT_CHECKRATE # noqa: F821 +del BROKER_USE_SSL # noqa: F821 +del DEFAULT_ENTERPRISE_API_URL # noqa: F821 +del DEFAULT_ENTERPRISE_CONSENT_API_URL # noqa: F821 +del EMAIL_FILE_PATH # noqa: F821 +del ENABLE_REQUIRE_THIRD_PARTY_AUTH # noqa: F821 +del ENTITLEMENTS_EXPIRATION_ROUTING_KEY # noqa: F821 +del PYTHON_LIB_FILENAME # noqa: F821 +del REGISTRATION_CODE_LENGTH # noqa: F821 +del SESSION_INACTIVITY_TIMEOUT_IN_SECONDS # noqa: F821 +del SSL_AUTH_DN_FORMAT_STRING # noqa: F821 +del SSL_AUTH_EMAIL_DOMAIN # noqa: F821 EDX_API_KEY = "PUT_YOUR_API_KEY_HERE" ENTERPRISE_PUBLIC_ENROLLMENT_API_URL = "https://localhost:18000/api/enrollment/v1/" GOOGLE_ANALYTICS_LINKEDIN = "GOOGLE_ANALYTICS_LINKEDIN_DUMMY" diff --git a/lms/lib/courseware_search/lms_filter_generator.py b/lms/lib/courseware_search/lms_filter_generator.py index 5b2592e4cd19..5c95852028f9 100644 --- a/lms/lib/courseware_search/lms_filter_generator.py +++ b/lms/lib/courseware_search/lms_filter_generator.py @@ -5,10 +5,10 @@ from django.conf import settings from search.filter_generator import SearchFilterGenerator +from common.djangoapps.student.models import CourseEnrollment from openedx.core.djangoapps.course_groups.partition_scheme import CohortPartitionScheme from openedx.core.djangoapps.site_configuration import helpers as configuration_helpers from openedx.core.djangoapps.user_api.partition_schemes import RandomUserPartitionScheme -from common.djangoapps.student.models import CourseEnrollment from xmodule.course_block import CATALOG_VISIBILITY_ABOUT, CATALOG_VISIBILITY_NONE INCLUDE_SCHEMES = [CohortPartitionScheme, RandomUserPartitionScheme, ] diff --git a/lms/lib/courseware_search/lms_result_processor.py b/lms/lib/courseware_search/lms_result_processor.py index c48abe87c432..b0852876fc74 100644 --- a/lms/lib/courseware_search/lms_result_processor.py +++ b/lms/lib/courseware_search/lms_result_processor.py @@ -11,7 +11,7 @@ from lms.djangoapps.course_blocks.api import get_course_blocks from lms.djangoapps.courseware.access import has_access -from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order class LmsSearchResultProcessor(SearchResultProcessor): diff --git a/lms/lib/courseware_search/test/test_lms_filter_generator.py b/lms/lib/courseware_search/test/test_lms_filter_generator.py index 8afa94f70fbf..c47617343e70 100644 --- a/lms/lib/courseware_search/test/test_lms_filter_generator.py +++ b/lms/lib/courseware_search/test/test_lms_filter_generator.py @@ -3,12 +3,17 @@ """ from unittest.mock import Mock, patch -from lms.lib.courseware_search.lms_filter_generator import LmsSearchFilterGenerator from common.djangoapps.student.models import CourseEnrollment from common.djangoapps.student.tests.factories import UserFactory +from lms.lib.courseware_search.lms_filter_generator import LmsSearchFilterGenerator from xmodule.course_block import CATALOG_VISIBILITY_ABOUT, CATALOG_VISIBILITY_NONE -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory, BlockFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + ModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import ( # pylint: disable=wrong-import-order + BlockFactory, + CourseFactory, +) class LmsSearchFilterGeneratorTestCase(ModuleStoreTestCase): diff --git a/lms/lib/courseware_search/test/test_lms_result_processor.py b/lms/lib/courseware_search/test/test_lms_result_processor.py index c482ce2ca810..37430f5dfb11 100644 --- a/lms/lib/courseware_search/test/test_lms_result_processor.py +++ b/lms/lib/courseware_search/test/test_lms_result_processor.py @@ -5,8 +5,13 @@ from common.djangoapps.student.tests.factories import UserFactory from lms.lib.courseware_search.lms_result_processor import LmsSearchResultProcessor -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory, BlockFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + ModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import ( # pylint: disable=wrong-import-order + BlockFactory, + CourseFactory, +) class LmsSearchResultProcessorTestCase(ModuleStoreTestCase): @@ -67,7 +72,7 @@ def setUp(self): def test_url_parameter(self): fake_url = "" srp = LmsSearchResultProcessor({}, "test") - with pytest.raises(ValueError): + with pytest.raises(ValueError): # noqa: PT011 fake_url = srp.url assert fake_url == '' @@ -80,7 +85,7 @@ def test_url_parameter(self): "test" ) - assert srp.url == '/courses/{}/jump_to/{}'.format(str(self.course.id), + assert srp.url == '/courses/{}/jump_to/{}'.format(str(self.course.id), # noqa: UP032 str(self.html.scope_ids.usage_id)) def test_should_remove(self): diff --git a/lms/lib/tests/test_utils.py b/lms/lib/tests/test_utils.py index ae0aea31d7e3..17bcce1a5843 100644 --- a/lms/lib/tests/test_utils.py +++ b/lms/lib/tests/test_utils.py @@ -4,8 +4,13 @@ from lms.lib import utils -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory, BlockFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + ModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import ( # pylint: disable=wrong-import-order + BlockFactory, + CourseFactory, +) class LmsUtilsTest(ModuleStoreTestCase): diff --git a/lms/lib/xblock/test/test_mixin.py b/lms/lib/xblock/test/test_mixin.py index 248ac234ca6f..41a87223b226 100644 --- a/lms/lib/xblock/test/test_mixin.py +++ b/lms/lib/xblock/test/test_mixin.py @@ -1,4 +1,4 @@ -# lint-amnesty, pylint: disable=django-not-configured +# pylint: disable=django-not-configured """ Tests of the LMS XBlock Mixin """ @@ -11,12 +11,19 @@ INVALID_USER_PARTITION_GROUP_VALIDATION_UNIT, INVALID_USER_PARTITION_VALIDATION_COMPONENT, INVALID_USER_PARTITION_VALIDATION_UNIT, - NONSENSICAL_ACCESS_RESTRICTION + NONSENSICAL_ACCESS_RESTRICTION, ) -from xmodule.modulestore import ModuleStoreEnum # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.django_utils import TEST_DATA_SPLIT_MODULESTORE, ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory, BlockFactory, ToyCourseFactory # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.partitions.partitions import Group, UserPartition # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore import ModuleStoreEnum # pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( # pylint: disable=wrong-import-order + TEST_DATA_SPLIT_MODULESTORE, + ModuleStoreTestCase, +) +from xmodule.modulestore.tests.factories import ( # pylint: disable=wrong-import-order + BlockFactory, + CourseFactory, + ToyCourseFactory, +) +from xmodule.partitions.partitions import Group, UserPartition # pylint: disable=wrong-import-order class LmsXBlockMixinTestCase(ModuleStoreTestCase): @@ -367,7 +374,7 @@ class RenamedTuple(tuple): This class is only used to allow overriding __name__ on the tuples passed through ddt, in order to have the generated test names make sense. """ - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass def ddt_named(parent, child): diff --git a/lms/static/js/instructor_dashboard/membership.js b/lms/static/js/instructor_dashboard/membership.js index ac5d63fbdc4c..0d6147c26bce 100644 --- a/lms/static/js/instructor_dashboard/membership.js +++ b/lms/static/js/instructor_dashboard/membership.js @@ -608,7 +608,9 @@ such that the value can be defined later than this assignment (file load order). this.$reason_field = this.$container.find("textarea[name='reason-field']"); this.$checkbox_autoenroll = this.$container.find("input[name='auto-enroll']"); this.$checkbox_emailstudents = this.$container.find("input[name='email-students']"); + this.$checkbox_asyncprocessing = this.$container.find("input[name='async-processing']"); this.checkbox_emailstudents_initialstate = this.$checkbox_emailstudents.is(':checked'); + this.checkbox_asyncprocessing_initialstate = this.$checkbox_asyncprocessing.is(':checked'); this.$task_response = this.$container.find('.request-response'); this.$request_response_error = this.$container.find('.request-response-error'); this.$enrollment_button.click(function(event) { @@ -624,6 +626,7 @@ such that the value can be defined later than this assignment (file load order). identifiers: batchEnroll.$identifier_input.val(), auto_enroll: batchEnroll.$checkbox_autoenroll.is(':checked'), email_students: emailStudents, + async_processing: batchEnroll.$checkbox_asyncprocessing.is(':checked'), reason: batchEnroll.$reason_field.val() }; return $.ajax({ @@ -645,6 +648,7 @@ such that the value can be defined later than this assignment (file load order). this.$identifier_input.val(''); this.$reason_field.val(''); this.$checkbox_emailstudents.attr('checked', this.checkbox_emailstudents_initialstate); + this.$checkbox_asyncprocessing.attr('checked', this.checkbox_asyncprocessing_initialstate); return this.$checkbox_autoenroll.attr('checked', true); }; @@ -655,6 +659,43 @@ such that the value can be defined later than this assignment (file load order). return this.$request_response_error.text(msg); }; + batchEnrollment.prototype.show_async_processing_message = function (dataFromServer) { + const { action: rawAction = 'process' } = dataFromServer; + + const actionsMap = { + enroll: { + text: gettext('enrollment'), + title: gettext('Enrollment Request Submitted') + }, + unenroll: { + text: gettext('unenrollment'), + title: gettext('Unenrollment Request Submitted') + }, + process: { + text: gettext('processing'), + title: gettext('Request Submitted') + } + }; + + const { text: actionText, title } = actionsMap[rawAction] || actionsMap.process; + + const message = interpolate( + gettext( + 'Your %(action)s request is being processed in the background. ' + + 'This may take several minutes to complete. You will receive an email ' + + 'notification when the process is finished.' + ), + { action: actionText }, + true + ); + + const $taskResSection = $('
          ', { class: 'request-res-section' }) + .append($('

          ', { text: title })) + .append($('
            ').append($('
          • ', { text: message }))); + + return this.$task_response.append($taskResSection); + }; + batchEnrollment.prototype.display_response = function(dataFromServer) { var allowed, autoenrolled, enrolled, errors, errorsLabel, invalidIdentifier, notenrolled, notunenrolled, renderList, sr, studentResults, @@ -671,6 +712,12 @@ such that the value can be defined later than this assignment (file load order). notenrolled = []; notunenrolled = []; ref = dataFromServer.results; + if (!ref) { + if (dataFromServer.error) { + return this.fail_with_error(dataFromServer.error); + } + return this.show_async_processing_message(dataFromServer); + } for (i = 0, len = ref.length; i < len; i++) { studentResults = ref[i]; if (studentResults.invalidIdentifier) { diff --git a/lms/static/js/main.js b/lms/static/js/main.js index b6c5ae512b15..31ac8962f52e 100644 --- a/lms/static/js/main.js +++ b/lms/static/js/main.js @@ -7,8 +7,10 @@ $(function() { $.ajaxSetup({ - headers: { - 'X-CSRFToken': $.cookie('csrftoken') + beforeSend: function(xhr, settings) { + if (!(/^(GET|HEAD|OPTIONS|TRACE)$/i.test(settings.type)) && !this.crossDomain) { + xhr.setRequestHeader('X-CSRFToken', $.cookie('csrftoken')); + } }, dataType: 'json' }); diff --git a/lms/static/js/spec/api_admin/catalog_preview_spec.js b/lms/static/js/spec/api_admin/catalog_preview_spec.js index 4e439fa8f0e9..ddb73f614eb1 100644 --- a/lms/static/js/spec/api_admin/catalog_preview_spec.js +++ b/lms/static/js/spec/api_admin/catalog_preview_spec.js @@ -1,17 +1,25 @@ define([ + 'sinon', 'js/api_admin/views/catalog_preview', 'edx-ui-toolkit/js/utils/spec-helpers/ajax-helpers' ], function( - CatalogPreviewView, AjaxHelpers + sinon, CatalogPreviewView, AjaxHelpers ) { 'use strict'; describe('Catalog preview view', function() { var view, + requests, + xhrFactory, previewUrl = 'http://example.com/api-admin/catalogs/preview/', catalogApiUrl = 'http://api.example.com/catalog/v1/courses/'; beforeEach(function() { + xhrFactory = sinon.useFakeXMLHttpRequest(); + requests = []; + requests.currentIndex = 0; + requests.restore = function() { xhrFactory.restore(); }; + xhrFactory.onCreate = function(req) { requests.push(req); }; setFixtures( '
            ' + '' @@ -26,12 +34,15 @@ define([ view.render(); }); + afterEach(function() { + requests.restore(); + }); + it('can render itself', function() { expect(view.$('button.preview-query').length).toBe(1); }); it('can retrieve a list of catalogs and display them', function() { - var requests = AjaxHelpers.requests(this); view.$('#id_query').val('*'); view.$('.preview-query').click(); AjaxHelpers.expectRequest(requests, 'GET', previewUrl + '?q=*'); @@ -46,7 +57,6 @@ define([ }); it('displays an error when courses cannot be retrieved', function() { - var requests = AjaxHelpers.requests(this); view.$('#id_query').val('*'); view.$('.preview-query').click(); AjaxHelpers.respondWithError(requests, 500); diff --git a/lms/static/js/spec/ccx/schedule_spec.js b/lms/static/js/spec/ccx/schedule_spec.js index 29ce7a6dc58f..b16c90b1fd02 100644 --- a/lms/static/js/spec/ccx/schedule_spec.js +++ b/lms/static/js/spec/ccx/schedule_spec.js @@ -1,10 +1,16 @@ -define(['edx-ui-toolkit/js/utils/spec-helpers/ajax-helpers', 'js/ccx/schedule'], - function(AjaxHelpers) { +define(['sinon', 'edx-ui-toolkit/js/utils/spec-helpers/ajax-helpers', 'js/ccx/schedule'], + function(sinon, AjaxHelpers) { describe('edx.ccx.schedule.ScheduleView', function() { var view = null; var data; + var requests, xhrFactory; beforeEach(function() { + xhrFactory = sinon.useFakeXMLHttpRequest(); + requests = []; + requests.currentIndex = 0; + requests.restore = function() { xhrFactory.restore(); }; + xhrFactory.onCreate = function(req) { requests.push(req); }; loadFixtures('js/fixtures/ccx/schedule.html'); var scheduleFixture = readFixtures('templates/ccx/schedule.underscore'); @@ -51,6 +57,10 @@ define(['edx-ui-toolkit/js/utils/spec-helpers/ajax-helpers', 'js/ccx/schedule'], view.render(); }); + afterEach(function() { + requests.restore(); + }); + it('verifies correct view setup', function() { expect(view.dirty).toBe(false); expect(view.showing).toEqual([]); @@ -204,7 +214,6 @@ define(['edx-ui-toolkit/js/utils/spec-helpers/ajax-helpers', 'js/ccx/schedule'], }); it('saves schedule changes', function() { - requests = AjaxHelpers.requests(this); view.save(); expect(requests.length).toEqual(1); AjaxHelpers.expectJsonRequest(requests, 'POST', 'save_ccx', view.schedule); @@ -217,7 +226,6 @@ define(['edx-ui-toolkit/js/utils/spec-helpers/ajax-helpers', 'js/ccx/schedule'], }); it('displays an error if the sync fails', function() { - requests = AjaxHelpers.requests(this); view.save(); requests[0].respond(500); expect($('#ajax-error')).toHaveCss({display: 'block'}); diff --git a/lms/static/js/spec/dashboard/donation.js b/lms/static/js/spec/dashboard/donation.js index 50edd8b255a9..66b07a175b9d 100644 --- a/lms/static/js/spec/dashboard/donation.js +++ b/lms/static/js/spec/dashboard/donation.js @@ -1,7 +1,7 @@ -define(['common/js/spec_helpers/template_helpers', +define(['sinon', 'common/js/spec_helpers/template_helpers', 'edx-ui-toolkit/js/utils/spec-helpers/ajax-helpers', 'js/dashboard/donation'], -function(TemplateHelpers, AjaxHelpers) { +function(sinon, TemplateHelpers, AjaxHelpers) { 'use strict'; describe('edx.dashboard.donation.DonationView', function() { @@ -15,6 +15,7 @@ function(TemplateHelpers, AjaxHelpers) { var view = null; var requests = null; + var xhrFactory = null; beforeEach(function() { setFixtures('
            '); @@ -34,12 +35,18 @@ function(TemplateHelpers, AjaxHelpers) { // Stub the analytics event tracker window.analytics = jasmine.createSpyObj('analytics', ['track']); + xhrFactory = sinon.useFakeXMLHttpRequest(); + requests = []; + requests.currentIndex = 0; + requests.restore = function() { xhrFactory.restore(); }; + xhrFactory.onCreate = function(req) { requests.push(req); }; }); - it('processes a donation for a course', function() { - // Spy on AJAX requests - requests = AjaxHelpers.requests(this); + afterEach(function() { + requests.restore(); + }); + it('processes a donation for a course', function() { // Enter a donation amount and proceed to the payment page view.$amount.val(AMOUNT); view.donate(); @@ -119,9 +126,6 @@ function(TemplateHelpers, AjaxHelpers) { }); it('displays an error when the server cannot be contacted', function() { - // Spy on AJAX requests - requests = AjaxHelpers.requests(this); - // Simulate an error from the LMS servers view.donate(); AjaxHelpers.respondWithError(requests); diff --git a/lms/static/js/spec/discovery/discovery_factory_spec.js b/lms/static/js/spec/discovery/discovery_factory_spec.js index 6ce1a9e2d657..25b87907be26 100644 --- a/lms/static/js/spec/discovery/discovery_factory_spec.js +++ b/lms/static/js/spec/discovery/discovery_factory_spec.js @@ -1,7 +1,7 @@ define([ - 'jquery', 'edx-ui-toolkit/js/utils/spec-helpers/ajax-helpers', 'common/js/spec_helpers/template_helpers', + 'jquery', 'sinon', 'edx-ui-toolkit/js/utils/spec-helpers/ajax-helpers', 'common/js/spec_helpers/template_helpers', 'js/discovery/discovery_factory' -], function($, AjaxHelpers, TemplateHelpers, DiscoveryFactory) { +], function($, sinon, AjaxHelpers, TemplateHelpers, DiscoveryFactory) { 'use strict'; var MEANINGS = { @@ -94,7 +94,14 @@ define([ }; describe('discovery.DiscoveryFactory', function() { + var requests, xhrFactory; + beforeEach(function() { + xhrFactory = sinon.useFakeXMLHttpRequest(); + requests = []; + requests.currentIndex = 0; + requests.restore = function() { xhrFactory.restore(); }; + xhrFactory.onCreate = function(req) { requests.push(req); }; loadFixtures('js/fixtures/discovery.html'); TemplateHelpers.installTemplates([ 'templates/discovery/course_card', @@ -110,10 +117,10 @@ define([ afterEach(function() { jasmine.clock().uninstall(); + requests.restore(); }); it('does search', function() { - var requests = AjaxHelpers.requests(this); $('.discovery-input').val('test'); $('.discovery-submit').trigger('click'); AjaxHelpers.respondWithJson(requests, JSON_RESPONSE); @@ -123,7 +130,6 @@ define([ }); it('loads more', function() { - var requests = AjaxHelpers.requests(this); $('.discovery-input').val('test'); $('.discovery-submit').trigger('click'); @@ -141,7 +147,6 @@ define([ }); it('displays not found message', function() { - var requests = AjaxHelpers.requests(this); $('.discovery-input').val('asdfasdf'); $('.discovery-submit').trigger('click'); AjaxHelpers.respondWithJson(requests, {}); @@ -151,7 +156,6 @@ define([ }); it('displays error message', function() { - var requests = AjaxHelpers.requests(this); $('.discovery-input').val('asdfasdf'); $('.discovery-submit').trigger('click'); AjaxHelpers.respondWithError(requests, 404, {error: 'some-search-error'}); @@ -161,7 +165,6 @@ define([ }); it('check filters and bar removed on clear all', function() { - var requests = AjaxHelpers.requests(this); $('.discovery-input').val('test'); $('.discovery-submit').trigger('click'); AjaxHelpers.respondWithJson(requests, JSON_RESPONSE); @@ -173,7 +176,6 @@ define([ }); it('check filters and bar removed on last filter cleared', function() { - var requests = AjaxHelpers.requests(this); $('.discovery-input').val('test'); $('.discovery-submit').trigger('click'); AjaxHelpers.respondWithJson(requests, JSON_RESPONSE); @@ -184,7 +186,6 @@ define([ }); it('filter results by named facet', function() { - var requests = AjaxHelpers.requests(this); $('.discovery-input').val('test'); $('.discovery-submit').trigger('click'); AjaxHelpers.respondWithJson(requests, JSON_RESPONSE); @@ -198,7 +199,14 @@ define([ }); describe('discovery.DiscoveryFactory default filters', function() { + var requests, xhrFactory; + beforeEach(function() { + xhrFactory = sinon.useFakeXMLHttpRequest(); + requests = []; + requests.currentIndex = 0; + requests.restore = function() { xhrFactory.restore(); }; + xhrFactory.onCreate = function(req) { requests.push(req); }; loadFixtures('js/fixtures/discovery.html'); TemplateHelpers.installTemplates([ 'templates/discovery/course_card', @@ -215,10 +223,10 @@ define([ afterEach(function() { jasmine.clock().uninstall(); + requests.restore(); }); it('filters by default language', function() { - var requests = AjaxHelpers.requests(this); $('.discovery-submit').trigger('click'); var request = AjaxHelpers.currentRequest(requests); // make sure language filter is set diff --git a/lms/static/js/spec/discovery/models/course_directory_spec.js b/lms/static/js/spec/discovery/models/course_directory_spec.js index b7a0bb8f15ec..eafd4664b4a4 100644 --- a/lms/static/js/spec/discovery/models/course_directory_spec.js +++ b/lms/static/js/spec/discovery/models/course_directory_spec.js @@ -1,6 +1,6 @@ define([ - 'edx-ui-toolkit/js/utils/spec-helpers/ajax-helpers', 'js/discovery/models/course_discovery' -], function(AjaxHelpers, CourseDiscovery) { + 'sinon', 'edx-ui-toolkit/js/utils/spec-helpers/ajax-helpers', 'js/discovery/models/course_discovery' +], function(sinon, AjaxHelpers, CourseDiscovery) { 'use strict'; var JSON_RESPONSE = { @@ -70,13 +70,23 @@ define([ }; describe('discovery.models.CourseDiscovery', function() { + var requests, xhrFactory; + beforeEach(function() { - var requests = AjaxHelpers.requests(this); + xhrFactory = sinon.useFakeXMLHttpRequest(); + requests = []; + requests.currentIndex = 0; + requests.restore = function() { xhrFactory.restore(); }; + xhrFactory.onCreate = function(req) { requests.push(req); }; this.discovery = new CourseDiscovery(); this.discovery.fetch(); AjaxHelpers.respondWithJson(requests, JSON_RESPONSE); }); + afterEach(function() { + requests.restore(); + }); + it('parses server response', function() { expect(this.discovery.courseCards.length).toBe(1); expect(this.discovery.facetOptions.length).toBe(27); diff --git a/lms/static/js/spec/discovery/models/search_state_spec.js b/lms/static/js/spec/discovery/models/search_state_spec.js index 61dc4d1d3ef5..2d5f26733f79 100644 --- a/lms/static/js/spec/discovery/models/search_state_spec.js +++ b/lms/static/js/spec/discovery/models/search_state_spec.js @@ -1,6 +1,6 @@ define([ - 'edx-ui-toolkit/js/utils/spec-helpers/ajax-helpers', 'js/discovery/models/search_state' -], function(AjaxHelpers, SearchState) { + 'sinon', 'edx-ui-toolkit/js/utils/spec-helpers/ajax-helpers', 'js/discovery/models/search_state' +], function(sinon, AjaxHelpers, SearchState) { 'use strict'; var JSON_RESPONSE = { @@ -29,7 +29,14 @@ define([ }; describe('discovery.models.SearchState', function() { + var requests, xhrFactory; + beforeEach(function() { + xhrFactory = sinon.useFakeXMLHttpRequest(); + requests = []; + requests.currentIndex = 0; + requests.restore = function() { xhrFactory.restore(); }; + xhrFactory.onCreate = function(req) { requests.push(req); }; this.search = new SearchState(); this.onSearch = jasmine.createSpy('onSearch'); this.onNext = jasmine.createSpy('onNext'); @@ -39,8 +46,11 @@ define([ this.search.on('error', this.onError); }); + afterEach(function() { + requests.restore(); + }); + it('perform search', function() { - var requests = AjaxHelpers.requests(this); this.search.performSearch('dummy'); AjaxHelpers.respondWithJson(requests, JSON_RESPONSE); expect(this.onSearch).toHaveBeenCalledWith('dummy', 365); @@ -51,14 +61,12 @@ define([ }); it('returns an error', function() { - var requests = AjaxHelpers.requests(this); this.search.performSearch(''); AjaxHelpers.respondWithError(requests, 500); expect(this.onError).toHaveBeenCalled(); }); it('loads next page', function() { - var requests = AjaxHelpers.requests(this); this.search.performSearch('dummy'); AjaxHelpers.respondWithJson(requests, JSON_RESPONSE); this.search.loadNextPage(); @@ -67,7 +75,6 @@ define([ }); it('shows all results when there are none', function() { - var requests = AjaxHelpers.requests(this); this.search.performSearch('dummy', {modes: 'SomeOption'}); // no results AjaxHelpers.respondWithJson(requests, {total: 0}); diff --git a/lms/static/js/spec/edxnotes/plugins/events_spec.js b/lms/static/js/spec/edxnotes/plugins/events_spec.js index 304c5746de19..46440c954b63 100644 --- a/lms/static/js/spec/edxnotes/plugins/events_spec.js +++ b/lms/static/js/spec/edxnotes/plugins/events_spec.js @@ -1,7 +1,7 @@ define([ - 'jquery', 'underscore', 'edx-ui-toolkit/js/utils/spec-helpers/ajax-helpers', 'js/spec/edxnotes/helpers', + 'jquery', 'underscore', 'sinon', 'edx-ui-toolkit/js/utils/spec-helpers/ajax-helpers', 'js/spec/edxnotes/helpers', 'annotator_1.2.9', 'logger', 'js/edxnotes/views/notes_factory' -], function($, _, AjaxHelpers, Helpers, Annotator, Logger, NotesFactory) { +], function($, _, sinon, AjaxHelpers, Helpers, Annotator, Logger, NotesFactory) { 'use strict'; describe('EdxNotes Events Plugin', function() { @@ -20,8 +20,14 @@ define([ usage_id: 'usage-123', tags: ['tag1', 'tag2'] }; + var requests, xhrFactory; beforeEach(function() { + xhrFactory = sinon.useFakeXMLHttpRequest(); + requests = []; + requests.currentIndex = 0; + requests.restore = function() { xhrFactory.restore(); }; + xhrFactory.onCreate = function(req) { requests.push(req); }; this.annotator = NotesFactory.factory( $('
            ').get(0), { endpoint: 'http://example.com/', @@ -35,6 +41,7 @@ define([ while (Annotator._instances.length > 0) { Annotator._instances[0].destroy(); } + requests.restore(); }); it('should log edx.course.student_notes.viewed event properly', function() { @@ -57,8 +64,7 @@ define([ }); it('should log edx.course.student_notes.added event properly', function() { - var requests = AjaxHelpers.requests(this), - newNote = { + var newNote = { user: 'user-123', text: 'text-123', quote: 'quote-123', diff --git a/lms/static/js/spec/edxnotes/plugins/store_error_handler_spec.js b/lms/static/js/spec/edxnotes/plugins/store_error_handler_spec.js index fd4d78932613..b7a407015643 100644 --- a/lms/static/js/spec/edxnotes/plugins/store_error_handler_spec.js +++ b/lms/static/js/spec/edxnotes/plugins/store_error_handler_spec.js @@ -1,14 +1,21 @@ define([ - 'jquery', 'underscore', 'annotator_1.2.9', + 'jquery', 'underscore', 'sinon', 'annotator_1.2.9', 'edx-ui-toolkit/js/utils/spec-helpers/ajax-helpers', 'js/spec/edxnotes/helpers', 'js/edxnotes/views/notes_factory', 'js/edxnotes/utils/notes_collector' -], function($, _, Annotator, AjaxHelpers, Helpers, NotesFactory, NotesCollector) { +], function($, _, sinon, Annotator, AjaxHelpers, Helpers, NotesFactory, NotesCollector) { 'use strict'; describe('Store Error Handler Custom Message', function() { + var requests, xhrFactory; + beforeEach(function() { + xhrFactory = sinon.useFakeXMLHttpRequest(); + requests = []; + requests.currentIndex = 0; + requests.restore = function() { xhrFactory.restore(); }; + xhrFactory.onCreate = function(req) { requests.push(req); }; spyOn(Annotator, 'showNotification'); loadFixtures('js/fixtures/edxnotes/edxnotes_wrapper.html'); NotesCollector.cleanup(); @@ -18,10 +25,10 @@ define([ while (Annotator._instances.length > 0) { // eslint-disable-line no-underscore-dangle Annotator._instances[0].destroy(); // eslint-disable-line no-underscore-dangle } + requests.restore(); }); it('can handle custom error if sent from server', function() { - var requests = AjaxHelpers.requests(this); var token = Helpers.makeToken(); _.each($('.edx-notes-wrapper'), function(wrapper) { NotesFactory.factory(wrapper, { diff --git a/lms/static/js/spec/edxnotes/utils/notes_collector_spec.js b/lms/static/js/spec/edxnotes/utils/notes_collector_spec.js index 1c92151cbf45..d9c2d371a198 100644 --- a/lms/static/js/spec/edxnotes/utils/notes_collector_spec.js +++ b/lms/static/js/spec/edxnotes/utils/notes_collector_spec.js @@ -1,13 +1,20 @@ define([ - 'jquery', 'underscore', 'annotator_1.2.9', 'edx-ui-toolkit/js/utils/spec-helpers/ajax-helpers', + 'jquery', 'underscore', 'sinon', 'annotator_1.2.9', 'edx-ui-toolkit/js/utils/spec-helpers/ajax-helpers', 'js/edxnotes/views/notes_factory', 'js/edxnotes/utils/notes_collector', 'js/spec/edxnotes/helpers' ], function( - $, _, Annotator, AjaxHelpers, NotesFactory, NotesCollector, Helpers + $, _, sinon, Annotator, AjaxHelpers, NotesFactory, NotesCollector, Helpers ) { 'use strict'; describe('EdxNotes NotesCollector', function() { + var requests, xhrFactory; + beforeEach(function() { + xhrFactory = sinon.useFakeXMLHttpRequest(); + requests = []; + requests.currentIndex = 0; + requests.restore = function() { xhrFactory.restore(); }; + xhrFactory.onCreate = function(req) { requests.push(req); }; loadFixtures('js/fixtures/edxnotes/edxnotes_wrapper.html'); NotesCollector.cleanup(); }); @@ -17,11 +24,11 @@ define([ Annotator._instances[0].destroy(); // eslint-disable-line no-underscore-dangle } NotesCollector.cleanup(); + requests.restore(); }); it('sends single search request to fetch notes for all HTML components', function() { - var requests = AjaxHelpers.requests(this), - token = Helpers.makeToken(); + var token = Helpers.makeToken(); _.each($('.edx-notes-wrapper'), function(wrapper, index) { NotesFactory.factory(wrapper, { diff --git a/lms/static/js/spec/edxnotes/views/note_item_spec.js b/lms/static/js/spec/edxnotes/views/note_item_spec.js index 5636c1e26f81..00e232e24534 100644 --- a/lms/static/js/spec/edxnotes/views/note_item_spec.js +++ b/lms/static/js/spec/edxnotes/views/note_item_spec.js @@ -1,13 +1,14 @@ define([ - 'jquery', 'underscore', 'edx-ui-toolkit/js/utils/spec-helpers/ajax-helpers', + 'jquery', 'underscore', 'sinon', 'edx-ui-toolkit/js/utils/spec-helpers/ajax-helpers', 'common/js/spec_helpers/template_helpers', 'js/spec/edxnotes/helpers', 'logger', 'js/edxnotes/models/note', 'js/edxnotes/views/note_item' ], function( - $, _, AjaxHelpers, TemplateHelpers, Helpers, Logger, NoteModel, NoteItemView + $, _, sinon, AjaxHelpers, TemplateHelpers, Helpers, Logger, NoteModel, NoteItemView ) { 'use strict'; describe('EdxNotes NoteItemView', function() { + var requests, xhrFactory; var getView = function(model, scrollToTag, formattedText) { model = new NoteModel(_.defaults(model || {}, { id: 'id-123', @@ -26,10 +27,19 @@ define([ }; beforeEach(function() { + xhrFactory = sinon.useFakeXMLHttpRequest(); + requests = []; + requests.currentIndex = 0; + requests.restore = function() { xhrFactory.restore(); }; + xhrFactory.onCreate = function(req) { requests.push(req); }; TemplateHelpers.installTemplate('templates/edxnotes/note-item'); spyOn(Logger, 'log').and.callThrough(); }); + afterEach(function() { + requests.restore(); + }); + it('can be rendered properly', function() { var view = getView(), unitLink = view.$('.reference-unit-link').get(0); @@ -111,8 +121,7 @@ define([ }); it('should log the edx.course.student_notes.used_unit_link event properly', function() { - var requests = AjaxHelpers.requests(this), - view = getView(); + var view = getView(); spyOn(view, 'redirectTo'); view.$('.reference-unit-link').click(); expect(Logger.log).toHaveBeenCalledWith( diff --git a/lms/static/js/spec/edxnotes/views/notes_factory_spec.js b/lms/static/js/spec/edxnotes/views/notes_factory_spec.js index dba04d47ac2e..dfd721daa3e7 100644 --- a/lms/static/js/spec/edxnotes/views/notes_factory_spec.js +++ b/lms/static/js/spec/edxnotes/views/notes_factory_spec.js @@ -1,11 +1,18 @@ define([ - 'jquery', 'underscore', 'annotator_1.2.9', 'js/edxnotes/views/notes_factory', + 'jquery', 'underscore', 'sinon', 'annotator_1.2.9', 'js/edxnotes/views/notes_factory', 'edx-ui-toolkit/js/utils/spec-helpers/ajax-helpers', 'js/edxnotes/utils/notes_collector', 'js/spec/edxnotes/helpers' -], function($, _, Annotator, NotesFactory, AjaxHelpers, NotesCollector, Helpers) { +], function($, _, sinon, Annotator, NotesFactory, AjaxHelpers, NotesCollector, Helpers) { 'use strict'; describe('EdxNotes NotesFactory', function() { + var requests, xhrFactory; + beforeEach(function() { + xhrFactory = sinon.useFakeXMLHttpRequest(); + requests = []; + requests.currentIndex = 0; + requests.restore = function() { xhrFactory.restore(); }; + xhrFactory.onCreate = function(req) { requests.push(req); }; loadFixtures('js/fixtures/edxnotes/edxnotes_wrapper.html'); NotesCollector.cleanup(); }); @@ -14,11 +21,11 @@ define([ while (Annotator._instances.length > 0) { Annotator._instances[0].destroy(); } + requests.restore(); }); it('can initialize annotator correctly', function(done) { - var requests = AjaxHelpers.requests(this), - token = Helpers.makeToken(), + var token = Helpers.makeToken(), options = { user: 'a user', usage_id: 'an usage', diff --git a/lms/static/js/spec/edxnotes/views/notes_page_spec.js b/lms/static/js/spec/edxnotes/views/notes_page_spec.js index 0ab25cfa9183..4503e8045bc5 100644 --- a/lms/static/js/spec/edxnotes/views/notes_page_spec.js +++ b/lms/static/js/spec/edxnotes/views/notes_page_spec.js @@ -1,14 +1,20 @@ define([ - 'jquery', 'underscore', 'common/js/spec_helpers/template_helpers', + 'jquery', 'underscore', 'sinon', 'common/js/spec_helpers/template_helpers', 'edx-ui-toolkit/js/utils/spec-helpers/ajax-helpers', 'js/spec/edxnotes/helpers', 'js/edxnotes/views/page_factory' -], function($, _, TemplateHelpers, AjaxHelpers, Helpers, NotesFactory) { +], function($, _, sinon, TemplateHelpers, AjaxHelpers, Helpers, NotesFactory) { 'use strict'; describe('EdxNotes NotesPage', function() { var notes = Helpers.getDefaultNotes(); + var requests, xhrFactory; beforeEach(function() { + xhrFactory = sinon.useFakeXMLHttpRequest(); + requests = []; + requests.currentIndex = 0; + requests.restore = function() { xhrFactory.restore(); }; + xhrFactory.onCreate = function(req) { requests.push(req); }; loadFixtures('js/fixtures/edxnotes/edxnotes.html'); TemplateHelpers.installTemplates([ 'templates/edxnotes/note-item', 'templates/edxnotes/tab-item' @@ -16,9 +22,12 @@ define([ this.view = new NotesFactory({notes: notes, pageSize: 10}); }); + afterEach(function() { + requests.restore(); + }); + it('should be displayed properly', function() { - var requests = AjaxHelpers.requests(this), - tab; + var tab; expect(this.view.$('#view-search-results')).not.toExist(); tab = this.view.$('#view-recent-activity'); diff --git a/lms/static/js/spec/edxnotes/views/notes_visibility_factory_spec.js b/lms/static/js/spec/edxnotes/views/notes_visibility_factory_spec.js index 6416d9035a82..7c15813439a2 100644 --- a/lms/static/js/spec/edxnotes/views/notes_visibility_factory_spec.js +++ b/lms/static/js/spec/edxnotes/views/notes_visibility_factory_spec.js @@ -1,12 +1,13 @@ define([ - 'jquery', 'underscore', 'annotator_1.2.9', 'edx-ui-toolkit/js/utils/spec-helpers/ajax-helpers', + 'jquery', 'underscore', 'sinon', 'annotator_1.2.9', 'edx-ui-toolkit/js/utils/spec-helpers/ajax-helpers', 'js/edxnotes/views/notes_visibility_factory', 'js/edxnotes/utils/notes_collector', 'js/spec/edxnotes/helpers' ], function( - $, _, Annotator, AjaxHelpers, NotesVisibilityFactory, NotesCollector, Helpers + $, _, sinon, Annotator, AjaxHelpers, NotesVisibilityFactory, NotesCollector, Helpers ) { 'use strict'; describe('EdxNotes ToggleNotesFactory', function() { + var requests, xhrFactory; var params = { endpoint: '/test_endpoint/', user: 'user12345', @@ -17,6 +18,11 @@ define([ }; beforeEach(function() { + xhrFactory = sinon.useFakeXMLHttpRequest(); + requests = []; + requests.currentIndex = 0; + requests.restore = function() { xhrFactory.restore(); }; + xhrFactory.onCreate = function(req) { requests.push(req); }; loadFixtures( 'js/fixtures/edxnotes/edxnotes_wrapper.html', 'js/fixtures/edxnotes/toggle_notes.html' @@ -42,10 +48,10 @@ define([ } $('.annotator-notice').remove(); NotesCollector.cleanup(); + requests.restore(); }); it('can toggle notes', function() { - var requests = AjaxHelpers.requests(this); expect(this.toggleVisibilityButton).not.toHaveClass('is-disabled'); expect(this.label).toContainText('Hide notes'); @@ -85,8 +91,7 @@ define([ }); it('can handle errors', function() { - var requests = AjaxHelpers.requests(this), - $errorContainer = $('.annotator-notice'); + var $errorContainer = $('.annotator-notice'); this.toggleVisibilityButton.click(); AjaxHelpers.respondWithError(requests); diff --git a/lms/static/js/spec/edxnotes/views/search_box_spec.js b/lms/static/js/spec/edxnotes/views/search_box_spec.js index a0ad28e4d9e2..33ada5f54587 100644 --- a/lms/static/js/spec/edxnotes/views/search_box_spec.js +++ b/lms/static/js/spec/edxnotes/views/search_box_spec.js @@ -1,16 +1,18 @@ define([ 'jquery', 'underscore', + 'sinon', 'edx-ui-toolkit/js/utils/spec-helpers/ajax-helpers', 'edx-ui-toolkit/js/utils/html-utils', 'js/edxnotes/views/search_box', 'js/edxnotes/collections/notes', 'js/spec/edxnotes/helpers' -], function($, _, AjaxHelpers, HtmlUtils, SearchBoxView, NotesCollection, Helpers) { +], function($, _, sinon, AjaxHelpers, HtmlUtils, SearchBoxView, NotesCollection, Helpers) { 'use strict'; describe('EdxNotes SearchBoxView', function() { var getSearchBox, submitForm, assertBoxIsEnabled, assertBoxIsDisabled, searchResponse; + var requests, xhrFactory; searchResponse = { count: 2, @@ -53,14 +55,22 @@ define([ }; beforeEach(function() { + xhrFactory = sinon.useFakeXMLHttpRequest(); + requests = []; + requests.currentIndex = 0; + requests.restore = function() { xhrFactory.restore(); }; + xhrFactory.onCreate = function(req) { requests.push(req); }; loadFixtures('js/fixtures/edxnotes/edxnotes.html'); spyOn(Logger, 'log'); this.searchBox = getSearchBox(); }); + afterEach(function() { + requests.restore(); + }); + it('sends a request with proper information on submit the form', function() { - var requests = AjaxHelpers.requests(this), - form = this.searchBox.el, + var form = this.searchBox.el, request; submitForm(this.searchBox, 'test_text'); @@ -74,7 +84,6 @@ define([ }); it('returns success result', function() { - var requests = AjaxHelpers.requests(this); submitForm(this.searchBox, 'test_text'); expect(this.searchBox.options.beforeSearchStart).toHaveBeenCalledWith( 'test_text' @@ -91,7 +100,6 @@ define([ }); it('should log the edx.course.student_notes.searched event properly', function() { - var requests = AjaxHelpers.requests(this); submitForm(this.searchBox, 'test_text'); AjaxHelpers.respondWithJson(requests, searchResponse); @@ -102,7 +110,6 @@ define([ }); it('returns default error message if received data structure is wrong', function() { - var requests = AjaxHelpers.requests(this); submitForm(this.searchBox, 'test_text'); AjaxHelpers.respondWithJson(requests, {}); expect(this.searchBox.options.error).toHaveBeenCalledWith( @@ -115,7 +122,6 @@ define([ }); it('returns default error message if network error occurs', function() { - var requests = AjaxHelpers.requests(this); submitForm(this.searchBox, 'test_text'); AjaxHelpers.respondWithError(requests); expect(this.searchBox.options.error).toHaveBeenCalledWith( @@ -128,7 +134,6 @@ define([ }); it('returns error message if server error occurs', function() { - var requests = AjaxHelpers.requests(this); submitForm(this.searchBox, 'test_text'); assertBoxIsDisabled(this.searchBox); @@ -150,7 +155,6 @@ define([ }); it('does not send second request during current search', function() { - var requests = AjaxHelpers.requests(this); submitForm(this.searchBox, 'test_text'); assertBoxIsDisabled(this.searchBox); submitForm(this.searchBox, 'another_text'); @@ -160,7 +164,6 @@ define([ }); it('returns error message if the field is empty', function() { - var requests = AjaxHelpers.requests(this); submitForm(this.searchBox, ' '); expect(requests).toHaveLength(0); assertBoxIsEnabled(this.searchBox); diff --git a/lms/static/js/spec/edxnotes/views/tabs/recent_activity_spec.js b/lms/static/js/spec/edxnotes/views/tabs/recent_activity_spec.js index 55272793ee17..c9093bd6dc81 100644 --- a/lms/static/js/spec/edxnotes/views/tabs/recent_activity_spec.js +++ b/lms/static/js/spec/edxnotes/views/tabs/recent_activity_spec.js @@ -1,9 +1,9 @@ define([ - 'jquery', 'common/js/spec_helpers/template_helpers', 'edx-ui-toolkit/js/utils/spec-helpers/ajax-helpers', + 'jquery', 'sinon', 'common/js/spec_helpers/template_helpers', 'edx-ui-toolkit/js/utils/spec-helpers/ajax-helpers', 'js/edxnotes/collections/notes', 'js/edxnotes/collections/tabs', 'js/edxnotes/views/tabs/recent_activity', 'js/spec/edxnotes/helpers' ], function( - $, TemplateHelpers, AjaxHelpers, NotesCollection, TabsCollection, RecentActivityView, Helpers + $, sinon, TemplateHelpers, AjaxHelpers, NotesCollection, TabsCollection, RecentActivityView, Helpers ) { 'use strict'; @@ -36,7 +36,8 @@ define([ } ] }, - getView, tabInfo, recentActivityTabId; + getView, tabInfo, recentActivityTabId, + requests, xhrFactory; getView = function(collection, tabsCollection, options) { var view; @@ -66,6 +67,11 @@ define([ recentActivityTabId = '#recent-panel'; beforeEach(function() { + xhrFactory = sinon.useFakeXMLHttpRequest(); + requests = []; + requests.currentIndex = 0; + requests.restore = function() { xhrFactory.restore(); }; + xhrFactory.onCreate = function(req) { requests.push(req); }; loadFixtures('js/fixtures/edxnotes/edxnotes.html'); TemplateHelpers.installTemplates([ 'templates/edxnotes/note-item', 'templates/edxnotes/tab-item' @@ -76,6 +82,10 @@ define([ this.tabsCollection = new TabsCollection(); }); + afterEach(function() { + requests.restore(); + }); + it('displays a tab and content with proper data and order', function() { var view = getView(this.collection, this.tabsCollection); Helpers.verifyPaginationInfo(view, 'Showing 1-3 out of 3 total', true, 1, 1); @@ -100,7 +110,6 @@ define([ }); it('can go to a page number', function() { - var requests = AjaxHelpers.requests(this); // eslint-disable-next-line no-shadow var notes = Helpers.createNotesData( { @@ -141,7 +150,6 @@ define([ }); it('can navigate forward and backward', function() { - var requests = AjaxHelpers.requests(this); var page1Notes = Helpers.createNotesData( { numNotesToCreate: 10, @@ -188,7 +196,6 @@ define([ }); it('sends correct page size value', function() { - var requests = AjaxHelpers.requests(this); // eslint-disable-next-line no-shadow var notes = Helpers.createNotesData( { diff --git a/lms/static/js/spec/edxnotes/views/tabs/search_results_spec.js b/lms/static/js/spec/edxnotes/views/tabs/search_results_spec.js index 74f94c2273b5..e44194fe47a1 100644 --- a/lms/static/js/spec/edxnotes/views/tabs/search_results_spec.js +++ b/lms/static/js/spec/edxnotes/views/tabs/search_results_spec.js @@ -1,10 +1,10 @@ define([ - 'jquery', 'underscore', 'common/js/spec_helpers/template_helpers', + 'jquery', 'underscore', 'sinon', 'common/js/spec_helpers/template_helpers', 'edx-ui-toolkit/js/utils/spec-helpers/ajax-helpers', 'logger', 'js/edxnotes/collections/tabs', 'js/edxnotes/views/tabs/search_results', 'js/spec/edxnotes/helpers' ], function( - $, _, TemplateHelpers, AjaxHelpers, Logger, TabsCollection, SearchResultsView, Helpers + $, _, sinon, TemplateHelpers, AjaxHelpers, Logger, TabsCollection, SearchResultsView, Helpers ) { 'use strict'; @@ -38,7 +38,8 @@ define([ previous: null, results: notes }, - getView, submitForm, tabInfo, searchResultsTabId; + getView, submitForm, tabInfo, searchResultsTabId, + requests, xhrFactory; getView = function(tabsCollection, perPage, options) { options = _.defaults(options || {}, { @@ -70,6 +71,11 @@ define([ searchResultsTabId = '#search-results-panel'; beforeEach(function() { + xhrFactory = sinon.useFakeXMLHttpRequest(); + requests = []; + requests.currentIndex = 0; + requests.restore = function() { xhrFactory.restore(); }; + xhrFactory.onCreate = function(req) { requests.push(req); }; loadFixtures('js/fixtures/edxnotes/edxnotes.html'); TemplateHelpers.installTemplates([ 'templates/edxnotes/note-item', 'templates/edxnotes/tab-item' @@ -78,6 +84,10 @@ define([ this.tabsCollection = new TabsCollection(); }); + afterEach(function() { + requests.restore(); + }); + it('does not create a tab and content on initialization', function() { var view = getView(this.tabsCollection); expect(this.tabsCollection).toHaveLength(0); @@ -85,8 +95,7 @@ define([ }); it('displays a tab and content on search with proper data and order', function() { - var view = getView(this.tabsCollection), - requests = AjaxHelpers.requests(this); + var view = getView(this.tabsCollection); submitForm(view.searchBox, 'second'); Helpers.respondToRequest(requests, responseJson, true); @@ -95,8 +104,7 @@ define([ }); it('displays loading indicator when search is running', function() { - var view = getView(this.tabsCollection), - requests = AjaxHelpers.requests(this); + var view = getView(this.tabsCollection); submitForm(view.searchBox, 'test query'); expect(view.$('.ui-loading')).not.toHaveClass('is-hidden'); @@ -109,8 +117,7 @@ define([ }); it('displays no results message', function() { - var view = getView(this.tabsCollection), - requests = AjaxHelpers.requests(this); + var view = getView(this.tabsCollection); submitForm(view.searchBox, 'some text'); Helpers.respondToRequest(requests, _.extend(_.clone(responseJson), {count: 0, results: []}), true); @@ -124,8 +131,7 @@ define([ }); it('does not send an additional request on switching between tabs', function() { - var view = getView(this.tabsCollection), - requests = AjaxHelpers.requests(this); + var view = getView(this.tabsCollection); spyOn(Logger, 'log'); submitForm(view.searchBox, 'test_query'); @@ -144,8 +150,7 @@ define([ }); it('can clear search results if tab is closed', function() { - var view = getView(this.tabsCollection), - requests = AjaxHelpers.requests(this); + var view = getView(this.tabsCollection); spyOn(view.searchBox, 'clearInput').and.callThrough(); submitForm(view.searchBox, 'test_query'); @@ -157,8 +162,7 @@ define([ }); it('can correctly show/hide error messages', function() { - var view = getView(this.tabsCollection), - requests = AjaxHelpers.requests(this); + var view = getView(this.tabsCollection); submitForm(view.searchBox, 'test error'); @@ -181,7 +185,6 @@ define([ it('can correctly update search results', function() { var view = getView(this.tabsCollection), - requests = AjaxHelpers.requests(this), newNotes = [{ created: 'December 11, 2014 at 11:10AM', updated: 'December 11, 2014 at 11:10AM', @@ -213,7 +216,6 @@ define([ it('will not render header and footer if there are no notes', function() { var view = getView(this.tabsCollection), - requests = AjaxHelpers.requests(this), // eslint-disable-next-line no-shadow notes = { count: 0, @@ -232,7 +234,6 @@ define([ it('can go to a page number', function() { var view = getView(this.tabsCollection), - requests = AjaxHelpers.requests(this), // eslint-disable-next-line no-shadow notes = Helpers.createNotesData( { @@ -271,8 +272,7 @@ define([ }); it('can navigate forward and backward', function() { - var requests = AjaxHelpers.requests(this), - page1Notes = Helpers.createNotesData( + var page1Notes = Helpers.createNotesData( { numNotesToCreate: 10, count: 15, @@ -318,8 +318,7 @@ define([ }); it('sends correct page size value', function() { - var requests = AjaxHelpers.requests(this), - view = getView(this.tabsCollection, 5); + var view = getView(this.tabsCollection, 5); submitForm(view.searchBox, 'awesome'); Helpers.verifyRequestParams( diff --git a/lms/static/js/spec/groups/views/cohorts_spec.js b/lms/static/js/spec/groups/views/cohorts_spec.js index 0a1e75f9c447..baabcdf87a38 100644 --- a/lms/static/js/spec/groups/views/cohorts_spec.js +++ b/lms/static/js/spec/groups/views/cohorts_spec.js @@ -1,12 +1,12 @@ /* globals _ */ -define(['backbone', 'jquery', 'edx-ui-toolkit/js/utils/spec-helpers/ajax-helpers', +define(['backbone', 'jquery', 'sinon', 'edx-ui-toolkit/js/utils/spec-helpers/ajax-helpers', 'common/js/spec_helpers/template_helpers', 'js/groups/views/cohorts', 'js/groups/collections/cohort', 'js/groups/models/content_group', 'js/groups/models/course_cohort_settings', 'js/utils/animation', 'js/vendor/jquery.qubit', 'js/groups/views/course_cohort_settings_notification' ], -function(Backbone, $, AjaxHelpers, TemplateHelpers, CohortsView, CohortCollection, ContentGroupModel, +function(Backbone, $, sinon, AjaxHelpers, TemplateHelpers, CohortsView, CohortCollection, ContentGroupModel, CourseCohortSettingsModel, AnimationUtil, Qubit, CourseCohortSettingsNotificationView) { 'use strict'; @@ -17,7 +17,7 @@ function(Backbone, $, AjaxHelpers, TemplateHelpers, CohortsView, CohortCollectio notAllowedUserMessage, invalidEmailMessage, createMockCohort, createMockCohorts, createMockContentGroups, createMockCohortSettingsJson, - createCohortsView, cohortsView, requests, respondToRefresh, verifyMessage, verifyNoMessage, + createCohortsView, cohortsView, requests, xhrFactory, respondToRefresh, verifyMessage, verifyNoMessage, verifyDetailedMessage, verifyHeader, expectCohortAddRequest, getAddModal, selectContentGroup, clearContentGroup, saveFormAndExpectErrors, createMockCohortSettings, MOCK_COHORTED_USER_PARTITION_ID, @@ -85,7 +85,6 @@ function(Backbone, $, AjaxHelpers, TemplateHelpers, CohortsView, CohortCollectio cohortSettings.url = '/mock_service/cohorts/settings'; cohorts.url = '/mock_service/cohorts'; - requests = AjaxHelpers.requests(test); cohortsView = new CohortsView({ model: cohorts, contentGroups: contentGroups, @@ -215,6 +214,11 @@ function(Backbone, $, AjaxHelpers, TemplateHelpers, CohortsView, CohortCollectio }; beforeEach(function() { + xhrFactory = sinon.useFakeXMLHttpRequest(); + requests = []; + requests.currentIndex = 0; + requests.restore = function() { xhrFactory.restore(); }; + xhrFactory.onCreate = function(req) { requests.push(req); }; setFixtures('
              ' + '
            ' @@ -229,6 +233,10 @@ function(Backbone, $, AjaxHelpers, TemplateHelpers, CohortsView, CohortCollectio TemplateHelpers.installTemplate('templates/file-upload'); }); + afterEach(function() { + requests.restore(); + }); + it('shows an error if no cohorts are defined', function() { createCohortsView(this, {cohorts: []}); verifyMessage( diff --git a/lms/static/js/spec/groups/views/discussions_spec.js b/lms/static/js/spec/groups/views/discussions_spec.js index ca872911427d..e386de07e3f4 100644 --- a/lms/static/js/spec/groups/views/discussions_spec.js +++ b/lms/static/js/spec/groups/views/discussions_spec.js @@ -1,14 +1,14 @@ -define(['backbone', 'jquery', 'edx-ui-toolkit/js/utils/spec-helpers/ajax-helpers', +define(['backbone', 'jquery', 'sinon', 'edx-ui-toolkit/js/utils/spec-helpers/ajax-helpers', 'common/js/spec_helpers/template_helpers', 'js/discussions_management/views/discussions', 'js/discussions_management/models/course_discussions_detail', 'js/discussions_management/models/course_discussions_settings' ], -function(Backbone, $, AjaxHelpers, TemplateHelpers, DiscussionsView, CourseDiscussionTopicDetailsModel, +function(Backbone, $, sinon, AjaxHelpers, TemplateHelpers, DiscussionsView, CourseDiscussionTopicDetailsModel, CourseDiscussionsSettingsModel) { 'use strict'; describe('Discussions View', function() { - var createMockDiscussionsSettingsJson, createDiscussionsView, discussionsView, requests, verifyMessage, + var createMockDiscussionsSettingsJson, createDiscussionsView, discussionsView, requests, xhrFactory, verifyMessage, createMockDiscussionsSettings, createMockDiscussionsJson, createMockDiscussions, showAndAssertDiscussionTopics; @@ -111,7 +111,6 @@ function(Backbone, $, AjaxHelpers, TemplateHelpers, DiscussionsView, CourseDiscu dividedDiscussions = discussionOptions.dividedDiscussions || createMockDiscussions(); dividedDiscussions.url = '/mock_service/discussion/topics'; - requests = AjaxHelpers.requests(test); discussionsView = new DiscussionsView({ el: $('.discussions-management'), discussionSettings: discussionSettings, @@ -147,6 +146,11 @@ function(Backbone, $, AjaxHelpers, TemplateHelpers, DiscussionsView, CourseDiscu }; beforeEach(function() { + xhrFactory = sinon.useFakeXMLHttpRequest(); + requests = []; + requests.currentIndex = 0; + requests.restore = function() { xhrFactory.restore(); }; + xhrFactory.onCreate = function(req) { requests.push(req); }; setFixtures('
              ' + '
            ' @@ -167,6 +171,10 @@ function(Backbone, $, AjaxHelpers, TemplateHelpers, DiscussionsView, CourseDiscu TemplateHelpers.installTemplate('templates/instructor/instructor_dashboard_2/notification'); }); + afterEach(function() { + requests.restore(); + }); + describe('Discussion Topics', function() { var courseWideView, assertDividedTopics; diff --git a/lms/static/js/spec/instructor_dashboard/certificates_exception_spec.js b/lms/static/js/spec/instructor_dashboard/certificates_exception_spec.js index a48fa9f6fa37..a97a36998d3d 100644 --- a/lms/static/js/spec/instructor_dashboard/certificates_exception_spec.js +++ b/lms/static/js/spec/instructor_dashboard/certificates_exception_spec.js @@ -54,7 +54,8 @@ function($, sinon, AjaxHelpers, CertificateExceptionModel, CertificateAllowlistV describe('edx.certificates.collections.certificate_allowlist.CertificateAllowlist', function() { var certificateAllowlist = null, - certificateExceptionUrl = 'test/url/'; + certificateExceptionUrl = 'test/url/', + requests, xhrFactory; var certificatesExceptionsJson = [ { id: 1, @@ -77,6 +78,11 @@ function($, sinon, AjaxHelpers, CertificateExceptionModel, CertificateAllowlistV ]; beforeEach(function() { + xhrFactory = sinon.useFakeXMLHttpRequest(); + requests = []; + requests.currentIndex = 0; + requests.restore = function() { xhrFactory.restore(); }; + xhrFactory.onCreate = function(req) { requests.push(req); }; certificateAllowlist = new CertificateAllowlistCollection(certificatesExceptionsJson, { parse: true, canBeEmpty: true, @@ -85,6 +91,10 @@ function($, sinon, AjaxHelpers, CertificateExceptionModel, CertificateAllowlistV }); }); + afterEach(function() { + requests.restore(); + }); + it('has 2 models in the collection after initialization', function() { expect(certificateAllowlist.models.length).toEqual(2); }); @@ -126,7 +136,6 @@ function($, sinon, AjaxHelpers, CertificateExceptionModel, CertificateAllowlistV it('sends empty certificate exceptions list if no model is added', function() { var successCallback = sinon.spy(), errorCallback = sinon.spy(), - requests = AjaxHelpers.requests(this), addStudents = 'all'; var expected = { url: certificateExceptionUrl + addStudents, @@ -140,7 +149,6 @@ function($, sinon, AjaxHelpers, CertificateExceptionModel, CertificateAllowlistV it('syncs only newly added models with the server', function() { var successCallback = sinon.spy(), errorCallback = sinon.spy(), - requests = AjaxHelpers.requests(this), addStudents = 'new', expected; @@ -293,7 +301,8 @@ function($, sinon, AjaxHelpers, CertificateExceptionModel, CertificateAllowlistV describe('edx.certificates.views.certificate_allowlist_editor.CertificateAllowlistEditorView', function() { var view = null, listView = null, - certificateExceptionUrl = 'test/url/'; + certificateExceptionUrl = 'test/url/', + requests, xhrFactory; var certificatesExceptionsJson = [ { url: certificateExceptionUrl, @@ -319,6 +328,11 @@ function($, sinon, AjaxHelpers, CertificateExceptionModel, CertificateAllowlistV ]; beforeEach(function() { + xhrFactory = sinon.useFakeXMLHttpRequest(); + requests = []; + requests.currentIndex = 0; + requests.restore = function() { xhrFactory.restore(); }; + xhrFactory.onCreate = function(req) { requests.push(req); }; var fixture, fixture2, certificateAllowlist; setFixtures(); @@ -357,6 +371,10 @@ function($, sinon, AjaxHelpers, CertificateExceptionModel, CertificateAllowlistV listView.render(); }); + afterEach(function() { + requests.restore(); + }); + it('verifies view is initialized and rendered successfully', function() { expect(view).not.toBe(undefined); expect(view.$el.find('#certificate-exception').length).toBe(1); @@ -368,7 +386,6 @@ function($, sinon, AjaxHelpers, CertificateExceptionModel, CertificateAllowlistV var messageSelector = '.message', successMessage = 'test_user has been successfully added to the exception list. Click Generate' + ' Exception Certificate below to send the certificate.', - requests = AjaxHelpers.requests(this), duplicateUser = 'test_user'; var errorMessages = { @@ -417,8 +434,7 @@ function($, sinon, AjaxHelpers, CertificateExceptionModel, CertificateAllowlistV it('verifies certificate exception can be deleted by clicking "delete" ', function() { var username = 'test1', certificateExceptionSelector = "div.allowlisted-students table tr:contains('" + username + "')", - deleteBtnSelector = certificateExceptionSelector + ' td .delete-exception', - requests = AjaxHelpers.requests(this); + deleteBtnSelector = certificateExceptionSelector + ' td .delete-exception'; $(deleteBtnSelector).click(); AjaxHelpers.respondWithJson(requests, {}); diff --git a/lms/static/js/spec/instructor_dashboard/certificates_invalidation_spec.js b/lms/static/js/spec/instructor_dashboard/certificates_invalidation_spec.js index bedb7c970aba..3fb517a1fa5c 100644 --- a/lms/static/js/spec/instructor_dashboard/certificates_invalidation_spec.js +++ b/lms/static/js/spec/instructor_dashboard/certificates_invalidation_spec.js @@ -1,12 +1,13 @@ /* global define */ define([ 'jquery', + 'sinon', 'edx-ui-toolkit/js/utils/spec-helpers/ajax-helpers', 'js/certificates/models/certificate_invalidation', 'js/certificates/views/certificate_invalidation_view', 'js/certificates/collections/certificate_invalidation_collection' ], -function($, AjaxHelpers, CertificateInvalidationModel, CertificateInvalidationView, +function($, sinon, AjaxHelpers, CertificateInvalidationModel, CertificateInvalidationView, CertificateInvalidationCollection) { 'use strict'; @@ -99,7 +100,8 @@ function($, AjaxHelpers, CertificateInvalidationModel, CertificateInvalidationVi invalidate_button = null, duplicate_user = 'test2', new_user = 'test4@test.com', - requests = null; + requests = null, + xhrFactory = null; var messages = { error: { @@ -163,7 +165,15 @@ function($, AjaxHelpers, CertificateInvalidationModel, CertificateInvalidationVi notes_field = $('#certificate-invalidation-notes'); invalidate_button = $('#invalidate-certificate'); - requests = AjaxHelpers.requests(this); + xhrFactory = sinon.useFakeXMLHttpRequest(); + requests = []; + requests.currentIndex = 0; + requests.restore = function() { xhrFactory.restore(); }; + xhrFactory.onCreate = function(req) { requests.push(req); }; + }); + + afterEach(function() { + requests.restore(); }); it('verifies view is initialized and rendered successfully', function() { diff --git a/lms/static/js/spec/instructor_dashboard/certificates_spec.js b/lms/static/js/spec/instructor_dashboard/certificates_spec.js index e0558d558337..b2e1df912638 100644 --- a/lms/static/js/spec/instructor_dashboard/certificates_spec.js +++ b/lms/static/js/spec/instructor_dashboard/certificates_spec.js @@ -1,16 +1,18 @@ /* global define, onCertificatesReady */ define([ 'jquery', + 'sinon', 'edx-ui-toolkit/js/utils/spec-helpers/ajax-helpers', 'js/instructor_dashboard/certificates' ], -function($, AjaxHelpers) { +function($, sinon, AjaxHelpers) { 'use strict'; describe('edx.instructor_dashboard.certificates.regenerate_certificates', function() { var $regenerate_certificates_button = null, $certificate_regeneration_status = null, - requests = null; + requests = null, + xhrFactory = null; var MESSAGES = { success_message: 'Certificate regeneration task has been started. ' + 'You can view the status of the generation task in the "Pending Tasks" section.', @@ -62,7 +64,15 @@ function($, AjaxHelpers) { onCertificatesReady(); $regenerate_certificates_button = $('#btn-start-regenerating-certificates'); $certificate_regeneration_status = $('.certificate-regeneration-status'); - requests = AjaxHelpers.requests(this); + xhrFactory = sinon.useFakeXMLHttpRequest(); + requests = []; + requests.currentIndex = 0; + requests.restore = function() { xhrFactory.restore(); }; + xhrFactory.onCreate = function(req) { requests.push(req); }; + }); + + afterEach(function() { + requests.restore(); }); it('does not regenerate certificates if user cancels operation in confirm popup', function() { diff --git a/lms/static/js/spec/instructor_dashboard/membership_auth_spec.js b/lms/static/js/spec/instructor_dashboard/membership_auth_spec.js index 0d4ba1bb273f..2eaaea35458b 100644 --- a/lms/static/js/spec/instructor_dashboard/membership_auth_spec.js +++ b/lms/static/js/spec/instructor_dashboard/membership_auth_spec.js @@ -1,13 +1,16 @@ /* global define, Membership */ define(['jquery', + 'sinon', 'edx-ui-toolkit/js/utils/spec-helpers/ajax-helpers', 'js/instructor_dashboard/membership'], -function($, AjaxHelpers) { +function($, sinon, AjaxHelpers) { 'use strict'; describe('Membership.AuthListWidget', function() { var membership, // eslint-disable-line no-unused-vars - changeSelectedList; + changeSelectedList, + requests, + xhrFactory; changeSelectedList = function(listName) { var i, options; @@ -22,6 +25,11 @@ function($, AjaxHelpers) { }; beforeEach(function() { + xhrFactory = sinon.useFakeXMLHttpRequest(); + requests = []; + requests.currentIndex = 0; + requests.restore = function() { xhrFactory.restore(); }; + xhrFactory.onCreate = function(req) { requests.push(req); }; var membershipMain, membershipTpl; membershipMain = readFixtures('js/fixtures/instructor_dashboard/membership.html'); membershipTpl = readFixtures( @@ -34,9 +42,12 @@ function($, AjaxHelpers) { membership = new window.InstructorDashboard.sections.Membership($('#membership')); }); + afterEach(function() { + requests.restore(); + }); + it('binds the ajax call and the result will be success for Group Moderator', function() { - var requests = AjaxHelpers.requests(this), - data, + var data, url = '/courses/course-v1:edx+ed202+2017_T3/instructor/api/list_forum_members'; data = { @@ -66,7 +77,6 @@ function($, AjaxHelpers) { it('Error message is shown if user with given identifier does not exist', function() { var url, params; - var requests = AjaxHelpers.requests(this); $('.active .add-field').val('smth'); $('.active .add').click(); expect(requests.length).toEqual(1); @@ -90,8 +100,7 @@ function($, AjaxHelpers) { }); it('When no discussions division scheme is selected error is shown and inputs are disabled', function() { - var requests = AjaxHelpers.requests(this), - data, + var data, url = '/courses/course-v1:edx+ed202+2017_T3/instructor/api/list_forum_members'; data = { diff --git a/lms/static/js/spec/instructor_dashboard/student_admin_spec.js b/lms/static/js/spec/instructor_dashboard/student_admin_spec.js index a4314228e006..efaedc646caf 100644 --- a/lms/static/js/spec/instructor_dashboard/student_admin_spec.js +++ b/lms/static/js/spec/instructor_dashboard/student_admin_spec.js @@ -1,12 +1,12 @@ /* globals _, interpolate_text, statusAjaxError, PendingInstructorTasks, createTaskListTable */ -define(['jquery', 'js/instructor_dashboard/student_admin', 'edx-ui-toolkit/js/utils/spec-helpers/ajax-helpers'], - function($, StudentAdmin, AjaxHelpers) { +define(['jquery', 'sinon', 'js/instructor_dashboard/student_admin', 'edx-ui-toolkit/js/utils/spec-helpers/ajax-helpers'], + function($, sinon, StudentAdmin, AjaxHelpers) { // 'js/instructor_dashboard/student_admin' 'use strict'; describe('edx.instructor_dashboard.student_admin.StudentAdmin', function() { - var studentadmin, dashboardApiUrl, uniqStudentIdentifier, alertMsg; + var studentadmin, dashboardApiUrl, uniqStudentIdentifier, alertMsg, requests, xhrFactory; beforeEach(function() { loadFixtures('js/fixtures/instructor_dashboard/student_admin.html'); @@ -23,6 +23,15 @@ define(['jquery', 'js/instructor_dashboard/student_admin', 'edx-ui-toolkit/js/ut spyOn(window, 'alert').and.callFake(function(message) { alertMsg = message; }); + xhrFactory = sinon.useFakeXMLHttpRequest(); + requests = []; + requests.currentIndex = 0; + requests.restore = function() { xhrFactory.restore(); }; + xhrFactory.onCreate = function(req) { requests.push(req); }; + }); + + afterEach(function() { + requests.restore(); }); it('initiates resetting of entrance exam when button is clicked', function() { @@ -32,9 +41,6 @@ define(['jquery', 'js/instructor_dashboard/student_admin', 'edx-ui-toolkit/js/ut }); var url = dashboardApiUrl + '/reset_student_attempts_for_entrance_exam'; - // Spy on AJAX requests - var requests = AjaxHelpers.requests(this); - // Verify that the client contacts the server to start instructor task var params = $.param({ unique_student_identifier: uniqStudentIdentifier, @@ -61,8 +67,6 @@ define(['jquery', 'js/instructor_dashboard/student_admin', 'edx-ui-toolkit/js/ut it('shows an error when resetting of entrance exam fails', function() { var url = dashboardApiUrl + '/reset_student_attempts_for_entrance_exam'; - // Spy on AJAX requests - var requests = AjaxHelpers.requests(this); // Verify that the client contacts the server to start instructor task var params = $.param({ unique_student_identifier: uniqStudentIdentifier, @@ -92,8 +96,6 @@ define(['jquery', 'js/instructor_dashboard/student_admin', 'edx-ui-toolkit/js/ut }); var url = dashboardApiUrl + '/rescore_entrance_exam'; - // Spy on AJAX requests - var requests = AjaxHelpers.requests(this); // Verify that the client contacts the server to start instructor task var params = $.param({ unique_student_identifier: uniqStudentIdentifier, @@ -120,8 +122,6 @@ define(['jquery', 'js/instructor_dashboard/student_admin', 'edx-ui-toolkit/js/ut it('shows an error when entrance exam rescoring fails', function() { var url = dashboardApiUrl + '/rescore_entrance_exam'; - // Spy on AJAX requests - var requests = AjaxHelpers.requests(this); // Verify that the client contacts the server to start instructor task var params = $.param({ unique_student_identifier: uniqStudentIdentifier, @@ -153,9 +153,6 @@ define(['jquery', 'js/instructor_dashboard/student_admin', 'edx-ui-toolkit/js/ut }); var url = dashboardApiUrl + '/mark_student_can_skip_entrance_exam'; - // Spy on AJAX requests - var requests = AjaxHelpers.requests(this); - studentadmin.$btn_skip_entrance_exam.click(); // expect error to be shown since student identifier is not set expect(studentadmin.$request_err_ee.text()).toEqual( @@ -177,8 +174,6 @@ define(['jquery', 'js/instructor_dashboard/student_admin', 'edx-ui-toolkit/js/ut }); it('shows an error when skip entrance exam fails', function() { - // Spy on AJAX requests - var requests = AjaxHelpers.requests(this); var url = dashboardApiUrl + '/mark_student_can_skip_entrance_exam'; var errorMessage = "An error occurred. Make sure that the student's username or email address is correct and try again."; // eslint-disable-line max-len studentadmin.$field_exam_grade.val(uniqStudentIdentifier); @@ -201,8 +196,6 @@ define(['jquery', 'js/instructor_dashboard/student_admin', 'edx-ui-toolkit/js/ut }); var url = dashboardApiUrl + '/reset_student_attempts_for_entrance_exam'; - // Spy on AJAX requests - var requests = AjaxHelpers.requests(this); // Verify that the client contacts the server to start instructor task var params = $.param({ unique_student_identifier: uniqStudentIdentifier, @@ -228,8 +221,6 @@ define(['jquery', 'js/instructor_dashboard/student_admin', 'edx-ui-toolkit/js/ut it('shows an error when delete student state for entrance exam fails', function() { var url = dashboardApiUrl + '/reset_student_attempts_for_entrance_exam'; - // Spy on AJAX requests - var requests = AjaxHelpers.requests(this); var params = $.param({ unique_student_identifier: uniqStudentIdentifier, delete_module: true @@ -253,8 +244,6 @@ define(['jquery', 'js/instructor_dashboard/student_admin', 'edx-ui-toolkit/js/ut it('initiates listing of entrance exam task history when button is clicked', function() { var url = dashboardApiUrl + '/list_entrance_exam_instructor_tasks'; - // Spy on AJAX requests - var requests = AjaxHelpers.requests(this); var params = $.param({ unique_student_identifier: uniqStudentIdentifier }); @@ -290,8 +279,6 @@ define(['jquery', 'js/instructor_dashboard/student_admin', 'edx-ui-toolkit/js/ut it('shows an error when listing entrance exam task history fails', function() { var url = dashboardApiUrl + '/list_entrance_exam_instructor_tasks'; - // Spy on AJAX requests - var requests = AjaxHelpers.requests(this); var params = $.param({ unique_student_identifier: uniqStudentIdentifier }); diff --git a/lms/static/js/spec/shoppingcart/shoppingcart_spec.js b/lms/static/js/spec/shoppingcart/shoppingcart_spec.js index e600bcc73e95..66a1e4618a6d 100644 --- a/lms/static/js/spec/shoppingcart/shoppingcart_spec.js +++ b/lms/static/js/spec/shoppingcart/shoppingcart_spec.js @@ -1,10 +1,11 @@ -define(['edx-ui-toolkit/js/utils/spec-helpers/ajax-helpers', 'js/shoppingcart/shoppingcart'], - function(AjaxHelpers) { +define(['sinon', 'edx-ui-toolkit/js/utils/spec-helpers/ajax-helpers', 'js/shoppingcart/shoppingcart'], + function(sinon, AjaxHelpers) { 'use strict'; describe('edx.shoppingcart.showcart.CartView', function() { var view = null; var requests = null; + var xhrFactory = null; beforeEach(function() { setFixtures('
            '); // eslint-disable-line max-len @@ -15,8 +16,11 @@ define(['edx-ui-toolkit/js/utils/spec-helpers/ajax-helpers', 'js/shoppingcart/sh spyOn(view, 'responseFromServer').and.callFake(function() {}); - // Spy on AJAX requests - requests = AjaxHelpers.requests(this); + xhrFactory = sinon.useFakeXMLHttpRequest(); + requests = []; + requests.currentIndex = 0; + requests.restore = function() { xhrFactory.restore(); }; + xhrFactory.onCreate = function(req) { requests.push(req); }; view.submit(); @@ -27,6 +31,10 @@ define(['edx-ui-toolkit/js/utils/spec-helpers/ajax-helpers', 'js/shoppingcart/sh ); }); + afterEach(function() { + requests.restore(); + }); + it('cart has invalid items, course enrollment has been closed', function() { // Simulate a response from the server containing the // parameter 'is_course_enrollment_closed'. This decides that diff --git a/lms/static/js/spec/staff_debug_actions_spec.js b/lms/static/js/spec/staff_debug_actions_spec.js index dc605d75f974..6a0a4b1994f4 100644 --- a/lms/static/js/spec/staff_debug_actions_spec.js +++ b/lms/static/js/spec/staff_debug_actions_spec.js @@ -1,10 +1,11 @@ define([ 'backbone', 'jquery', + 'sinon', 'js/staff_debug_actions', 'edx-ui-toolkit/js/utils/spec-helpers/ajax-helpers' ], -function(Backbone, $, tmp, AjaxHelpers) { +function(Backbone, $, sinon, tmp, AjaxHelpers) { 'use strict'; var StaffDebug = window.StaffDebug; @@ -23,6 +24,19 @@ function(Backbone, $, tmp, AjaxHelpers) { var esclocationName = 'P2:problem_1'; var escapableId = 'result_' + esclocationName; var $escapableResultArea = $('
            ', {id: escapableId}); + var requests, xhrFactory; + + beforeEach(function() { + xhrFactory = sinon.useFakeXMLHttpRequest(); + requests = []; + requests.currentIndex = 0; + requests.restore = function() { xhrFactory.restore(); }; + xhrFactory.onCreate = function(req) { requests.push(req); }; + }); + + afterEach(function() { + requests.restore(); + }); describe('getURL ', function() { it('defines url to courseware ajax entry point', function() { @@ -83,7 +97,6 @@ function(Backbone, $, tmp, AjaxHelpers) { describe('doInstructorDashAction success', function() { it('adds a success message to the results element after using an action', function() { $('body').append($escapableResultArea); - var requests = AjaxHelpers.requests(this); var action = { courseId: courseId, locationName: esclocationName, @@ -98,7 +111,6 @@ function(Backbone, $, tmp, AjaxHelpers) { describe('doInstructorDashAction error', function() { it('adds a failure message to the results element after using an action', function() { $('body').append($escapableResultArea); - var requests = AjaxHelpers.requests(this); var action = { courseId: courseId, locationName: esclocationName, diff --git a/lms/static/js/spec/student_account/access_spec.js b/lms/static/js/spec/student_account/access_spec.js index 142fa1fb4a1e..622f6346ff0a 100644 --- a/lms/static/js/spec/student_account/access_spec.js +++ b/lms/static/js/spec/student_account/access_spec.js @@ -5,6 +5,7 @@ 'jquery', 'underscore', 'backbone', + 'sinon', 'common/js/spec_helpers/template_helpers', 'edx-ui-toolkit/js/utils/spec-helpers/ajax-helpers', 'js/student_account/views/AccessView', @@ -13,10 +14,11 @@ 'js/student_account/shoppingcart', 'js/student_account/emailoptin' ], - function($, _, Backbone, TemplateHelpers, AjaxHelpers, AccessView, FormView, EnrollmentInterface, + function($, _, Backbone, sinon, TemplateHelpers, AjaxHelpers, AccessView, FormView, EnrollmentInterface, ShoppingCartInterface) { describe('edx.student.account.AccessView', function() { var requests = null, + xhrFactory = null, view = null, FORM_DESCRIPTION = { method: 'post', @@ -72,9 +74,6 @@ }, $logistrationElement = $('#login-and-registration-container'); - // Spy on AJAX requests - requests = AjaxHelpers.requests(that); - // Initialize the access view view = new AccessView(_.extend(options, {el: $logistrationElement})); @@ -114,10 +113,16 @@ // Stub analytics tracking window.analytics = jasmine.createSpyObj('analytics', ['track', 'page', 'pageview', 'trackLink']); + xhrFactory = sinon.useFakeXMLHttpRequest(); + requests = []; + requests.currentIndex = 0; + requests.restore = function() { xhrFactory.restore(); }; + xhrFactory.onCreate = function(req) { requests.push(req); }; }); afterEach(function() { Backbone.history.stop(); + requests.restore(); }); it('can initially display the login form', function() { diff --git a/lms/static/js/spec/student_account/emailoptin_spec.js b/lms/static/js/spec/student_account/emailoptin_spec.js index c13e77931958..3932d276a1c9 100644 --- a/lms/static/js/spec/student_account/emailoptin_spec.js +++ b/lms/static/js/spec/student_account/emailoptin_spec.js @@ -1,15 +1,26 @@ -define(['edx-ui-toolkit/js/utils/spec-helpers/ajax-helpers', 'js/student_account/emailoptin'], - function(AjaxHelpers, EmailOptInInterface) { +define(['sinon', 'edx-ui-toolkit/js/utils/spec-helpers/ajax-helpers', 'js/student_account/emailoptin'], + function(sinon, AjaxHelpers, EmailOptInInterface) { 'use strict'; describe('EmailOptInInterface', function() { var COURSE_KEY = 'edX/DemoX/Fall', EMAIL_OPT_IN = 'True', - EMAIL_OPT_IN_URL = '/api/user/v1/preferences/email_opt_in/'; + EMAIL_OPT_IN_URL = '/api/user/v1/preferences/email_opt_in/', + requests, xhrFactory; + + beforeEach(function() { + xhrFactory = sinon.useFakeXMLHttpRequest(); + requests = []; + requests.currentIndex = 0; + requests.restore = function() { xhrFactory.restore(); }; + xhrFactory.onCreate = function(req) { requests.push(req); }; + }); + + afterEach(function() { + requests.restore(); + }); it('Opts in for organization emails', function() { - // Spy on Ajax requests - var requests = AjaxHelpers.requests(this); // Attempt to enroll the user EmailOptInInterface.setPreference(COURSE_KEY, EMAIL_OPT_IN); diff --git a/lms/static/js/spec/student_account/enrollment_spec.js b/lms/static/js/spec/student_account/enrollment_spec.js index 1467b061d31d..bd83b47a5edd 100644 --- a/lms/static/js/spec/student_account/enrollment_spec.js +++ b/lms/static/js/spec/student_account/enrollment_spec.js @@ -1,22 +1,29 @@ -define(['edx-ui-toolkit/js/utils/spec-helpers/ajax-helpers', 'js/student_account/enrollment'], - function(AjaxHelpers, EnrollmentInterface) { +define(['sinon', 'edx-ui-toolkit/js/utils/spec-helpers/ajax-helpers', 'js/student_account/enrollment'], + function(sinon, AjaxHelpers, EnrollmentInterface) { 'use strict'; describe('EnrollmentInterface', function() { var COURSE_KEY = 'edX/DemoX/Fall', ENROLL_URL = '/api/commerce/v0/baskets/', FORWARD_URL = '/course_modes/choose/edX/DemoX/Fall/', - EMBARGO_MSG_URL = '/embargo/blocked-message/enrollment/default/'; + EMBARGO_MSG_URL = '/embargo/blocked-message/enrollment/default/', + requests, xhrFactory; beforeEach(function() { // Mock the redirect call spyOn(EnrollmentInterface, 'redirect').and.callFake(function() {}); + xhrFactory = sinon.useFakeXMLHttpRequest(); + requests = []; + requests.currentIndex = 0; + requests.restore = function() { xhrFactory.restore(); }; + xhrFactory.onCreate = function(req) { requests.push(req); }; }); - it('enrolls a user in a course', function() { - // Spy on Ajax requests - var requests = AjaxHelpers.requests(this); + afterEach(function() { + requests.restore(); + }); + it('enrolls a user in a course', function() { // Attempt to enroll the user EnrollmentInterface.enroll(COURSE_KEY, FORWARD_URL); @@ -36,9 +43,6 @@ define(['edx-ui-toolkit/js/utils/spec-helpers/ajax-helpers', 'js/student_account }); it('redirects the user if enrollment fails', function() { - // Spy on Ajax requests - var requests = AjaxHelpers.requests(this); - // Attempt to enroll the user EnrollmentInterface.enroll(COURSE_KEY, FORWARD_URL); @@ -50,9 +54,6 @@ define(['edx-ui-toolkit/js/utils/spec-helpers/ajax-helpers', 'js/student_account }); it('redirects the user if blocked by an embargo', function() { - // Spy on Ajax requests - var requests = AjaxHelpers.requests(this); - // Attempt to enroll the user EnrollmentInterface.enroll(COURSE_KEY, FORWARD_URL); diff --git a/lms/static/js/spec/student_account/finish_auth_spec.js b/lms/static/js/spec/student_account/finish_auth_spec.js index b440ca4e458e..9af9d3dbe385 100644 --- a/lms/static/js/spec/student_account/finish_auth_spec.js +++ b/lms/static/js/spec/student_account/finish_auth_spec.js @@ -4,6 +4,7 @@ define([ 'jquery', 'jquery.url', + 'sinon', 'utility', 'edx-ui-toolkit/js/utils/spec-helpers/ajax-helpers', 'js/student_account/views/FinishAuthView', @@ -11,17 +12,16 @@ 'js/student_account/shoppingcart', 'js/student_account/emailoptin' ], - function($, url, utility, AjaxHelpers, FinishAuthView, EnrollmentInterface, ShoppingCartInterface, + function($, url, sinon, utility, AjaxHelpers, FinishAuthView, EnrollmentInterface, ShoppingCartInterface, EmailOptInInterface) { describe('FinishAuthView', function() { var requests = null, view = null, + xhrFactory = null, FORWARD_URL = '/courseware/next', COURSE_KEY = 'course-v1:edX+test+15'; - var ajaxSpyAndInitialize = function(that) { - // Spy on AJAX requests - requests = AjaxHelpers.requests(that); + var ajaxSpyAndInitialize = function() { // Initialize the access view view = new FinishAuthView({}); @@ -55,6 +55,15 @@ beforeEach(function() { // Stub analytics tracking window.analytics = jasmine.createSpyObj('analytics', ['track', 'page', 'pageview', 'trackLink']); + xhrFactory = sinon.useFakeXMLHttpRequest(); + requests = []; + requests.currentIndex = 0; + requests.restore = function() { xhrFactory.restore(); }; + xhrFactory.onCreate = function(req) { requests.push(req); }; + }); + + afterEach(function() { + requests.restore(); }); it('saves the email opt-in preference before enrollment', function() { diff --git a/lms/static/js/spec/student_account/login_spec.js b/lms/static/js/spec/student_account/login_spec.js index 2d1c481fb23e..fe62de38976c 100644 --- a/lms/static/js/spec/student_account/login_spec.js +++ b/lms/static/js/spec/student_account/login_spec.js @@ -17,6 +17,7 @@ resetModel = null, view = null, requests = null, + xhrFactory = null, authComplete = false, PLATFORM_NAME = 'edX', ENTERPRISE_SLUG_LOGIN_URL = 'enterprise/login', @@ -96,9 +97,6 @@ isEnterpriseEnable: IS_ENTERPRISE_ENABLE }); - // Spy on AJAX requests - requests = AjaxHelpers.requests(test); - // Intercept events from the view authComplete = false; view.on('auth-complete', function() { @@ -132,6 +130,15 @@ setFixtures('
            '); TemplateHelpers.installTemplate('templates/student_account/login'); TemplateHelpers.installTemplate('templates/student_account/form_field'); + xhrFactory = sinon.useFakeXMLHttpRequest(); + requests = []; + requests.currentIndex = 0; + requests.restore = function() { xhrFactory.restore(); }; + xhrFactory.onCreate = function(req) { requests.push(req); }; + }); + + afterEach(function() { + requests.restore(); }); it('logs the user in', function() { diff --git a/lms/static/js/spec/student_account/multiple_enterprise_spec.js b/lms/static/js/spec/student_account/multiple_enterprise_spec.js index 0c7bdeb2e356..958e97a6dd52 100644 --- a/lms/static/js/spec/student_account/multiple_enterprise_spec.js +++ b/lms/static/js/spec/student_account/multiple_enterprise_spec.js @@ -1,27 +1,35 @@ define([ + 'sinon', 'edx-ui-toolkit/js/utils/spec-helpers/ajax-helpers', 'js/student_account/multiple_enterprise', 'js/student_account/utils' ], -function(AjaxHelpers, MultipleEnterpriseInterface, Utils) { +function(sinon, AjaxHelpers, MultipleEnterpriseInterface, Utils) { 'use strict'; describe('MultipleEnterpriseInterface', function() { var LEARNER_URL = '/enterprise/api/v1/enterprise-learner/?username=test-learner', NEXT_URL = '/dashboard', REDIRECT_URL = '/enterprise/select/active/?success_url=%2Fdashboard', - ENTERPRISE_ACTIVATION_URL = '/enterprise/select/active'; + ENTERPRISE_ACTIVATION_URL = '/enterprise/select/active', + requests, xhrFactory; beforeEach(function() { // Mock the redirect call spyOn(MultipleEnterpriseInterface, 'redirect').and.callFake(function() {}); spyOn(Utils, 'userFromEdxUserCookie').and.returnValue({username: 'test-learner'}); + xhrFactory = sinon.useFakeXMLHttpRequest(); + requests = []; + requests.currentIndex = 0; + requests.restore = function() { xhrFactory.restore(); }; + xhrFactory.onCreate = function(req) { requests.push(req); }; }); - it('gets learner information and checks redirect to enterprise selection page', function() { - // Spy on Ajax requests - var requests = AjaxHelpers.requests(this); + afterEach(function() { + requests.restore(); + }); + it('gets learner information and checks redirect to enterprise selection page', function() { // Attempt to fetch a learner MultipleEnterpriseInterface.check(NEXT_URL); @@ -41,8 +49,6 @@ function(AjaxHelpers, MultipleEnterpriseInterface, Utils) { }); it('checks bypass of enterprise selection page in case of enterprise in URL', function() { - // Spy on Ajax requests - var requests = AjaxHelpers.requests(this); spyOn(MultipleEnterpriseInterface, 'getEnterpriseFromUrl').and.returnValue('SomeEnterprise'); spyOn(MultipleEnterpriseInterface, 'checkEnterpriseExists').and.returnValue(true); @@ -75,8 +81,6 @@ function(AjaxHelpers, MultipleEnterpriseInterface, Utils) { }); it('checks enterprise selection page redirect in case of enterprise activation failure', function() { - // Spy on Ajax requests - var requests = AjaxHelpers.requests(this); spyOn(MultipleEnterpriseInterface, 'getEnterpriseFromUrl').and.returnValue('SomeEnterprise'); spyOn(MultipleEnterpriseInterface, 'checkEnterpriseExists').and.returnValue(true); @@ -110,9 +114,6 @@ function(AjaxHelpers, MultipleEnterpriseInterface, Utils) { }); it('gets learner information and checks that enterprise selection page is bypassed', function() { - // Spy on Ajax requests - var requests = AjaxHelpers.requests(this); - // Attempt to fetch a learner MultipleEnterpriseInterface.check(NEXT_URL); @@ -132,9 +133,6 @@ function(AjaxHelpers, MultipleEnterpriseInterface, Utils) { }); it('correctly redirects the user if learner information call fails', function() { - // Spy on Ajax requests - var requests = AjaxHelpers.requests(this); - // Attempt to fetch a learner MultipleEnterpriseInterface.check(NEXT_URL); diff --git a/lms/static/js/spec/student_account/password_reset_spec.js b/lms/static/js/spec/student_account/password_reset_spec.js index 68d6172f5ccb..78f7feea90fa 100644 --- a/lms/static/js/spec/student_account/password_reset_spec.js +++ b/lms/static/js/spec/student_account/password_reset_spec.js @@ -4,16 +4,18 @@ define([ 'jquery', 'underscore', + 'sinon', 'common/js/spec_helpers/template_helpers', 'edx-ui-toolkit/js/utils/spec-helpers/ajax-helpers', 'js/student_account/models/PasswordResetModel', 'js/student_account/views/PasswordResetView' ], - function($, _, TemplateHelpers, AjaxHelpers, PasswordResetModel, PasswordResetView) { + function($, _, sinon, TemplateHelpers, AjaxHelpers, PasswordResetModel, PasswordResetView) { describe('edx.student.account.PasswordResetView', function() { var model = null, view = null, requests = null, + xhrFactory = null, EMAIL = 'xsy@edx.org', FORM_DESCRIPTION = { method: 'post', @@ -43,8 +45,6 @@ model: model }); - // Spy on AJAX requests - requests = AjaxHelpers.requests(that); }; var submitEmail = function(validationSuccess) { @@ -72,6 +72,15 @@ setFixtures(''); TemplateHelpers.installTemplate('templates/student_account/password_reset'); TemplateHelpers.installTemplate('templates/student_account/form_field'); + xhrFactory = sinon.useFakeXMLHttpRequest(); + requests = []; + requests.currentIndex = 0; + requests.restore = function() { xhrFactory.restore(); }; + xhrFactory.onCreate = function(req) { requests.push(req); }; + }); + + afterEach(function() { + requests.restore(); }); it('allows the user to request a new password', function() { diff --git a/lms/static/js/spec/student_account/register_spec.js b/lms/static/js/spec/student_account/register_spec.js index 17d82e2b13d6..d886106b762c 100644 --- a/lms/static/js/spec/student_account/register_spec.js +++ b/lms/static/js/spec/student_account/register_spec.js @@ -4,17 +4,19 @@ define([ 'jquery', 'underscore', + 'sinon', 'common/js/spec_helpers/template_helpers', 'edx-ui-toolkit/js/utils/spec-helpers/ajax-helpers', 'js/student_account/models/RegisterModel', 'js/student_account/views/RegisterView', 'js/student_account/tos_modal' ], - function($, _, TemplateHelpers, AjaxHelpers, RegisterModel, RegisterView) { + function($, _, sinon, TemplateHelpers, AjaxHelpers, RegisterModel, RegisterView) { describe('edx.student.account.RegisterView', function() { var model = null, view = null, requests = null, + xhrFactory = null, authComplete = false, PLATFORM_NAME = 'edX', COURSE_ID = 'edX/DemoX/Fall', @@ -245,9 +247,6 @@ platformName: PLATFORM_NAME }); - // Spy on AJAX requests - requests = AjaxHelpers.requests(that); - // Intercept events from the view authComplete = false; view.on('auth-complete', function() { @@ -323,6 +322,15 @@ setFixtures('
            '); TemplateHelpers.installTemplate('templates/student_account/register'); TemplateHelpers.installTemplate('templates/student_account/form_field'); + xhrFactory = sinon.useFakeXMLHttpRequest(); + requests = []; + requests.currentIndex = 0; + requests.restore = function() { xhrFactory.restore(); }; + xhrFactory.onCreate = function(req) { requests.push(req); }; + }); + + afterEach(function() { + requests.restore(); }); it('registers a new user', function() { diff --git a/lms/static/js/spec/student_account/shoppingcart_spec.js b/lms/static/js/spec/student_account/shoppingcart_spec.js index 69ed04ba7c44..73d43ed43307 100644 --- a/lms/static/js/spec/student_account/shoppingcart_spec.js +++ b/lms/static/js/spec/student_account/shoppingcart_spec.js @@ -1,21 +1,28 @@ -define(['edx-ui-toolkit/js/utils/spec-helpers/ajax-helpers', 'js/student_account/shoppingcart'], - function(AjaxHelpers, ShoppingCartInterface) { +define(['sinon', 'edx-ui-toolkit/js/utils/spec-helpers/ajax-helpers', 'js/student_account/shoppingcart'], + function(sinon, AjaxHelpers, ShoppingCartInterface) { 'use strict'; describe('ShoppingCartInterface', function() { var COURSE_KEY = 'edX/DemoX/Fall', ADD_COURSE_URL = '/shoppingcart/add/course/edX/DemoX/Fall/', - FORWARD_URL = '/shoppingcart/'; + FORWARD_URL = '/shoppingcart/', + requests, xhrFactory; beforeEach(function() { // Mock the redirect call spyOn(ShoppingCartInterface, 'redirect').and.callFake(function() {}); + xhrFactory = sinon.useFakeXMLHttpRequest(); + requests = []; + requests.currentIndex = 0; + requests.restore = function() { xhrFactory.restore(); }; + xhrFactory.onCreate = function(req) { requests.push(req); }; }); - it('adds a course to the cart', function() { - // Spy on Ajax requests - var requests = AjaxHelpers.requests(this); + afterEach(function() { + requests.restore(); + }); + it('adds a course to the cart', function() { // Attempt to add a course to the cart ShoppingCartInterface.addCourseToCart(COURSE_KEY); @@ -30,9 +37,6 @@ define(['edx-ui-toolkit/js/utils/spec-helpers/ajax-helpers', 'js/student_account }); it('redirects the user on a server error', function() { - // Spy on Ajax requests - var requests = AjaxHelpers.requests(this); - // Attempt to add a course to the cart ShoppingCartInterface.addCourseToCart(COURSE_KEY); diff --git a/lms/static/js/spec/verify_student/make_payment_step_view_ab_testing_spec.js b/lms/static/js/spec/verify_student/make_payment_step_view_ab_testing_spec.js index 31aa924130cb..986154936e1d 100644 --- a/lms/static/js/spec/verify_student/make_payment_step_view_ab_testing_spec.js +++ b/lms/static/js/spec/verify_student/make_payment_step_view_ab_testing_spec.js @@ -2,11 +2,12 @@ define([ 'jquery', 'underscore', 'backbone', + 'sinon', 'edx-ui-toolkit/js/utils/spec-helpers/ajax-helpers', 'common/js/spec_helpers/template_helpers', 'js/verify_student/views/make_payment_step_view' ], -function($, _, Backbone, AjaxHelpers, TemplateHelpers, MakePaymentStepView) { +function($, _, Backbone, sinon, AjaxHelpers, TemplateHelpers, MakePaymentStepView) { 'use strict'; var checkPaymentButtons, @@ -19,6 +20,7 @@ function($, _, Backbone, AjaxHelpers, TemplateHelpers, MakePaymentStepView) { SERVER_ERROR_MSG = 'An error occurred!'; describe('edx.verify_student.MakePaymentStepView', function() { + var requests, xhrFactory; var STEP_DATA = { minPrice: '12', currency: 'usd', @@ -129,6 +131,15 @@ function($, _, Backbone, AjaxHelpers, TemplateHelpers, MakePaymentStepView) { setFixtures('
            '); TemplateHelpers.installTemplate('templates/verify_student/make_payment_step_ab_testing'); + xhrFactory = sinon.useFakeXMLHttpRequest(); + requests = []; + requests.currentIndex = 0; + requests.restore = function() { xhrFactory.restore(); }; + xhrFactory.onCreate = function(req) { requests.push(req); }; + }); + + afterEach(function() { + requests.restore(); }); it('A/B Testing: check Initialize method with AB testing enable ', function() { @@ -138,8 +149,7 @@ function($, _, Backbone, AjaxHelpers, TemplateHelpers, MakePaymentStepView) { }); it('shows users only minimum price', function() { - var view = createView(), - requests = AjaxHelpers.requests(this); + var view = createView(); expectPriceSelected(STEP_DATA.minPrice); expectPaymentButtonEnabled(true); @@ -154,12 +164,12 @@ function($, _, Backbone, AjaxHelpers, TemplateHelpers, MakePaymentStepView) { it('A/B Testing: provides working payment buttons for a single processor', function() { createView({processors: ['cybersource']}); - checkPaymentButtons(AjaxHelpers.requests(this), {cybersource: 'Checkout'}); + checkPaymentButtons(requests, {cybersource: 'Checkout'}); }); it('A/B Testing: provides working payment buttons for multiple processors', function() { createView({processors: ['cybersource', 'paypal', 'other']}); - checkPaymentButtons(AjaxHelpers.requests(this), { + checkPaymentButtons(requests, { cybersource: 'Checkout', paypal: 'Checkout with PayPal', other: 'Checkout with other' @@ -167,8 +177,7 @@ function($, _, Backbone, AjaxHelpers, TemplateHelpers, MakePaymentStepView) { }); it('A/B Testing: by default minimum price is selected if no suggested prices are given', function() { - var view = createView(), - requests = AjaxHelpers.requests(this); + var view = createView(); expectPriceSelected(STEP_DATA.minPrice); expectPaymentButtonEnabled(true); @@ -198,8 +207,7 @@ function($, _, Backbone, AjaxHelpers, TemplateHelpers, MakePaymentStepView) { }); it('A/B Testing: displays an error if the order could not be created', function() { - var requests = AjaxHelpers.requests(this), - view = createView(); + var view = createView(); goToPayment(requests, { amount: STEP_DATA.minPrice, diff --git a/lms/static/js/spec/verify_student/make_payment_step_view_spec.js b/lms/static/js/spec/verify_student/make_payment_step_view_spec.js index fa24a757d58f..59e3cc8f4cf3 100644 --- a/lms/static/js/spec/verify_student/make_payment_step_view_spec.js +++ b/lms/static/js/spec/verify_student/make_payment_step_view_spec.js @@ -2,14 +2,16 @@ define([ 'jquery', 'underscore', 'backbone', + 'sinon', 'edx-ui-toolkit/js/utils/spec-helpers/ajax-helpers', 'common/js/spec_helpers/template_helpers', 'js/verify_student/views/make_payment_step_view' ], -function($, _, Backbone, AjaxHelpers, TemplateHelpers, MakePaymentStepView) { +function($, _, Backbone, sinon, AjaxHelpers, TemplateHelpers, MakePaymentStepView) { 'use strict'; describe('edx.verify_student.MakePaymentStepView', function() { + var requests, xhrFactory; var PAYMENT_PARAMS = { orderId: 'test-order', signature: 'abcd1234' @@ -124,11 +126,19 @@ function($, _, Backbone, AjaxHelpers, TemplateHelpers, MakePaymentStepView) { setFixtures('
            '); TemplateHelpers.installTemplate('templates/verify_student/make_payment_step'); + xhrFactory = sinon.useFakeXMLHttpRequest(); + requests = []; + requests.currentIndex = 0; + requests.restore = function() { xhrFactory.restore(); }; + xhrFactory.onCreate = function(req) { requests.push(req); }; + }); + + afterEach(function() { + requests.restore(); }); it('shows users only minimum price', function() { - var view = createView({}), - requests = AjaxHelpers.requests(this); + var view = createView({}); expectPriceSelected(STEP_DATA.minPrice); expectPaymentButtonEnabled(true); @@ -184,12 +194,12 @@ function($, _, Backbone, AjaxHelpers, TemplateHelpers, MakePaymentStepView) { it('provides working payment buttons for a single processor', function() { createView({processors: ['cybersource']}); - checkPaymentButtons(AjaxHelpers.requests(this), {cybersource: 'Checkout'}); + checkPaymentButtons(requests, {cybersource: 'Checkout'}); }); it('provides working payment buttons for multiple processors', function() { createView({processors: ['cybersource', 'paypal', 'other']}); - checkPaymentButtons(AjaxHelpers.requests(this), { + checkPaymentButtons(requests, { cybersource: 'Checkout', paypal: 'Checkout with PayPal', other: 'Checkout with other' @@ -197,8 +207,7 @@ function($, _, Backbone, AjaxHelpers, TemplateHelpers, MakePaymentStepView) { }); it('by default minimum price is selected if no suggested prices are given', function() { - var view = createView(), - requests = AjaxHelpers.requests(this); + var view = createView(); expectPriceSelected(STEP_DATA.minPrice); expectPaymentButtonEnabled(true); @@ -228,8 +237,7 @@ function($, _, Backbone, AjaxHelpers, TemplateHelpers, MakePaymentStepView) { }); it('displays an error if the order could not be created', function() { - var requests = AjaxHelpers.requests(this), - view = createView({}); + var view = createView({}); goToPayment(requests, { amount: STEP_DATA.minPrice, diff --git a/lms/static/js/spec/verify_student/review_photos_step_view_spec.js b/lms/static/js/spec/verify_student/review_photos_step_view_spec.js index 68f84306b3ce..e3d046db9c10 100644 --- a/lms/static/js/spec/verify_student/review_photos_step_view_spec.js +++ b/lms/static/js/spec/verify_student/review_photos_step_view_spec.js @@ -2,12 +2,13 @@ define([ 'jquery', 'underscore', 'backbone', + 'sinon', 'edx-ui-toolkit/js/utils/spec-helpers/ajax-helpers', 'common/js/spec_helpers/template_helpers', 'js/verify_student/views/review_photos_step_view', 'js/verify_student/models/verification_model' ], -function($, _, Backbone, AjaxHelpers, TemplateHelpers, ReviewPhotosStepView, VerificationModel) { +function($, _, Backbone, sinon, AjaxHelpers, TemplateHelpers, ReviewPhotosStepView, VerificationModel) { 'use strict'; describe('edx.verify_student.ReviewPhotosStepView', function() { @@ -15,7 +16,8 @@ function($, _, Backbone, AjaxHelpers, TemplateHelpers, ReviewPhotosStepView, Ver FULL_NAME = 'Test User', FACE_IMAGE = 'abcd1234', PHOTO_ID_IMAGE = 'efgh56789', - SERVER_ERROR_MSG = 'An error occurred!'; + SERVER_ERROR_MSG = 'An error occurred!', + requests, xhrFactory; var createView = function() { return new ReviewPhotosStepView({ @@ -64,11 +66,18 @@ function($, _, Backbone, AjaxHelpers, TemplateHelpers, ReviewPhotosStepView, Ver setFixtures('
            '); TemplateHelpers.installTemplate('templates/verify_student/review_photos_step'); + xhrFactory = sinon.useFakeXMLHttpRequest(); + requests = []; + requests.currentIndex = 0; + requests.restore = function() { xhrFactory.restore(); }; + xhrFactory.onCreate = function(req) { requests.push(req); }; }); - it('allows the user to change her full name', function() { - var requests = AjaxHelpers.requests(this); + afterEach(function() { + requests.restore(); + }); + it('allows the user to change her full name', function() { createView(); setFullName(FULL_NAME); submitPhotos( @@ -83,8 +92,6 @@ function($, _, Backbone, AjaxHelpers, TemplateHelpers, ReviewPhotosStepView, Ver }); it('submits photos for verification', function() { - var requests = AjaxHelpers.requests(this); - createView(); submitPhotos( requests, @@ -101,8 +108,7 @@ function($, _, Backbone, AjaxHelpers, TemplateHelpers, ReviewPhotosStepView, Ver }); it('displays an error if photo submission fails', function() { - var view = createView(), - requests = AjaxHelpers.requests(this); + var view = createView(); submitPhotos( requests, diff --git a/lms/static/js/spec/views/fields_spec.js b/lms/static/js/spec/views/fields_spec.js index 4137dd01232b..6f65f90a7aa8 100644 --- a/lms/static/js/spec/views/fields_spec.js +++ b/lms/static/js/spec/views/fields_spec.js @@ -1,7 +1,7 @@ -define(['backbone', 'jquery', 'underscore', 'edx-ui-toolkit/js/utils/spec-helpers/ajax-helpers', +define(['backbone', 'jquery', 'underscore', 'sinon', 'edx-ui-toolkit/js/utils/spec-helpers/ajax-helpers', 'common/js/spec_helpers/template_helpers', 'js/views/fields', 'js/spec/views/fields_helpers', 'string_utils'], -function(Backbone, $, _, AjaxHelpers, TemplateHelpers, FieldViews, FieldViewsSpecHelpers) { +function(Backbone, $, _, sinon, AjaxHelpers, TemplateHelpers, FieldViews, FieldViewsSpecHelpers) { 'use strict'; var USERNAME = 'Legolas', @@ -9,6 +9,7 @@ function(Backbone, $, _, AjaxHelpers, TemplateHelpers, FieldViews, FieldViewsSpe describe('edx.FieldViews', function() { var requests, + xhrFactory, timerCallback, dropdownSelectClass = '.u-field-value > select', dropdownButtonClass = '.u-field-value > button', @@ -25,10 +26,16 @@ function(Backbone, $, _, AjaxHelpers, TemplateHelpers, FieldViews, FieldViewsSpe beforeEach(function() { timerCallback = jasmine.createSpy('timerCallback'); jasmine.clock().install(); + xhrFactory = sinon.useFakeXMLHttpRequest(); + requests = []; + requests.currentIndex = 0; + requests.restore = function() { xhrFactory.restore(); }; + xhrFactory.onCreate = function(req) { requests.push(req); }; }); afterEach(function() { jasmine.clock().uninstall(); + requests.restore(); }); it('updates messages correctly for all fields', function() { @@ -60,7 +67,6 @@ function(Backbone, $, _, AjaxHelpers, TemplateHelpers, FieldViews, FieldViewsSpe }); it('sends a PATCH request when saveAttributes is called', function() { - requests = AjaxHelpers.requests(this); var fieldViewClass = FieldViews.EditableFieldView; var fieldData = FieldViewsSpecHelpers.createFieldData(fieldViewClass, { @@ -99,7 +105,6 @@ function(Backbone, $, _, AjaxHelpers, TemplateHelpers, FieldViews, FieldViewsSpe }); it('correctly renders, updates and persists changes to TextFieldView when editable == always', function() { - requests = AjaxHelpers.requests(this); var fieldData = FieldViewsSpecHelpers.createFieldData(FieldViews.TextFieldView, { title: 'Full Name', @@ -122,7 +127,6 @@ function(Backbone, $, _, AjaxHelpers, TemplateHelpers, FieldViews, FieldViewsSpe }); it('correctly renders and updates DropdownFieldView when editable == never', function() { - requests = AjaxHelpers.requests(this); var fieldData = FieldViewsSpecHelpers.createFieldData(FieldViews.DropdownFieldView, { title: 'Full Name', @@ -160,7 +164,6 @@ function(Backbone, $, _, AjaxHelpers, TemplateHelpers, FieldViews, FieldViewsSpe }); it('correctly renders, updates and persists changes to DropdownFieldView when editable == always', function() { - requests = AjaxHelpers.requests(this); var fieldData = FieldViewsSpecHelpers.createFieldData(FieldViews.DropdownFieldView, { title: 'Full Name', @@ -183,7 +186,6 @@ function(Backbone, $, _, AjaxHelpers, TemplateHelpers, FieldViews, FieldViewsSpe }); it('correctly renders, updates and persists changes to DropdownFieldView when editable == toggle', function() { - requests = AjaxHelpers.requests(this); var fieldData = FieldViewsSpecHelpers.createFieldData(FieldViews.DropdownFieldView, { title: 'Full Name', @@ -208,7 +210,6 @@ function(Backbone, $, _, AjaxHelpers, TemplateHelpers, FieldViews, FieldViewsSpe }); it('only shows empty option in DropdownFieldView if required is false or model value is not set', function() { - requests = AjaxHelpers.requests(this); var editableOptions = ['toggle', 'always']; _.each(editableOptions, function(editable) { @@ -271,7 +272,6 @@ function(Backbone, $, _, AjaxHelpers, TemplateHelpers, FieldViews, FieldViewsSpe }); it('correctly renders, updates and persists changes to TextAreaFieldView when editable == toggle', function() { - requests = AjaxHelpers.requests(this); var valueInputSelector = '.u-field-value > textarea'; var fieldData = FieldViewsSpecHelpers.createFieldData(FieldViews.TextareaFieldView, { @@ -327,7 +327,6 @@ function(Backbone, $, _, AjaxHelpers, TemplateHelpers, FieldViews, FieldViewsSpe }); it("can't persist changes if persistChanges is off", function() { - requests = AjaxHelpers.requests(this); var fieldClasses = [ FieldViews.TextFieldView, FieldViews.DropdownFieldView, diff --git a/lms/static/js/spec/views/file_uploader_spec.js b/lms/static/js/spec/views/file_uploader_spec.js index f74cb1f3be3d..b55cbb76902e 100644 --- a/lms/static/js/spec/views/file_uploader_spec.js +++ b/lms/static/js/spec/views/file_uploader_spec.js @@ -1,10 +1,10 @@ -define(['backbone', 'jquery', 'js/views/file_uploader', 'common/js/spec_helpers/template_helpers', +define(['backbone', 'jquery', 'sinon', 'js/views/file_uploader', 'common/js/spec_helpers/template_helpers', 'edx-ui-toolkit/js/utils/spec-helpers/ajax-helpers', 'js/models/notification', 'string_utils'], -function(Backbone, $, FileUploaderView, TemplateHelpers, AjaxHelpers, NotificationModel) { +function(Backbone, $, sinon, FileUploaderView, TemplateHelpers, AjaxHelpers, NotificationModel) { describe('FileUploaderView', function() { var verifyTitle, verifyInputLabel, verifyInputTip, verifySubmitButton, verifyExtensions, verifyText, verifyFileUploadOption, verifyNotificationMessage, verifySubmitButtonEnabled, mimicUpload, - respondWithSuccess, respondWithError, fileUploaderView, + respondWithSuccess, respondWithError, fileUploaderView, requests, xhrFactory, url = 'http://test_url/'; verifyText = function(css, expectedText) { @@ -45,9 +45,7 @@ function(Backbone, $, FileUploaderView, TemplateHelpers, AjaxHelpers, Notificati verifyText('.file-upload-form-result .message-' + type + ' .message-title', expectedMessage); }; - mimicUpload = function(test) { - var requests = AjaxHelpers.requests(test); - + mimicUpload = function() { var param = {files: [{name: 'upload_file.txt'}]}; fileUploaderView.$('#file-upload-form').fileupload('add', param); verifySubmitButtonEnabled(true); @@ -55,7 +53,6 @@ function(Backbone, $, FileUploaderView, TemplateHelpers, AjaxHelpers, Notificati // No file will actually be uploaded because "uploaded_file.txt" doesn't actually exist. AjaxHelpers.expectRequest(requests, 'POST', url, new FormData()); - return requests; }; respondWithSuccess = function(requests) { @@ -75,6 +72,15 @@ function(Backbone, $, FileUploaderView, TemplateHelpers, AjaxHelpers, Notificati TemplateHelpers.installTemplate('templates/file-upload'); TemplateHelpers.installTemplate('templates/instructor/instructor_dashboard_2/notification'); fileUploaderView = new FileUploaderView({url: url}).render(); + xhrFactory = sinon.useFakeXMLHttpRequest(); + requests = []; + requests.currentIndex = 0; + requests.restore = function() { xhrFactory.restore(); }; + xhrFactory.onCreate = function(req) { requests.push(req); }; + }); + + afterEach(function() { + requests.restore(); }); it('has default values', function() { @@ -115,7 +121,7 @@ function(Backbone, $, FileUploaderView, TemplateHelpers, AjaxHelpers, Notificati }); it('handles errors with default message', function() { - var requests = mimicUpload(this); + mimicUpload(); respondWithError(requests); verifyNotificationMessage("Your upload of 'upload_file.txt' failed.", 'error'); }); @@ -131,19 +137,19 @@ function(Backbone, $, FileUploaderView, TemplateHelpers, AjaxHelpers, Notificati }); } }).render(); - var requests = mimicUpload(this); + mimicUpload(); respondWithError(requests, 'server error'); verifyNotificationMessage("Custom error for 'upload_file.txt'", 'customized'); }); it('handles server error message', function() { - var requests = mimicUpload(this); + mimicUpload(); respondWithError(requests, 'server error'); verifyNotificationMessage('server error', 'error'); }); it('handles success with default message', function() { - var requests = mimicUpload(this); + mimicUpload(); respondWithSuccess(requests); verifyNotificationMessage("Your upload of 'upload_file.txt' succeeded.", 'confirmation'); }); @@ -159,7 +165,7 @@ function(Backbone, $, FileUploaderView, TemplateHelpers, AjaxHelpers, Notificati }); } }).render(); - var requests = mimicUpload(this); + mimicUpload(); respondWithSuccess(requests); verifyNotificationMessage("Custom success message for 'upload_file.txt'", 'customized'); }); diff --git a/lms/static/js/student_account/views/RegisterView.js b/lms/static/js/student_account/views/RegisterView.js index 42ab7c8857a8..bd958c2d8bd4 100644 --- a/lms/static/js/student_account/views/RegisterView.js +++ b/lms/static/js/student_account/views/RegisterView.js @@ -58,6 +58,7 @@ ); this.currentProvider = data.thirdPartyAuth.currentProvider || ''; this.syncLearnerProfileData = data.thirdPartyAuth.syncLearnerProfileData || false; + this.skipRegistrationOptionalCheckboxes = data.thirdPartyAuth.skipRegistrationOptionalCheckboxes || false; this.errorMessage = data.thirdPartyAuth.errorMessage || ''; this.platformName = data.platformName; this.autoSubmit = data.thirdPartyAuth.autoSubmitRegForm; @@ -156,6 +157,7 @@ fields: fields, currentProvider: this.currentProvider, syncLearnerProfileData: this.syncLearnerProfileData, + skipRegistrationOptionalCheckboxes: this.skipRegistrationOptionalCheckboxes, providers: this.providers, hasSecondaryProviders: this.hasSecondaryProviders, platformName: this.platformName, diff --git a/lms/static/karma_lms.conf.js b/lms/static/karma_lms.conf.js index 0119d4d18ca2..b3b24f631e8f 100644 --- a/lms/static/karma_lms.conf.js +++ b/lms/static/karma_lms.conf.js @@ -34,7 +34,10 @@ var options = { {pattern: 'discussion/js/**/!(*spec).js'}, {pattern: 'js/**/!(*spec|djangojs).js'}, {pattern: 'learner_profile/**/!(*spec).js'}, - {pattern: 'lms/js/**/!(*spec).js'}, + // Split lms/js/ to exclude spec/main*.js test entry points (handled by runFiles) + {pattern: 'lms/js/!(*spec).js'}, // Direct children of lms/js/ + {pattern: 'lms/js/!(spec)/**/!(*spec).js'}, // Subdirs of lms/js/ except spec/ + {pattern: 'lms/js/spec/**/!(*spec|main*).js'}, // spec/ subdir, excluding main* files {pattern: 'support/js/**/!(*spec).js'}, {pattern: 'teams/js/**/!(*spec).js'}, {pattern: 'completion/js/**/!(*spec).js'} diff --git a/lms/static/lms/js/spec/preview/preview_factory_spec.js b/lms/static/lms/js/spec/preview/preview_factory_spec.js index e87d018fb67d..dcd006fd5475 100644 --- a/lms/static/lms/js/spec/preview/preview_factory_spec.js +++ b/lms/static/lms/js/spec/preview/preview_factory_spec.js @@ -1,16 +1,18 @@ define( [ + 'sinon', 'edx-ui-toolkit/js/utils/spec-helpers/ajax-helpers', 'common/js/components/utils/view_utils', 'lms/js/preview/preview_factory' ], - function(AjaxHelpers, ViewUtils, PreviewFactory) { + function(sinon, AjaxHelpers, ViewUtils, PreviewFactory) { 'use strict'; describe('Preview Factory', function() { var showPreview, previewActionSelect, - usernameInput; + usernameInput, + requests, xhrFactory; showPreview = function(options) { PreviewFactory(options); @@ -26,6 +28,15 @@ define( beforeEach(function() { loadFixtures('lms/fixtures/preview/course_preview.html'); + xhrFactory = sinon.useFakeXMLHttpRequest(); + requests = []; + requests.currentIndex = 0; + requests.restore = function() { xhrFactory.restore(); }; + xhrFactory.onCreate = function(req) { requests.push(req); }; + }); + + afterEach(function() { + requests.restore(); }); it('can render preview for a staff user', function() { @@ -47,8 +58,7 @@ define( }); it('can switch to view as a student', function() { - var requests = AjaxHelpers.requests(this), - reloadSpy = spyOn(ViewUtils, 'reload'); + var reloadSpy = spyOn(ViewUtils, 'reload'); showPreview({ courseId: 'test_course' }); @@ -67,8 +77,7 @@ define( }); it('can switch to view as a content group', function() { - var requests = AjaxHelpers.requests(this), - reloadSpy = spyOn(ViewUtils, 'reload'); + var reloadSpy = spyOn(ViewUtils, 'reload'); showPreview({ courseId: 'test_course' }); @@ -89,8 +98,7 @@ define( }); it('can switch to masquerade as a specific student', function() { - var requests = AjaxHelpers.requests(this), - reloadSpy = spyOn(ViewUtils, 'reload'); + var reloadSpy = spyOn(ViewUtils, 'reload'); showPreview({ courseId: 'test_course' }); diff --git a/lms/static/sass/partials/README.rst b/lms/static/sass/partials/README.rst index 914165caef53..86cfa7b3b5ec 100644 --- a/lms/static/sass/partials/README.rst +++ b/lms/static/sass/partials/README.rst @@ -1,3 +1,6 @@ +SASS Partials +============= + Any partials in this directory can be overridden by a theme by matching the directory structure as in lms/static/sass/partials. diff --git a/lms/static/sass/shared/_header.scss b/lms/static/sass/shared/_header.scss index 898933685b26..b3942b90b058 100644 --- a/lms/static/sass/shared/_header.scss +++ b/lms/static/sass/shared/_header.scss @@ -379,7 +379,6 @@ } // page-based nav states -.view-howitworks .nav-global-01, .view-courses .nav-global-02, .view-schools .nav-global-03, .view-register .nav-global-04 { @@ -899,7 +898,6 @@ } // page-based nav states -.view-howitworks .nav-global-01, .view-courses .nav-global-02, .view-schools .nav-global-03, .view-register .nav-global-04 { diff --git a/lms/templates/courseware/course_about.html b/lms/templates/courseware/course_about.html index e4f78e2afc2b..746dd691b169 100644 --- a/lms/templates/courseware/course_about.html +++ b/lms/templates/courseware/course_about.html @@ -244,32 +244,9 @@

            ${course.display_name_with_default}

            • % endif - % if get_course_about_section(request, course, "prerequisites"): -
          • - -

            ${_("Requirements")}

            - ${get_course_about_section(request, course, "prerequisites")} -
            • - % endif

          - - ## For now, ocw links are the only thing that goes in additional resources - % if get_course_about_section(request, course, "ocw_links"): -
          -
          -

          ${_("Additional Resources")}

          -
          - -
          - ## "MITOpenCourseware" should *not* be translated -

          MITOpenCourseware

          - ${get_course_about_section(request, course, "ocw_links")} -
          -
          - %endif - % if sidebar_html_enabled: % if get_course_about_section(request, course, "about_sidebar_html"):
          diff --git a/lms/templates/dashboard.html b/lms/templates/dashboard.html index 6149418035ca..34270eea53d5 100644 --- a/lms/templates/dashboard.html +++ b/lms/templates/dashboard.html @@ -220,10 +220,9 @@ is_course_voucher_refundable = (session_id in enrolled_courses_voucher_refundable) course_requirements = courses_requirements_not_met.get(session_id) related_programs = inverted_programs.get(str(entitlement.course_uuid if is_unfulfilled_entitlement else session_id)) - show_consent_link = (session_id in consent_required_courses) resume_button_url = resume_button_urls[dashboard_index] %> - <%include file='dashboard/_dashboard_course_listing.html' args='course_overview=course_overview, course_card_index=dashboard_index, enrollment=enrollment, enrollments_fbe_is_on=enrollments_fbe_is_on, is_unfulfilled_entitlement=is_unfulfilled_entitlement, is_fulfilled_entitlement=is_fulfilled_entitlement, entitlement=entitlement, entitlement_session=entitlement_session, entitlement_available_sessions=entitlement_available_sessions, entitlement_expiration_date=entitlement_expiration_date, entitlement_expired_at=entitlement_expired_at, show_courseware_link=show_courseware_link, cert_status=cert_status, can_refund_entitlement=can_refund_entitlement, can_unenroll=can_unenroll, credit_status=credit_status, show_email_settings=show_email_settings, course_mode_info=course_mode_info, is_paid_course=is_paid_course, is_course_voucher_refundable=is_course_voucher_refundable, course_requirements=course_requirements, dashboard_index=dashboard_index, share_settings=share_settings, user=user, related_programs=related_programs, display_course_modes_on_dashboard=display_course_modes_on_dashboard, show_consent_link=show_consent_link, enterprise_customer_name=enterprise_customer_name, resume_button_url=resume_button_url, partner_managed_enrollment=partner_managed_enrollment' /> + <%include file='dashboard/_dashboard_course_listing.html' args='course_overview=course_overview, course_card_index=dashboard_index, enrollment=enrollment, enrollments_fbe_is_on=enrollments_fbe_is_on, is_unfulfilled_entitlement=is_unfulfilled_entitlement, is_fulfilled_entitlement=is_fulfilled_entitlement, entitlement=entitlement, entitlement_session=entitlement_session, entitlement_available_sessions=entitlement_available_sessions, entitlement_expiration_date=entitlement_expiration_date, entitlement_expired_at=entitlement_expired_at, show_courseware_link=show_courseware_link, cert_status=cert_status, can_refund_entitlement=can_refund_entitlement, can_unenroll=can_unenroll, credit_status=credit_status, show_email_settings=show_email_settings, course_mode_info=course_mode_info, is_paid_course=is_paid_course, is_course_voucher_refundable=is_course_voucher_refundable, course_requirements=course_requirements, dashboard_index=dashboard_index, share_settings=share_settings, user=user, related_programs=related_programs, display_course_modes_on_dashboard=display_course_modes_on_dashboard, resume_button_url=resume_button_url, partner_managed_enrollment=partner_managed_enrollment' /> % endfor % if show_load_all_courses_link:
          diff --git a/lms/templates/dashboard/_dashboard_course_listing.html b/lms/templates/dashboard/_dashboard_course_listing.html index 39c66f0e81fa..ff27485a87b4 100644 --- a/lms/templates/dashboard/_dashboard_course_listing.html +++ b/lms/templates/dashboard/_dashboard_course_listing.html @@ -1,4 +1,4 @@ -<%page args="course_overview, enrollment, entitlement, entitlement_session, course_card_index, enrollments_fbe_is_on, is_unfulfilled_entitlement, is_fulfilled_entitlement, entitlement_available_sessions, entitlement_expiration_date, entitlement_expired_at, show_courseware_link, cert_status, can_refund_entitlement, can_unenroll, credit_status, show_email_settings, course_mode_info, is_paid_course, is_course_voucher_refundable, course_requirements, dashboard_index, share_settings, related_programs, display_course_modes_on_dashboard, show_consent_link, enterprise_customer_name, resume_button_url, partner_managed_enrollment" expression_filter="h"/> +<%page args="course_overview, enrollment, entitlement, entitlement_session, course_card_index, enrollments_fbe_is_on, is_unfulfilled_entitlement, is_fulfilled_entitlement, entitlement_available_sessions, entitlement_expiration_date, entitlement_expired_at, show_courseware_link, cert_status, can_refund_entitlement, can_unenroll, credit_status, show_email_settings, course_mode_info, is_paid_course, is_course_voucher_refundable, course_requirements, dashboard_index, share_settings, related_programs, display_course_modes_on_dashboard, resume_button_url, partner_managed_enrollment" expression_filter="h"/> <%! import datetime @@ -370,10 +370,6 @@

          <%include file="_dashboard_credit_info.html" args="credit_status=credit_status"/> % endif - % if show_consent_link: - <%include file="_dashboard_show_consent.html" args="course_overview=course_overview, course_target=course_target, enrollment=enrollment, enterprise_customer_name=enterprise_customer_name"/> - %endif - % if display_course_upgrade:
          diff --git a/lms/templates/dashboard/_dashboard_show_consent.html b/lms/templates/dashboard/_dashboard_show_consent.html deleted file mode 100644 index 98f8ffd3c473..000000000000 --- a/lms/templates/dashboard/_dashboard_show_consent.html +++ /dev/null @@ -1,25 +0,0 @@ -<%page expression_filter="h" args="course_overview, course_target, enrollment, enterprise_customer_name" /> -<%! -from django.utils.translation import gettext as _ -%> -<%namespace name='static' file='../static_content.html'/> - -
          -
          -

          - - ${_("Consent to share your data")} - -
          - ${_("To access this course, you must first consent to share your learning achievements with {enterprise_customer_name}.").format(enterprise_customer_name=enterprise_customer_name)} -

          -
          - - - ${_("View Consent")} -  ${_(course_overview.display_name_with_default)} - - -
          -
          -
          diff --git a/lms/templates/header/user_dropdown.html b/lms/templates/header/user_dropdown.html index a10ec658d2d9..9071fcdde640 100644 --- a/lms/templates/header/user_dropdown.html +++ b/lms/templates/header/user_dropdown.html @@ -11,6 +11,7 @@ from django.utils.translation import gettext as _ from openedx.core.djangoapps.user_api.accounts.image_helpers import get_profile_image_urls_for_user +from openedx.core.djangoapps.site_configuration import helpers as configuration_helpers from openedx.features.enterprise_support.utils import get_enterprise_learner_generic_name, get_enterprise_learner_portal %> @@ -45,7 +46,7 @@ % endif
          ${_("Profile")}
          -
          ${_("Account")}
          +
          ${_("Account")}
          % if should_show_order_history:
          ${_("Order History")}
          % endif diff --git a/lms/templates/instructor/edx_ace/batchenrollment/email/body.html b/lms/templates/instructor/edx_ace/batchenrollment/email/body.html new file mode 100644 index 000000000000..3ec977a9dd2d --- /dev/null +++ b/lms/templates/instructor/edx_ace/batchenrollment/email/body.html @@ -0,0 +1,56 @@ +{% extends 'ace_common/edx_ace/common/base_body.html' %} + +{% load i18n %} +{% load static %} +{% block content %} + + + + +
          +

          + {% autoescape off %} + {# xss-lint: disable=django-blocktrans-missing-escape-filter #} + {% blocktrans %}Batch {{ action_name }} completed for {{ course_name }}{% endblocktrans %} + {% endautoescape %} +

          + +

          + {% autoescape off %} + {# xss-lint: disable=django-blocktrans-missing-escape-filter #} + {% blocktrans %}The batch {{ action_name }} process for {{ course_name }} is complete.{% endblocktrans %} + {% endautoescape %} +
          +

          + +

          + {% autoescape off %} + {# xss-lint: disable=django-blocktrans-missing-escape-filter #} + {% blocktrans %}Out of {{ total_processed }} users:{% endblocktrans %} + {% endautoescape %} +
          +

          + +
          +
            +
          • + ✓ + {% filter force_escape %} + {% blocktrans %}{{ successful }} successfully processed{% endblocktrans %} + {% endfilter %} +
            • +
          • + ✗ + {% filter force_escape %} + {% blocktrans %}{{ failed }} failed to process{% endblocktrans %} + {% endfilter %} +
            • +
          +
          + + {% filter force_escape %} + {% blocktrans asvar course_cta_text %}Download the CSV report{% endblocktrans %} + {% endfilter %} + {% include "ace_common/edx_ace/common/return_to_course_cta.html" with course_cta_text=course_cta_text course_cta_url=course_url|add:"instructor#view-data_download" %} +
          +{% endblock %} diff --git a/lms/templates/instructor/edx_ace/batchenrollment/email/body.txt b/lms/templates/instructor/edx_ace/batchenrollment/email/body.txt new file mode 100644 index 000000000000..6183ead45b61 --- /dev/null +++ b/lms/templates/instructor/edx_ace/batchenrollment/email/body.txt @@ -0,0 +1,13 @@ +{% load i18n %} +{% autoescape off %} +{% blocktrans %}Batch {{ action_name }} completed for {{ course_name }}{% endblocktrans %} + +{% blocktrans %}The batch {{ action_name }} process for {{ course_name }} is complete.{% endblocktrans %} + +{% blocktrans %}Out of {{ total_processed }} users:{% endblocktrans %} + +✓ {% blocktrans %}{{ successful }} successfully processed{% endblocktrans %} +✗ {% blocktrans %}{{ failed }} failed to process{% endblocktrans %} + +{% blocktrans %}Download the CSV report{% endblocktrans %} +{% endautoescape %} diff --git a/lms/templates/instructor/edx_ace/batchenrollment/email/from_name.txt b/lms/templates/instructor/edx_ace/batchenrollment/email/from_name.txt new file mode 100644 index 000000000000..dcbc23c00480 --- /dev/null +++ b/lms/templates/instructor/edx_ace/batchenrollment/email/from_name.txt @@ -0,0 +1 @@ +{{ platform_name }} diff --git a/lms/templates/instructor/edx_ace/batchenrollment/email/head.html b/lms/templates/instructor/edx_ace/batchenrollment/email/head.html new file mode 100644 index 000000000000..366ada7ad92e --- /dev/null +++ b/lms/templates/instructor/edx_ace/batchenrollment/email/head.html @@ -0,0 +1 @@ +{% extends 'ace_common/edx_ace/common/base_head.html' %} diff --git a/lms/templates/instructor/edx_ace/batchenrollment/email/subject.txt b/lms/templates/instructor/edx_ace/batchenrollment/email/subject.txt new file mode 100644 index 000000000000..4ecd16bea64a --- /dev/null +++ b/lms/templates/instructor/edx_ace/batchenrollment/email/subject.txt @@ -0,0 +1,2 @@ +{% load i18n %} +{% blocktrans %}Batch {{ action_name }} completed for {{ course_name }}{% endblocktrans %} diff --git a/lms/templates/instructor/edx_ace/batchenrollment/push/body.txt b/lms/templates/instructor/edx_ace/batchenrollment/push/body.txt new file mode 100644 index 000000000000..39af1c274c82 --- /dev/null +++ b/lms/templates/instructor/edx_ace/batchenrollment/push/body.txt @@ -0,0 +1,4 @@ +{% load i18n %} +{% autoescape off %} +{% blocktrans %}Batch {{ action_name }} completed: {{ successful }}/{{ total_processed }} users processed for {{ course_name }}. CSV report available.{% endblocktrans %} +{% endautoescape %} diff --git a/lms/templates/instructor/edx_ace/batchenrollment/push/title.txt b/lms/templates/instructor/edx_ace/batchenrollment/push/title.txt new file mode 100644 index 000000000000..4ecd16bea64a --- /dev/null +++ b/lms/templates/instructor/edx_ace/batchenrollment/push/title.txt @@ -0,0 +1,2 @@ +{% load i18n %} +{% blocktrans %}Batch {{ action_name }} completed for {{ course_name }}{% endblocktrans %} diff --git a/lms/templates/instructor/instructor_dashboard_2/membership.html b/lms/templates/instructor/instructor_dashboard_2/membership.html index 9b1f64dfb9d1..d2721470a8db 100644 --- a/lms/templates/instructor/instructor_dashboard_2/membership.html +++ b/lms/templates/instructor/instructor_dashboard_2/membership.html @@ -49,6 +49,21 @@
          +
          + +
          diff --git a/lms/templates/student_account/register.underscore b/lms/templates/student_account/register.underscore index 84cdb09d5ce1..1822bafc7b64 100644 --- a/lms/templates/student_account/register.underscore +++ b/lms/templates/student_account/register.underscore @@ -56,14 +56,16 @@
          <%= context.fields /* xss-lint: disable=underscore-not-escaped */ %> -
          - - -
          + <% if (!context.skipRegistrationOptionalCheckboxes) { %> +
          + + +
          + <% } %>
          @@ -36,7 +37,7 @@
          % else: diff --git a/lms/tests.py b/lms/tests.py index 8a447958268b..67c5ee2f9f7a 100644 --- a/lms/tests.py +++ b/lms/tests.py @@ -4,7 +4,7 @@ import logging import mimetypes -from django.conf import settings # lint-amnesty, pylint: disable=unused-import +from django.conf import settings # pylint: disable=unused-import # noqa: F401 from django.test import TestCase log = logging.getLogger(__name__) diff --git a/lms/urls.py b/lms/urls.py index ca6744305a54..caa95569f3e0 100644 --- a/lms/urls.py +++ b/lms/urls.py @@ -17,13 +17,13 @@ from common.djangoapps.student import views as student_views from common.djangoapps.util import views as util_views from lms.djangoapps.branding import views as branding_views -from lms.djangoapps.courseware.masquerade import MasqueradeView from lms.djangoapps.courseware.block_render import ( handle_xblock_callback, handle_xblock_callback_noauth, xblock_view, - xqueue_callback + xqueue_callback, ) +from lms.djangoapps.courseware.masquerade import MasqueradeView from lms.djangoapps.courseware.views import views as courseware_views from lms.djangoapps.courseware.views.index import CoursewareIndex from lms.djangoapps.courseware.views.views import CourseTabView, EnrollStaffView, StaticCourseTabView @@ -33,6 +33,7 @@ from lms.djangoapps.discussion.notification_prefs import views as notification_prefs_views from lms.djangoapps.instructor.views import instructor_dashboard as instructor_dashboard_views from lms.djangoapps.instructor_task import views as instructor_task_views +from lms.djangoapps.mfe_config_api.urls import frontend_site_config_urls, mfe_config_urls from lms.djangoapps.static_template_view import views as static_template_view_views from lms.djangoapps.staticbook import views as staticbook_views from openedx.core.apidocs import api_info @@ -272,14 +273,14 @@ urlpatterns += [ # jump_to URLs for direct access to a location in the course re_path( - r'^courses/{}/jump_to/(?P.*)$'.format( + r'^courses/{}/jump_to/(?P.*)$'.format( # noqa: UP032 settings.COURSE_ID_PATTERN, ), courseware_views.jump_to, name='jump_to', ), re_path( - r'^courses/{}/jump_to_id/(?P.*)$'.format( + r'^courses/{}/jump_to_id/(?P.*)$'.format( # noqa: UP032 settings.COURSE_ID_PATTERN, ), courseware_views.jump_to_id, @@ -288,7 +289,7 @@ # xblock Handler APIs re_path( - r'^courses/{course_key}/xblock/{usage_key}/handler/(?P[^/]*)(?:/(?P.*))?$'.format( + r'^courses/{course_key}/xblock/{usage_key}/handler/(?P[^/]*)(?:/(?P.*))?$'.format( # noqa: UP032 course_key=settings.COURSE_ID_PATTERN, usage_key=settings.USAGE_ID_PATTERN, ), @@ -296,7 +297,7 @@ name='xblock_handler', ), re_path( - r'^courses/{course_key}/xblock/{usage_key}/handler_noauth/(?P[^/]*)(?:/(?P.*))?$'.format( + r'^courses/{course_key}/xblock/{usage_key}/handler_noauth/(?P[^/]*)(?:/(?P.*))?$'.format( # noqa: UP032 course_key=settings.COURSE_ID_PATTERN, usage_key=settings.USAGE_ID_PATTERN, ), @@ -308,7 +309,7 @@ # (unpublished) API that returns JSON with the HTML fragment and related resources # for the xBlock's requested view. re_path( - r'^courses/{course_key}/xblock/{usage_key}/view/(?P[^/]*)$'.format( + r'^courses/{course_key}/xblock/{usage_key}/view/(?P[^/]*)$'.format( # noqa: UP032 course_key=settings.COURSE_ID_PATTERN, usage_key=settings.USAGE_ID_PATTERN, ), @@ -344,12 +345,12 @@ name='xblock_resource_url', ), - # New (Learning-Core-based) XBlock REST API + # New XBlock REST API, based on the openedx_content API path('', include(('openedx.core.djangoapps.xblock.rest_api.urls', 'openedx.core.djangoapps.xblock'), namespace='xblock_api')), re_path( - r'^courses/{}/xqueue/(?P[^/]*)/(?P.*?)/(?P[^/]*)$'.format( + r'^courses/{}/xqueue/(?P[^/]*)/(?P.*?)/(?P[^/]*)$'.format( # noqa: UP032 settings.COURSE_ID_PATTERN, ), xqueue_callback, @@ -357,7 +358,7 @@ ), re_path( - r'^courses/{}/xqueue/(?P[^/]*)/(?P.*?)/(?P[^/]*)$'.format( + r'^courses/{}/xqueue/(?P[^/]*)/(?P.*?)/(?P[^/]*)$'.format( # noqa: UP032 settings.COURSE_ID_PATTERN, ), xqueue_callback, @@ -377,7 +378,7 @@ # About the course re_path( - r'^courses/{}/about$'.format( + r'^courses/{}/about$'.format( # noqa: UP032 settings.COURSE_ID_PATTERN, ), courseware_views.course_about, @@ -389,7 +390,7 @@ name='yt_video_metadata', ), re_path( - r'^courses/{}/enroll_staff$'.format( + r'^courses/{}/enroll_staff$'.format( # noqa: UP032 settings.COURSE_ID_PATTERN, ), EnrollStaffView.as_view(), @@ -398,7 +399,7 @@ # Inside the course re_path( - r'^courses/{}/$'.format( + r'^courses/{}/$'.format( # noqa: UP032 settings.COURSE_ID_PATTERN, ), courseware_views.course_about, @@ -406,7 +407,7 @@ ), # TODO arjun remove when custom tabs in place, see courseware/courses.py re_path( - r'^courses/{}/syllabus$'.format( + r'^courses/{}/syllabus$'.format( # noqa: UP032 settings.COURSE_ID_PATTERN, ), courseware_views.syllabus, @@ -415,7 +416,7 @@ # Survey associated with a course re_path( - r'^courses/{}/survey$'.format( + r'^courses/{}/survey$'.format( # noqa: UP032 settings.COURSE_ID_PATTERN, ), courseware_views.course_survey, @@ -423,14 +424,14 @@ ), re_path( - r'^courses/{}/book/(?P\d+)/$'.format( + r'^courses/{}/book/(?P\d+)/$'.format( # noqa: UP032 settings.COURSE_ID_PATTERN, ), staticbook_views.index, name='book', ), re_path( - r'^courses/{}/book/(?P\d+)/(?P\d+)$'.format( + r'^courses/{}/book/(?P\d+)/(?P\d+)$'.format( # noqa: UP032 settings.COURSE_ID_PATTERN, ), staticbook_views.index, @@ -438,14 +439,14 @@ ), re_path( - r'^courses/{}/pdfbook/(?P\d+)/$'.format( + r'^courses/{}/pdfbook/(?P\d+)/$'.format( # noqa: UP032 settings.COURSE_ID_PATTERN, ), staticbook_views.pdf_index, name='pdf_book', ), re_path( - r'^courses/{}/pdfbook/(?P\d+)/(?P\d+)$'.format( + r'^courses/{}/pdfbook/(?P\d+)/(?P\d+)$'.format( # noqa: UP032 settings.COURSE_ID_PATTERN, ), staticbook_views.pdf_index, @@ -453,14 +454,14 @@ ), re_path( - r'^courses/{}/pdfbook/(?P\d+)/chapter/(?P\d+)/$'.format( + r'^courses/{}/pdfbook/(?P\d+)/chapter/(?P\d+)/$'.format( # noqa: UP032 settings.COURSE_ID_PATTERN, ), staticbook_views.pdf_index, name='pdf_book', ), re_path( - r'^courses/{}/pdfbook/(?P\d+)/chapter/(?P\d+)/(?P\d+)$'.format( + r'^courses/{}/pdfbook/(?P\d+)/chapter/(?P\d+)/(?P\d+)$'.format( # noqa: UP032 settings.COURSE_ID_PATTERN, ), staticbook_views.pdf_index, @@ -468,14 +469,14 @@ ), re_path( - r'^courses/{}/htmlbook/(?P\d+)/$'.format( + r'^courses/{}/htmlbook/(?P\d+)/$'.format( # noqa: UP032 settings.COURSE_ID_PATTERN, ), staticbook_views.html_index, name='html_book', ), re_path( - r'^courses/{}/htmlbook/(?P\d+)/chapter/(?P\d+)/$'.format( + r'^courses/{}/htmlbook/(?P\d+)/chapter/(?P\d+)/$'.format( # noqa: UP032 settings.COURSE_ID_PATTERN, ), staticbook_views.html_index, @@ -483,28 +484,28 @@ ), re_path( - r'^courses/{}/courseware/?$'.format( + r'^courses/{}/courseware/?$'.format( # noqa: UP032 settings.COURSE_ID_PATTERN, ), CoursewareIndex.as_view(), name='courseware', ), re_path( - r'^courses/{}/courseware/(?P
          [^/]*)/$'.format( + r'^courses/{}/courseware/(?P
          [^/]*)/$'.format( # noqa: UP032 settings.COURSE_ID_PATTERN, ), CoursewareIndex.as_view(), name='courseware_section', ), re_path( - r'^courses/{}/courseware/(?P
          [^/]*)/(?P[^/]*)/$'.format( + r'^courses/{}/courseware/(?P
          [^/]*)/(?P[^/]*)/$'.format( # noqa: UP032 settings.COURSE_ID_PATTERN, ), CoursewareIndex.as_view(), name='courseware_subsection', ), re_path( - r'^courses/{}/courseware/(?P
          [^/]*)/(?P[^/]*)/(?P[^/]*)/?$'.format( + r'^courses/{}/courseware/(?P
          [^/]*)/(?P[^/]*)/(?P[^/]*)/?$'.format( # noqa: UP032 settings.COURSE_ID_PATTERN, ), CoursewareIndex.as_view(), @@ -513,7 +514,7 @@ # progress page re_path( - r'^courses/{}/progress$'.format( + r'^courses/{}/progress$'.format( # noqa: UP032 settings.COURSE_ID_PATTERN, ), courseware_views.progress, @@ -521,11 +522,11 @@ ), # dates page (no longer functional, just redirects to MFE) - re_path(r'^courses/{}/dates'.format(settings.COURSE_ID_PATTERN), courseware_views.dates, name='dates'), + re_path(r'^courses/{}/dates'.format(settings.COURSE_ID_PATTERN), courseware_views.dates, name='dates'), # noqa: UP032 # Takes optional student_id for instructor use--shows profile as that student sees it. re_path( - r'^courses/{}/progress/(?P[^/]*)/$'.format( + r'^courses/{}/progress/(?P[^/]*)/$'.format( # noqa: UP032 settings.COURSE_ID_PATTERN, ), courseware_views.progress, @@ -542,7 +543,7 @@ # For the instructor re_path( - r'^courses/{}/instructor$'.format( + r'^courses/{}/instructor$'.format( # noqa: UP032 settings.COURSE_ID_PATTERN, ), instructor_dashboard_views.instructor_dashboard_2, @@ -550,7 +551,7 @@ ), re_path( - r'^courses/{}/set_course_mode_price$'.format( + r'^courses/{}/set_course_mode_price$'.format( # noqa: UP032 settings.COURSE_ID_PATTERN, ), instructor_dashboard_views.set_course_mode_price, @@ -559,7 +560,7 @@ # Discussions Management re_path( - r'^courses/{}/discussions/settings$'.format( + r'^courses/{}/discussions/settings$'.format( # noqa: UP032 settings.COURSE_KEY_PATTERN, ), discussion_views.course_discussions_settings_handler, @@ -573,49 +574,49 @@ # Cohorts management re_path( - r'^courses/{}/cohorts/settings$'.format( + r'^courses/{}/cohorts/settings$'.format( # noqa: UP032 settings.COURSE_KEY_PATTERN, ), course_groups_views.course_cohort_settings_handler, name='course_cohort_settings', ), re_path( - r'^courses/{}/cohorts/(?P[0-9]+)?$'.format( + r'^courses/{}/cohorts/(?P[0-9]+)?$'.format( # noqa: UP032 settings.COURSE_KEY_PATTERN, ), course_groups_views.cohort_handler, name='cohorts', ), re_path( - r'^courses/{}/cohorts/(?P[0-9]+)$'.format( + r'^courses/{}/cohorts/(?P[0-9]+)$'.format( # noqa: UP032 settings.COURSE_KEY_PATTERN, ), course_groups_views.users_in_cohort, name='list_cohort', ), re_path( - r'^courses/{}/cohorts/(?P[0-9]+)/add$'.format( + r'^courses/{}/cohorts/(?P[0-9]+)/add$'.format( # noqa: UP032 settings.COURSE_KEY_PATTERN, ), course_groups_views.add_users_to_cohort, name='add_to_cohort', ), re_path( - r'^courses/{}/cohorts/(?P[0-9]+)/delete$'.format( + r'^courses/{}/cohorts/(?P[0-9]+)/delete$'.format( # noqa: UP032 settings.COURSE_KEY_PATTERN, ), course_groups_views.remove_user_from_cohort, name='remove_from_cohort', ), re_path( - r'^courses/{}/cohorts/debug$'.format( + r'^courses/{}/cohorts/debug$'.format( # noqa: UP032 settings.COURSE_KEY_PATTERN, ), course_groups_views.debug_cohort_mgmt, name='debug_cohort_mgmt', ), re_path( - r'^courses/{}/discussion/topics$'.format( + r'^courses/{}/discussion/topics$'.format( # noqa: UP032 settings.COURSE_KEY_PATTERN, ), discussion_views.discussion_topics, @@ -624,7 +625,7 @@ # LTI endpoints listing re_path( - r'^courses/{}/lti_rest_endpoints/'.format( + r'^courses/{}/lti_rest_endpoints/'.format( # noqa: UP032 settings.COURSE_ID_PATTERN, ), courseware_views.get_course_lti_endpoints, @@ -633,7 +634,7 @@ # Student Notes re_path( - r'^courses/{}/edxnotes/'.format( + r'^courses/{}/edxnotes/'.format( # noqa: UP032 settings.COURSE_ID_PATTERN, ), include('lms.djangoapps.edxnotes.urls'), @@ -654,7 +655,7 @@ # Course experience re_path( - r'^courses/{}/course/'.format( + r'^courses/{}/course/'.format( # noqa: UP032 settings.COURSE_ID_PATTERN, ), include('openedx.features.course_experience.urls'), @@ -662,7 +663,7 @@ # Course bookmarks UI in LMS re_path( - r'^courses/{}/bookmarks/'.format( + r'^courses/{}/bookmarks/'.format( # noqa: UP032 settings.COURSE_ID_PATTERN, ), include('openedx.features.course_bookmarks.urls'), @@ -676,7 +677,7 @@ # Survey Report re_path( - fr'^survey_report/', + fr'^survey_report/', # noqa: F541 include('openedx.features.survey_report.urls'), ), ] @@ -689,7 +690,7 @@ include('lms.djangoapps.teams.api_urls') ), re_path( - r'^courses/{}/teams/'.format( + r'^courses/{}/teams/'.format( # noqa: UP032 settings.COURSE_ID_PATTERN, ), include('lms.djangoapps.teams.urls'), @@ -701,7 +702,7 @@ if settings.FEATURES.get('ENABLE_MASQUERADE'): urlpatterns += [ re_path( - r'^courses/{}/masquerade$'.format( + r'^courses/{}/masquerade$'.format( # noqa: UP032 settings.COURSE_KEY_PATTERN, ), MasqueradeView.as_view(), @@ -711,7 +712,7 @@ urlpatterns += [ re_path( - r'^courses/{}/generate_user_cert'.format( + r'^courses/{}/generate_user_cert'.format( # noqa: UP032 settings.COURSE_ID_PATTERN, ), courseware_views.generate_user_cert, @@ -727,7 +728,7 @@ include('lms.djangoapps.discussion.rest_api.urls') ), re_path( - r'^courses/{}/discussion/'.format( + r'^courses/{}/discussion/'.format( # noqa: UP032 settings.COURSE_ID_PATTERN, ), include('lms.djangoapps.discussion.django_comment_client.urls') @@ -743,7 +744,7 @@ urlpatterns += [ re_path( - r'^courses/{}/tab/(?P[^/]+)/$'.format( + r'^courses/{}/tab/(?P[^/]+)/$'.format( # noqa: UP032 settings.COURSE_ID_PATTERN, ), CourseTabView.as_view(), @@ -753,7 +754,7 @@ urlpatterns += [ re_path( - r'^courses/{}/courseware-search/enabled/$'.format( + r'^courses/{}/courseware-search/enabled/$'.format( # noqa: UP032 settings.COURSE_ID_PATTERN, ), courseware_views.courseware_mfe_search_enabled, @@ -768,7 +769,7 @@ urlpatterns += [ re_path( - r'^courses/{}/lti_tab/(?P[^/]+)/$'.format( + r'^courses/{}/lti_tab/(?P[^/]+)/$'.format( # noqa: UP032 settings.COURSE_ID_PATTERN, ), CourseTabView.as_view(), @@ -780,7 +781,7 @@ urlpatterns += [ # This MUST be the last view in the courseware--it's a catch-all for custom tabs. re_path( - r'^courses/{}/(?P[^/]+)/$'.format( + r'^courses/{}/(?P[^/]+)/$'.format( # noqa: UP032 settings.COURSE_ID_PATTERN, ), StaticCourseTabView.as_view(), @@ -791,7 +792,7 @@ if settings.FEATURES.get('ENABLE_STUDENT_HISTORY_VIEW'): urlpatterns += [ re_path( - r'^courses/{}/submission_history/(?P[^/]*)/(?P.*?)$'.format( + r'^courses/{}/submission_history/(?P[^/]*)/(?P.*?)$'.format( # noqa: UP032 settings.COURSE_ID_PATTERN ), courseware_views.submission_history, @@ -1055,7 +1056,8 @@ # MFE API urls urlpatterns += [ - path('api/mfe_config/v1', include(('lms.djangoapps.mfe_config_api.urls', 'lms.djangoapps.mfe_config_api'), namespace='mfe_config_api')) + path('api/mfe_config/v1', include((mfe_config_urls, 'lms.djangoapps.mfe_config_api'), namespace='mfe_config_api')), + path('api/frontend_site_config/v1/', include((frontend_site_config_urls, 'lms.djangoapps.mfe_config_api'), namespace='frontend_site_config')) ] urlpatterns += [ diff --git a/lms/wsgi.py b/lms/wsgi.py index 0321c827ccf5..ecdcaa2157f8 100644 --- a/lms/wsgi.py +++ b/lms/wsgi.py @@ -10,12 +10,17 @@ # Patch the xml libs from openedx.core.lib.safe_lxml import defuse_xml_libs + defuse_xml_libs() -import os # lint-amnesty, pylint: disable=wrong-import-order, wrong-import-position +import os # pylint: disable=wrong-import-order, wrong-import-position + os.environ.setdefault("DJANGO_SETTINGS_MODULE", "lms.envs.aws") # This application object is used by the development server # as well as any WSGI server configured to use this file. -from django.core.wsgi import get_wsgi_application # lint-amnesty, pylint: disable=wrong-import-order, wrong-import-position +from django.core.wsgi import ( + get_wsgi_application, # pylint: disable=wrong-import-order, wrong-import-position +) + application = get_wsgi_application() diff --git a/lms/wsgi_apache_lms.py b/lms/wsgi_apache_lms.py index be74f3dc2580..3835d2187f8f 100644 --- a/lms/wsgi_apache_lms.py +++ b/lms/wsgi_apache_lms.py @@ -7,13 +7,17 @@ # Patch the xml libs before anything else. from openedx.core.lib.safe_lxml import defuse_xml_libs + defuse_xml_libs() -import os # lint-amnesty, pylint: disable=wrong-import-order, wrong-import-position +import os # pylint: disable=wrong-import-order, wrong-import-position os.environ.setdefault("DJANGO_SETTINGS_MODULE", "lms.envs.aws") # This application object is used by the development server # as well as any WSGI server configured to use this file. -from django.core.wsgi import get_wsgi_application # lint-amnesty, pylint: disable=wrong-import-order, wrong-import-position +from django.core.wsgi import ( + get_wsgi_application, # pylint: disable=wrong-import-order, wrong-import-position +) + application = get_wsgi_application() # pylint: disable=invalid-name diff --git a/manage.py b/manage.py index 90e87b6b1dcc..e852b25adce4 100755 --- a/manage.py +++ b/manage.py @@ -13,10 +13,11 @@ # pylint: disable=wrong-import-order, wrong-import-position from openedx.core.lib.logsettings import log_python_warnings + log_python_warnings() # Patch the xml libs before anything else. -from openedx.core.lib.safe_lxml import defuse_xml_libs # isort:skip +from openedx.core.lib.safe_lxml import defuse_xml_libs # noqa: I001 - must patch xml libs before other imports execute defuse_xml_libs() import os diff --git a/mypy.ini b/mypy.ini index 982e500b3a93..6e36cde13e6c 100644 --- a/mypy.ini +++ b/mypy.ini @@ -6,15 +6,17 @@ plugins = mypy_django_plugin.main, mypy_drf_plugin.main files = - cms/lib/xblock/upstream_sync.py, - cms/lib/xblock/upstream_sync_container.py, - cms/djangoapps/contentstore/rest_api/v2/views/downstreams.py, + cms/lib/xblock, + cms/djangoapps/contentstore/rest_api/v2/views, + cms/djangoapps/contentstore/xblock_storage_handlers, + cms/djangoapps/contentstore/helpers.py, cms/djangoapps/modulestore_migrator, openedx/core/djangoapps/content/learning_sequences, # FIXME: need to solve type issues and add 'search' app here: # openedx/core/djangoapps/content/search, openedx/core/djangoapps/content_staging, openedx/core/djangoapps/content_libraries, + openedx/core/djangoapps/discussions/services.py, openedx/core/djangoapps/programs/rest_api, openedx/core/djangoapps/xblock, openedx/core/lib/derived.py, diff --git a/openedx/core/djangoapps/ace_common/__init__.py b/openedx/core/djangoapps/ace_common/__init__.py index fa59cbe49abd..31bee2448854 100644 --- a/openedx/core/djangoapps/ace_common/__init__.py +++ b/openedx/core/djangoapps/ace_common/__init__.py @@ -1,5 +1,5 @@ """ -# lint-amnesty, pylint: disable=django-not-configured +# pylint: disable=django-not-configured ace_common is a Django App that provides common utilities and templates for edx-platform applications that use ACE as their messaging framework. """ diff --git a/openedx/core/djangoapps/ace_common/message.py b/openedx/core/djangoapps/ace_common/message.py index a25104956bfd..bf2369fa7644 100644 --- a/openedx/core/djangoapps/ace_common/message.py +++ b/openedx/core/djangoapps/ace_common/message.py @@ -8,7 +8,7 @@ from openedx.core.djangoapps.site_configuration import helpers as configuration_helpers -class BaseMessageType(MessageType): # lint-amnesty, pylint: disable=missing-class-docstring +class BaseMessageType(MessageType): # pylint: disable=missing-class-docstring def __init__(self, *args, **kwargs): super().__init__(*args, **kwargs) from_address = configuration_helpers.get_value('email_from_address') diff --git a/openedx/core/djangoapps/ace_common/policies.py b/openedx/core/djangoapps/ace_common/policies.py index 11dc75b1e6e3..7835a0eed16f 100644 --- a/openedx/core/djangoapps/ace_common/policies.py +++ b/openedx/core/djangoapps/ace_common/policies.py @@ -6,7 +6,6 @@ from edx_ace.channel import ChannelType from edx_ace.policy import Policy, PolicyResult - User = get_user_model() log = logging.getLogger(__name__) diff --git a/openedx/core/djangoapps/ace_common/settings/common.py b/openedx/core/djangoapps/ace_common/settings/common.py index 5d10766ede94..5becd4ab5074 100644 --- a/openedx/core/djangoapps/ace_common/settings/common.py +++ b/openedx/core/djangoapps/ace_common/settings/common.py @@ -6,7 +6,7 @@ ACE_ROUTING_KEY = 'edx.lms.core.default' -def plugin_settings(settings): # lint-amnesty, pylint: disable=missing-function-docstring, missing-module-docstring +def plugin_settings(settings): # pylint: disable=missing-function-docstring, missing-module-docstring if 'push_notifications' not in settings.INSTALLED_APPS: settings.INSTALLED_APPS.append('push_notifications') settings.ACE_ENABLED_CHANNELS = [ diff --git a/openedx/core/djangoapps/ace_common/template_context.py b/openedx/core/djangoapps/ace_common/template_context.py index 25cfe6c02a6d..43d6d04c2265 100644 --- a/openedx/core/djangoapps/ace_common/template_context.py +++ b/openedx/core/djangoapps/ace_common/template_context.py @@ -5,8 +5,8 @@ from django.conf import settings from django.urls import NoReverseMatch, reverse -from lms.djangoapps.branding.api import get_logo_url_for_email from common.djangoapps.edxmako.shortcuts import marketing_link +from lms.djangoapps.branding.api import get_logo_url_for_email from openedx.core.djangoapps.theming.helpers import get_config_value_from_site_or_settings diff --git a/openedx/core/djangoapps/ace_common/templatetags/ace.py b/openedx/core/djangoapps/ace_common/templatetags/ace.py index 8a7f2b5451ee..70177b8d8d25 100644 --- a/openedx/core/djangoapps/ace_common/templatetags/ace.py +++ b/openedx/core/djangoapps/ace_common/templatetags/ace.py @@ -56,7 +56,7 @@ def _get_variables_from_context(context, tag_name): if request is None: raise template.VariableDoesNotExist( - 'The {} template tag requires a "request" to be present in the template context. Consider using ' + 'The {} template tag requires a "request" to be present in the template context. Consider using ' # noqa: UP032 # pylint: disable=line-too-long '"emulate_http_request" if you are rendering the template in a celery task.'.format(tag_name) ) @@ -96,13 +96,15 @@ def google_analytics_tracking_pixel(context): def _get_google_analytics_tracking_url(context): site, user, message = _get_variables_from_context(context, 'google_analytics_tracking_pixel') + user_id = user.id if user else None + pixel = GoogleAnalyticsTrackingPixel( site=site, - user_id=user.id, + user_id=user_id, campaign_source=message.app_label, campaign_name=message.name, campaign_content=message.uuid, - document_path='/email/{}/{}/{}/{}'.format( + document_path='/email/{}/{}/{}/{}'.format( # noqa: UP032 message.app_label, message.name, message.send_uuid, diff --git a/openedx/core/djangoapps/ace_common/tests/mixins.py b/openedx/core/djangoapps/ace_common/tests/mixins.py index aed566504c4c..1b16982a1d5f 100644 --- a/openedx/core/djangoapps/ace_common/tests/mixins.py +++ b/openedx/core/djangoapps/ace_common/tests/mixins.py @@ -8,8 +8,8 @@ from django.http import HttpRequest from edx_ace import Message, Recipient -from openedx.core.djangoapps.site_configuration.tests.factories import SiteFactory from common.djangoapps.student.tests.factories import UserFactory +from openedx.core.djangoapps.site_configuration.tests.factories import SiteFactory class QueryStringAssertionMixin: @@ -25,7 +25,7 @@ def assert_query_string_equal(self, expected_qs, actual_qs): Raises: AssertionError: If the two query strings are not equal. """ - self.assertDictEqual(parse_qs(expected_qs), parse_qs(actual_qs)) + self.assertDictEqual(parse_qs(expected_qs), parse_qs(actual_qs)) # noqa: PT009 def assert_url_components_equal(self, url, **kwargs): """ diff --git a/openedx/core/djangoapps/ace_common/tests/test_message.py b/openedx/core/djangoapps/ace_common/tests/test_message.py index 16d2d31eb5dc..069342d496bb 100644 --- a/openedx/core/djangoapps/ace_common/tests/test_message.py +++ b/openedx/core/djangoapps/ace_common/tests/test_message.py @@ -10,7 +10,7 @@ @ddt.ddt -class TestAbsoluteUrl(TestCase): # lint-amnesty, pylint: disable=missing-class-docstring +class TestAbsoluteUrl(TestCase): # pylint: disable=missing-class-docstring @ddt.data( ('test@example.com', True), diff --git a/openedx/core/djangoapps/ace_common/tests/test_templatetags.py b/openedx/core/djangoapps/ace_common/tests/test_templatetags.py index 6df495060304..3280cc9c6232 100644 --- a/openedx/core/djangoapps/ace_common/tests/test_templatetags.py +++ b/openedx/core/djangoapps/ace_common/tests/test_templatetags.py @@ -9,7 +9,7 @@ _get_google_analytics_tracking_url, ensure_url_is_absolute, google_analytics_tracking_pixel, - with_link_tracking + with_link_tracking, ) from openedx.core.djangoapps.ace_common.tests.mixins import EmailTemplateTagMixin, QueryStringAssertionMixin from openedx.core.djangoapps.site_configuration.tests.factories import SiteFactory @@ -47,7 +47,7 @@ def test_default(self): scheme='http', netloc='example.com', path='/foo', - query='utm_source=test_app_label&utm_campaign=test_name&utm_medium=email&utm_content={uuid}'.format( + query='utm_source=test_app_label&utm_campaign=test_name&utm_medium=email&utm_content={uuid}'.format( # noqa: UP032 # pylint: disable=line-too-long uuid=self.message.uuid ) ) @@ -102,7 +102,7 @@ def test_default(self): cs=self.message.app_label, cn=self.message.name, cc=self.message.uuid, - dp='/email/test_app_label/test_name/{send_uuid}/{uuid}'.format( + dp='/email/test_app_label/test_name/{send_uuid}/{uuid}'.format( # noqa: UP032 send_uuid=self.message.send_uuid, uuid=self.message.uuid, ), diff --git a/openedx/core/djangoapps/ace_common/tests/test_tracking.py b/openedx/core/djangoapps/ace_common/tests/test_tracking.py index b6c0fa1df5b6..ed8f7ebb39f6 100644 --- a/openedx/core/djangoapps/ace_common/tests/test_tracking.py +++ b/openedx/core/djangoapps/ace_common/tests/test_tracking.py @@ -10,7 +10,7 @@ DEFAULT_CAMPAIGN_MEDIUM, DEFAULT_CAMPAIGN_SOURCE, CampaignTrackingInfo, - GoogleAnalyticsTrackingPixel + GoogleAnalyticsTrackingPixel, ) from openedx.core.djangoapps.site_configuration.tests.factories import SiteConfigurationFactory from openedx.core.djangolib.testing.utils import CacheIsolationTestCase @@ -82,7 +82,7 @@ def test_default_parameters(self): scheme='https', netloc='www.google-analytics.com', path='/collect', - query='v=1&t=event&cs={cs}&cm={cm}&ec=email&ea=edx.bi.email.opened&cid={cid}&tid=UA-123456-1'.format( + query='v=1&t=event&cs={cs}&cm={cm}&ec=email&ea=edx.bi.email.opened&cid={cid}&tid=UA-123456-1'.format( # noqa: UP032 # pylint: disable=line-too-long cs=DEFAULT_CAMPAIGN_SOURCE, cm=DEFAULT_CAMPAIGN_MEDIUM, cid=GoogleAnalyticsTrackingPixel.ANONYMOUS_USER_CLIENT_ID, @@ -138,7 +138,7 @@ def test_custom_dimension(self): assert pixel.generate_image_url() is not None self.assert_url_components_equal( pixel.generate_image_url(), - query='v=1&t=event&ec=email&ea=edx.bi.email.opened&cid={cid}&tid=UA-123456-1&cd40=10&uid=10'.format( + query='v=1&t=event&ec=email&ea=edx.bi.email.opened&cid={cid}&tid=UA-123456-1&cd40=10&uid=10'.format( # noqa: UP032 # pylint: disable=line-too-long cid=GoogleAnalyticsTrackingPixel.ANONYMOUS_USER_CLIENT_ID, ) ) @@ -152,7 +152,7 @@ def test_custom_dimension_without_user_id(self): assert pixel.generate_image_url() is not None self.assert_url_components_equal( pixel.generate_image_url(), - query='v=1&t=event&ec=email&ea=edx.bi.email.opened&cid={cid}&tid=UA-123456-1'.format( + query='v=1&t=event&ec=email&ea=edx.bi.email.opened&cid={cid}&tid=UA-123456-1'.format( # noqa: UP032 cid=GoogleAnalyticsTrackingPixel.ANONYMOUS_USER_CLIENT_ID, ) ) diff --git a/openedx/core/djangoapps/agreements/admin.py b/openedx/core/djangoapps/agreements/admin.py index 82e2427dff50..8f7cf906c9bf 100644 --- a/openedx/core/djangoapps/agreements/admin.py +++ b/openedx/core/djangoapps/agreements/admin.py @@ -3,10 +3,14 @@ """ from django.contrib import admin -from openedx.core.djangoapps.agreements.models import IntegritySignature -from openedx.core.djangoapps.agreements.models import LTIPIITool -from openedx.core.djangoapps.agreements.models import LTIPIISignature -from openedx.core.djangoapps.agreements.models import ProctoringPIISignature + +from openedx.core.djangoapps.agreements.models import ( + IntegritySignature, + LTIPIISignature, + LTIPIITool, + ProctoringPIISignature, + UserAgreement, +) class IntegritySignatureAdmin(admin.ModelAdmin): @@ -62,3 +66,17 @@ class Meta: admin.site.register(ProctoringPIISignature, ProctoringPIISignatureAdmin) + + +class UserAgreementAdmin(admin.ModelAdmin): + """ + Admin for the UserAgreement Model + """ + + list_display = ("type", "name", "url", "created", "updated") + + class Meta: + model = UserAgreement + + +admin.site.register(UserAgreement, UserAgreementAdmin) diff --git a/openedx/core/djangoapps/agreements/api.py b/openedx/core/djangoapps/agreements/api.py index 2489cefb8533..2b88048a294f 100644 --- a/openedx/core/djangoapps/agreements/api.py +++ b/openedx/core/djangoapps/agreements/api.py @@ -3,17 +3,25 @@ """ import logging +from datetime import datetime +from typing import Iterator # noqa: UP035 from django.contrib.auth import get_user_model from django.core.exceptions import ObjectDoesNotExist from opaque_keys.edx.keys import CourseKey -from openedx.core.djangoapps.agreements.models import IntegritySignature -from openedx.core.djangoapps.agreements.models import LTIPIITool -from openedx.core.djangoapps.agreements.models import LTIPIISignature - -from .data import LTIToolsReceivingPIIData -from .data import LTIPIISignatureData +from openedx.core.djangoapps.agreements.data import ( + LTIPIISignatureData, + LTIToolsReceivingPIIData, + UserAgreementRecordData, +) +from openedx.core.djangoapps.agreements.models import ( + IntegritySignature, + LTIPIISignature, + LTIPIITool, + UserAgreement, + UserAgreementRecord, +) log = logging.getLogger(__name__) User = get_user_model() @@ -35,7 +43,7 @@ def create_integrity_signature(username, course_id): signature, created = IntegritySignature.objects.get_or_create(user=user, course_key=course_key) if not created: log.warning( - 'Integrity signature already exists for user_id={user_id} and ' + 'Integrity signature already exists for user_id={user_id} and ' # noqa: UP032 'course_id={course_id}'.format(user_id=user.id, course_id=course_id) ) return signature @@ -240,3 +248,46 @@ def _user_signature_out_of_date(username, course_id): return False else: return user_lti_pii_signature_hash != course_lti_pii_tools_hash + + +def get_user_agreement_records(user: User) -> Iterator[UserAgreementRecordData]: + """ + Retrieves all the agreements that the specified user has acknowledged. + """ + for agreement_record in UserAgreementRecord.objects.filter(user=user).select_related("agreement", "user"): + yield UserAgreementRecordData.from_model(agreement_record) + + +def get_latest_user_agreement_record( + user: User, + agreement_type: str, +) -> UserAgreementRecordData: + """ + Retrieve the user agreement record for the specified user and agreement type. + + An agreement update timestamp can be provided to return a record only if it + was signed after that timestamp. + """ + record_query = UserAgreementRecord.objects.filter( + user=user, + agreement__type=agreement_type, + ) + if record_query.exists(): + return UserAgreementRecordData.from_model(record_query.latest("timestamp")) + return UserAgreementRecordData( + username=user.get_username(), + agreement_type=agreement_type, + ) + + +def create_user_agreement_record(user: User, agreement_type: str) -> UserAgreementRecordData: + """ + Creates a user agreement record with current timestamp. + """ + agreement = UserAgreement.objects.get(type=agreement_type) + record = UserAgreementRecord.objects.create( + user=user, + agreement=agreement, + timestamp=datetime.now(), + ) + return UserAgreementRecordData.from_model(record) diff --git a/openedx/core/djangoapps/agreements/data.py b/openedx/core/djangoapps/agreements/data.py index 9d843c73cb04..4f27145ad531 100644 --- a/openedx/core/djangoapps/agreements/data.py +++ b/openedx/core/djangoapps/agreements/data.py @@ -1,8 +1,13 @@ """ Public data structures for this app. """ + +from datetime import datetime + import attr +from openedx.core.djangoapps.agreements.models import UserAgreement, UserAgreementRecord + @attr.s(frozen=True, auto_attribs=True) class LTIToolsReceivingPIIData: @@ -21,3 +26,47 @@ class LTIPIISignatureData: course_id: str lti_tools: str lti_tools_hash: str + + +@attr.s(frozen=True, auto_attribs=True) +class UserAgreementData: + """ + Data for a user agreement record. + """ + + type: str + name: str + summary: str + has_text: bool + url: str | None + + @classmethod + def from_model(cls, model: UserAgreement): + return UserAgreementData( + type=model.type, + name=model.name, + summary=model.summary, + url=model.url, + has_text=bool(model.text), + ) + + +@attr.s(frozen=True, auto_attribs=True) +class UserAgreementRecordData: + """ + Data for a single user agreement record. + """ + + username: str + agreement_type: str + accepted_at: datetime | None = None + is_current: bool = False + + @classmethod + def from_model(cls, model: UserAgreementRecord): + return UserAgreementRecordData( + username=model.user.username, + agreement_type=model.agreement.type, + accepted_at=model.timestamp, + is_current=model.is_current, + ) diff --git a/openedx/core/djangoapps/agreements/migrations/0001_initial.py b/openedx/core/djangoapps/agreements/migrations/0001_initial.py index 5db5e1429f2f..87df97246bb5 100644 --- a/openedx/core/djangoapps/agreements/migrations/0001_initial.py +++ b/openedx/core/djangoapps/agreements/migrations/0001_initial.py @@ -1,11 +1,11 @@ # Generated by Django 2.2.20 on 2021-05-07 16:53 -from django.conf import settings -from django.db import migrations, models import django.db.models.deletion import django.utils.timezone import model_utils.fields import opaque_keys.edx.django.models +from django.conf import settings +from django.db import migrations, models class Migration(migrations.Migration): diff --git a/openedx/core/djangoapps/agreements/migrations/0002_ltipiisignature.py b/openedx/core/djangoapps/agreements/migrations/0002_ltipiisignature.py index c72ab0dc8c57..25cc4e391957 100644 --- a/openedx/core/djangoapps/agreements/migrations/0002_ltipiisignature.py +++ b/openedx/core/djangoapps/agreements/migrations/0002_ltipiisignature.py @@ -1,9 +1,9 @@ # Generated by Django 3.2.20 on 2023-08-02 13:59 -from django.conf import settings -from django.db import migrations, models import django.db.models.deletion import opaque_keys.edx.django.models +from django.conf import settings +from django.db import migrations, models class Migration(migrations.Migration): diff --git a/openedx/core/djangoapps/agreements/migrations/0002_ltipiitool.py b/openedx/core/djangoapps/agreements/migrations/0002_ltipiitool.py index fde896bc8d71..128288e03002 100644 --- a/openedx/core/djangoapps/agreements/migrations/0002_ltipiitool.py +++ b/openedx/core/djangoapps/agreements/migrations/0002_ltipiitool.py @@ -1,7 +1,7 @@ # Generated by Django 3.2.20 on 2023-08-01 14:06 -from django.db import migrations, models import opaque_keys.edx.django.models +from django.db import migrations, models class Migration(migrations.Migration): diff --git a/openedx/core/djangoapps/agreements/migrations/0004_proctoringpiisignature.py b/openedx/core/djangoapps/agreements/migrations/0004_proctoringpiisignature.py index befe64cd5a5a..fc834a2c9d61 100644 --- a/openedx/core/djangoapps/agreements/migrations/0004_proctoringpiisignature.py +++ b/openedx/core/djangoapps/agreements/migrations/0004_proctoringpiisignature.py @@ -1,9 +1,9 @@ # Generated by Django 3.2.20 on 2023-08-03 16:09 -from django.conf import settings -from django.db import migrations, models import django.db.models.deletion import opaque_keys.edx.django.models +from django.conf import settings +from django.db import migrations, models class Migration(migrations.Migration): diff --git a/openedx/core/djangoapps/agreements/migrations/0005_timestampedmodels.py b/openedx/core/djangoapps/agreements/migrations/0005_timestampedmodels.py index 53eb07fc3daa..a8c2bbf82d03 100644 --- a/openedx/core/djangoapps/agreements/migrations/0005_timestampedmodels.py +++ b/openedx/core/djangoapps/agreements/migrations/0005_timestampedmodels.py @@ -1,8 +1,8 @@ # Generated by Django 3.2.22 on 2023-10-25 14:58 -from django.db import migrations import django.utils.timezone import model_utils.fields +from django.db import migrations class Migration(migrations.Migration): diff --git a/openedx/core/djangoapps/agreements/migrations/0006_useragreementrecord.py b/openedx/core/djangoapps/agreements/migrations/0006_useragreementrecord.py new file mode 100644 index 000000000000..b77e4f4de264 --- /dev/null +++ b/openedx/core/djangoapps/agreements/migrations/0006_useragreementrecord.py @@ -0,0 +1,24 @@ +# Generated by Django 4.2.16 on 2024-12-06 11:34 + +import django.db.models.deletion +from django.conf import settings +from django.db import migrations, models + + +class Migration(migrations.Migration): + dependencies = [ + migrations.swappable_dependency(settings.AUTH_USER_MODEL), + ("agreements", "0005_timestampedmodels"), + ] + + operations = [ + migrations.CreateModel( + name="UserAgreementRecord", + fields=[ + ("id", models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name="ID")), + ("agreement_type", models.CharField(max_length=255)), + ("timestamp", models.DateTimeField(auto_now_add=True)), + ("user", models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to=settings.AUTH_USER_MODEL)), + ], + ), + ] diff --git a/openedx/core/djangoapps/agreements/migrations/0007_historicaluseragreement_useragreement_and_more.py b/openedx/core/djangoapps/agreements/migrations/0007_historicaluseragreement_useragreement_and_more.py new file mode 100644 index 000000000000..e91e40fc7f93 --- /dev/null +++ b/openedx/core/djangoapps/agreements/migrations/0007_historicaluseragreement_useragreement_and_more.py @@ -0,0 +1,141 @@ +# Generated by Django 5.2.10 on 2026-01-26 10:21 + +import django.db.models.deletion +import simple_history.models +from django.conf import settings +from django.db import migrations, models + + +class Migration(migrations.Migration): + dependencies = [ + ("agreements", "0006_useragreementrecord"), + migrations.swappable_dependency(settings.AUTH_USER_MODEL), + ] + + operations = [ + migrations.CreateModel( + name="HistoricalUserAgreement", + fields=[ + ("id", models.IntegerField(auto_created=True, blank=True, db_index=True, verbose_name="ID")), + ("type", models.CharField(db_index=True, max_length=255)), + ( + "name", + models.CharField( + help_text="Human-readable name for the agreement type. Will be displayed to users in an alert to accept/reject the agreement.", + max_length=255, + ), + ), + ( + "summary", + models.TextField( + help_text="Brief summary of the agreement content. Will be displayed to users in alert to accept the agreement.", + max_length=1024, + ), + ), + ( + "text", + models.TextField( + blank=True, help_text="Full text of the agreement. (Required if url is not provided)", null=True + ), + ), + ( + "url", + models.URLField( + blank=True, + help_text='URL where the full agreement can be accessed. Will be used for "Learn More" link in alert to accept the agreement.', + null=True, + ), + ), + ("created", models.DateTimeField(blank=True, editable=False)), + ( + "updated", + models.DateTimeField( + help_text="Timestamp of the last update to this agreement. If changed users will be prompted to accept the agreement again." + ), + ), + ("history_id", models.AutoField(primary_key=True, serialize=False)), + ("history_date", models.DateTimeField()), + ("history_change_reason", models.CharField(max_length=100, null=True)), + ( + "history_type", + models.CharField(choices=[("+", "Created"), ("~", "Changed"), ("-", "Deleted")], max_length=1), + ), + ( + "history_user", + models.ForeignKey( + null=True, + on_delete=django.db.models.deletion.SET_NULL, + related_name="+", + to=settings.AUTH_USER_MODEL, + ), + ), + ], + options={ + "verbose_name": "historical user agreement", + "verbose_name_plural": "historical user agreements", + "ordering": ("-history_date", "-history_id"), + "get_latest_by": ("history_date", "history_id"), + }, + bases=(simple_history.models.HistoricalChanges, models.Model), + ), + migrations.CreateModel( + name="UserAgreement", + fields=[ + ("id", models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name="ID")), + ("type", models.CharField(max_length=255, unique=True)), + ( + "name", + models.CharField( + help_text="Human-readable name for the agreement type. Will be displayed to users in an alert to accept/reject the agreement.", + max_length=255, + ), + ), + ( + "summary", + models.TextField( + help_text="Brief summary of the agreement content. Will be displayed to users in alert to accept the agreement.", + max_length=1024, + ), + ), + ( + "text", + models.TextField( + blank=True, help_text="Full text of the agreement. (Required if url is not provided)", null=True + ), + ), + ( + "url", + models.URLField( + blank=True, + help_text='URL where the full agreement can be accessed. Will be used for "Learn More" link in alert to accept the agreement.', + null=True, + ), + ), + ("created", models.DateTimeField(auto_now_add=True)), + ( + "updated", + models.DateTimeField( + help_text="Timestamp of the last update to this agreement. If changed users will be prompted to accept the agreement again." + ), + ), + ], + options={ + "constraints": [ + models.CheckConstraint( + condition=models.Q(("text__isnull", False), ("url__isnull", False), _connector="OR"), + name="agreement_has_text_or_url", + ) + ], + }, + ), + migrations.AddField( + model_name="useragreementrecord", + name="agreement", + field=models.ForeignKey( + null=True, + on_delete=django.db.models.deletion.CASCADE, + related_name="records", + to="agreements.useragreement", + ), + ), + ] diff --git a/openedx/core/djangoapps/agreements/migrations/0008_remove_useragreementrecord_agreement_type_and_more.py b/openedx/core/djangoapps/agreements/migrations/0008_remove_useragreementrecord_agreement_type_and_more.py new file mode 100644 index 000000000000..1bb68c8e51b2 --- /dev/null +++ b/openedx/core/djangoapps/agreements/migrations/0008_remove_useragreementrecord_agreement_type_and_more.py @@ -0,0 +1,40 @@ +# Generated by Django 5.2.10 on 2026-01-26 10:22 + +import django.db.models.deletion +from django.db import migrations, models + + +def migrate_agreement_type(apps, schema_editor): + UserAgreementRecord = apps.get_model("agreements", "UserAgreementRecord") + UserAgreement = apps.get_model("agreements", "UserAgreement") + for user_agreement_record in UserAgreementRecord.objects.all(): + user_agreement_record.agreement = UserAgreement.objects.get_or_create( + type=user_agreement_record.agreement_type, defaults=dict(text="") + ) + + +def migrate_agreement_type_rev(apps, schema_editor): + UserAgreementRecord = apps.get_model("agreements", "UserAgreementRecord") + for user_agreement_record in UserAgreementRecord.objects.all(): + user_agreement_record.agreement_type = user_agreement_record.agreement.type + + +class Migration(migrations.Migration): + dependencies = [ + ("agreements", "0007_historicaluseragreement_useragreement_and_more"), + ] + + operations = [ + migrations.RunPython(migrate_agreement_type, migrate_agreement_type_rev), + migrations.RemoveField( + model_name="useragreementrecord", + name="agreement_type", + ), + migrations.AlterField( + model_name="useragreementrecord", + name="agreement", + field=models.ForeignKey( + on_delete=django.db.models.deletion.CASCADE, related_name="records", to="agreements.useragreement" + ), + ), + ] diff --git a/openedx/core/djangoapps/agreements/models.py b/openedx/core/djangoapps/agreements/models.py index 2672a4f47b24..934e0d795236 100644 --- a/openedx/core/djangoapps/agreements/models.py +++ b/openedx/core/djangoapps/agreements/models.py @@ -6,6 +6,7 @@ from django.db import models from model_utils.models import TimeStampedModel from opaque_keys.edx.django.models import CourseKeyField +from simple_history.models import HistoricalRecords User = get_user_model() @@ -70,3 +71,82 @@ class ProctoringPIISignature(TimeStampedModel): class Meta: app_label = 'agreements' + + +class UserAgreement(models.Model): # noqa: DJ008 + """ + This model stores agreements that the user can accept, which can gate certain + platform features. + + .. no_pii: + """ + + type = models.CharField(max_length=255, unique=True) + name = models.CharField( + max_length=255, + help_text=( + "Human-readable name for the agreement type. " + "Will be displayed to users in an alert to accept/reject the agreement." + ), + ) + summary = models.TextField( + max_length=1024, + help_text=( + "Brief summary of the agreement content. Will be displayed to users in alert to accept the agreement." + ), + ) + text = models.TextField( # noqa: DJ001 + help_text="Full text of the agreement. (Required if url is not provided)", + null=True, + blank=True, + ) + url = models.URLField( # noqa: DJ001 + help_text=( + "URL where the full agreement can be accessed. " + 'Will be used for "Learn More" link in alert to accept the agreement.' + ), + null=True, + blank=True, + ) + created = models.DateTimeField(auto_now_add=True) + updated = models.DateTimeField( + help_text=( + "Timestamp of the last update to this agreement. " + "If changed users will be prompted to accept the agreement again." + ) + ) + history = HistoricalRecords() + + @property + def has_text(self): + return bool(self.text) + + class Meta: # noqa: DJ012 + app_label = "agreements" + constraints = [ + models.CheckConstraint( + check=models.Q(text__isnull=False) | models.Q(url__isnull=False), name="agreement_has_text_or_url" + ) + ] + + +class UserAgreementRecord(models.Model): # noqa: DJ008 + """ + This model stores the agreements a user has accepted or acknowledged. + + Each record here represents a user agreeing to the agreement type represented + by `agreement_type` at a particular time. + + .. no_pii: + """ + + user = models.ForeignKey(User, db_index=True, on_delete=models.CASCADE) + agreement = models.ForeignKey(UserAgreement, on_delete=models.CASCADE, related_name="records") + timestamp = models.DateTimeField(auto_now_add=True) + + @property + def is_current(self): + return self.agreement.updated < self.timestamp + + class Meta: # noqa: DJ012 + app_label = "agreements" diff --git a/openedx/core/djangoapps/agreements/serializers.py b/openedx/core/djangoapps/agreements/serializers.py index 397a9ba61d54..26614882902c 100644 --- a/openedx/core/djangoapps/agreements/serializers.py +++ b/openedx/core/djangoapps/agreements/serializers.py @@ -1,9 +1,10 @@ """ Serializers for the Agreements app """ + from rest_framework import serializers -from openedx.core.djangoapps.agreements.models import IntegritySignature, LTIPIISignature +from openedx.core.djangoapps.agreements.models import IntegritySignature, LTIPIISignature, UserAgreement from openedx.core.lib.api.serializers import CourseKeyField @@ -31,3 +32,25 @@ class LTIPIISignatureSerializer(serializers.ModelSerializer): class Meta: model = LTIPIISignature fields = ('username', 'course_id', 'lti_tools', 'created_at') + + +class UserAgreementSerializer(serializers.ModelSerializer): + """ + Serializer for UserAgreement model + """ + + class Meta: + model = UserAgreement + fields = ('type', 'name', 'summary', 'has_text', 'url', 'updated') + read_only_fields = ('type', 'name', 'summary', 'has_text', 'url', 'updated') + + +class UserAgreementRecordSerializer(serializers.Serializer): + """ + Serializer for UserAgreementRecordData + """ + + username = serializers.CharField(read_only=True) + agreement_type = serializers.CharField(read_only=True) + accepted_at = serializers.DateTimeField() + is_current = serializers.BooleanField(read_only=True) diff --git a/openedx/core/djangoapps/agreements/tests/test_api.py b/openedx/core/djangoapps/agreements/tests/test_api.py index c66065789939..96d800f5f01f 100644 --- a/openedx/core/djangoapps/agreements/tests/test_api.py +++ b/openedx/core/djangoapps/agreements/tests/test_api.py @@ -1,26 +1,30 @@ """ Tests for the Agreements API """ + import logging +from datetime import datetime, timedelta +from django.test import TestCase +from opaque_keys.edx.keys import CourseKey from testfixtures import LogCapture from common.djangoapps.student.tests.factories import UserFactory from openedx.core.djangoapps.agreements.api import ( create_integrity_signature, + create_lti_pii_signature, + create_user_agreement_record, get_integrity_signature, get_integrity_signatures_for_course, + get_latest_user_agreement_record, + get_lti_pii_signature, get_pii_receiving_lti_tools, - create_lti_pii_signature, - get_lti_pii_signature + get_user_agreement_records, ) +from openedx.core.djangoapps.agreements.models import LTIPIITool, UserAgreement from openedx.core.djangolib.testing.utils import skip_unless_lms -from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order -from ..models import ( - LTIPIITool, -) -from opaque_keys.edx.keys import CourseKey +from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase +from xmodule.modulestore.tests.factories import CourseFactory LOGGER_NAME = "openedx.core.djangoapps.agreements.api" @@ -57,7 +61,7 @@ def test_create_duplicate_integrity_signature(self): LOGGER_NAME, 'WARNING', ( - 'Integrity signature already exists for user_id={user_id} and ' + 'Integrity signature already exists for user_id={user_id} and ' # noqa: UP032 'course_id={course_id}'.format( user_id=self.user.id, course_id=str(self.course_id) ) @@ -77,7 +81,7 @@ def test_get_nonexistent_integrity_signature(self): Test that None is returned if an integrity signature does not exist """ signature = get_integrity_signature(self.user.username, self.course_id) - self.assertIsNone(signature) + self.assertIsNone(signature) # noqa: PT009 def test_get_integrity_signatures_for_course(self): """ @@ -88,23 +92,23 @@ def test_get_integrity_signatures_for_course(self): create_integrity_signature(second_user.username, self.course_id) signatures = get_integrity_signatures_for_course(self.course_id) self._assert_integrity_signature(signatures[0]) - self.assertEqual(signatures[1].user, second_user) - self.assertEqual(signatures[1].course_key, self.course.id) + self.assertEqual(signatures[1].user, second_user) # noqa: PT009 + self.assertEqual(signatures[1].course_key, self.course.id) # noqa: PT009 def test_get_integrity_signatures_for_course_empty(self): """ Test that a course with no integrity signatures returns an empty queryset """ signatures = get_integrity_signatures_for_course(self.course_id) - self.assertEqual(len(signatures), 0) + self.assertEqual(len(signatures), 0) # noqa: PT009 def _assert_integrity_signature(self, signature): """ Helper function to assert the returned integrity signature has the correct user and course key """ - self.assertEqual(signature.user, self.user) - self.assertEqual(signature.course_key, self.course.id) + self.assertEqual(signature.user, self.user) # noqa: PT009 + self.assertEqual(signature.course_key, self.course.id) # noqa: PT009 @skip_unless_lms @@ -145,15 +149,15 @@ def test_create_multiple_lti_pii_signature(self): s1 = get_lti_pii_signature(self.user.username, self.course_id) # retrieve the database entry create_lti_pii_signature(self.user.username, self.course_id, self.lti_tools_2) # signature with updated tools s2 = get_lti_pii_signature(self.user.username, self.course_id) # retrieve the updated database entry - self.assertNotEqual(s1, s2) # the signatue retrieved from the database should be the updated version + self.assertNotEqual(s1, s2) # the signatue retrieved from the database should be the updated version # noqa: PT009 # pylint: disable=line-too-long def _assert_lti_pii_signature(self, signature): """ Helper function to assert the returned lti pii signature has the correct user and course key """ - self.assertEqual(signature.user, self.user) - self.assertEqual(signature.course_key, self.course.id) + self.assertEqual(signature.user, self.user) # noqa: PT009 + self.assertEqual(signature.course_key, self.course.id) # noqa: PT009 @skip_unless_lms @@ -185,4 +189,57 @@ def _assert_ltitools(self, lti_list): """ Helper function to assert the returned list has the correct tools """ - self.assertEqual(self.lti_tools, lti_list) + self.assertEqual(self.lti_tools, lti_list) # noqa: PT009 + + +@skip_unless_lms +class UserAgreementsTests(TestCase): + """ + Tests for the python APIs related to user agreements. + """ + + def setUp(self): + self.user = UserFactory() + self.agreement = UserAgreement.objects.create( + type="test_type", + name="test agreement", + summary="test summary", + url="https://example.com", + text="test text", + updated=datetime.now(), + ) + + def test_get_user_agreements(self): + """ + Tests the functionality of retrieving user agreement records + """ + result = list(get_user_agreement_records(self.user)) + assert len(result) == 0 + + record = create_user_agreement_record(self.user, "test_type") + result = list(get_user_agreement_records(self.user)) + + assert len(result) == 1 + assert result[0].agreement_type == "test_type" + assert result[0].username == self.user.username + assert result[0].accepted_at == record.accepted_at + + def test_get_user_agreement_record(self): + """ + Tests the functionality of retrieving the latest user agreement record. + """ + record = create_user_agreement_record(self.user, "test_type") + result = get_latest_user_agreement_record(self.user, "test_type") + + assert result == record + + self.agreement.updated = datetime.now() + timedelta(days=1) + self.agreement.save() + + result = get_latest_user_agreement_record(self.user, "test_type") + + assert result.is_current is False + + def tearDown(self): + self.user.delete() + self.agreement.delete() diff --git a/openedx/core/djangoapps/agreements/tests/test_models.py b/openedx/core/djangoapps/agreements/tests/test_models.py new file mode 100644 index 000000000000..55fe2dad09f9 --- /dev/null +++ b/openedx/core/djangoapps/agreements/tests/test_models.py @@ -0,0 +1,86 @@ +""" +Tests for Agreements models +""" + +from datetime import datetime + +from django.db import IntegrityError +from django.test import TestCase + +from openedx.core.djangoapps.agreements.models import UserAgreement +from openedx.core.djangolib.testing.utils import skip_unless_lms + + +@skip_unless_lms +class UserAgreementModelTest(TestCase): + """ + Tests for the UserAgreement model. + """ + + def test_agreement_must_have_text_or_url(self): + """ + Verify that a UserAgreement must have at least a url or text. + """ + agreement = UserAgreement.objects.create( + type="type1", + name="Name 1", + summary="Summary 1", + text="Some text", + url="https://example.com", + updated=datetime.now(), + ) + assert agreement.pk is not None + + agreement = UserAgreement.objects.create( + type="type2", + name="Name 2", + summary="Summary 2", + text="Some text", + url=None, + updated=datetime.now(), + ) + assert agreement.pk is not None + + agreement = UserAgreement.objects.create( + type="type3", + name="Name 3", + summary="Summary 3", + text=None, + url="https://example.com", + updated=datetime.now(), + ) + assert agreement.pk is not None + + with self.assertRaises(IntegrityError): # noqa: PT027 + UserAgreement.objects.create( + type="type4", + name="Name 4", + summary="Summary 4", + text=None, + url=None, + updated=datetime.now(), + ) + + def test_agreement_with_empty_strings(self): + """ + Verify behavior with empty strings + """ + agreement = UserAgreement.objects.create( + type="type5", + name="Name 5", + summary="Summary 5", + text="", + url=None, + updated=datetime.now(), + ) + assert agreement.pk is not None + + agreement = UserAgreement.objects.create( + type="type6", + name="Name 6", + summary="Summary 6", + text=None, + url="", + updated=datetime.now(), + ) + assert agreement.pk is not None diff --git a/openedx/core/djangoapps/agreements/tests/test_views.py b/openedx/core/djangoapps/agreements/tests/test_views.py index 4c52e5853f05..95fa3c5dd64c 100644 --- a/openedx/core/djangoapps/agreements/tests/test_views.py +++ b/openedx/core/djangoapps/agreements/tests/test_views.py @@ -2,26 +2,28 @@ Tests for agreements views """ +import json from datetime import datetime, timedelta from unittest.mock import patch from django.conf import settings from django.urls import reverse -from rest_framework.test import APITestCase -from rest_framework import status from freezegun import freeze_time -import json +from rest_framework import status +from rest_framework.test import APITestCase -from common.djangoapps.student.tests.factories import UserFactory, AdminFactory from common.djangoapps.student.roles import CourseStaffRole +from common.djangoapps.student.tests.factories import AdminFactory, UserFactory from openedx.core.djangoapps.agreements.api import ( create_integrity_signature, + create_user_agreement_record, get_integrity_signatures_for_course, - get_lti_pii_signature + get_lti_pii_signature, ) +from openedx.core.djangoapps.agreements.models import UserAgreement from openedx.core.djangolib.testing.utils import skip_unless_lms -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase +from xmodule.modulestore.tests.factories import CourseFactory @skip_unless_lms @@ -100,7 +102,7 @@ def test_403_get_if_non_staff(self): 'integrity_signature', kwargs={'course_id': self.course_id}, ) - + '?username={}'.format(self.other_user.username) + + '?username={}'.format(self.other_user.username) # noqa: UP032 ) self._assert_response(response, status.HTTP_403_FORBIDDEN) @@ -118,7 +120,7 @@ def test_200_get_for_course_staff_request(self): 'integrity_signature', kwargs={'course_id': self.course_id}, ) - + '?username={}'.format(self.user.username) + + '?username={}'.format(self.user.username) # noqa: UP032 ) self._assert_response(response, status.HTTP_200_OK, self.user, self.course_id) @@ -138,7 +140,7 @@ def test_403_get_for_other_course_instructor(self): 'integrity_signature', kwargs={'course_id': self.course_id}, ) - + '?username={}'.format(self.user.username) + + '?username={}'.format(self.user.username) # noqa: UP032 ) self._assert_response(response, status.HTTP_403_FORBIDDEN) @@ -155,7 +157,7 @@ def test_200_get_for_admin(self): 'integrity_signature', kwargs={'course_id': self.course_id}, ) - + '?username={}'.format(self.user.username) + + '?username={}'.format(self.user.username) # noqa: UP032 ) self._assert_response(response, status.HTTP_200_OK, self.user, self.course_id) @@ -178,8 +180,8 @@ def test_post_integrity_signature(self): # Check that the course has a signature created signatures = get_integrity_signatures_for_course(self.course_id) - self.assertEqual(len(signatures), 1) - self.assertEqual(signatures[0].user.username, self.USERNAME) + self.assertEqual(len(signatures), 1) # noqa: PT009 + self.assertEqual(signatures[0].user.username, self.USERNAME) # noqa: PT009 def test_post_duplicate_integrity_signature(self): # Create a signature @@ -188,7 +190,7 @@ def test_post_duplicate_integrity_signature(self): 'integrity_signature', kwargs={'course_id': self.course_id}, ) - + '?username={}'.format(self.other_user.username) + + '?username={}'.format(self.other_user.username) # noqa: UP032 ) # Attempt to create a new signature in the future @@ -201,15 +203,15 @@ def test_post_duplicate_integrity_signature(self): ) # The created_at field in the response should equal the original time created - self.assertEqual( + self.assertEqual( # noqa: PT009 original_response.data['created_at'], new_response.data['created_at'], ) # The course should not have a second signature signatures = get_integrity_signatures_for_course(self.course_id) - self.assertEqual(len(signatures), 1) - self.assertEqual(signatures[0].user.username, self.USERNAME) + self.assertEqual(len(signatures), 1) # noqa: PT009 + self.assertEqual(signatures[0].user.username, self.USERNAME) # noqa: PT009 @patch.dict(settings.FEATURES, {'ENABLE_INTEGRITY_SIGNATURE': False}) def test_post_integrity_signature_no_waffle_flag(self): @@ -287,5 +289,84 @@ def test_post_lti_pii_signature(self): "lti_tools": self.lti_tools, "created_at": self.time_created}) self._assert_response(response, status.HTTP_200_OK, self.user, self.course_id) signature = get_lti_pii_signature(self.user.username, self.course_id) - self.assertEqual(signature.user.username, self.user.username) - self.assertEqual(signature.lti_tools, self.lti_tools) + self.assertEqual(signature.user.username, self.user.username) # noqa: PT009 + self.assertEqual(signature.lti_tools, self.lti_tools) # noqa: PT009 + + +@skip_unless_lms +class UserAgreementsViewTests(APITestCase): + """ + Tests for the UserAgreementsView + """ + + def setUp(self): + self.user = UserFactory(username="testuser", password="password") + self.agreement = UserAgreement.objects.create( + type="sample_agreement", + name="sample agreement", + summary="sample summary", + text="sample text", + updated="2024-11-21 11:00:00", + ) + self.url = reverse("user_agreement_record", kwargs={"agreement_type": "sample_agreement"}) + self.login() + + def login(self): + self.client.login(username="testuser", password="password") + + def test_get_user_agreement_record_for_missing_agreement(self): + """ + Tests that the view returns a non-acceptance record for a missing agreement + """ + response = self.client.get(reverse("user_agreement_record", kwargs={"agreement_type": "missing_agreement"})) + assert response.status_code == status.HTTP_200_OK + assert response.data["is_current"] is False + assert response.data["accepted_at"] is None + + def test_get_user_agreement_record_missing_record(self): + """ + Tests that the view returns a non-acceptance record for a missing user agreement record + """ + response = self.client.get(self.url) + assert response.status_code == status.HTTP_200_OK + assert response.data["is_current"] is False + assert response.data["accepted_at"] is None + + def test_get_user_agreement_record(self): + """ + Tests that the view returns a user agreement record for a valid agreement. + """ + create_user_agreement_record(self.user, "sample_agreement") + response = self.client.get(self.url) + assert response.status_code == status.HTTP_200_OK + assert "accepted_at" in response.data + + def test_post_user_agreement(self): + """ + Tests that the view creates a new user agreement record and returns it + and marks the agreement record as non-current if the agreement is newer + than the agreement record. + """ + with freeze_time("2024-11-21 12:00:00"): + response = self.client.post(self.url) + assert response.status_code == status.HTTP_201_CREATED + + self.login() + + response = self.client.get(self.url) + assert response.status_code == status.HTTP_200_OK + assert response.data["is_current"] is True + + self.agreement.updated = datetime.now() + self.agreement.save() + + response = self.client.get(self.url) + assert response.status_code == status.HTTP_200_OK + assert response.data["is_current"] is False + + response = self.client.post(self.url) + assert response.status_code == status.HTTP_201_CREATED + + response = self.client.get(self.url) + assert response.status_code == status.HTTP_200_OK + assert response.data["is_current"] is True diff --git a/openedx/core/djangoapps/agreements/toggles.py b/openedx/core/djangoapps/agreements/toggles.py index 6d71abdf6582..4e69b5fe4530 100644 --- a/openedx/core/djangoapps/agreements/toggles.py +++ b/openedx/core/djangoapps/agreements/toggles.py @@ -3,6 +3,7 @@ """ from opaque_keys.edx.keys import CourseKey + from openedx.core.djangoapps.waffle_utils import CourseWaffleFlag # .. toggle_name: agreements.enable_lti_pii_acknowledgement diff --git a/openedx/core/djangoapps/agreements/urls.py b/openedx/core/djangoapps/agreements/urls.py index d9d009d65ac1..36789a8c625d 100644 --- a/openedx/core/djangoapps/agreements/urls.py +++ b/openedx/core/djangoapps/agreements/urls.py @@ -3,15 +3,26 @@ """ from django.conf import settings -from django.urls import re_path +from django.urls import include, path, re_path +from rest_framework.routers import DefaultRouter -from .views import IntegritySignatureView, LTIPIISignatureView +from openedx.core.djangoapps.agreements.views import ( + IntegritySignatureView, + LTIPIISignatureView, + UserAgreementRecordsView, + UserAgreementsViewSet, +) + +router = DefaultRouter() +router.register(r"agreement", UserAgreementsViewSet, basename="user_agreements") urlpatterns = [ - re_path(r'^integrity_signature/{course_id}$'.format( + re_path(r'^integrity_signature/{course_id}$'.format( # noqa: UP032 course_id=settings.COURSE_ID_PATTERN ), IntegritySignatureView.as_view(), name='integrity_signature'), - re_path(r'^lti_pii_signature/{course_id}$'.format( + re_path(r'^lti_pii_signature/{course_id}$'.format( # noqa: UP032 course_id=settings.COURSE_ID_PATTERN ), LTIPIISignatureView.as_view(), name='lti_pii_signature'), + path('agreement_record/', UserAgreementRecordsView.as_view(), name='user_agreement_record'), + path('', include(router.urls)), ] diff --git a/openedx/core/djangoapps/agreements/views.py b/openedx/core/djangoapps/agreements/views.py index cc928669ffdd..6d61b4496737 100644 --- a/openedx/core/djangoapps/agreements/views.py +++ b/openedx/core/djangoapps/agreements/views.py @@ -2,21 +2,33 @@ Views served by the Agreements app """ +import edx_api_doc_tools as apidocs from django.conf import settings -from rest_framework import status -from rest_framework.views import APIView -from rest_framework.response import Response -from rest_framework.permissions import IsAuthenticated +from drf_yasg import openapi from opaque_keys.edx.keys import CourseKey +from rest_framework import status, viewsets +from rest_framework.decorators import action +from rest_framework.permissions import IsAuthenticated +from rest_framework.response import Response +from rest_framework.views import APIView from common.djangoapps.student import auth from common.djangoapps.student.roles import CourseStaffRole from openedx.core.djangoapps.agreements.api import ( create_integrity_signature, create_lti_pii_signature, + create_user_agreement_record, get_integrity_signature, + get_latest_user_agreement_record, ) -from openedx.core.djangoapps.agreements.serializers import IntegritySignatureSerializer, LTIPIISignatureSerializer +from openedx.core.djangoapps.agreements.models import UserAgreement +from openedx.core.djangoapps.agreements.serializers import ( + IntegritySignatureSerializer, + LTIPIISignatureSerializer, + UserAgreementRecordSerializer, + UserAgreementSerializer, +) +from openedx.core.lib.api.view_utils import view_auth_classes def is_user_course_or_global_staff(user, course_id): @@ -159,3 +171,141 @@ def post(self, request, course_id): else: statusStr = status.HTTP_500_INTERNAL_SERVER_ERROR return Response(data=serializer.data, status=statusStr) + + +@view_auth_classes(is_authenticated=True) +class UserAgreementRecordsView(APIView): + """ + Endpoint for the user agreement records API. + """ + + @apidocs.schema( + parameters=[ + apidocs.string_parameter( + "agreement_type", + apidocs.ParameterLocation.PATH, + description="Agreement ID/Type", + ), + ], + responses={ + 200: UserAgreementRecordSerializer, + 400: "Bad Request", + 404: "Not Found", + }, + ) + def get(self, request, agreement_type): + """ + Get a user's acknowledgement record for this agreement type. + """ + record = get_latest_user_agreement_record(request.user, agreement_type) + serializer = UserAgreementRecordSerializer(record) + return Response(serializer.data, status=status.HTTP_200_OK) + + @apidocs.schema( + parameters=[ + apidocs.string_parameter( + "agreement_type", + apidocs.ParameterLocation.PATH, + description="Agreement ID/Type", + ), + ], + responses={ + 200: UserAgreementRecordSerializer, + 400: "Bad Request", + }, + ) + def post(self, request, agreement_type): + """ + Marks a user's acknowledgement of this agreement type. + """ + record = create_user_agreement_record(request.user, agreement_type) + serializer = UserAgreementRecordSerializer(record) + return Response(serializer.data, status=status.HTTP_201_CREATED) + + +@view_auth_classes(is_authenticated=True) +class UserAgreementsViewSet(viewsets.GenericViewSet): + """ + Endpoint for the user agreements API. + """ + + queryset = UserAgreement.objects.all() + lookup_field = "type" + lookup_url_kwarg = "agreement_type" + + @apidocs.schema( + parameters=[ + apidocs.string_parameter( + "agreement_type", + apidocs.ParameterLocation.PATH, + description="Agreement ID/Type", + ), + ], + responses={ + 200: UserAgreementSerializer, + 400: "Bad Request", + 404: "Not Found", + }, + ) + def retrieve(self, request, agreement_type=None, **kwargs): + """ + Get the user agreement for this agreement type. + """ + try: + agreement = UserAgreement.objects.get(type=agreement_type) + except UserAgreement.DoesNotExist: + return Response(status=status.HTTP_404_NOT_FOUND) + serializer = UserAgreementSerializer(agreement) + return Response(serializer.data, status=status.HTTP_200_OK) + + @apidocs.schema( + parameters=[ + apidocs.string_parameter( + "agreement_type", + apidocs.ParameterLocation.PATH, + description="Agreement ID/Type", + ), + ], + responses={ + 200: UserAgreementSerializer, + 400: "Bad Request", + 404: "Not Found", + }, + ) + @action(methods=["get"], detail=True) + def text(self, request, agreement_type=None): + """ + Get the text of a user agreement by its type. + """ + try: + agreement = UserAgreement.objects.get(type=agreement_type) + except UserAgreement.DoesNotExist: + return Response(status=status.HTTP_404_NOT_FOUND) + return Response(agreement.text, status=status.HTTP_200_OK) + + @apidocs.schema( + parameters=[ + openapi.Parameter( + "agreement_type", + apidocs.ParameterLocation.QUERY, + required=False, + type=openapi.TYPE_ARRAY, + items=openapi.Items(type=openapi.TYPE_STRING), + description="Agreement ID/Type", + ), + ], + responses={ + 200: UserAgreementSerializer, + 400: "Bad Request", + }, + ) + def list(self, request): + """ + Get all user agreements for this agreement type. + """ + types = request.query_params.getlist("agreement_type", None) + agreements = UserAgreement.objects.all() + if types: + agreements = agreements.filter(type__in=types) + serializer = UserAgreementSerializer(agreements, many=True) + return Response(serializer.data, status=status.HTTP_200_OK) diff --git a/openedx/core/djangoapps/api_admin/api/urls.py b/openedx/core/djangoapps/api_admin/api/urls.py index 81bc98680513..35a0b1882775 100644 --- a/openedx/core/djangoapps/api_admin/api/urls.py +++ b/openedx/core/djangoapps/api_admin/api/urls.py @@ -3,8 +3,7 @@ """ -from django.urls import include -from django.urls import path +from django.urls import include, path app_name = 'api_admin' urlpatterns = [ diff --git a/openedx/core/djangoapps/api_admin/api/v1/tests/test_views.py b/openedx/core/djangoapps/api_admin/api/v1/tests/test_views.py index 922d470f5b76..ec88958a4e7d 100644 --- a/openedx/core/djangoapps/api_admin/api/v1/tests/test_views.py +++ b/openedx/core/djangoapps/api_admin/api/v1/tests/test_views.py @@ -4,14 +4,13 @@ import json -from rest_framework.reverse import reverse - -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.test import TestCase +from rest_framework.reverse import reverse +from common.djangoapps.student.tests.factories import UserFactory from openedx.core.djangoapps.api_admin.tests import factories from openedx.core.djangolib.testing.utils import skip_unless_lms -from common.djangoapps.student.tests.factories import UserFactory @skip_unless_lms @@ -21,7 +20,7 @@ class ApiAccessRequestViewTests(TestCase): """ password = 'test' - def setUp(self): # lint-amnesty, pylint: disable=super-method-not-called + def setUp(self): # pylint: disable=super-method-not-called """ Perform operations common to all test cases. """ diff --git a/openedx/core/djangoapps/api_admin/api/v1/urls.py b/openedx/core/djangoapps/api_admin/api/v1/urls.py index 37781d74465b..8c2f0564baeb 100644 --- a/openedx/core/djangoapps/api_admin/api/v1/urls.py +++ b/openedx/core/djangoapps/api_admin/api/v1/urls.py @@ -3,6 +3,7 @@ """ from django.urls import path + from openedx.core.djangoapps.api_admin.api.v1 import views app_name = 'v1' diff --git a/openedx/core/djangoapps/api_admin/api/v1/views.py b/openedx/core/djangoapps/api_admin/api/v1/views.py index 70addba4c292..e4f26b28fd28 100644 --- a/openedx/core/djangoapps/api_admin/api/v1/views.py +++ b/openedx/core/djangoapps/api_admin/api/v1/views.py @@ -3,16 +3,15 @@ """ from django_filters.rest_framework import DjangoFilterBackend - from edx_rest_framework_extensions.auth.jwt.authentication import JwtAuthentication from rest_framework.authentication import SessionAuthentication -from rest_framework.permissions import IsAuthenticated from rest_framework.generics import ListAPIView -from openedx.core.lib.api.authentication import BearerAuthentication +from rest_framework.permissions import IsAuthenticated +from openedx.core.djangoapps.api_admin.api.filters import IsOwnerOrStaffFilterBackend from openedx.core.djangoapps.api_admin.api.v1 import serializers as api_access_serializers from openedx.core.djangoapps.api_admin.models import ApiAccessRequest -from openedx.core.djangoapps.api_admin.api.filters import IsOwnerOrStaffFilterBackend +from openedx.core.lib.api.authentication import BearerAuthentication class ApiAccessRequestView(ListAPIView): diff --git a/openedx/core/djangoapps/api_admin/forms.py b/openedx/core/djangoapps/api_admin/forms.py index 3f1dc1de5dac..97a005c965bd 100644 --- a/openedx/core/djangoapps/api_admin/forms.py +++ b/openedx/core/djangoapps/api_admin/forms.py @@ -2,7 +2,7 @@ from django import forms -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.utils.translation import gettext as _ from openedx.core.djangoapps.api_admin.models import ApiAccessRequest, Catalog diff --git a/openedx/core/djangoapps/api_admin/management/commands/create_api_access_request.py b/openedx/core/djangoapps/api_admin/management/commands/create_api_access_request.py index 9c35a31afa8a..cb5627d6156c 100644 --- a/openedx/core/djangoapps/api_admin/management/commands/create_api_access_request.py +++ b/openedx/core/djangoapps/api_admin/management/commands/create_api_access_request.py @@ -4,7 +4,7 @@ import logging from contextlib import contextmanager -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.contrib.sites.models import Site from django.core.management.base import BaseCommand, CommandError from django.db.models.signals import post_save, pre_save @@ -13,7 +13,7 @@ ApiAccessConfig, ApiAccessRequest, send_decision_email, - send_request_email + send_request_email, ) logger = logging.getLogger(__name__) @@ -105,7 +105,7 @@ def get_user(self, username): try: return User.objects.get(username=username) except User.DoesNotExist: - raise CommandError(f'User {username} not found') # lint-amnesty, pylint: disable=raise-missing-from + raise CommandError(f'User {username} not found') # pylint: disable=raise-missing-from # noqa: B904 def create_api_access_request(self, user, status, reason, website): """ @@ -126,14 +126,14 @@ def create_api_access_request(self, user, status, reason, website): if 'Permission denied' in error_msg and 'mako_lms' in error_msg: logger.warning(f'Error sending email about access request: {error_msg}') else: - raise CommandError(error_msg) # lint-amnesty, pylint: disable=raise-missing-from + raise CommandError(error_msg) # pylint: disable=raise-missing-from # noqa: B904 except Exception as e: - msg = 'Unable to create ApiAccessRequest for {}. Exception is {}: {}'.format( + msg = 'Unable to create ApiAccessRequest for {}. Exception is {}: {}'.format( # noqa: UP032 user.username, type(e).__name__, e ) - raise CommandError(msg) # lint-amnesty, pylint: disable=raise-missing-from + raise CommandError(msg) # pylint: disable=raise-missing-from # noqa: B904 logger.info(f'Created ApiAccessRequest for user {user.username}') @@ -145,7 +145,7 @@ def create_api_access_config(self): _, created = ApiAccessConfig.objects.get_or_create(enabled=True) except Exception as e: msg = f'Unable to create ApiAccessConfig. Exception is {type(e).__name__}: {e}' - raise CommandError(msg) # lint-amnesty, pylint: disable=raise-missing-from + raise CommandError(msg) # pylint: disable=raise-missing-from # noqa: B904 if created: logger.info('Created ApiAccessConfig') diff --git a/openedx/core/djangoapps/api_admin/management/commands/tests/test_create_api_access_request.py b/openedx/core/djangoapps/api_admin/management/commands/tests/test_create_api_access_request.py index f633aec1305e..d20c8963b79b 100644 --- a/openedx/core/djangoapps/api_admin/management/commands/tests/test_create_api_access_request.py +++ b/openedx/core/djangoapps/api_admin/management/commands/tests/test_create_api_access_request.py @@ -7,9 +7,10 @@ from django.core.management import call_command from django.core.management.base import CommandError from django.test import TestCase + +from common.djangoapps.student.tests.factories import UserFactory from openedx.core.djangoapps.api_admin.models import ApiAccessConfig, ApiAccessRequest from openedx.core.djangolib.testing.utils import skip_unless_lms -from common.djangoapps.student.tests.factories import UserFactory @skip_unless_lms @@ -54,7 +55,7 @@ def test_config_already_exists(self): self.assert_models_exist(True, True) def test_user_not_found(self): - with self.assertRaisesRegex(CommandError, r'User .*? not found'): + with self.assertRaisesRegex(CommandError, r'User .*? not found'): # noqa: PT027 call_command(self.command, 'not-a-user-notfound-nope') @patch('openedx.core.djangoapps.api_admin.models.ApiAccessRequest.objects.create') @@ -63,7 +64,7 @@ def test_api_request_error(self, mocked_method): self.assert_models_exist(False, False) - with self.assertRaisesRegex(CommandError, r'Unable to create ApiAccessRequest .*'): + with self.assertRaisesRegex(CommandError, r'Unable to create ApiAccessRequest .*'): # noqa: PT027 call_command(self.command, self.user.username) self.assert_models_exist(False, False) @@ -91,7 +92,7 @@ def test_api_request_other_oserrors_raise(self, mocked_method): self.assert_models_exist(False, False) - with self.assertRaisesRegex(CommandError, 'out of disk space'): + with self.assertRaisesRegex(CommandError, 'out of disk space'): # noqa: PT027 call_command(self.command, self.user.username) self.assert_models_exist(False, False) @@ -101,7 +102,7 @@ def test_api_config_error(self, mocked_method): mocked_method.side_effect = Exception() self.assert_models_exist(False, False) - with self.assertRaisesRegex(CommandError, r'Unable to create ApiAccessConfig\. .*'): + with self.assertRaisesRegex(CommandError, r'Unable to create ApiAccessConfig\. .*'): # noqa: PT027 call_command(self.command, self.user.username, create_config=True) self.assert_models_exist(False, False) diff --git a/openedx/core/djangoapps/api_admin/models.py b/openedx/core/djangoapps/api_admin/models.py index 8d947cd4a7e3..15b174b709fb 100644 --- a/openedx/core/djangoapps/api_admin/models.py +++ b/openedx/core/djangoapps/api_admin/models.py @@ -7,7 +7,7 @@ from config_models.models import ConfigurationModel from django.conf import settings -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.contrib.sites.models import Site from django.core.mail import send_mail from django.db import models @@ -16,8 +16,6 @@ from django.urls import reverse from django.utils.translation import gettext as _u from django.utils.translation import gettext_lazy as _ - - from model_utils.models import TimeStampedModel from common.djangoapps.edxmako.shortcuts import render_to_string @@ -251,7 +249,7 @@ def __init__(self, *args, **kwargs): else: super().__init__(*args, **kwargs) - def save(self, **kwargs): # lint-amnesty, pylint: disable=arguments-differ, unused-argument + def save(self, **kwargs): # pylint: disable=arguments-differ, unused-argument return None @property @@ -264,5 +262,5 @@ def attributes(self): 'viewers': self.viewers, } - def __str__(self): + def __str__(self): # noqa: DJ012 return f'Catalog {self.name} [{self.query}]' diff --git a/openedx/core/djangoapps/api_admin/tests/factories.py b/openedx/core/djangoapps/api_admin/tests/factories.py index 4d369e5aaefe..f5ba84b0e803 100644 --- a/openedx/core/djangoapps/api_admin/tests/factories.py +++ b/openedx/core/djangoapps/api_admin/tests/factories.py @@ -6,9 +6,9 @@ from factory.fuzzy import FuzzyInteger, FuzzyText from oauth2_provider.models import get_application_model -from openedx.core.djangoapps.site_configuration.tests.factories import SiteFactory -from openedx.core.djangoapps.api_admin.models import ApiAccessRequest, Catalog from common.djangoapps.student.tests.factories import UserFactory +from openedx.core.djangoapps.api_admin.models import ApiAccessRequest, Catalog +from openedx.core.djangoapps.site_configuration.tests.factories import SiteFactory Application = get_application_model() # pylint: disable=invalid-name diff --git a/openedx/core/djangoapps/api_admin/tests/test_forms.py b/openedx/core/djangoapps/api_admin/tests/test_forms.py index ceacb23dc023..8ce4952f2cdb 100644 --- a/openedx/core/djangoapps/api_admin/tests/test_forms.py +++ b/openedx/core/djangoapps/api_admin/tests/test_forms.py @@ -34,7 +34,7 @@ def test_render_value(self): dummy_string_value = 'staff, verified' input_field_name = 'viewers' extra_formating = '' - expected_widget_html = ''.format( # lint-amnesty, pylint: disable=line-too-long + expected_widget_html = ''.format( # pylint: disable=line-too-long # noqa: UP032 input_field_name=input_field_name, serialized_value=dummy_string_value, extra_formating=extra_formating, diff --git a/openedx/core/djangoapps/api_admin/tests/test_models.py b/openedx/core/djangoapps/api_admin/tests/test_models.py index 05ca5b18463b..029f8a1f1b5b 100644 --- a/openedx/core/djangoapps/api_admin/tests/test_models.py +++ b/openedx/core/djangoapps/api_admin/tests/test_models.py @@ -4,17 +4,17 @@ from smtplib import SMTPException from unittest import mock -import pytest import ddt +import pytest from django.db import IntegrityError from django.test import TestCase +from common.djangoapps.student.tests.factories import UserFactory from openedx.core.djangoapps.api_admin.models import ApiAccessConfig, ApiAccessRequest from openedx.core.djangoapps.api_admin.models import log as model_log from openedx.core.djangoapps.api_admin.tests.factories import ApiAccessRequestFactory from openedx.core.djangoapps.site_configuration.tests.factories import SiteFactory from openedx.core.djangolib.testing.utils import skip_unless_lms -from common.djangoapps.student.tests.factories import UserFactory @ddt.ddt diff --git a/openedx/core/djangoapps/api_admin/tests/test_views.py b/openedx/core/djangoapps/api_admin/tests/test_views.py index 083286ea0e24..d30f12e17838 100644 --- a/openedx/core/djangoapps/api_admin/tests/test_views.py +++ b/openedx/core/djangoapps/api_admin/tests/test_views.py @@ -11,15 +11,15 @@ from django.urls import reverse from oauth2_provider.models import get_application_model +from common.djangoapps.student.tests.factories import UserFactory from openedx.core.djangoapps.api_admin.models import ApiAccessConfig, ApiAccessRequest from openedx.core.djangoapps.api_admin.tests.factories import ( ApiAccessRequestFactory, ApplicationFactory, - CatalogFactory + CatalogFactory, ) from openedx.core.djangoapps.api_admin.tests.utils import VALID_DATA from openedx.core.djangolib.testing.utils import skip_unless_lms -from common.djangoapps.student.tests.factories import UserFactory Application = get_application_model() # pylint: disable=invalid-name @@ -351,9 +351,9 @@ def test_delete(self): ) response = self.client.post(self.url, {'delete-catalog': 'on'}) self.assertRedirects(response, reverse('api_admin:catalog-search')) - assert httpretty.last_request().method == 'DELETE' # lint-amnesty, pylint: disable=no-member + assert httpretty.last_request().method == 'DELETE' # pylint: disable=no-member assert httpretty.last_request().path == \ - f'/api/v1/catalogs/{self.catalog.id}/' # lint-amnesty, pylint: disable=no-member + f'/api/v1/catalogs/{self.catalog.id}/' # pylint: disable=no-member assert len(httpretty.httpretty.latest_requests) == 1 @httpretty.activate diff --git a/openedx/core/djangoapps/api_admin/urls.py b/openedx/core/djangoapps/api_admin/urls.py index 73148b198a46..76ced9cb4e23 100644 --- a/openedx/core/djangoapps/api_admin/urls.py +++ b/openedx/core/djangoapps/api_admin/urls.py @@ -13,7 +13,7 @@ CatalogEditView, CatalogListView, CatalogPreviewView, - CatalogSearchView + CatalogSearchView, ) app_name = 'api_admin' diff --git a/openedx/core/djangoapps/api_admin/views.py b/openedx/core/djangoapps/api_admin/views.py index 9b7d24a76fac..fe35f2776d19 100644 --- a/openedx/core/djangoapps/api_admin/views.py +++ b/openedx/core/djangoapps/api_admin/views.py @@ -38,7 +38,7 @@ class ApiRequestView(CreateView): template_name = 'api_admin/api_access_request_form.html' success_url = reverse_lazy('api_admin:api-status') - def get(self, request): # lint-amnesty, pylint: disable=arguments-differ + def get(self, request): # pylint: disable=arguments-differ """ If the requesting user has already requested API access, redirect them to the client creation page. @@ -116,7 +116,7 @@ def form_invalid(self, form): return self.get(self.request, form) @require_api_access - def post(self, request): # lint-amnesty, pylint: disable=arguments-differ + def post(self, request): # pylint: disable=arguments-differ return super().post(request) diff --git a/openedx/core/djangoapps/auth_exchange/forms.py b/openedx/core/djangoapps/auth_exchange/forms.py index 0f5cacf07dd8..044efe7ffeaf 100644 --- a/openedx/core/djangoapps/auth_exchange/forms.py +++ b/openedx/core/djangoapps/auth_exchange/forms.py @@ -3,9 +3,9 @@ """ from django import forms -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user -from django.forms import CharField from django.conf import settings +from django.contrib.auth.models import User # pylint: disable=imported-auth-user +from django.forms import CharField from django.utils.encoding import smart_str from django.utils.translation import gettext as _ from oauth2_provider.models import Application @@ -164,7 +164,7 @@ def clean(self): try: client = self.oauth2_adapter.get_client(client_id=client_id) except Application.DoesNotExist: - raise OAuthValidationError( # lint-amnesty, pylint: disable=raise-missing-from + raise OAuthValidationError( # pylint: disable=raise-missing-from # noqa: B904 { "error": "invalid_client", "error_description": f"{client_id} is not a valid client_id", diff --git a/openedx/core/djangoapps/auth_exchange/tests/test_forms.py b/openedx/core/djangoapps/auth_exchange/tests/test_forms.py index 0facf82fd427..5682b6f8bb57 100644 --- a/openedx/core/djangoapps/auth_exchange/tests/test_forms.py +++ b/openedx/core/djangoapps/auth_exchange/tests/test_forms.py @@ -13,7 +13,10 @@ from django.test.client import RequestFactory from social_django.models import Partial -from common.djangoapps.third_party_auth.tests.utils import ThirdPartyOAuthTestMixinFacebook, ThirdPartyOAuthTestMixinGoogle # lint-amnesty, pylint: disable=line-too-long +from common.djangoapps.third_party_auth.tests.utils import ( # pylint: disable=line-too-long + ThirdPartyOAuthTestMixinFacebook, + ThirdPartyOAuthTestMixinGoogle, +) from ..forms import AccessTokenExchangeForm from .mixins import DOTAdapterMixin @@ -37,7 +40,7 @@ def tearDown(self): super().tearDown() Partial.objects.all().delete() - def _assert_error(self, data, expected_error, expected_error_description): # lint-amnesty, pylint: disable=arguments-differ + def _assert_error(self, data, expected_error, expected_error_description): # pylint: disable=arguments-differ form = AccessTokenExchangeForm(request=self.request, oauth2_adapter=self.oauth2_adapter, data=data) assert form.errors == {'error': expected_error, 'error_description': expected_error_description} @@ -62,7 +65,7 @@ class DOTAccessTokenExchangeFormTestFacebook( Tests for AccessTokenExchangeForm used with Facebook, tested against django-oauth-toolkit (DOT). """ - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass # This is necessary because cms does not implement third party auth @@ -78,4 +81,4 @@ class DOTAccessTokenExchangeFormTestGoogle( Tests for AccessTokenExchangeForm used with Google, tested against django-oauth-toolkit (DOT). """ - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass diff --git a/openedx/core/djangoapps/auth_exchange/tests/test_views.py b/openedx/core/djangoapps/auth_exchange/tests/test_views.py index f560c5effbb4..2c34b17681c8 100644 --- a/openedx/core/djangoapps/auth_exchange/tests/test_views.py +++ b/openedx/core/djangoapps/auth_exchange/tests/test_views.py @@ -6,8 +6,7 @@ import json import unittest -from datetime import timedelta -from datetime import datetime +from datetime import datetime, timedelta import ddt import httpretty @@ -19,14 +18,14 @@ from rest_framework.test import APIClient from social_django.models import Partial -from openedx.core.djangoapps.oauth_dispatch import jwt as jwt_api -from openedx.core.djangoapps.oauth_dispatch.adapters import DOTAdapter -from openedx.core.djangoapps.oauth_dispatch.tests import factories as dot_factories from common.djangoapps.student.tests.factories import UserFactory from common.djangoapps.third_party_auth.tests.utils import ( ThirdPartyOAuthTestMixinFacebook, ThirdPartyOAuthTestMixinGoogle, ) +from openedx.core.djangoapps.oauth_dispatch import jwt as jwt_api +from openedx.core.djangoapps.oauth_dispatch.adapters import DOTAdapter +from openedx.core.djangoapps.oauth_dispatch.tests import factories as dot_factories from openedx.core.djangolib.testing.utils import skip_unless_lms from .mixins import DOTAdapterMixin @@ -126,7 +125,7 @@ class DOTAccessTokenExchangeViewTestFacebook( """ Rerun AccessTokenExchangeViewTestFacebook tests against DOT backend """ - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass # This is necessary because cms does not implement third party auth @@ -142,7 +141,7 @@ class DOTAccessTokenExchangeViewTestGoogle( Tests for AccessTokenExchangeView used with Google using django-oauth-toolkit backend. """ - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass @skip_unless_lms @@ -157,7 +156,7 @@ def setUp(self): def _get_response(self, access_token, token_type='Bearer'): url = reverse("login_with_access_token") - return self.client.post(url, HTTP_AUTHORIZATION=f"{token_type} {access_token}".encode('utf-8')) + return self.client.post(url, HTTP_AUTHORIZATION=f"{token_type} {access_token}".encode('utf-8')) # noqa: UP012 def _verify_response(self, access_token, expected_status_code, token_type='Bearer', expected_cookie_name=None): """ @@ -240,7 +239,7 @@ def test_failure_with_valid_symmetric_jwt(self): 'error_code': 'non_asymmetric_token', 'developer_message': 'Only asymmetric jwt are supported.' } - self.assertDictEqual(error_msg, json.loads(response.content)) + self.assertDictEqual(error_msg, json.loads(response.content)) # noqa: PT009 assert '_auth_user_id' not in self.client.session assert response.status_code == 401 @@ -254,7 +253,7 @@ def test_failure_with_valid_asymmetric_jwt_and_disabled_user(self): 'error_code': 'account_disabled', 'developer_message': 'User account is disabled.' } - self.assertDictEqual(error_msg, json.loads(response.content)) + self.assertDictEqual(error_msg, json.loads(response.content)) # noqa: PT009 assert '_auth_user_id' not in self.client.session assert response.status_code == 401 diff --git a/openedx/core/djangoapps/auth_exchange/tests/utils.py b/openedx/core/djangoapps/auth_exchange/tests/utils.py index b45a44b704c8..e3f9722cacde 100644 --- a/openedx/core/djangoapps/auth_exchange/tests/utils.py +++ b/openedx/core/djangoapps/auth_exchange/tests/utils.py @@ -61,11 +61,11 @@ def test_missing_fields(self): for field in ["access_token", "client_id"]: data = dict(self.data) del data[field] - self._assert_error(data, "invalid_request", f"{field} is required") # lint-amnesty, pylint: disable=no-value-for-parameter + self._assert_error(data, "invalid_request", f"{field} is required") # pylint: disable=no-value-for-parameter def test_invalid_client(self): self.data["client_id"] = "nonexistent_client" - self._assert_error( # lint-amnesty, pylint: disable=no-value-for-parameter + self._assert_error( # pylint: disable=no-value-for-parameter self.data, "invalid_client", "nonexistent_client is not a valid client_id" @@ -74,7 +74,7 @@ def test_invalid_client(self): def test_confidential_client(self): self.data['client_id'] += '_confidential' self.oauth_client = self.create_confidential_client(self.user, self.data['client_id']) - self._assert_error( # lint-amnesty, pylint: disable=no-value-for-parameter + self._assert_error( # pylint: disable=no-value-for-parameter self.data, "invalid_client", f"{self.client_id}_confidential is not a public client", @@ -88,13 +88,13 @@ def test_inactive_user(self): def test_invalid_acess_token(self): self._setup_provider_response(success=False) - self._assert_error(self.data, "invalid_grant", "access_token is not valid") # lint-amnesty, pylint: disable=no-value-for-parameter + self._assert_error(self.data, "invalid_grant", "access_token is not valid") # pylint: disable=no-value-for-parameter def test_no_linked_user(self): UserSocialAuth.objects.all().delete() Partial.objects.all().delete() self._setup_provider_response(success=True) - self._assert_error(self.data, "invalid_grant", "access_token is not valid") # lint-amnesty, pylint: disable=no-value-for-parameter + self._assert_error(self.data, "invalid_grant", "access_token is not valid") # pylint: disable=no-value-for-parameter def test_user_automatically_linked_by_email(self): UserSocialAuth.objects.all().delete() @@ -108,4 +108,4 @@ def test_inactive_user_not_automatically_linked(self): self._setup_provider_response(success=True, email=self.user.email) self.user.is_active = False self.user.save() - self._assert_error(self.data, "invalid_grant", "access_token is not valid") # lint-amnesty, pylint: disable=no-value-for-parameter + self._assert_error(self.data, "invalid_grant", "access_token is not valid") # pylint: disable=no-value-for-parameter diff --git a/openedx/core/djangoapps/auth_exchange/views.py b/openedx/core/djangoapps/auth_exchange/views.py index 60470aeba520..145c8880a6b4 100644 --- a/openedx/core/djangoapps/auth_exchange/views.py +++ b/openedx/core/djangoapps/auth_exchange/views.py @@ -8,8 +8,8 @@ """ import logging -import jwt import django.contrib.auth as auth +import jwt import social_django.utils as social_utils from django.conf import settings from django.contrib.auth import login @@ -35,7 +35,6 @@ from openedx.core.djangoapps.safe_sessions.middleware import mark_user_change_as_expected from openedx.core.lib.api.authentication import BearerAuthenticationAllowInactiveUser - logger = logging.getLogger(__name__) @@ -60,7 +59,7 @@ def post(self, request, _backend): """ Handle POST requests to get a first-party access token. """ - form = AccessTokenExchangeForm(request=request, oauth2_adapter=self.oauth2_adapter, data=request.POST) # lint-amnesty, pylint: disable=no-member + form = AccessTokenExchangeForm(request=request, oauth2_adapter=self.oauth2_adapter, data=request.POST) # pylint: disable=no-member if not form.is_valid(): error_response = self.error_response(form.errors) # pylint: disable=no-member return error_response @@ -76,7 +75,7 @@ def exchange_access_token(self, request, user, scope, client): serialized access token response. """ edx_access_token = self.create_access_token(request, user, scope, client) - return self.access_token_response(edx_access_token) # lint-amnesty, pylint: disable=no-member + return self.access_token_response(edx_access_token) # pylint: disable=no-member def _get_invalid_request_response(self, description): return Response(status=400, data={ diff --git a/openedx/core/djangoapps/authz/README.rst b/openedx/core/djangoapps/authz/README.rst new file mode 100644 index 000000000000..a9f1112f2361 --- /dev/null +++ b/openedx/core/djangoapps/authz/README.rst @@ -0,0 +1,82 @@ +AuthZ Django Integration +######################## + +Overview +******** + +The ``openedx.core.djangoapps.authz`` app provides Django integrations for the +`openedx-authz` authorization framework within ``edx-platform``. + +The `openedx-authz` library implements a centralized authorization system based +on explicit permissions and policy evaluation. This Django app acts as a thin +integration layer between ``edx-platform`` and the external library, providing +utilities that make it easier to enforce authorization checks in Django views. + +Currently, the app provides a decorator used to enforce AuthZ permissions in +views. The app may also host additional Django-specific helpers and utilities +as the integration with the AuthZ framework evolves. + +Purpose +******* + +This app exists to: + +- Provide Django-specific integrations for the ``openedx-authz`` framework +- Offer reusable decorators for enforcing authorization checks in views +- Centralize AuthZ-related utilities used across LMS and Studio + +Keeping these integrations in a dedicated app avoids coupling authorization +logic with unrelated apps and provides a clear location for future extensions. + +Location in the Platform +************************ + +The app lives in ``openedx/core/djangoapps`` because the functionality it +provides is a **platform-level concern shared across LMS and Studio**, rather +than something specific to either service. + +Usage +***** + +The primary utility currently provided by this app is a decorator that enforces +authorization checks using the AuthZ framework. + +Example usage:: + + from openedx.core.djangoapps.authz.decorators import authz_permission_required + + + @authz_permission_required("course.read") + def my_view(request, course_key): + ... + +The decorator ensures that the requesting user has the required permission +before allowing the view to execute. + +Additional parameters may allow compatibility with legacy permission checks +during the transition to the new authorization framework. + +Contents +******** + +The app currently includes: + +- **Decorators** for enforcing AuthZ permissions in Django views +- **Constants** used by the AuthZ integration +- **Tests** validating decorator behavior + +Relationship with ``openedx-authz`` +*********************************** + +This app does not implement the authorization framework itself. Instead, it +provides Django-specific integrations that connect ``edx-platform`` with the +external ``openedx-authz`` library. + +Keeping these integrations in ``edx-platform`` ensures that the external +library remains framework-agnostic. + +References +********** + +- `openedx-authz repository `_ +- `openedx-authz documentation `_ diff --git a/xmodule/capa/__init__.py b/openedx/core/djangoapps/authz/__init__.py similarity index 100% rename from xmodule/capa/__init__.py rename to openedx/core/djangoapps/authz/__init__.py diff --git a/openedx/core/djangoapps/authz/apps.py b/openedx/core/djangoapps/authz/apps.py new file mode 100644 index 000000000000..3f247cc07f78 --- /dev/null +++ b/openedx/core/djangoapps/authz/apps.py @@ -0,0 +1,16 @@ +"""Django app configuration for authz app.""" + +from django.apps import AppConfig + + +class AuthzConfig(AppConfig): + """Django application configuration for the Open edX Authorization (AuthZ) app. + + This app provides a centralized location for integrations with the + openedx-authz library, including permission helpers, decorators, + and other utilities used to enforce RBAC-based authorization across + the platform.""" + + default_auto_field = 'django.db.models.BigAutoField' + name = 'openedx.core.djangoapps.authz' + verbose_name = "Open edX Authorization Framework" diff --git a/openedx/core/djangoapps/authz/constants.py b/openedx/core/djangoapps/authz/constants.py new file mode 100644 index 000000000000..272089c2169b --- /dev/null +++ b/openedx/core/djangoapps/authz/constants.py @@ -0,0 +1,16 @@ +"""Constants used by the Open edX Authorization (AuthZ) framework.""" + +from enum import Enum + +from common.djangoapps.student.auth import has_studio_read_access, has_studio_write_access + + +class LegacyAuthoringPermission(Enum): + READ = "read" + WRITE = "write" + + +LEGACY_PERMISSION_HANDLER_MAP = { + LegacyAuthoringPermission.READ: has_studio_read_access, + LegacyAuthoringPermission.WRITE: has_studio_write_access, +} diff --git a/openedx/core/djangoapps/authz/decorators.py b/openedx/core/djangoapps/authz/decorators.py new file mode 100644 index 000000000000..a25b9841fcac --- /dev/null +++ b/openedx/core/djangoapps/authz/decorators.py @@ -0,0 +1,119 @@ +"""Decorators for AuthZ-based permissions enforcement.""" +import logging +from collections.abc import Callable +from functools import wraps + +from django.contrib.auth.models import AbstractUser +from opaque_keys import InvalidKeyError +from opaque_keys.edx.keys import CourseKey, UsageKey +from openedx_authz import api as authz_api +from rest_framework import status + +from openedx.core import toggles as core_toggles +from openedx.core.djangoapps.authz.constants import LEGACY_PERMISSION_HANDLER_MAP, LegacyAuthoringPermission +from openedx.core.lib.api.view_utils import DeveloperErrorViewMixin + +log = logging.getLogger(__name__) + + +def authz_permission_required( + authz_permission: str, + legacy_permission: LegacyAuthoringPermission | None = None) -> Callable: + """ + Decorator enforcing course author permissions via AuthZ + with optional legacy fallback. + + This decorator checks if the requesting user has the specified AuthZ permission for the course. + If AuthZ is not enabled for the course, and a legacy_permission is provided, it falls back to checking + the legacy permission. + + Raises: + DeveloperErrorResponseException: If the user does not have the required permissions. + """ + + def decorator(view_func): + + @wraps(view_func) + def _wrapped_view(self, request, course_id, *args, **kwargs): + course_key = get_course_key(course_id) + + if not user_has_course_permission( + request.user, + authz_permission, + course_key, + legacy_permission + ): + raise DeveloperErrorViewMixin.api_error( + status_code=status.HTTP_403_FORBIDDEN, + developer_message="You do not have permission to perform this action.", + error_code="permission_denied", + ) + + return view_func(self, request, course_key, *args, **kwargs) + + return _wrapped_view + + return decorator + + +def user_has_course_permission( + user: AbstractUser, + authz_permission: str, + course_key: CourseKey, + legacy_permission: LegacyAuthoringPermission | None = None, +) -> bool: + """ + Checks if the user has the specified AuthZ permission for the course, + with optional fallback to legacy permissions. + """ + if core_toggles.enable_authz_course_authoring(course_key): + # If AuthZ is enabled for this course, check the permission via AuthZ only. + is_user_allowed = authz_api.is_user_allowed(user.username, authz_permission, str(course_key)) + log.info( + "AuthZ permission granted = {}".format(is_user_allowed), # noqa: UP032 + extra={ + "user_id": user.id, + "authz_permission": authz_permission, + "course_key": str(course_key), + }, + ) + return is_user_allowed + + # If AuthZ is not enabled for this course, fall back to legacy course author + # access check if legacy_permission is provided. + has_legacy_permission: Callable | None = LEGACY_PERMISSION_HANDLER_MAP.get(legacy_permission) + if legacy_permission and has_legacy_permission and has_legacy_permission(user, course_key): + log.info( + "AuthZ fallback used", + extra={ + "user_id": user.id, + "authz_permission": authz_permission, + "legacy_permission": legacy_permission, + "course_key": str(course_key), + }, + ) + return True + + log.info( + "AuthZ permission denied", + extra={ + "user_id": user.id, + "authz_permission": authz_permission, + "course_key": str(course_key), + }, + ) + return False + + +def get_course_key(course_id: str) -> CourseKey: + """ + Given a course_id string, attempts to parse it as a CourseKey. + If that fails, attempts to parse it as a UsageKey and extract the course key from it. + """ + try: + return CourseKey.from_string(course_id) + except InvalidKeyError: + # If the course_id doesn't match the COURSE_KEY_PATTERN, it might be a usage key. + # Attempt to parse it as such and extract the course key. + usage_key = UsageKey.from_string(course_id) + return usage_key.course_key diff --git a/openedx/core/djangoapps/authz/docs/decisions/0001-authz-django-integration-app.rst b/openedx/core/djangoapps/authz/docs/decisions/0001-authz-django-integration-app.rst new file mode 100644 index 000000000000..4dd1e49f4bc7 --- /dev/null +++ b/openedx/core/djangoapps/authz/docs/decisions/0001-authz-django-integration-app.rst @@ -0,0 +1,74 @@ +0001 AUTHZ DJANGO INTEGRATION APP +#################### + +Status +****** + +Accepted + +Context +******* + +This ADR defines where Django integrations for the openedx-authz framework should live within edx-platform. +The openedx-authz library introduces a new authorization framework for Open edX based on explicit permissions and a centralized policy engine. Integrating this framework into edx-platform requires several Django-specific utilities. +One of the first integrations is a view decorator used to enforce authorization checks using the new AuthZ framework. This decorator is expected to be reused across multiple views in LMS and Studio. +During implementation, the question arose of where these Django integrations should live. + +Some options considered were: + +- common/djangoapps/student/auth.py +- openedx/core/authz.py (a new python module) +- openedx/core/djangoapps/authz (a new Django app) + +The student app contains legacy authentication and authorization logic tied to student functionality. Adding new platform-level authorization integrations there would introduce cross-cutting concerns into an unrelated app. + +Another option was creating a single module such as openedx/core/authz.py. However, the integration already includes multiple components (decorators, constants, tests) and is expected to grow over time. + +Because of this, a dedicated Django app provides a clearer and more scalable structure for these integrations. + +Decision +******** + +edx-platform will introduce a new lightweight Django app openedx.core.djangoapps.authz to host Django integrations for the openedx-authz framework. + +- The app will contain reusable decorators enforcing AuthZ permissions in Django views. +- Supporting modules such as constants and helper utilities will live in this app. +- The app will include tests validating these integrations. +- The app acts as a thin integration layer between edx-platform and the external openedx-authz library. +- The app will live in openedx/core/djangoapps because this functionality is a platform-level concern shared by LMS and Studio. + +Initial contents include: + +- An authorization decorator for Django views. +- A constants.py module for AuthZ-related constants. +- Tests validating the decorator behavior. + +Consequences +************ + +- Django integrations for the AuthZ framework have a centralized and discoverable location. +- Future integrations can be added without expanding unrelated modules. +- The separation clarifies the distinction between authentication (authn) and authorization (authz) responsibilities. + +However: + +- Introducing a new Django app slightly increases project structure complexity. +- Some authorization logic may remain elsewhere until future refactoring occurs. + +Rejected Alternatives +********************** + +- Add the decorator to common/djangoapps/student/auth.py +Rejected because the module belongs to the student app and already mixes authentication and authorization responsibilities. + +- Create a single module openedx/core/authz.py +Rejected because the integration already includes multiple components and is expected to grow. + +- Implement the decorator in the openedx-authz library +Rejected because the decorator is Django-specific and tied to how edx-platform integrates authorization checks into views. + +References +********** + +.. _openedx-authz repository: https://github.com/openedx/openedx-authz +.. _openedx-authz documentation: https://openedx-authz.readthedocs.io/ diff --git a/xmodule/capa/safe_exec/tests/__init__.py b/openedx/core/djangoapps/authz/migrations/__init__.py similarity index 100% rename from xmodule/capa/safe_exec/tests/__init__.py rename to openedx/core/djangoapps/authz/migrations/__init__.py diff --git a/xmodule/capa/tests/__init__.py b/openedx/core/djangoapps/authz/tests/__init__.py similarity index 100% rename from xmodule/capa/tests/__init__.py rename to openedx/core/djangoapps/authz/tests/__init__.py diff --git a/openedx/core/djangoapps/authz/tests/mixins.py b/openedx/core/djangoapps/authz/tests/mixins.py new file mode 100644 index 000000000000..c6385115693f --- /dev/null +++ b/openedx/core/djangoapps/authz/tests/mixins.py @@ -0,0 +1,128 @@ +""" Mixins for testing course-scoped AuthZ endpoints. """ + +from unittest.mock import patch + +import casbin +import pkg_resources +from openedx_authz.api.users import assign_role_to_user_in_scope +from openedx_authz.constants.roles import COURSE_STAFF +from openedx_authz.engine.enforcer import AuthzEnforcer +from openedx_authz.engine.utils import migrate_policy_between_enforcers +from rest_framework.test import APIClient + +from common.djangoapps.student.tests.factories import UserFactory +from openedx.core import toggles as core_toggles + + +class CourseAuthoringAuthzTestMixin: + """ + Base mixin for testing AuthZ in the course authoring context. + + Responsibilities: + - Enable course authoring AuthZ feature flag + - Seed policies into the AuthZ enforcer + - Provide authenticated test clients + - Provide helpers for assigning roles within a course scope + """ + + @classmethod + def setUpClass(cls): + cls.toggle_patcher = patch.object( + core_toggles.AUTHZ_COURSE_AUTHORING_FLAG, + "is_enabled", + return_value=True, + ) + cls.toggle_patcher.start() + cls.password = 'test' + super().setUpClass() + + @classmethod + def tearDownClass(cls): + cls.toggle_patcher.stop() + super().tearDownClass() + + def setUp(self): + super().setUp() + + self._seed_policies() + + self.authorized_user = UserFactory(password=self.password) + self.unauthorized_user = UserFactory(password=self.password) + + self.authorized_client = APIClient() + self.authorized_client.force_authenticate(user=self.authorized_user) + + self.unauthorized_client = APIClient() + self.unauthorized_client.force_authenticate(user=self.unauthorized_user) + + self.super_user = UserFactory(is_superuser=True, password=self.password) + self.super_client = APIClient() + self.super_client.force_authenticate(user=self.super_user) + + self.staff_user = UserFactory(is_staff=True, password=self.password) + self.staff_client = APIClient() + self.staff_client.force_authenticate(user=self.staff_user) + + def tearDown(self): + super().tearDown() + AuthzEnforcer.get_enforcer().clear_policy() + + def add_user_to_role_in_course(self, user, role, course_key): + """Helper method to add a user to a role for the course.""" + assign_role_to_user_in_scope( + user.username, + role, + str(course_key) + ) + AuthzEnforcer.get_enforcer().load_policy() + + @classmethod + def _seed_policies(cls): + """Seed the database with AuthZ policies.""" + global_enforcer = AuthzEnforcer.get_enforcer() + global_enforcer.load_policy() + + model_path = pkg_resources.resource_filename( + "openedx_authz.engine", + "config/model.conf", + ) + + policy_path = pkg_resources.resource_filename( + "openedx_authz.engine", + "config/authz.policy", + ) + + migrate_policy_between_enforcers( + source_enforcer=casbin.Enforcer(model_path, policy_path), + target_enforcer=global_enforcer, + ) + + +class CourseAuthzTestMixin(CourseAuthoringAuthzTestMixin): + """ + Reusable mixin for testing course-scoped AuthZ endpoints. + """ + + authz_roles_to_assign = [COURSE_STAFF.external_key] + + @property + def course_key(self): + """ + Must be defined by subclasses. + """ + raise NotImplementedError("Tests using CourseAuthzTestMixin must define 'course_key'") + + def setUp(self): + super().setUp() + for role in self.authz_roles_to_assign: + assign_role_to_user_in_scope( + self.authorized_user.username, + role, + str(self.course_key) + ) + + AuthzEnforcer.get_enforcer().load_policy() + + def add_user_to_role(self, user, role): + """Helper method to add a user to a role for the course.""" + self.add_user_to_role_in_course(user, role, self.course_key) diff --git a/openedx/core/djangoapps/authz/tests/test_decorators.py b/openedx/core/djangoapps/authz/tests/test_decorators.py new file mode 100644 index 000000000000..9d9084b11612 --- /dev/null +++ b/openedx/core/djangoapps/authz/tests/test_decorators.py @@ -0,0 +1,156 @@ +"""Tests for authz decorators.""" +from unittest.mock import Mock, patch + +from django.test import RequestFactory, TestCase +from opaque_keys.edx.locator import BlockUsageLocator, CourseLocator + +from openedx.core.djangoapps.authz.constants import LegacyAuthoringPermission +from openedx.core.djangoapps.authz.decorators import authz_permission_required, get_course_key +from openedx.core.lib.api.view_utils import DeveloperErrorResponseException + + +class AuthzPermissionRequiredDecoratorTests(TestCase): + """ + Tests focused on the authz_permission_required decorator behavior. + """ + + def setUp(self): + self.factory = RequestFactory() + self.course_key = CourseLocator("TestX", "TST101", "2025") + + self.user = Mock() + self.user.username = "testuser" + self.user.id = 1 + + self.view_instance = Mock() + + def _build_request(self): + request = self.factory.get("/test") + request.user = self.user + return request + + def test_view_executes_when_permission_granted(self): + """Decorator allows execution when permission check passes.""" + request = self._build_request() + + mock_view = Mock(return_value="success") + + with patch( + "openedx.core.djangoapps.authz.decorators.user_has_course_permission", + return_value=True, + ): + decorated = authz_permission_required("courses.view")(mock_view) + + result = decorated(self.view_instance, request, str(self.course_key)) + + self.assertEqual(result, "success") # noqa: PT009 + mock_view.assert_called_once_with( + self.view_instance, + request, + self.course_key, + ) + + def test_view_executes_when_legacy_fallback_read(self): + """Decorator allows execution when AuthZ denies but legacy permission succeeds.""" + request = self._build_request() + + mock_view = Mock(return_value="success") + + with patch( + "openedx.core.djangoapps.authz.decorators.core_toggles.enable_authz_course_authoring", + return_value=False, + ), patch( + "openedx.core.djangoapps.authz.decorators.authz_api.is_user_allowed", + return_value=True, # Should not be used when AuthZ is disabled, but set to True just in case + ), patch( + "openedx.core.djangoapps.authz.constants.has_studio_read_access", + return_value=True, + ): + decorated = authz_permission_required( + "courses.view", + legacy_permission=LegacyAuthoringPermission.READ + )(mock_view) + + result = decorated(self.view_instance, request, str(self.course_key)) + + self.assertEqual(result, "success") # noqa: PT009 + mock_view.assert_called_once() + + def test_view_executes_when_legacy_fallback_write(self): + """Decorator allows execution when AuthZ denies but legacy write permission succeeds.""" + request = self._build_request() + + mock_view = Mock(return_value="success") + + with patch( + "openedx.core.djangoapps.authz.decorators.core_toggles.enable_authz_course_authoring", + return_value=False, + ), patch( + "openedx.core.djangoapps.authz.decorators.authz_api.is_user_allowed", + return_value=True, # Should not be used when AuthZ is disabled, but set to True just in case + ), patch( + "openedx.core.djangoapps.authz.constants.has_studio_write_access", + return_value=True, + ): + decorated = authz_permission_required( + "courses.edit", + legacy_permission=LegacyAuthoringPermission.WRITE + )(mock_view) + + result = decorated(self.view_instance, request, str(self.course_key)) + + self.assertEqual(result, "success") # noqa: PT009 + mock_view.assert_called_once() + + def test_access_denied_when_permission_fails(self): + """Decorator raises API error when permission fails.""" + request = self._build_request() + + mock_view = Mock() + + with patch( + "openedx.core.djangoapps.authz.decorators.user_has_course_permission", + return_value=False, + ): + decorated = authz_permission_required("courses.view")(mock_view) + + with self.assertRaises(DeveloperErrorResponseException) as context: # noqa: PT027 + decorated(self.view_instance, request, str(self.course_key)) + + self.assertEqual(context.exception.response.status_code, 403) # noqa: PT009 + mock_view.assert_not_called() + + def test_decorator_preserves_function_name(self): + """Decorator preserves wrapped function metadata.""" + + def sample_view(self, request, course_key): + return "ok" + + decorated = authz_permission_required("courses.view")(sample_view) + + self.assertEqual(decorated.__name__, "sample_view") # noqa: PT009 + + +class GetCourseKeyTests(TestCase): + """Tests for the get_course_key function used in the authz decorators.""" + + def setUp(self): + self.course_key = CourseLocator("TestX", "TST101", "2025") + + def test_course_key_string(self): + """Valid course key string returns CourseKey.""" + result = get_course_key(str(self.course_key)) + + self.assertEqual(result, self.course_key) # noqa: PT009 + + def test_usage_key_string(self): + """UsageKey string resolves to course key.""" + usage_key = BlockUsageLocator( + self.course_key, + "html", + "block1" + ) + + result = get_course_key(str(usage_key)) + + self.assertEqual(result, self.course_key) # noqa: PT009 diff --git a/openedx/core/djangoapps/bookmarks/__init__.py b/openedx/core/djangoapps/bookmarks/__init__.py index 32c18231afba..c766cd1e4acb 100644 --- a/openedx/core/djangoapps/bookmarks/__init__.py +++ b/openedx/core/djangoapps/bookmarks/__init__.py @@ -1,6 +1,6 @@ """ -# lint-amnesty, pylint: disable=django-not-configured -# lint-amnesty, pylint: disable=django-not-configured +# pylint: disable=django-not-configured +# pylint: disable=django-not-configured Bookmarks module. """ diff --git a/openedx/core/djangoapps/bookmarks/api.py b/openedx/core/djangoapps/bookmarks/api.py index 7a65b0711f82..19ccad082c09 100644 --- a/openedx/core/djangoapps/bookmarks/api.py +++ b/openedx/core/djangoapps/bookmarks/api.py @@ -4,12 +4,12 @@ # pylint: disable=unused-import from .api_impl import ( - BookmarksLimitReachedError, - get_bookmark, - get_bookmarks, - can_create_more, - create_bookmark, - delete_bookmark, - delete_bookmarks, + BookmarksLimitReachedError, # noqa: F401 + can_create_more, # noqa: F401 + create_bookmark, # noqa: F401 + delete_bookmark, # noqa: F401 + delete_bookmarks, # noqa: F401 + get_bookmark, # noqa: F401 + get_bookmarks, # noqa: F401 ) -from .services import BookmarksService +from .services import BookmarksService # noqa: F401 diff --git a/openedx/core/djangoapps/bookmarks/api_impl.py b/openedx/core/djangoapps/bookmarks/api_impl.py index 01559f64e51f..6b23b7297139 100644 --- a/openedx/core/djangoapps/bookmarks/api_impl.py +++ b/openedx/core/djangoapps/bookmarks/api_impl.py @@ -27,7 +27,7 @@ class BookmarksLimitReachedError(Exception): """ if try to create new bookmark when max limit of bookmarks already reached """ - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass def get_bookmark(user, usage_key, fields=None): diff --git a/openedx/core/djangoapps/bookmarks/apps.py b/openedx/core/djangoapps/bookmarks/apps.py index 61ff98f6dc60..f09823b52196 100644 --- a/openedx/core/djangoapps/bookmarks/apps.py +++ b/openedx/core/djangoapps/bookmarks/apps.py @@ -35,4 +35,4 @@ class BookmarksConfig(AppConfig): def ready(self): # Register the signals handled by bookmarks. - from . import signals # lint-amnesty, pylint: disable=unused-import + from . import signals # pylint: disable=unused-import # noqa: F401 diff --git a/openedx/core/djangoapps/bookmarks/migrations/0001_initial.py b/openedx/core/djangoapps/bookmarks/migrations/0001_initial.py index 8a4849f84c80..2d45f38a42a6 100644 --- a/openedx/core/djangoapps/bookmarks/migrations/0001_initial.py +++ b/openedx/core/djangoapps/bookmarks/migrations/0001_initial.py @@ -1,8 +1,8 @@ -from django.db import migrations, models -import model_utils.fields -import jsonfield.fields import django.utils.timezone +import jsonfield.fields +import model_utils.fields from django.conf import settings +from django.db import migrations, models from opaque_keys.edx.django.models import CourseKeyField, UsageKeyField diff --git a/openedx/core/djangoapps/bookmarks/models.py b/openedx/core/djangoapps/bookmarks/models.py index 3236a6494870..e83902c1a13f 100644 --- a/openedx/core/djangoapps/bookmarks/models.py +++ b/openedx/core/djangoapps/bookmarks/models.py @@ -5,9 +5,8 @@ import logging -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.db import models - from jsonfield.fields import JSONField from model_utils.models import TimeStampedModel from opaque_keys.edx.django.models import CourseKeyField, UsageKeyField diff --git a/openedx/core/djangoapps/bookmarks/serializers.py b/openedx/core/djangoapps/bookmarks/serializers.py index 67ca301b675a..56d5b7e01770 100644 --- a/openedx/core/djangoapps/bookmarks/serializers.py +++ b/openedx/core/djangoapps/bookmarks/serializers.py @@ -8,7 +8,6 @@ from openedx.core.lib.api.serializers import CourseKeyField, UsageKeyField - from . import DEFAULT_FIELDS, OPTIONAL_FIELDS from .models import Bookmark diff --git a/openedx/core/djangoapps/bookmarks/services.py b/openedx/core/djangoapps/bookmarks/services.py index 2e2e25b01bf8..2e21e8759614 100644 --- a/openedx/core/djangoapps/bookmarks/services.py +++ b/openedx/core/djangoapps/bookmarks/services.py @@ -11,7 +11,8 @@ from xmodule.modulestore.django import modulestore from xmodule.modulestore.exceptions import ItemNotFoundError -from . import DEFAULT_FIELDS, api_impl as api +from . import DEFAULT_FIELDS +from . import api_impl as api log = logging.getLogger(__name__) diff --git a/openedx/core/djangoapps/bookmarks/settings/common.py b/openedx/core/djangoapps/bookmarks/settings/common.py index e350eea25689..6d783f78ae8b 100644 --- a/openedx/core/djangoapps/bookmarks/settings/common.py +++ b/openedx/core/djangoapps/bookmarks/settings/common.py @@ -1,4 +1,4 @@ -# lint-amnesty, pylint: disable=missing-module-docstring +# pylint: disable=missing-module-docstring def plugin_settings(settings): # Course Content Bookmarks Settings settings.MAX_BOOKMARKS_PER_COURSE = 100 diff --git a/openedx/core/djangoapps/bookmarks/tasks.py b/openedx/core/djangoapps/bookmarks/tasks.py index 836335c1289c..a35affb05180 100644 --- a/openedx/core/djangoapps/bookmarks/tasks.py +++ b/openedx/core/djangoapps/bookmarks/tasks.py @@ -87,11 +87,11 @@ def paths_equal(paths_1, paths_2): if len(paths_1) != len(paths_2): return False - for path_1, path_2 in zip(paths_1, paths_2): + for path_1, path_2 in zip(paths_1, paths_2): # noqa: B905 if len(path_1) != len(path_2): return False - for path_item_1, path_item_2 in zip(path_1, path_2): + for path_item_1, path_item_2 in zip(path_1, path_2): # noqa: B905 if path_item_1.display_name != path_item_2.display_name: return False diff --git a/openedx/core/djangoapps/bookmarks/tests/test_api.py b/openedx/core/djangoapps/bookmarks/tests/test_api.py index 0f5a3405bc43..dd7f7fb66be9 100644 --- a/openedx/core/djangoapps/bookmarks/tests/test_api.py +++ b/openedx/core/djangoapps/bookmarks/tests/test_api.py @@ -3,15 +3,15 @@ """ from unittest.mock import Mock, patch -import pytest import ddt +import pytest from django.conf import settings from django.core.exceptions import ObjectDoesNotExist from opaque_keys.edx.keys import UsageKey from openedx.core.djangoapps.bookmarks.api import BookmarksLimitReachedError from openedx.core.djangolib.testing.utils import skip_unless_lms -from xmodule.modulestore.exceptions import ItemNotFoundError # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.exceptions import ItemNotFoundError # pylint: disable=wrong-import-order from .. import api from ..models import Bookmark diff --git a/openedx/core/djangoapps/bookmarks/tests/test_models.py b/openedx/core/djangoapps/bookmarks/tests/test_models.py index 57a7234bccf8..c40154571fae 100644 --- a/openedx/core/djangoapps/bookmarks/tests/test_models.py +++ b/openedx/core/djangoapps/bookmarks/tests/test_models.py @@ -12,13 +12,13 @@ from freezegun import freeze_time from opaque_keys.edx.keys import UsageKey from opaque_keys.edx.locator import BlockUsageLocator, CourseLocator + +from common.djangoapps.student.tests.factories import AdminFactory, UserFactory +from openedx.core.djangolib.testing.utils import skip_unless_lms from xmodule.modulestore import ModuleStoreEnum from xmodule.modulestore.django import modulestore from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase -from xmodule.modulestore.tests.factories import CourseFactory, BlockFactory, check_mongo_calls - -from openedx.core.djangolib.testing.utils import skip_unless_lms -from common.djangoapps.student.tests.factories import AdminFactory, UserFactory +from xmodule.modulestore.tests.factories import BlockFactory, CourseFactory, check_mongo_calls from .. import DEFAULT_FIELDS, OPTIONAL_FIELDS, PathItem from ..models import Bookmark, XBlockCache, parse_path_data diff --git a/openedx/core/djangoapps/bookmarks/tests/test_views.py b/openedx/core/djangoapps/bookmarks/tests/test_views.py index 592ae4d7b689..4816ddb26ea8 100644 --- a/openedx/core/djangoapps/bookmarks/tests/test_views.py +++ b/openedx/core/djangoapps/bookmarks/tests/test_views.py @@ -4,16 +4,16 @@ import json -from urllib.parse import quote from unittest.mock import patch +from urllib.parse import quote import ddt from django.conf import settings from django.urls import reverse from rest_framework.test import APIClient -from xmodule.modulestore.tests.django_utils import TEST_DATA_SPLIT_MODULESTORE from openedx.core.djangolib.testing.utils import skip_unless_lms +from xmodule.modulestore.tests.django_utils import TEST_DATA_SPLIT_MODULESTORE from .test_api import BookmarkApiEventTestMixin from .test_models import BookmarksTestsBase @@ -91,7 +91,7 @@ def test_get_bookmarks_successfully(self, bookmarks_count, check_all_fields, moc course, __, bookmarks = self.create_course_with_bookmarks_count(bookmarks_count) - query_parameters = 'course_id={}&page_size={}'.format( + query_parameters = 'course_id={}&page_size={}'.format( # noqa: UP032 quote(str(course.id)), 100) if check_all_fields: query_parameters += '&fields=path,display_name' @@ -133,7 +133,7 @@ def test_get_bookmarks_with_pagination(self, bookmarks_count, mock_tracker): course, __, bookmarks = self.create_course_with_bookmarks_count(bookmarks_count) page_size = 5 - query_parameters = 'course_id={}&page_size={}'.format( + query_parameters = 'course_id={}&page_size={}'.format( # noqa: UP032 quote(str(course.id)), page_size) response = self.send_get( @@ -308,10 +308,10 @@ def test_post_bookmark_when_max_bookmarks_already_exist(self): ) assert response.data['user_message'] == 'You can create up to {} bookmarks.' \ ' You must remove some bookmarks before you can add new ones.'\ - .format(max_bookmarks) + .format(max_bookmarks) # noqa: UP032 assert response.data['developer_message'] == 'You can create up to {} bookmarks.' \ ' You must remove some bookmarks before you can add new ones.'\ - .format(max_bookmarks) + .format(max_bookmarks) # noqa: UP032 def test_unsupported_methods(self): """ diff --git a/openedx/core/djangoapps/bookmarks/urls.py b/openedx/core/djangoapps/bookmarks/urls.py index 9e9d3580fd1d..07af3e22e97c 100644 --- a/openedx/core/djangoapps/bookmarks/urls.py +++ b/openedx/core/djangoapps/bookmarks/urls.py @@ -13,7 +13,7 @@ name='bookmarks' ), re_path( - r'^v1/bookmarks/{username},{usage_key}/$'.format( + r'^v1/bookmarks/{username},{usage_key}/$'.format( # noqa: UP032 username=settings.USERNAME_PATTERN, usage_key=settings.USAGE_ID_PATTERN ), diff --git a/openedx/core/djangoapps/bookmarks/views.py b/openedx/core/djangoapps/bookmarks/views.py index f8ab37963e60..3fd25ae06fbd 100644 --- a/openedx/core/djangoapps/bookmarks/views.py +++ b/openedx/core/djangoapps/bookmarks/views.py @@ -8,12 +8,12 @@ import logging +import edx_api_doc_tools as apidocs import eventtracking from django.conf import settings from django.core.exceptions import ObjectDoesNotExist from django.utils.translation import gettext as _ from django.utils.translation import gettext_noop -import edx_api_doc_tools as apidocs from edx_rest_framework_extensions.paginators import DefaultPagination from opaque_keys import InvalidKeyError from opaque_keys.edx.keys import CourseKey, UsageKey @@ -23,11 +23,11 @@ from rest_framework.response import Response from rest_framework.views import APIView -from openedx.core.lib.api.authentication import BearerAuthentication from openedx.core.djangoapps.bookmarks.api import BookmarksLimitReachedError +from openedx.core.lib.api.authentication import BearerAuthentication from openedx.core.lib.api.permissions import IsUserInUrl from openedx.core.lib.url_utils import unquote_slashes -from xmodule.modulestore.exceptions import ItemNotFoundError # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.exceptions import ItemNotFoundError # pylint: disable=wrong-import-order from . import DEFAULT_FIELDS, OPTIONAL_FIELDS, api from .serializers import BookmarkSerializer @@ -91,7 +91,7 @@ def error_response(self, developer_message, user_message=None, error_status=stat return Response( { "developer_message": developer_message, - "user_message": _(user_message) # lint-amnesty, pylint: disable=translation-of-non-string + "user_message": _(user_message) # pylint: disable=translation-of-non-string }, status=error_status ) @@ -202,7 +202,7 @@ def paginate_queryset(self, queryset): return page @apidocs.schema() - def post(self, request, *unused_args, **unused_kwargs): # lint-amnesty, pylint: disable=unused-argument + def post(self, request, *unused_args, **unused_kwargs): # pylint: disable=unused-argument """Create a new bookmark for a user. The POST request only needs to contain one parameter "usage_id". @@ -312,7 +312,7 @@ def get_usage_key_or_error_response(self, usage_id): return self.error_response(error_message, error_status=status.HTTP_404_NOT_FOUND) @apidocs.schema() - def get(self, request, username=None, usage_id=None): # lint-amnesty, pylint: disable=unused-argument + def get(self, request, username=None, usage_id=None): # pylint: disable=unused-argument """ Get a specific bookmark for a user. diff --git a/openedx/core/djangoapps/cache_toolbox/__init__.py b/openedx/core/djangoapps/cache_toolbox/__init__.py index f41654ad433f..cb2cdbc3a851 100644 --- a/openedx/core/djangoapps/cache_toolbox/__init__.py +++ b/openedx/core/djangoapps/cache_toolbox/__init__.py @@ -25,4 +25,4 @@ https://github.com/playfire/django-cache-toolbox/issues """ -from .model import cache_model +from .model import cache_model # noqa: F401 diff --git a/openedx/core/djangoapps/cache_toolbox/core.py b/openedx/core/djangoapps/cache_toolbox/core.py index 7fa082ef09a7..c894cad58b0b 100644 --- a/openedx/core/djangoapps/cache_toolbox/core.py +++ b/openedx/core/djangoapps/cache_toolbox/core.py @@ -97,7 +97,7 @@ def instance_key(model, instance_or_pk): """ Returns the cache key for this (model, instance) pair. """ - return '%s.%s:%d' % ( + return '%s.%s:%d' % ( # noqa: UP031 model._meta.app_label, model._meta.model_name, getattr(instance_or_pk, 'pk', instance_or_pk), diff --git a/openedx/core/djangoapps/cache_toolbox/middleware.py b/openedx/core/djangoapps/cache_toolbox/middleware.py index b980ba255a41..106f875b96a4 100644 --- a/openedx/core/djangoapps/cache_toolbox/middleware.py +++ b/openedx/core/djangoapps/cache_toolbox/middleware.py @@ -92,7 +92,7 @@ from django.conf import settings from django.contrib.auth import HASH_SESSION_KEY from django.contrib.auth.middleware import AuthenticationMiddleware -from django.contrib.auth.models import AnonymousUser, User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import AnonymousUser, User # pylint: disable=imported-auth-user from django.utils.crypto import constant_time_compare from django.utils.deprecation import MiddlewareMixin from edx_django_utils.monitoring import set_custom_attribute @@ -116,7 +116,7 @@ def process_request(self, request): try: # Try and construct a User instance from data stored in the cache session_user_id = SafeSessionMiddleware.get_user_id_from_session(request) - request.user = User.get_cached(session_user_id) # lint-amnesty, pylint: disable=no-member + request.user = User.get_cached(session_user_id) # pylint: disable=no-member if request.user.id != session_user_id: log.error( "CacheBackedAuthenticationMiddleware cached user '%s' does not match requested user '%s'.", diff --git a/openedx/core/djangoapps/cache_toolbox/templatetags/cache_toolbox.py b/openedx/core/djangoapps/cache_toolbox/templatetags/cache_toolbox.py index 0b3a81f5bdd5..2839915ccd9f 100644 --- a/openedx/core/djangoapps/cache_toolbox/templatetags/cache_toolbox.py +++ b/openedx/core/djangoapps/cache_toolbox/templatetags/cache_toolbox.py @@ -6,8 +6,12 @@ from django import template from django.core.cache import cache -from django.template import Node, TemplateSyntaxError, Variable -from django.template import resolve_variable # lint-amnesty, pylint: disable=no-name-in-module +from django.template import ( + Node, + TemplateSyntaxError, + Variable, + resolve_variable, # pylint: disable=no-name-in-module +) register = template.Library() # pylint: disable=invalid-name @@ -52,7 +56,7 @@ def cachedeterministic(parser, token): parser.delete_first_token() tokens = token.contents.split() if len(tokens) != 3: - raise TemplateSyntaxError("'%r' tag requires 2 arguments." % tokens[0]) + raise TemplateSyntaxError("'%r' tag requires 2 arguments." % tokens[0]) # noqa: UP031 return CacheNode(nodelist, tokens[1], tokens[2]) @@ -85,5 +89,5 @@ def showifcached(parser, token): # pylint: disable=unused-argument """ tokens = token.contents.split() if len(tokens) != 2: - raise TemplateSyntaxError("'%r' tag requires 1 argument." % tokens[0]) + raise TemplateSyntaxError("'%r' tag requires 1 argument." % tokens[0]) # noqa: UP031 return ShowIfCachedNode(tokens[1]) diff --git a/openedx/core/djangoapps/cache_toolbox/tests/test_middleware.py b/openedx/core/djangoapps/cache_toolbox/tests/test_middleware.py index bd5e0bc7c25a..e3efcfaa2913 100644 --- a/openedx/core/djangoapps/cache_toolbox/tests/test_middleware.py +++ b/openedx/core/djangoapps/cache_toolbox/tests/test_middleware.py @@ -3,7 +3,7 @@ from django.conf import settings from django.contrib.auth import SESSION_KEY -from django.contrib.auth.models import AnonymousUser, User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import AnonymousUser, User # pylint: disable=imported-auth-user from django.http import HttpResponse, SimpleCookie from django.test import TestCase from django.urls import reverse diff --git a/openedx/core/djangoapps/catalog/README.rst b/openedx/core/djangoapps/catalog/README.rst index c9d58e996f89..b3b3f8e2757c 100644 --- a/openedx/core/djangoapps/catalog/README.rst +++ b/openedx/core/djangoapps/catalog/README.rst @@ -1,3 +1,6 @@ +Catalog +======= + This app serves as an interface to the discovery a.k.a. "catalog" service. It contains management commands for caching data from the discovery service, functions for accessing that data, and a config model that can be used to control access to the service. diff --git a/openedx/core/djangoapps/catalog/__init__.py b/openedx/core/djangoapps/catalog/__init__.py index 41903687689c..7cac77010d3c 100644 --- a/openedx/core/djangoapps/catalog/__init__.py +++ b/openedx/core/djangoapps/catalog/__init__.py @@ -1 +1 @@ -# lint-amnesty, pylint: disable=missing-module-docstring +# pylint: disable=missing-module-docstring diff --git a/openedx/core/djangoapps/catalog/api.py b/openedx/core/djangoapps/catalog/api.py index 4428eb5f32ca..e9b6870d6eea 100644 --- a/openedx/core/djangoapps/catalog/api.py +++ b/openedx/core/djangoapps/catalog/api.py @@ -2,10 +2,10 @@ Python APIs exposed by the catalog app to other in-process apps. """ -from .utils import get_programs_by_type_slug as _get_programs_by_type_slug -from .utils import get_programs as _get_programs from .utils import course_run_keys_for_program as _course_run_keys_for_program from .utils import get_course_run_details as _get_course_run_details +from .utils import get_programs as _get_programs +from .utils import get_programs_by_type_slug as _get_programs_by_type_slug def get_programs_by_type(site, program_type_slug): diff --git a/openedx/core/djangoapps/catalog/cache.py b/openedx/core/djangoapps/catalog/cache.py index 044ce074203f..4ca681197a6a 100644 --- a/openedx/core/djangoapps/catalog/cache.py +++ b/openedx/core/djangoapps/catalog/cache.py @@ -1,4 +1,4 @@ -# lint-amnesty, pylint: disable=missing-module-docstring +# pylint: disable=missing-module-docstring # Template used to create cache keys for individual programs. PROGRAM_CACHE_KEY_TPL = 'program-{uuid}' diff --git a/openedx/core/djangoapps/catalog/management/commands/cache_programs.py b/openedx/core/djangoapps/catalog/management/commands/cache_programs.py index 4af05da89280..40e86748323a 100644 --- a/openedx/core/djangoapps/catalog/management/commands/cache_programs.py +++ b/openedx/core/djangoapps/catalog/management/commands/cache_programs.py @@ -20,7 +20,7 @@ PROGRAMS_BY_TYPE_CACHE_KEY_TPL, PROGRAMS_BY_TYPE_SLUG_CACHE_KEY_TPL, SITE_PATHWAY_IDS_CACHE_KEY_TPL, - SITE_PROGRAM_UUIDS_CACHE_KEY_TPL + SITE_PROGRAM_UUIDS_CACHE_KEY_TPL, ) from openedx.core.djangoapps.catalog.models import CatalogIntegration from openedx.core.djangoapps.catalog.utils import ( @@ -28,7 +28,7 @@ course_uuids_for_program, get_catalog_api_base_url, get_catalog_api_client, - normalize_program_type + normalize_program_type, ) logger = logging.getLogger(__name__) @@ -53,8 +53,8 @@ def add_arguments(self, parser): help='Help in caching the programs for one site' ) - # lint-amnesty, pylint: disable=bad-option-value, unicode-format-string - def handle(self, *args, **options): # lint-amnesty, pylint: disable=too-many-statements + # pylint: disable=bad-option-value, unicode-format-string + def handle(self, *args, **options): # pylint: disable=too-many-statements domain = options.get('domain', '') failure = False logger.info('populate-multitenant-programs switch is ON') @@ -111,14 +111,14 @@ def handle(self, *args, **options): # lint-amnesty, pylint: disable=too-many-st programs_by_type_slug.update(self.get_programs_by_type_slug(site, new_programs)) organizations.update(self.get_programs_by_organization(new_programs)) - logger.info('Caching UUIDs for {total} programs for site {site_name}.'.format( + logger.info('Caching UUIDs for {total} programs for site {site_name}.'.format( # noqa: UP032 total=len(uuids), site_name=site.domain, )) cache.set(SITE_PROGRAM_UUIDS_CACHE_KEY_TPL.format(domain=site.domain), uuids, None) pathway_ids = list(new_pathways.keys()) - logger.info('Caching ids for {total} pathways for site {site_name}.'.format( + logger.info('Caching ids for {total} pathways for site {site_name}.'.format( # noqa: UP032 total=len(pathway_ids), site_name=site.domain, )) @@ -148,7 +148,7 @@ def handle(self, *args, **options): # lint-amnesty, pylint: disable=too-many-st if failure: sys.exit(1) - def get_site_program_uuids(self, client, site, api_base_url): # lint-amnesty, pylint: disable=missing-function-docstring + def get_site_program_uuids(self, client, site, api_base_url): # pylint: disable=missing-function-docstring failure = False uuids = [] try: @@ -166,13 +166,13 @@ def get_site_program_uuids(self, client, site, api_base_url): # lint-amnesty, p logger.exception(f'Failed to retrieve program UUIDs for site: {site.domain}.') failure = True - logger.info('Received {total} UUIDs for site {domain}'.format( + logger.info('Received {total} UUIDs for site {domain}'.format( # noqa: UP032 total=len(uuids), domain=site.domain )) return uuids, failure - def fetch_program_details(self, client, uuids, api_base_url): # lint-amnesty, pylint: disable=missing-function-docstring + def fetch_program_details(self, client, uuids, api_base_url): # pylint: disable=missing-function-docstring programs = {} failure = False for uuid in uuids: @@ -214,7 +214,7 @@ def get_pathways(self, client, site, api_base_url): ) failure = True - logger.info('Received {total} pathways for site {domain}'.format( + logger.info('Received {total} pathways for site {domain}'.format( # noqa: UP032 total=len(pathways), domain=site.domain )) diff --git a/openedx/core/djangoapps/catalog/management/commands/create_catalog_integrations.py b/openedx/core/djangoapps/catalog/management/commands/create_catalog_integrations.py index 4e6942c37d52..6436ca1c0197 100644 --- a/openedx/core/djangoapps/catalog/management/commands/create_catalog_integrations.py +++ b/openedx/core/djangoapps/catalog/management/commands/create_catalog_integrations.py @@ -2,6 +2,7 @@ from django.core.management import BaseCommand, CommandError + from openedx.core.djangoapps.catalog.models import CatalogIntegration @@ -66,7 +67,7 @@ def handle(self, *args, **options): page_size=page_size ) except Exception as err: - raise CommandError(f'Error creating CatalogIntegration: {err}') # lint-amnesty, pylint: disable=raise-missing-from + raise CommandError(f'Error creating CatalogIntegration: {err}') # pylint: disable=raise-missing-from # noqa: B904 self.stdout.write(self.style.SUCCESS( 'Successfully created CatalogIntegration enabled={} url={} service_username={}').format( diff --git a/openedx/core/djangoapps/catalog/management/commands/sync_course_runs.py b/openedx/core/djangoapps/catalog/management/commands/sync_course_runs.py index a1bf31bd9577..ef66e52fed91 100644 --- a/openedx/core/djangoapps/catalog/management/commands/sync_course_runs.py +++ b/openedx/core/djangoapps/catalog/management/commands/sync_course_runs.py @@ -2,8 +2,8 @@ Sync course runs from catalog service. """ -from collections import namedtuple import logging +from collections import namedtuple from django.core.management.base import BaseCommand from opaque_keys.edx.keys import CourseKey diff --git a/openedx/core/djangoapps/catalog/management/commands/tests/test_cache_programs.py b/openedx/core/djangoapps/catalog/management/commands/tests/test_cache_programs.py index 1edd52d3c6a5..b981b3d4f4ac 100644 --- a/openedx/core/djangoapps/catalog/management/commands/tests/test_cache_programs.py +++ b/openedx/core/djangoapps/catalog/management/commands/tests/test_cache_programs.py @@ -3,27 +3,28 @@ """ import json -import pytest + import httpretty +import pytest from django.core.cache import cache from django.core.management import call_command +from common.djangoapps.student.tests.factories import UserFactory from openedx.core.djangoapps.catalog.cache import ( COURSE_PROGRAMS_CACHE_KEY_TPL, - PROGRAMS_BY_ORGANIZATION_CACHE_KEY_TPL, PATHWAY_CACHE_KEY_TPL, PROGRAM_CACHE_KEY_TPL, + PROGRAMS_BY_ORGANIZATION_CACHE_KEY_TPL, PROGRAMS_BY_TYPE_CACHE_KEY_TPL, PROGRAMS_BY_TYPE_SLUG_CACHE_KEY_TPL, SITE_PATHWAY_IDS_CACHE_KEY_TPL, - SITE_PROGRAM_UUIDS_CACHE_KEY_TPL + SITE_PROGRAM_UUIDS_CACHE_KEY_TPL, ) -from openedx.core.djangoapps.catalog.utils import normalize_program_type from openedx.core.djangoapps.catalog.tests.factories import OrganizationFactory, PathwayFactory, ProgramFactory from openedx.core.djangoapps.catalog.tests.mixins import CatalogIntegrationMixin +from openedx.core.djangoapps.catalog.utils import normalize_program_type from openedx.core.djangoapps.site_configuration.tests.mixins import SiteMixin from openedx.core.djangolib.testing.utils import CacheIsolationTestCase, skip_unless_lms -from common.djangoapps.student.tests.factories import UserFactory @skip_unless_lms @@ -349,7 +350,7 @@ def test_handle_missing_service_user(self): Verify that the command raises an exception when run without a service user, and that program UUIDs are not cached. """ - with pytest.raises(Exception): + with pytest.raises(Exception): # noqa: B017, PT011 call_command('cache_programs') cached_uuids = cache.get(SITE_PROGRAM_UUIDS_CACHE_KEY_TPL.format(domain=self.site_domain)) diff --git a/openedx/core/djangoapps/catalog/management/commands/tests/test_create_catalog_integrations.py b/openedx/core/djangoapps/catalog/management/commands/tests/test_create_catalog_integrations.py index 72591bf92d57..1738543713df 100644 --- a/openedx/core/djangoapps/catalog/management/commands/tests/test_create_catalog_integrations.py +++ b/openedx/core/djangoapps/catalog/management/commands/tests/test_create_catalog_integrations.py @@ -2,12 +2,11 @@ Test cases for catalog_integrations command. """ import pytest -from django.core.management import call_command, CommandError - -from openedx.core.djangolib.testing.utils import CacheIsolationTestCase +from django.core.management import CommandError, call_command from openedx.core.djangoapps.catalog.models import CatalogIntegration from openedx.core.djangoapps.catalog.tests.mixins import CatalogIntegrationMixin +from openedx.core.djangolib.testing.utils import CacheIsolationTestCase class TestCreateCatalogIntegrations(CatalogIntegrationMixin, CacheIsolationTestCase): diff --git a/openedx/core/djangoapps/catalog/management/commands/tests/test_sync_course_runs.py b/openedx/core/djangoapps/catalog/management/commands/tests/test_sync_course_runs.py index 882488f6c615..e06f198127d5 100644 --- a/openedx/core/djangoapps/catalog/management/commands/tests/test_sync_course_runs.py +++ b/openedx/core/djangoapps/catalog/management/commands/tests/test_sync_course_runs.py @@ -6,11 +6,13 @@ import ddt from django.core.management import call_command -from openedx.core.djangoapps.catalog.tests.factories import CourseRunFactory from openedx.core.djangoapps.catalog.management.commands.sync_course_runs import Command as sync_command +from openedx.core.djangoapps.catalog.tests.factories import CourseRunFactory from openedx.core.djangoapps.content.course_overviews.models import CourseOverview -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + ModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order COMMAND_MODULE = 'openedx.core.djangoapps.catalog.management.commands.sync_course_runs' diff --git a/openedx/core/djangoapps/catalog/tests/test_models.py b/openedx/core/djangoapps/catalog/tests/test_models.py index 6bcd06d6bb15..acdcde975b6f 100644 --- a/openedx/core/djangoapps/catalog/tests/test_models.py +++ b/openedx/core/djangoapps/catalog/tests/test_models.py @@ -2,7 +2,6 @@ import ddt - from django.test import override_settings from openedx.core.djangoapps.catalog.tests import mixins diff --git a/openedx/core/djangoapps/catalog/tests/test_utils.py b/openedx/core/djangoapps/catalog/tests/test_utils.py index 73bd663299de..eb961951352b 100644 --- a/openedx/core/djangoapps/catalog/tests/test_utils.py +++ b/openedx/core/djangoapps/catalog/tests/test_utils.py @@ -169,7 +169,7 @@ def fake_get_many(keys): key = PROGRAM_CACHE_KEY_TPL.format(uuid=program["uuid"]) assert program == all_programs[key] - def test_get_one(self, mock_warning, _mock_info): + def test_get_one(self, mock_warning, _mock_info): # noqa: PT019 expected_program = ProgramFactory() expected_uuid = expected_program["uuid"] @@ -183,7 +183,7 @@ def test_get_one(self, mock_warning, _mock_info): assert actual_program == expected_program assert not mock_warning.called - def test_get_from_course(self, mock_warning, _mock_info): + def test_get_from_course(self, mock_warning, _mock_info): # noqa: PT019 expected_program = ProgramFactory() expected_course = expected_program["courses"][0]["course_runs"][0]["key"] @@ -196,7 +196,7 @@ def test_get_from_course(self, mock_warning, _mock_info): assert actual_program == [expected_program] assert not mock_warning.called - def test_get_via_uuids(self, mock_warning, _mock_info): + def test_get_via_uuids(self, mock_warning, _mock_info): # noqa: PT019 first_program = ProgramFactory() second_program = ProgramFactory() @@ -209,7 +209,7 @@ def test_get_via_uuids(self, mock_warning, _mock_info): assert second_program in results assert not mock_warning.called - def test_get_from_catalog_course(self, mock_warning, _mock_info): + def test_get_from_catalog_course(self, mock_warning, _mock_info): # noqa: PT019 expected_program = ProgramFactory() expected_catalog_course = expected_program["courses"][0] @@ -323,7 +323,7 @@ def fake_get_many(keys): key = PATHWAY_CACHE_KEY_TPL.format(id=pathway["id"]) assert pathway == all_pathways[key] - def test_get_one(self, mock_warning, _mock_info): + def test_get_one(self, mock_warning, _mock_info): # noqa: PT019 expected_pathway = PathwayFactory() expected_id = expected_pathway["id"] @@ -844,8 +844,8 @@ def init_cache(self): def test_get_masters_programs(self): expected_programs = [self.masters_program_1, self.masters_program_2] - self.assertCountEqual(expected_programs, get_programs_by_type(self.site, "masters")) - self.assertCountEqual(expected_programs, get_programs_by_type_slug(self.site, "masters")) + self.assertCountEqual(expected_programs, get_programs_by_type(self.site, "masters")) # noqa: PT009 + self.assertCountEqual(expected_programs, get_programs_by_type_slug(self.site, "masters")) # noqa: PT009 def test_get_bachelors_programs(self): expected_programs = [self.bachelors_program] diff --git a/openedx/core/djangoapps/catalog/urls.py b/openedx/core/djangoapps/catalog/urls.py index edf725ed727d..2b0d190e74e6 100644 --- a/openedx/core/djangoapps/catalog/urls.py +++ b/openedx/core/djangoapps/catalog/urls.py @@ -3,6 +3,7 @@ """ from django.urls import path + from . import views app_name = 'catalog' diff --git a/openedx/core/djangoapps/catalog/utils.py b/openedx/core/djangoapps/catalog/utils.py index 10abd33647cd..68cb9505a305 100644 --- a/openedx/core/djangoapps/catalog/utils.py +++ b/openedx/core/djangoapps/catalog/utils.py @@ -4,7 +4,7 @@ import datetime import logging import uuid -from typing import TYPE_CHECKING, Any, List, Union +from typing import TYPE_CHECKING, Any, List, Union # noqa: UP035 from zoneinfo import ZoneInfo import pycountry @@ -84,7 +84,7 @@ def check_catalog_integration_and_get_user(error_message_field): user = catalog_integration.get_service_user() except ObjectDoesNotExist: logger.error( - "Catalog service user with username [{username}] does not exist. " + "Catalog service user with username [{username}] does not exist. " # noqa: UP032 "{field} will not be retrieved.".format( username=catalog_integration.service_username, field=error_message_field, @@ -93,8 +93,8 @@ def check_catalog_integration_and_get_user(error_message_field): return None, catalog_integration return user, catalog_integration else: - logger.error( - "Unable to retrieve details about {field} because Catalog Integration is not enabled".format( + logger.info( + "Unable to retrieve details about {field} because Catalog Integration is not enabled".format( # noqa: UP032 field=error_message_field, ) ) @@ -105,11 +105,11 @@ def check_catalog_integration_and_get_user(error_message_field): def get_programs( site: "Site" = None, uuid: str = None, - uuids: List[str] = None, + uuids: List[str] = None, # noqa: UP006 course: str = None, catalog_course_uuid: str = None, organization: str = None, -) -> Union[str, List[str]]: +) -> Union[str, List[str]]: # noqa: UP006, UP007 """Read programs from the cache. The cache is populated by a management command, cache_programs. @@ -205,7 +205,7 @@ def get_programs_by_type_slug(site, program_type_slug): return get_programs_by_uuids(uuids) -def get_programs_by_uuids(uuids: List[Any]) -> List[str]: +def get_programs_by_uuids(uuids: List[Any]) -> List[str]: # noqa: UP006 """ Gets a list of programs for the provided uuids """ @@ -443,7 +443,7 @@ def get_course_runs(): return course_runs -def get_course_runs_for_course(course_uuid): # lint-amnesty, pylint: disable=missing-function-docstring +def get_course_runs_for_course(course_uuid): # pylint: disable=missing-function-docstring if course_uuid is None: raise ValueError("missing course_uuid") user, catalog_integration = check_catalog_integration_and_get_user(error_message_field="Course runs") diff --git a/openedx/core/djangoapps/catalog/views.py b/openedx/core/djangoapps/catalog/views.py index d417dc14d33f..a328fe0b25cf 100644 --- a/openedx/core/djangoapps/catalog/views.py +++ b/openedx/core/djangoapps/catalog/views.py @@ -1,4 +1,4 @@ -# lint-amnesty, pylint: disable=missing-module-docstring +# pylint: disable=missing-module-docstring from django.conf import settings from django.core.management import call_command from django.http import Http404, HttpResponse diff --git a/openedx/core/djangoapps/ccxcon/api.py b/openedx/core/djangoapps/ccxcon/api.py index 5dab1c940fa8..4ec95ac30c1b 100644 --- a/openedx/core/djangoapps/ccxcon/api.py +++ b/openedx/core/djangoapps/ccxcon/api.py @@ -13,10 +13,10 @@ from requests_oauthlib import OAuth2Session from rest_framework.status import HTTP_200_OK, HTTP_201_CREATED -from openedx.core.djangoapps.models.course_details import CourseDetails -from openedx.core.lib.courses import get_course_by_id from common.djangoapps.student.models import anonymous_id_for_user from common.djangoapps.student.roles import CourseInstructorRole +from openedx.core.djangoapps.models.course_details import CourseDetails +from openedx.core.lib.courses import get_course_by_id from .models import CCXCon @@ -148,7 +148,7 @@ def course_info_to_ccxcon(course_key): ) if resp.status_code >= 500: - raise CCXConnServerError('Server returned error Status: %s, Content: %s', resp.status_code, resp.content) # lint-amnesty, pylint: disable=raising-format-tuple + raise CCXConnServerError('Server returned error Status: %s, Content: %s', resp.status_code, resp.content) # pylint: disable=raising-format-tuple if resp.status_code >= 400: log.error("Error creating course on ccxcon. Status: %s, Content: %s", resp.status_code, resp.content) # this API performs a POST request both for POST and PATCH, but the POST returns 201 and the PATCH returns 200 diff --git a/openedx/core/djangoapps/ccxcon/apps.py b/openedx/core/djangoapps/ccxcon/apps.py index 40aa4a32676d..68f06c564137 100644 --- a/openedx/core/djangoapps/ccxcon/apps.py +++ b/openedx/core/djangoapps/ccxcon/apps.py @@ -6,9 +6,9 @@ from django.apps import AppConfig -class CCXConnectorConfig(AppConfig): # lint-amnesty, pylint: disable=missing-class-docstring +class CCXConnectorConfig(AppConfig): # pylint: disable=missing-class-docstring name = 'openedx.core.djangoapps.ccxcon' verbose_name = "CCX Connector" def ready(self): - from . import signals # lint-amnesty, pylint: disable=unused-import + from . import signals # pylint: disable=unused-import # noqa: F401 diff --git a/openedx/core/djangoapps/ccxcon/tasks.py b/openedx/core/djangoapps/ccxcon/tasks.py index d5d25f943cc4..12a8cc7d9f33 100644 --- a/openedx/core/djangoapps/ccxcon/tasks.py +++ b/openedx/core/djangoapps/ccxcon/tasks.py @@ -7,7 +7,12 @@ from celery.utils.log import get_task_logger from edx_django_utils.monitoring import set_code_owner_attribute from opaque_keys.edx.keys import CourseKey -from requests.exceptions import ConnectionError, HTTPError, RequestException, TooManyRedirects # lint-amnesty, pylint: disable=redefined-builtin +from requests.exceptions import ( # pylint: disable=redefined-builtin + ConnectionError, + HTTPError, + RequestException, + TooManyRedirects, +) from openedx.core.djangoapps.ccxcon import api diff --git a/openedx/core/djangoapps/ccxcon/tests/test_api.py b/openedx/core/djangoapps/ccxcon/tests/test_api.py index d2d133ba20df..797778e8084e 100644 --- a/openedx/core/djangoapps/ccxcon/tests/test_api.py +++ b/openedx/core/djangoapps/ccxcon/tests/test_api.py @@ -8,12 +8,12 @@ import pytest from opaque_keys.edx.keys import CourseKey -from xmodule.modulestore.django import modulestore -from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase -from xmodule.modulestore.tests.factories import CourseFactory, BlockFactory -from openedx.core.djangoapps.ccxcon import api as ccxconapi from common.djangoapps.student.tests.factories import AdminFactory +from openedx.core.djangoapps.ccxcon import api as ccxconapi +from xmodule.modulestore.django import modulestore +from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase +from xmodule.modulestore.tests.factories import BlockFactory, CourseFactory from .factories import CcxConFactory @@ -69,7 +69,7 @@ def setUpClass(cls): # Trying to wrap the whole thing in a bulk operation fails because it # doesn't find the parents. But we can at least wrap this part... with cls.store.bulk_operations(course.id, emit_signals=False): - blocks = flatten([ # pylint: disable=unused-variable + blocks = flatten([ # pylint: disable=unused-variable # noqa: F841 [ BlockFactory.create(parent=vertical) for _ in range(2) ] for vertical in cls.verticals diff --git a/openedx/core/djangoapps/ccxcon/tests/test_signals.py b/openedx/core/djangoapps/ccxcon/tests/test_signals.py index ec3c61c3fb87..9060ad499242 100644 --- a/openedx/core/djangoapps/ccxcon/tests/test_signals.py +++ b/openedx/core/djangoapps/ccxcon/tests/test_signals.py @@ -4,6 +4,7 @@ from unittest import mock + from django.test import TestCase from opaque_keys.edx.keys import CourseKey diff --git a/openedx/core/djangoapps/ccxcon/tests/test_tasks.py b/openedx/core/djangoapps/ccxcon/tests/test_tasks.py index 309b465bd43a..c31332a2de20 100644 --- a/openedx/core/djangoapps/ccxcon/tests/test_tasks.py +++ b/openedx/core/djangoapps/ccxcon/tests/test_tasks.py @@ -4,6 +4,7 @@ from unittest import mock + from django.test import TestCase from opaque_keys.edx.keys import CourseKey diff --git a/openedx/core/djangoapps/commerce/utils.py b/openedx/core/djangoapps/commerce/utils.py index 1d0c5d0924a6..1b1a36cf9e67 100644 --- a/openedx/core/djangoapps/commerce/utils.py +++ b/openedx/core/djangoapps/commerce/utils.py @@ -1,21 +1,22 @@ """ Commerce API Service. """ -import requests -import slumber import datetime import json import os import socket + +import requests +import slumber from django.conf import settings -from edx_rest_api_client.auth import SuppliedJwtAuth, JwtAuth from edx_django_utils.cache import TieredCache +from edx_django_utils.monitoring import set_custom_attribute +from edx_rest_api_client.auth import JwtAuth, SuppliedJwtAuth from eventtracking import tracker +from requests.auth import AuthBase from openedx.core.djangoapps.oauth_dispatch.jwt import create_jwt_for_user -from requests.auth import AuthBase from openedx.core.djangoapps.site_configuration import helpers as configuration_helpers -from edx_django_utils.monitoring import set_custom_attribute # When caching tokens, use this value to err on expiring tokens a little early so they are # sure to be valid at the time they are used. @@ -65,7 +66,7 @@ def user_agent(): client_name = os.environ.get("EDX_REST_API_CLIENT_NAME") or socket.gethostbyname(socket.gethostname()) except: # pylint: disable=bare-except pass # using 'unknown_client_name' is good enough. no need to log. - return "{} edx-rest-api-client/{} {}".format( + return "{} edx-rest-api-client/{} {}".format( # noqa: UP032 requests.utils.default_user_agent(), # e.g. "python-requests/2.9.1" __version__, # version of this client client_name @@ -172,7 +173,7 @@ def get_and_cache_oauth_access_token(url, client_id, client_secret, token_type=' """ oauth_url = _get_oauth_url(url) - cache_key = 'edx_rest_api_client.access_token.{}.{}.{}.{}'.format( + cache_key = 'edx_rest_api_client.access_token.{}.{}.{}.{}'.format( # noqa: UP032 token_type, grant_type, client_id, diff --git a/openedx/core/djangoapps/common_initialization/apps.py b/openedx/core/djangoapps/common_initialization/apps.py index ccbe6d76d929..1b2c1f795f45 100644 --- a/openedx/core/djangoapps/common_initialization/apps.py +++ b/openedx/core/djangoapps/common_initialization/apps.py @@ -2,18 +2,19 @@ Common initialization app for the LMS and CMS """ - from django.apps import AppConfig +from django.db import connection -class CommonInitializationConfig(AppConfig): # lint-amnesty, pylint: disable=missing-class-docstring +class CommonInitializationConfig(AppConfig): # pylint: disable=missing-class-docstring name = 'openedx.core.djangoapps.common_initialization' verbose_name = 'Common Initialization' def ready(self): # Common settings validations for the LMS and CMS. - from . import checks # lint-amnesty, pylint: disable=unused-import + from . import checks # pylint: disable=unused-import # noqa: F401 self._add_mimetypes() + self._add_required_adapters() @staticmethod def _add_mimetypes(): @@ -26,3 +27,21 @@ def _add_mimetypes(): mimetypes.add_type('application/x-font-opentype', '.otf') mimetypes.add_type('application/x-font-ttf', '.ttf') mimetypes.add_type('application/font-woff', '.woff') + + @staticmethod + def _add_required_adapters(): + """ + Register CourseLocator in psycopg2 extensions + :return: + """ + if 'postgresql' in connection.vendor.lower(): + from opaque_keys.edx.locator import BlockUsageLocator, CourseLocator, LibraryLocator + from psycopg2.extensions import QuotedString, register_adapter + + def adapt_course_locator(course_locator): + return QuotedString(str(course_locator)) # pylint: disable=protected-access + + # Register the adapter + register_adapter(CourseLocator, adapt_course_locator) + register_adapter(LibraryLocator, adapt_course_locator) + register_adapter(BlockUsageLocator, adapt_course_locator) diff --git a/openedx/core/djangoapps/common_initialization/checks.py b/openedx/core/djangoapps/common_initialization/checks.py index f081691759b7..3eb41ce48518 100644 --- a/openedx/core/djangoapps/common_initialization/checks.py +++ b/openedx/core/djangoapps/common_initialization/checks.py @@ -12,7 +12,7 @@ @register(Tags.compatibility) -def validate_lms_root_url_setting(app_configs, **kwargs): # lint-amnesty, pylint: disable=unused-argument +def validate_lms_root_url_setting(app_configs, **kwargs): # pylint: disable=unused-argument """ Validates the LMS_ROOT_URL setting. """ @@ -28,7 +28,7 @@ def validate_lms_root_url_setting(app_configs, **kwargs): # lint-amnesty, pylin @register(Tags.compatibility) -def validate_marketing_site_setting(app_configs, **kwargs): # lint-amnesty, pylint: disable=unused-argument +def validate_marketing_site_setting(app_configs, **kwargs): # pylint: disable=unused-argument """ Validates marketing site related settings. """ diff --git a/openedx/core/djangoapps/common_views/xblock.py b/openedx/core/djangoapps/common_views/xblock.py index ec87b07afb47..1a4e1c3d1b71 100644 --- a/openedx/core/djangoapps/common_views/xblock.py +++ b/openedx/core/djangoapps/common_views/xblock.py @@ -23,10 +23,10 @@ def xblock_resource(request, block_type, uri): # pylint: disable=unused-argumen content = xblock_class.open_local_resource(uri) except OSError: log.info('Failed to load xblock resource', exc_info=True) - raise Http404 # lint-amnesty, pylint: disable=raise-missing-from + raise Http404 # pylint: disable=raise-missing-from # noqa: B904 except Exception: log.error('Failed to load xblock resource', exc_info=True) - raise Http404 # lint-amnesty, pylint: disable=raise-missing-from + raise Http404 # pylint: disable=raise-missing-from # noqa: B904 mimetype, _ = mimetypes.guess_type(uri) return HttpResponse(content, content_type=mimetype) diff --git a/openedx/core/djangoapps/config_model_utils/admin.py b/openedx/core/djangoapps/config_model_utils/admin.py index cd896f448ffd..faf29aaf75aa 100644 --- a/openedx/core/djangoapps/config_model_utils/admin.py +++ b/openedx/core/djangoapps/config_model_utils/admin.py @@ -7,6 +7,7 @@ from django import forms from django.utils.translation import gettext_lazy as _ from opaque_keys.edx.keys import CourseKey + from openedx.core.djangolib.markup import HTML, Text diff --git a/openedx/core/djangoapps/config_model_utils/models.py b/openedx/core/djangoapps/config_model_utils/models.py index 11d4d6383a10..eb78ad9153b9 100644 --- a/openedx/core/djangoapps/config_model_utils/models.py +++ b/openedx/core/djangoapps/config_model_utils/models.py @@ -72,7 +72,7 @@ class Meta: "Configure values for all course runs associated with this site." ), ) - org = models.CharField( + org = models.CharField( # noqa: DJ001 max_length=255, db_index=True, null=True, @@ -82,7 +82,7 @@ class Meta: "Organization. This is the organization string (i.e. edX, MITx)." ) ) - org_course = models.CharField( + org_course = models.CharField( # noqa: DJ001 max_length=255, db_index=True, null=True, @@ -326,7 +326,7 @@ def _org_course_from_course_key(cls, course_key): @classmethod @request_cached() - def _site_from_org(cls, org): # lint-amnesty, pylint: disable=missing-function-docstring + def _site_from_org(cls, org): # pylint: disable=missing-function-docstring configuration = SiteConfiguration.get_configuration_for_org(org, select_related=['site']) if configuration is None: diff --git a/openedx/core/djangoapps/content/block_structure/__init__.py b/openedx/core/djangoapps/content/block_structure/__init__.py index 00ed1b12d2ef..cf345b73cf51 100644 --- a/openedx/core/djangoapps/content/block_structure/__init__.py +++ b/openedx/core/djangoapps/content/block_structure/__init__.py @@ -49,7 +49,7 @@ Registry. Transformers are registered using the platform's PluginManager (e.g., Stevedore). This is currently done by updating -setup.py. Only registered transformers are called during the Collect +pyproject.toml. Only registered transformers are called during the Collect Phase. And only registered transformers can be used during the Transform phase. Exceptions to this rule are any nested transformers that are contained within higher-order transformers - as long as the diff --git a/openedx/core/djangoapps/content/block_structure/apps.py b/openedx/core/djangoapps/content/block_structure/apps.py index bdb77d2bafca..d3911df76540 100644 --- a/openedx/core/djangoapps/content/block_structure/apps.py +++ b/openedx/core/djangoapps/content/block_structure/apps.py @@ -21,4 +21,4 @@ def ready(self): These happen at import time. Hence the unused imports """ - from . import signals, tasks # lint-amnesty, pylint: disable=unused-import, unused-variable + from . import signals, tasks # pylint: disable=unused-import, unused-variable # noqa: F401 diff --git a/openedx/core/djangoapps/content/block_structure/block_structure.py b/openedx/core/djangoapps/content/block_structure/block_structure.py index d7ef27fcceed..757bd58d8e17 100644 --- a/openedx/core/djangoapps/content/block_structure/block_structure.py +++ b/openedx/core/djangoapps/content/block_structure/block_structure.py @@ -14,9 +14,8 @@ from functools import partial from logging import getLogger -from xmodule.block_metadata_utils import get_datetime_field - from openedx.core.lib.graph_traversals import traverse_post_order, traverse_topologically +from xmodule.block_metadata_utils import get_datetime_field from .exceptions import TransformerException @@ -299,11 +298,11 @@ def __init__(self): def __getattr__(self, field_name): if self._is_own_field(field_name): - return super().__getattr__(field_name) # lint-amnesty, pylint: disable=no-member + return super().__getattr__(field_name) # pylint: disable=no-member try: return self.fields[field_name] except KeyError: - raise AttributeError(f"Field {field_name} does not exist") # lint-amnesty, pylint: disable=raise-missing-from + raise AttributeError(f"Field {field_name} does not exist") # pylint: disable=raise-missing-from # noqa: B904 def __setattr__(self, field_name, field_value): if self._is_own_field(field_name): @@ -393,6 +392,10 @@ def __init__(self, usage_key): # Map of transformer name to its block-specific data. self.transformer_data = TransformerDataMap() + @property + def usage_key(self): + return self.location + class BlockStructureBlockData(BlockStructure): """ @@ -749,7 +752,7 @@ def _add_transformer(self, transformer): its current version number. """ if transformer.WRITE_VERSION == 0: - raise TransformerException('Version attributes are not set on transformer {0}.', transformer.name()) # lint-amnesty, pylint: disable=raising-format-tuple + raise TransformerException('Version attributes are not set on transformer {0}.', transformer.name()) # pylint: disable=raising-format-tuple self.set_transformer_data(transformer, TRANSFORMER_VERSION_KEY, transformer.WRITE_VERSION) def _get_or_create_block(self, usage_key): diff --git a/openedx/core/djangoapps/content/block_structure/config/__init__.py b/openedx/core/djangoapps/content/block_structure/config/__init__.py index 79837df86be6..62e797e9e4c6 100644 --- a/openedx/core/djangoapps/content/block_structure/config/__init__.py +++ b/openedx/core/djangoapps/content/block_structure/config/__init__.py @@ -2,8 +2,8 @@ This module contains various configuration settings via waffle switches for the Block Structure framework. """ -from edx_django_utils.cache import RequestCache -from edx_toggles.toggles import WaffleSwitch +from edx_django_utils.cache import RequestCache # noqa: F401 +from edx_toggles.toggles import WaffleSwitch # noqa: F401 from openedx.core.lib.cache_utils import request_cached diff --git a/openedx/core/djangoapps/content/block_structure/config/models.py b/openedx/core/djangoapps/content/block_structure/config/models.py index 0f540fa0de5d..19979850a616 100644 --- a/openedx/core/djangoapps/content/block_structure/config/models.py +++ b/openedx/core/djangoapps/content/block_structure/config/models.py @@ -24,7 +24,7 @@ class Meta: cache_timeout_in_seconds = IntegerField(blank=True, null=True, default=DEFAULT_CACHE_TIMEOUT_IN_SECONDS) def __str__(self): - return "BlockStructureConfiguration: num_versions_to_keep: {}, cache_timeout_in_seconds: {}".format( + return "BlockStructureConfiguration: num_versions_to_keep: {}, cache_timeout_in_seconds: {}".format( # noqa: UP032 # pylint: disable=line-too-long self.num_versions_to_keep, self.cache_timeout_in_seconds, ) diff --git a/openedx/core/djangoapps/content/block_structure/exceptions.py b/openedx/core/djangoapps/content/block_structure/exceptions.py index 50a4ad548d20..4b7e98e5e71f 100644 --- a/openedx/core/djangoapps/content/block_structure/exceptions.py +++ b/openedx/core/djangoapps/content/block_structure/exceptions.py @@ -7,21 +7,21 @@ class BlockStructureException(Exception): """ Base class for all Block Structure framework exceptions. """ - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass class TransformerException(BlockStructureException): """ Exception class for Transformer related errors. """ - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass class UsageKeyNotInBlockStructure(BlockStructureException): """ Exception for when a usage key is not found within a block structure. """ - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass class TransformerDataIncompatible(BlockStructureException): @@ -29,7 +29,7 @@ class TransformerDataIncompatible(BlockStructureException): Exception for when the version of a Transformer's data is not compatible with the current version of the Transformer. """ - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass class BlockStructureNotFound(BlockStructureException): diff --git a/openedx/core/djangoapps/content/block_structure/management/commands/generate_course_blocks.py b/openedx/core/djangoapps/content/block_structure/management/commands/generate_course_blocks.py index 047c945fe406..bb873fe6c145 100644 --- a/openedx/core/djangoapps/content/block_structure/management/commands/generate_course_blocks.py +++ b/openedx/core/djangoapps/content/block_structure/management/commands/generate_course_blocks.py @@ -13,9 +13,9 @@ from openedx.core.lib.command_utils import ( get_mutually_exclusive_required_option, parse_course_keys, - validate_dependent_option + validate_dependent_option, ) -from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order log = logging.getLogger(__name__) diff --git a/openedx/core/djangoapps/content/block_structure/management/commands/tests/test_generate_course_blocks.py b/openedx/core/djangoapps/content/block_structure/management/commands/tests/test_generate_course_blocks.py index 430f374b07cc..762ae52658ea 100644 --- a/openedx/core/djangoapps/content/block_structure/management/commands/tests/test_generate_course_blocks.py +++ b/openedx/core/djangoapps/content/block_structure/management/commands/tests/test_generate_course_blocks.py @@ -2,19 +2,21 @@ Tests for generate_course_blocks management command. """ +import itertools from unittest.mock import patch -import itertools -import pytest import ddt +import pytest from django.core.management.base import CommandError from openedx.core.djangoapps.content.block_structure.tests.helpers import ( is_course_in_block_structure_cache, - is_course_in_block_structure_storage + is_course_in_block_structure_storage, +) +from xmodule.modulestore.tests.django_utils import ( + ModuleStoreTestCase, # pylint: disable=wrong-import-order ) -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order from .. import generate_course_blocks diff --git a/openedx/core/djangoapps/content/block_structure/manager.py b/openedx/core/djangoapps/content/block_structure/manager.py index b6a447bdf201..5335182ba6e8 100644 --- a/openedx/core/djangoapps/content/block_structure/manager.py +++ b/openedx/core/djangoapps/content/block_structure/manager.py @@ -73,7 +73,7 @@ def get_transformed(self, transformers, starting_block_usage_key=None, collected # requested location. The rest of the structure will be pruned # as part of the transformation. if starting_block_usage_key not in block_structure: - raise UsageKeyNotInBlockStructure( # lint-amnesty, pylint: disable=raising-format-tuple + raise UsageKeyNotInBlockStructure( # pylint: disable=raising-format-tuple "The requested usage_key '{0}' is not found in the block_structure with root '{1}'", str(starting_block_usage_key), str(self.root_block_usage_key), diff --git a/openedx/core/djangoapps/content/block_structure/migrations/0001_config.py b/openedx/core/djangoapps/content/block_structure/migrations/0001_config.py index f25e3d629d8e..77fcba89e790 100644 --- a/openedx/core/djangoapps/content/block_structure/migrations/0001_config.py +++ b/openedx/core/djangoapps/content/block_structure/migrations/0001_config.py @@ -1,6 +1,6 @@ -from django.db import migrations, models import django.db.models.deletion from django.conf import settings +from django.db import migrations, models class Migration(migrations.Migration): diff --git a/openedx/core/djangoapps/content/block_structure/migrations/0002_blockstructuremodel.py b/openedx/core/djangoapps/content/block_structure/migrations/0002_blockstructuremodel.py index 7ff9c9e03640..80f9749a0291 100644 --- a/openedx/core/djangoapps/content/block_structure/migrations/0002_blockstructuremodel.py +++ b/openedx/core/djangoapps/content/block_structure/migrations/0002_blockstructuremodel.py @@ -1,7 +1,8 @@ -from django.db import migrations, models import django.utils.timezone import model_utils.fields +from django.db import migrations, models from opaque_keys.edx.django.models import UsageKeyField + import openedx.core.djangoapps.content.block_structure.models diff --git a/openedx/core/djangoapps/content/block_structure/migrations/0003_blockstructuremodel_storage.py b/openedx/core/djangoapps/content/block_structure/migrations/0003_blockstructuremodel_storage.py index b343dc170608..4a7904b97f3c 100644 --- a/openedx/core/djangoapps/content/block_structure/migrations/0003_blockstructuremodel_storage.py +++ b/openedx/core/djangoapps/content/block_structure/migrations/0003_blockstructuremodel_storage.py @@ -1,4 +1,5 @@ from django.db import migrations, models + import openedx.core.djangoapps.content.block_structure.models diff --git a/openedx/core/djangoapps/content/block_structure/migrations/0004_blockstructuremodel_usagekeywithrun.py b/openedx/core/djangoapps/content/block_structure/migrations/0004_blockstructuremodel_usagekeywithrun.py index 23ee895f3ba5..6d75495bf2a1 100644 --- a/openedx/core/djangoapps/content/block_structure/migrations/0004_blockstructuremodel_usagekeywithrun.py +++ b/openedx/core/djangoapps/content/block_structure/migrations/0004_blockstructuremodel_usagekeywithrun.py @@ -1,4 +1,5 @@ from django.db import migrations, models + import openedx.core.djangoapps.xmodule_django.models diff --git a/openedx/core/djangoapps/content/block_structure/models.py b/openedx/core/djangoapps/content/block_structure/models.py index 9bd75cab22bf..0591ea83646c 100644 --- a/openedx/core/djangoapps/content/block_structure/models.py +++ b/openedx/core/djangoapps/content/block_structure/models.py @@ -12,10 +12,9 @@ from django.core.exceptions import SuspiciousOperation from django.core.files.base import ContentFile from django.db import models, transaction - -from common.djangoapps.util.storage import resolve_storage_backend from model_utils.models import TimeStampedModel +from common.djangoapps.util.storage import resolve_storage_backend from openedx.core.djangoapps.xmodule_django.models import UsageKeyWithRunField from . import config @@ -47,7 +46,7 @@ def _directory_name(data_usage_key): # replace any '/' in the usage key so they aren't interpreted # as folder separators. encoded_usage_key = str(data_usage_key).replace('/', '_') - return '{}{}'.format( + return '{}{}'.format( # noqa: UP032 directory_prefix, encoded_usage_key, ) @@ -107,7 +106,7 @@ def __init__(self, *args, **kwargs): )) super().__init__(*args, **kwargs) - def deconstruct(self): # lint-amnesty, pylint: disable=missing-function-docstring + def deconstruct(self): # pylint: disable=missing-function-docstring name, path, args, kwargs = super().deconstruct() del kwargs['upload_to'] del kwargs['storage'] @@ -139,13 +138,13 @@ def _storage_error_handling(bs_model, operation, is_read_operation=False): yield except Exception as error: # pylint: disable=broad-except log.exception('BlockStructure: Exception %s on store %s; %s.', error.__class__, operation, bs_model) - if isinstance(error, OSError) and error.errno in (errno.EACCES, errno.EPERM): # lint-amnesty, pylint: disable=no-else-raise, no-member + if isinstance(error, OSError) and error.errno in (errno.EACCES, errno.EPERM): # pylint: disable=no-else-raise, no-member raise elif is_read_operation and isinstance(error, (IOError, SuspiciousOperation)): # May have been caused by one of the possible error # situations listed above. Raise BlockStructureNotFound # so the block structure can be regenerated and restored. - raise BlockStructureNotFound(bs_model.data_usage_key) # lint-amnesty, pylint: disable=raise-missing-from + raise BlockStructureNotFound(bs_model.data_usage_key) # pylint: disable=raise-missing-from # noqa: B904 else: raise @@ -173,7 +172,7 @@ class Meta: max_length=255, unique=True, ) - data_version = models.CharField( + data_version = models.CharField( # noqa: DJ001 'Version of the data at the time of collection.', blank=True, null=True, @@ -218,7 +217,7 @@ def get(cls, data_usage_key): return cls.objects.get(data_usage_key=data_usage_key) except cls.DoesNotExist: log.info('BlockStructure: Not found in table; %s.', data_usage_key) - raise BlockStructureNotFound(data_usage_key) # lint-amnesty, pylint: disable=raise-missing-from + raise BlockStructureNotFound(data_usage_key) # pylint: disable=raise-missing-from # noqa: B904 @classmethod def update_or_create(cls, serialized_data, data_usage_key, **kwargs): @@ -260,7 +259,7 @@ def _prune_files(cls, data_usage_key, num_to_keep=None): try: all_files_by_date = sorted(cls._get_all_files(data_usage_key)) - files_to_delete = all_files_by_date[:-num_to_keep] if num_to_keep > 0 else all_files_by_date # lint-amnesty, pylint: disable=invalid-unary-operand-type + files_to_delete = all_files_by_date[:-num_to_keep] if num_to_keep > 0 else all_files_by_date # pylint: disable=invalid-unary-operand-type cls._delete_files(files_to_delete) log.info( 'BlockStructure: Deleted %d out of total %d files in store; data_usage_key: %s, num_to_keep: %d.', diff --git a/openedx/core/djangoapps/content/block_structure/store.py b/openedx/core/djangoapps/content/block_structure/store.py index bb6359b9d3a3..a3c1a3f7f939 100644 --- a/openedx/core/djangoapps/content/block_structure/store.py +++ b/openedx/core/djangoapps/content/block_structure/store.py @@ -6,6 +6,7 @@ from logging import getLogger +from edx_django_utils import monitoring from openedx.core.lib.cache_utils import zpickle, zunpickle @@ -16,8 +17,6 @@ from .models import BlockStructureModel from .transformer_registry import TransformerRegistry -from edx_django_utils import monitoring - logger = getLogger(__name__) # pylint: disable=C0103 @@ -194,7 +193,7 @@ def _deserialize(self, serialized_data, root_block_usage_key): # Somehow failed to de-serialized the data, assume it's corrupt. bs_model = self._get_model(root_block_usage_key) logger.exception("BlockStructure: Failed to load data from cache for %s", bs_model) - raise BlockStructureNotFound(bs_model.data_usage_key) # lint-amnesty, pylint: disable=raise-missing-from + raise BlockStructureNotFound(bs_model.data_usage_key) # pylint: disable=raise-missing-from # noqa: B904 return BlockStructureFactory.create_new( root_block_usage_key, diff --git a/openedx/core/djangoapps/content/block_structure/tasks.py b/openedx/core/djangoapps/content/block_structure/tasks.py index 5796b8167b2b..4490650fe06e 100644 --- a/openedx/core/djangoapps/content/block_structure/tasks.py +++ b/openedx/core/djangoapps/content/block_structure/tasks.py @@ -11,10 +11,10 @@ from edxval.api import ValInternalError from lxml.etree import XMLSyntaxError from opaque_keys.edx.keys import CourseKey +from xblocks_contrib.problem.capa.responsetypes import LoncapaProblemError -from xmodule.capa.responsetypes import LoncapaProblemError from openedx.core.djangoapps.content.block_structure import api -from xmodule.modulestore.exceptions import ItemNotFoundError # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.exceptions import ItemNotFoundError # pylint: disable=wrong-import-order log = logging.getLogger('edx.celery.task') @@ -107,7 +107,7 @@ def _call_and_retry_if_needed(self, api_method, **kwargs): raise except RETRY_TASKS as exc: log.exception("%s encountered expected error, retrying.", self.__name__) - raise self.retry(kwargs=kwargs, exc=exc) + raise self.retry(kwargs=kwargs, exc=exc) # noqa: B904 except Exception as exc: log.exception( "BlockStructure: %s encountered unknown error in course %s, task_id %s. Retry #%d", @@ -116,4 +116,4 @@ def _call_and_retry_if_needed(self, api_method, **kwargs): self.request.id, self.request.retries, ) - raise self.retry(kwargs=kwargs, exc=exc) + raise self.retry(kwargs=kwargs, exc=exc) # noqa: B904 diff --git a/openedx/core/djangoapps/content/block_structure/tests/helpers.py b/openedx/core/djangoapps/content/block_structure/tests/helpers.py index df53b33d7b2e..30899a87f398 100644 --- a/openedx/core/djangoapps/content/block_structure/tests/helpers.py +++ b/openedx/core/djangoapps/content/block_structure/tests/helpers.py @@ -4,8 +4,8 @@ from contextlib import contextmanager -from uuid import uuid4 from unittest.mock import patch +from uuid import uuid4 from opaque_keys.edx.locator import BlockUsageLocator, CourseLocator @@ -62,7 +62,7 @@ def __getattr__(self, attr): try: return self.field_map[attr] except KeyError: - raise AttributeError # lint-amnesty, pylint: disable=raise-missing-from + raise AttributeError # pylint: disable=raise-missing-from # noqa: B904 def get_children(self): """ @@ -217,7 +217,7 @@ def clear_registered_transformers_cache(): """ Test helper to clear out any cached values of registered transformers. """ - TransformerRegistry.get_write_version_hash.cache.clear() # lint-amnesty, pylint: disable=no-member + TransformerRegistry.get_write_version_hash.cache.clear() # pylint: disable=no-member @contextmanager @@ -316,7 +316,7 @@ def assert_block_structure(self, block_structure, children_map, missing_blocks=N # Verify presence assert (self.block_key_factory(block_key) in block_structure) == (block_key not in missing_blocks),\ 'Expected presence in block_structure for block_key {} to match absence in missing_blocks.'\ - .format(str(block_key)) + .format(str(block_key)) # noqa: UP032 # Verify children if block_key not in missing_blocks: diff --git a/openedx/core/djangoapps/content/block_structure/tests/test_block_structure.py b/openedx/core/djangoapps/content/block_structure/tests/test_block_structure.py index 3152e762d127..02acf78c3a05 100644 --- a/openedx/core/djangoapps/content/block_structure/tests/test_block_structure.py +++ b/openedx/core/djangoapps/content/block_structure/tests/test_block_structure.py @@ -4,6 +4,7 @@ import itertools + # pylint: disable=protected-access from collections import namedtuple from copy import deepcopy @@ -36,11 +37,11 @@ def test_relations(self, children_map): # get_children for parent, children in enumerate(children_map): - self.assertSetEqual(set(block_structure.get_children(parent)), set(children)) + self.assertSetEqual(set(block_structure.get_children(parent)), set(children)) # noqa: PT009 # get_parents for child, parents in enumerate(self.get_parents_map(children_map)): - self.assertSetEqual(set(block_structure.get_parents(child)), set(parents)) + self.assertSetEqual(set(block_structure.get_parents(child)), set(parents)) # noqa: PT009 # __contains__ for node in range(len(children_map)): @@ -64,7 +65,7 @@ class TestNonVersionedTransformer(MockTransformer): block_structure = BlockStructureModulestoreData(root_block_usage_key=0) - with self.assertRaisesRegex(TransformerException, "Version attributes are not set"): + with self.assertRaisesRegex(TransformerException, "Version attributes are not set"): # noqa: PT027 block_structure._add_transformer(TestNonVersionedTransformer()) def test_transformer_data(self): diff --git a/openedx/core/djangoapps/content/block_structure/tests/test_factory.py b/openedx/core/djangoapps/content/block_structure/tests/test_factory.py index 92050eef24b8..e762d559af89 100644 --- a/openedx/core/djangoapps/content/block_structure/tests/test_factory.py +++ b/openedx/core/djangoapps/content/block_structure/tests/test_factory.py @@ -4,15 +4,15 @@ import pytest from django.test import TestCase - from opaque_keys.edx.keys import CourseKey from opaque_keys.edx.locator import BlockUsageLocator, CourseLocator + from xmodule.modulestore.exceptions import ItemNotFoundError from ..exceptions import BlockStructureNotFound from ..factory import BlockStructureFactory from ..store import BlockStructureStore -from .helpers import ChildrenMapTestMixin, MockCache, MockModulestoreFactory, MockXBlock, MockModulestore +from .helpers import ChildrenMapTestMixin, MockCache, MockModulestore, MockModulestoreFactory, MockXBlock class TestBlockStructureFactory(TestCase, ChildrenMapTestMixin): @@ -141,7 +141,7 @@ def test_from_modulestore_normalizes_locations_with_branch_info(self): for block_key in block_structure: # The block_key should equal its normalized version normalized_key = block_key.for_branch(None) - self.assertEqual( + self.assertEqual( # noqa: PT009 block_key, normalized_key, f"Block key {block_key} should be normalized (without branch info). " @@ -149,7 +149,7 @@ def test_from_modulestore_normalizes_locations_with_branch_info(self): ) # Verify it doesn't have branch information in the course_key if hasattr(block_key.course_key, 'branch'): - self.assertIsNone( + self.assertIsNone( # noqa: PT009 block_key.course_key.branch, f"Block key {block_key} should not have branch information" ) diff --git a/openedx/core/djangoapps/content/block_structure/tests/test_manager.py b/openedx/core/djangoapps/content/block_structure/tests/test_manager.py index 1c4060871c97..04a08accf6b3 100644 --- a/openedx/core/djangoapps/content/block_structure/tests/test_manager.py +++ b/openedx/core/djangoapps/content/block_structure/tests/test_manager.py @@ -2,9 +2,10 @@ Tests for manager.py """ -import pytest -import ddt from unittest.mock import MagicMock + +import ddt +import pytest from django.test import TestCase from xmodule.modulestore import ModuleStoreEnum @@ -19,7 +20,7 @@ MockModulestoreFactory, MockTransformer, UsageKeyFactoryMixin, - mock_registered_transformers + mock_registered_transformers, ) @@ -242,10 +243,10 @@ def mock_branch_setting(branch, course_key): self.bs_manager.get_collected() # Verify branch_setting was called with the correct parameters - self.assertEqual(len(branch_setting_calls), 1) + self.assertEqual(len(branch_setting_calls), 1) # noqa: PT009 branch, course_key = branch_setting_calls[0] - self.assertEqual(branch, ModuleStoreEnum.Branch.published_only) - self.assertEqual(course_key, self.block_key_factory(0).course_key) + self.assertEqual(branch, ModuleStoreEnum.Branch.published_only) # noqa: PT009 + self.assertEqual(course_key, self.block_key_factory(0).course_key) # noqa: PT009 finally: # Restore original method if it existed diff --git a/openedx/core/djangoapps/content/block_structure/tests/test_models.py b/openedx/core/djangoapps/content/block_structure/tests/test_models.py index 39bb68b09412..45a500e59a1a 100644 --- a/openedx/core/djangoapps/content/block_structure/tests/test_models.py +++ b/openedx/core/djangoapps/content/block_structure/tests/test_models.py @@ -4,8 +4,8 @@ # pylint: disable=protected-access import errno from itertools import product -from uuid import uuid4 from unittest.mock import Mock, patch +from uuid import uuid4 import ddt import pytest @@ -83,7 +83,7 @@ def test_update_or_create(self, mock_log): serialized_data = 'initial data' # shouldn't already exist - with pytest.raises(BlockStructureNotFound): + with pytest.raises(BlockStructureNotFound): # noqa: PT012 BlockStructureModel.get(self.usage_key) assert 'BlockStructure: Not found in table;' in mock_log.info.call_args[0][0] @@ -154,9 +154,9 @@ def test_prune_keep_count(self, prune_keep_count, num_prior_edits): def test_error_handling(self, error_raised_in_operation, errno_raised, message_raised, expected_error_raised, is_read_operation): bs_model, _ = BlockStructureModel.update_or_create('test data', **self.params) - with pytest.raises(expected_error_raised): + with pytest.raises(expected_error_raised): # noqa: PT012 with _storage_error_handling(bs_model, 'operation', is_read_operation): - if errno_raised is not None: # lint-amnesty, pylint: disable=no-else-raise + if errno_raised is not None: # pylint: disable=no-else-raise raise error_raised_in_operation(errno_raised, message_raised) else: raise error_raised_in_operation diff --git a/openedx/core/djangoapps/content/block_structure/tests/test_signals.py b/openedx/core/djangoapps/content/block_structure/tests/test_signals.py index af3587312530..68bf14669fee 100644 --- a/openedx/core/djangoapps/content/block_structure/tests/test_signals.py +++ b/openedx/core/djangoapps/content/block_structure/tests/test_signals.py @@ -3,9 +3,10 @@ """ from unittest.mock import patch -import pytest import ddt +import pytest from opaque_keys.edx.locator import CourseLocator, LibraryLocator + from xmodule.modulestore.exceptions import ItemNotFoundError from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase from xmodule.modulestore.tests.factories import CourseFactory diff --git a/openedx/core/djangoapps/content/block_structure/tests/test_store.py b/openedx/core/djangoapps/content/block_structure/tests/test_store.py index 63a02efa7af8..d3b9f93251b0 100644 --- a/openedx/core/djangoapps/content/block_structure/tests/test_store.py +++ b/openedx/core/djangoapps/content/block_structure/tests/test_store.py @@ -2,8 +2,8 @@ Tests for block_structure/cache.py """ -import pytest import ddt +import pytest from openedx.core.djangolib.testing.utils import CacheIsolationTestCase diff --git a/openedx/core/djangoapps/content/block_structure/tests/test_transformer_registry.py b/openedx/core/djangoapps/content/block_structure/tests/test_transformer_registry.py index 5e71e1da4406..4e999e09b8d8 100644 --- a/openedx/core/djangoapps/content/block_structure/tests/test_transformer_registry.py +++ b/openedx/core/djangoapps/content/block_structure/tests/test_transformer_registry.py @@ -15,21 +15,21 @@ class TestTransformer1(MockTransformer): """ 1st test instance of the MockTransformer that is registered. """ - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass class TestTransformer2(MockTransformer): """ 2nd test instance of the MockTransformer that is registered. """ - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass class UnregisteredTestTransformer3(MockTransformer): """ 3rd test instance of the MockTransformer that is not registered. """ - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass @ddt.ddt @@ -62,7 +62,7 @@ def tearDown(self): def test_find_unregistered(self, transformers, expected_unregistered): with mock_registered_transformers([TestTransformer1, TestTransformer2]): - self.assertSetEqual( + self.assertSetEqual( # noqa: PT009 TransformerRegistry.find_unregistered(transformers), set(expected_unregistered), ) diff --git a/openedx/core/djangoapps/content/block_structure/tests/test_transformers.py b/openedx/core/djangoapps/content/block_structure/tests/test_transformers.py index f7eb1efc811f..09b1578ea3c7 100644 --- a/openedx/core/djangoapps/content/block_structure/tests/test_transformers.py +++ b/openedx/core/djangoapps/content/block_structure/tests/test_transformers.py @@ -21,7 +21,7 @@ class UnregisteredTransformer(MockTransformer): """ Mock transformer that is not registered. """ - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass def setUp(self): super().setUp() diff --git a/openedx/core/djangoapps/content/block_structure/transformer.py b/openedx/core/djangoapps/content/block_structure/transformer.py index 1bcde62e0650..e1b0c9e5481f 100644 --- a/openedx/core/djangoapps/content/block_structure/transformer.py +++ b/openedx/core/djangoapps/content/block_structure/transformer.py @@ -4,8 +4,8 @@ """ -from abc import abstractmethod import functools +from abc import abstractmethod class BlockStructureTransformer: @@ -65,7 +65,7 @@ def name(cls): identify the transformer's cached data. So it should be unique and not conflict with other transformers. Consider using the same name that is used in the Transformer Registry. For example, - for Stevedore, it is specified in the setup.py file. + for Stevedore, it is specified in the package configuration (pyproject.toml). Once the transformer is in use and its data is cached, do not modify this name value without consideration of backward diff --git a/openedx/core/djangoapps/content/block_structure/transformers.py b/openedx/core/djangoapps/content/block_structure/transformers.py index d8a24c1551f3..0a7dab22a32f 100644 --- a/openedx/core/djangoapps/content/block_structure/transformers.py +++ b/openedx/core/djangoapps/content/block_structure/transformers.py @@ -97,7 +97,7 @@ def verify_versions(cls, block_structure): outdated_transformers.append(transformer) if outdated_transformers: - raise TransformerDataIncompatible( # lint-amnesty, pylint: disable=raising-format-tuple + raise TransformerDataIncompatible( # pylint: disable=raising-format-tuple "Collected Block Structure data for the following transformers is outdated: '%s'.", [(transformer.name(), transformer.READ_VERSION) for transformer in outdated_transformers], ) diff --git a/openedx/core/djangoapps/content/course_overviews/api.py b/openedx/core/djangoapps/content/course_overviews/api.py index 972469f83a1a..f800b1c58286 100644 --- a/openedx/core/djangoapps/content/course_overviews/api.py +++ b/openedx/core/djangoapps/content/course_overviews/api.py @@ -7,9 +7,7 @@ from openedx.core.djangoapps.catalog.api import get_course_run_details from openedx.core.djangoapps.content.course_overviews.models import CourseOverview -from openedx.core.djangoapps.content.course_overviews.serializers import ( - CourseOverviewBaseSerializer, -) +from openedx.core.djangoapps.content.course_overviews.serializers import CourseOverviewBaseSerializer log = logging.getLogger(__name__) diff --git a/openedx/core/djangoapps/content/course_overviews/apps.py b/openedx/core/djangoapps/content/course_overviews/apps.py index d7976cf219ba..2ae86e2accd8 100644 --- a/openedx/core/djangoapps/content/course_overviews/apps.py +++ b/openedx/core/djangoapps/content/course_overviews/apps.py @@ -16,4 +16,4 @@ class CourseOverviewsConfig(AppConfig): def ready(self): # Import signals to activate signal handler which invalidates # the CourseOverview cache every time a course is published. - from . import signals # lint-amnesty, pylint: disable=unused-import, unused-variable + from . import signals # pylint: disable=unused-import, unused-variable # noqa: F401 diff --git a/openedx/core/djangoapps/content/course_overviews/management/commands/backfill_history.py b/openedx/core/djangoapps/content/course_overviews/management/commands/backfill_history.py index cc5c75fbb92c..fe94e38b968f 100644 --- a/openedx/core/djangoapps/content/course_overviews/management/commands/backfill_history.py +++ b/openedx/core/djangoapps/content/course_overviews/management/commands/backfill_history.py @@ -6,10 +6,10 @@ import logging import os import time + from django.core.management.base import BaseCommand from django.db import connection, transaction - log = logging.getLogger(__name__) @@ -90,7 +90,7 @@ def handle(self, *args, **options): FROM information_schema.columns WHERE table_name='{}' ORDER BY ordinal_position - """.format(table) + """.format(table) # noqa: UP032 cursor.execute(query) columns = [column[0] for column in cursor.fetchall()] if exclude_column in columns: @@ -114,7 +114,7 @@ def handle(self, *args, **options): FROM {historical_table} WHERE ID in ({ids}) AND history_type='+' - """.format( + """.format( # noqa: UP032 historical_table=historical_table, ids=ids ) # noqa diff --git a/openedx/core/djangoapps/content/course_overviews/management/commands/generate_course_overview.py b/openedx/core/djangoapps/content/course_overviews/management/commands/generate_course_overview.py index c18ceef4782e..37cad0bd5213 100644 --- a/openedx/core/djangoapps/content/course_overviews/management/commands/generate_course_overview.py +++ b/openedx/core/djangoapps/content/course_overviews/management/commands/generate_course_overview.py @@ -12,7 +12,7 @@ DEFAULT_ALL_COURSES, DEFAULT_CHUNK_SIZE, DEFAULT_FORCE_UPDATE, - enqueue_async_course_overview_update_tasks + enqueue_async_course_overview_update_tasks, ) log = logging.getLogger(__name__) @@ -72,4 +72,4 @@ def handle(self, *args, **options): **kwargs ) except InvalidKeyError as exc: - raise CommandError('Invalid Course Key: ' + str(exc)) # lint-amnesty, pylint: disable=raise-missing-from + raise CommandError('Invalid Course Key: ' + str(exc)) # pylint: disable=raise-missing-from # noqa: B904 diff --git a/openedx/core/djangoapps/content/course_overviews/management/commands/simulate_publish.py b/openedx/core/djangoapps/content/course_overviews/management/commands/simulate_publish.py index efa36e7e227f..e50387ff7311 100644 --- a/openedx/core/djangoapps/content/course_overviews/management/commands/simulate_publish.py +++ b/openedx/core/djangoapps/content/course_overviews/management/commands/simulate_publish.py @@ -19,13 +19,14 @@ import textwrap import time -from django.core.management.base import BaseCommand, CommandError from django.conf import settings +from django.core.management.base import BaseCommand, CommandError from opaque_keys import InvalidKeyError from opaque_keys.edx.keys import CourseKey -from openedx.core.djangoapps.content.course_overviews.models import SimulateCoursePublishConfig + from lms.djangoapps.ccx.tasks import course_published_handler as ccx_receiver_fn -from xmodule.modulestore.django import SignalHandler, modulestore # lint-amnesty, pylint: disable=wrong-import-order +from openedx.core.djangoapps.content.course_overviews.models import SimulateCoursePublishConfig +from xmodule.modulestore.django import SignalHandler, modulestore # pylint: disable=wrong-import-order log = logging.getLogger('simulate_publish') @@ -193,7 +194,7 @@ def handle(self, *args, **options): if options['force_lms']: log.info("Forcing simulate_publish to run in LMS process.") else: - log.fatal( # lint-amnesty, pylint: disable=logging-not-lazy + log.fatal( # pylint: disable=logging-not-lazy "simulate_publish should be run as a CMS (Studio) " + "command, not %s (override with --force-lms).", settings.SERVICE_VARIANT @@ -244,7 +245,7 @@ def modify_receivers(self, receiver_names, skip_ccx): log.info("%d receivers specified: %s", len(receiver_names), ", ".join(receiver_names)) receiver_names_set = set(receiver_names) for receiver_fn in get_receiver_fns(): - if receiver_fn == ccx_receiver_fn and not skip_ccx: # lint-amnesty, pylint: disable=comparison-with-callable + if receiver_fn == ccx_receiver_fn and not skip_ccx: # pylint: disable=comparison-with-callable continue fn_name = name_from_fn(receiver_fn) if fn_name not in receiver_names_set: diff --git a/openedx/core/djangoapps/content/course_overviews/management/commands/tests/test_generate_course_overview.py b/openedx/core/djangoapps/content/course_overviews/management/commands/tests/test_generate_course_overview.py index 87bc5e4323c3..12247c7d3bfd 100644 --- a/openedx/core/djangoapps/content/course_overviews/management/commands/tests/test_generate_course_overview.py +++ b/openedx/core/djangoapps/content/course_overviews/management/commands/tests/test_generate_course_overview.py @@ -8,8 +8,10 @@ from openedx.core.djangoapps.content.course_overviews.management.commands import generate_course_overview from openedx.core.djangoapps.content.course_overviews.models import CourseOverview -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + ModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order class TestGenerateCourseOverview(ModuleStoreTestCase): diff --git a/openedx/core/djangoapps/content/course_overviews/management/commands/tests/test_simulate_publish.py b/openedx/core/djangoapps/content/course_overviews/management/commands/tests/test_simulate_publish.py index 1235559969c2..7ae7ffb601d4 100644 --- a/openedx/core/djangoapps/content/course_overviews/management/commands/tests/test_simulate_publish.py +++ b/openedx/core/djangoapps/content/course_overviews/management/commands/tests/test_simulate_publish.py @@ -9,10 +9,12 @@ import openedx.core.djangoapps.content.course_overviews.signals from openedx.core.djangoapps.content.course_overviews.management.commands.simulate_publish import Command, name_from_fn from openedx.core.djangoapps.content.course_overviews.models import CourseOverview, SimulateCoursePublishConfig -from xmodule.modulestore import ModuleStoreEnum # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.django import SwitchedSignal # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore import ModuleStoreEnum # pylint: disable=wrong-import-order +from xmodule.modulestore.django import SwitchedSignal # pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + SharedModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order LOGGER_NAME = 'simulate_publish' @@ -150,7 +152,7 @@ def sample_receiver_2(self, sender, course_key, **kwargs): # pylint: disable=un def test_args_from_database(self): """Test management command arguments injected from config model.""" # Nothing in the database, should default to disabled - with self.assertRaisesRegex(CommandError, 'SimulateCourseConfigPublish is disabled.*'): + with self.assertRaisesRegex(CommandError, 'SimulateCourseConfigPublish is disabled.*'): # noqa: PT027 call_command('simulate_publish', '--args-from-database') # Add a config diff --git a/openedx/core/djangoapps/content/course_overviews/migrations/0001_initial.py b/openedx/core/djangoapps/content/course_overviews/migrations/0001_initial.py index 4b6926999e46..bedf76d1ad27 100644 --- a/openedx/core/djangoapps/content/course_overviews/migrations/0001_initial.py +++ b/openedx/core/djangoapps/content/course_overviews/migrations/0001_initial.py @@ -1,6 +1,6 @@ -from django.db import migrations, models import django.utils.timezone import model_utils.fields +from django.db import migrations, models from opaque_keys.edx.django.models import CourseKeyField, UsageKeyField diff --git a/openedx/core/djangoapps/content/course_overviews/migrations/0003_courseoverviewgeneratedhistory.py b/openedx/core/djangoapps/content/course_overviews/migrations/0003_courseoverviewgeneratedhistory.py index c6c5a001081e..77609054991e 100644 --- a/openedx/core/djangoapps/content/course_overviews/migrations/0003_courseoverviewgeneratedhistory.py +++ b/openedx/core/djangoapps/content/course_overviews/migrations/0003_courseoverviewgeneratedhistory.py @@ -1,6 +1,6 @@ -from django.db import migrations, models import django.utils.timezone import model_utils.fields +from django.db import migrations, models class Migration(migrations.Migration): diff --git a/openedx/core/djangoapps/content/course_overviews/migrations/0006_courseoverviewimageset.py b/openedx/core/djangoapps/content/course_overviews/migrations/0006_courseoverviewimageset.py index b8cc1577aaea..ade8bc1c8c3d 100644 --- a/openedx/core/djangoapps/content/course_overviews/migrations/0006_courseoverviewimageset.py +++ b/openedx/core/djangoapps/content/course_overviews/migrations/0006_courseoverviewimageset.py @@ -1,6 +1,6 @@ -from django.db import migrations, models import django.utils.timezone import model_utils.fields +from django.db import migrations, models class Migration(migrations.Migration): diff --git a/openedx/core/djangoapps/content/course_overviews/migrations/0007_courseoverviewimageconfig.py b/openedx/core/djangoapps/content/course_overviews/migrations/0007_courseoverviewimageconfig.py index ed69e2ce4d27..63df02140af4 100644 --- a/openedx/core/djangoapps/content/course_overviews/migrations/0007_courseoverviewimageconfig.py +++ b/openedx/core/djangoapps/content/course_overviews/migrations/0007_courseoverviewimageconfig.py @@ -1,6 +1,6 @@ -from django.db import migrations, models import django.db.models.deletion from django.conf import settings +from django.db import migrations, models class Migration(migrations.Migration): diff --git a/openedx/core/djangoapps/content/course_overviews/migrations/0009_readd_facebook_url.py b/openedx/core/djangoapps/content/course_overviews/migrations/0009_readd_facebook_url.py index dc99d79731ef..533cc732bb98 100644 --- a/openedx/core/djangoapps/content/course_overviews/migrations/0009_readd_facebook_url.py +++ b/openedx/core/djangoapps/content/course_overviews/migrations/0009_readd_facebook_url.py @@ -1,45 +1,43 @@ -from django.db import migrations, models, connection +from django.db import connection, migrations, models -def table_description(): - """Handle Mysql/Pg vs Sqlite""" - # django's mysql/pg introspection.get_table_description tries to select * - # from table and fails during initial migrations from scratch. - # sqlite does not have this failure, so we can use the API. - # For not-sqlite, query information-schema directly with code lifted - # from the internals of django.db.backends.mysql.introspection.py +def table_description(): + """Handle MySQL/Postgres vs SQLite compatibility for table introspection""" if connection.vendor == 'sqlite': fields = connection.introspection.get_table_description(connection.cursor(), 'course_overviews_courseoverview') return [f.name for f in fields] else: cursor = connection.cursor() - cursor.execute(""" - SELECT column_name - FROM information_schema.columns - WHERE table_name = 'course_overviews_courseoverview' AND table_schema = DATABASE()""") + if connection.vendor == 'mysql': + cursor.execute(""" + SELECT column_name + FROM information_schema.columns + WHERE table_name = 'course_overviews_courseoverview' AND table_schema = DATABASE() + """) + elif connection.vendor == 'postgresql': + cursor.execute(""" + SELECT column_name + FROM information_schema.columns + WHERE table_name = 'course_overviews_courseoverview' AND table_catalog = current_database() + """) rows = cursor.fetchall() return [r[0] for r in rows] - class Migration(migrations.Migration): dependencies = [ ('course_overviews', '0008_remove_courseoverview_facebook_url'), ] - # An original version of 0008 removed the facebook_url field We need to - # handle the case where our noop 0008 ran AND the case where the original - # 0008 ran. We do that by using the standard information_schema to find out - # what columns exist. _meta is unavailable as the column has already been - # removed from the model operations = [] fields = table_description() - # during a migration from scratch, fields will be empty, but we do not want to add - # an additional facebook_url + # Ensure 'facebook_url' is added if it does not exist in the table if fields and not any(f == 'facebook_url' for f in fields): - operations += migrations.AddField( - model_name='courseoverview', - name='facebook_url', - field=models.TextField(null=True), - ), + operations.append( + migrations.AddField( + model_name='courseoverview', + name='facebook_url', + field=models.TextField(null=True), + ) + ) diff --git a/openedx/core/djangoapps/content/course_overviews/migrations/0015_historicalcourseoverview.py b/openedx/core/djangoapps/content/course_overviews/migrations/0015_historicalcourseoverview.py index ef41464fa91f..418de6514a1b 100644 --- a/openedx/core/djangoapps/content/course_overviews/migrations/0015_historicalcourseoverview.py +++ b/openedx/core/djangoapps/content/course_overviews/migrations/0015_historicalcourseoverview.py @@ -1,13 +1,13 @@ # Generated by Django 1.11.20 on 2019-05-30 21:13 -from django.conf import settings -from django.db import migrations, models import django.db.models.deletion import django.utils.timezone import model_utils.fields import opaque_keys.edx.django.models import simple_history.models +from django.conf import settings +from django.db import migrations, models class Migration(migrations.Migration): diff --git a/openedx/core/djangoapps/content/course_overviews/migrations/0016_simulatecoursepublishconfig.py b/openedx/core/djangoapps/content/course_overviews/migrations/0016_simulatecoursepublishconfig.py index ad802b13463f..692307d79f80 100644 --- a/openedx/core/djangoapps/content/course_overviews/migrations/0016_simulatecoursepublishconfig.py +++ b/openedx/core/djangoapps/content/course_overviews/migrations/0016_simulatecoursepublishconfig.py @@ -1,9 +1,9 @@ # Generated by Django 1.11.23 on 2019-09-16 10:45 +import django.db.models.deletion from django.conf import settings from django.db import migrations, models -import django.db.models.deletion class Migration(migrations.Migration): diff --git a/openedx/core/djangoapps/content/course_overviews/migrations/0030_backfill_new_catalog_courseruns.py b/openedx/core/djangoapps/content/course_overviews/migrations/0030_backfill_new_catalog_courseruns.py new file mode 100644 index 000000000000..f12a6f2c391d --- /dev/null +++ b/openedx/core/djangoapps/content/course_overviews/migrations/0030_backfill_new_catalog_courseruns.py @@ -0,0 +1,139 @@ +""" +Data migration to populate the new CourseRun and CatalogCourse models. +""" + +# Generated by Django 5.2.11 on 2026-02-13 21:47 +import logging + +from django.conf import settings +from django.db import migrations +from organizations.api import ensure_organization +from organizations.api import exceptions as org_exceptions + +log = logging.getLogger(__name__) + +# https://github.com/openedx/openedx-platform/issues/38036 +NORMALIZE_LANGUAGE_CODES = { + "zh-hans": "zh-cn", + "zh-hant": "zh-hk", + "ca@valencia": "ca-es-valencia", +} + + +def backfill_openedx_catalog(apps, schema_editor) -> None: + """ + Populate the new CourseRun and CatalogCourse models. + """ + CourseOverview = apps.get_model("course_overviews", "CourseOverview") + CatalogCourse = apps.get_model("openedx_catalog", "CatalogCourse") + CourseRun = apps.get_model("openedx_catalog", "CourseRun") + + created_catalog_course_ids: set[int] = set() + all_course_runs = CourseOverview.objects.order_by("-created") + for course_overview in all_course_runs: + course_key = course_overview.id + org_code: str = course_key.org + course_code: str = course_key.course + run_code: str = course_key.run + + # Ensure that the Organization exists. + try: + org_data = ensure_organization(org_code) + except org_exceptions.InvalidOrganizationException as exc: + # Note: IFF the org exists among the modulestore courses but not in the Organizations database table, + # and if auto-create is disabled (it's enabled by default), this will raise InvalidOrganizationException. It + # would be up to the operator to decide how they want to resolve that. + raise ValueError( + f'The organization short code "{org_code}" exists in modulestore ({course_key}) but ' + "not the Organizations table, and auto-creating organizations is disabled. You can resolve this by " + "creating the Organization manually (e.g. from the Django admin) or turning on auto-creation. " + "You can set active=False to prevent this Organization from being used other than for historical data. " + ) from exc + if org_data["short_name"] != org_code: + # On most installations, the 'short_name' database column is case insensitive (unfortunately) + log.warning( + 'The course with ID "%s" does not match its Organization.short_name "%s"', + course_key, + org_data["short_name"], + ) + + # Fetch the CourseOverview if it exists + try: + course_overview = CourseOverview.objects.get(id=course_key) + except CourseOverview.DoesNotExist: + course_overview = None # Course exists in modulestore but details aren't cached into CourseOverview yet + title: str = (course_overview.display_name if course_overview else None) or course_code + + # Determine the course language. + # Note that in Studio, the options for course language generally came from the ALL_LANGUAGES setting, which is + # mostly two-letter language codes with no locale, except it uses "zh_HANS" for Mandarin and "zh_HANT" for + # Cantonese. We normalize those to "zh-cn" and "zh-hk" for consistency with our platform UI languages / + # Transifex, but you can still access the "old" version using the CatalogCourse.language_short + # getter/setter for backwards compatbility. See https://github.com/openedx/openedx-platform/issues/38036 + language = settings.LANGUAGE_CODE + if course_overview and course_overview.language: + language = course_overview.language.lower() + language = language.replace("_", "-") # Ensure we use hyphens for consistency (`en-us` not `en_us`) + # Normalize this language code. The previous/non-normalized code will still be available via the + # "language_short" property for backwards compatibility. + language = NORMALIZE_LANGUAGE_CODES.get(language, language) + if len(language) > 2 and language[2] != "-": + # This seems like an invalid value; revert to the default: + log.warning( + 'The course with ID "%s" has invalid language "%s" - using default language "%s" instead.', + course_key, + language, + settings.LANGUAGE_CODE, + ) + language = settings.LANGUAGE_CODE + + # Ensure that the CatalogCourse exists. + cc, cc_created = CatalogCourse.objects.get_or_create( + org_id=org_data["id"], + course_code=course_code, + defaults={ + # The default title for the catalog course will be the same name as the newest run, since we iterate + # over "all_course_runs" in "-created" order. + "title": title, + "language": language, + }, + ) + if cc_created: + created_catalog_course_ids.add(cc.pk) + + if cc.course_code != course_code: + raise ValueError( + f"The course {course_key} exists in modulestore with a different capitalization of its " + f'course code compared to other instances of the same run ("{course_code}" vs "{cc.course_code}"). ' + "This really should not happen. To fix it, delete the inconsistent course runs (!). " + ) + + # Create the CourseRun + new_run, run_created = CourseRun.objects.get_or_create( + catalog_course=cc, + run_code=run_code, + course_key=course_key, + defaults={"title": title}, + ) + + # Correct the "created" timestamp. Since it has auto_now_add=True, we can't set its value except using update() + # The CourseOverview should have the "created" date unless it's missing or the course was created before + # the CourseOverview model existed. In any case, it should be good enough. Otherwise use the default (now). + if course_overview: + if course_overview.created < cc.created and cc.pk in created_catalog_course_ids: + # Use the 'created' date from the oldest course run that we process. + CatalogCourse.objects.filter(pk=cc.pk).update(created=course_overview.created) + if run_created: + CourseRun.objects.filter(pk=new_run.pk).update(created=course_overview.created) + + +class Migration(migrations.Migration): + dependencies = [ + ("openedx_catalog", "0001_initial"), + ("course_overviews", "0029_alter_historicalcourseoverview_options"), + ("split_modulestore_django", "0003_alter_historicalsplitmodulestorecourseindex_options"), + ] + + operations = [ + migrations.RunPython(backfill_openedx_catalog, reverse_code=migrations.RunPython.noop), + ] diff --git a/openedx/core/djangoapps/content/course_overviews/models.py b/openedx/core/djangoapps/content/course_overviews/models.py index c5b453f82e6c..3115999a87fb 100644 --- a/openedx/core/djangoapps/content/course_overviews/models.py +++ b/openedx/core/djangoapps/content/course_overviews/models.py @@ -14,26 +14,25 @@ from django.conf import settings from django.db import models, transaction from django.db.models import Q -from django.db.models.signals import post_save, post_delete +from django.db.models.signals import post_delete, post_save from django.db.utils import IntegrityError from django.template import defaultfilters - from django.utils.functional import cached_property from model_utils.models import TimeStampedModel from opaque_keys.edx.django.models import CourseKeyField, UsageKeyField from simple_history.models import HistoricalRecords +from common.djangoapps.static_replace.models import AssetBaseUrlConfig from lms.djangoapps.courseware.model_data import FieldDataCache from openedx.core.djangoapps.catalog.models import CatalogIntegration from openedx.core.djangoapps.lang_pref.api import get_closest_released_language from openedx.core.djangoapps.models.course_details import CourseDetails -from openedx.core.lib.cache_utils import request_cached, RequestCache -from common.djangoapps.static_replace.models import AssetBaseUrlConfig -from xmodule import block_metadata_utils, course_metadata_utils # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.course_block import DEFAULT_START_DATE, CourseBlock # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.error_block import ErrorBlock # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.tabs import CourseTab # lint-amnesty, pylint: disable=wrong-import-order +from openedx.core.lib.cache_utils import RequestCache, request_cached +from xmodule import block_metadata_utils, course_metadata_utils # pylint: disable=wrong-import-order +from xmodule.course_block import DEFAULT_START_DATE, CourseBlock # pylint: disable=wrong-import-order +from xmodule.error_block import ErrorBlock # pylint: disable=wrong-import-order +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order +from xmodule.tabs import CourseTab # pylint: disable=wrong-import-order log = logging.getLogger(__name__) @@ -73,7 +72,7 @@ class Meta: id = CourseKeyField(db_index=True, primary_key=True, max_length=255) _location = UsageKeyField(max_length=255) org = models.TextField(max_length=255, default='outdated_entry') - display_name = models.TextField(null=True) + display_name = models.TextField(null=True) # noqa: DJ001 display_number_with_default = models.TextField() display_org_with_default = models.TextField() @@ -86,18 +85,18 @@ class Meta: start_date = models.DateTimeField(null=True) end_date = models.DateTimeField(null=True) - advertised_start = models.TextField(null=True) + advertised_start = models.TextField(null=True) # noqa: DJ001 announcement = models.DateTimeField(null=True) # URLs # Not allowing null per django convention; not sure why many TextFields in this model do allow null banner_image_url = models.TextField() course_image_url = models.TextField() - social_sharing_url = models.TextField(null=True) - end_of_course_survey_url = models.TextField(null=True) + social_sharing_url = models.TextField(null=True) # noqa: DJ001 + end_of_course_survey_url = models.TextField(null=True) # noqa: DJ001 # Certification data - certificates_display_behavior = models.TextField(null=True) + certificates_display_behavior = models.TextField(null=True) # noqa: DJ001 certificates_show_before_end = models.BooleanField(default=False) cert_html_view_enabled = models.BooleanField(default=False) has_any_active_web_certificate = models.BooleanField(default=False) @@ -117,17 +116,17 @@ class Meta: # Enrollment details enrollment_start = models.DateTimeField(null=True) enrollment_end = models.DateTimeField(null=True) - enrollment_domain = models.TextField(null=True) + enrollment_domain = models.TextField(null=True) # noqa: DJ001 invitation_only = models.BooleanField(default=False) max_student_enrollments_allowed = models.IntegerField(null=True) # Catalog information - catalog_visibility = models.TextField(null=True) - short_description = models.TextField(null=True) - course_video_url = models.TextField(null=True) - effort = models.TextField(null=True) + catalog_visibility = models.TextField(null=True) # noqa: DJ001 + short_description = models.TextField(null=True) # noqa: DJ001 + course_video_url = models.TextField(null=True) # noqa: DJ001 + effort = models.TextField(null=True) # noqa: DJ001 self_paced = models.BooleanField(default=False) - marketing_url = models.TextField(null=True) + marketing_url = models.TextField(null=True) # noqa: DJ001 eligible_for_financial_aid = models.BooleanField(default=True) # Course highlight info, used to guide course update emails @@ -135,8 +134,8 @@ class Meta: # Proctoring enable_proctored_exams = models.BooleanField(default=False) - proctoring_provider = models.TextField(null=True) - proctoring_escalation_email = models.TextField(null=True) + proctoring_provider = models.TextField(null=True) # noqa: DJ001 + proctoring_escalation_email = models.TextField(null=True) # noqa: DJ001 allow_proctoring_opt_out = models.BooleanField(default=False) # Entrance Exam information @@ -147,14 +146,14 @@ class Meta: # Open Response Assessment configuration force_on_flexible_peer_openassessments = models.BooleanField(default=False) - external_id = models.CharField(max_length=128, null=True, blank=True) + external_id = models.CharField(max_length=128, null=True, blank=True) # noqa: DJ001 - language = models.TextField(null=True) + language = models.TextField(null=True) # noqa: DJ001 history = HistoricalRecords() @classmethod - def _create_or_update(cls, course): # lint-amnesty, pylint: disable=too-many-statements + def _create_or_update(cls, course): # pylint: disable=too-many-statements """ Creates or updates a CourseOverview object from a CourseBlock. @@ -207,7 +206,7 @@ def _create_or_update(cls, course): # lint-amnesty, pylint: disable=too-many-st course_overview.version = cls.VERSION course_overview.id = course.id - course_overview._location = course.location # lint-amnesty, pylint: disable=protected-access + course_overview._location = course.location # pylint: disable=protected-access course_overview.org = course.location.org course_overview.display_name = display_name course_overview.display_number_with_default = course.display_number_with_default @@ -240,7 +239,7 @@ def _create_or_update(cls, course): # lint-amnesty, pylint: disable=too-many-st course_overview.days_early_for_beta = course.days_early_for_beta course_overview.mobile_available = course.mobile_available course_overview.visible_to_staff_only = course.visible_to_staff_only - course_overview._pre_requisite_courses_json = json.dumps(course.pre_requisite_courses) # lint-amnesty, pylint: disable=protected-access + course_overview._pre_requisite_courses_json = json.dumps(course.pre_requisite_courses) # pylint: disable=protected-access course_overview.enrollment_start = course.enrollment_start course_overview.enrollment_end = course.enrollment_end @@ -360,7 +359,7 @@ def load_from_module_store(cls, course_id): return course_overview elif course is not None: - raise OSError( # lint-amnesty, pylint: disable=raising-format-tuple + raise OSError( # pylint: disable=raising-format-tuple "Error while loading CourseOverview for course {} " "from the module store: {}", str(course_id), @@ -478,9 +477,9 @@ def clean_id(self, padding_char='='): return course_metadata_utils.clean_course_key(self.location.course_key, padding_char) @property - def location(self): + def usage_key(self): """ - Returns the UsageKey of this course. + Returns the UsageKey of the root block of this course. UsageKeyField has a strange behavior where it fails to parse the "run" of a course out of the serialized form of a Mongo Draft UsageKey. This @@ -491,6 +490,13 @@ def location(self): self._location = self._location.map_into_course(self.id) return self._location + @property + def location(self): + """ + The old name for `usage_key`. This method is analogous to `XModuleMixin.location`. + """ + return self.usage_key + @property def number(self): """ @@ -506,9 +512,9 @@ def number(self): @property def url_name(self): """ - Returns this course's URL name. + The old name for `block_id`. This method is analogous to `XModuleMixin.url_name`. """ - return block_metadata_utils.url_name_for_block(self) + return self.usage_key.block_id @property def display_name_with_default(self): @@ -639,7 +645,7 @@ def pre_requisite_courses(self, value): cause a lot of issues. These should not be mutable after construction, so for now we just eat this. """ - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass @classmethod def update_select_courses(cls, course_keys, force_update=False): @@ -998,11 +1004,11 @@ class CourseOverviewTab(models.Model): """ tab_id = models.CharField(max_length=50) course_overview = models.ForeignKey(CourseOverview, db_index=True, related_name="tab_set", on_delete=models.CASCADE) - type = models.CharField(max_length=50, null=True) - name = models.TextField(null=True) + type = models.CharField(max_length=50, null=True) # noqa: DJ001 + name = models.TextField(null=True) # noqa: DJ001 course_staff_only = models.BooleanField(default=False) - url_slug = models.TextField(null=True) - link = models.TextField(null=True) + url_slug = models.TextField(null=True) # noqa: DJ001 + link = models.TextField(null=True) # noqa: DJ001 is_hidden = models.BooleanField(default=False) def __str__(self): @@ -1146,7 +1152,7 @@ def create(cls, course_overview, course=None): pass def __str__(self): - return "CourseOverviewImageSet({}, small_url={}, large_url={})".format( + return "CourseOverviewImageSet({}, small_url={}, large_url={})".format( # noqa: UP032 self.course_overview_id, self.small_url, self.large_url ) @@ -1181,7 +1187,7 @@ def large(self): return (self.large_width, self.large_height) def __str__(self): - return "CourseOverviewImageConfig(enabled={}, small={}, large={})".format( + return "CourseOverviewImageConfig(enabled={}, small={}, large={})".format( # noqa: UP032 self.enabled, self.small, self.large ) diff --git a/openedx/core/djangoapps/content/course_overviews/signals.py b/openedx/core/djangoapps/content/course_overviews/signals.py index 4ae2f4bf0f8a..959b8d1efee0 100644 --- a/openedx/core/djangoapps/content/course_overviews/signals.py +++ b/openedx/core/djangoapps/content/course_overviews/signals.py @@ -2,13 +2,14 @@ Signal handler for invalidating cached course overviews """ - import logging from django.db import transaction from django.db.models.signals import post_save from django.dispatch import Signal from django.dispatch.dispatcher import receiver +from openedx_catalog import api as catalog_api +from openedx_catalog.models_api import CourseRun from openedx.core.djangoapps.signals.signals import COURSE_CERT_DATE_CHANGE from xmodule.data import CertificatesDisplayBehaviors @@ -33,6 +34,8 @@ def _listen_for_course_publish(sender, course_key, **kwargs): # pylint: disable """ Catches the signal that a course has been published in Studio and updates the corresponding CourseOverview cache entry. + + Also sync course data to the openedx_catalog CourseRun model. """ try: previous_course_overview = CourseOverview.objects.get(id=course_key) @@ -41,6 +44,51 @@ def _listen_for_course_publish(sender, course_key, **kwargs): # pylint: disable updated_course_overview = CourseOverview.load_from_module_store(course_key) _check_for_course_changes(previous_course_overview, updated_course_overview) + # Currently, SplitModulestoreCourseIndex is the ultimate source of truth for + # which courses exist. When a course is published, we sync that data to + # CourseOverview, and from CourseOverview to CourseRun. + + # In the future, CourseRun will be the "source of truth" and each CourseRun + # may optionally point to content and get synced to CourseOverview. + + # Ensure a CourseRun exists for this course + try: + course_run = catalog_api.get_course_run(course_key) + except CourseRun.DoesNotExist: + # Presumably this is a newly-created course. Create the CourseRun. + course_run = catalog_api.create_course_run_for_modulestore_course_with( + course_key=course_key, + title=updated_course_overview.display_name, + language_short=updated_course_overview.language, + ) + + # Keep the CourseRun up to date as the course is edited: + if updated_course_overview.display_name != course_run.title: + catalog_api.sync_course_run_details(course_key, title=updated_course_overview.display_name) + # If this course is the only run in the CatalogCourse, should we update the title of + # the CatalogCourse to match the run's new title? Currently the only way to edit the name of + # a CatalogCourse is via the Django admin. But it's also not used anywhere yet. + + if ( + updated_course_overview.language + and updated_course_overview.language != course_run.catalog_course.language_short + ): + if course_run.catalog_course.runs.count() == 1: + # This is the only run in this CatalogCourse. Update the language of the CatalogCourse + catalog_api.update_catalog_course( + course_run.catalog_course, + language_short=updated_course_overview.language, + ) + else: + LOG.warning( + 'Course run "%s" language "%s" does not match its catalog course language, "%s"', + str(course_key), + updated_course_overview.language, + course_run.catalog_course.language_short, + ) + + # In the future, this will also sync schedule and other metadata to the CourseRun's related models + @receiver(SignalHandler.course_deleted) def _listen_for_course_delete(sender, course_key, **kwargs): # pylint: disable=unused-argument @@ -56,10 +104,20 @@ def _listen_for_course_delete(sender, course_key, **kwargs): # pylint: disable= sender=None, courserun_key=courserun_key, ) + # Delete the openedx_catalog CourseRun to keep it in sync: + try: + course_run_obj = catalog_api.get_course_run(course_key) + except CourseRun.DoesNotExist: + pass + else: + catalog_course = course_run_obj.catalog_course + catalog_api.delete_course_run(course_key) + if catalog_course.runs.count() == 0: + catalog_api.delete_catalog_course(catalog_course) @receiver(post_save, sender=CourseOverview) -def trigger_import_course_details_signal(sender, instance, created, **kwargs): # lint-amnesty, pylint: disable=unused-argument +def trigger_import_course_details_signal(sender, instance, created, **kwargs): # pylint: disable=unused-argument """ Triggers the `IMPORT_COURSE_DETAILS` signal which will be handled in `federated_content_connector` plugin """ diff --git a/openedx/core/djangoapps/content/course_overviews/tasks.py b/openedx/core/djangoapps/content/course_overviews/tasks.py index 4cdf1cd6ef08..155a2011d40c 100644 --- a/openedx/core/djangoapps/content/course_overviews/tasks.py +++ b/openedx/core/djangoapps/content/course_overviews/tasks.py @@ -1,4 +1,4 @@ -# lint-amnesty, pylint: disable=missing-module-docstring +# pylint: disable=missing-module-docstring import logging @@ -9,7 +9,7 @@ from opaque_keys.edx.keys import CourseKey from openedx.core.djangoapps.content.course_overviews.models import CourseOverview -from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order log = logging.getLogger(__name__) @@ -25,7 +25,7 @@ def chunks(sequence, chunk_size): return (sequence[index: index + chunk_size] for index in range(0, len(sequence), chunk_size)) -def _task_options(routing_key): # lint-amnesty, pylint: disable=missing-function-docstring +def _task_options(routing_key): # pylint: disable=missing-function-docstring task_options = {} if getattr(settings, 'HIGH_MEM_QUEUE', None): task_options['routing_key'] = settings.HIGH_MEM_QUEUE @@ -34,7 +34,7 @@ def _task_options(routing_key): # lint-amnesty, pylint: disable=missing-functio return task_options -def enqueue_async_course_overview_update_tasks( # lint-amnesty, pylint: disable=missing-function-docstring +def enqueue_async_course_overview_update_tasks( # pylint: disable=missing-function-docstring course_ids, all_courses=False, force_update=False, diff --git a/openedx/core/djangoapps/content/course_overviews/tests/factories.py b/openedx/core/djangoapps/content/course_overviews/tests/factories.py index b7c1ca1b151a..a0e4ae334fcf 100644 --- a/openedx/core/djangoapps/content/course_overviews/tests/factories.py +++ b/openedx/core/djangoapps/content/course_overviews/tests/factories.py @@ -1,17 +1,17 @@ -# lint-amnesty, pylint: disable=missing-module-docstring +# pylint: disable=missing-module-docstring -from datetime import timedelta import json +from datetime import timedelta -from django.utils import timezone import factory +from django.utils import timezone from factory.django import DjangoModelFactory from opaque_keys.edx.locator import CourseLocator from ..models import CourseOverview -class CourseOverviewFactory(DjangoModelFactory): # lint-amnesty, pylint: disable=missing-class-docstring +class CourseOverviewFactory(DjangoModelFactory): # pylint: disable=missing-class-docstring class Meta: model = CourseOverview django_get_or_create = ('id', ) diff --git a/openedx/core/djangoapps/content/course_overviews/tests/test_api.py b/openedx/core/djangoapps/content/course_overviews/tests/test_api.py index 568322f82d98..ece6cf50df8e 100644 --- a/openedx/core/djangoapps/content/course_overviews/tests/test_api.py +++ b/openedx/core/djangoapps/content/course_overviews/tests/test_api.py @@ -7,7 +7,6 @@ from opaque_keys.edx.keys import CourseKey from openedx.core.djangoapps.catalog.tests.factories import CourseRunFactory -from openedx.core.djangoapps.content.course_overviews.models import CourseOverview from openedx.core.djangoapps.content.course_overviews.api import ( get_course_overview_or_404, get_course_overview_or_none, @@ -15,8 +14,11 @@ get_course_overviews_from_ids, get_pseudo_course_overview, ) +from openedx.core.djangoapps.content.course_overviews.models import CourseOverview from openedx.core.djangoapps.content.course_overviews.tests.factories import CourseOverviewFactory -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + ModuleStoreTestCase, # pylint: disable=wrong-import-order +) class TestCourseOverviewsApi(ModuleStoreTestCase): @@ -68,7 +70,7 @@ def test_get_course_overview_or_404_missing(self): Test for `test_get_course_overview_or_404` function when the overview does not exist. """ course_run_key = CourseKey.from_string('course-v1:coping+with+deletions') - with self.assertRaises(Http404): + with self.assertRaises(Http404): # noqa: PT027 get_course_overview_or_404(course_run_key) def test_get_course_overview_from_ids(self): diff --git a/openedx/core/djangoapps/content/course_overviews/tests/test_course_overviews.py b/openedx/core/djangoapps/content/course_overviews/tests/test_course_overviews.py index dd43dcaee88b..acf4a2814963 100644 --- a/openedx/core/djangoapps/content/course_overviews/tests/test_course_overviews.py +++ b/openedx/core/djangoapps/content/course_overviews/tests/test_course_overviews.py @@ -1,18 +1,17 @@ """ Tests for course_overviews app. """ +import datetime # pylint: disable=wrong-import-order +import itertools # pylint: disable=wrong-import-order import json +import math # pylint: disable=wrong-import-order import os from io import BytesIO from unittest import mock - -import pytest -import datetime # lint-amnesty, pylint: disable=wrong-import-order -import itertools # lint-amnesty, pylint: disable=wrong-import-order -import math # lint-amnesty, pylint: disable=wrong-import-order from zoneinfo import ZoneInfo import ddt +import pytest from django.conf import settings from django.db.utils import IntegrityError from django.test.utils import override_settings @@ -20,27 +19,32 @@ from opaque_keys.edx.keys import CourseKey from PIL import Image +from common.djangoapps.static_replace.models import AssetBaseUrlConfig from lms.djangoapps.certificates.api import get_active_web_certificate from openedx.core.djangoapps.catalog.tests.mixins import CatalogIntegrationMixin from openedx.core.djangoapps.dark_lang.models import DarkLangConfig from openedx.core.djangoapps.models.course_details import CourseDetails from openedx.core.djangolib.testing.utils import CacheIsolationTestCase from openedx.core.lib.courses import course_image_url -from common.djangoapps.static_replace.models import AssetBaseUrlConfig -from xmodule.assetstore.assetmgr import AssetManager # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.contentstore.content import StaticContent # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.contentstore.django import contentstore # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.course_metadata_utils import DEFAULT_START_DATE # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.course_block import ( # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.assetstore.assetmgr import AssetManager # pylint: disable=wrong-import-order +from xmodule.contentstore.content import StaticContent # pylint: disable=wrong-import-order +from xmodule.contentstore.django import contentstore # pylint: disable=wrong-import-order +from xmodule.course_block import ( # pylint: disable=wrong-import-order CATALOG_VISIBILITY_ABOUT, CATALOG_VISIBILITY_CATALOG_AND_ABOUT, - CATALOG_VISIBILITY_NONE + CATALOG_VISIBILITY_NONE, +) +from xmodule.course_metadata_utils import DEFAULT_START_DATE # pylint: disable=wrong-import-order +from xmodule.error_block import ErrorBlock # pylint: disable=wrong-import-order +from xmodule.modulestore import ModuleStoreEnum # pylint: disable=wrong-import-order +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + ModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import ( # pylint: disable=wrong-import-order + CourseFactory, + check_mongo_calls_range, ) -from xmodule.error_block import ErrorBlock # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore import ModuleStoreEnum # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory, check_mongo_calls_range # lint-amnesty, pylint: disable=wrong-import-order from ..models import CourseOverview, CourseOverviewImageConfig, CourseOverviewImageSet, CourseOverviewTab from .factories import CourseOverviewFactory @@ -358,7 +362,7 @@ def test_get_errored_course(self): # This mock makes it so when the module store tries to load course data, # an exception is thrown, which causes get_course to return an ErrorBlock, # which causes get_from_id to raise an IOError. - with pytest.raises(IOError): + with pytest.raises(IOError): # noqa: PT011 CourseOverview.load_from_module_store(self.store.make_course_key('Non', 'Existent', 'Course')) def test_malformed_grading_policy(self): @@ -371,7 +375,7 @@ def test_malformed_grading_policy(self): """ course = CourseFactory.create() course._grading_policy['GRADE_CUTOFFS'] = {} # pylint: disable=protected-access - with pytest.raises(ValueError): + with pytest.raises(ValueError): # noqa: PT011 __ = course.lowest_passing_grade course_overview = CourseOverview._create_or_update(course) # pylint: disable=protected-access assert course_overview.lowest_passing_grade is None @@ -609,7 +613,7 @@ def test_mongo_course_overview_generation(self): """ Tests that course_overview can be generated for old Mongo course. """ - store = modulestore()._get_modulestore_by_type(ModuleStoreEnum.Type.mongo) # lint-amnesty, pylint: disable=protected-access + store = modulestore()._get_modulestore_by_type(ModuleStoreEnum.Type.mongo) # pylint: disable=protected-access file_path = os.path.join(os.path.dirname(os.path.abspath(__file__)), 'data/mongo_course.json') with open(file_path) as file: course_structure = json.load(file) diff --git a/openedx/core/djangoapps/content/course_overviews/tests/test_signals.py b/openedx/core/djangoapps/content/course_overviews/tests/test_signals.py index ad071acaf9ae..ba9eb3ecc3aa 100644 --- a/openedx/core/djangoapps/content/course_overviews/tests/test_signals.py +++ b/openedx/core/djangoapps/content/course_overviews/tests/test_signals.py @@ -4,19 +4,19 @@ import datetime -from unittest.mock import patch from collections import namedtuple +from unittest.mock import patch from zoneinfo import ZoneInfo -import pytest import ddt +import pytest from xmodule.data import CertificatesDisplayBehaviors from xmodule.modulestore import ModuleStoreEnum from xmodule.modulestore.tests.django_utils import ( TEST_DATA_ONLY_SPLIT_MODULESTORE_DRAFT_PREFERRED, - ModuleStoreTestCase, ImmediateOnCommitMixin, + ModuleStoreTestCase, ) from xmodule.modulestore.tests.factories import CourseFactory, check_mongo_calls @@ -89,7 +89,7 @@ def test_cache_invalidation(self): assert not course_overview_2.mobile_available # Verify that when the course is deleted, the corresponding CourseOverview is deleted as well. - with pytest.raises(CourseOverview.DoesNotExist): + with pytest.raises(CourseOverview.DoesNotExist): # noqa: PT012 self.store.delete_course(course.id, ModuleStoreEnum.UserID.test) CourseOverview.get_from_id(course.id) diff --git a/openedx/core/djangoapps/content/course_overviews/tests/test_sync_with_openedx_catalog.py b/openedx/core/djangoapps/content/course_overviews/tests/test_sync_with_openedx_catalog.py new file mode 100644 index 000000000000..f6b638c2e3ed --- /dev/null +++ b/openedx/core/djangoapps/content/course_overviews/tests/test_sync_with_openedx_catalog.py @@ -0,0 +1,161 @@ +""" +Test that changes to courses get synced into the new openedx_catalog models. +""" + +import pytest +from openedx_catalog import api as catalog_api +from openedx_catalog.models_api import CatalogCourse, CourseRun + +from openedx.core.djangolib.testing.utils import skip_unless_cms +from xmodule.modulestore import ModuleStoreEnum +from xmodule.modulestore.tests.django_utils import ( + TEST_DATA_ONLY_SPLIT_MODULESTORE_DRAFT_PREFERRED, + ImmediateOnCommitMixin, + ModuleStoreTestCase, +) +from xmodule.modulestore.tests.factories import CourseFactory + + +@skip_unless_cms +class CourseOverviewSyncTestCase(ImmediateOnCommitMixin, ModuleStoreTestCase): + """ + Test that changes to courses get synced into the new openedx_catalog models. + """ + + MODULESTORE = TEST_DATA_ONLY_SPLIT_MODULESTORE_DRAFT_PREFERRED + ENABLED_SIGNALS = ["course_deleted", "course_published"] + + def test_courserun_creation(self) -> None: + """ + Tests that when a course is created, the `CourseRun` record gets created. + + (Also the corresponding `CatalogCourse`.) + """ + course = CourseFactory.create(display_name="Intro to Testing", emit_signals=True) + course_key = course.location.context_key + + run = catalog_api.get_course_run(course_key) + assert run.title == "Intro to Testing" + assert run.course_key == course_key + assert run.catalog_course.course_code == course_key.course + assert run.catalog_course.org_code == course_key.org + + def test_courserun_sync(self) -> None: + """ + Tests that when a course is updated, the catalog records get updated. + + Because the "language" of a course cannot be set in Studio before you + create the course, when a Catalog Course has only a single run, we need + to keep the language of the catalog course in sync with any changes to + the language field of the course run. (Because authors necessarily + create a new course with the default language then edit it to have the + correct language that they actually intended to use for that [catalog] + course.) This is in contrast with display_name (title), which can + actually be set before creating a course. + """ + # Create a course + course = CourseFactory.create(display_name="Intro to Testing", emit_signals=True) + course_id = course.location.context_key + run = catalog_api.get_course_run(course_id) + assert run.title == "Intro to Testing" + assert run.catalog_course.language_short == "en" + + # Update the course's title and language: + course.language = "es" + course.display_name = "Introducción a las pruebas" + self.store.update_item(course, ModuleStoreEnum.UserID.test) + + # Check if the catalog data is updated: + run.refresh_from_db() + assert run.title == "Introducción a las pruebas" + assert run.catalog_course.language_short == "es" + # Note: for now we don't update the title of the catalog course after it has been created. + # We _could_ decide to sync the name from run -> catalog course if there is only one run. + assert run.catalog_course.title == "Intro to Testing" + + def test_courserun_of_many_sync(self) -> None: + """ + Tests that when a course is updated, the catalog records get updated, + but if there are several runs of the same course, the changes don't + propagate to the `CatalogCourse` and only affect the `CourseRun. + """ + # This import causes problems at top level when tests run on the LMS shard + from cms.djangoapps.contentstore.views.course import rerun_course + + # Create a course + course = CourseFactory.create(display_name="Intro to Testing", emit_signals=True) + course_id = course.location.context_key + run = catalog_api.get_course_run(course_id) + assert run.title == "Intro to Testing" + assert run.catalog_course.language_short == "en" + + # re-run the course: + new_run_course_id = rerun_course( + self.user, + source_course_key=course_id, + org=course_id.org, + number=course_id.course, + run="newRUN", + fields={"display_name": "Intro to Testing TEMPORARY NAME"}, + background=False, + ) + + # Update the re-run's title (display_name) and language: + new_course = self.store.get_course(new_run_course_id) + new_course.language = "es" + new_course.display_name = "Introducción a las pruebas" + self.store.update_item(new_course, self.user.id) + + # Check if the catalog data is updated correctly. + # The original CourseRun object should be unchanged: + run.refresh_from_db() + assert run.title == "Intro to Testing" + assert run.catalog_course.language_short == "en" + # The new CourseRun object should be created: + new_run = catalog_api.get_course_run(new_run_course_id) + assert new_run.title == "Introducción a las pruebas" + # Changing the language of the second run doesn't affect the lanugage of the overall catalog course (since the + # first run is still in English) + assert new_run.catalog_course.language_short == "en" + + def test_courserun_deletion(self) -> None: + """ + Tests that when a course run is deleted, the corresponding CourseRun is + deleted, and when it's the last run, the CatalogCourse is deleted too. + """ + # This import causes problems at top level when tests run on the LMS shard + from cms.djangoapps.contentstore.views.course import rerun_course + + # Create a course with two runs: + course = CourseFactory.create(display_name="Intro to Testing", emit_signals=True) + course_id1 = course.location.context_key + run1 = catalog_api.get_course_run(course_id1) + # re-run the course: + course_id2 = rerun_course( + self.user, + source_course_key=course_id1, + org=course_id1.org, + number=course_id1.course, + run="run2", + fields={"display_name": "ItT run2"}, + background=False, + ) + run2 = catalog_api.get_course_run(course_id2) + catalog_course = run1.catalog_course + assert catalog_course == run2.catalog_course # Same for run1 and run2 + + self.store.delete_course(course_id1, ModuleStoreEnum.UserID.test) + with pytest.raises(CourseRun.DoesNotExist): + run1.refresh_from_db() + + # run2 should still exist: + run2.refresh_from_db() + assert run2.catalog_course.title == "Intro to Testing" # The catalog course still exists and works + + # delete run 2: + self.store.delete_course(course_id2, ModuleStoreEnum.UserID.test) + with pytest.raises(CourseRun.DoesNotExist): + run2.refresh_from_db() + # With no runs left, the CatalogCourse also gets auto-deleted: + with pytest.raises(CatalogCourse.DoesNotExist): + catalog_course.refresh_from_db() diff --git a/openedx/core/djangoapps/content/course_overviews/tests/test_tasks.py b/openedx/core/djangoapps/content/course_overviews/tests/test_tasks.py index ee51712452ef..0f86aee31586 100644 --- a/openedx/core/djangoapps/content/course_overviews/tests/test_tasks.py +++ b/openedx/core/djangoapps/content/course_overviews/tests/test_tasks.py @@ -1,4 +1,4 @@ -# lint-amnesty, pylint: disable=missing-module-docstring +# pylint: disable=missing-module-docstring from unittest import mock @@ -8,7 +8,7 @@ from ..tasks import enqueue_async_course_overview_update_tasks -class BatchedAsyncCourseOverviewUpdateTests(ModuleStoreTestCase): # lint-amnesty, pylint: disable=missing-class-docstring +class BatchedAsyncCourseOverviewUpdateTests(ModuleStoreTestCase): # pylint: disable=missing-class-docstring def setUp(self): super().setUp() self.course_1 = CourseFactory.create() diff --git a/openedx/core/djangoapps/content/learning_sequences/admin.py b/openedx/core/djangoapps/content/learning_sequences/admin.py index 58ca0d3e713b..445037e838f9 100644 --- a/openedx/core/djangoapps/content/learning_sequences/admin.py +++ b/openedx/core/djangoapps/content/learning_sequences/admin.py @@ -1,17 +1,18 @@ """ Read-only Django Admin for viewing Learning Sequences and Outline data. """ +import json from datetime import datetime from enum import Enum -import json +import attr from django.contrib import admin from django.utils.html import format_html, format_html_join from django.utils.translation import gettext_lazy as _ from opaque_keys import OpaqueKey -import attr from openedx.core import types + from .api import get_content_errors, get_course_outline from .models import CourseContext, CourseSectionSequence diff --git a/openedx/core/djangoapps/content/learning_sequences/api/__init__.py b/openedx/core/djangoapps/content/learning_sequences/api/__init__.py index 2ab8283a6e1f..58520871e4a3 100644 --- a/openedx/core/djangoapps/content/learning_sequences/api/__init__.py +++ b/openedx/core/djangoapps/content/learning_sequences/api/__init__.py @@ -1,10 +1,10 @@ -# lint-amnesty, pylint: disable=missing-module-docstring +# pylint: disable=missing-module-docstring from .outlines import ( - get_content_errors, - get_course_keys_with_outlines, - get_course_outline, - get_user_course_outline, - get_user_course_outline_details, - key_supports_outlines, - replace_course_outline, + get_content_errors, # noqa: F401 + get_course_keys_with_outlines, # noqa: F401 + get_course_outline, # noqa: F401 + get_user_course_outline, # noqa: F401 + get_user_course_outline_details, # noqa: F401 + key_supports_outlines, # noqa: F401 + replace_course_outline, # noqa: F401 ) diff --git a/openedx/core/djangoapps/content/learning_sequences/api/outlines.py b/openedx/core/djangoapps/content/learning_sequences/api/outlines.py index cd2b12d03f1c..e39cbf8d2e3a 100644 --- a/openedx/core/djangoapps/content/learning_sequences/api/outlines.py +++ b/openedx/core/djangoapps/content/learning_sequences/api/outlines.py @@ -6,7 +6,7 @@ import logging from collections import defaultdict from datetime import datetime -from typing import Dict, FrozenSet, List, Optional, Union +from typing import Dict, FrozenSet, List, Optional, Union # noqa: UP035 from django.db import transaction from django.db.models.query import QuerySet @@ -15,9 +15,11 @@ from opaque_keys import OpaqueKey from opaque_keys.edx.keys import CourseKey from opaque_keys.edx.locator import LibraryLocator + from openedx.core import types -from openedx.core.djangoapps.content.learning_sequences.api.processors.team_partition_groups \ - import TeamPartitionGroupsOutlineProcessor +from openedx.core.djangoapps.content.learning_sequences.api.processors.team_partition_groups import ( + TeamPartitionGroupsOutlineProcessor, +) from ..data import ( ContentErrorData, @@ -28,7 +30,7 @@ ExamData, UserCourseOutlineData, UserCourseOutlineDetailsData, - VisibilityData + VisibilityData, ) from ..models import ( ContentError, @@ -39,7 +41,7 @@ LearningContext, LearningSequence, PublishReport, - UserPartitionGroup + UserPartitionGroup, ) from .permissions import can_see_all_content from .processors.cohort_partition_groups import CohortPartitionGroupsOutlineProcessor @@ -115,7 +117,7 @@ def get_course_outline(course_key: CourseKey) -> CourseOutlineData: course_context = _get_course_context_for_outline(course_key) # Check to see if it's in the cache. - cache_key = "learning_sequences.api.get_course_outline.v2.{}.{}".format( + cache_key = "learning_sequences.api.get_course_outline.v2.{}.{}".format( # noqa: UP032 course_context.learning_context.context_key, course_context.learning_context.published_version ) outline_cache_result = TieredCache.get_cached_response(cache_key) @@ -197,7 +199,7 @@ def get_course_outline(course_key: CourseKey) -> CourseOutlineData: return outline_data -def _get_user_partition_groups_from_qset(upg_qset) -> Dict[int, FrozenSet[int]]: +def _get_user_partition_groups_from_qset(upg_qset) -> Dict[int, FrozenSet[int]]: # noqa: UP006 """ Given a QuerySet of UserPartitionGroup, return a mapping of UserPartition IDs to the set of Group IDs for each UserPartition. @@ -218,7 +220,7 @@ def _get_course_context_for_outline(course_key: CourseKey) -> CourseContext: """ if course_key.deprecated: raise ValueError( - "Learning Sequence API does not support Old Mongo courses: {}" + "Learning Sequence API does not support Old Mongo courses: {}" # noqa: UP032 .format(course_key), ) try: @@ -230,13 +232,13 @@ def _get_course_context_for_outline(course_key: CourseKey) -> CourseContext: ) except LearningContext.DoesNotExist: # Could happen if it hasn't been published. - raise CourseOutlineData.DoesNotExist( # lint-amnesty, pylint: disable=raise-missing-from + raise CourseOutlineData.DoesNotExist( # pylint: disable=raise-missing-from # noqa: B904 f"No CourseOutlineData for {course_key}" ) return course_context -def get_content_errors(course_key: CourseKey) -> List[ContentErrorData]: +def get_content_errors(course_key: CourseKey) -> List[ContentErrorData]: # noqa: UP006 """ Get ContentErrors created in the most recent publish of this Course run. """ @@ -300,7 +302,7 @@ def get_user_course_outline_details(course_key: CourseKey, ) -def _get_user_course_outline_and_processors(course_key: CourseKey, # lint-amnesty, pylint: disable=missing-function-docstring +def _get_user_course_outline_and_processors(course_key: CourseKey, # pylint: disable=missing-function-docstring user: types.User, at_time: datetime): """ @@ -384,7 +386,7 @@ def _get_user_course_outline_and_processors(course_key: CourseKey, # lint-amnes @function_trace('learning_sequences.api.replace_course_outline') def replace_course_outline(course_outline: CourseOutlineData, - content_errors: Optional[List[ContentErrorData]] = None): + content_errors: Optional[List[ContentErrorData]] = None): # noqa: UP006, UP045 """ Replace the model data stored for the Course Outline with the contents of course_outline (a CourseOutlineData). Record any content errors. @@ -536,8 +538,8 @@ def _update_course_section_sequences(course_outline: CourseOutlineData, course_c _update_user_partition_groups(sequence_data.user_partition_groups, course_section_sequence) -def _update_user_partition_groups(upg_data: Dict[int, FrozenSet[int]], - model_obj: Union[CourseSection, CourseSectionSequence]): +def _update_user_partition_groups(upg_data: Dict[int, FrozenSet[int]], # noqa: UP006 + model_obj: Union[CourseSection, CourseSectionSequence]): # noqa: UP007 """ Replace UserPartitionGroups associated with this content with `upg_data`. """ @@ -552,7 +554,7 @@ def _update_user_partition_groups(upg_data: Dict[int, FrozenSet[int]], def _update_publish_report(course_outline: CourseOutlineData, - content_errors: List[ContentErrorData], + content_errors: List[ContentErrorData], # noqa: UP006 course_context: CourseContext): """ Record ContentErrors for this course publish. Deletes previous errors. diff --git a/openedx/core/djangoapps/content/learning_sequences/api/processors/base.py b/openedx/core/djangoapps/content/learning_sequences/api/processors/base.py index 72762667bfaf..80f36e1e34b0 100644 --- a/openedx/core/djangoapps/content/learning_sequences/api/processors/base.py +++ b/openedx/core/djangoapps/content/learning_sequences/api/processors/base.py @@ -5,7 +5,8 @@ import logging from datetime import datetime -from opaque_keys.edx.keys import CourseKey # lint-amnesty, pylint: disable=unused-import +from opaque_keys.edx.keys import CourseKey # pylint: disable=unused-import + from openedx.core import types from ...data import CourseOutlineData @@ -59,7 +60,7 @@ def load_data(self, full_course_outline: CourseOutlineData): # pylint: disable= tens of milliseconds, even on courses with hundreds of learning sequences. """ - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass def inaccessible_sequences(self, full_course_outline: CourseOutlineData): # pylint: disable=unused-argument """ diff --git a/openedx/core/djangoapps/content/learning_sequences/api/processors/cohort_partition_groups.py b/openedx/core/djangoapps/content/learning_sequences/api/processors/cohort_partition_groups.py index fa921902c833..d1270c7a7e50 100644 --- a/openedx/core/djangoapps/content/learning_sequences/api/processors/cohort_partition_groups.py +++ b/openedx/core/djangoapps/content/learning_sequences/api/processors/cohort_partition_groups.py @@ -1,4 +1,4 @@ -# lint-amnesty, pylint: disable=missing-module-docstring +# pylint: disable=missing-module-docstring import logging from datetime import datetime from typing import Union @@ -24,8 +24,8 @@ class CohortPartitionGroupsOutlineProcessor(OutlineProcessor): """ def __init__(self, course_key: CourseKey, user: types.User, at_time: datetime): super().__init__(course_key, user, at_time) - self.user_cohort_group_id: Union[int, None] = None - self.cohorted_partition_id: Union[int, None] = None + self.user_cohort_group_id: Union[int, None] = None # noqa: UP007 + self.cohorted_partition_id: Union[int, None] = None # noqa: UP007 def load_data(self, full_course_outline) -> None: """ diff --git a/openedx/core/djangoapps/content/learning_sequences/api/processors/content_gating.py b/openedx/core/djangoapps/content/learning_sequences/api/processors/content_gating.py index 9f86406dd971..f4b0dbb1121b 100644 --- a/openedx/core/djangoapps/content/learning_sequences/api/processors/content_gating.py +++ b/openedx/core/djangoapps/content/learning_sequences/api/processors/content_gating.py @@ -1,12 +1,12 @@ -# lint-amnesty, pylint: disable=missing-module-docstring +# pylint: disable=missing-module-docstring import logging from datetime import datetime from opaque_keys.edx.keys import CourseKey -from openedx.core import types from common.djangoapps.student.models import EntranceExamConfiguration from common.djangoapps.util import milestones_helpers +from openedx.core import types from .base import OutlineProcessor diff --git a/openedx/core/djangoapps/content/learning_sequences/api/processors/enrollment.py b/openedx/core/djangoapps/content/learning_sequences/api/processors/enrollment.py index f91e5a510d43..b0068e665de0 100644 --- a/openedx/core/djangoapps/content/learning_sequences/api/processors/enrollment.py +++ b/openedx/core/djangoapps/content/learning_sequences/api/processors/enrollment.py @@ -1,11 +1,11 @@ """ Simple OutlineProcessor that removes items based on Enrollment and course visibility setting. """ -from openedx.features.course_experience import COURSE_ENABLE_UNENROLLED_ACCESS_FLAG from common.djangoapps.student.models import CourseEnrollment +from openedx.features.course_experience import COURSE_ENABLE_UNENROLLED_ACCESS_FLAG -from .base import OutlineProcessor from ...data import CourseVisibility +from .base import OutlineProcessor class EnrollmentOutlineProcessor(OutlineProcessor): diff --git a/openedx/core/djangoapps/content/learning_sequences/api/processors/enrollment_track_partition_groups.py b/openedx/core/djangoapps/content/learning_sequences/api/processors/enrollment_track_partition_groups.py index b8587e0f71f9..4e337f44689d 100644 --- a/openedx/core/djangoapps/content/learning_sequences/api/processors/enrollment_track_partition_groups.py +++ b/openedx/core/djangoapps/content/learning_sequences/api/processors/enrollment_track_partition_groups.py @@ -1,19 +1,21 @@ -# lint-amnesty, pylint: disable=missing-module-docstring +# pylint: disable=missing-module-docstring import logging from datetime import datetime -from typing import Dict +from typing import Dict # noqa: UP035 from opaque_keys.edx.keys import CourseKey -from openedx.core import types -from xmodule.partitions.enrollment_track_partition_generator import ( # lint-amnesty, pylint: disable=wrong-import-order - create_enrollment_track_partition_with_course_id +from openedx.core import types +from xmodule.partitions.enrollment_track_partition_generator import ( # pylint: disable=wrong-import-order + create_enrollment_track_partition_with_course_id, ) -from xmodule.partitions.partitions import ( # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.partitions.partitions import ( # pylint: disable=wrong-import-order ENROLLMENT_TRACK_PARTITION_ID, + Group, # pylint: disable=wrong-import-order +) +from xmodule.partitions.partitions_service import ( + get_user_partition_groups, # pylint: disable=wrong-import-order ) -from xmodule.partitions.partitions_service import get_user_partition_groups # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.partitions.partitions import Group # lint-amnesty, pylint: disable=wrong-import-order from .base import OutlineProcessor @@ -30,7 +32,7 @@ class EnrollmentTrackPartitionGroupsOutlineProcessor(OutlineProcessor): """ def __init__(self, course_key: CourseKey, user: types.User, at_time: datetime): super().__init__(course_key, user, at_time) - self.enrollment_track_groups: Dict[str, Group] = {} + self.enrollment_track_groups: Dict[str, Group] = {} # noqa: UP006 self.user_group = None def load_data(self, full_course_outline) -> None: diff --git a/openedx/core/djangoapps/content/learning_sequences/api/processors/milestones.py b/openedx/core/djangoapps/content/learning_sequences/api/processors/milestones.py index 688ad8125402..280d5eea194a 100644 --- a/openedx/core/djangoapps/content/learning_sequences/api/processors/milestones.py +++ b/openedx/core/djangoapps/content/learning_sequences/api/processors/milestones.py @@ -1,7 +1,8 @@ -# lint-amnesty, pylint: disable=missing-module-docstring +# pylint: disable=missing-module-docstring import logging from django.contrib.auth import get_user_model + from common.djangoapps.util import milestones_helpers from .base import OutlineProcessor diff --git a/openedx/core/djangoapps/content/learning_sequences/api/processors/schedule.py b/openedx/core/djangoapps/content/learning_sequences/api/processors/schedule.py index 7d6e373b43e1..e9bc8f40ea49 100644 --- a/openedx/core/djangoapps/content/learning_sequences/api/processors/schedule.py +++ b/openedx/core/djangoapps/content/learning_sequences/api/processors/schedule.py @@ -1,16 +1,16 @@ -# lint-amnesty, pylint: disable=missing-module-docstring +# pylint: disable=missing-module-docstring from __future__ import annotations import logging -from collections import defaultdict # lint-amnesty, pylint: disable=unused-import +from collections import defaultdict # pylint: disable=unused-import from datetime import datetime, timedelta from edx_when.api import get_dates_for_course -from opaque_keys.edx.keys import UsageKey, CourseKey # lint-amnesty, pylint: disable=unused-import -from openedx.core import types +from opaque_keys.edx.keys import CourseKey, UsageKey # pylint: disable=unused-import from common.djangoapps.student.auth import user_has_role from common.djangoapps.student.roles import CourseBetaTesterRole +from openedx.core import types from ...data import ScheduleData, ScheduleItemData, UserCourseOutlineData from .base import OutlineProcessor @@ -127,7 +127,7 @@ def _effective_start(*dates): specified_dates = [date for date in dates if date is not None] return max(specified_dates) if specified_dates else None - pruned_section_keys = {section.usage_key for section in pruned_course_outline.sections} # lint-amnesty, pylint: disable=unused-variable + pruned_section_keys = {section.usage_key for section in pruned_course_outline.sections} # pylint: disable=unused-variable # noqa: F841 course_usage_key = self.course_key.make_usage_key('course', 'course') course_start = self.keys_to_schedule_fields[course_usage_key].get('start') course_end = self.keys_to_schedule_fields[course_usage_key].get('end') diff --git a/openedx/core/djangoapps/content/learning_sequences/api/processors/special_exams.py b/openedx/core/djangoapps/content/learning_sequences/api/processors/special_exams.py index 124b766a94a8..098e2a188fc8 100644 --- a/openedx/core/djangoapps/content/learning_sequences/api/processors/special_exams.py +++ b/openedx/core/djangoapps/content/learning_sequences/api/processors/special_exams.py @@ -12,16 +12,16 @@ import logging -from edx_proctoring.api import get_attempt_status_summary -from edx_proctoring.exceptions import ProctoredExamNotFoundException from django.conf import settings from django.contrib.auth import get_user_model from django.utils.translation import gettext as _ +from edx_proctoring.api import get_attempt_status_summary +from edx_proctoring.exceptions import ProctoredExamNotFoundException -from ...data import SpecialExamAttemptData, UserCourseOutlineData -from .base import OutlineProcessor from openedx.core.djangoapps.course_apps.toggles import exams_ida_enabled +from ...data import SpecialExamAttemptData, UserCourseOutlineData +from .base import OutlineProcessor User = get_user_model() log = logging.getLogger(__name__) @@ -35,7 +35,7 @@ def load_data(self, full_course_outline): """ Check if special exams are enabled """ - self.special_exams_enabled = settings.FEATURES.get('ENABLE_SPECIAL_EXAMS', False) # lint-amnesty, pylint: disable=attribute-defined-outside-init + self.special_exams_enabled = settings.FEATURES.get('ENABLE_SPECIAL_EXAMS', False) # pylint: disable=attribute-defined-outside-init def exam_data(self, pruned_course_outline: UserCourseOutlineData) -> SpecialExamAttemptData: """ diff --git a/openedx/core/djangoapps/content/learning_sequences/api/processors/team_partition_groups.py b/openedx/core/djangoapps/content/learning_sequences/api/processors/team_partition_groups.py index d3a8f0058030..a0f4a7afbcd4 100644 --- a/openedx/core/djangoapps/content/learning_sequences/api/processors/team_partition_groups.py +++ b/openedx/core/djangoapps/content/learning_sequences/api/processors/team_partition_groups.py @@ -3,13 +3,13 @@ """ import logging from datetime import datetime -from typing import Dict +from typing import Dict # noqa: UP035 from opaque_keys.edx.keys import CourseKey from openedx.core import types from openedx.core.djangoapps.content.learning_sequences.api.processors.base import OutlineProcessor -from openedx.core.lib.teams_config import create_team_set_partitions_with_course_id, CONTENT_GROUPS_FOR_TEAMS +from openedx.core.lib.teams_config import CONTENT_GROUPS_FOR_TEAMS, create_team_set_partitions_with_course_id from xmodule.partitions.partitions import Group from xmodule.partitions.partitions_service import get_user_partition_groups @@ -31,7 +31,7 @@ def __init__(self, course_key: CourseKey, user: types.User, at_time: datetime): belongs in each partition. """ super().__init__(course_key, user, at_time) - self.current_user_groups: Dict[str, Group] = {} + self.current_user_groups: Dict[str, Group] = {} # noqa: UP006 def load_data(self, _) -> None: """ diff --git a/openedx/core/djangoapps/content/learning_sequences/api/tests/test_data.py b/openedx/core/djangoapps/content/learning_sequences/api/tests/test_data.py index aaf1d2ba78d4..22dee3925055 100644 --- a/openedx/core/djangoapps/content/learning_sequences/api/tests/test_data.py +++ b/openedx/core/djangoapps/content/learning_sequences/api/tests/test_data.py @@ -1,14 +1,12 @@ -# lint-amnesty, pylint: disable=missing-module-docstring +# pylint: disable=missing-module-docstring from datetime import datetime, timezone from unittest import TestCase +import attr import pytest from opaque_keys.edx.keys import CourseKey -import attr -from ...data import ( - CourseOutlineData, CourseSectionData, CourseLearningSequenceData, VisibilityData, CourseVisibility -) +from ...data import CourseLearningSequenceData, CourseOutlineData, CourseSectionData, CourseVisibility, VisibilityData class TestCourseOutlineData(TestCase): @@ -23,7 +21,7 @@ def setUpClass(cls): test as needed. """ super().setUpClass() - normal_visibility = VisibilityData( # lint-amnesty, pylint: disable=unused-variable + normal_visibility = VisibilityData( # pylint: disable=unused-variable # noqa: F841 hide_from_toc=False, visible_to_staff_only=False ) @@ -31,7 +29,7 @@ def setUpClass(cls): cls.course_outline = CourseOutlineData( course_key=cls.course_key, title="Exciting Test Course!", - published_at=datetime(2020, 5, 19, tzinfo=timezone.utc), + published_at=datetime(2020, 5, 19, tzinfo=timezone.utc), # noqa: UP017 published_version="5ebece4b69dd593d82fe2014", entrance_exam_id=None, days_early_for_beta=None, @@ -43,7 +41,7 @@ def setUpClass(cls): def test_deprecated_course_key(self): """Old-Mongo style, "Org/Course/Run" keys are not supported.""" old_course_key = CourseKey.from_string("OpenEdX/TestCourse/TestRun") - with pytest.raises(ValueError): + with pytest.raises(ValueError): # noqa: PT011 attr.evolve(self.course_outline, course_key=old_course_key) def test_sequence_building(self): @@ -60,7 +58,7 @@ def test_duplicate_sequence(self): section_with_dupe_seq = attr.evolve( self.course_outline.sections[1], title="Chapter 2 dupe", ) - with pytest.raises(ValueError): + with pytest.raises(ValueError): # noqa: PT011 attr.evolve( self.course_outline, sections=self.course_outline.sections + [section_with_dupe_seq] @@ -68,7 +66,7 @@ def test_duplicate_sequence(self): def test_size(self): """Limit how large a CourseOutline is allowed to be.""" - with pytest.raises(ValueError): + with pytest.raises(ValueError): # noqa: PT011 attr.evolve( self.course_outline, sections=generate_sections(self.course_key, [1001]) @@ -118,7 +116,7 @@ def test_days_early_for_beta(self): assert new_outline != self.course_outline assert new_outline.days_early_for_beta == 5 - with pytest.raises(ValueError) as error: + with pytest.raises(ValueError) as error: # noqa: PT011 attr.evolve(self.course_outline, days_early_for_beta=-1) assert error.match( "Provided value -1 for days_early_for_beta is invalid. The value must be positive or zero. " @@ -141,7 +139,7 @@ def test_empty_user_partition_groups(self): 51: frozenset([1]), } ) - with self.assertRaises(ValueError): + with self.assertRaises(ValueError): # noqa: PT027 attr.evolve( valid_section, user_partition_groups={ diff --git a/openedx/core/djangoapps/content/learning_sequences/api/tests/test_outlines.py b/openedx/core/djangoapps/content/learning_sequences/api/tests/test_outlines.py index 20effa6b16cd..11a0967d94f6 100644 --- a/openedx/core/djangoapps/content/learning_sequences/api/tests/test_outlines.py +++ b/openedx/core/djangoapps/content/learning_sequences/api/tests/test_outlines.py @@ -2,10 +2,13 @@ Top level API tests. Tests API public contracts only. Do not import/create/mock models for this app. """ -from datetime import datetime, timezone -from unittest.mock import patch, MagicMock import unittest +from datetime import datetime, timezone +from unittest.mock import MagicMock, patch +import attr +import ddt +import pytest from django.conf import settings from django.contrib.auth.models import AnonymousUser from django.db.models import signals @@ -14,26 +17,22 @@ from edx_when.api import set_dates_for_course from opaque_keys.edx.keys import CourseKey from opaque_keys.edx.locator import LibraryLocator -import attr -import ddt + +from common.djangoapps.course_modes.models import CourseMode +from common.djangoapps.course_modes.signals import update_masters_access_course +from common.djangoapps.student.auth import user_has_role +from common.djangoapps.student.roles import CourseBetaTesterRole +from common.djangoapps.student.tests.factories import BetaTesterFactory, UserFactory from lms.djangoapps.teams.tests.factories import CourseTeamFactory from openedx.core.djangoapps.content.learning_sequences.api.processors.team_partition_groups import ( TeamPartitionGroupsOutlineProcessor, ) -from openedx.core.djangolib.testing.utils import skip_unless_lms -import pytest - from openedx.core.djangoapps.course_apps.toggles import EXAMS_IDA from openedx.core.djangoapps.course_groups.models import CourseCohortsSettings, CourseUserGroupPartitionGroup from openedx.core.djangoapps.course_groups.tests.helpers import CohortFactory -from openedx.core.djangolib.testing.utils import CacheIsolationTestCase +from openedx.core.djangolib.testing.utils import CacheIsolationTestCase, skip_unless_lms from openedx.features.course_experience import COURSE_ENABLE_UNENROLLED_ACCESS_FLAG -from common.djangoapps.course_modes.models import CourseMode -from common.djangoapps.course_modes.signals import update_masters_access_course -from common.djangoapps.student.auth import user_has_role -from common.djangoapps.student.roles import CourseBetaTesterRole -from common.djangoapps.student.tests.factories import BetaTesterFactory, UserFactory -from xmodule.partitions.partitions import ( # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.partitions.partitions import ( # pylint: disable=wrong-import-order ENROLLMENT_TRACK_PARTITION_ID, ) @@ -45,7 +44,6 @@ CourseVisibility, ExamData, VisibilityData, - ) from ..outlines import ( get_content_errors, @@ -77,16 +75,16 @@ class CourseOutlineTestCase(CacheIsolationTestCase): Simple tests around reading and writing CourseOutlineData. No user info. """ @classmethod - def setUpTestData(cls): # lint-amnesty, pylint: disable=super-method-not-called + def setUpTestData(cls): # pylint: disable=super-method-not-called cls.course_key = CourseKey.from_string("course-v1:OpenEdX+Learn+Roundtrip") - normal_visibility = VisibilityData( # lint-amnesty, pylint: disable=unused-variable + normal_visibility = VisibilityData( # pylint: disable=unused-variable # noqa: F841 hide_from_toc=False, visible_to_staff_only=False ) cls.course_outline = CourseOutlineData( course_key=cls.course_key, title="Roundtrip Test Course!", - published_at=datetime(2020, 5, 20, tzinfo=timezone.utc), + published_at=datetime(2020, 5, 20, tzinfo=timezone.utc), # noqa: UP017 published_version="5ebece4b69dd593d82fe2015", entrance_exam_id=None, days_early_for_beta=None, @@ -98,13 +96,13 @@ def setUpTestData(cls): # lint-amnesty, pylint: disable=super-method-not-called def test_deprecated_course_key(self): """Don't allow Old Mongo Courses at all.""" old_course_key = CourseKey.from_string("Org/Course/Run") - with pytest.raises(ValueError): - outline = get_course_outline(old_course_key) # lint-amnesty, pylint: disable=unused-variable + with pytest.raises(ValueError): # noqa: PT011 + outline = get_course_outline(old_course_key) # pylint: disable=unused-variable # noqa: F841 def test_simple_roundtrip(self): """Happy path for writing/reading-back a course outline.""" with pytest.raises(CourseOutlineData.DoesNotExist): - course_outline = get_course_outline(self.course_key) # lint-amnesty, pylint: disable=unused-variable + course_outline = get_course_outline(self.course_key) # pylint: disable=unused-variable # noqa: F841 replace_course_outline(self.course_outline) outline = get_course_outline(self.course_key) @@ -155,8 +153,8 @@ def test_cached_response(self): # Make sure this new outline is returned instead of the previously # cached one. with self.assertNumQueries(5): - uncached_new_version_outline = get_course_outline(self.course_key) # lint-amnesty, pylint: disable=unused-variable - assert new_version_outline == new_version_outline # lint-amnesty, pylint: disable=comparison-with-itself + uncached_new_version_outline = get_course_outline(self.course_key) # pylint: disable=unused-variable # noqa: F841 + assert new_version_outline == new_version_outline # pylint: disable=comparison-with-itself class UserCourseOutlineTestCase(CacheIsolationTestCase): @@ -165,7 +163,7 @@ class UserCourseOutlineTestCase(CacheIsolationTestCase): """ @classmethod - def setUpTestData(cls): # lint-amnesty, pylint: disable=super-method-not-called + def setUpTestData(cls): # pylint: disable=super-method-not-called course_key = CourseKey.from_string("course-v1:OpenEdX+Outline+T1") # Users... cls.global_staff = UserFactory.create( @@ -182,7 +180,7 @@ def setUpTestData(cls): # lint-amnesty, pylint: disable=super-method-not-called cls.simple_outline = CourseOutlineData( course_key=cls.course_key, title="User Outline Test Course!", - published_at=datetime(2020, 5, 20, tzinfo=timezone.utc), + published_at=datetime(2020, 5, 20, tzinfo=timezone.utc), # noqa: UP017 published_version="5ebece4b69dd593d82fe2020", entrance_exam_id=None, days_early_for_beta=None, @@ -199,7 +197,7 @@ def setUpTestData(cls): # lint-amnesty, pylint: disable=super-method-not-called def test_simple_outline(self): """This outline is the same for everyone.""" - at_time = datetime(2020, 5, 21, tzinfo=timezone.utc) + at_time = datetime(2020, 5, 21, tzinfo=timezone.utc) # noqa: UP017 beta_tester_outline = get_user_course_outline( self.course_key, self.beta_tester, at_time ) @@ -229,9 +227,9 @@ def test_simple_outline(self): assert global_staff_outline_details.outline == global_staff_outline -class OutlineProcessorTestCase(CacheIsolationTestCase): # lint-amnesty, pylint: disable=missing-class-docstring +class OutlineProcessorTestCase(CacheIsolationTestCase): # pylint: disable=missing-class-docstring @classmethod - def setUpTestData(cls): # lint-amnesty, pylint: disable=super-method-not-called + def setUpTestData(cls): # pylint: disable=super-method-not-called cls.course_key = CourseKey.from_string("course-v1:OpenEdX+Outline+T1") # Users... @@ -256,7 +254,7 @@ def get_details(self, at_time): def set_sequence_keys(cls, keys): cls.all_seq_keys = keys - def get_sequence_keys(self, exclude=None): # lint-amnesty, pylint: disable=missing-function-docstring + def get_sequence_keys(self, exclude=None): # pylint: disable=missing-function-docstring if exclude is None: exclude = [] if not isinstance(exclude, list): @@ -292,31 +290,31 @@ def setUpTestData(cls): [ ( cls.course_key.make_usage_key('course', 'course'), - {'start': datetime(2020, 5, 10, tzinfo=timezone.utc)} + {'start': datetime(2020, 5, 10, tzinfo=timezone.utc)} # noqa: UP017 ), ( cls.entrance_exam_section_key, - {'start': datetime(2020, 5, 15, tzinfo=timezone.utc)} + {'start': datetime(2020, 5, 15, tzinfo=timezone.utc)} # noqa: UP017 ), ( cls.entrance_exam_seq_key, - {'start': datetime(2020, 5, 15, tzinfo=timezone.utc)} + {'start': datetime(2020, 5, 15, tzinfo=timezone.utc)} # noqa: UP017 ), ( cls.open_section_key, - {'start': datetime(2020, 5, 15, tzinfo=timezone.utc)} + {'start': datetime(2020, 5, 15, tzinfo=timezone.utc)} # noqa: UP017 ), ( cls.open_seq_key, - {'start': datetime(2020, 5, 15, tzinfo=timezone.utc)} + {'start': datetime(2020, 5, 15, tzinfo=timezone.utc)} # noqa: UP017 ), ( cls.gated_section_key, - {'start': datetime(2020, 5, 15, tzinfo=timezone.utc)} + {'start': datetime(2020, 5, 15, tzinfo=timezone.utc)} # noqa: UP017 ), ( cls.gated_seq_key, - {'start': datetime(2020, 5, 15, tzinfo=timezone.utc)} + {'start': datetime(2020, 5, 15, tzinfo=timezone.utc)} # noqa: UP017 ), ] ) @@ -328,7 +326,7 @@ def setUpTestData(cls): cls.outline = CourseOutlineData( course_key=cls.course_key, title="User Outline Test Course!", - published_at=datetime(2020, 5, 20, tzinfo=timezone.utc), + published_at=datetime(2020, 5, 20, tzinfo=timezone.utc), # noqa: UP017 published_version="5ebece4b69dd593d82fe2020", entrance_exam_id=str(cls.entrance_exam_section_key), days_early_for_beta=None, @@ -378,19 +376,19 @@ def setUpTestData(cls): # Enroll student in the course cls.student.courseenrollment_set.create(course_id=cls.course_key, is_active=True, mode="verified") - # lint-amnesty, pylint: disable=pointless-string-statement + # pylint: disable=pointless-string-statement """ Currently returns all, and only, sequences in required content, not just the first. This logic matches the existing transformer. Is this right? """ - @patch('openedx.core.djangoapps.content.learning_sequences.api.processors.content_gating.EntranceExamConfiguration.user_can_skip_entrance_exam') # lint-amnesty, pylint: disable=line-too-long - @patch('openedx.core.djangoapps.content.learning_sequences.api.processors.content_gating.milestones_helpers.get_required_content') # lint-amnesty, pylint: disable=line-too-long + @patch('openedx.core.djangoapps.content.learning_sequences.api.processors.content_gating.EntranceExamConfiguration.user_can_skip_entrance_exam') # pylint: disable=line-too-long + @patch('openedx.core.djangoapps.content.learning_sequences.api.processors.content_gating.milestones_helpers.get_required_content') # pylint: disable=line-too-long def test_user_can_skip_entrance_exam(self, required_content_mock, user_can_skip_entrance_exam_mock): required_content_mock.return_value = [str(self.entrance_exam_section_key)] user_can_skip_entrance_exam_mock.return_value = True staff_details, student_details, _ = self.get_details( - datetime(2020, 5, 25, tzinfo=timezone.utc) + datetime(2020, 5, 25, tzinfo=timezone.utc) # noqa: UP017 ) # Staff can always access all sequences @@ -399,13 +397,13 @@ def test_user_can_skip_entrance_exam(self, required_content_mock, user_can_skip_ # Student can access all sequences assert len(student_details.outline.accessible_sequences) == 3 - @patch('openedx.core.djangoapps.content.learning_sequences.api.processors.content_gating.EntranceExamConfiguration.user_can_skip_entrance_exam') # lint-amnesty, pylint: disable=line-too-long - @patch('openedx.core.djangoapps.content.learning_sequences.api.processors.content_gating.milestones_helpers.get_required_content') # lint-amnesty, pylint: disable=line-too-long + @patch('openedx.core.djangoapps.content.learning_sequences.api.processors.content_gating.EntranceExamConfiguration.user_can_skip_entrance_exam') # pylint: disable=line-too-long + @patch('openedx.core.djangoapps.content.learning_sequences.api.processors.content_gating.milestones_helpers.get_required_content') # pylint: disable=line-too-long def test_user_can_not_skip_entrance_exam(self, required_content_mock, user_can_skip_entrance_exam_mock): required_content_mock.return_value = [str(self.entrance_exam_section_key)] user_can_skip_entrance_exam_mock.return_value = False staff_details, student_details, _ = self.get_details( - datetime(2020, 5, 25, tzinfo=timezone.utc) + datetime(2020, 5, 25, tzinfo=timezone.utc) # noqa: UP017 ) # Staff can always access all sequences assert len(staff_details.outline.accessible_sequences) == 3 @@ -441,19 +439,19 @@ def setUpTestData(cls): [ ( cls.course_key.make_usage_key('course', 'course'), - {'start': datetime(2020, 5, 10, tzinfo=timezone.utc)} + {'start': datetime(2020, 5, 10, tzinfo=timezone.utc)} # noqa: UP017 ), ( cls.section_key, - {'start': datetime(2020, 5, 15, tzinfo=timezone.utc)} + {'start': datetime(2020, 5, 15, tzinfo=timezone.utc)} # noqa: UP017 ), ( cls.open_seq_key, - {'start': datetime(2020, 5, 15, tzinfo=timezone.utc)} + {'start': datetime(2020, 5, 15, tzinfo=timezone.utc)} # noqa: UP017 ), ( cls.milestone_required_seq_key, - {'start': datetime(2020, 5, 15, tzinfo=timezone.utc)} + {'start': datetime(2020, 5, 15, tzinfo=timezone.utc)} # noqa: UP017 ), ] ) @@ -465,7 +463,7 @@ def setUpTestData(cls): cls.outline = CourseOutlineData( course_key=cls.course_key, title="User Outline Test Course!", - published_at=datetime(2020, 5, 20, tzinfo=timezone.utc), + published_at=datetime(2020, 5, 20, tzinfo=timezone.utc), # noqa: UP017 published_version="5ebece4b69dd593d82fe2020", entrance_exam_id=None, days_early_for_beta=None, @@ -496,7 +494,7 @@ def setUpTestData(cls): # Enroll student in the course cls.student.courseenrollment_set.create(course_id=cls.course_key, is_active=True, mode="audit") - @patch('openedx.core.djangoapps.content.learning_sequences.api.processors.milestones.milestones_helpers.get_course_content_milestones') # lint-amnesty, pylint: disable=line-too-long + @patch('openedx.core.djangoapps.content.learning_sequences.api.processors.milestones.milestones_helpers.get_course_content_milestones') # pylint: disable=line-too-long def test_user_can_skip_entrance_exam(self, get_course_content_milestones_mock): # Only return that there are milestones required for the # milestones_required_seq_key usage key @@ -506,7 +504,7 @@ def get_milestones_side_effect(_course_key, usage_key, _milestone_type, _user_id get_course_content_milestones_mock.side_effect = get_milestones_side_effect staff_details, student_details, _ = self.get_details( - datetime(2020, 5, 25, tzinfo=timezone.utc) + datetime(2020, 5, 25, tzinfo=timezone.utc) # noqa: UP017 ) # Staff can always access all sequences @@ -555,26 +553,26 @@ def setUpTestData(cls): [ ( cls.course_key.make_usage_key('course', 'course'), - {'start': datetime(2020, 5, 10, tzinfo=timezone.utc)} + {'start': datetime(2020, 5, 10, tzinfo=timezone.utc)} # noqa: UP017 ), ( cls.section_key, - {'start': datetime(2020, 5, 15, tzinfo=timezone.utc)} + {'start': datetime(2020, 5, 15, tzinfo=timezone.utc)} # noqa: UP017 ), # Sequence that starts before containing Section. ( cls.seq_before_key, - {'start': datetime(2020, 5, 14, tzinfo=timezone.utc)} + {'start': datetime(2020, 5, 14, tzinfo=timezone.utc)} # noqa: UP017 ), # Sequence starts at same time as containing Section. ( cls.seq_same_key, - {'start': datetime(2020, 5, 15, tzinfo=timezone.utc)} + {'start': datetime(2020, 5, 15, tzinfo=timezone.utc)} # noqa: UP017 ), # Sequence starts after containing Section. ( cls.seq_after_key, - {'start': datetime(2020, 5, 16, tzinfo=timezone.utc)} + {'start': datetime(2020, 5, 16, tzinfo=timezone.utc)} # noqa: UP017 ), # Sequence should inherit start information from Section. ( @@ -586,7 +584,7 @@ def setUpTestData(cls): cls.seq_due_key, { 'start': None, - 'due': datetime(2020, 5, 20, tzinfo=timezone.utc) + 'due': datetime(2020, 5, 20, tzinfo=timezone.utc) # noqa: UP017 } ), ] @@ -598,7 +596,7 @@ def setUpTestData(cls): cls.outline = CourseOutlineData( course_key=cls.course_key, title="User Outline Test Course!", - published_at=datetime(2020, 5, 20, tzinfo=timezone.utc), + published_at=datetime(2020, 5, 20, tzinfo=timezone.utc), # noqa: UP017 published_version="5ebece4b69dd593d82fe2020", entrance_exam_id=None, days_early_for_beta=None, @@ -650,7 +648,7 @@ def setUpTestData(cls): def test_before_course_starts(self): staff_details, student_details, beta_tester_details = self.get_details( - datetime(2020, 5, 9, tzinfo=timezone.utc) + datetime(2020, 5, 9, tzinfo=timezone.utc) # noqa: UP017 ) # Staff can always access all sequences assert len(staff_details.outline.accessible_sequences) == 5 @@ -670,7 +668,7 @@ def test_course_beta_access(self): replace_course_outline(course_outline) staff_details, student_details, beta_tester_details = self.get_details( - datetime(2020, 5, 9, tzinfo=timezone.utc) + datetime(2020, 5, 9, tzinfo=timezone.utc) # noqa: UP017 ) # Staff can always access all sequences assert len(staff_details.outline.accessible_sequences) == 5 @@ -686,7 +684,7 @@ def test_course_beta_access(self): def test_before_section_starts(self): staff_details, student_details, beta_tester_details = self.get_details( - datetime(2020, 5, 14, tzinfo=timezone.utc) + datetime(2020, 5, 14, tzinfo=timezone.utc) # noqa: UP017 ) # Staff can always access all sequences assert len(staff_details.outline.accessible_sequences) == 5 @@ -696,8 +694,8 @@ def test_before_section_starts(self): # started yet. assert len(student_details.outline.accessible_sequences) == 0 before_seq_sched_item_data = student_details.schedule.sequences[self.seq_before_key] - assert before_seq_sched_item_data.start == datetime(2020, 5, 14, tzinfo=timezone.utc) - assert before_seq_sched_item_data.effective_start == datetime(2020, 5, 15, tzinfo=timezone.utc) + assert before_seq_sched_item_data.start == datetime(2020, 5, 14, tzinfo=timezone.utc) # noqa: UP017 + assert before_seq_sched_item_data.effective_start == datetime(2020, 5, 15, tzinfo=timezone.utc) # noqa: UP017 # Beta tester can access nothing assert len(beta_tester_details.outline.accessible_sequences) == 0 @@ -708,7 +706,7 @@ def test_section_beta_access(self): replace_course_outline(course_outline) staff_details, student_details, beta_tester_details = self.get_details( - datetime(2020, 5, 14, tzinfo=timezone.utc) + datetime(2020, 5, 14, tzinfo=timezone.utc) # noqa: UP017 ) # Staff can always access all sequences assert len(staff_details.outline.accessible_sequences) == 5 @@ -718,15 +716,15 @@ def test_section_beta_access(self): # started yet. assert len(student_details.outline.accessible_sequences) == 0 before_seq_sched_item_data = student_details.schedule.sequences[self.seq_before_key] - assert before_seq_sched_item_data.start == datetime(2020, 5, 14, tzinfo=timezone.utc) - assert before_seq_sched_item_data.effective_start == datetime(2020, 5, 15, tzinfo=timezone.utc) + assert before_seq_sched_item_data.start == datetime(2020, 5, 14, tzinfo=timezone.utc) # noqa: UP017 + assert before_seq_sched_item_data.effective_start == datetime(2020, 5, 15, tzinfo=timezone.utc) # noqa: UP017 # Beta tester can access some assert len(beta_tester_details.outline.accessible_sequences) == 4 def test_at_section_start(self): staff_details, student_details, beta_tester_details = self.get_details( - datetime(2020, 5, 15, tzinfo=timezone.utc) + datetime(2020, 5, 15, tzinfo=timezone.utc) # noqa: UP017 ) # Staff can always access all sequences assert len(staff_details.outline.accessible_sequences) == 5 @@ -747,7 +745,7 @@ def test_at_beta_section_start(self): replace_course_outline(course_outline) staff_details, student_details, beta_tester_details = self.get_details( - datetime(2020, 5, 15, tzinfo=timezone.utc) + datetime(2020, 5, 15, tzinfo=timezone.utc) # noqa: UP017 ) # Staff can always access all sequences assert len(staff_details.outline.accessible_sequences) == 5 @@ -764,7 +762,7 @@ def test_at_beta_section_start(self): def test_is_due_and_before_due(self): staff_details, student_details, beta_tester_details = self.get_details( - datetime(2020, 5, 16, tzinfo=timezone.utc) + datetime(2020, 5, 16, tzinfo=timezone.utc) # noqa: UP017 ) # Staff can always access all sequences assert len(staff_details.outline.accessible_sequences) == 5 @@ -775,14 +773,14 @@ def test_is_due_and_before_due(self): assert self.seq_due_key in student_details.outline.accessible_sequences seq_due_sched_item_data = student_details.schedule.sequences[self.seq_due_key] - assert seq_due_sched_item_data.due == datetime(2020, 5, 20, tzinfo=timezone.utc) + assert seq_due_sched_item_data.due == datetime(2020, 5, 20, tzinfo=timezone.utc) # noqa: UP017 # Beta tester can access some assert len(beta_tester_details.outline.accessible_sequences) == 5 def test_is_due_and_after_due(self): staff_details, student_details, beta_tester_details = self.get_details( - datetime(2020, 5, 21, tzinfo=timezone.utc) + datetime(2020, 5, 21, tzinfo=timezone.utc) # noqa: UP017 ) # Staff can always access all sequences assert len(staff_details.outline.accessible_sequences) == 5 @@ -799,7 +797,7 @@ def test_is_due_and_after_due(self): assert len(beta_tester_details.outline.accessible_sequences) == 4 -class SelfPacedTestCase(OutlineProcessorTestCase): # lint-amnesty, pylint: disable=missing-class-docstring +class SelfPacedTestCase(OutlineProcessorTestCase): # pylint: disable=missing-class-docstring @classmethod def setUpTestData(cls): @@ -823,20 +821,20 @@ def setUpTestData(cls): ( cls.course_key.make_usage_key('course', 'course'), { - 'start': datetime(2020, 5, 10, tzinfo=timezone.utc), + 'start': datetime(2020, 5, 10, tzinfo=timezone.utc), # noqa: UP017 } ), ( cls.section_key, - {'start': datetime(2020, 5, 15, tzinfo=timezone.utc)} + {'start': datetime(2020, 5, 15, tzinfo=timezone.utc)} # noqa: UP017 ), ( cls.seq_one_key, - {'due': datetime(2020, 5, 21, tzinfo=timezone.utc)} + {'due': datetime(2020, 5, 21, tzinfo=timezone.utc)} # noqa: UP017 ), ( cls.seq_two_key, - {'due': datetime(2020, 5, 21, tzinfo=timezone.utc)} + {'due': datetime(2020, 5, 21, tzinfo=timezone.utc)} # noqa: UP017 ), ] ) @@ -847,7 +845,7 @@ def setUpTestData(cls): cls.outline = CourseOutlineData( course_key=cls.course_key, title="User Outline Test Course!", - published_at=datetime(2020, 5, 20, tzinfo=timezone.utc), + published_at=datetime(2020, 5, 20, tzinfo=timezone.utc), # noqa: UP017 published_version="5ebece4b69dd593d82fe2020", entrance_exam_id=None, days_early_for_beta=None, @@ -880,10 +878,10 @@ def setUpTestData(cls): cls.student.courseenrollment_set.create(course_id=cls.course_key, is_active=True, mode="audit") def test_sequences_accessible_after_due(self): - at_time = datetime(2020, 5, 22, tzinfo=timezone.utc) # lint-amnesty, pylint: disable=unused-variable + at_time = datetime(2020, 5, 22, tzinfo=timezone.utc) # pylint: disable=unused-variable # noqa: F841, UP017 staff_details, student_details, _ = self.get_details( - datetime(2020, 5, 25, tzinfo=timezone.utc) + datetime(2020, 5, 25, tzinfo=timezone.utc) # noqa: UP017 ) # Staff can always access all sequences @@ -895,7 +893,7 @@ def test_sequences_accessible_after_due(self): assert len(student_details.outline.accessible_sequences) == 2 -class SpecialExamsTestCase(OutlineProcessorTestCase): # lint-amnesty, pylint: disable=missing-class-docstring +class SpecialExamsTestCase(OutlineProcessorTestCase): # pylint: disable=missing-class-docstring @classmethod def setUpTestData(cls): @@ -922,27 +920,27 @@ def setUpTestData(cls): [ ( cls.course_key.make_usage_key('course', 'course'), - {'start': datetime(2020, 5, 15, tzinfo=timezone.utc)} + {'start': datetime(2020, 5, 15, tzinfo=timezone.utc)} # noqa: UP017 ), ( cls.section_key, - {'start': datetime(2020, 5, 15, tzinfo=timezone.utc)} + {'start': datetime(2020, 5, 15, tzinfo=timezone.utc)} # noqa: UP017 ), ( cls.seq_practice_exam_key, - {'start': datetime(2020, 5, 15, tzinfo=timezone.utc)} + {'start': datetime(2020, 5, 15, tzinfo=timezone.utc)} # noqa: UP017 ), ( cls.seq_proctored_exam_key, - {'start': datetime(2020, 5, 15, tzinfo=timezone.utc)} + {'start': datetime(2020, 5, 15, tzinfo=timezone.utc)} # noqa: UP017 ), ( cls.seq_timed_exam_key, - {'start': datetime(2020, 5, 15, tzinfo=timezone.utc)} + {'start': datetime(2020, 5, 15, tzinfo=timezone.utc)} # noqa: UP017 ), ( cls.seq_normal_key, - {'start': datetime(2020, 5, 15, tzinfo=timezone.utc)} + {'start': datetime(2020, 5, 15, tzinfo=timezone.utc)} # noqa: UP017 ), ] ) @@ -953,7 +951,7 @@ def setUpTestData(cls): cls.outline = CourseOutlineData( course_key=cls.course_key, title="User Outline Test Course!", - published_at=datetime(2020, 5, 20, tzinfo=timezone.utc), + published_at=datetime(2020, 5, 20, tzinfo=timezone.utc), # noqa: UP017 published_version="5ebece4b69dd593d82fe2020", entrance_exam_id=None, days_early_for_beta=None, @@ -1000,10 +998,10 @@ def setUpTestData(cls): @patch.dict(settings.FEATURES, {'ENABLE_SPECIAL_EXAMS': True}) def test_special_exams_enabled_all_sequences_visible(self): - at_time = datetime(2020, 5, 22, tzinfo=timezone.utc) # lint-amnesty, pylint: disable=unused-variable + at_time = datetime(2020, 5, 22, tzinfo=timezone.utc) # pylint: disable=unused-variable # noqa: F841, UP017 staff_details, student_details, _ = self.get_details( - datetime(2020, 5, 25, tzinfo=timezone.utc) + datetime(2020, 5, 25, tzinfo=timezone.utc) # noqa: UP017 ) # Staff can always access all sequences @@ -1016,10 +1014,10 @@ def test_special_exams_enabled_all_sequences_visible(self): @patch.dict(settings.FEATURES, {'ENABLE_SPECIAL_EXAMS': False}) def test_special_exams_disabled_preserves_exam_sequences(self): - at_time = datetime(2020, 5, 22, tzinfo=timezone.utc) # lint-amnesty, pylint: disable=unused-variable + at_time = datetime(2020, 5, 22, tzinfo=timezone.utc) # pylint: disable=unused-variable # noqa: F841, UP017 staff_details, student_details, _ = self.get_details( - datetime(2020, 5, 25, tzinfo=timezone.utc) + datetime(2020, 5, 25, tzinfo=timezone.utc) # noqa: UP017 ) # Staff can always access all sequences @@ -1036,7 +1034,7 @@ def test_special_exams_disabled_preserves_exam_sequences(self): @patch.dict(settings.FEATURES, {'ENABLE_SPECIAL_EXAMS': True}) @patch('openedx.core.djangoapps.content.learning_sequences.api.processors.special_exams.get_attempt_status_summary') def test_special_exam_attempt_data_in_details(self, mock_get_attempt_status_summary): - at_time = datetime(2020, 5, 22, tzinfo=timezone.utc) # lint-amnesty, pylint: disable=unused-variable + at_time = datetime(2020, 5, 22, tzinfo=timezone.utc) # pylint: disable=unused-variable # noqa: F841, UP017 def get_attempt_status_side_effect(user_id, _course_key, usage_key): """ @@ -1047,7 +1045,7 @@ def get_attempt_status_side_effect(user_id, _course_key, usage_key): for sequence_key in self.get_sequence_keys(exclude=[self.seq_normal_key]): if usage_key == str(sequence_key): - num_fake_attempts = mock_get_attempt_status_summary.call_count % len(self.all_seq_keys) # lint-amnesty, pylint: disable=unused-variable + num_fake_attempts = mock_get_attempt_status_summary.call_count % len(self.all_seq_keys) # pylint: disable=unused-variable # noqa: F841 return { "summary": { "usage_key": usage_key @@ -1057,23 +1055,23 @@ def get_attempt_status_side_effect(user_id, _course_key, usage_key): mock_get_attempt_status_summary.side_effect = get_attempt_status_side_effect _, student_details, _ = self.get_details( - datetime(2020, 5, 25, tzinfo=timezone.utc) + datetime(2020, 5, 25, tzinfo=timezone.utc) # noqa: UP017 ) assert len(student_details.special_exam_attempts.sequences) == 3 for sequence_key in self.get_sequence_keys(exclude=[self.seq_normal_key]): assert sequence_key in student_details.special_exam_attempts.sequences attempt_summary = student_details.special_exam_attempts.sequences[sequence_key] - assert type(attempt_summary) == dict # lint-amnesty, pylint: disable=unidiomatic-typecheck + assert type(attempt_summary) == dict # pylint: disable=unidiomatic-typecheck assert attempt_summary["summary"]["usage_key"] == str(sequence_key) @patch.dict(settings.FEATURES, {'ENABLE_SPECIAL_EXAMS': False}) @patch('openedx.core.djangoapps.content.learning_sequences.api.processors.special_exams.get_attempt_status_summary') def test_special_exam_attempt_data_empty_when_disabled(self, mock_get_attempt_status_summary): - at_time = datetime(2020, 5, 22, tzinfo=timezone.utc) # lint-amnesty, pylint: disable=unused-variable + at_time = datetime(2020, 5, 22, tzinfo=timezone.utc) # pylint: disable=unused-variable # noqa: F841, UP017 _, student_details, _ = self.get_details( - datetime(2020, 5, 25, tzinfo=timezone.utc) + datetime(2020, 5, 25, tzinfo=timezone.utc) # noqa: UP017 ) # Ensure that no calls are made to get_attempt_status_summary and no data in special_exam_attempts @@ -1085,7 +1083,7 @@ def test_special_exam_attempt_data_empty_when_disabled(self, mock_get_attempt_st @patch('openedx.core.djangoapps.content.learning_sequences.api.processors.special_exams.get_attempt_status_summary') def test_special_exam_attempt_data_exams_ida_flag_on(self, mock_get_attempt_status_summary): _, student_details, _ = self.get_details( - datetime(2020, 5, 25, tzinfo=timezone.utc) + datetime(2020, 5, 25, tzinfo=timezone.utc) # noqa: UP017 ) # Ensure that no calls are made to get_attempt_status_summary @@ -1095,13 +1093,13 @@ def test_special_exam_attempt_data_exams_ida_flag_on(self, mock_get_attempt_stat @patch.dict(settings.FEATURES, {'ENABLE_SPECIAL_EXAMS': True}) def test_special_exam_attempt_data_exam_type(self): _, student_details, _ = self.get_details( - datetime(2020, 5, 25, tzinfo=timezone.utc) + datetime(2020, 5, 25, tzinfo=timezone.utc) # noqa: UP017 ) # Ensure that exam type is correct for proctored exam assert self.seq_proctored_exam_key in student_details.special_exam_attempts.sequences attempt_summary = student_details.special_exam_attempts.sequences[self.seq_proctored_exam_key] - assert type(attempt_summary) == dict # lint-amnesty, pylint: disable=unidiomatic-typecheck + assert type(attempt_summary) == dict # pylint: disable=unidiomatic-typecheck assert attempt_summary["short_description"] == "Proctored Exam" @@ -1148,7 +1146,7 @@ def setUpTestData(cls): cls.outline = CourseOutlineData( course_key=cls.course_key, title="User Outline Test Course!", - published_at=datetime(2020, 5, 20, tzinfo=timezone.utc), + published_at=datetime(2020, 5, 20, tzinfo=timezone.utc), # noqa: UP017 published_version="5ebece4b69dd593d82fe2020", entrance_exam_id=None, days_early_for_beta=None, @@ -1190,10 +1188,10 @@ def setUpTestData(cls): cls.student.courseenrollment_set.create(course_id=cls.course_key, is_active=True, mode="audit") def test_visibility(self): - at_time = datetime(2020, 5, 21, tzinfo=timezone.utc) # Exact value doesn't matter # lint-amnesty, pylint: disable=unused-variable + at_time = datetime(2020, 5, 21, tzinfo=timezone.utc) # Exact value doesn't matter # pylint: disable=unused-variable # noqa: F841, UP017 staff_details, student_details, _ = self.get_details( - datetime(2020, 5, 25, tzinfo=timezone.utc) + datetime(2020, 5, 25, tzinfo=timezone.utc) # noqa: UP017 ) # Sections visible @@ -1226,7 +1224,7 @@ def setUpTestData(cls): # Handy variable as we almost always need to test with all types of users cls.all_users = [cls.global_staff, cls.student, cls.unenrolled_student, cls.anonymous_user] - cls.course_access_time = datetime(2020, 5, 21, tzinfo=timezone.utc) # Some random time in past + cls.course_access_time = datetime(2020, 5, 21, tzinfo=timezone.utc) # Some random time in past # noqa: UP017 # Create course, set it start date to some time in past and attach outline to it cls.course_key = CourseKey.from_string("course-v1:OpenEdX+Outline+T0") @@ -1236,7 +1234,7 @@ def setUpTestData(cls): cls.course_outline = CourseOutlineData( course_key=cls.course_key, title="User Outline Test Course!", - published_at=datetime(2020, 5, 20, tzinfo=timezone.utc), + published_at=datetime(2020, 5, 20, tzinfo=timezone.utc), # noqa: UP017 published_version="5ebece4b69dd593d82fe2020", entrance_exam_id=None, days_early_for_beta=None, @@ -1261,7 +1259,7 @@ def test_public_course_outline(self): assert len(user_course_outline.sections) == 3 assert len(user_course_outline.sequences) == 6 - assert all([(seq.usage_key in user_course_outline.accessible_sequences) for seq in # lint-amnesty, pylint: disable=use-a-generator + assert all([(seq.usage_key in user_course_outline.accessible_sequences) for seq in # pylint: disable=use-a-generator user_course_outline.sequences.values()]),\ 'Sequences should be accessible to all users for a public course' @@ -1324,7 +1322,7 @@ def test_private_course_outline(self): @ddt.ddt -class EnrollmentTrackPartitionGroupsTestCase(OutlineProcessorTestCase): # lint-amnesty, pylint: disable=missing-class-docstring +class EnrollmentTrackPartitionGroupsTestCase(OutlineProcessorTestCase): # pylint: disable=missing-class-docstring """Tests for enrollment track partitions outline processor that affect outlines""" @classmethod @@ -1368,7 +1366,7 @@ def _create_and_enroll_learner(self, username, mode, is_staff=False): Returns created learner """ learner = UserFactory.create( - username=username, email='{}@example.com'.format(username), is_staff=is_staff + username=username, email='{}@example.com'.format(username), is_staff=is_staff # noqa: UP032 ) learner.courseenrollment_set.create(course_id=self.course_key, is_active=True, mode=mode) return learner @@ -1376,7 +1374,7 @@ def _create_and_enroll_learner(self, username, mode, is_staff=False): def _setup_course_outline_with_sections( self, course_sections, - course_start_date=datetime(2021, 3, 26, tzinfo=timezone.utc) + course_start_date=datetime(2021, 3, 26, tzinfo=timezone.utc) # noqa: UP017 ): """ Helper function to update the course outline under test with @@ -1567,7 +1565,7 @@ def test_enrollment_track_partition_on_section( self._create_and_enroll_learner(username, mode) ) - check_date = datetime(2021, 3, 27, tzinfo=timezone.utc) + check_date = datetime(2021, 3, 27, tzinfo=timezone.utc) # noqa: UP017 # Get details staff_details, _, beta_tester_details = self.get_details(check_date) @@ -1714,7 +1712,7 @@ def test_processor_only( self._create_and_enroll_learner(username, mode) ) - check_date = datetime(2021, 3, 27, tzinfo=timezone.utc) + check_date = datetime(2021, 3, 27, tzinfo=timezone.utc) # noqa: UP017 for learner_to_verify in learners_to_verify: processor = EnrollmentTrackPartitionGroupsOutlineProcessor( self.course_key, learner_to_verify, check_date @@ -1744,7 +1742,7 @@ def _create_and_enroll_learner(self, username, is_staff=False): Returns the created learner """ learner = UserFactory.create( - username=username, email='{}@example.com'.format(username), is_staff=is_staff + username=username, email='{}@example.com'.format(username), is_staff=is_staff # noqa: UP032 ) learner.courseenrollment_set.create(course_id=self.course_key, is_active=True, mode=CourseMode.VERIFIED) return learner @@ -1752,7 +1750,7 @@ def _create_and_enroll_learner(self, username, is_staff=False): def _setup_course_outline_with_sections( self, course_sections, - course_start_date=datetime(2021, 3, 26, tzinfo=timezone.utc) + course_start_date=datetime(2021, 3, 26, tzinfo=timezone.utc) # noqa: UP017 ): """ Helper function to update the course outline under test with @@ -1901,7 +1899,7 @@ def test_cohort_partition_on_outline( ] ) - check_date = datetime(2021, 3, 27, tzinfo=timezone.utc) + check_date = datetime(2021, 3, 27, tzinfo=timezone.utc) # noqa: UP017 for learner_to_verify in learners_to_verify: learner_details = get_user_course_outline_details(self.course_key, learner_to_verify, check_date) @@ -1919,7 +1917,7 @@ def test_errors(self): outline = CourseOutlineData( course_key=course_key, title="Outline Errors Test Course!", - published_at=datetime(2021, 3, 21, tzinfo=timezone.utc), + published_at=datetime(2021, 3, 21, tzinfo=timezone.utc), # noqa: UP017 published_version="8ebece4b69dd593d82fe2020", sections=[], self_paced=False, @@ -1970,7 +1968,7 @@ def test_errors(self): @patch( - "openedx.core.djangoapps.content.learning_sequences.api.processors.team_partition_groups.CONTENT_GROUPS_FOR_TEAMS.is_enabled", # lint-amnesty, pylint: disable=line-too-long + "openedx.core.djangoapps.content.learning_sequences.api.processors.team_partition_groups.CONTENT_GROUPS_FOR_TEAMS.is_enabled", # pylint: disable=line-too-long lambda _: True ) @skip_unless_lms @@ -1986,7 +1984,7 @@ def _create_and_enroll_learner(cls, username, is_staff=False): Returns the created learner """ learner = UserFactory.create( - username=username, email='{}@example.com'.format(username), is_staff=is_staff + username=username, email='{}@example.com'.format(username), is_staff=is_staff # noqa: UP032 ) learner.courseenrollment_set.create(course_id=cls.course_key, is_active=True) return learner @@ -1995,7 +1993,7 @@ def _create_and_enroll_learner(cls, username, is_staff=False): def _setup_course_outline_with_sections( cls, course_sections, - course_start_date=datetime(2021, 3, 26, tzinfo=timezone.utc) + course_start_date=datetime(2021, 3, 26, tzinfo=timezone.utc) # noqa: UP017 ): """ Helper function to update the course outline under test with diff --git a/openedx/core/djangoapps/content/learning_sequences/apps.py b/openedx/core/djangoapps/content/learning_sequences/apps.py index 46b9bb45b3f4..05d92ff4572f 100644 --- a/openedx/core/djangoapps/content/learning_sequences/apps.py +++ b/openedx/core/djangoapps/content/learning_sequences/apps.py @@ -1,11 +1,11 @@ -# lint-amnesty, pylint: disable=missing-module-docstring +# pylint: disable=missing-module-docstring from django.apps import AppConfig from django.conf import settings from django.utils.translation import gettext_lazy as _ from edx_proctoring.runtime import set_runtime_service -class LearningSequencesConfig(AppConfig): # lint-amnesty, pylint: disable=missing-class-docstring +class LearningSequencesConfig(AppConfig): # pylint: disable=missing-class-docstring name = 'openedx.core.djangoapps.content.learning_sequences' verbose_name = _('Learning Sequences and Outlines') diff --git a/openedx/core/djangoapps/content/learning_sequences/data.py b/openedx/core/djangoapps/content/learning_sequences/data.py index c13b451490ab..831882d512d8 100644 --- a/openedx/core/djangoapps/content/learning_sequences/data.py +++ b/openedx/core/djangoapps/content/learning_sequences/data.py @@ -23,10 +23,11 @@ import logging from datetime import datetime from enum import Enum -from typing import Dict, FrozenSet, List, Optional +from typing import Dict, FrozenSet, List, Optional # noqa: UP035 import attr from opaque_keys.edx.keys import CourseKey, UsageKey + from openedx.core import types log = logging.getLogger(__name__) @@ -58,7 +59,7 @@ class ContentErrorData: the outline (unknown tag types, sequences where we expect sections, etc.) """ message: str - usage_key: Optional[UsageKey] = None + usage_key: Optional[UsageKey] = None # noqa: UP045 @attr.s(frozen=True, auto_attribs=True) @@ -135,7 +136,7 @@ class CourseLearningSequenceData: # associated with this piece of content. See models.UserPartitionGroup # for more details. user_partition_groups = attr.ib( - type=Dict[int, FrozenSet[int]], + type=Dict[int, FrozenSet[int]], # noqa: UP006 factory=dict, validator=[user_partition_groups_not_empty], ) @@ -149,13 +150,13 @@ class CourseSectionData: usage_key = attr.ib(type=UsageKey) title = attr.ib(type=str) visibility = attr.ib(type=VisibilityData, default=VisibilityData()) - sequences = attr.ib(type=List[CourseLearningSequenceData], factory=list) + sequences = attr.ib(type=List[CourseLearningSequenceData], factory=list) # noqa: UP006 # Mapping of UserPartition IDs to list of UserPartition Groups that are # associated with this piece of content. See models.UserPartitionGroup # for more details. user_partition_groups = attr.ib( - type=Dict[int, FrozenSet[int]], + type=Dict[int, FrozenSet[int]], # noqa: UP006 factory=dict, validator=[user_partition_groups_not_empty], ) @@ -199,30 +200,30 @@ def not_deprecated(self, _attribute, value): # The time period (in days) before the official start of the course during which # beta testers have access to the course. - days_early_for_beta = attr.ib(type=Optional[int]) + days_early_for_beta = attr.ib(type=Optional[int]) # noqa: UP045 - sections = attr.ib(type=List[CourseSectionData]) + sections = attr.ib(type=List[CourseSectionData]) # noqa: UP006 # Defines if course self-paced or instructor-paced. self_paced = attr.ib(type=bool) # To make sure that our data structure is consistent, this field is # derived from what you pass into `sections`. Do not set this directly. - sequences = attr.ib(type=Dict[UsageKey, CourseLearningSequenceData], init=False) + sequences = attr.ib(type=Dict[UsageKey, CourseLearningSequenceData], init=False) # noqa: UP006 course_visibility: CourseVisibility = attr.ib(validator=attr.validators.in_(CourseVisibility)) # Entrance Exam ID - entrance_exam_id = attr.ib(type=Optional[str]) + entrance_exam_id = attr.ib(type=Optional[str]) # noqa: UP045 def __attrs_post_init__(self): """Post-init hook that validates and inits the `sequences` field.""" sequences = {} for section in self.sections: for seq in section.sequences: - if seq.usage_key in sequences: # lint-amnesty, pylint: disable=no-else-raise + if seq.usage_key in sequences: # pylint: disable=no-else-raise raise ValueError( - "Sequence {} appears in more than one Section." + "Sequence {} appears in more than one Section." # noqa: UP032 .format(seq.usage_key) ) else: @@ -236,7 +237,7 @@ def __attrs_post_init__(self): # sequences manually here, instead of in a @sequences.validator if len(sequences) > self.MAX_SEQUENCE_COUNT: raise ValueError( - "sequences cannot have more than {} entries ({} attempted)" + "sequences cannot have more than {} entries ({} attempted)" # noqa: UP032 .format(self.MAX_SEQUENCE_COUNT, len(sequences)) ) @@ -278,13 +279,13 @@ def remove(self, usage_keys): ) @days_early_for_beta.validator - def validate_days_early_for_beta(self, attribute, value): # lint-amnesty, pylint: disable=unused-argument + def validate_days_early_for_beta(self, attribute, value): # pylint: disable=unused-argument """ Ensure that days_early_for_beta isn't negative. """ if value is not None and value < 0: raise ValueError( - "Provided value {} for days_early_for_beta is invalid. The value must be positive or zero. " + "Provided value {} for days_early_for_beta is invalid. The value must be positive or zero. " # noqa: UP032 # pylint: disable=line-too-long "A positive value will shift back the starting date for Beta users by that many days.".format(value) ) @@ -297,11 +298,11 @@ class ScheduleItemData: usage_key: UsageKey # Start date that is specified for this item - start: Optional[datetime] + start: Optional[datetime] # noqa: UP045 # Effective release date that it's available (may be affected by parents) - effective_start: Optional[datetime] - due: Optional[datetime] + effective_start: Optional[datetime] # noqa: UP045 + due: Optional[datetime] # noqa: UP045 @attr.s(frozen=True, auto_attribs=True) @@ -309,10 +310,10 @@ class ScheduleData: """ Overall course schedule data. """ - course_start: Optional[datetime] - course_end: Optional[datetime] - sections: Dict[UsageKey, ScheduleItemData] - sequences: Dict[UsageKey, ScheduleItemData] + course_start: Optional[datetime] # noqa: UP045 + course_end: Optional[datetime] # noqa: UP045 + sections: Dict[UsageKey, ScheduleItemData] # noqa: UP006 + sequences: Dict[UsageKey, ScheduleItemData] # noqa: UP006 @attr.s(frozen=True, auto_attribs=True) @@ -320,7 +321,7 @@ class SpecialExamAttemptData: """ Overall special exam attempt data. """ - sequences: Dict[UsageKey, Dict] + sequences: Dict[UsageKey, Dict] # noqa: UP006 @attr.s(frozen=True, auto_attribs=True) @@ -359,7 +360,7 @@ class is a pretty dumb container that doesn't understand anything about how # * If anonymous course access is enabled in "public_outline" mode, # unauthenticated users (AnonymousUser) will see the course outline but # not be able to access anything inside. - accessible_sequences: FrozenSet[UsageKey] + accessible_sequences: FrozenSet[UsageKey] # noqa: UP006 @attr.s(frozen=True, auto_attribs=True) diff --git a/openedx/core/djangoapps/content/learning_sequences/migrations/0001_initial.py b/openedx/core/djangoapps/content/learning_sequences/migrations/0001_initial.py index 22aad21ffb27..1830e06d22f9 100644 --- a/openedx/core/djangoapps/content/learning_sequences/migrations/0001_initial.py +++ b/openedx/core/djangoapps/content/learning_sequences/migrations/0001_initial.py @@ -3,122 +3,158 @@ # Manually modified to collate some fields as utf8_bin for case sensitive # matching. -from django.db import migrations, models -import django.db.models.deletion import django.utils.timezone import model_utils.fields import opaque_keys.edx.django.models +from django.db import connection, migrations, models -class Migration(migrations.Migration): - - initial = True +def run_before_migrate(migrations, db_engine): + if 'postgresql' in db_engine: + # PostgreSQL: Use binary collation + return [ + migrations.RunSQL( + 'ALTER TABLE learning_sequences_learningcontext ALTER COLUMN context_key TYPE VARCHAR(255) COLLATE "C";', + reverse_sql=migrations.RunSQL.noop, ), + migrations.RunSQL( + 'ALTER TABLE learning_sequences_coursesection ALTER COLUMN usage_key TYPE VARCHAR(255) COLLATE "C";', + reverse_sql=migrations.RunSQL.noop, ), + migrations.RunSQL( + 'ALTER TABLE learning_sequences_learningsequence ALTER COLUMN usage_key TYPE VARCHAR(255) COLLATE "C";', + reverse_sql=migrations.RunSQL.noop, ), + ] - dependencies = [ - ] - - operations = [ - migrations.CreateModel( - name='CourseSection', - fields=[ - ('id', models.BigAutoField(primary_key=True, serialize=False)), - ('ordering', models.PositiveIntegerField()), - ('usage_key', opaque_keys.edx.django.models.UsageKeyField(max_length=255)), - ('title', models.CharField(max_length=1000)), - ('hide_from_toc', models.BooleanField(default=False)), - ('visible_to_staff_only', models.BooleanField(default=False)), - ('created', model_utils.fields.AutoCreatedField(default=django.utils.timezone.now, editable=False, verbose_name='created')), - ('modified', model_utils.fields.AutoLastModifiedField(default=django.utils.timezone.now, editable=False, verbose_name='modified')), - ], - ), - migrations.CreateModel( - name='CourseSectionSequence', - fields=[ - ('id', models.BigAutoField(primary_key=True, serialize=False)), - ('ordering', models.PositiveIntegerField()), - ('hide_from_toc', models.BooleanField(default=False)), - ('visible_to_staff_only', models.BooleanField(default=False)), - ('created', model_utils.fields.AutoCreatedField(default=django.utils.timezone.now, editable=False, verbose_name='created')), - ('modified', model_utils.fields.AutoLastModifiedField(default=django.utils.timezone.now, editable=False, verbose_name='modified')), - ], - ), - migrations.CreateModel( - name='LearningContext', - fields=[ - ('id', models.BigAutoField(primary_key=True, serialize=False)), - ('context_key', opaque_keys.edx.django.models.LearningContextKeyField(db_index=True, max_length=255, unique=True)), - ('title', models.CharField(max_length=255)), - ('published_at', models.DateTimeField()), - ('published_version', models.CharField(max_length=255)), - ('created', model_utils.fields.AutoCreatedField(default=django.utils.timezone.now, editable=False, verbose_name='created')), - ('modified', model_utils.fields.AutoLastModifiedField(default=django.utils.timezone.now, editable=False, verbose_name='modified')), - ], - ), - migrations.CreateModel( - name='LearningSequence', - fields=[ - ('id', models.BigAutoField(primary_key=True, serialize=False)), - ('learning_context', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='sequences', to='learning_sequences.LearningContext')), - ('usage_key', opaque_keys.edx.django.models.UsageKeyField(max_length=255)), - ('title', models.CharField(max_length=1000)), - ('created', model_utils.fields.AutoCreatedField(default=django.utils.timezone.now, editable=False, verbose_name='created')), - ('modified', model_utils.fields.AutoLastModifiedField(default=django.utils.timezone.now, editable=False, verbose_name='modified')), - ], - ), - migrations.AddIndex( - model_name='learningcontext', - index=models.Index(fields=['-published_at'], name='learning_se_publish_62319b_idx'), - ), - migrations.AddField( - model_name='coursesectionsequence', - name='learning_context', - field=models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='section_sequences', to='learning_sequences.LearningContext'), - ), - migrations.AddField( - model_name='coursesectionsequence', - name='section', - field=models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='learning_sequences.CourseSection'), - ), - migrations.AddField( - model_name='coursesectionsequence', - name='sequence', - field=models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='learning_sequences.LearningSequence'), - ), - migrations.AddField( - model_name='coursesection', - name='learning_context', - field=models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='sections', to='learning_sequences.LearningContext'), - ), - migrations.AlterUniqueTogether( - name='learningsequence', - unique_together={('learning_context', 'usage_key')}, - ), - migrations.AlterUniqueTogether( - name='coursesectionsequence', - unique_together={('learning_context', 'ordering')}, - ), - migrations.AlterUniqueTogether( - name='coursesection', - unique_together={('learning_context', 'usage_key')}, - ), - migrations.AlterIndexTogether( - name='coursesection', - index_together={('learning_context', 'ordering')}, - ), - - # Custom code: Convert columns to utf8_bin because we want to allow - # case-sensitive comparisons for things like UsageKeys, CourseKeys, and - # slugs. + return [ migrations.RunSQL( 'ALTER TABLE learning_sequences_learningcontext MODIFY context_key VARCHAR(255) CHARACTER SET utf8 COLLATE utf8_bin;', - reverse_sql=migrations.RunSQL.noop, - ), + reverse_sql=migrations.RunSQL.noop, ), migrations.RunSQL( 'ALTER TABLE learning_sequences_coursesection MODIFY usage_key VARCHAR(255) CHARACTER SET utf8 COLLATE utf8_bin;', - reverse_sql=migrations.RunSQL.noop, - ), + reverse_sql=migrations.RunSQL.noop, ), migrations.RunSQL( 'ALTER TABLE learning_sequences_learningsequence MODIFY usage_key VARCHAR(255) CHARACTER SET utf8 COLLATE utf8_bin;', - reverse_sql=migrations.RunSQL.noop, - ), + reverse_sql=migrations.RunSQL.noop, ), ] + + +class Migration(migrations.Migration): + initial = True + db_engine = connection.settings_dict['ENGINE'] + + dependencies = [ + ] + + operations = [ + migrations.CreateModel( + name='CourseSection', + fields=[ + ('id', models.BigAutoField(primary_key=True, serialize=False)), + ('ordering', models.PositiveIntegerField()), + ('usage_key', opaque_keys.edx.django.models.UsageKeyField(max_length=255)), + ('title', models.CharField(max_length=1000)), + ('hide_from_toc', models.BooleanField(default=False)), + ('visible_to_staff_only', models.BooleanField(default=False)), + ('created', + model_utils.fields.AutoCreatedField(default=django.utils.timezone.now, editable=False, + verbose_name='created')), + ('modified', model_utils.fields.AutoLastModifiedField(default=django.utils.timezone.now, + editable=False, + verbose_name='modified')), + ], + ), + migrations.CreateModel( + name='CourseSectionSequence', + fields=[ + ('id', models.BigAutoField(primary_key=True, serialize=False)), + ('ordering', models.PositiveIntegerField()), + ('hide_from_toc', models.BooleanField(default=False)), + ('visible_to_staff_only', models.BooleanField(default=False)), + ('created', + model_utils.fields.AutoCreatedField(default=django.utils.timezone.now, editable=False, + verbose_name='created')), + ('modified', model_utils.fields.AutoLastModifiedField(default=django.utils.timezone.now, + editable=False, + verbose_name='modified')), + ], + ), + migrations.CreateModel( + name='LearningContext', + fields=[ + ('id', models.BigAutoField(primary_key=True, serialize=False)), + ('context_key', + opaque_keys.edx.django.models.LearningContextKeyField(db_index=True, max_length=255, + unique=True)), + ('title', models.CharField(max_length=255)), + ('published_at', models.DateTimeField()), + ('published_version', models.CharField(max_length=255)), + ('created', + model_utils.fields.AutoCreatedField(default=django.utils.timezone.now, editable=False, + verbose_name='created')), + ('modified', model_utils.fields.AutoLastModifiedField(default=django.utils.timezone.now, + editable=False, + verbose_name='modified')), + ], + ), + migrations.CreateModel( + name='LearningSequence', + fields=[ + ('id', models.BigAutoField(primary_key=True, serialize=False)), + ('learning_context', + models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='sequences', + to='learning_sequences.LearningContext')), + ('usage_key', opaque_keys.edx.django.models.UsageKeyField(max_length=255)), + ('title', models.CharField(max_length=1000)), + ('created', + model_utils.fields.AutoCreatedField(default=django.utils.timezone.now, editable=False, + verbose_name='created')), + ('modified', model_utils.fields.AutoLastModifiedField(default=django.utils.timezone.now, + editable=False, + verbose_name='modified')), + ], + ), + migrations.AddIndex( + model_name='learningcontext', + index=models.Index(fields=['-published_at'], name='learning_se_publish_62319b_idx'), + ), + migrations.AddField( + model_name='coursesectionsequence', + name='learning_context', + field=models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, + related_name='section_sequences', + to='learning_sequences.LearningContext'), + ), + migrations.AddField( + model_name='coursesectionsequence', + name='section', + field=models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, + to='learning_sequences.CourseSection'), + ), + migrations.AddField( + model_name='coursesectionsequence', + name='sequence', + field=models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, + to='learning_sequences.LearningSequence'), + ), + migrations.AddField( + model_name='coursesection', + name='learning_context', + field=models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='sections', + to='learning_sequences.LearningContext'), + ), + migrations.AlterUniqueTogether( + name='learningsequence', + unique_together={('learning_context', 'usage_key')}, + ), + migrations.AlterUniqueTogether( + name='coursesectionsequence', + unique_together={('learning_context', 'ordering')}, + ), + migrations.AlterUniqueTogether( + name='coursesection', + unique_together={('learning_context', 'usage_key')}, + ), + migrations.AlterIndexTogether( + name='coursesection', + index_together={('learning_context', 'ordering')}, + ), + ] + run_before_migrate(migrations, db_engine=db_engine) diff --git a/openedx/core/djangoapps/content/learning_sequences/migrations/0003_create_course_context_for_course_specific_models.py b/openedx/core/djangoapps/content/learning_sequences/migrations/0003_create_course_context_for_course_specific_models.py index ca7ece7c4220..2287c57c926d 100644 --- a/openedx/core/djangoapps/content/learning_sequences/migrations/0003_create_course_context_for_course_specific_models.py +++ b/openedx/core/djangoapps/content/learning_sequences/migrations/0003_create_course_context_for_course_specific_models.py @@ -1,9 +1,9 @@ # Generated by Django 2.2.14 on 2020-07-22 18:27 -from django.db import migrations, models import django.db.models.deletion import django.utils.timezone import model_utils.fields +from django.db import migrations, models class Migration(migrations.Migration): diff --git a/openedx/core/djangoapps/content/learning_sequences/migrations/0007_coursesequenceexam.py b/openedx/core/djangoapps/content/learning_sequences/migrations/0007_coursesequenceexam.py index a3081bae0aea..c8dde65dca66 100644 --- a/openedx/core/djangoapps/content/learning_sequences/migrations/0007_coursesequenceexam.py +++ b/openedx/core/djangoapps/content/learning_sequences/migrations/0007_coursesequenceexam.py @@ -1,9 +1,9 @@ # Generated by Django 2.2.16 on 2020-09-30 07:14 -from django.db import migrations, models import django.db.models.deletion import django.utils.timezone import model_utils.fields +from django.db import migrations, models class Migration(migrations.Migration): diff --git a/openedx/core/djangoapps/content/learning_sequences/migrations/0009_contenterror_publishreport.py b/openedx/core/djangoapps/content/learning_sequences/migrations/0009_contenterror_publishreport.py index 1c7135a84713..b586bb5aed17 100644 --- a/openedx/core/djangoapps/content/learning_sequences/migrations/0009_contenterror_publishreport.py +++ b/openedx/core/djangoapps/content/learning_sequences/migrations/0009_contenterror_publishreport.py @@ -1,8 +1,8 @@ # Generated by Django 2.2.19 on 2021-03-12 16:31 -from django.db import migrations, models import django.db.models.deletion import opaque_keys.edx.django.models +from django.db import migrations, models class Migration(migrations.Migration): diff --git a/openedx/core/djangoapps/content/learning_sequences/migrations/0013_through_model_for_user_partition_groups_1.py b/openedx/core/djangoapps/content/learning_sequences/migrations/0013_through_model_for_user_partition_groups_1.py index 23ad1b0cf381..1c8c8ddd0af5 100644 --- a/openedx/core/djangoapps/content/learning_sequences/migrations/0013_through_model_for_user_partition_groups_1.py +++ b/openedx/core/djangoapps/content/learning_sequences/migrations/0013_through_model_for_user_partition_groups_1.py @@ -1,7 +1,7 @@ # Generated by Django 2.2.24 on 2021-06-14 22:04 -from django.db import migrations, models import django.db.models.deletion +from django.db import migrations, models class Migration(migrations.Migration): diff --git a/openedx/core/djangoapps/content/learning_sequences/models.py b/openedx/core/djangoapps/content/learning_sequences/models.py index 877ee084a567..33849d58dc7e 100644 --- a/openedx/core/djangoapps/content/learning_sequences/models.py +++ b/openedx/core/djangoapps/content/learning_sequences/models.py @@ -41,10 +41,11 @@ from django.db import models from model_utils.models import TimeStampedModel - -from opaque_keys.edx.django.models import ( # lint-amnesty, pylint: disable=unused-import - LearningContextKeyField, UsageKeyField +from opaque_keys.edx.django.models import ( # pylint: disable=unused-import + LearningContextKeyField, + UsageKeyField, ) + from .data import CourseVisibility @@ -91,7 +92,7 @@ class CourseContext(TimeStampedModel): ) days_early_for_beta = models.IntegerField(null=True, blank=True) self_paced = models.BooleanField(default=False) - entrance_exam_id = models.CharField(max_length=255, null=True) + entrance_exam_id = models.CharField(max_length=255, null=True) # noqa: DJ001 class Meta: verbose_name = 'Course' @@ -158,7 +159,7 @@ class Meta: abstract = True -class UserPartitionGroup(models.Model): +class UserPartitionGroup(models.Model): # noqa: DJ008 """ Each row represents a Group in a UserPartition. @@ -200,7 +201,7 @@ class Meta: ] -class CourseSection(CourseContentVisibilityMixin, TimeStampedModel): +class CourseSection(CourseContentVisibilityMixin, TimeStampedModel): # noqa: DJ008 """ Course Section data, mapping to the 'chapter' block type. @@ -233,7 +234,7 @@ class Meta: ] -class SectionPartitionGroup(models.Model): +class SectionPartitionGroup(models.Model): # noqa: DJ008 """ Model which maps user partition groups to course sections. Used for the user_partition_groups ManyToManyField field in the CourseSection model above. @@ -247,7 +248,7 @@ class Meta: ['user_partition_group', 'course_section'], ] - user_partition_group = models.ForeignKey(UserPartitionGroup, on_delete=models.CASCADE) + user_partition_group = models.ForeignKey(UserPartitionGroup, on_delete=models.CASCADE) # noqa: DJ012 course_section = models.ForeignKey(CourseSection, on_delete=models.CASCADE) @@ -301,7 +302,7 @@ def __str__(self): return f"{self.section.title} > {self.sequence.title}" -class SectionSequencePartitionGroup(models.Model): +class SectionSequencePartitionGroup(models.Model): # noqa: DJ008 """ Model which maps user partition groups to course section sequences. Used for the user_partition_groups ManyToManyField field in the CourseSectionSequence model above. @@ -315,7 +316,7 @@ class Meta: ['user_partition_group', 'course_section_sequence'], ] - user_partition_group = models.ForeignKey(UserPartitionGroup, on_delete=models.CASCADE) + user_partition_group = models.ForeignKey(UserPartitionGroup, on_delete=models.CASCADE) # noqa: DJ012 course_section_sequence = models.ForeignKey(CourseSectionSequence, on_delete=models.CASCADE) @@ -333,7 +334,7 @@ class CourseSequenceExam(TimeStampedModel): is_time_limited = models.BooleanField(default=False) -class PublishReport(models.Model): +class PublishReport(models.Model): # noqa: DJ008 """ A report about the content that generated this LearningContext publish. @@ -351,7 +352,7 @@ class PublishReport(models.Model): num_sequences = models.PositiveIntegerField(null=False, db_index=True) -class ContentError(models.Model): +class ContentError(models.Model): # noqa: DJ008 """ Human readable content errors. diff --git a/openedx/core/djangoapps/content/learning_sequences/tests/test_views.py b/openedx/core/djangoapps/content/learning_sequences/tests/test_views.py index 4cd8bf0c7df8..49d9fafa068f 100644 --- a/openedx/core/djangoapps/content/learning_sequences/tests/test_views.py +++ b/openedx/core/djangoapps/content/learning_sequences/tests/test_views.py @@ -17,7 +17,7 @@ import ddt from opaque_keys.edx.keys import CourseKey -from rest_framework.test import APITestCase, APIClient +from rest_framework.test import APIClient, APITestCase from common.djangoapps.student.models import CourseEnrollment from common.djangoapps.student.roles import CourseInstructorRole, CourseStaffRole @@ -38,7 +38,7 @@ class CourseOutlineViewTest(CacheIsolationTestCase, APITestCase): """ @classmethod - def setUpTestData(cls): # lint-amnesty, pylint: disable=super-method-not-called + def setUpTestData(cls): # pylint: disable=super-method-not-called cls.staff = UserFactory.create( username='staff', email='staff@example.com', is_staff=True, password='staff_pass' ) @@ -50,7 +50,7 @@ def setUpTestData(cls): # lint-amnesty, pylint: disable=super-method-not-called cls.outline = CourseOutlineData( course_key=cls.course_key, title="Views Test Course!", - published_at=datetime(2020, 5, 20, tzinfo=timezone.utc), + published_at=datetime(2020, 5, 20, tzinfo=timezone.utc), # noqa: UP017 published_version="5ebece4b69dd593d82fe2020", entrance_exam_id=None, days_early_for_beta=None, @@ -110,7 +110,7 @@ def test_outline_as_staff(self): # the raw form for max compatibility (i.e. guard against serialization # of dates changing), or do the parsing for conveninece? Convenience for # now. - assert data['published_at'] == datetime(2020, 5, 20, tzinfo=timezone.utc) + assert data['published_at'] == datetime(2020, 5, 20, tzinfo=timezone.utc) # noqa: UP017 assert data['published_version'] == "5ebece4b69dd593d82fe2020" # Basic outline structure checks @@ -127,7 +127,7 @@ class CourseOutlineViewTargetUserTest(CacheIsolationTestCase, APITestCase): Tests permissions of specifying a target user via url parameter. """ @classmethod - def setUpTestData(cls): # lint-amnesty, pylint: disable=super-method-not-called + def setUpTestData(cls): # pylint: disable=super-method-not-called """Set up the basic course outline and our users.""" # This is the course that we're creating staff for. cls.course_key = CourseKey.from_string("course-v1:OpenEdX+Masq+StaffAccess") @@ -139,7 +139,7 @@ def setUpTestData(cls): # lint-amnesty, pylint: disable=super-method-not-called outline = CourseOutlineData( course_key=course_key, title="Views Test Course!", - published_at=datetime(2020, 5, 20, tzinfo=timezone.utc), + published_at=datetime(2020, 5, 20, tzinfo=timezone.utc), # noqa: UP017 published_version="5ebece4b69dd593d82fe2020", entrance_exam_id=None, days_early_for_beta=None, @@ -260,7 +260,7 @@ def setUpTestData(cls): outline = CourseOutlineData( course_key=cls.course_key, title="Views Test Course!", - published_at=datetime(2020, 5, 20, tzinfo=timezone.utc), + published_at=datetime(2020, 5, 20, tzinfo=timezone.utc), # noqa: UP017 published_version="5ebece4b69dd593d82fe2020", entrance_exam_id=None, days_early_for_beta=None, diff --git a/openedx/core/djangoapps/content/learning_sequences/urls.py b/openedx/core/djangoapps/content/learning_sequences/urls.py index cf55533358b6..351aeb5bafc1 100644 --- a/openedx/core/djangoapps/content/learning_sequences/urls.py +++ b/openedx/core/djangoapps/content/learning_sequences/urls.py @@ -1,8 +1,8 @@ -# lint-amnesty, pylint: disable=missing-module-docstring +# pylint: disable=missing-module-docstring from django.urls import path -from .views import CourseOutlineView +from .views import CourseOutlineView urlpatterns = [ path('v1/course_outline/', CourseOutlineView.as_view(), diff --git a/openedx/core/djangoapps/content/learning_sequences/views.py b/openedx/core/djangoapps/content/learning_sequences/views.py index 25f078d9f7a8..09baa7c4d14a 100644 --- a/openedx/core/djangoapps/content/learning_sequences/views.py +++ b/openedx/core/djangoapps/content/learning_sequences/views.py @@ -2,8 +2,8 @@ The views.py for this app is intentionally thin, and only exists to translate user input/output to and from the business logic in the `api` package. """ -from datetime import datetime, timezone import logging +from datetime import datetime, timezone from django.conf import settings from django.contrib.auth import get_user_model @@ -35,7 +35,7 @@ class CourseOutlineView(APIView): # We want to eventually allow unauthenticated users to use this as well... authentication_classes = (JwtAuthentication, SessionAuthenticationAllowInactiveUser) - class UserCourseOutlineDataSerializer(serializers.BaseSerializer): # lint-amnesty, pylint: disable=abstract-method + class UserCourseOutlineDataSerializer(serializers.BaseSerializer): # pylint: disable=abstract-method """ Read-only serializer for CourseOutlineData for this endpoint. @@ -55,7 +55,7 @@ class UserCourseOutlineDataSerializer(serializers.BaseSerializer): # lint-amnes are a critical part of the internals of edx-platform, so the in-process API uses them, but we translate them to "ids" for REST API clients. """ - def to_representation(self, user_course_outline_details): # lint-amnesty, pylint: disable=arguments-differ + def to_representation(self, user_course_outline_details): # pylint: disable=arguments-differ """ Convert to something DRF knows how to serialize (so no custom types) @@ -151,7 +151,7 @@ def _section_repr(self, section, section_schedule): **schedule_item_dict, } - def get(self, request, course_key_str, format=None): # lint-amnesty, pylint: disable=redefined-builtin, unused-argument + def get(self, request, course_key_str, format=None): # pylint: disable=redefined-builtin, unused-argument """ The CourseOutline, customized for a given user. @@ -161,7 +161,7 @@ def get(self, request, course_key_str, format=None): # lint-amnesty, pylint: di # Translate input params and do course key validation (will cause HTTP # 400 error if an invalid CourseKey was entered, instead of 404). course_key = validate_course_key(course_key_str) - at_time = datetime.now(timezone.utc) + at_time = datetime.now(timezone.utc) # noqa: UP017 # Get target user (and override request user for the benefit of any waffle checks) request.user = self._determine_user(request, course_key) diff --git a/openedx/core/djangoapps/content/search/api.py b/openedx/core/djangoapps/content/search/api.py index 9cdb51941996..6d6ce6148cd2 100644 --- a/openedx/core/djangoapps/content/search/api.py +++ b/openedx/core/djangoapps/content/search/api.py @@ -1,6 +1,7 @@ """ Content index and search API using Meilisearch """ + from __future__ import annotations import logging @@ -9,8 +10,9 @@ from contextlib import contextmanager, nullcontext from datetime import datetime, timedelta, timezone from functools import wraps -from typing import Callable, Generator, cast +from typing import Callable, Generator, cast # noqa: UP035 +from attrs import define from django.conf import settings from django.contrib.auth import get_user_model from django.core.cache import cache @@ -20,12 +22,9 @@ from meilisearch.models.task import TaskInfo from opaque_keys import OpaqueKey from opaque_keys.edx.keys import CourseKey, UsageKey -from opaque_keys.edx.locator import ( - LibraryCollectionLocator, - LibraryContainerLocator, - LibraryLocatorV2, -) -from openedx_learning.api import authoring as authoring_api +from opaque_keys.edx.locator import LibraryCollectionLocator, LibraryContainerLocator, LibraryLocatorV2 +from openedx_content import api as content_api +from openedx_content import models_api as content_models from rest_framework.request import Request from common.djangoapps.student.role_helpers import get_course_roles @@ -34,9 +33,10 @@ from openedx.core.djangoapps.content.search.index_config import ( INDEX_DISTINCT_ATTRIBUTE, INDEX_FILTERABLE_ATTRIBUTES, + INDEX_PRIMARY_KEY, INDEX_RANKING_RULES, INDEX_SEARCHABLE_ATTRIBUTES, - INDEX_SORTABLE_ATTRIBUTES + INDEX_SORTABLE_ATTRIBUTES, ) from openedx.core.djangoapps.content.search.models import IncrementalIndexCompleted, get_access_ids_for_request from openedx.core.djangoapps.content_libraries import api as lib_api @@ -47,13 +47,13 @@ Fields, meili_id_from_opaque_key, searchable_doc_collections, + searchable_doc_containers, searchable_doc_for_collection, searchable_doc_for_container, searchable_doc_for_course_block, - searchable_doc_for_library_block, searchable_doc_for_key, + searchable_doc_for_library_block, searchable_doc_tags, - searchable_doc_containers, ) log = logging.getLogger(__name__) @@ -78,7 +78,7 @@ MAX_ACCESS_IDS_IN_FILTER = 1_000 MAX_ORGS_IN_FILTER = 1_000 -EXCLUDED_XBLOCK_TYPES = ['course', 'course_info'] +EXCLUDED_XBLOCK_TYPES = ["course", "course_info"] @contextmanager @@ -152,29 +152,30 @@ def _wait_for_meili_task(info: TaskInfo) -> None: Simple helper method to wait for a Meilisearch task to complete This method will block until the task is completed, so it should only be used in celery tasks or management commands. + + ✨ Note: "Meilisearch processes tasks in the order they were added to the queue." + per https://www.meilisearch.com/docs/capabilities/indexing/tasks_and_batches/monitor_tasks#monitoring-task-status + so if you need to wait for multiple tasks, simply wait for the final (last) task. """ client = _get_meilisearch_client() + # This function almost always gets called immediately after enqueing a task, and from experiments, an initial wait + # of at least 15ms is warranted, as the task is almost never done in less than 10ms. We are using 20ms which seems + # to work well without requiring an additional wait in most cases. + sleep_delay = 0.020 # Initial wait is only 20ms but we will back off exponentially + time.sleep(sleep_delay) current_status = client.get_task(info.task_uid) while current_status.status in ("enqueued", "processing"): - time.sleep(0.5) + time.sleep(sleep_delay) + sleep_delay = min(sleep_delay * 1.5, 2.0) # Increase delay up to 2s current_status = client.get_task(info.task_uid) if current_status.status != "succeeded": try: - err_reason = current_status.error['message'] + err_reason = current_status.error["message"] except (TypeError, KeyError): err_reason = "Unknown error" raise MeilisearchError(err_reason) -def _wait_for_meili_tasks(info_list: list[TaskInfo]) -> None: - """ - Simple helper method to wait for multiple Meilisearch tasks to complete - """ - while info_list: - info = info_list.pop() - _wait_for_meili_task(info) - - def _index_exists(index_name: str) -> bool: """ Check if an index exists @@ -210,9 +211,7 @@ def _using_temp_index(status_cb: Callable[[str], None] | None = None) -> Generat _wait_for_meili_task(client.delete_index(temp_index_name)) status_cb("Creating new index...") - _wait_for_meili_task( - client.create_index(temp_index_name, {'primaryKey': 'id'}) - ) + _wait_for_meili_task(client.create_index(temp_index_name, {"primaryKey": INDEX_PRIMARY_KEY})) new_index_created = client.get_index(temp_index_name).created_at yield temp_index_name @@ -222,7 +221,7 @@ def _using_temp_index(status_cb: Callable[[str], None] | None = None) -> Generat status_cb("Preparing to swap into index (first time)...") _wait_for_meili_task(client.create_index(STUDIO_INDEX_NAME)) status_cb("Swapping index...") - client.swap_indexes([{'indexes': [temp_index_name, STUDIO_INDEX_NAME]}]) + client.swap_indexes([{"indexes": [temp_index_name, STUDIO_INDEX_NAME]}]) # If we're using an API key that's restricted to certain index prefix(es), we won't be able to get the status # of this request unfortunately. https://github.com/meilisearch/meilisearch/issues/4103 while True: @@ -247,28 +246,49 @@ def _index_is_empty(index_name: str) -> bool: return index.get_stats().number_of_documents == 0 -def _configure_index(index_name): +def _apply_index_settings( + index_name: str, + wait: bool, + status_cb: Callable[[str], None] | None = None, +) -> None: """ - Configure the index. The following index settings are best changed on an empty index. - Changing them on a populated index will "re-index all documents in the index", which can take some time. + Apply the standard Meilisearch settings to an index. + + When wait=False, settings are sent in fire-and-forget mode. This is appropriate + for empty temporary indexes that will immediately be populated on the same Meilisearch + task queue. + + When wait=True, each settings task is synchronously waited on before returning. + This is appropriate when reconciling a live index and we need confirmation that the + settings have been applied before returning. Args: - index_name (str): The name of the index to configure + index_name: The name of the index to configure. + wait: Whether to wait for each Meilisearch settings task to complete. + status_cb: Optional callback for status messages when wait=True. """ + if status_cb is None: + status_cb = log.info + client = _get_meilisearch_client() + index = client.index(index_name) + + settings_updates = ( + ("distinct attribute", index.update_distinct_attribute, INDEX_DISTINCT_ATTRIBUTE), + ("filterable attributes", index.update_filterable_attributes, INDEX_FILTERABLE_ATTRIBUTES), + ("searchable attributes", index.update_searchable_attributes, INDEX_SEARCHABLE_ATTRIBUTES), + ("sortable attributes", index.update_sortable_attributes, INDEX_SORTABLE_ATTRIBUTES), + ("ranking rules", index.update_ranking_rules, INDEX_RANKING_RULES), + ) - # Mark usage_key as unique (it's not the primary key for the index, but nevertheless must be unique): - client.index(index_name).update_distinct_attribute(INDEX_DISTINCT_ATTRIBUTE) - # Mark which attributes can be used for filtering/faceted search: - client.index(index_name).update_filterable_attributes(INDEX_FILTERABLE_ATTRIBUTES) - # Mark which attributes are used for keyword search, in order of importance: - client.index(index_name).update_searchable_attributes(INDEX_SEARCHABLE_ATTRIBUTES) - # Mark which attributes can be used for sorting search results: - client.index(index_name).update_sortable_attributes(INDEX_SORTABLE_ATTRIBUTES) + for label, update_method, value in settings_updates: + status_cb(f"Applying {label} to '{index_name}'...") + if wait: + _wait_for_meili_task(update_method(value)) + else: + update_method(value) - # Update the search ranking rules to let the (optional) "sort" parameter take precedence over keyword relevance. - # cf https://www.meilisearch.com/docs/learn/core_concepts/relevancy - client.index(index_name).update_ranking_rules(INDEX_RANKING_RULES) + status_cb(f"All settings applied to '{index_name}'.") def _recurse_children(block, fn, status_cb: Callable[[str], None] | None = None) -> None: @@ -305,24 +325,23 @@ def _update_index_docs(docs) -> None: client = _get_meilisearch_client() current_rebuild_index_name = _get_running_rebuild_index_name() - tasks = [] if current_rebuild_index_name: # If there is a rebuild in progress, the document will also be added to the new index. - tasks.append(client.index(current_rebuild_index_name).update_documents(docs)) - tasks.append(client.index(STUDIO_INDEX_NAME).update_documents(docs)) - - _wait_for_meili_tasks(tasks) + client.index(current_rebuild_index_name).update_documents(docs) + _wait_for_meili_task(client.index(STUDIO_INDEX_NAME).update_documents(docs)) def only_if_meilisearch_enabled(f): """ Only call `f` if meilisearch is enabled """ + @wraps(f) def wrapper(*args, **kwargs): """Wraps the decorated function.""" if is_meilisearch_enabled(): return f(*args, **kwargs) + return wrapper @@ -345,66 +364,186 @@ def reset_index(status_cb: Callable[[str], None] | None = None) -> None: status_cb("Creating new empty index...") with _using_temp_index(status_cb) as temp_index_name: - _configure_index(temp_index_name) + _apply_index_settings(temp_index_name, wait=False) status_cb("Index recreated!") status_cb("Index reset complete.") -def _is_index_configured(index_name: str) -> bool: +@define +class IndexDrift: + """ + Represents the drift state of a Meilisearch index compared to the expected configuration. + """ + + exists: bool + is_empty: bool | None = None # None if index doesn't exist + primary_key_correct: bool | None = None # None if index doesn't exist + distinct_attribute_match: bool | None = None + filterable_attributes_match: bool | None = None + searchable_attributes_match: bool | None = None + sortable_attributes_match: bool | None = None + ranking_rules_match: bool | None = None + + @property + def is_settings_drifted(self) -> bool: + """True if any of the 5 settings fields is False (not None, but explicitly False).""" + return any( + setting_fields is False + for setting_fields in ( + self.distinct_attribute_match, + self.filterable_attributes_match, + self.searchable_attributes_match, + self.sortable_attributes_match, + self.ranking_rules_match, + ) + ) + + +def _detect_index_drift(index_name: str) -> IndexDrift: """ - Check if an index is completely configured + Inspect the current state of a Meilisearch index and return a structured drift report. + + It provides per-setting match status plus primary key and emptiness information. Args: - index_name (str): The name of the index to check + index_name (str): The name of the index to inspect. + + Returns: + IndexDrift: Structured drift report. """ + if not _index_exists(index_name): + return IndexDrift(exists=False) + client = _get_meilisearch_client() index = client.get_index(index_name) + + # Check primary key + primary_key_correct = index.primary_key == INDEX_PRIMARY_KEY + + # Check emptiness + is_empty = index.get_stats().number_of_documents == 0 + + # Check settings index_settings = index.get_settings() - for k, v in ( - ("distinctAttribute", INDEX_DISTINCT_ATTRIBUTE), - ("filterableAttributes", INDEX_FILTERABLE_ATTRIBUTES), - ("searchableAttributes", INDEX_SEARCHABLE_ATTRIBUTES), - ("sortableAttributes", INDEX_SORTABLE_ATTRIBUTES), - ("rankingRules", INDEX_RANKING_RULES), - ): - setting = index_settings.get(k, []) - if isinstance(v, list): - v = set(v) - setting = set(setting) - if setting != v: - return False - return True + def _compare_setting(key, expected): + """Compare a single setting value against the expected value.""" + actual = index_settings.get(key, [] if isinstance(expected, list) else None) + if isinstance(expected, list): + # For ranking rules, order matters; for other lists, it doesn't + if key == "rankingRules": + return list(actual) == list(expected) + return set(actual) == set(expected) + return actual == expected + + return IndexDrift( + exists=True, + is_empty=is_empty, + primary_key_correct=primary_key_correct, + distinct_attribute_match=_compare_setting("distinctAttribute", INDEX_DISTINCT_ATTRIBUTE), + filterable_attributes_match=_compare_setting("filterableAttributes", INDEX_FILTERABLE_ATTRIBUTES), + searchable_attributes_match=_compare_setting("searchableAttributes", INDEX_SEARCHABLE_ATTRIBUTES), + sortable_attributes_match=_compare_setting("sortableAttributes", INDEX_SORTABLE_ATTRIBUTES), + ranking_rules_match=_compare_setting("rankingRules", INDEX_RANKING_RULES), + ) -def init_index(status_cb: Callable[[str], None] | None = None, warn_cb: Callable[[str], None] | None = None) -> None: + +def reconcile_index( + status_cb: Callable[[str], None] | None = None, warn_cb: Callable[[str], None] | None = None +) -> None: # noqa: E501 """ - Initialize the Meilisearch index, creating it and configuring it if it doesn't exist + Reconcile the Meilisearch index state. + + Inspects the current Studio Meilisearch index and takes appropriate action based on its state: + - Creates the index if missing. + - Reconfigures if empty and drifted. + - Applies updated settings if populated and drifted. + - Recreates the index if primary key is mismatched (even if populated — data loss is unavoidable). + - No-ops if everything is correctly configured. + + This is the primary reconciliation entry point, called from post_migrate and init_index(). """ if status_cb is None: status_cb = log.info if warn_cb is None: warn_cb = log.warning - if _index_exists(STUDIO_INDEX_NAME): - if _index_is_empty(STUDIO_INDEX_NAME): + drift = _detect_index_drift(STUDIO_INDEX_NAME) + + # CASE: Index missing + if not drift.exists: + status_cb("Studio search index not found. Creating and configuring...") + reset_index(status_cb) + status_cb("Index created. Run './manage.py cms reindex_studio' to populate.") + return + + # CASE: Primary key mismatch (must recreate regardless of population state) + if not drift.primary_key_correct: + if drift.is_empty: + warn_cb("Primary key mismatch on empty index. Recreating...") + else: warn_cb( - "The studio search index is empty. Please run ./manage.py cms reindex_studio" - " [--incremental]" + f"PRIMARY KEY MISMATCH on populated index '{STUDIO_INDEX_NAME}'. " + "Index must be recreated (data loss is unavoidable for primary key changes)." ) - return - if not _is_index_configured(STUDIO_INDEX_NAME): - warn_cb( - "A rebuild of the index is required. Please run ./manage.py cms reindex_studio" - " [--incremental]" + warn_cb("Dropping and recreating index. Repopulate with: './manage.py cms reindex_studio'") + reset_index(status_cb) + warn_cb("Index recreated empty. Run './manage.py cms reindex_studio' to repopulate.") + return + + # CASE: Index empty + if drift.is_empty: + if drift.is_settings_drifted: + status_cb("Empty index has drifted settings. Reconfiguring...") + _apply_index_settings(STUDIO_INDEX_NAME, wait=True, status_cb=status_cb) + status_cb("Reconfigured. Run './manage.py cms reindex_studio' to populate.") + else: + status_cb( + "Index exists and is correctly configured but empty. Run './manage.py cms reindex_studio' to populate." ) - return - status_cb("Index already exists and is configured.") return - reset_index(status_cb) + # CASE: Index populated, attribute drifted i.e settings mismatched + if drift.is_settings_drifted: + warn_cb(f"Settings drift detected on populated index '{STUDIO_INDEX_NAME}'. Applying updated settings...") + # Log per-setting mismatch details + for field_name, match in ( + ("distinctAttribute", drift.distinct_attribute_match), + ("filterableAttributes", drift.filterable_attributes_match), + ("searchableAttributes", drift.searchable_attributes_match), + ("sortableAttributes", drift.sortable_attributes_match), + ("rankingRules", drift.ranking_rules_match), + ): + if match is False: + warn_cb(f" - {field_name}: DRIFTED") + + _apply_index_settings(STUDIO_INDEX_NAME, wait=True, status_cb=status_cb) + warn_cb( + "Settings applied. Meilisearch will re-index documents in the background. " + "Consider running './manage.py cms reindex_studio' for a full rebuild " + "if search quality is affected." + ) + else: + status_cb("Index is populated and correctly configured. No action needed.") + + +def init_index(status_cb: Callable[[str], None] | None = None, warn_cb: Callable[[str], None] | None = None) -> None: + """ + This method is depricated as of Verawood and would be removed in the future release. + + Initialize the Meilisearch index, creating it and configuring it if it doesn't exist. + + This is a compatibility wrapper around reconcile_index(). + """ + log.warning("init_index is deprecated as of Verawood and will be removed in the future release.") + reconcile_index(status_cb=status_cb, warn_cb=warn_cb) -def index_course(course_key: CourseKey, index_name: str | None = None) -> list: +def index_course( + course_key: CourseKey, + index_name: str | None = None, + status_cb: Callable[[str], None] | None = None, +) -> list[dict]: """ Rebuilds the index for a given course. """ @@ -413,11 +552,18 @@ def index_course(course_key: CourseKey, index_name: str | None = None) -> list: docs = [] if index_name is None: index_name = STUDIO_INDEX_NAME + if status_cb is None: + status_cb = log.info + # Pre-fetch the course with all of its children: course = store.get_course(course_key, depth=None) + if course is None: + status_cb(f"Error: course {course_key} does not seem to exist! It may have been incompletely deleted.") + return [] + def add_with_children(block): - """ Recursively index the given XBlock/component """ + """Recursively index the given XBlock/component""" doc = searchable_doc_for_course_block(block) doc.update(searchable_doc_tags(block.usage_key)) docs.append(doc) # pylint: disable=cell-var-from-loop @@ -432,7 +578,9 @@ def add_with_children(block): return docs -def rebuild_index(status_cb: Callable[[str], None] | None = None, incremental=False) -> None: # lint-amnesty, pylint: disable=too-many-statements +def rebuild_index( # pylint: disable=too-many-statements + status_cb: Callable[[str], None] | None = None, incremental=False +) -> None: """ Rebuild the Meilisearch index from scratch """ @@ -446,6 +594,8 @@ def rebuild_index(status_cb: Callable[[str], None] | None = None, incremental=Fa keys_indexed = [] if incremental: keys_indexed = list(IncrementalIndexCompleted.objects.values_list("context_key", flat=True)) + if keys_indexed: + status_cb(f"Resuming incremental index - {len(keys_indexed)} courses/libraries already indexed.") lib_keys = [ lib.library_key for lib in lib_api.ContentLibrary.objects.select_related("org").only("org", "slug").order_by("-id") @@ -471,7 +621,7 @@ def rebuild_index(status_cb: Callable[[str], None] | None = None, incremental=Fa # Changing them on a populated index will "re-index all documents in the index", which can take some time # and use more RAM. Instead, we configure an empty index then populate it one course/library at a time. if not incremental: - _configure_index(index_name) + _apply_index_settings(index_name, wait=False) ############## Libraries ############## status_cb("Indexing libraries...") @@ -502,7 +652,7 @@ def index_collection_batch(batch, num_done, library_key) -> int: docs = [] for collection in batch: try: - collection_key = lib_api.library_collection_locator(library_key, collection.key) + collection_key = lib_api.library_collection_locator(library_key, collection.collection_code) doc = searchable_doc_for_collection(collection_key, collection=collection) doc.update(searchable_doc_tags(collection_key)) docs.append(doc) @@ -530,15 +680,15 @@ def index_container_batch(batch, num_done, library_key) -> int: doc = searchable_doc_for_container(container_key) doc.update(searchable_doc_tags(container_key)) doc.update(searchable_doc_collections(container_key)) - container_type = lib_api.ContainerType(container_key.container_type) - match container_type: - case lib_api.ContainerType.Unit: + container_type_code = container_key.container_type + match container_type_code: + case content_models.Unit.type_code: doc.update(searchable_doc_containers(container_key, "subsections")) - case lib_api.ContainerType.Subsection: + case content_models.Subsection.type_code: doc.update(searchable_doc_containers(container_key, "sections")) docs.append(doc) except Exception as err: # pylint: disable=broad-except - status_cb(f"Error indexing container {container.key}: {err}") + status_cb(f"Error indexing container {container.entity_ref}: {err}") num_done += 1 if docs: @@ -556,10 +706,11 @@ def index_container_batch(batch, num_done, library_key) -> int: # To reduce memory usage on large instances, split up the Collections into pages of 100 collections: library = lib_api.get_library(lib_key) - collections = authoring_api.get_collections(library.learning_package_id, enabled=True) + collections = content_api.get_collections(library.learning_package_id, enabled=True) num_collections = collections.count() num_collections_done = 0 - status_cb(f"{num_collections_done}/{num_collections}. Now indexing collections in library {lib_key}") + if num_collections: + status_cb(f"Now indexing {num_collections} collections in library {lib_key}") paginator = Paginator(collections, 100) for p in paginator.page_range: num_collections_done = index_collection_batch( @@ -567,15 +718,14 @@ def index_container_batch(batch, num_done, library_key) -> int: num_collections_done, lib_key, ) - if incremental: - IncrementalIndexCompleted.objects.get_or_create(context_key=lib_key) - status_cb(f"{num_collections_done}/{num_collections} collections indexed for library {lib_key}") + status_cb(f"Indexed {num_collections_done}/{num_collections} collections in library {lib_key}") # Similarly, batch process Containers (units, sections, etc) in pages of 100 - containers = authoring_api.get_containers(library.learning_package_id) + containers = content_api.get_containers(library.learning_package_id) num_containers = containers.count() num_containers_done = 0 - status_cb(f"{num_containers_done}/{num_containers}. Now indexing containers in library {lib_key}") + if num_containers: + status_cb(f"Now indexing {num_containers} containers in library {lib_key}") paginator = Paginator(containers, 100) for p in paginator.page_range: num_containers_done = index_container_batch( @@ -583,7 +733,9 @@ def index_container_batch(batch, num_done, library_key) -> int: num_containers_done, lib_key, ) - status_cb(f"{num_containers_done}/{num_containers} containers indexed for library {lib_key}") + status_cb(f"Indexed {num_containers_done}/{num_containers} containers in library {lib_key}") + + # Mark this library as indexed: if incremental: IncrementalIndexCompleted.objects.get_or_create(context_key=lib_key) @@ -593,7 +745,7 @@ def index_container_batch(batch, num_done, library_key) -> int: status_cb("Indexing courses...") # To reduce memory usage on large instances, split up the CourseOverviews into pages of 1,000 courses: - paginator = Paginator(CourseOverview.objects.only('id', 'display_name'), 1000) + paginator = Paginator(CourseOverview.objects.only("id", "display_name").order_by("-created", "id"), 1000) for p in paginator.page_range: for course in paginator.page(p).object_list: status_cb( @@ -602,7 +754,7 @@ def index_container_batch(batch, num_done, library_key) -> int: if course.id in keys_indexed: num_contexts_done += 1 continue - course_docs = index_course(course.id, index_name) + course_docs = index_course(course.id, index_name, status_cb) if incremental: IncrementalIndexCompleted.objects.get_or_create(context_key=course.id) num_contexts_done += 1 @@ -630,7 +782,7 @@ def upsert_xblock_index_doc(usage_key: UsageKey, recursive: bool = True) -> None docs = [] def add_with_children(block): - """ Recursively index the given XBlock/component """ + """Recursively index the given XBlock/component""" doc = searchable_doc_for_course_block(block) docs.append(doc) if recursive: @@ -674,13 +826,10 @@ def _delete_documents(filter_query: str) -> None: client = _get_meilisearch_client() current_rebuild_index_name = _get_running_rebuild_index_name() - tasks = [] if current_rebuild_index_name: # If there is a rebuild in progress, the document will also be removed from the new index. - tasks.append(client.index(current_rebuild_index_name).delete_documents(filter=filter_query)) - tasks.append(client.index(STUDIO_INDEX_NAME).delete_documents(filter=filter_query)) - - _wait_for_meili_tasks(tasks) + client.index(current_rebuild_index_name).delete_documents(filter=filter_query) + _wait_for_meili_task(client.index(STUDIO_INDEX_NAME).delete_documents(filter=filter_query)) def _delete_index_doc(doc_id) -> None: @@ -695,14 +844,11 @@ def _delete_index_doc(doc_id) -> None: client = _get_meilisearch_client() current_rebuild_index_name = _get_running_rebuild_index_name() - tasks = [] if current_rebuild_index_name: # If there is a rebuild in progress, the document will also be removed from the new index. - tasks.append(client.index(current_rebuild_index_name).delete_document(doc_id)) + client.index(current_rebuild_index_name).delete_document(doc_id) - tasks.append(client.index(STUDIO_INDEX_NAME).delete_document(doc_id)) - - _wait_for_meili_tasks(tasks) + _wait_for_meili_task(client.index(STUDIO_INDEX_NAME).delete_document(doc_id)) def upsert_library_block_index_doc(usage_key: UsageKey) -> None: @@ -713,9 +859,7 @@ def upsert_library_block_index_doc(usage_key: UsageKey) -> None: library_block = lib_api.get_component_from_usage_key(usage_key) library_block_metadata = lib_api.LibraryXBlockMetadata.from_component(usage_key.context_key, library_block) - docs = [ - searchable_doc_for_library_block(library_block_metadata) - ] + docs = [searchable_doc_for_library_block(library_block_metadata)] _update_index_docs(docs) @@ -746,38 +890,27 @@ def upsert_library_collection_index_doc(collection_key: LibraryCollectionLocator If the Collection is not found or disabled (i.e. soft-deleted), then delete it from the search index. """ doc = searchable_doc_for_collection(collection_key) - update_items = False - - # Soft-deleted/disabled collections are removed from the index - # and their components updated. - if doc.get('_disabled'): - - _delete_index_doc(doc[Fields.id]) - - update_items = True - - # Hard-deleted collections are also deleted from the index, - # but their components are automatically updated as part of the deletion process, so we don't have to. - elif not doc.get(Fields.type): - + # Soft-deleted/disabled/hard-deleted collections are removed from the index: + # (If the collection is soft-deleted, searchable_doc_for_collection() sets `_disabled: True`) + # (If the collection is hard-deleted, searchable_doc_for_collection() leaves all fields other than ID empty) + if doc.get("_disabled") or not doc.get(Fields.type): _delete_index_doc(doc[Fields.id]) + return - # Otherwise, upsert the collection. - # Newly-added/restored collection get their components updated too. - else: - already_indexed = _get_document_from_index(doc[Fields.id]) - if not already_indexed: - update_items = True - - _update_index_docs([doc]) - - # Asynchronously update the collection's components "collections" field - if update_items: - from .tasks import update_library_components_collections as update_components_task - from .tasks import update_library_containers_collections as update_containers_task + # Normal case - update the collection doc. + _update_index_docs([doc]) - update_components_task.delay(str(collection_key)) - update_containers_task.delay(str(collection_key)) + # We do NOT update the individual entities (components/containers) in the collection here. + # This event can be called if a single entity is added or removed from the collection (to update the "# of items in + # collection" field (Fields.num_children), and we don't want to re-index all entities in that case). + # + # If the collection is renamed, the COLLECTION_CHANGED signal will be emitted, and content_libraries will handle it + # and emit CONTENT_OBJECT_ASSOCIATIONS_CHANGED for every entity in the collection, which will update their + # "collections" field in the search index. + # + # If the collection is enabled/disabled/deleted, the COLLECTION_CHANGED signal will include all entities in the + # collection as added or removed, which the same libraries signal handler will convert to + # CONTENT_OBJECT_ASSOCIATIONS_CHANGED events, which will update them. def update_library_components_collections( @@ -791,7 +924,7 @@ def update_library_components_collections( """ library_key = collection_key.lib_key library = lib_api.get_library(library_key) - components = authoring_api.get_collection_components( + components = content_api.get_collection_components( library.learning_package_id, collection_key.collection_id, ) @@ -810,8 +943,7 @@ def update_library_components_collections( docs.append(doc) log.info( - f"Updating document.collections for library {library_key} components" - f" page {page} / {paginator.num_pages}" + f"Updating document.collections for library {library_key} components page {page} / {paginator.num_pages}" ) _update_index_docs(docs) @@ -827,27 +959,30 @@ def update_library_containers_collections( """ library_key = collection_key.lib_key library = lib_api.get_library(library_key) - containers = authoring_api.get_collection_containers( - library.learning_package_id, - collection_key.collection_id, + container_entities = ( + content_api.get_collection_entities( + library.learning_package_id, + collection_key.collection_id, + ) + .exclude(container=None) + .select_related("container") ) - paginator = Paginator(containers, batch_size) + paginator = Paginator(container_entities, batch_size) for page in paginator.page_range: docs = [] - for container in paginator.page(page).object_list: + for container_entity in paginator.page(page).object_list: container_key = lib_api.library_container_locator( library_key, - container, + container_entity.container, ) doc = searchable_doc_for_key(container_key) doc.update(searchable_doc_collections(container_key)) docs.append(doc) log.info( - f"Updating document.collections for library {library_key} containers" - f" page {page} / {paginator.num_pages}" + f"Updating document.collections for library {library_key} containers page {page} / {paginator.num_pages}" ) _update_index_docs(docs) @@ -862,13 +997,11 @@ def upsert_library_container_index_doc(container_key: LibraryContainerLocator) - # Soft-deleted/disabled containers are removed from the index # and their components updated. - if doc.get('_disabled'): - + if doc.get("_disabled"): _delete_index_doc(doc[Fields.id]) # Hard-deleted containers are also deleted from the index elif not doc.get(Fields.type): - _delete_index_doc(doc[Fields.id]) # Otherwise, upsert the container. @@ -897,7 +1030,7 @@ def upsert_content_library_index_docs(library_key: LibraryLocatorV2, full_index: docs.append(doc) for collection in lib_api.get_library_collections(library_key): - collection_key = lib_api.library_collection_locator(library_key, collection.key) + collection_key = lib_api.library_collection_locator(library_key, collection.collection_code) doc = searchable_doc_for_collection(collection_key, collection=collection) docs.append(doc) @@ -938,11 +1071,9 @@ def _get_user_orgs(request: Request) -> list[str]: Note: org-level roles have course_id=None to distinguish them from course-level roles. """ course_roles = get_course_roles(request.user) - return list(set( - role.org - for role in course_roles - if role.course_id is None and role.role in ['staff', 'instructor'] - )) + return list( + set(role.org for role in course_roles if role.course_id is None and role.role in ["staff", "instructor"]) + ) def _get_meili_access_filter(request: Request) -> dict: @@ -967,7 +1098,7 @@ def generate_user_token_for_studio_search(request): """ Returns a Meilisearch API key that only allows the user to search content that they have permission to view """ - expires_at = datetime.now(tz=timezone.utc) + timedelta(days=7) + expires_at = datetime.now(tz=timezone.utc) + timedelta(days=7) # noqa: UP017 search_rules = { STUDIO_INDEX_NAME: _get_meili_access_filter(request), @@ -1035,7 +1166,7 @@ def fetch_block_types(extra_filter: Filter | None = None): "facets": ["block_type"], "filter": extra_filter_formatted, "limit": 0, - } + }, ) return response @@ -1068,7 +1199,7 @@ def get_all_blocks_from_context( "limit": limit, "offset": offset, "attributesToRetrieve": ["usage_key"] + (extra_attributes_to_retrieve or []), - } + }, ) yield from response["hits"] diff --git a/openedx/core/djangoapps/content/search/apps.py b/openedx/core/djangoapps/content/search/apps.py index 13a83a11a6a6..38e3ad92aa4a 100644 --- a/openedx/core/djangoapps/content/search/apps.py +++ b/openedx/core/djangoapps/content/search/apps.py @@ -10,7 +10,13 @@ class ContentSearchConfig(AppConfig): default_auto_field = "django.db.models.BigAutoField" name = "openedx.core.djangoapps.content.search" + label = "search" def ready(self): # Connect signal handlers - from . import handlers # pylint: disable=unused-import + # Connect post_migrate for Meilisearch index reconciliation. + # No sender= argument here; the handler filters by sender.label internally. + from django.db.models.signals import post_migrate # pylint: disable=import-outside-toplevel + + from . import handlers # pylint: disable=unused-import # noqa: F401 + post_migrate.connect(handlers.handle_post_migrate) diff --git a/openedx/core/djangoapps/content/search/documents.py b/openedx/core/djangoapps/content/search/documents.py index df673db55dd6..028fc203ee95 100644 --- a/openedx/core/djangoapps/content/search/documents.py +++ b/openedx/core/djangoapps/content/search/documents.py @@ -7,11 +7,12 @@ from hashlib import blake2b from django.core.exceptions import ObjectDoesNotExist +from django.db.models import F from django.utils.text import slugify -from opaque_keys.edx.keys import ContainerKey, LearningContextKey, UsageKey, OpaqueKey +from opaque_keys.edx.keys import ContainerKey, LearningContextKey, OpaqueKey, UsageKey from opaque_keys.edx.locator import LibraryCollectionLocator, LibraryContainerLocator -from openedx_learning.api import authoring as authoring_api -from openedx_learning.api.authoring_models import Collection +from openedx_content import api as content_api +from openedx_content.models_api import Collection from rest_framework.exceptions import NotFound from openedx.core.djangoapps.content.search.models import SearchAccess @@ -33,7 +34,7 @@ class Fields: usage_key = "usage_key" type = "type" # DocType.course_block or DocType.library_block (see below) # The block_id part of the usage key for course or library blocks. - # If it's a collection, the collection.key is stored here. + # If it's a collection, the collection.collection_code is stored here. # Sometimes human-readable, sometimes a random hex ID # Is only unique within the given context_key. block_id = "block_id" @@ -64,7 +65,8 @@ class Fields: tags_level2 = "level2" tags_level3 = "level3" # Collections (dictionary) that this object belongs to. - # Similarly to tags above, we collect the collection.titles and collection.keys into hierarchical facets. + # Similarly to tags above, we collect the collection.titles and collection.collection_codes + # into hierarchical facets. collections = "collections" collections_display_name = "display_name" collections_key = "key" @@ -137,7 +139,7 @@ def meili_id_from_opaque_key(key: OpaqueKey) -> str: hyphens (-) and underscores (_). Since our opaque keys don't meet this requirement, we transform them to a similar slug ID string that does. - In the future, with Learning Core's data models in place for courseware, + In the future, with openedx_content's data models in place for courseware, we could use PublishableEntity's primary key / UUID instead. """ # The slugified key _may_ not be unique so we append a hashed string to make it unique: @@ -232,7 +234,9 @@ class implementation returns only: if hasattr(block, "edited_on"): block_data[Fields.modified] = block.edited_on.timestamp() # Get the breadcrumbs (course, section, subsection, etc.): - if block.usage_key.context_key.is_course: # Getting parent is not yet implemented in Learning Core (for libraries). + # TODO: Implement this for library items too. Libraries didn't support hierarchy at the time + # this code was originally written. + if block.usage_key.context_key.is_course: cur_block = block while cur_block.parent: if not cur_block.has_cached_parent: @@ -376,15 +380,23 @@ def searchable_doc_tags(object_id: OpaqueKey) -> dict: # if we used get_all_object_tags() to load all the tags for the library in a single query rather than loading the # tags for each component separately. all_tags = tagging_api.get_object_tags(str(object_id)).all() - if not all_tags: - # Clear out tags in the index when unselecting all tags for the block, otherwise - # it would remain the last value if a cleared Fields.tags field is not included - return {Fields.tags: {}} result = { Fields.tags_taxonomy: [], Fields.tags_level0: [], - # ... other levels added as needed + Fields.tags_level1: [], + Fields.tags_level2: [], + Fields.tags_level3: [], } + if not all_tags: + # Clear out tags in the index when the block has no tags (anymore) + # Note: due to a bug in Meilisearch, just setting `{Fields.tags: {}}` + # does not properly clear previously-set values within the tags field, + # like tags.level0, so we explicitly set `{Field.tags: { level0: [], ... }}` + # etc. to work around that and ensure tags are removed properly. + # In the future, if Meili's bug is fixed, we can perhaps simplify this + # and go back to just setting {Fields.tags: {}}` when there are no tags. + return {Fields.tags: result} + for obj_tag in all_tags: # Add the taxonomy name: if obj_tag.taxonomy.name not in result[Fields.tags_taxonomy]: @@ -446,10 +458,13 @@ def searchable_doc_collections(object_id: OpaqueKey) -> dict: try: if isinstance(object_id, UsageKey): component = lib_api.get_component_from_usage_key(object_id) - collections = authoring_api.get_entity_collections( + # Temporarily alias collection_code to "key" so downstream consumers + # (search indexer, REST API) keep the same field name. We will update + # downstream consumers later: https://github.com/openedx/openedx-platform/issues/38406 + collections = content_api.get_entity_collections( component.learning_package_id, - component.key, - ).values('key', 'title') + component.entity_ref, + ).values("title", key=F('collection_code')) elif isinstance(object_id, LibraryContainerLocator): container = lib_api.get_container(object_id, include_collections=True) collections = container.collections @@ -505,7 +520,7 @@ def searchable_doc_containers(object_id: OpaqueKey, container_type: str) -> dict else: log.warning(f"Unexpected key type for {object_id}") - except ObjectDoesNotExist: + except (ObjectDoesNotExist, lib_api.ContentLibraryBlockNotFound): log.warning(f"No library item found for {object_id}") if not containers: @@ -541,13 +556,16 @@ def searchable_doc_for_collection( pass if collection: - assert collection.key == collection_key.collection_id + assert collection.collection_code == collection_key.collection_id - draft_num_children = authoring_api.filter_publishable_entities( + # Collections themselves are not publishable entities, so don't have a "draft" or "published" version, but the + # entities they contain are publishable, so the number of entities in the collection may be different between + # draft and published views, if some draft entities are unpublished or are published but the draft is deleted. + draft_num_children = content_api.filter_publishable_entities( collection.entities, has_draft=True, ).count() - published_num_children = authoring_api.filter_publishable_entities( + published_num_children = content_api.filter_publishable_entities( collection.entities, has_published=True, ).count() @@ -556,7 +574,7 @@ def searchable_doc_for_collection( Fields.context_key: str(collection_key.context_key), Fields.org: str(collection_key.org), Fields.usage_key: str(collection_key), - Fields.block_id: collection.key, + Fields.block_id: collection.collection_code, Fields.type: DocType.collection, Fields.display_name: collection.title, Fields.description: collection.description, @@ -587,8 +605,8 @@ def searchable_doc_for_container( found using faceted search. If no container is found for the given container key, the returned document - will contain only basic information derived from the container key, and no - Fields.type value will be included in the returned dict. + will contain only basic information derived from the container key, and some + fields like Fields.display_name will be missing from the returned dict. """ doc = { Fields.id: meili_id_from_opaque_key(container_key), @@ -612,42 +630,21 @@ def searchable_doc_for_container( log.error(f"Container {container_key} not found") return doc - draft_children = lib_api.get_container_children( - container_key, - published=False, - ) + draft_children = lib_api.get_container_children_list(container_key, published=False) publish_status = PublishStatus.published if container.last_published is None: publish_status = PublishStatus.never elif container.has_unpublished_changes: publish_status = PublishStatus.modified - container_type = lib_api.ContainerType(container_key.container_type) - - def get_child_keys(children) -> list[str]: - match container_type: - case lib_api.ContainerType.Unit: - return [ - str(child.usage_key) - for child in children - ] - case lib_api.ContainerType.Subsection | lib_api.ContainerType.Section: - return [ - str(child.container_key) - for child in children - ] - - def get_child_names(children) -> list[str]: - return [child.display_name for child in children] - doc.update({ Fields.display_name: container.display_name, Fields.created: container.created.timestamp(), Fields.modified: container.modified.timestamp(), Fields.num_children: len(draft_children), Fields.content: { - Fields.child_usage_keys: get_child_keys(draft_children), - Fields.child_display_names: get_child_names(draft_children), + Fields.child_usage_keys: [str(child.key) for child in draft_children], + Fields.child_display_names: [child.display_name for child in draft_children], }, Fields.publish_status: publish_status, Fields.last_published: container.last_published.timestamp() if container.last_published else None, @@ -657,16 +654,13 @@ def get_child_names(children) -> list[str]: doc[Fields.breadcrumbs] = [{"display_name": library.title}] if container.published_version_num is not None: - published_children = lib_api.get_container_children( - container_key, - published=True, - ) + published_children = lib_api.get_container_children_list(container_key, published=True) doc[Fields.published] = { Fields.published_display_name: container.published_display_name, Fields.published_num_children: len(published_children), Fields.published_content: { - Fields.child_usage_keys: get_child_keys(published_children), - Fields.child_display_names: get_child_names(published_children), + Fields.child_usage_keys: [str(child.key) for child in published_children], + Fields.child_display_names: [child.display_name for child in published_children], }, } diff --git a/openedx/core/djangoapps/content/search/handlers.py b/openedx/core/djangoapps/content/search/handlers.py index 38dac3153596..0fe93292d8fa 100644 --- a/openedx/core/djangoapps/content/search/handlers.py +++ b/openedx/core/djangoapps/content/search/handlers.py @@ -47,7 +47,9 @@ from xmodule.modulestore.django import SignalHandler from .api import ( + is_meilisearch_enabled, only_if_meilisearch_enabled, + reconcile_index, upsert_content_object_tags_index_doc, upsert_item_collections_index_docs, upsert_item_containers_index_docs, @@ -68,6 +70,37 @@ log = logging.getLogger(__name__) +def handle_post_migrate(sender, **kwargs): + """ + Reconcile Meilisearch index state after Django migrations run. + + Filters on sender.label to only execute for the search app's post_migrate signal. + Tolerant of Meilisearch unavailability — logs a warning and continues. + """ + from .apps import ContentSearchConfig # pylint: disable=import-outside-toplevel + + if sender.label != ContentSearchConfig.label: + return + + if not is_meilisearch_enabled(): + return + + try: + reconcile_index(status_cb=log.info, warn_cb=log.warning) + except ConnectionError as exc: + log.warning( + "Meilisearch reconciliation skipped during post_migrate: %s. " + "Will retry on next migrate run.", + exc, + ) + except Exception as exc: # pylint: disable=broad-except + log.warning( + "Meilisearch reconciliation failed during post_migrate: %s. " + "Will retry on next migrate run.", + exc, + ) + + # Using post_delete here because there is no COURSE_DELETED event defined. @receiver(post_delete, sender=CourseOverview) def delete_course_search_access(sender, instance, **kwargs): # pylint: disable=unused-argument @@ -192,7 +225,7 @@ def library_block_deleted(**kwargs) -> None: @only_if_meilisearch_enabled def content_library_created_handler(**kwargs) -> None: """ - Create the index for the content library + Create the index and SearchAccess for the content library """ content_library_data = kwargs.get("content_library", None) if not content_library_data or not isinstance(content_library_data, ContentLibraryData): # pragma: no cover @@ -200,6 +233,10 @@ def content_library_created_handler(**kwargs) -> None: return library_key = content_library_data.library_key + # Create SearchAccess record immediately so course creators can search this library + # right after creation. Without this, the JWT token won't include the new library's + # access_id until it's added by the document indexing process or the page is refreshed. + SearchAccess.objects.get_or_create(context_key=library_key) update_content_library_index_docs.apply(args=[str(library_key), True]) diff --git a/openedx/core/djangoapps/content/search/index_config.py b/openedx/core/djangoapps/content/search/index_config.py index 8b96adc8b4db..0f55a00347fc 100644 --- a/openedx/core/djangoapps/content/search/index_config.py +++ b/openedx/core/djangoapps/content/search/index_config.py @@ -1,6 +1,8 @@ """Configuration for the search index.""" from .documents import Fields +# The Meilisearch primary key for all documents in the index. +INDEX_PRIMARY_KEY = Fields.id INDEX_DISTINCT_ATTRIBUTE = "usage_key" diff --git a/openedx/core/djangoapps/content/search/management/commands/reindex_studio.py b/openedx/core/djangoapps/content/search/management/commands/reindex_studio.py index a320790739a1..a1d7318f16c0 100644 --- a/openedx/core/djangoapps/content/search/management/commands/reindex_studio.py +++ b/openedx/core/djangoapps/content/search/management/commands/reindex_studio.py @@ -1,43 +1,111 @@ """ -Command to build or re-build the search index for courses (in Studio, i.e. Draft -mode), in Meilisearch. +Command to queue incremental population of the Studio Meilisearch search index. + +Index creation, configuration, and schema reconciliation are handled +automatically via the post_migrate signal. This command is solely +responsible for enqueuing the population task in Celery. See also cms/djangoapps/contentstore/management/commands/reindex_course.py which indexes LMS (published) courses in ElasticSearch. """ + +import logging + +from django.conf import settings from django.core.management import BaseCommand, CommandError from ... import api +from ...tasks import rebuild_index_incremental + +log = logging.getLogger(__name__) class Command(BaseCommand): """ - Build or re-build the Meilisearch search index for courses and libraries in Studio. + Add all course and library content to the Studio search index. + + This enqueues a Celery task that incrementally indexes all courses and + libraries. Progress is tracked via IncrementalIndexCompleted, so the task + can safely resume if interrupted. + + Index creation and configuration are handled by post_migrate reconciliation + (runs automatically on ./manage.py cms migrate). - This is separate from LMS search features like courseware search or forum search. + If it's ever necessary to reset the incremental indexing state (force + the full re-index process to start from the beginning), use: + + ./manage.py cms shell -c 'IncrementalIndexCompleted.objects.all().delete()' + + This will delete all the IncrementalIndexCompleted records and will help in restarting the index population. """ - # TODO: improve this - see https://github.com/openedx/edx-platform/issues/36868 + help = "Add all course and library content to the Studio search index." def add_arguments(self, parser): - parser.add_argument("--experimental", action="store_true") # kept for compatibility but ignored. - parser.add_argument("--reset", action="store_true") - parser.add_argument("--init", action="store_true") - parser.add_argument("--incremental", action="store_true") - parser.set_defaults(experimental=False, reset=False, init=False, incremental=False) + # Removed flags — provide clear error messages for operators with old automation. + parser.add_argument( + "--experimental", + action="store_true", + default=False, + help="(Removed) reindex_studio is no longer experimental.", + ) + parser.add_argument( + "--reset", + action="store_true", + default=False, + help="(Removed) Index reset is now handled by post_migrate reconciliation.", + ) + parser.add_argument( + "--init", + action="store_true", + default=False, + help="(Removed) Index initialization is now handled by post_migrate reconciliation.", + ) + parser.add_argument( + "--incremental", + action="store_true", + default=False, + help="(Removed) Incremental is now the default and only population mode.", + ) def handle(self, *args, **options): - """ - Build a new search index for Studio, containing content from courses and libraries - """ if not api.is_meilisearch_enabled(): raise CommandError("Meilisearch is not enabled. Please set MEILISEARCH_ENABLED to True in your settings.") if options["reset"]: - api.reset_index(self.stdout.write) - elif options["init"]: - api.init_index(self.stdout.write, self.stderr.write) - elif options["incremental"]: - api.rebuild_index(self.stdout.write, incremental=True) + log.warning( + "The --reset flag has been removed. " + "Index reset is now handled automatically by post_migrate reconciliation. " + "Run: ./manage.py cms migrate" + ) + + if options["init"]: + log.warning( + "The --init flag has been removed. " + "Index initialization is now handled automatically by post_migrate reconciliation. " + "Run: ./manage.py cms migrate" + ) + + if options["incremental"]: + log.warning( + "The --incremental flag has been removed. " + "Incremental population is now the default behavior of this command." + ) + if options["experimental"]: + log.warning( + "The --experimental flag has been removed. " + "reindex_studio is now a stable command, so the flag is no longer necessary." + ) + + result = rebuild_index_incremental.delay() + + if settings.CELERY_ALWAYS_EAGER: + self.stdout.write("Indexing complete!") else: - api.rebuild_index(self.stdout.write) + self.stdout.write( + f"Studio search index population has been queued (task_id={result.id}). " + "Population will run incrementally in a Celery worker. " + "Monitor progress in Celery worker logs. " + "In order to reset the incremental indexing state, please run: " + "./manage.py cms shell -c 'IncrementalIndexCompleted.objects.all().delete()'" + ) diff --git a/openedx/core/djangoapps/content/search/migrations/0002_incrementalindexcompleted.py b/openedx/core/djangoapps/content/search/migrations/0002_incrementalindexcompleted.py index a316c35a7dfe..60266dfd5d21 100644 --- a/openedx/core/djangoapps/content/search/migrations/0002_incrementalindexcompleted.py +++ b/openedx/core/djangoapps/content/search/migrations/0002_incrementalindexcompleted.py @@ -1,7 +1,7 @@ # Generated by Django 4.2.16 on 2024-11-15 12:40 -from django.db import migrations, models import opaque_keys.edx.django.models +from django.db import migrations, models class Migration(migrations.Migration): diff --git a/openedx/core/djangoapps/content/search/models.py b/openedx/core/djangoapps/content/search/models.py index 6fa53ef17b34..d726f1ead057 100644 --- a/openedx/core/djangoapps/content/search/models.py +++ b/openedx/core/djangoapps/content/search/models.py @@ -12,7 +12,7 @@ from openedx.core.djangoapps.content_libraries.api import get_libraries_for_user -class SearchAccess(models.Model): +class SearchAccess(models.Model): # noqa: DJ008 """ Stores a numeric ID for each ContextKey. @@ -21,6 +21,8 @@ class SearchAccess(models.Model): a) in some deployments, users may be granted access to more than 1_000 individual courses, and b) the search filter request is stored in the JWT, which is limited to 8Kib. + + .. no_pii: """ id = models.BigAutoField( primary_key=True, @@ -67,9 +69,11 @@ def get_access_ids_for_request(request: Request, omit_orgs: list[str] = None) -> ) -class IncrementalIndexCompleted(models.Model): +class IncrementalIndexCompleted(models.Model): # noqa: DJ008 """ Stores the contex keys of aleady indexed courses and libraries for incremental indexing. + + .. no_pii: """ context_key = LearningContextKeyField( diff --git a/openedx/core/djangoapps/content/search/plain_text_math.py b/openedx/core/djangoapps/content/search/plain_text_math.py index 70f6c3fd2cf0..e1f550e3b554 100644 --- a/openedx/core/djangoapps/content/search/plain_text_math.py +++ b/openedx/core/djangoapps/content/search/plain_text_math.py @@ -65,7 +65,7 @@ def _nested_bracket_matcher(equation: str, opening_pattern: str) -> str: raise EqnPatternNotFound() open_count = 0 inner_start = start + len(opening_pattern) - for i, char in enumerate(equation[inner_start:]): + for i, char in enumerate(equation[inner_start:]): # noqa: B007 if char == "{": open_count += 1 if char == "}": diff --git a/openedx/core/djangoapps/content/search/tasks.py b/openedx/core/djangoapps/content/search/tasks.py index 8d18c2aae6ee..a95bedb062db 100644 --- a/openedx/core/djangoapps/content/search/tasks.py +++ b/openedx/core/djangoapps/content/search/tasks.py @@ -184,3 +184,36 @@ def delete_course_index_docs(course_key_str: str) -> None: # Delete children index data for course blocks. api.delete_docs_with_context_key(course_key) + + +@shared_task( + base=LoggedTask, + autoretry_for=(MeilisearchError, ConnectionError), + max_retries=3, + retry_backoff=True, +) +@set_code_owner_attribute +def rebuild_index_incremental() -> None: + """ + Celery task to incrementally populate the Studio Meilisearch index. + + Uses IncrementalIndexCompleted to track progress and resume from where + it left off if interrupted. Safe to call multiple times — already-indexed + contexts are skipped. + + If a rebuild is already in progress (lock held), the task exits gracefully. + """ + log.info("Starting incremental Studio search index population...") + + try: + api.rebuild_index(status_cb=log.info, incremental=True) + except RuntimeError as exc: + # rebuild_index -> _using_temp_index or lock contention + if "already in progress" in str(exc).lower(): + log.warning( + "Studio index population skipped: a rebuild is already in progress. Will retry later if re-enqueued." + ) + return + raise + + log.info("Incremental Studio search index population complete.") diff --git a/openedx/core/djangoapps/content/search/tests/test_api.py b/openedx/core/djangoapps/content/search/tests/test_api.py index f0213eae75a2..3fd6859cafd8 100644 --- a/openedx/core/djangoapps/content/search/tests/test_api.py +++ b/openedx/core/djangoapps/content/search/tests/test_api.py @@ -4,36 +4,42 @@ from __future__ import annotations import copy - -from datetime import datetime, timezone +from datetime import UTC, datetime from unittest.mock import MagicMock, Mock, call, patch -from opaque_keys.edx.keys import UsageKey -from opaque_keys.edx.locator import LibraryCollectionLocator, LibraryContainerLocator import ddt import pytest from django.test import override_settings from freezegun import freeze_time from meilisearch.errors import MeilisearchApiError -from openedx_learning.api import authoring as authoring_api +from opaque_keys.edx.keys import UsageKey +from opaque_keys.edx.locator import LibraryCollectionLocator, LibraryContainerLocator +from openedx_content import api as content_api +from openedx_content import models_api as content_models from organizations.tests.factories import OrganizationFactory from common.djangoapps.student.tests.factories import UserFactory +from openedx.core.djangoapps.content.course_overviews.api import CourseOverview from openedx.core.djangoapps.content_libraries import api as library_api from openedx.core.djangoapps.content_tagging import api as tagging_api -from openedx.core.djangoapps.content.course_overviews.api import CourseOverview from openedx.core.djangolib.testing.utils import skip_unless_cms from xmodule.modulestore.tests.django_utils import TEST_DATA_SPLIT_MODULESTORE, ModuleStoreTestCase - try: # This import errors in the lms because content.search is not an installed app there. from .. import api - from ..models import SearchAccess, IncrementalIndexCompleted + from ..models import IncrementalIndexCompleted, SearchAccess except RuntimeError: SearchAccess = {} STUDIO_SEARCH_ENDPOINT_URL = "/api/content_search/v2/studio/" +EMPTY_TAGS = { + "taxonomy": [], + "level0": [], + "level1": [], + "level2": [], + "level3": [], +} @ddt.ddt @@ -62,7 +68,7 @@ def setUp(self) -> None: # Clear the Meilisearch client to avoid side effects from other tests api.clear_meilisearch_client() - modified_date = datetime(2024, 5, 6, 7, 8, 9, tzinfo=timezone.utc) + modified_date = datetime(2024, 5, 6, 7, 8, 9, tzinfo=UTC) # Create course with freeze_time(modified_date): self.course = self.store.create_course( @@ -135,7 +141,7 @@ def setUp(self) -> None: lib_access, _ = SearchAccess.objects.get_or_create(context_key=self.library.key) # Populate it with 2 problems, freezing the date so we can verify created date serializes correctly. - self.created_date = datetime(2023, 4, 5, 6, 7, 8, tzinfo=timezone.utc) + self.created_date = datetime(2023, 4, 5, 6, 7, 8, tzinfo=UTC) with freeze_time(self.created_date): self.problem1 = library_api.create_library_block(self.library.key, "problem", "p1") self.problem2 = library_api.create_library_block(self.library.key, "problem", "p2") @@ -189,11 +195,11 @@ def setUp(self) -> None: tagging_api.add_tag_to_taxonomy(self.taxonomyB, "four") # Create a collection: - self.learning_package = authoring_api.get_learning_package_by_key(self.library.key) + self.learning_package = content_api.get_learning_package_by_ref(str(self.library.key)) with freeze_time(self.created_date): - self.collection = authoring_api.create_collection( + self.collection = content_api.create_collection( learning_package_id=self.learning_package.id, - key="MYCOL", + collection_code="MYCOL", title="my_collection", created_by=None, description="my collection description" @@ -203,7 +209,7 @@ def setUp(self) -> None: ) self.collection_dict = { "id": "lib-collectionorg1libmycol-5b647617", - "block_id": self.collection.key, + "block_id": self.collection.collection_code, "usage_key": str(self.collection_key), "type": "collection", "display_name": "my_collection", @@ -224,7 +230,7 @@ def setUp(self) -> None: with freeze_time(self.created_date): self.unit = library_api.create_container( library_key=self.library.key, - container_type=library_api.ContainerType.Unit, + container_cls=content_models.Unit, slug="unit-1", title="Unit 1", user_id=None, @@ -232,7 +238,7 @@ def setUp(self) -> None: self.unit_key = "lct:org1:lib:unit:unit-1" self.subsection = library_api.create_container( self.library.key, - container_type=library_api.ContainerType.Subsection, + container_cls=content_models.Subsection, slug="subsection-1", title="Subsection 1", user_id=None, @@ -245,7 +251,7 @@ def setUp(self) -> None: self.subsection_key = "lct:org1:lib:subsection:subsection-1" self.section = library_api.create_container( self.library.key, - container_type=library_api.ContainerType.Section, + container_cls=content_models.Section, slug="section-1", title="Section 1", user_id=None, @@ -327,9 +333,13 @@ def setUp(self) -> None: # "published" is not set since we haven't published it yet } + def tearDown(self): + content_models.Container.reset_cache() + return super().tearDown() + @override_settings(MEILISEARCH_ENABLED=False) def test_reindex_meilisearch_disabled(self, mock_meilisearch) -> None: - with self.assertRaises(RuntimeError): + with self.assertRaises(RuntimeError): # noqa: PT027 api.rebuild_index() mock_meilisearch.return_value.swap_indexes.assert_not_called() @@ -339,29 +349,29 @@ def test_reindex_meilisearch(self, mock_meilisearch) -> None: # Add tags field to doc, since reindex calls includes tags doc_sequential = copy.deepcopy(self.doc_sequential) - doc_sequential["tags"] = {} + doc_sequential["tags"] = copy.deepcopy(EMPTY_TAGS) doc_vertical = copy.deepcopy(self.doc_vertical) - doc_vertical["tags"] = {} + doc_vertical["tags"] = copy.deepcopy(EMPTY_TAGS) doc_problem1 = copy.deepcopy(self.doc_problem1) - doc_problem1["tags"] = {} + doc_problem1["tags"] = copy.deepcopy(EMPTY_TAGS) doc_problem1["collections"] = {'display_name': [], 'key': []} doc_problem1["units"] = {'display_name': [], 'key': []} doc_problem2 = copy.deepcopy(self.doc_problem2) - doc_problem2["tags"] = {} + doc_problem2["tags"] = copy.deepcopy(EMPTY_TAGS) doc_problem2["collections"] = {'display_name': [], 'key': []} doc_problem2["units"] = {'display_name': [], 'key': []} doc_collection = copy.deepcopy(self.collection_dict) - doc_collection["tags"] = {} + doc_collection["tags"] = copy.deepcopy(EMPTY_TAGS) doc_unit = copy.deepcopy(self.unit_dict) - doc_unit["tags"] = {} + doc_unit["tags"] = copy.deepcopy(EMPTY_TAGS) doc_unit["collections"] = {'display_name': [], 'key': []} doc_unit["subsections"] = {'display_name': ['Subsection 1'], 'key': ['lct:org1:lib:subsection:subsection-1']} doc_subsection = copy.deepcopy(self.subsection_dict) - doc_subsection["tags"] = {} + doc_subsection["tags"] = copy.deepcopy(EMPTY_TAGS) doc_subsection["collections"] = {'display_name': [], 'key': []} doc_subsection["sections"] = {'display_name': ['Section 1'], 'key': ['lct:org1:lib:section:section-1']} doc_section = copy.deepcopy(self.section_dict) - doc_section["tags"] = {} + doc_section["tags"] = copy.deepcopy(EMPTY_TAGS) doc_section["collections"] = {'display_name': [], 'key': []} api.rebuild_index() @@ -381,29 +391,29 @@ def test_reindex_meilisearch_incremental(self, mock_meilisearch) -> None: # Add tags field to doc, since reindex calls includes tags doc_sequential = copy.deepcopy(self.doc_sequential) - doc_sequential["tags"] = {} + doc_sequential["tags"] = copy.deepcopy(EMPTY_TAGS) doc_vertical = copy.deepcopy(self.doc_vertical) - doc_vertical["tags"] = {} + doc_vertical["tags"] = copy.deepcopy(EMPTY_TAGS) doc_problem1 = copy.deepcopy(self.doc_problem1) - doc_problem1["tags"] = {} + doc_problem1["tags"] = copy.deepcopy(EMPTY_TAGS) doc_problem1["collections"] = {"display_name": [], "key": []} doc_problem1["units"] = {'display_name': [], 'key': []} doc_problem2 = copy.deepcopy(self.doc_problem2) - doc_problem2["tags"] = {} + doc_problem2["tags"] = copy.deepcopy(EMPTY_TAGS) doc_problem2["collections"] = {"display_name": [], "key": []} doc_problem2["units"] = {'display_name': [], 'key': []} doc_collection = copy.deepcopy(self.collection_dict) - doc_collection["tags"] = {} + doc_collection["tags"] = copy.deepcopy(EMPTY_TAGS) doc_unit = copy.deepcopy(self.unit_dict) - doc_unit["tags"] = {} + doc_unit["tags"] = copy.deepcopy(EMPTY_TAGS) doc_unit["collections"] = {"display_name": [], "key": []} doc_unit["subsections"] = {'display_name': ['Subsection 1'], 'key': ['lct:org1:lib:subsection:subsection-1']} doc_subsection = copy.deepcopy(self.subsection_dict) - doc_subsection["tags"] = {} + doc_subsection["tags"] = copy.deepcopy(EMPTY_TAGS) doc_subsection["collections"] = {'display_name': [], 'key': []} doc_subsection["sections"] = {'display_name': ['Section 1'], 'key': ['lct:org1:lib:section:section-1']} doc_section = copy.deepcopy(self.section_dict) - doc_section["tags"] = {} + doc_section["tags"] = copy.deepcopy(EMPTY_TAGS) doc_section["collections"] = {'display_name': [], 'key': []} api.rebuild_index(incremental=True) @@ -446,19 +456,32 @@ def test_reset_meilisearch_index(self, mock_meilisearch) -> None: @override_settings(MEILISEARCH_ENABLED=True) def test_init_meilisearch_index(self, mock_meilisearch) -> None: - # Test index already exists + # Test index already exists, is populated, and correctly configured + mock_index = Mock() + mock_index.primary_key = "id" + mock_index.get_stats.return_value = Mock(number_of_documents=100) + mock_index.get_settings.return_value = { + "distinctAttribute": "usage_key", + "filterableAttributes": list(api.INDEX_FILTERABLE_ATTRIBUTES), + "searchableAttributes": list(api.INDEX_SEARCHABLE_ATTRIBUTES), + "sortableAttributes": list(api.INDEX_SORTABLE_ATTRIBUTES), + "rankingRules": list(api.INDEX_RANKING_RULES), + } + mock_meilisearch.return_value.get_index.return_value = mock_index + api.init_index() mock_meilisearch.return_value.swap_indexes.assert_not_called() mock_meilisearch.return_value.create_index.assert_not_called() mock_meilisearch.return_value.delete_index.assert_not_called() - # Test index already exists and has no documents - mock_meilisearch.return_value.get_stats.return_value = 0 + # Test index already exists and is empty but correctly configured + mock_index.get_stats.return_value = Mock(number_of_documents=0) api.init_index() mock_meilisearch.return_value.swap_indexes.assert_not_called() mock_meilisearch.return_value.create_index.assert_not_called() mock_meilisearch.return_value.delete_index.assert_not_called() + # Test index does not exist — should create it mock_meilisearch.return_value.get_index.side_effect = [ MeilisearchApiError("Testing reindex", Mock(text='{"code":"index_not_found"}')), MeilisearchApiError("Testing reindex", Mock(text='{"code":"index_not_found"}')), @@ -508,11 +531,11 @@ def test_reindex_meilisearch_library_block_error(self, mock_meilisearch) -> None # Add tags field to doc, since reindex calls includes tags doc_sequential = copy.deepcopy(self.doc_sequential) - doc_sequential["tags"] = {} + doc_sequential["tags"] = copy.deepcopy(EMPTY_TAGS) doc_vertical = copy.deepcopy(self.doc_vertical) - doc_vertical["tags"] = {} + doc_vertical["tags"] = copy.deepcopy(EMPTY_TAGS) doc_problem2 = copy.deepcopy(self.doc_problem2) - doc_problem2["tags"] = {} + doc_problem2["tags"] = copy.deepcopy(EMPTY_TAGS) doc_problem2["collections"] = {'display_name': [], 'key': []} doc_problem2["units"] = {'display_name': [], 'key': []} @@ -520,7 +543,7 @@ def test_reindex_meilisearch_library_block_error(self, mock_meilisearch) -> None def mocked_from_component(lib_key, component): # Simulate an error when processing problem 1 - if component.key == 'xblock.v1:problem:p1': + if component.entity_ref == 'xblock.v1:problem:p1': raise Exception('Error') return orig_from_component(lib_key, component) @@ -595,14 +618,20 @@ def test_index_xblock_tags(self, mock_meilisearch) -> None: "id": self.doc_sequential["id"], "tags": { 'taxonomy': ['A'], - 'level0': ['A > one', 'A > two'] + 'level0': ['A > one', 'A > two'], + 'level1': [], + 'level2': [], + 'level3': [], } } doc_sequential_with_tags2 = { "id": self.doc_sequential["id"], "tags": { 'taxonomy': ['A', 'B'], - 'level0': ['A > one', 'A > two', 'B > four', 'B > three'] + 'level0': ['A > one', 'A > two', 'B > four', 'B > three'], + 'level1': [], + 'level2': [], + 'level3': [], } } @@ -615,6 +644,41 @@ def test_index_xblock_tags(self, mock_meilisearch) -> None: any_order=True, ) + @override_settings(MEILISEARCH_ENABLED=True) + def test_remove_xblock_tag_clears_index_tags(self, mock_meilisearch) -> None: + """ + Test that removing tags from an XBlock clears tag facets in the index. + """ + # Add a tag first so we can verify it is later cleared. + tagging_api.tag_object(str(self.sequential.usage_key), self.taxonomyA, ["one"]) + + # Remove all tags for taxonomyA from this object. + tagging_api.tag_object(str(self.sequential.usage_key), self.taxonomyA, []) + + doc_with_tag = { + "id": self.doc_sequential["id"], + "tags": { + "taxonomy": ["A"], + "level0": ["A > one"], + "level1": [], + "level2": [], + "level3": [], + }, + } + doc_without_tags = { + "id": self.doc_sequential["id"], + "tags": copy.deepcopy(EMPTY_TAGS), + } + + assert mock_meilisearch.return_value.index.return_value.update_documents.call_count == 2 + mock_meilisearch.return_value.index.return_value.update_documents.assert_has_calls( + [ + call([doc_with_tag]), + call([doc_without_tags]), + ], + any_order=True, + ) + @override_settings(MEILISEARCH_ENABLED=True) def test_delete_index_xblock(self, mock_meilisearch) -> None: """ @@ -654,14 +718,20 @@ def test_index_library_block_tags(self, mock_meilisearch) -> None: "id": self.doc_problem1["id"], "tags": { 'taxonomy': ['A'], - 'level0': ['A > one', 'A > two'] + 'level0': ['A > one', 'A > two'], + 'level1': [], + 'level2': [], + 'level3': [], } } doc_problem_with_tags2 = { "id": self.doc_problem1["id"], "tags": { 'taxonomy': ['A', 'B'], - 'level0': ['A > one', 'A > two', 'B > four', 'B > three'] + 'level0': ['A > one', 'A > two', 'B > four', 'B > three'], + 'level1': [], + 'level2': [], + 'level3': [], } } @@ -680,8 +750,10 @@ def test_index_library_block_and_collections(self, mock_meilisearch) -> None: Test indexing an Library Block and the Collections it's in. """ # Create collections (these internally call `upsert_library_collection_index_doc`) - created_date = datetime(2023, 5, 6, 7, 8, 9, tzinfo=timezone.utc) - with freeze_time(created_date): + created_date = datetime(2023, 5, 6, 7, 8, 9, tzinfo=UTC) + # Note: because TestCase keeps the transaction open, we need self.captureOnCommitCallbacks(execute=True) to + # ensure events get emitted here as if this part were its own transaction as it normally would be. + with freeze_time(created_date), self.captureOnCommitCallbacks(execute=True): collection1 = library_api.create_library_collection( self.library.key, collection_key="COL1", @@ -701,12 +773,12 @@ def test_index_library_block_and_collections(self, mock_meilisearch) -> None: # Add Problem1 to both Collections (these internally call `upsert_item_collections_index_docs` and # `upsert_library_collection_index_doc`) # (adding in reverse order to test sorting of collection tag) - updated_date = datetime(2023, 6, 7, 8, 9, 10, tzinfo=timezone.utc) - with freeze_time(updated_date): - for collection in (collection2, collection1): + updated_date = datetime(2023, 6, 7, 8, 9, 10, tzinfo=UTC) + for collection in (collection2, collection1): + with freeze_time(updated_date), self.captureOnCommitCallbacks(execute=True): library_api.update_library_collection_items( self.library.key, - collection_key=collection.key, + collection_key=collection.collection_code, opaque_keys=[ self.problem1.usage_key, ], @@ -716,8 +788,8 @@ def test_index_library_block_and_collections(self, mock_meilisearch) -> None: lib_access, _ = SearchAccess.objects.get_or_create(context_key=self.library.key) doc_collection1_created = { "id": "lib-collectionorg1libcol1-283a79c9", - "block_id": collection1.key, - "usage_key": f"lib-collection:org1:lib:{collection1.key}", + "block_id": collection1.collection_code, + "usage_key": f"lib-collection:org1:lib:{collection1.collection_code}", "type": "collection", "display_name": "Collection 1", "description": "First Collection", @@ -734,8 +806,8 @@ def test_index_library_block_and_collections(self, mock_meilisearch) -> None: } doc_collection2_created = { "id": "lib-collectionorg1libcol2-46823d4d", - "block_id": collection2.key, - "usage_key": f"lib-collection:org1:lib:{collection2.key}", + "block_id": collection2.collection_code, + "usage_key": f"lib-collection:org1:lib:{collection2.collection_code}", "type": "collection", "display_name": "Collection 2", "description": "Second Collection", @@ -752,8 +824,8 @@ def test_index_library_block_and_collections(self, mock_meilisearch) -> None: } doc_collection2_updated = { "id": "lib-collectionorg1libcol2-46823d4d", - "block_id": collection2.key, - "usage_key": f"lib-collection:org1:lib:{collection2.key}", + "block_id": collection2.collection_code, + "usage_key": f"lib-collection:org1:lib:{collection2.collection_code}", "type": "collection", "display_name": "Collection 2", "description": "Second Collection", @@ -770,8 +842,8 @@ def test_index_library_block_and_collections(self, mock_meilisearch) -> None: } doc_collection1_updated = { "id": "lib-collectionorg1libcol1-283a79c9", - "block_id": collection1.key, - "usage_key": f"lib-collection:org1:lib:{collection1.key}", + "block_id": collection1.collection_code, + "usage_key": f"lib-collection:org1:lib:{collection1.collection_code}", "type": "collection", "display_name": "Collection 1", "description": "First Collection", @@ -858,14 +930,20 @@ def test_index_tags_in_collections(self, mock_meilisearch) -> None: "id": "lib-collectionorg1libmycol-5b647617", "tags": { 'taxonomy': ['A'], - 'level0': ['A > one', 'A > two'] + 'level0': ['A > one', 'A > two'], + 'level1': [], + 'level2': [], + 'level3': [], } } doc_collection_with_tags2 = { "id": "lib-collectionorg1libmycol-5b647617", "tags": { 'taxonomy': ['A', 'B'], - 'level0': ['A > one', 'A > two', 'B > four', 'B > three'] + 'level0': ['A > one', 'A > two', 'B > four', 'B > three'], + 'level1': [], + 'level2': [], + 'level3': [], } } @@ -884,11 +962,13 @@ def test_delete_collection(self, mock_meilisearch) -> None: Test soft-deleting, restoring, and hard-deleting a collection. """ # Add a component to the collection - updated_date = datetime(2023, 6, 7, 8, 9, 10, tzinfo=timezone.utc) - with freeze_time(updated_date): + updated_date = datetime(2023, 6, 7, 8, 9, 10, tzinfo=UTC) + # Note: because TestCase keeps the transaction open, we need self.captureOnCommitCallbacks(execute=True) to + # ensure events get emitted here as if this part were its own transaction as it normally would be. + with freeze_time(updated_date), self.captureOnCommitCallbacks(execute=True): library_api.update_library_collection_items( self.library.key, - collection_key=self.collection.key, + collection_key=self.collection.collection_code, opaque_keys=[ self.problem1.usage_key, self.unit.container_key @@ -902,14 +982,14 @@ def test_delete_collection(self, mock_meilisearch) -> None: "id": self.doc_problem1["id"], "collections": { "display_name": [self.collection.title], - "key": [self.collection.key], + "key": [self.collection.collection_code], }, } doc_unit_with_collection = { "id": self.unit_dict["id"], "collections": { "display_name": [self.collection.title], - "key": [self.collection.key], + "key": [self.collection.collection_code], }, } @@ -926,10 +1006,11 @@ def test_delete_collection(self, mock_meilisearch) -> None: mock_meilisearch.return_value.index.reset_mock() # Soft-delete the collection - authoring_api.delete_collection( - self.collection.learning_package_id, - self.collection.key, - ) + with self.captureOnCommitCallbacks(execute=True): + content_api.delete_collection( + self.collection.learning_package_id, + self.collection.collection_code, + ) doc_problem_without_collection = { "id": self.doc_problem1["id"], @@ -959,11 +1040,11 @@ def test_delete_collection(self, mock_meilisearch) -> None: mock_meilisearch.return_value.get_index.return_value.get_document.return_value = None # Restore the collection - restored_date = datetime(2023, 8, 9, 10, 11, 12, tzinfo=timezone.utc) - with freeze_time(restored_date): - authoring_api.restore_collection( + restored_date = datetime(2023, 8, 9, 10, 11, 12, tzinfo=UTC) + with freeze_time(restored_date), self.captureOnCommitCallbacks(execute=True): + content_api.restore_collection( self.collection.learning_package_id, - self.collection.key, + self.collection.collection_code, ) doc_collection = copy.deepcopy(self.collection_dict) @@ -983,11 +1064,12 @@ def test_delete_collection(self, mock_meilisearch) -> None: mock_meilisearch.return_value.index.reset_mock() # Hard-delete the collection - authoring_api.delete_collection( - self.collection.learning_package_id, - self.collection.key, - hard_delete=True, - ) + with self.captureOnCommitCallbacks(execute=True): + content_api.delete_collection( + self.collection.learning_package_id, + self.collection.collection_code, + hard_delete=True, + ) # Should delete the collection document mock_meilisearch.return_value.index.return_value.delete_document.assert_called_once_with( @@ -1010,7 +1092,11 @@ def test_delete_collection(self, mock_meilisearch) -> None: @override_settings(MEILISEARCH_ENABLED=True) def test_delete_index_container(self, container_type, mock_meilisearch) -> None: """ - Test delete a container index. + Test that the search index is updated correctly when a container is deleted. + + That container's entry should be deleted, and its parent and children should also be updated. + + Then test reverting/restoring the container. """ container = getattr(self, container_type) container_dict = getattr(self, f"{container_type}_dict") @@ -1026,20 +1112,27 @@ def clear_contents(data: dict): }, } if container_type == "unit": + # The parent subsection's "child_usage_keys" and "child_display_names" should be cleared: update_doc_calls.append(call([clear_contents(self.subsection_dict)])) elif container_type == "subsection": + # The parent section's "child_usage_keys" and "child_display_names" should be cleared: update_doc_calls.append(call([clear_contents(self.section_dict)])) + # The subsection gets removed from the child unit's "subsections this is used in": update_doc_calls.append(call([{ 'id': self.unit_dict['id'], 'subsections': {'display_name': [], 'key': []}, }])) elif container_type == "section": + # The subsection gets removed from the child unit's "subsections this is used in": update_doc_calls.append(call([{ 'id': self.subsection_dict['id'], 'sections': {'display_name': [], 'key': []}, }])) - library_api.delete_container(container.container_key) + # Note: because TestCase keeps the transaction open, we need self.captureOnCommitCallbacks(execute=True) to + # ensure events get emitted here as if this part were its own transaction as it normally would be. + with self.captureOnCommitCallbacks(execute=True): + library_api.delete_container(container.container_key) mock_meilisearch.return_value.index.return_value.delete_document.assert_called_once_with( container_dict["id"], @@ -1052,7 +1145,8 @@ def clear_contents(data: dict): ) # Restore - library_api.restore_container(container.container_key) + with self.captureOnCommitCallbacks(execute=True): + library_api.restore_container(container.container_key) if container_type == "unit": update_doc_calls.append(call([self.subsection_dict])) elif container_type == "subsection": @@ -1114,14 +1208,20 @@ def test_index_tags_in_containers(self, container_type, container_id, mock_meili "id": container_id, "tags": { 'taxonomy': ['A'], - 'level0': ['A > one', 'A > two'] + 'level0': ['A > one', 'A > two'], + 'level1': [], + 'level2': [], + 'level3': [], } } doc_unit_with_tags2 = { "id": container_id, "tags": { 'taxonomy': ['A', 'B'], - 'level0': ['A > one', 'A > two', 'B > four', 'B > three'] + 'level0': ['A > one', 'A > two', 'B > four', 'B > three'], + 'level1': [], + 'level2': [], + 'level3': [], } } @@ -1136,7 +1236,10 @@ def test_index_tags_in_containers(self, container_type, container_id, mock_meili @override_settings(MEILISEARCH_ENABLED=True) def test_block_in_units(self, mock_meilisearch) -> None: - with freeze_time(self.created_date): + """Test that search index is updated correctly when we add a problem block to a unit""" + # Note: because TestCase keeps the transaction open, we need self.captureOnCommitCallbacks(execute=True) to + # ensure events get emitted here as if this part were its own transaction as it normally would be. + with freeze_time(self.created_date), self.captureOnCommitCallbacks(execute=True): library_api.update_container_children( LibraryContainerLocator.from_string(self.unit_key), [self.problem1.usage_key], @@ -1159,18 +1262,36 @@ def test_block_in_units(self, mock_meilisearch) -> None: } } - assert mock_meilisearch.return_value.index.return_value.update_documents.call_count == 2 + assert mock_meilisearch.return_value.index.return_value.update_documents.call_count == 4 mock_meilisearch.return_value.index.return_value.update_documents.assert_has_calls( [ + # The problem block's index document gets updated so that its "[parent] units" field lists the new unit call([doc_block_with_units]), + # Update the parent unit so that the problem block is in "child_usage_keys" and "child_display_names" call([new_unit_dict]), + # The ancestor containers are updated too, because they're included as dependencies in the event. + # We don't really need this. + call([self.subsection_dict]), + call([self.section_dict]), ], any_order=True, ) @override_settings(MEILISEARCH_ENABLED=True) def test_units_in_subsection(self, mock_meilisearch) -> None: - with freeze_time(self.created_date): + """Test adding a unit to a subsection""" + + # First, remove all children from the subsection: + with self.captureOnCommitCallbacks(execute=False): # suppress events + library_api.update_container_children(self.subsection.container_key, [], None) + + # We suppresssed events just now so we don't expect Meilisearch to have updated + assert mock_meilisearch.return_value.index.return_value.update_documents.call_count == 0 + + # Now add the unit to the subsection - this is what we want to test. + # Note: because TestCase keeps the transaction open, we need self.captureOnCommitCallbacks(execute=True) to + # ensure events get emitted here as if this part were its own transaction as it normally would be. + with freeze_time(self.created_date), self.captureOnCommitCallbacks(execute=True): library_api.update_container_children( LibraryContainerLocator.from_string(self.subsection_key), [LibraryContainerLocator.from_string(self.unit_key)], @@ -1192,21 +1313,36 @@ def test_units_in_subsection(self, mock_meilisearch) -> None: 'child_display_names': [self.unit.display_name] } } - assert mock_meilisearch.return_value.index.return_value.update_documents.call_count == 2 + assert mock_meilisearch.return_value.index.return_value.update_documents.call_count == 3 mock_meilisearch.return_value.index.return_value.update_documents.assert_has_calls( [ + # The unit isn't directly modified but its "parent subsections: ..." field must be updated: call([doc_block_with_subsections]), + # Update the parent subsection so that the new unit is in "child_usage_keys" and "child_display_names" call([new_subsection_dict]), + # The ancestor section is updated too because it's included in the event. We don't really need this. + call([self.section_dict]), ], any_order=True, ) @override_settings(MEILISEARCH_ENABLED=True) - def test_section_in_usbsections(self, mock_meilisearch) -> None: - with freeze_time(self.created_date): + def test_section_in_subsections(self, mock_meilisearch) -> None: + """Test that search index is updated correctly when we add a subsection to a section""" + + # Setup: first, remove all children from the section: + with self.captureOnCommitCallbacks(execute=False): # suppress events + library_api.update_container_children(self.section.container_key, [], None) + # We suppresssed events just now so we don't expect Meilisearch to have updated + assert mock_meilisearch.return_value.index.return_value.update_documents.call_count == 0 + + # Now add the subsection to the section - this is what we want to test. + # Note: because TestCase keeps the transaction open, we need self.captureOnCommitCallbacks(execute=True) to + # ensure events get emitted here as if this part were its own transaction as it normally would be. + with freeze_time(self.created_date), self.captureOnCommitCallbacks(execute=True): library_api.update_container_children( - LibraryContainerLocator.from_string(self.section_key), - [LibraryContainerLocator.from_string(self.subsection_key)], + self.section.container_key, + [self.subsection.container_key], None, ) @@ -1228,7 +1364,9 @@ def test_section_in_usbsections(self, mock_meilisearch) -> None: assert mock_meilisearch.return_value.index.return_value.update_documents.call_count == 2 mock_meilisearch.return_value.index.return_value.update_documents.assert_has_calls( [ + # The subsection isn't directly modified but its "parent sections: ..." field must be updated: call([doc_block_with_sections]), + # Update the parent section so that the new subsection is in "child_usage_keys" & "child_display_names" call([new_section_dict]), ], any_order=True, diff --git a/openedx/core/djangoapps/content/search/tests/test_documents.py b/openedx/core/djangoapps/content/search/tests/test_documents.py index 5a8a2231dcdd..5bba56d4b7df 100644 --- a/openedx/core/djangoapps/content/search/tests/test_documents.py +++ b/openedx/core/djangoapps/content/search/tests/test_documents.py @@ -1,13 +1,14 @@ """ Tests for the Studio content search documents (what gets stored in the index) """ -import ddt from dataclasses import replace from datetime import datetime, timezone +import ddt from freezegun import freeze_time from opaque_keys.edx.locator import LibraryCollectionLocator, LibraryContainerLocator -from openedx_learning.api import authoring as authoring_api +from openedx_content import api as content_api +from openedx_content import models_api as content_models from organizations.models import Organization from openedx.core.djangoapps.content_libraries import api as library_api @@ -53,7 +54,7 @@ def setUpClass(cls): super().setUpClass() cls.store = modulestore() # Create a library and collection with a block - cls.created_date = datetime(2023, 4, 5, 6, 7, 8, tzinfo=timezone.utc) + cls.created_date = datetime(2023, 4, 5, 6, 7, 8, tzinfo=timezone.utc) # noqa: UP017 with freeze_time(cls.created_date): # Get references to some blocks in the toy course cls.org = Organization.objects.create(name="edX", short_name="edX") @@ -92,7 +93,7 @@ def setUpClass(cls): ) cls.container = library_api.create_container( cls.library.key, - container_type=library_api.ContainerType.Unit, + container_cls=content_models.Unit, slug="unit1", title="A Unit in the Search Index", user_id=None, @@ -102,7 +103,7 @@ def setUpClass(cls): ) cls.subsection = library_api.create_container( cls.library.key, - container_type=library_api.ContainerType.Subsection, + container_cls=content_models.Subsection, slug="subsection1", title="A Subsection in the Search Index", user_id=None, @@ -112,7 +113,7 @@ def setUpClass(cls): ) cls.section = library_api.create_container( cls.library.key, - container_type=library_api.ContainerType.Section, + container_cls=content_models.Section, slug="section1", title="A Section in the Search Index", user_id=None, @@ -153,6 +154,11 @@ def setUpClass(cls): tagging_api.tag_object(str(cls.subsection_key), cls.difficulty_tags, tags=["Normal"]) tagging_api.tag_object(str(cls.section_key), cls.difficulty_tags, tags=["Normal"]) + def tearDown(self): + # If we're working with Containers in test cases, we need this line: + content_models.Container.reset_cache() + return super().tearDown() + @property def toy_course_access_id(self): """ @@ -223,6 +229,9 @@ def test_problem_block(self): "tags": { "taxonomy": ["Difficulty"], "level0": ["Difficulty > Easy"], + "level1": [], + "level2": [], + "level3": [], }, } @@ -270,6 +279,7 @@ def test_html_block(self): "level0": ["Difficulty > Normal", "Subject > Hypertext", "Subject > Linguistics"], "level1": ["Subject > Hypertext > Jump Links", "Subject > Linguistics > Asian Languages"], "level2": ["Subject > Linguistics > Asian Languages > Chinese"], + "level3": [], }, } @@ -279,7 +289,9 @@ def test_video_block_untagged(self): """ block_usage_key = self.toy_course_key.make_usage_key("video", "Welcome") block = self.store.get_item(block_usage_key) - doc = searchable_doc_for_course_block(block) + doc = {} + doc.update(searchable_doc_for_course_block(block)) + doc.update(searchable_doc_tags(block.usage_key)) assert doc == { "id": "block-v1edxtoy2012_falltypevideoblockwelcome-0c9fd626", "type": "course_block", @@ -301,7 +313,13 @@ def test_video_block_untagged(self): ], "content": {}, "modified": self.created_date.timestamp(), - # This video has no tags. + "tags": { + "taxonomy": [], + "level0": [], + "level1": [], + "level2": [], + "level3": [], + }, } def test_html_library_block(self): @@ -340,6 +358,9 @@ def test_html_library_block(self): "tags": { "taxonomy": ["Difficulty"], "level0": ["Difficulty > Normal"], + "level1": [], + "level2": [], + "level3": [], }, "publish_status": "never", } @@ -379,6 +400,9 @@ def test_html_published_library_block(self): "tags": { "taxonomy": ["Difficulty"], "level0": ["Difficulty > Normal"], + "level1": [], + "level2": [], + "level3": [], }, 'published': {'display_name': 'Text'}, "publish_status": "published", @@ -421,6 +445,9 @@ def test_html_published_library_block(self): "tags": { "taxonomy": ["Difficulty"], "level0": ["Difficulty > Normal"], + "level1": [], + "level2": [], + "level3": [], }, "published": {"display_name": "Text"}, "publish_status": "published", @@ -461,6 +488,9 @@ def test_html_published_library_block(self): "tags": { "taxonomy": ["Difficulty"], "level0": ["Difficulty > Normal"], + "level1": [], + "level2": [], + "level3": [], }, "published": { "display_name": "Text 2", @@ -472,8 +502,8 @@ def test_html_published_library_block(self): # Verify publish status is set to modified library_block_modified = replace( self.library_block, - modified=datetime(2024, 4, 5, 6, 7, 8, tzinfo=timezone.utc), - last_published=datetime(2023, 4, 5, 6, 7, 8, tzinfo=timezone.utc), + modified=datetime(2024, 4, 5, 6, 7, 8, tzinfo=timezone.utc), # noqa: UP017 + last_published=datetime(2023, 4, 5, 6, 7, 8, tzinfo=timezone.utc), # noqa: UP017 ) doc = searchable_doc_for_library_block(library_block_modified) doc.update(searchable_doc_tags(library_block_modified.usage_key)) @@ -486,7 +516,7 @@ def test_collection_with_library(self): assert doc == { "id": "lib-collectionedx2012_falltoy_collection-d1d907a4", - "block_id": self.collection.key, + "block_id": self.collection.collection_code, "usage_key": str(self.collection_key), "type": "collection", "org": "edX", @@ -500,7 +530,10 @@ def test_collection_with_library(self): "modified": 1680674828.0, 'tags': { 'taxonomy': ['Difficulty'], - 'level0': ['Difficulty > Normal'] + 'level0': ['Difficulty > Normal'], + 'level1': [], + 'level2': [], + 'level3': [], }, "published": { "num_children": 0 @@ -515,7 +548,7 @@ def test_collection_with_published_library(self): assert doc == { "id": "lib-collectionedx2012_falltoy_collection-d1d907a4", - "block_id": self.collection.key, + "block_id": self.collection.collection_code, "usage_key": str(self.collection_key), "type": "collection", "org": "edX", @@ -529,7 +562,10 @@ def test_collection_with_published_library(self): "modified": 1680674828.0, 'tags': { 'taxonomy': ['Difficulty'], - 'level0': ['Difficulty > Normal'] + 'level0': ['Difficulty > Normal'], + 'level1': [], + 'level2': [], + 'level3': [], }, "published": { "num_children": 1 @@ -573,7 +609,10 @@ def test_draft_container(self, container_name, container_slug, container_type, d "last_published": None, "tags": { "taxonomy": ["Difficulty"], - "level0": ["Difficulty > Normal"] + "level0": ["Difficulty > Normal"], + "level1": [], + "level2": [], + "level3": [], }, # "published" is not set since we haven't published it yet } @@ -621,7 +660,10 @@ def test_published_container(self): "last_published": 1680674828.0, "tags": { "taxonomy": ["Difficulty"], - "level0": ["Difficulty > Normal"] + "level0": ["Difficulty > Normal"], + "level1": [], + "level2": [], + "level3": [], }, "published": { "num_children": 1, @@ -660,7 +702,7 @@ def test_published_container_with_changes(self): self.container.container_key, [block_2.usage_key], user_id=None, - entities_action=authoring_api.ChildrenEntitiesAction.APPEND, + entities_action=content_api.ChildrenEntitiesAction.APPEND, ) doc = searchable_doc_for_container(self.container.container_key) @@ -695,7 +737,10 @@ def test_published_container_with_changes(self): "last_published": 1680674828.0, "tags": { "taxonomy": ["Difficulty"], - "level0": ["Difficulty > Normal"] + "level0": ["Difficulty > Normal"], + "level1": [], + "level2": [], + "level3": [], }, "published": { "num_children": 1, diff --git a/openedx/core/djangoapps/content/search/tests/test_handlers.py b/openedx/core/djangoapps/content/search/tests/test_handlers.py index 7ccbec687e98..6ee28a658ed3 100644 --- a/openedx/core/djangoapps/content/search/tests/test_handlers.py +++ b/openedx/core/djangoapps/content/search/tests/test_handlers.py @@ -14,10 +14,8 @@ from xmodule.modulestore.tests.django_utils import ( TEST_DATA_SPLIT_MODULESTORE, ModuleStoreTestCase, - ImmediateOnCommitMixin, ) - try: # This import errors in the lms because content.search is not an installed app there. from .. import api @@ -30,7 +28,7 @@ @patch("openedx.core.djangoapps.content.search.api.MeilisearchClient") @override_settings(MEILISEARCH_ENABLED=True) @skip_unless_cms -class TestUpdateIndexHandlers(ImmediateOnCommitMixin, ModuleStoreTestCase, LiveServerTestCase): +class TestUpdateIndexHandlers(ModuleStoreTestCase, LiveServerTestCase): """ Test that the search index is updated when XBlocks and Library Blocks are modified """ @@ -63,8 +61,10 @@ def test_create_delete_xblock(self, meilisearch_client): course_access, _ = SearchAccess.objects.get_or_create(context_key=course.id) # Create XBlocks - created_date = datetime(2023, 4, 5, 6, 7, 8, tzinfo=timezone.utc) - with freeze_time(created_date): + created_date = datetime(2023, 4, 5, 6, 7, 8, tzinfo=timezone.utc) # noqa: UP017 + # Note: because TestCase keeps the transaction open, we need self.captureOnCommitCallbacks(execute=True) to + # ensure events get emitted here as if this part were its own transaction as it normally would be. + with freeze_time(created_date), self.captureOnCommitCallbacks(execute=True): sequential = self.store.create_child(self.user_id, course.location, "sequential", "test_sequential") doc_sequential = { "id": "block-v1orgatest_coursetest_runtypesequentialblocktest_sequential-0cdb9395", @@ -87,7 +87,7 @@ def test_create_delete_xblock(self, meilisearch_client): meilisearch_client.return_value.index.return_value.update_documents.assert_called_with([doc_sequential]) - with freeze_time(created_date): + with freeze_time(created_date), self.captureOnCommitCallbacks(execute=True): vertical = self.store.create_child(self.user_id, sequential.location, "vertical", "test_vertical") doc_vertical = { "id": "block-v1orgatest_coursetest_runtypeverticalblocktest_vertical-011f143b", @@ -117,8 +117,8 @@ def test_create_delete_xblock(self, meilisearch_client): # Update the XBlock sequential = self.store.get_item(sequential.location, self.user_id) # Refresh the XBlock sequential.display_name = "Updated Sequential" - modified_date = datetime(2024, 5, 6, 7, 8, 9, tzinfo=timezone.utc) - with freeze_time(modified_date): + modified_date = datetime(2024, 5, 6, 7, 8, 9, tzinfo=timezone.utc) # noqa: UP017 + with freeze_time(modified_date), self.captureOnCommitCallbacks(execute=True): self.store.update_item(sequential, self.user_id) # The display name and the child's breadcrumbs should be updated @@ -132,12 +132,30 @@ def test_create_delete_xblock(self, meilisearch_client): ]) # Delete the XBlock - self.store.delete_item(vertical.location, self.user_id) + with self.captureOnCommitCallbacks(execute=True): + self.store.delete_item(vertical.location, self.user_id) meilisearch_client.return_value.index.return_value.delete_document.assert_called_with( "block-v1orgatest_coursetest_runtypeverticalblocktest_vertical-011f143b" ) + def test_library_creation_creates_search_access(self, meilisearch_client): + """ + Test that creating a library automatically creates a SearchAccess record. + This is required for course creators to search library content immediately after creation. + """ + # Create a library + library = library_api.create_library( + org=self.orgA, + slug="test_lib", + title="Test Library", + description="Test library for SearchAccess creation", + ) + + assert SearchAccess.objects.filter(context_key=library.key).exists() + search_access = SearchAccess.objects.get(context_key=library.key) + assert search_access.context_key == library.key + def test_create_delete_library_block(self, meilisearch_client): # Create library library = library_api.create_library( @@ -146,12 +164,16 @@ def test_create_delete_library_block(self, meilisearch_client): title="Library Org A", description="This is a library from Org A", ) - lib_access, _ = SearchAccess.objects.get_or_create(context_key=library.key) + lib_access = SearchAccess.objects.get(context_key=library.key) # Populate it with a problem, freezing the date so we can verify created date serializes correctly. - created_date = datetime(2023, 4, 5, 6, 7, 8, tzinfo=timezone.utc) - with freeze_time(created_date): + created_date = datetime(2023, 4, 5, 6, 7, 8, tzinfo=timezone.utc) # noqa: UP017 + + # Note: because TestCase keeps the transaction open, we need self.captureOnCommitCallbacks(execute=True) to + # ensure events get emitted here as if this part were its own transaction as it normally would be. + with freeze_time(created_date), self.captureOnCommitCallbacks(execute=True): problem = library_api.create_library_block(library.key, "problem", "Problem1") + doc_problem = { "id": "lborgalib_aproblemproblem1-ca3186e9", "type": "library_block", @@ -180,15 +202,15 @@ def test_create_delete_library_block(self, meilisearch_client): meilisearch_client.return_value.index.return_value.update_documents.assert_called_with([doc_problem]) # Edit the problem block, freezing the date so we can verify modified date serializes correctly - modified_date = datetime(2024, 5, 6, 7, 8, 9, tzinfo=timezone.utc) - with freeze_time(modified_date): + modified_date = datetime(2024, 5, 6, 7, 8, 9, tzinfo=timezone.utc) # noqa: UP017 + with freeze_time(modified_date), self.captureOnCommitCallbacks(execute=True): library_api.set_library_block_olx(problem.usage_key, "") doc_problem["modified"] = modified_date.timestamp() meilisearch_client.return_value.index.return_value.update_documents.assert_called_with([doc_problem]) # Publish the content library, freezing the date so we can verify last_published date serializes correctly - published_date = datetime(2024, 6, 7, 8, 9, 10, tzinfo=timezone.utc) - with freeze_time(published_date): + published_date = datetime(2024, 6, 7, 8, 9, 10, tzinfo=timezone.utc) # noqa: UP017 + with freeze_time(published_date), self.captureOnCommitCallbacks(execute=True): library_api.publish_changes(library.key) doc_problem["last_published"] = published_date.timestamp() doc_problem["published"] = {"display_name": "Blank Problem"} @@ -196,18 +218,14 @@ def test_create_delete_library_block(self, meilisearch_client): meilisearch_client.return_value.index.return_value.update_documents.assert_called_with([doc_problem]) # Delete the Library Block - library_api.delete_library_block(problem.usage_key) + with self.captureOnCommitCallbacks(execute=True): + library_api.delete_library_block(problem.usage_key) meilisearch_client.return_value.index.return_value.delete_document.assert_called_with( "lborgalib_aproblemproblem1-ca3186e9" ) # Restore the Library Block - library_api.restore_library_block(problem.usage_key) + with self.captureOnCommitCallbacks(execute=True): + library_api.restore_library_block(problem.usage_key) meilisearch_client.return_value.index.return_value.update_documents.assert_any_call([doc_problem]) - meilisearch_client.return_value.index.return_value.update_documents.assert_any_call( - [{'id': doc_problem['id'], 'collections': {'display_name': [], 'key': []}}] - ) - meilisearch_client.return_value.index.return_value.update_documents.assert_any_call( - [{'id': doc_problem['id'], 'tags': {}}] - ) diff --git a/openedx/core/djangoapps/content/search/tests/test_reconcile.py b/openedx/core/djangoapps/content/search/tests/test_reconcile.py new file mode 100644 index 000000000000..6904f555ebb4 --- /dev/null +++ b/openedx/core/djangoapps/content/search/tests/test_reconcile.py @@ -0,0 +1,611 @@ +""" +Tests for the Meilisearch index reconciliation logic. +""" + +from __future__ import annotations + +from unittest.mock import MagicMock, Mock, patch + +import pytest +from django.test import TestCase, override_settings +from meilisearch.errors import MeilisearchError + +from openedx.core.djangolib.testing.utils import skip_unless_cms + +try: + from .. import api + from ..api import ( + IndexDrift, + _apply_index_settings, + _detect_index_drift, + reconcile_index, + ) + from ..apps import ContentSearchConfig + from ..handlers import handle_post_migrate + from ..index_config import ( + INDEX_DISTINCT_ATTRIBUTE, + INDEX_FILTERABLE_ATTRIBUTES, + INDEX_PRIMARY_KEY, + INDEX_RANKING_RULES, + INDEX_SEARCHABLE_ATTRIBUTES, + INDEX_SORTABLE_ATTRIBUTES, + ) +except RuntimeError: + pass + + +@skip_unless_cms +class TestIndexDrift(TestCase): + """Tests for the IndexDrift dataclass.""" + + def test_all_fields_match(self): + drift = IndexDrift( + exists=True, + is_empty=False, + primary_key_correct=True, + distinct_attribute_match=True, + filterable_attributes_match=True, + searchable_attributes_match=True, + sortable_attributes_match=True, + ranking_rules_match=True, + ) + assert drift.exists is True + assert drift.is_empty is False + assert drift.primary_key_correct is True + assert drift.distinct_attribute_match is True + assert drift.filterable_attributes_match is True + assert drift.searchable_attributes_match is True + assert drift.sortable_attributes_match is True + assert drift.ranking_rules_match is True + assert not drift.is_settings_drifted + + def test_settings_drifted_when_one_setting_false(self): + drift = IndexDrift( + exists=True, + is_empty=False, + primary_key_correct=True, + distinct_attribute_match=True, + filterable_attributes_match=False, + searchable_attributes_match=True, + sortable_attributes_match=True, + ranking_rules_match=True, + ) + assert drift.primary_key_correct is True + assert drift.filterable_attributes_match is False + assert drift.is_settings_drifted + + def test_primary_key_wrong_without_settings_drift(self): + drift = IndexDrift( + exists=True, + is_empty=False, + primary_key_correct=False, + distinct_attribute_match=True, + filterable_attributes_match=True, + searchable_attributes_match=True, + sortable_attributes_match=True, + ranking_rules_match=True, + ) + assert drift.primary_key_correct is False + assert drift.distinct_attribute_match is True + assert drift.filterable_attributes_match is True + assert drift.searchable_attributes_match is True + assert drift.sortable_attributes_match is True + assert drift.ranking_rules_match is True + assert not drift.is_settings_drifted + + def test_missing_index_leaves_optional_fields_unset(self): + drift = IndexDrift(exists=False) + assert drift.exists is False + assert drift.is_empty is None + assert drift.primary_key_correct is None + assert drift.distinct_attribute_match is None + assert drift.filterable_attributes_match is None + assert drift.searchable_attributes_match is None + assert drift.sortable_attributes_match is None + assert drift.ranking_rules_match is None + assert not drift.is_settings_drifted + + def test_multiple_settings_drifted(self): + drift = IndexDrift( + exists=True, + is_empty=True, + primary_key_correct=True, + distinct_attribute_match=False, + filterable_attributes_match=False, + searchable_attributes_match=True, + sortable_attributes_match=False, + ranking_rules_match=True, + ) + assert drift.distinct_attribute_match is False + assert drift.filterable_attributes_match is False + assert drift.searchable_attributes_match is True + assert drift.sortable_attributes_match is False + assert drift.ranking_rules_match is True + assert drift.is_settings_drifted + + +@skip_unless_cms +@override_settings(MEILISEARCH_ENABLED=True) +@patch("openedx.core.djangoapps.content.search.api._wait_for_meili_task", new=MagicMock(return_value=None)) +@patch("openedx.core.djangoapps.content.search.api.MeilisearchClient") +class TestDetectIndexDrift(TestCase): + """Tests for _detect_index_drift().""" + + def setUp(self): + super().setUp() + api.clear_meilisearch_client() + + def test_index_missing(self, mock_meilisearch): + """When the index doesn't exist, returns exists=False with all other fields None.""" + from meilisearch.errors import MeilisearchApiError + + mock_meilisearch.return_value.get_index.side_effect = MeilisearchApiError( + "Not found", Mock(text='{"code":"index_not_found"}') + ) + + drift = _detect_index_drift("test_index") + + assert not drift.exists + assert drift.is_empty is None + assert drift.primary_key_correct is None + assert drift.distinct_attribute_match is None + + def test_all_settings_match(self, mock_meilisearch): + """When all settings match, returns non-drifted state.""" + mock_index = Mock() + mock_index.primary_key = INDEX_PRIMARY_KEY + mock_index.get_stats.return_value = Mock(number_of_documents=100) + mock_index.get_settings.return_value = { + "distinctAttribute": INDEX_DISTINCT_ATTRIBUTE, + "filterableAttributes": list(INDEX_FILTERABLE_ATTRIBUTES), + "searchableAttributes": list(INDEX_SEARCHABLE_ATTRIBUTES), + "sortableAttributes": list(INDEX_SORTABLE_ATTRIBUTES), + "rankingRules": list(INDEX_RANKING_RULES), + } + mock_meilisearch.return_value.get_index.return_value = mock_index + + drift = _detect_index_drift("test_index") + + assert drift.exists + assert drift.is_empty is False + assert drift.primary_key_correct is True + assert drift.distinct_attribute_match is True + assert drift.filterable_attributes_match is True + assert drift.searchable_attributes_match is True + assert drift.sortable_attributes_match is True + assert drift.ranking_rules_match is True + assert not drift.is_settings_drifted + + def test_filterable_attributes_mismatch(self, mock_meilisearch): + """Detects when filterable attributes differ.""" + mock_index = Mock() + mock_index.primary_key = INDEX_PRIMARY_KEY + mock_index.get_stats.return_value = Mock(number_of_documents=0) + mock_index.get_settings.return_value = { + "distinctAttribute": INDEX_DISTINCT_ATTRIBUTE, + "filterableAttributes": ["some_other_field"], + "searchableAttributes": list(INDEX_SEARCHABLE_ATTRIBUTES), + "sortableAttributes": list(INDEX_SORTABLE_ATTRIBUTES), + "rankingRules": list(INDEX_RANKING_RULES), + } + mock_meilisearch.return_value.get_index.return_value = mock_index + + drift = _detect_index_drift("test_index") + + assert drift.exists + assert drift.is_empty + assert drift.filterable_attributes_match is False + assert drift.distinct_attribute_match is True + assert drift.is_settings_drifted + + def test_ranking_rules_order_matters(self, mock_meilisearch): + """Ranking rules comparison is order-sensitive.""" + mock_index = Mock() + mock_index.primary_key = INDEX_PRIMARY_KEY + mock_index.get_stats.return_value = Mock(number_of_documents=50) + # Reverse the ranking rules + mock_index.get_settings.return_value = { + "distinctAttribute": INDEX_DISTINCT_ATTRIBUTE, + "filterableAttributes": list(INDEX_FILTERABLE_ATTRIBUTES), + "searchableAttributes": list(INDEX_SEARCHABLE_ATTRIBUTES), + "sortableAttributes": list(INDEX_SORTABLE_ATTRIBUTES), + "rankingRules": list(reversed(INDEX_RANKING_RULES)), + } + mock_meilisearch.return_value.get_index.return_value = mock_index + + drift = _detect_index_drift("test_index") + + assert drift.ranking_rules_match is False + assert drift.is_settings_drifted + + def test_filterable_attributes_order_independent(self, mock_meilisearch): + """Filterable/searchable/sortable attributes comparison is order-independent.""" + mock_index = Mock() + mock_index.primary_key = INDEX_PRIMARY_KEY + mock_index.get_stats.return_value = Mock(number_of_documents=10) + mock_index.get_settings.return_value = { + "distinctAttribute": INDEX_DISTINCT_ATTRIBUTE, + "filterableAttributes": list(reversed(INDEX_FILTERABLE_ATTRIBUTES)), + "searchableAttributes": list(reversed(INDEX_SEARCHABLE_ATTRIBUTES)), + "sortableAttributes": list(reversed(INDEX_SORTABLE_ATTRIBUTES)), + "rankingRules": list(INDEX_RANKING_RULES), + } + mock_meilisearch.return_value.get_index.return_value = mock_index + + drift = _detect_index_drift("test_index") + + assert drift.filterable_attributes_match is True + assert drift.searchable_attributes_match is True + assert drift.sortable_attributes_match is True + assert drift.primary_key_correct is True + assert not drift.is_settings_drifted + + def test_primary_key_mismatch(self, mock_meilisearch): + """Detects primary key mismatch.""" + mock_index = Mock() + mock_index.primary_key = "wrong_key" + mock_index.get_stats.return_value = Mock(number_of_documents=100) + mock_index.get_settings.return_value = { + "distinctAttribute": INDEX_DISTINCT_ATTRIBUTE, + "filterableAttributes": list(INDEX_FILTERABLE_ATTRIBUTES), + "searchableAttributes": list(INDEX_SEARCHABLE_ATTRIBUTES), + "sortableAttributes": list(INDEX_SORTABLE_ATTRIBUTES), + "rankingRules": list(INDEX_RANKING_RULES), + } + mock_meilisearch.return_value.get_index.return_value = mock_index + + drift = _detect_index_drift("test_index") + + assert drift.exists is True + assert drift.is_empty is False + assert drift.primary_key_correct is False + # Settings themselves are fine + assert not drift.is_settings_drifted + + def test_multiple_mismatches(self, mock_meilisearch): + """Reports all drifted fields when multiple settings differ.""" + mock_index = Mock() + mock_index.primary_key = INDEX_PRIMARY_KEY + mock_index.get_stats.return_value = Mock(number_of_documents=0) + mock_index.get_settings.return_value = { + "distinctAttribute": "wrong_attr", + "filterableAttributes": ["wrong"], + "searchableAttributes": list(INDEX_SEARCHABLE_ATTRIBUTES), + "sortableAttributes": list(INDEX_SORTABLE_ATTRIBUTES), + "rankingRules": ["wrong"], + } + mock_meilisearch.return_value.get_index.return_value = mock_index + + drift = _detect_index_drift("test_index") + + assert drift.distinct_attribute_match is False + assert drift.filterable_attributes_match is False + assert drift.searchable_attributes_match is True + assert drift.sortable_attributes_match is True + assert drift.ranking_rules_match is False + assert drift.is_settings_drifted + + +@skip_unless_cms +@override_settings(MEILISEARCH_ENABLED=True) +@patch("openedx.core.djangoapps.content.search.api.MeilisearchClient") +class TestApplyIndexSettings(TestCase): + """Tests for _apply_index_settings().""" + + def setUp(self): + super().setUp() + api.clear_meilisearch_client() + + @patch("openedx.core.djangoapps.content.search.api._wait_for_meili_task", new=MagicMock(return_value=None)) + def test_applies_all_settings(self, mock_meilisearch): + """All 5 settings are applied in wait mode.""" + mock_index = mock_meilisearch.return_value.index.return_value + status_cb = Mock() + + _apply_index_settings("test_index", wait=True, status_cb=status_cb) + + mock_index.update_distinct_attribute.assert_called_once_with(INDEX_DISTINCT_ATTRIBUTE) + mock_index.update_filterable_attributes.assert_called_once_with(INDEX_FILTERABLE_ATTRIBUTES) + mock_index.update_searchable_attributes.assert_called_once_with(INDEX_SEARCHABLE_ATTRIBUTES) + mock_index.update_sortable_attributes.assert_called_once_with(INDEX_SORTABLE_ATTRIBUTES) + mock_index.update_ranking_rules.assert_called_once_with(INDEX_RANKING_RULES) + + @patch("openedx.core.djangoapps.content.search.api._wait_for_meili_task") + def test_waits_for_each_task(self, mock_wait, mock_meilisearch): + """Each settings update is waited on when wait=True.""" + mock_index = mock_meilisearch.return_value.index.return_value + task_info = Mock() + mock_index.update_distinct_attribute.return_value = task_info + mock_index.update_filterable_attributes.return_value = task_info + mock_index.update_searchable_attributes.return_value = task_info + mock_index.update_sortable_attributes.return_value = task_info + mock_index.update_ranking_rules.return_value = task_info + + _apply_index_settings("test_index", wait=True) + + assert mock_wait.call_count == 5 + + @patch("openedx.core.djangoapps.content.search.api._wait_for_meili_task") + def test_does_not_wait_when_wait_false(self, mock_wait, mock_meilisearch): + """Settings are fire-and-forget when wait=False.""" + status_cb = Mock() + + _apply_index_settings("test_index", wait=False, status_cb=status_cb) + + mock_wait.assert_not_called() + status_cb.assert_called() + + @patch("openedx.core.djangoapps.content.search.api._wait_for_meili_task") + def test_raises_on_task_failure(self, mock_wait, mock_meilisearch): + """MeilisearchError is raised if a waited-on task fails.""" + mock_wait.side_effect = MeilisearchError("Task failed") + + with pytest.raises(MeilisearchError): + _apply_index_settings("test_index", wait=True) + + +@skip_unless_cms +@override_settings(MEILISEARCH_ENABLED=True) +@patch("openedx.core.djangoapps.content.search.api._wait_for_meili_task", new=MagicMock(return_value=None)) +@patch("openedx.core.djangoapps.content.search.api.MeilisearchClient") +class TestReconcileIndex(TestCase): + """Tests for reconcile_index().""" + + def setUp(self): + super().setUp() + api.clear_meilisearch_client() + + @patch("openedx.core.djangoapps.content.search.api._detect_index_drift") + @patch("openedx.core.djangoapps.content.search.api.reset_index") + def test_index_missing(self, mock_reset, mock_drift, mock_meilisearch): + """When index doesn't exist, reset_index is called to create it.""" + mock_drift.return_value = IndexDrift(exists=False) + status_cb = Mock() + + reconcile_index(status_cb=status_cb) + + mock_reset.assert_called_once() + status_cb.assert_any_call("Studio search index not found. Creating and configuring...") + + @patch("openedx.core.djangoapps.content.search.api._detect_index_drift") + def test_index_empty_configured(self, mock_drift, mock_meilisearch): + """When index is empty and configured, no action taken.""" + mock_drift.return_value = IndexDrift( + exists=True, + is_empty=True, + primary_key_correct=True, + distinct_attribute_match=True, + filterable_attributes_match=True, + searchable_attributes_match=True, + sortable_attributes_match=True, + ranking_rules_match=True, + ) + status_cb = Mock() + + reconcile_index(status_cb=status_cb) + + status_cb.assert_any_call( + "Index exists and is correctly configured but empty. Run './manage.py cms reindex_studio' to populate." + ) + + @patch("openedx.core.djangoapps.content.search.api._detect_index_drift") + @patch("openedx.core.djangoapps.content.search.api._apply_index_settings") + def test_index_empty_drifted_settings(self, mock_apply, mock_drift, mock_meilisearch): + """When index is empty and settings drifted, settings are applied.""" + mock_drift.return_value = IndexDrift( + exists=True, + is_empty=True, + primary_key_correct=True, + distinct_attribute_match=True, + filterable_attributes_match=False, + searchable_attributes_match=True, + sortable_attributes_match=True, + ranking_rules_match=True, + ) + status_cb = Mock() + + reconcile_index(status_cb=status_cb) + + mock_apply.assert_called_once_with(api.STUDIO_INDEX_NAME, wait=True, status_cb=status_cb) + status_cb.assert_any_call("Empty index has drifted settings. Reconfiguring...") + + @patch("openedx.core.djangoapps.content.search.api._detect_index_drift") + @patch("openedx.core.djangoapps.content.search.api.reset_index") + def test_index_empty_wrong_pk(self, mock_reset, mock_drift, mock_meilisearch): + """When index is empty with wrong PK, reset_index is called.""" + mock_drift.return_value = IndexDrift( + exists=True, + is_empty=True, + primary_key_correct=False, + distinct_attribute_match=True, + filterable_attributes_match=True, + searchable_attributes_match=True, + sortable_attributes_match=True, + ranking_rules_match=True, + ) + warn_cb = Mock() + + reconcile_index(warn_cb=warn_cb) + + mock_reset.assert_called_once() + warn_cb.assert_any_call("Primary key mismatch on empty index. Recreating...") + + @patch("openedx.core.djangoapps.content.search.api._detect_index_drift") + def test_index_populated_configured(self, mock_drift, mock_meilisearch): + """When index is populated and configured, no action taken.""" + mock_drift.return_value = IndexDrift( + exists=True, + is_empty=False, + primary_key_correct=True, + distinct_attribute_match=True, + filterable_attributes_match=True, + searchable_attributes_match=True, + sortable_attributes_match=True, + ranking_rules_match=True, + ) + status_cb = Mock() + + reconcile_index(status_cb=status_cb) + + status_cb.assert_any_call("Index is populated and correctly configured. No action needed.") + + @patch("openedx.core.djangoapps.content.search.api._detect_index_drift") + @patch("openedx.core.djangoapps.content.search.api._apply_index_settings") + def test_index_populated_drifted_settings(self, mock_apply, mock_drift, mock_meilisearch): + """When index is populated and drifted, settings are applied with warnings.""" + mock_drift.return_value = IndexDrift( + exists=True, + is_empty=False, + primary_key_correct=True, + distinct_attribute_match=True, + filterable_attributes_match=False, + searchable_attributes_match=False, + sortable_attributes_match=True, + ranking_rules_match=True, + ) + status_cb = Mock() + warn_cb = Mock() + + reconcile_index(status_cb=status_cb, warn_cb=warn_cb) + + mock_apply.assert_called_once_with(api.STUDIO_INDEX_NAME, wait=True, status_cb=status_cb) + # Check that drifted fields are logged + warn_cb.assert_any_call(" - filterableAttributes: DRIFTED") + warn_cb.assert_any_call(" - searchableAttributes: DRIFTED") + # Check that non-drifted fields are NOT logged as drifted + drifted_calls = [c for c in warn_cb.call_args_list if "DRIFTED" in str(c)] + assert len(drifted_calls) == 2 + + @patch("openedx.core.djangoapps.content.search.api._detect_index_drift") + @patch("openedx.core.djangoapps.content.search.api.reset_index") + def test_index_populated_wrong_pk(self, mock_reset, mock_drift, mock_meilisearch): + """When index is populated with wrong PK, reset_index is called (destructive).""" + mock_drift.return_value = IndexDrift( + exists=True, + is_empty=False, + primary_key_correct=False, + distinct_attribute_match=True, + filterable_attributes_match=True, + searchable_attributes_match=True, + sortable_attributes_match=True, + ranking_rules_match=True, + ) + warn_cb = Mock() + + reconcile_index(warn_cb=warn_cb) + + mock_reset.assert_called_once() + # Should warn about data loss + warn_cb.assert_any_call("Index recreated empty. Run './manage.py cms reindex_studio' to repopulate.") + + @override_settings(MEILISEARCH_ENABLED=False) + def test_meilisearch_disabled(self, mock_meilisearch): + """When Meilisearch is disabled, reconcile_index raises RuntimeError (from client).""" + api.clear_meilisearch_client() + with pytest.raises(RuntimeError): + reconcile_index() + + +@skip_unless_cms +@override_settings(MEILISEARCH_ENABLED=True) +@patch("openedx.core.djangoapps.content.search.api._wait_for_meili_task", new=MagicMock(return_value=None)) +@patch("openedx.core.djangoapps.content.search.api.MeilisearchClient") +class TestHandlePostMigrate(TestCase): + """Tests for the handle_post_migrate signal handler.""" + + def setUp(self): + super().setUp() + api.clear_meilisearch_client() + + @patch("openedx.core.djangoapps.content.search.handlers.reconcile_index") + def test_calls_reconcile_for_search_app(self, mock_reconcile, mock_meilisearch): + """Handler calls reconcile_index when sender is the search app.""" + sender = Mock() + sender.label = ContentSearchConfig.label + + handle_post_migrate(sender=sender) + + mock_reconcile.assert_called_once() + + @patch("openedx.core.djangoapps.content.search.handlers.reconcile_index") + def test_skips_wrong_sender(self, mock_reconcile, mock_meilisearch): + """Handler does nothing when sender is a different app.""" + sender = Mock() + sender.label = "some_other_app" + + handle_post_migrate(sender=sender) + + mock_reconcile.assert_not_called() + + @override_settings(MEILISEARCH_ENABLED=False) + @patch("openedx.core.djangoapps.content.search.handlers.reconcile_index") + def test_skips_when_disabled(self, mock_reconcile, mock_meilisearch): + """Handler does nothing when Meilisearch is disabled.""" + sender = Mock() + sender.label = ContentSearchConfig.label + + handle_post_migrate(sender=sender) + + mock_reconcile.assert_not_called() + + @patch("openedx.core.djangoapps.content.search.handlers.reconcile_index") + def test_catches_connection_error(self, mock_reconcile, mock_meilisearch): + """Handler catches ConnectionError and logs warning.""" + sender = Mock() + sender.label = ContentSearchConfig.label + mock_reconcile.side_effect = ConnectionError("Cannot connect") + + # Should not raise + handle_post_migrate(sender=sender) + + @patch("openedx.core.djangoapps.content.search.handlers.reconcile_index") + def test_catches_meilisearch_error(self, mock_reconcile, mock_meilisearch): + """Handler catches MeilisearchError and logs warning.""" + sender = Mock() + sender.label = ContentSearchConfig.label + mock_reconcile.side_effect = MeilisearchError("Something went wrong") + + # Should not raise + handle_post_migrate(sender=sender) + + @patch("openedx.core.djangoapps.content.search.handlers.reconcile_index") + def test_catches_generic_exception(self, mock_reconcile, mock_meilisearch): + """Handler catches unexpected exceptions and logs warning.""" + sender = Mock() + sender.label = ContentSearchConfig.label + mock_reconcile.side_effect = RuntimeError("Unexpected") + + # Should not raise + handle_post_migrate(sender=sender) + + def test_signal_connected(self, mock_meilisearch): + """Verify post_migrate signal is connected to handle_post_migrate.""" + from django.db.models.signals import post_migrate + + from ..handlers import handle_post_migrate as handler_fn + + # Check that the handler is in the receivers + receiver_funcs = [r[1]() for r in post_migrate.receivers if r[1]() is not None] + assert handler_fn in receiver_funcs, "handle_post_migrate should be connected to post_migrate signal" + + +@skip_unless_cms +@override_settings(MEILISEARCH_ENABLED=True) +@patch("openedx.core.djangoapps.content.search.api._wait_for_meili_task", new=MagicMock(return_value=None)) +@patch("openedx.core.djangoapps.content.search.api.MeilisearchClient") +class TestInitIndexBackwardCompat(TestCase): + """Tests that init_index() still works as a compatibility wrapper.""" + + def setUp(self): + super().setUp() + api.clear_meilisearch_client() + + @patch("openedx.core.djangoapps.content.search.api.reconcile_index") + def test_init_index_delegates_to_reconcile(self, mock_reconcile, mock_meilisearch): + """init_index() should delegate to reconcile_index().""" + status_cb = Mock() + warn_cb = Mock() + + api.init_index(status_cb=status_cb, warn_cb=warn_cb) + + mock_reconcile.assert_called_once_with(status_cb=status_cb, warn_cb=warn_cb) diff --git a/openedx/core/djangoapps/content/search/tests/test_reindex_cmd.py b/openedx/core/djangoapps/content/search/tests/test_reindex_cmd.py new file mode 100644 index 000000000000..45a89d7d9e04 --- /dev/null +++ b/openedx/core/djangoapps/content/search/tests/test_reindex_cmd.py @@ -0,0 +1,96 @@ +""" +Tests for the reindex_studio management command and the rebuild_index_incremental Celery task. +""" + +from __future__ import annotations + +from unittest.mock import MagicMock, Mock, patch + +import pytest +from django.core.management import CommandError, call_command +from django.test import TestCase, override_settings + +from openedx.core.djangolib.testing.utils import skip_unless_cms + +try: + from .. import api + from ..tasks import rebuild_index_incremental +except RuntimeError: + pass + + +@skip_unless_cms +@override_settings(MEILISEARCH_ENABLED=True) +class TestReindexStudioCommand(TestCase): + """Tests for the reindex_studio management command.""" + + @patch("openedx.core.djangoapps.content.search.tasks.rebuild_index_incremental.delay") + def test_enqueues_task(self, mock_delay): + """Command enqueues the incremental rebuild task.""" + mock_delay.return_value = Mock(id="fake-task-id") + + call_command("reindex_studio") + + mock_delay.assert_called_once_with() + + @override_settings(MEILISEARCH_ENABLED=False) + def test_disabled(self): + """Command raises error when Meilisearch is disabled.""" + with pytest.raises(CommandError, match="not enabled"): + call_command("reindex_studio") + + @patch("openedx.core.djangoapps.content.search.tasks.rebuild_index_incremental.delay") + @patch("openedx.core.djangoapps.content.search.management.commands.reindex_studio.log") + def test_incremental_flag_accepted_with_warning(self, mock_log, mock_delay): + """Passing old flags logs a warning but still enqueues the task.""" + mock_delay.return_value = Mock(id="fake-task-id") + + call_command("reindex_studio", "--incremental", "--init", "--experimental", "--reset") + + assert mock_log.warning.call_count == 4 + mock_delay.assert_called_once_with() + + +@skip_unless_cms +@override_settings(MEILISEARCH_ENABLED=True) +@patch("openedx.core.djangoapps.content.search.api._wait_for_meili_task", new=MagicMock(return_value=None)) +@patch("openedx.core.djangoapps.content.search.api.MeilisearchClient") +class TestRebuildIndexIncrementalTask(TestCase): + """Tests for the rebuild_index_incremental Celery task.""" + + def setUp(self): + super().setUp() + api.clear_meilisearch_client() + + @patch("openedx.core.djangoapps.content.search.api.rebuild_index") + def test_calls_rebuild_incremental(self, mock_rebuild, mock_meilisearch): + """Task calls api.rebuild_index with incremental=True.""" + rebuild_index_incremental() + + mock_rebuild.assert_called_once() + _, kwargs = mock_rebuild.call_args + assert kwargs["incremental"] is True + + @patch("openedx.core.djangoapps.content.search.api.rebuild_index") + def test_rebuild_already_in_progress(self, mock_rebuild, mock_meilisearch): + """Task exits gracefully if rebuild lock is already held.""" + mock_rebuild.side_effect = RuntimeError("Rebuild already in progress") + + # Should not raise + rebuild_index_incremental() + + @patch("openedx.core.djangoapps.content.search.api.rebuild_index") + def test_other_runtime_error_raised(self, mock_rebuild, mock_meilisearch): + """Task re-raises RuntimeError if it's not about lock contention.""" + mock_rebuild.side_effect = RuntimeError("Something else went wrong") + + with pytest.raises(RuntimeError, match="Something else went wrong"): + rebuild_index_incremental() + + @patch("openedx.core.djangoapps.content.search.api.rebuild_index") + def test_idempotent(self, mock_rebuild, mock_meilisearch): + """Task can be called multiple times safely.""" + rebuild_index_incremental() + rebuild_index_incremental() + + assert mock_rebuild.call_count == 2 diff --git a/openedx/core/djangoapps/content/search/tests/test_views.py b/openedx/core/djangoapps/content/search/tests/test_views.py index 7c1b8e99850a..3d056b2b4327 100644 --- a/openedx/core/djangoapps/content/search/tests/test_views.py +++ b/openedx/core/djangoapps/content/search/tests/test_views.py @@ -110,12 +110,12 @@ def test_studio_search_enabled(self, mock_search_client): so any logged-in user can get a restricted API key for Meilisearch using the REST API. """ self.client.login(username='student', password='student_pass') - mock_generate_tenant_token = self._mock_generate_tenant_token(mock_search_client) + mock_generate_tenant_token = self._mock_generate_tenant_token(mock_search_client) # noqa: F841 result = self.client.get(STUDIO_SEARCH_ENDPOINT_URL) assert result.status_code == 200 assert result.data["index_name"] == "studio_content" assert result.data["url"] == "http://meilisearch.url" - assert result.data["api_key"] and isinstance(result.data["api_key"], str) + assert result.data["api_key"] and isinstance(result.data["api_key"], str) # noqa: PT018 @mock_meilisearch(enabled=True) @patch('openedx.core.djangoapps.content.search.api.MeilisearchClient') diff --git a/openedx/core/djangoapps/content/search/urls.py b/openedx/core/djangoapps/content/search/urls.py index c69be33d5bb0..fe38d83f5ef4 100644 --- a/openedx/core/djangoapps/content/search/urls.py +++ b/openedx/core/djangoapps/content/search/urls.py @@ -5,7 +5,6 @@ from .views import StudioSearchView - urlpatterns = [ path('api/content_search/v2/studio/', StudioSearchView.as_view(), name='studio_content_search') ] diff --git a/openedx/core/djangoapps/content_libraries/admin.py b/openedx/core/djangoapps/content_libraries/admin.py index f84cac7f62e2..f0ab84b91526 100644 --- a/openedx/core/djangoapps/content_libraries/admin.py +++ b/openedx/core/djangoapps/content_libraries/admin.py @@ -2,16 +2,8 @@ Admin site for content libraries """ from django.contrib import admin -from .models import ContentLibrary, ContentLibraryPermission - -class ContentLibraryPermissionInline(admin.TabularInline): - """ - Inline form for a content library's permissions - """ - model = ContentLibraryPermission - raw_id_fields = ("user", "group", ) - extra = 0 +from .models import ContentLibrary @admin.register(ContentLibrary) @@ -24,18 +16,17 @@ class ContentLibraryAdmin(admin.ModelAdmin): "library_key", "org", "slug", + "learning_package", "allow_public_learning", "allow_public_read", - "authorized_lti_configs", ) list_display = ("slug", "org",) - inlines = (ContentLibraryPermissionInline, ) def get_readonly_fields(self, request, obj=None): """ Ensure that 'slug' and 'uuid' cannot be edited after creation. """ + always_ro_fields = ["library_key", "learning_package"] if obj: - return ["library_key", "org", "slug"] - else: - return ["library_key", ] + return [*always_ro_fields, "org", "slug"] + return always_ro_fields diff --git a/openedx/core/djangoapps/content_libraries/api/__init__.py b/openedx/core/djangoapps/content_libraries/api/__init__.py index 5f7db8b17f72..7100397cd4e4 100644 --- a/openedx/core/djangoapps/content_libraries/api/__init__.py +++ b/openedx/core/djangoapps/content_libraries/api/__init__.py @@ -1,12 +1,12 @@ """ Python API for working with content libraries """ -from .block_metadata import * -from .collections import * -from .container_metadata import * -from .containers import * -from .courseware_import import * -from .exceptions import * -from .libraries import * -from .blocks import * -from . import permissions +from . import permissions # noqa: F401 +from .backup import * # noqa: F403 +from .block_metadata import * # noqa: F403 +from .blocks import * # noqa: F403 +from .collections import * # noqa: F403 +from .container_metadata import * # noqa: F403 +from .containers import * # noqa: F403 +from .exceptions import * # noqa: F403 +from .libraries import * # noqa: F403 diff --git a/openedx/core/djangoapps/content_libraries/api/backup.py b/openedx/core/djangoapps/content_libraries/api/backup.py new file mode 100644 index 000000000000..a8a0b90cc0f2 --- /dev/null +++ b/openedx/core/djangoapps/content_libraries/api/backup.py @@ -0,0 +1,81 @@ +""" +Public API for content library backup (zip export) utilities. +""" +from __future__ import annotations + +import os +import shutil +import zipfile +from datetime import datetime +from tempfile import mkdtemp + +from django.conf import settings +from django.contrib.auth import get_user_model +from django.utils.text import slugify +from opaque_keys.edx.locator import LibraryLocatorV2, log +from openedx_content.api import create_zip_file as create_lib_zip_file +from path import Path + +__all__ = ["create_library_v2_zip", "extract_library_v2_zip_to_dir"] + + +def create_library_v2_zip(library_key: LibraryLocatorV2, user) -> tuple: + """ + Create a zip backup of a v2 library and return ``(temp_dir, zip_file_path)``. + + The caller is responsible for cleaning up ``temp_dir`` when done. + + Args: + library_key: LibraryLocatorV2 identifying the library to export. + user: User object passed to the backup API. + + Returns: + A tuple of ``(temp_dir as Path, zip_file_path as str)``. + """ + root_dir = Path(mkdtemp()) + sanitized_lib_key = str(library_key).replace(":", "-") + sanitized_lib_key = slugify(sanitized_lib_key, allow_unicode=True) + timestamp = datetime.now().strftime("%Y-%m-%d-%H%M%S") + filename = f'{sanitized_lib_key}-{timestamp}.zip' + file_path = os.path.join(root_dir, filename) + origin_server = getattr(settings, 'CMS_BASE', None) + create_lib_zip_file(package_ref=str(library_key), path=file_path, user=user, origin_server=origin_server) + return root_dir, file_path + + +def extract_library_v2_zip_to_dir(library_key, root_dir, library_dir, username=None): + """ + Export a v2 library to a directory by creating a zip backup and extracting it. + + V2 libraries are stored in Learning Core and use a zip-based backup mechanism. + This function creates a temporary zip backup, extracts its contents into + ``library_dir`` under ``root_dir``, then cleans up the temporary zip. + + Args: + library_key: LibraryLocatorV2 for the library to export + root_dir: Root directory where library_dir will be created + library_dir: Directory name under root_dir to extract the library into + username: Username string for the backup API (optional) + + Raises: + Exception: If backup creation or extraction fails + DoesNotExist: If the specified user does not exist + """ + # Get user object for backup API (if username provided) + user_obj = None + if username: + # Let it raise if given user doesn't exist + user_obj = get_user_model().objects.get(username=username) + + temp_dir, zip_path = create_library_v2_zip(library_key, user_obj) + + try: + target_dir = os.path.join(root_dir, library_dir) + os.makedirs(target_dir, exist_ok=True) + # Extract zip contents (will overwrite existing files) + with zipfile.ZipFile(zip_path, 'r') as zip_ref: + zip_ref.extractall(target_dir) + log.info('Extracted library v2 backup to %s', target_dir) + finally: + if temp_dir.exists(): + shutil.rmtree(temp_dir) diff --git a/openedx/core/djangoapps/content_libraries/api/block_metadata.py b/openedx/core/djangoapps/content_libraries/api/block_metadata.py index f117d2762949..1d8fe64b5330 100644 --- a/openedx/core/djangoapps/content_libraries/api/block_metadata.py +++ b/openedx/core/djangoapps/content_libraries/api/block_metadata.py @@ -2,21 +2,41 @@ Content libraries data classes related to XBlocks/Components. """ from __future__ import annotations + from dataclasses import dataclass +from datetime import datetime +from typing import TypedDict +from uuid import UUID + +from django.contrib.auth.models import AbstractUser +from django.utils.translation import gettext as _ # noqa: F401 +from opaque_keys.edx.locator import LibraryContainerLocator, LibraryLocatorV2, LibraryUsageLocatorV2 +from openedx_content.models_api import PublishableEntityVersion, PublishLogRecord + +from openedx.core.djangoapps.user_api.accounts.image_helpers import get_profile_image_urls_for_user -from django.utils.translation import gettext as _ -from opaque_keys.edx.locator import LibraryUsageLocatorV2 from .libraries import ( - library_component_usage_key, PublishableItem, + library_component_usage_key, ) # The public API is only the following symbols: __all__ = [ "LibraryXBlockMetadata", "LibraryXBlockStaticFile", + "LibraryHistoryEntry", + "LibraryHistoryContributor", + "LibraryPublishHistoryGroup", ] +class ProfileImageUrls(TypedDict): + """URLs for a user's profile image in different sizes.""" + + full: str + large: str + medium: str + small: str + @dataclass(frozen=True, kw_only=True) class LibraryXBlockMetadata(PublishableItem): @@ -26,9 +46,20 @@ class LibraryXBlockMetadata(PublishableItem): usage_key: LibraryUsageLocatorV2 @classmethod - def from_component(cls, library_key, component, associated_collections=None): + def from_component( + cls, + library_key: LibraryLocatorV2, + component, + associated_collections=None, + use_published=False, + ) -> LibraryXBlockMetadata: """ Construct a LibraryXBlockMetadata from a Component object. + + Requires that the draft version of the component exists, unless you + specify use_published=True, in which case it requires that the published + version exists. The 'display_name' and 'modified' fields will depend on + which version you request. """ # Import content_tagging.api here to avoid circular imports from openedx.core.djangoapps.content_tagging.api import get_object_tag_counts @@ -41,16 +72,17 @@ def from_component(cls, library_key, component, associated_collections=None): draft = component.versioning.draft published = component.versioning.published last_draft_created = draft.created if draft else None - last_draft_created_by = draft.publishable_entity_version.created_by if draft else None + last_draft_created_by = draft.publishable_entity_version.created_by if draft else "" usage_key = library_component_usage_key(library_key, component) tags = get_object_tag_counts(str(usage_key), count_implicit=True) return cls( usage_key=usage_key, - display_name=draft.title, + display_name=published.title if use_published else draft.title, created=component.created, - modified=draft.created, - draft_version_num=draft.version_num, + created_by=component.created_by.username if component.created_by else None, + modified=published.created if use_published else draft.created, + draft_version_num=draft.version_num if draft else None, published_version_num=published.version_num if published else None, published_display_name=published.title if published else None, last_published=None if last_publish_log is None else last_publish_log.published_at, @@ -64,6 +96,78 @@ def from_component(cls, library_key, component, associated_collections=None): ) +@dataclass(frozen=True) +class LibraryHistoryEntry: + """ + One entry in the history of a library component. + """ + contributor: LibraryHistoryContributor | None + changed_at: datetime + title: str # title at time of change + item_type: str + action: str # "created" | "edited" | "renamed" | "deleted" + old_version: int + new_version: int | None + + +@dataclass(frozen=True) +class LibraryHistoryContributor: + """ + A contributor in a publish history group, with profile image URLs. + """ + username: str + profile_image_urls: ProfileImageUrls + + @classmethod + def from_user(cls, user, request=None) -> LibraryHistoryContributor: + return cls( + username=user.username, + profile_image_urls=get_profile_image_urls_for_user(user, request), + ) + + +@dataclass(frozen=True) +class DirectPublishedEntity: + """ + Represents one entity the user directly requested to publish (direct=True). + Each entry carries its own title and entity_type so the frontend can display + the correct label for each directly published item. + + Pre-Verawood groups have exactly one entry (approximated from available data). + Post-Verawood groups have one entry per direct=True record in the PublishLog. + """ + entity_key: LibraryUsageLocatorV2 | LibraryContainerLocator + title: str # title of the entity at time of publish + entity_type: str # e.g. "html", "problem" for components; "unit", "section" for containers + + +@dataclass(frozen=True) +class LibraryPublishHistoryGroup: + """ + Summary of a publish event for a library item. + + Each instance represents one or more PublishLogRecords, and includes the + set of contributors who authored draft changes between the previous publish + and this one. + + Pre-Verawood (direct=None): one group per entity × publish event. + Post-Verawood (direct!=None): one group per unique PublishLog. + """ + publish_log_uuid: UUID + published_by: AbstractUser | None + published_at: datetime + contributors: list[LibraryHistoryContributor] # distinct authors of versions in this group + # Each element is one entity the user directly requested to publish. + # Pre-Verawood: single approximated entry derived from the group's entity. + # Post-Verawood: one entry per direct=True record in the PublishLog. + direct_published_entities: list[DirectPublishedEntity] + # Key to pass as scope_entity_key when fetching entries for this group. + # Pre-Verawood: the specific entity key for this group (container or usage key). + # Post-Verawood container groups: None — frontend must use currentContainerKey. + # Component history (all eras): usage_key. + scope_entity_key: LibraryUsageLocatorV2 | LibraryContainerLocator | None + + @dataclass(frozen=True) class LibraryXBlockStaticFile: """ @@ -77,3 +181,85 @@ class LibraryXBlockStaticFile: url: str # Size in bytes size: int + + + +def get_entity_item_type(entity) -> str: + """ + Return the item type string for a PublishableEntity (component or container). + """ + if hasattr(entity, 'component'): + return entity.component.component_type.name + if hasattr(entity, 'container'): + return entity.container.container_type.type_code + raise ValueError(f"Entity {entity} is neither a component nor a container.") + + +def make_contributor(user, request=None) -> LibraryHistoryContributor | None: + """ + Convert a single User (or None) to a LibraryHistoryContributor. + + None input produces None output — frontend renders as default/anonymous. + """ + return LibraryHistoryContributor.from_user(user, request) if user else None + + +def resolve_change_action( + old_version: PublishableEntityVersion | None, + new_version: PublishableEntityVersion | None, +) -> str: + """ + Derive a human-readable action label from a draft history record's versions. + """ + if old_version is None: + return "created" + if new_version is None: + return "deleted" + if old_version.title != new_version.title: + return "renamed" + return "edited" + + +def direct_published_entity_from_record( + record: PublishLogRecord, + lib_key: LibraryLocatorV2, +) -> DirectPublishedEntity: + """ + Build a DirectPublishedEntity from a PublishLogRecord. + + lib_key is used only to construct locator strings — entity_key is always + derived from record.entity itself, never from an external container key. + + Callers must ensure the record is fetched with: + select_related( + 'entity__component__component_type', + 'entity__container__container_type', + 'new_version', + 'old_version', + ) + """ + # Import here to avoid circular imports (container_metadata imports block_metadata). + from .container_metadata import library_container_locator # noqa: PLC0415 + + # Use new_version title when available; fall back to old_version for soft-deletes (new_version=None). + version = record.new_version or record.old_version + title = version.title if version else "" + if hasattr(record.entity, 'component'): + component = record.entity.component + return DirectPublishedEntity( + entity_key=LibraryUsageLocatorV2( # type: ignore[abstract] + lib_key=lib_key, + block_type=component.component_type.name, + usage_id=component.component_code, + ), + title=title, + entity_type=component.component_type.name, + ) + if hasattr(record.entity, 'container'): + container = record.entity.container + return DirectPublishedEntity( + entity_key=library_container_locator(lib_key, container), + title=title, + entity_type=container.container_type.type_code, + ) + raise ValueError(f"PublishableEntity {record.entity.pk!r} is neither a Component nor a Container") diff --git a/openedx/core/djangoapps/content_libraries/api/blocks.py b/openedx/core/djangoapps/content_libraries/api/blocks.py index 4cf46627d1d2..077b8e6a94c5 100644 --- a/openedx/core/djangoapps/content_libraries/api/blocks.py +++ b/openedx/core/djangoapps/content_libraries/api/blocks.py @@ -4,53 +4,59 @@ These methods don't enforce permissions (only the REST APIs do). """ from __future__ import annotations + import logging import mimetypes from datetime import datetime, timezone +from functools import cache from typing import TYPE_CHECKING -from uuid import uuid4 +from uuid import UUID, uuid4 from django.conf import settings from django.core.exceptions import ObjectDoesNotExist, ValidationError from django.core.validators import validate_unicode_slug from django.db import transaction -from django.db.models import QuerySet +from django.db.models import F, QuerySet from django.urls import reverse from django.utils.text import slugify from django.utils.translation import gettext as _ from lxml import etree from opaque_keys import InvalidKeyError -from opaque_keys.edx.locator import LibraryContainerLocator, LibraryLocatorV2, LibraryUsageLocatorV2 from opaque_keys.edx.keys import LearningContextKey, UsageKeyV2 -from openedx_events.content_authoring.data import ( - ContentObjectChangedData, - LibraryBlockData, - LibraryCollectionData, - LibraryContainerData -) -from openedx_events.content_authoring.signals import ( - CONTENT_OBJECT_ASSOCIATIONS_CHANGED, - LIBRARY_BLOCK_CREATED, - LIBRARY_BLOCK_DELETED, - LIBRARY_BLOCK_UPDATED, - LIBRARY_COLLECTION_UPDATED, - LIBRARY_CONTAINER_UPDATED -) -from openedx_learning.api import authoring as authoring_api -from openedx_learning.api.authoring_models import ( - Component, ComponentVersion, LearningPackage, MediaType, - Container, Collection -) +from opaque_keys.edx.locator import LibraryContainerLocator, LibraryLocatorV2, LibraryUsageLocatorV2 +from openedx_content import api as content_api +from openedx_content.models_api import Collection, Component, ComponentVersion, Container, LearningPackage, MediaType +from openedx_events.content_authoring.data import LibraryBlockData +from openedx_events.content_authoring.signals import LIBRARY_BLOCK_DELETED from xblock.core import XBlock +from openedx.core.djangoapps.content_staging.data import StagedContentID from openedx.core.djangoapps.xblock.api import ( get_component_from_usage_key, get_xblock_app_config, - xblock_type_display_name + xblock_type_display_name, ) from openedx.core.types import User as UserType from ..models import ContentLibrary +from .block_metadata import ( + DirectPublishedEntity, + LibraryHistoryContributor, + LibraryHistoryEntry, + LibraryPublishHistoryGroup, + LibraryXBlockMetadata, + LibraryXBlockStaticFile, + direct_published_entity_from_record, + make_contributor, + resolve_change_action, +) +from .container_metadata import container_subclass_for_olx_tag +from .containers import ( + ContainerMetadata, + create_container, + get_container, + update_container_children, +) from .exceptions import ( BlockLimitReachedError, ContentLibraryBlockNotFound, @@ -58,18 +64,7 @@ InvalidNameError, LibraryBlockAlreadyExists, ) -from .block_metadata import LibraryXBlockMetadata, LibraryXBlockStaticFile -from .containers import ( - create_container, - get_container, - get_containers_contains_item, - update_container_children, - ContainerMetadata, - ContainerType, -) -from .collections import library_collection_locator from .libraries import PublishableItem -from .. import tasks # This content_libraries API is sometimes imported in the LMS (should we prevent that?), but the content_staging app # cannot be. For now we only need this one type import at module scope, so only import it during type checks. @@ -79,6 +74,7 @@ log = logging.getLogger(__name__) + # The public API is only the following symbols: __all__ = [ # API methods @@ -98,6 +94,10 @@ "add_library_block_static_asset_file", "delete_library_block_static_asset_file", "publish_component_changes", + "get_library_component_draft_history", + "get_library_component_publish_history", + "get_library_component_publish_history_entries", + "get_library_component_creation_entry", ] @@ -115,7 +115,7 @@ def get_library_components( lib = ContentLibrary.objects.get_by_key(library_key) # type: ignore[attr-defined] learning_package = lib.learning_package assert learning_package is not None - components = authoring_api.get_components( + components = content_api.get_components( learning_package.id, draft=True, namespace='xblock.v1', @@ -133,7 +133,7 @@ def get_library_containers(library_key: LibraryLocatorV2) -> QuerySet[Container] lib = ContentLibrary.objects.get_by_key(library_key) # type: ignore[attr-defined] learning_package = lib.learning_package assert learning_package is not None - containers: QuerySet[Container] = authoring_api.get_containers( + containers: QuerySet[Container] = content_api.get_containers( learning_package.id ) @@ -147,7 +147,7 @@ def get_library_collections(library_key: LibraryLocatorV2) -> QuerySet[Collectio lib = ContentLibrary.objects.get_by_key(library_key) # type: ignore[attr-defined] learning_package = lib.learning_package assert learning_package is not None - collections = authoring_api.get_collections( + collections = content_api.get_collections( learning_package.id ) return collections @@ -177,10 +177,13 @@ def get_library_block(usage_key: LibraryUsageLocatorV2, include_collections=Fals raise ContentLibraryBlockNotFound(usage_key) if include_collections: - associated_collections = authoring_api.get_entity_collections( + # Temporarily alias collection_code to "key" so downstream consumers + # (search indexer, REST API) keep the same field name. We will update + # downstream consumers later: https://github.com/openedx/openedx-platform/issues/38406 + associated_collections = content_api.get_entity_collections( component.learning_package_id, - component.key, - ).values('key', 'title') + component.entity_ref, + ).values("title", key=F('collection_code')) else: associated_collections = None xblock_metadata = LibraryXBlockMetadata.from_component( @@ -191,7 +194,233 @@ def get_library_block(usage_key: LibraryUsageLocatorV2, include_collections=Fals return xblock_metadata -def set_library_block_olx(usage_key: LibraryUsageLocatorV2, new_olx_str: str) -> ComponentVersion: +def get_library_component_draft_history( + usage_key: LibraryUsageLocatorV2, + request=None, +) -> list[LibraryHistoryEntry]: + """ + Return the draft change history for a library component since its last publication, + ordered from most recent to oldest. + + Raises ContentLibraryBlockNotFound if the component does not exist. + """ + try: + component = get_component_from_usage_key(usage_key) + except ObjectDoesNotExist as exc: + raise ContentLibraryBlockNotFound(usage_key) from exc + + @cache + def _contributor(user): + return make_contributor(user, request) + + draft_change_records = ( + content_api.get_entity_draft_history(component.publishable_entity) + .select_related("entity__component__component_type", "draft_change_log__changed_by__profile") + ) + entries = [] + for record in draft_change_records: + version = record.new_version if record.new_version is not None else record.old_version + # old_version is None only for the very first publish (entity had no prior published version) + old_version_num = record.old_version.version_num if record.old_version else 0 + # new_version is None for soft-delete publishes (component deleted without a new draft version) + new_version_num = record.new_version.version_num if record.new_version else None + entries.append(LibraryHistoryEntry( + contributor=_contributor(record.draft_change_log.changed_by), + changed_at=record.draft_change_log.changed_at, + title=version.title if version is not None else "", + item_type=record.entity.component.component_type.name, + action=resolve_change_action(record.old_version, record.new_version), + old_version=old_version_num, + new_version=new_version_num, + )) + return entries + + +def get_library_component_publish_history( + usage_key: LibraryUsageLocatorV2, + request=None, +) -> list[LibraryPublishHistoryGroup]: + """ + Return the publish history of a library component as a list of groups. + + Each group corresponds to one publish event (PublishLogRecord) and includes: + - who published and when + - the distinct set of contributors: users who authored draft changes between + the previous publish and this one (via DraftChangeLogRecord version bounds) + + direct_published_entities per era: + - Pre-Verawood (direct=None): single entry for the component itself. + - Post-Verawood, direct=True: single entry for the component (directly published). + - Post-Verawood, direct=False: all direct=True records from the same PublishLog + (e.g. a parent container that was directly published). + + Groups are ordered most-recent-first. Returns [] if the component has never + been published. + """ + try: + component = get_component_from_usage_key(usage_key) + except ObjectDoesNotExist as exc: + raise ContentLibraryBlockNotFound(usage_key) from exc + + entity = component.publishable_entity + publish_records = ( + content_api.get_entity_publish_history(entity) + .select_related("entity__component__component_type") + ) + + groups = [] + for pub_record in publish_records: + # old_version is None only for the very first publish (entity had no prior published version) + old_version_num = pub_record.old_version.version_num if pub_record.old_version else 0 + # new_version is None for soft-delete publishes (component deleted without a new draft version) + new_version_num = pub_record.new_version.version_num if pub_record.new_version else None + + contributing_users = content_api.get_entity_version_contributors( + entity, + old_version_num=old_version_num, + new_version_num=new_version_num, + ).select_related('profile') + contributors = [ + LibraryHistoryContributor.from_user(user, request) + for user in contributing_users + ] + + if pub_record.direct is None or pub_record.direct is True: + # Pre-Verawood or component was directly published: single entry for itself. + # Use new_version title normally; fall back to old_version for soft-delete publishes + # (new_version=None means the component was deleted). + version = pub_record.new_version or pub_record.old_version + direct_published_entities = [DirectPublishedEntity( + entity_key=usage_key, + title=version.title if version else "", + entity_type=pub_record.entity.component.component_type.name, + )] + else: + # Post-Verawood, direct=False: component published as a dependency. + # Find all direct=True records in the same PublishLog. + direct_records = ( + pub_record.publish_log.records + .filter(direct=True) + .select_related( + 'entity__component__component_type', + 'entity__container__container_type', + 'new_version', + 'old_version', + ) + ) + direct_published_entities = [ + direct_published_entity_from_record(r, usage_key.lib_key) + for r in direct_records + ] + + groups.append(LibraryPublishHistoryGroup( + publish_log_uuid=pub_record.publish_log.uuid, + published_by=pub_record.publish_log.published_by, + published_at=pub_record.publish_log.published_at, + contributors=contributors, + direct_published_entities=direct_published_entities, + scope_entity_key=usage_key, + )) + + return groups + + +def get_library_component_publish_history_entries( + usage_key: LibraryUsageLocatorV2, + publish_log_uuid: UUID, + request=None, +) -> list[LibraryHistoryEntry]: + """ + Return the individual draft change entries for a specific publish event. + + Called lazily when the user expands a publish event in the UI. Entries are + the DraftChangeLogRecords that fall between the previous publish event and + this one, ordered most-recent-first. + """ + try: + component = get_component_from_usage_key(usage_key) + except ObjectDoesNotExist as exc: + raise ContentLibraryBlockNotFound(usage_key) from exc + + @cache + def _contributor(user): + return make_contributor(user, request) + + records = ( + content_api.get_entity_publish_history_entries( + component.publishable_entity, str(publish_log_uuid) + ) + .select_related("entity__component__component_type", "draft_change_log__changed_by__profile") + ) + entries = [] + for record in records: + # Deleted components can't reach this endpoint, so new_version is always set. + # (Unlike containers — see get_library_container_publish_history_entries.) + assert record.new_version is not None # for satisfy the type check + # old_version is None only for the very first publish (entity had no prior published version) + old_version_num = record.old_version.version_num if record.old_version else 0 + # new_version is None for soft-delete publishes (component deleted without a new draft version) + new_version_num = record.new_version.version_num if record.new_version else None + entries.append(LibraryHistoryEntry( + contributor=_contributor(record.draft_change_log.changed_by), + changed_at=record.draft_change_log.changed_at, + title=record.new_version.title, + item_type=record.entity.component.component_type.name, + action=resolve_change_action(record.old_version, record.new_version), + old_version=old_version_num, + new_version=new_version_num, + )) + return entries + + +def get_library_component_creation_entry( + usage_key: LibraryUsageLocatorV2, + request=None, +) -> LibraryHistoryEntry | None: + """ + Return the creation entry for a library component. + + This is a single LibraryHistoryEntry representing the moment the + component was first created. Returns None if the component + has no versions yet. + + Raises ContentLibraryBlockNotFound if the component does not exist. + """ + try: + component = get_component_from_usage_key(usage_key) + except ObjectDoesNotExist as exc: + raise ContentLibraryBlockNotFound(usage_key) from exc + + # TODO: replace with component.versioning.earliest once VersioningHelper exposes that helper. + first_version = ( + component.publishable_entity.versions + .order_by('version_num') + .select_related("created_by__profile") + .first() + ) + if first_version is None: + return None + + user = first_version.created_by + return LibraryHistoryEntry( + contributor=make_contributor(user, request), + changed_at=first_version.created, + title=first_version.title, + item_type=component.component_type.name, + action="created", + old_version=0, + new_version=first_version.version_num, + ) + + +def set_library_block_olx( + usage_key: LibraryUsageLocatorV2, + new_olx_str: str, + paths_to_media: dict | None = None, + # The following arg can be removed after https://github.com/openedx/openedx-core/pull/573 lands + # then we can presumably just get the name from the bulk_draft_changes_for context + created_by: int | None = None, +) -> ComponentVersion: """ Replace the OLX source of the given XBlock. @@ -199,9 +428,19 @@ def set_library_block_olx(usage_key: LibraryUsageLocatorV2, new_olx_str: str) -> very little validation is done and this can easily result in a broken XBlock that won't load. + The optional ``paths_to_media`` parameter can be used to attach + openedx_content Media to this XBlock. A common use case for this would be to + add images or other static assets to a text block:: + + figure_a_media = content_api.get_or_create_file_media(...) + paths_to_media={ + 'static/figure_a.png': figure_a_media, + } + Returns the version number of the newly created ComponentVersion. """ assert isinstance(usage_key, LibraryUsageLocatorV2) + paths_to_media = paths_to_media or {} # HTMLBlock uses CDATA to preserve HTML inside the XML, so make sure we # don't strip that out. @@ -235,44 +474,24 @@ def set_library_block_olx(usage_key: LibraryUsageLocatorV2, new_olx_str: str) -> del node.attrib["url_name"] new_olx_str = etree.tostring(node, encoding='unicode') - now = datetime.now(tz=timezone.utc) + now = datetime.now(tz=timezone.utc) # noqa: UP017 with transaction.atomic(): - new_content = authoring_api.get_or_create_text_content( + new_olx_media = content_api.get_or_create_text_media( component.learning_package_id, get_or_create_olx_media_type(usage_key.block_type).id, text=new_olx_str, created=now, ) - new_component_version = authoring_api.create_next_component_version( - component.pk, + new_component_version = content_api.create_next_component_version( + component.id, title=new_title, - content_to_replace={ - 'block.xml': new_content.pk, + media_to_replace={ + **paths_to_media, + 'block.xml': new_olx_media.pk, }, created=now, - ) - - # .. event_implemented_name: LIBRARY_BLOCK_UPDATED - # .. event_type: org.openedx.content_authoring.library_block.updated.v1 - LIBRARY_BLOCK_UPDATED.send_event( - library_block=LibraryBlockData( - library_key=usage_key.context_key, - usage_key=usage_key - ) - ) - - # For each container, trigger LIBRARY_CONTAINER_UPDATED signal and set background=True to trigger - # container indexing asynchronously. - affected_containers = get_containers_contains_item(usage_key) - for container in affected_containers: - # .. event_implemented_name: LIBRARY_CONTAINER_UPDATED - # .. event_type: org.openedx.content_authoring.content_library.container.updated.v1 - LIBRARY_CONTAINER_UPDATED.send_event( - library_container=LibraryContainerData( - container_key=container.container_key, - background=True, - ) + created_by=created_by, ) return new_component_version @@ -295,7 +514,7 @@ def validate_can_add_block_to_library( # If adding a component would take us over our max, return an error. assert content_library.learning_package_id is not None - component_count = authoring_api.get_all_drafts(content_library.learning_package_id).count() + component_count = content_api.get_all_drafts(content_library.learning_package_id).count() if component_count + 1 > settings.MAX_BLOCKS_PER_CONTENT_LIBRARY: raise BlockLimitReachedError( _("Library cannot have more than {} Components.").format( @@ -310,7 +529,8 @@ def validate_can_add_block_to_library( if block_class.has_children: raise IncompatibleTypesError( _( - 'The "{block_type}" XBlock (ID: "{block_id}") has children, so it not supported in content libraries.' + 'The "{block_type}" XBlock (ID: "{block_id}") has children,' + ' so it is not supported in content libraries.' ).format(block_type=block_type, block_id=block_id) ) # Make sure the new ID is not taken already: @@ -350,16 +570,6 @@ def create_library_block( _create_component_for_block(content_library, usage_key, user_id, can_stand_alone) # Now return the metadata about the new block: - - # .. event_implemented_name: LIBRARY_BLOCK_CREATED - # .. event_type: org.openedx.content_authoring.library_block.created.v1 - LIBRARY_BLOCK_CREATED.send_event( - library_block=LibraryBlockData( - library_key=content_library.library_key, - usage_key=usage_key - ) - ) - return get_library_block(usage_key) @@ -382,7 +592,7 @@ def _import_staged_block( library_key: LibraryLocatorV2, source_context_key: LearningContextKey, user, - staged_content_id: int, + staged_content_id: StagedContentID, staged_content_files: list[StagedContentFileData], now: datetime, ) -> LibraryXBlockMetadata: @@ -418,27 +628,23 @@ def _import_staged_block( with transaction.atomic(savepoint=False): # First create the Component, but do not initialize it to anything (i.e. # no ComponentVersion). - component_type = authoring_api.get_or_create_component_type( + component_type = content_api.get_or_create_component_type( "xblock.v1", usage_key.block_type ) - component = authoring_api.create_component( + component = content_api.create_component( # noqa: F841 learning_package.id, component_type=component_type, - local_key=usage_key.block_id, + component_code=usage_key.block_id, created=now, created_by=user.id, ) - # This will create the first component version and set the OLX/title - # appropriately. It will not publish. Once we get the newly created - # ComponentVersion back from this, we can attach all our files to it. - component_version = set_library_block_olx(usage_key, olx_str) - + paths_to_media = {} for staged_content_file_data in staged_content_files: # The ``data`` attribute is going to be None because the clipboard # is optimized to not do redundant file copying when copying/pasting # within the same course (where all the Files and Uploads are - # shared). Learning Core backed content Components will always store + # shared). openedx_content backed content Components will always store # a Component-local "copy" of the data, and rely on lower-level # deduplication to happen in the ``contents`` app. filename = staged_content_file_data.filename @@ -458,14 +664,14 @@ def _import_staged_block( # Courses don't support having assets that are local to a specific # component, and instead store all their content together in a # shared Files and Uploads namespace. If we're pasting that into a - # Learning Core backed data model (v2 Libraries), then we want to + # openedx_content backed data model (v2 Libraries), then we want to # prepend "static/" to the filename. This will need to get updated - # when we start moving courses over to Learning Core, or if we start + # when we start moving courses over to openedx_content, or if we start # storing course component assets in sub-directories of Files and # Uploads. # # The reason we don't just search for a "static/" prefix is that - # Learning Core components can store other kinds of files if they + # openedx_content components can store other kinds of files if they # wish (though none currently do). source_assumes_global_assets = not isinstance( source_context_key, LibraryLocatorV2 @@ -473,34 +679,25 @@ def _import_staged_block( if source_assumes_global_assets: filename = f"static/{filename}" - # Now construct the Learning Core data models for it... - # TODO: more of this logic should be pushed down to openedx-learning + # Now construct the Core data models for it... + # TODO: more of this logic should be pushed down to openedx_content media_type_str, _encoding = mimetypes.guess_type(filename) if not media_type_str: media_type_str = "application/octet-stream" - media_type = authoring_api.get_or_create_media_type(media_type_str) - content = authoring_api.get_or_create_file_content( + media_type = content_api.get_or_create_media_type(media_type_str) + media = content_api.get_or_create_file_media( learning_package.id, media_type.id, data=file_data, created=now, ) - authoring_api.create_component_version_content( - component_version.pk, - content.id, - key=filename, - ) + paths_to_media[filename] = media.id - # Emit library block created event - # .. event_implemented_name: LIBRARY_BLOCK_CREATED - # .. event_type: org.openedx.content_authoring.library_block.created.v1 - LIBRARY_BLOCK_CREATED.send_event( - library_block=LibraryBlockData( - library_key=content_library.library_key, - usage_key=usage_key - ) - ) + # This will create the first component version and set the OLX/title + # appropriately. It will not publish. Once we get the newly created + # ComponentVersion back from this, we can attach all our files to it. + set_library_block_olx(usage_key, olx_str, paths_to_media) # Now return the metadata about the new block return get_library_block(usage_key) @@ -517,7 +714,7 @@ def _import_staged_block_as_container( library_key: LibraryLocatorV2, source_context_key: LearningContextKey, user, - staged_content_id: int, + staged_content_id: StagedContentID, staged_content_files: list[StagedContentFileData], now: datetime, *, @@ -546,7 +743,7 @@ def _import_staged_block_as_container( container = create_container( library_key=library_key, - container_type=ContainerType.from_source_olx_tag(olx_node.tag), + container_cls=container_subclass_for_olx_tag(olx_node.tag), slug=None, # auto-generate slug from title title=title, user_id=user.id, @@ -654,7 +851,7 @@ def import_staged_content_from_user_clipboard(library_key: LibraryLocatorV2, use if olx_str is None: raise RuntimeError("olx_str missing") # Shouldn't happen - mostly here for type checker - now = datetime.now(tz=timezone.utc) + now = datetime.now(tz=timezone.utc) # noqa: UP017 if _is_container(user_clipboard.content.block_type): # This is a container and we can import it as such. @@ -681,15 +878,14 @@ def import_staged_content_from_user_clipboard(library_key: LibraryLocatorV2, use now, ) - def get_or_create_olx_media_type(block_type: str) -> MediaType: """ Get or create a MediaType for the block type. - Learning Core stores all Content with a Media Type (a.k.a. MIME type). For + openedx_content stores all Content with a Media Type (a.k.a. MIME type). For OLX, we use the "application/vnd.*" convention, per RFC 6838. """ - return authoring_api.get_or_create_media_type( + return content_api.get_or_create_media_type( f"application/vnd.openedx.xblock.v1.{block_type}+xml" ) @@ -701,52 +897,27 @@ def delete_library_block( """ Delete the specified block from this library (soft delete). """ - component = get_component_from_usage_key(usage_key) library_key = usage_key.context_key - affected_collections = authoring_api.get_entity_collections(component.learning_package_id, component.key) - affected_containers = get_containers_contains_item(usage_key) - - authoring_api.soft_delete_draft(component.pk, deleted_by=user_id) - # .. event_implemented_name: LIBRARY_BLOCK_DELETED - # .. event_type: org.openedx.content_authoring.library_block.deleted.v1 - LIBRARY_BLOCK_DELETED.send_event( - library_block=LibraryBlockData( - library_key=library_key, - usage_key=usage_key - ) - ) - - # For each collection, trigger LIBRARY_COLLECTION_UPDATED signal and set background=True to trigger - # collection indexing asynchronously. - # - # To delete the component on collections - for collection in affected_collections: - # .. event_implemented_name: LIBRARY_COLLECTION_UPDATED - # .. event_type: org.openedx.content_authoring.content_library.collection.updated.v1 - LIBRARY_COLLECTION_UPDATED.send_event( - library_collection=LibraryCollectionData( - collection_key=library_collection_locator( - library_key=library_key, - collection_key=collection.key, - ), - background=True, - ) + try: + component = get_component_from_usage_key(usage_key) + if component.versioning.draft is None: + raise Component.DoesNotExist("Component draft version was already deleted.") + except Component.DoesNotExist: + # There may be cases where entries are created in the + # search index, but the component is not created + # (an intermediate error occurred). + # In that case, we keep the index updated by removing the entry, + # but still raise the error so the caller knows the component did not exist. + + # .. event_implemented_name: LIBRARY_BLOCK_DELETED + # .. event_type: org.openedx.content_authoring.library_block.deleted.v1 + LIBRARY_BLOCK_DELETED.send_event( + library_block=LibraryBlockData(library_key=library_key, usage_key=usage_key) ) + raise - # For each container, trigger LIBRARY_CONTAINER_UPDATED signal and set background=True to trigger - # container indexing asynchronously. - # - # To update the components count in containers - for container in affected_containers: - # .. event_implemented_name: LIBRARY_CONTAINER_UPDATED - # .. event_type: org.openedx.content_authoring.content_library.container.updated.v1 - LIBRARY_CONTAINER_UPDATED.send_event( - library_container=LibraryContainerData( - container_key=container.container_key, - background=True, - ) - ) + content_api.soft_delete_draft(component.id, deleted_by=user_id) def restore_library_block(usage_key: LibraryUsageLocatorV2, user_id: int | None = None) -> None: @@ -754,67 +925,13 @@ def restore_library_block(usage_key: LibraryUsageLocatorV2, user_id: int | None Restore the specified library block. """ component = get_component_from_usage_key(usage_key) - library_key = usage_key.context_key - affected_collections = authoring_api.get_entity_collections(component.learning_package_id, component.key) - # Set draft version back to the latest available component version id. - authoring_api.set_draft_version( - component.pk, + content_api.set_draft_version( + component.id, component.versioning.latest.pk, set_by=user_id, ) - # .. event_implemented_name: LIBRARY_BLOCK_CREATED - # .. event_type: org.openedx.content_authoring.library_block.created.v1 - LIBRARY_BLOCK_CREATED.send_event( - library_block=LibraryBlockData( - library_key=library_key, - usage_key=usage_key - ) - ) - - # Add tags and collections back to index - # .. event_implemented_name: CONTENT_OBJECT_ASSOCIATIONS_CHANGED - # .. event_type: org.openedx.content_authoring.content.object.associations.changed.v1 - CONTENT_OBJECT_ASSOCIATIONS_CHANGED.send_event( - content_object=ContentObjectChangedData( - object_id=str(usage_key), - changes=["collections", "tags", "units"], - ), - ) - - # For each collection, trigger LIBRARY_COLLECTION_UPDATED signal and set background=True to trigger - # collection indexing asynchronously. - # - # To restore the component in the collections - for collection in affected_collections: - # .. event_implemented_name: LIBRARY_COLLECTION_UPDATED - # .. event_type: org.openedx.content_authoring.content_library.collection.updated.v1 - LIBRARY_COLLECTION_UPDATED.send_event( - library_collection=LibraryCollectionData( - collection_key=library_collection_locator( - library_key=library_key, - collection_key=collection.key, - ), - background=True, - ) - ) - - # For each container, trigger LIBRARY_CONTAINER_UPDATED signal and set background=True to trigger - # container indexing asynchronously. - # - # To update the components count in containers - affected_containers = get_containers_contains_item(usage_key) - for container in affected_containers: - # .. event_implemented_name: LIBRARY_CONTAINER_UPDATED - # .. event_type: org.openedx.content_authoring.content_library.container.updated.v1 - LIBRARY_CONTAINER_UPDATED.send_event( - library_container=LibraryContainerData( - container_key=container.container_key, - background=True, - ) - ) - def get_library_block_static_asset_files(usage_key: LibraryUsageLocatorV2) -> list[LibraryXBlockStaticFile]: """ @@ -832,30 +949,30 @@ def get_library_block_static_asset_files(usage_key: LibraryUsageLocatorV2) -> li if component_version is None: return [] - # cvc = the ComponentVersionContent through table - cvc_set = ( + # cvm = the ComponentVersionMedia through table + cvm_set = ( component_version - .componentversioncontent_set - .filter(content__has_file=True) - .order_by('key') - .select_related('content') + .componentversionmedia_set + .filter(media__has_file=True) + .order_by('path') + .select_related('media') ) site_root_url = get_xblock_app_config().get_site_root_url() return [ LibraryXBlockStaticFile( - path=cvc.key, - size=cvc.content.size, + path=cvm.path, + size=cvm.media.size, url=site_root_url + reverse( 'content_libraries:library-assets', kwargs={ 'component_version_uuid': component_version.uuid, - 'asset_path': cvc.key, + 'asset_path': cvm.path, } ), ) - for cvc in cvc_set + for cvm in cvm_set ] @@ -894,22 +1011,12 @@ def add_library_block_static_asset_file( component = get_component_from_usage_key(usage_key) with transaction.atomic(): - component_version = authoring_api.create_next_component_version( - component.pk, - content_to_replace={file_path: file_content}, - created=datetime.now(tz=timezone.utc), + component_version = content_api.create_next_component_version( + component.id, + media_to_replace={file_path: file_content}, + created=datetime.now(tz=timezone.utc), # noqa: UP017 created_by=user.id if user else None, ) - transaction.on_commit( - # .. event_implemented_name: LIBRARY_BLOCK_UPDATED - # .. event_type: org.openedx.content_authoring.library_block.updated.v1 - lambda: LIBRARY_BLOCK_UPDATED.send_event( - library_block=LibraryBlockData( - library_key=usage_key.context_key, - usage_key=usage_key, - ) - ) - ) # Now figure out the URL for the newly created asset... site_root_url = get_xblock_app_config().get_site_root_url() @@ -939,25 +1046,15 @@ def delete_library_block_static_asset_file(usage_key, file_path, user=None): delete_library_block_static_asset_file(video_block, "subtitles-en.srt") """ component = get_component_from_usage_key(usage_key) - now = datetime.now(tz=timezone.utc) + now = datetime.now(tz=timezone.utc) # noqa: UP017 with transaction.atomic(): - component_version = authoring_api.create_next_component_version( - component.pk, - content_to_replace={file_path: None}, + content_api.create_next_component_version( + component.id, + media_to_replace={file_path: None}, created=now, created_by=user.id if user else None, ) - transaction.on_commit( - # .. event_implemented_name: LIBRARY_BLOCK_UPDATED - # .. event_type: org.openedx.content_authoring.library_block.updated.v1 - lambda: LIBRARY_BLOCK_UPDATED.send_event( - library_block=LibraryBlockData( - library_key=usage_key.context_key, - usage_key=usage_key, - ) - ) - ) def publish_component_changes(usage_key: LibraryUsageLocatorV2, user_id: int): @@ -970,15 +1067,9 @@ def publish_component_changes(usage_key: LibraryUsageLocatorV2, user_id: int): learning_package = content_library.learning_package assert learning_package # The core publishing API is based on draft objects, so find the draft that corresponds to this component: - drafts_to_publish = authoring_api.get_all_drafts(learning_package.id).filter(entity__key=component.key) + drafts_to_publish = content_api.get_all_drafts(learning_package.id).filter(entity__entity_ref=component.entity_ref) # Publish the component and update anything that needs to be updated (e.g. search index): - publish_log = authoring_api.publish_from_drafts( - learning_package.id, draft_qset=drafts_to_publish, published_by=user_id, - ) - # Since this is a single component, it should be safe to process synchronously and in-process: - tasks.send_events_after_publish(publish_log.pk, str(library_key)) - # IF this is found to be a performance issue, we could instead make it async where necessary: - # tasks.wait_for_post_publish_events(publish_log, library_key=library_key) + content_api.publish_from_drafts(learning_package.id, draft_qset=drafts_to_publish, published_by=user_id) def _component_exists(usage_key: UsageKeyV2) -> bool: @@ -1018,35 +1109,33 @@ def _create_component_for_block( text data like X" goes in xblock.api. """ display_name = xblock_type_display_name(usage_key.block_type) - now = datetime.now(tz=timezone.utc) + now = datetime.now(tz=timezone.utc) # noqa: UP017 xml_text = f'<{usage_key.block_type} />' learning_package = content_lib.learning_package assert learning_package is not None # mostly for type checker with transaction.atomic(): - component_type = authoring_api.get_or_create_component_type( + component_type = content_api.get_or_create_component_type( "xblock.v1", usage_key.block_type ) - component, component_version = authoring_api.create_component_and_version( + block_olx_media = content_api.get_or_create_text_media( + learning_package.id, + get_or_create_olx_media_type(usage_key.block_type).id, + text=xml_text, + created=now, + ) + _component, component_version = content_api.create_component_and_version( learning_package.id, component_type=component_type, - local_key=usage_key.block_id, + component_code=usage_key.block_id, title=display_name, created=now, created_by=user_id, can_stand_alone=can_stand_alone, - ) - content = authoring_api.get_or_create_text_content( - learning_package.id, - get_or_create_olx_media_type(usage_key.block_type).id, - text=xml_text, - created=now, - ) - authoring_api.create_component_version_content( - component_version.pk, - content.id, - key="block.xml", + media={ + 'block.xml': block_olx_media + } ) return component_version diff --git a/openedx/core/djangoapps/content_libraries/api/collections.py b/openedx/core/djangoapps/content_libraries/api/collections.py index 3f8e33f4445e..f2b16edbfd6f 100644 --- a/openedx/core/djangoapps/content_libraries/api/collections.py +++ b/openedx/core/djangoapps/content_libraries/api/collections.py @@ -2,14 +2,11 @@ Python API for library collections ================================== """ -from django.db import IntegrityError from opaque_keys import OpaqueKey from opaque_keys.edx.keys import BlockTypeKey, UsageKeyV2 from opaque_keys.edx.locator import LibraryCollectionLocator, LibraryContainerLocator, LibraryLocatorV2 -from openedx_events.content_authoring.data import LibraryCollectionData -from openedx_events.content_authoring.signals import LIBRARY_COLLECTION_UPDATED -from openedx_learning.api import authoring as authoring_api -from openedx_learning.api.authoring_models import Collection, Component, PublishableEntity +from openedx_content import api as content_api +from openedx_content.models_api import Collection, Component, PublishableEntity from ..models import ContentLibrary from .exceptions import ( @@ -51,18 +48,18 @@ def create_library_collection( assert content_library.learning_package_id assert content_library.library_key == library_key - try: - collection = authoring_api.create_collection( - learning_package_id=content_library.learning_package_id, - key=collection_key, - title=title, - description=description, - created_by=created_by, - ) - except IntegrityError as err: - raise LibraryCollectionAlreadyExists from err - - return collection + if Collection.objects.filter( + learning_package_id=content_library.learning_package_id, + collection_code=collection_key, + ).exists(): + raise LibraryCollectionAlreadyExists(f"Collection {collection_key} already exists in {library_key}") + return content_api.create_collection( + learning_package_id=content_library.learning_package_id, + collection_code=collection_key, + title=title, + description=description, + created_by=created_by, + ) def update_library_collection( @@ -84,9 +81,9 @@ def update_library_collection( assert content_library.library_key == library_key try: - collection = authoring_api.update_collection( + collection = content_api.update_collection( learning_package_id=content_library.learning_package_id, - key=collection_key, + collection_code=collection_key, title=title, description=description, ) @@ -127,49 +124,47 @@ def update_library_collection_items( assert content_library.learning_package_id assert content_library.library_key == library_key - # Fetch the Component.key values for the provided UsageKeys. - item_keys = [] + # Fetch the Component.entity_ref values for the provided UsageKeys. + entity_ids: list[PublishableEntity.ID] = [] for opaque_key in opaque_keys: if isinstance(opaque_key, LibraryContainerLocator): try: - container = authoring_api.get_container_by_key( + container = content_api.get_container_by_code( content_library.learning_package_id, - key=opaque_key.container_id, + container_code=opaque_key.container_id, ) except Collection.DoesNotExist as exc: raise ContentLibraryContainerNotFound(opaque_key) from exc - item_keys.append(container.key) + entity_ids.append(container.id) elif isinstance(opaque_key, UsageKeyV2): # Parse the block_family from the key to use as namespace. block_type = BlockTypeKey.from_string(str(opaque_key)) try: - component = authoring_api.get_component_by_key( + component = content_api.get_component_by_code( content_library.learning_package_id, namespace=block_type.block_family, type_name=opaque_key.block_type, - local_key=opaque_key.block_id, + component_code=opaque_key.block_id, ) except Component.DoesNotExist as exc: raise ContentLibraryBlockNotFound(opaque_key) from exc - item_keys.append(component.key) + entity_ids.append(component.id) else: # This should never happen, but just in case. raise ValueError(f"Invalid opaque_key: {opaque_key}") - entities_qset = PublishableEntity.objects.filter( - key__in=item_keys, - ) + entities_qset = content_api.get_publishable_entities(content_library.learning_package_id).filter(id__in=entity_ids) if remove: - collection = authoring_api.remove_from_collection( + collection = content_api.remove_from_collection( content_library.learning_package_id, collection_key, entities_qset, ) else: - collection = authoring_api.add_to_collection( + collection = content_api.add_to_collection( content_library.learning_package_id, collection_key, entities_qset, @@ -181,7 +176,7 @@ def update_library_collection_items( def set_library_item_collections( library_key: LibraryLocatorV2, - entity_key: str, + entity_ref: str, *, collection_keys: list[str], created_by: int | None = None, @@ -207,37 +202,22 @@ def set_library_item_collections( assert content_library.learning_package_id assert content_library.library_key == library_key - publishable_entity = authoring_api.get_publishable_entity_by_key( + publishable_entity = content_api.get_publishable_entity_by_ref( content_library.learning_package_id, - key=entity_key, + entity_ref=entity_ref, ) - # Note: Component.key matches its PublishableEntity.key - collection_qs = authoring_api.get_collections(content_library.learning_package_id).filter( - key__in=collection_keys + # Note: Component.entity_ref matches its PublishableEntity.entity_ref + collection_qs = content_api.get_collections(content_library.learning_package_id).filter( + collection_code__in=collection_keys ) - affected_collections = authoring_api.set_collections( + content_api.set_collections( publishable_entity, collection_qs, created_by=created_by, ) - # For each collection, trigger LIBRARY_COLLECTION_UPDATED signal and set background=True to trigger - # collection indexing asynchronously. - for collection in affected_collections: - # .. event_implemented_name: LIBRARY_COLLECTION_UPDATED - # .. event_type: org.openedx.content_authoring.content_library.collection.updated.v1 - LIBRARY_COLLECTION_UPDATED.send_event( - library_collection=LibraryCollectionData( - collection_key=library_collection_locator( - library_key=library_key, - collection_key=collection.key, - ), - background=True, - ) - ) - return publishable_entity @@ -263,7 +243,7 @@ def get_library_collection_from_locator( content_library = ContentLibrary.objects.get_by_key(library_key) # type: ignore[attr-defined] assert content_library.learning_package_id is not None # shouldn't happen but it's technically possible. try: - return authoring_api.get_collection( + return content_api.get_collection( content_library.learning_package_id, collection_key, ) diff --git a/openedx/core/djangoapps/content_libraries/api/container_metadata.py b/openedx/core/djangoapps/content_libraries/api/container_metadata.py index 53726ca49d45..d7ad7e7f6ad4 100644 --- a/openedx/core/djangoapps/content_libraries/api/container_metadata.py +++ b/openedx/core/djangoapps/content_libraries/api/container_metadata.py @@ -1,105 +1,66 @@ """ Content libraries data classes related to Containers. """ + from __future__ import annotations -from dataclasses import dataclass, field as dataclass_field +from dataclasses import dataclass +from dataclasses import field as dataclass_field from enum import Enum -from django.db.models import QuerySet +from django.db.models import QuerySet from opaque_keys.edx.locator import LibraryContainerLocator, LibraryLocatorV2, LibraryUsageLocatorV2 -from openedx_learning.api import authoring as authoring_api -from openedx_learning.api.authoring_models import ( +from openedx_content import api as content_api +from openedx_content.models_api import ( Component, Container, - ContainerVersion, - Unit, - UnitVersion, - Subsection, - SubsectionVersion, - Section, - SectionVersion, PublishableEntity, + PublishableEntityMixin, + Section, + Subsection, + Unit, ) from openedx.core.djangoapps.content_tagging.api import get_object_tag_counts from openedx.core.djangoapps.xblock.api import get_component_from_usage_key from ..models import ContentLibrary -from .exceptions import ContentLibraryContainerNotFound +from .exceptions import ContentLibraryBlockNotFound, ContentLibraryContainerNotFound from .libraries import PublishableItem, library_component_usage_key # The public API is only the following symbols: __all__ = [ # Models "ContainerMetadata", - "ContainerType", # Methods + "container_subclass_for_olx_tag", "library_container_locator", ] +# For now, we only allow the following types of containers in content libraries, and their hierarchy is hard-coded. +LIBRARY_ALLOWED_CONTAINER_TYPES = [ + Unit.type_code, + Subsection.type_code, + Section.type_code, +] -class ContainerType(Enum): - """ - The container types supported by content_libraries, and logic to map them to OLX. - """ - Unit = "unit" - Subsection = "subsection" - Section = "section" - - @property - def container_model_classes(self) -> tuple[type[Container], type[ContainerVersion]]: - """ - Get the container, containerversion subclasses associated with this type. - @@TODO Is this what we want, a hard mapping between container_types and Container classes? - * If so, then expand on this pattern, so that all ContainerType logic is contained within - this class, and get rid of the match-case statements that are all over the content_libraries - app. - * If not, then figure out what to do instead. - """ - match self: - case self.Unit: - return (Unit, UnitVersion) - case self.Subsection: - return (Subsection, SubsectionVersion) - case self.Section: - return (Section, SectionVersion) - raise TypeError(f"unexpected ContainerType: {self!r}") - - @property - def olx_tag(self) -> str: - """ - Canonical XML tag to use when representing this container as OLX. - - For example, Units are encoded as .... - These tag names are historical. We keep them around for the backwards compatibility of OLX - and for easier interaction with legacy modulestore-powered structural XBlocks - (e.g., copy-paste of Units between courses and V2 libraries). - """ - match self: - case self.Unit: - return "vertical" - case self.Subsection: - return "sequential" - case self.Section: - return "chapter" - raise TypeError(f"unexpected ContainerType: {self!r}") +def container_subclass_for_olx_tag(olx_tag: str) -> content_api.ContainerSubclass: + """ + Given an OLX tag code (e.g. `"vertical"` for ``), get the + corresponding `Container` subclass, e.g. `Unit`. - @classmethod - def from_source_olx_tag(cls, olx_tag: str) -> 'ContainerType': - """ - Get the ContainerType that this OLX tag maps to. - """ - if olx_tag == "unit": - # There is an alternative implementation to VerticalBlock called UnitBlock whose - # OLX tag is . When converting from OLX, we want to handle both - # and as Unit containers, although the canonical serialization is still . - return cls.Unit - try: - return next(ct for ct in cls if olx_tag == ct.olx_tag) - except StopIteration: - raise ValueError(f"no container_type for XML tag: <{olx_tag}>") from None + This method is specific to content libraries. + """ + try: + subclass = next(ct for ct in content_api.get_all_container_subclasses() if olx_tag == ct.olx_tag_name) + except StopIteration: + raise ValueError(f"Content libraries does not support containers with XML tag: <{olx_tag}>") from None + if subclass.type_code not in LIBRARY_ALLOWED_CONTAINER_TYPES: + raise ValueError( + f'Content libraries does not support "{subclass.type_code}" containers (with XML tag <{olx_tag}>)' + ) from None + return subclass @dataclass(frozen=True, kw_only=True) @@ -107,21 +68,26 @@ class ContainerMetadata(PublishableItem): """ Class that represents the metadata about a Container (e.g. Unit) in a content library. """ + container_key: LibraryContainerLocator - container_type: ContainerType - container_pk: int + container_type_code: str + container_id: Container.ID @classmethod - def from_container(cls, library_key, container: Container, associated_collections=None): + def from_container(cls, library_key, container: Container, associated_collections=None, use_published=False): """ Construct a ContainerMetadata object from a Container object. + + Requires that the draft version of the container exists, unless you + specify use_published=True, in which case it requires that the published + version exists. The 'display_name' and 'modified' fields will depend on + which version you request. """ last_publish_log = container.versioning.last_publish_log container_key = library_container_locator( library_key, container=container, ) - container_type = ContainerType(container_key.container_type) published_by = None if last_publish_log and last_publish_log.published_by: published_by = last_publish_log.published_by.username @@ -137,19 +103,19 @@ def from_container(cls, library_key, container: Container, associated_collection return cls( container_key=container_key, - container_type=container_type, - container_pk=container.pk, - display_name=draft.title, + container_type_code=container_key.container_type, + container_id=container.id, + display_name=published.title if use_published else draft.title, created=container.created, - modified=draft.created, - draft_version_num=draft.version_num, + modified=published.created if use_published else draft.created, + draft_version_num=draft.version_num if draft else None, published_version_num=published.version_num if published else None, published_display_name=published.title if published else None, last_published=None if last_publish_log is None else last_publish_log.published_at, published_by=published_by, last_draft_created=last_draft_created, last_draft_created_by=last_draft_created_by, - has_unpublished_changes=authoring_api.contains_unpublished_changes(container.pk), + has_unpublished_changes=content_api.contains_unpublished_changes(container.id), tags_count=tags.get(str(container_key), 0), collections=associated_collections or [], ) @@ -164,6 +130,7 @@ class ContainerHierarchy: database queries in the future. More details being discussed in https://github.com/openedx/edx-platform/pull/36813#issuecomment-3136631767 """ + sections: list[ContainerHierarchyMember] = dataclass_field(default_factory=list) subsections: list[ContainerHierarchyMember] = dataclass_field(default_factory=list) units: list[ContainerHierarchyMember] = dataclass_field(default_factory=list) @@ -174,6 +141,7 @@ class Level(Enum): """ Enumeratable levels contained by the ContainerHierarchy. """ + none = 0 components = 1 units = 2 @@ -295,10 +263,12 @@ def _get_containers_with_entities( """ qs = Container.objects.none() for member in members: - qs = qs.union(authoring_api.get_containers_with_entity( - member.entity.pk, - ignore_pinned=ignore_pinned, - )) + qs = qs.union( + content_api.get_containers_with_entity( + member.entity.id, + ignore_pinned=ignore_pinned, + ) + ) return qs @@ -320,7 +290,7 @@ def _get_containers_children( for member in members: container = member.container assert container - for entry in authoring_api.get_entities_in_container( + for entry in content_api.get_entities_in_container( container, published=published, ): @@ -338,6 +308,7 @@ class ContainerHierarchyMember: """ Represents an individual member of ContainerHierarchy which is ready to be serialized. """ + id: LibraryContainerLocator | LibraryUsageLocatorV2 display_name: str has_unpublished_changes: bool @@ -372,7 +343,7 @@ def create( container=entity, ), display_name=entity.versioning.draft.title, - has_unpublished_changes=authoring_api.contains_unpublished_changes(entity.pk), + has_unpublished_changes=content_api.contains_unpublished_changes(entity.id), container=entity, component=None, ) @@ -396,22 +367,11 @@ def library_container_locator( """ Returns a LibraryContainerLocator for the given library + container. """ - container_type = None - if hasattr(container, 'unit'): - container_type = ContainerType.Unit - elif hasattr(container, 'subsection'): - container_type = ContainerType.Subsection - elif hasattr(container, 'section'): - container_type = ContainerType.Section - else: - # This should never happen, but we assert to ensure that we handle all cases. - # If this fails, it means that a new Container type was added without updating this code. - raise ValueError(f"Unexpected container type: {container!r}") - + container_type_code = content_api.get_container_type_code_of(container) + if container_type_code not in LIBRARY_ALLOWED_CONTAINER_TYPES: + raise ValueError(f"Unsupported container type for content libraries: {container!r}") return LibraryContainerLocator( - library_key, - container_type=container_type.value, - container_id=container.publishable_entity.key, + library_key, container_type=container_type_code, container_id=container.container_code, ) @@ -425,13 +385,27 @@ def get_container_from_key(container_key: LibraryContainerLocator, include_delet content_library = ContentLibrary.objects.get_by_key(container_key.lib_key) learning_package = content_library.learning_package assert learning_package is not None - container = authoring_api.get_container_by_key( - learning_package.id, - key=container_key.container_id, - ) + container = content_api.get_container_by_code(learning_package.id, container_code=container_key.container_id) + assert content_api.get_container_type_code_of(container) in LIBRARY_ALLOWED_CONTAINER_TYPES # We only return the container if it exists and either: # 1. the container has a draft version (which means it is not soft-deleted) OR # 2. the container was soft-deleted but the `include_deleted` flag is set to True if container and (include_deleted or container.versioning.draft): return container raise ContentLibraryContainerNotFound + + +def get_entity_from_key( + key: LibraryContainerLocator | LibraryUsageLocatorV2, /, *, include_deleted=False +) -> PublishableEntityMixin: + """ + Given a key for an item in a library, load it as a `Component` or a `Container` subclass. + """ + if isinstance(key, LibraryContainerLocator): + return get_container_from_key(key, include_deleted=False) + else: + assert isinstance(key, LibraryUsageLocatorV2) + component = get_component_from_usage_key(key) + if not include_deleted and not component.versioning.draft: + raise ContentLibraryBlockNotFound("Component has been deleted.") + return component diff --git a/openedx/core/djangoapps/content_libraries/api/containers.py b/openedx/core/djangoapps/content_libraries/api/containers.py index 5cca0b3a994b..8952576cb163 100644 --- a/openedx/core/djangoapps/content_libraries/api/containers.py +++ b/openedx/core/djangoapps/content_libraries/api/containers.py @@ -1,46 +1,48 @@ """ API for containers (Sections, Subsections, Units) in Content Libraries """ + from __future__ import annotations -from datetime import datetime, timezone import logging -from uuid import uuid4 +import operator import typing +from dataclasses import dataclass +from datetime import datetime, timezone +from functools import cache +from uuid import UUID, uuid4 +from django.core.exceptions import ObjectDoesNotExist +from django.db.models import F from django.utils.text import slugify from opaque_keys.edx.locator import LibraryContainerLocator, LibraryLocatorV2, LibraryUsageLocatorV2 -from openedx_events.content_authoring.data import ( - ContentObjectChangedData, - LibraryCollectionData, - LibraryContainerData, -) -from openedx_events.content_authoring.signals import ( - CONTENT_OBJECT_ASSOCIATIONS_CHANGED, - LIBRARY_COLLECTION_UPDATED, - LIBRARY_CONTAINER_CREATED, - LIBRARY_CONTAINER_DELETED, - LIBRARY_CONTAINER_UPDATED, -) -from openedx_learning.api import authoring as authoring_api -from openedx_learning.api.authoring_models import Container, ContainerVersion, Component -from openedx.core.djangoapps.content_libraries.api.collections import library_collection_locator +from openedx_content import api as content_api +from openedx_content.models_api import Container, PublishLogRecord +from openedx_events.content_authoring.data import LibraryContainerData +from openedx_events.content_authoring.signals import LIBRARY_CONTAINER_DELETED -from openedx.core.djangoapps.xblock.api import get_component_from_usage_key - -from .. import tasks from ..models import ContentLibrary -from .block_metadata import LibraryXBlockMetadata +from .block_metadata import ( + LibraryHistoryContributor, + LibraryHistoryEntry, + LibraryPublishHistoryGroup, + LibraryXBlockMetadata, + direct_published_entity_from_record, + get_entity_item_type, + library_component_usage_key, + make_contributor, + resolve_change_action, +) from .container_metadata import ( + LIBRARY_ALLOWED_CONTAINER_TYPES, ContainerHierarchy, ContainerMetadata, - ContainerType, - library_container_locator, get_container_from_key, + get_entity_from_key, + library_container_locator, ) from .serializers import ContainerSerializer - if typing.TYPE_CHECKING: from openedx.core.djangoapps.content_staging.api import UserClipboardData @@ -48,9 +50,11 @@ # 🛑 UNSTABLE: All APIs related to containers are unstable until we've figured # out our approach to dynamic content (randomized, A/B tests, etc.) __all__ = [ + "ContainerChildMetadata", "get_container", "create_container", "get_container_children", + "get_container_children_list", "get_container_children_count", "update_container", "delete_container", @@ -61,11 +65,24 @@ "get_library_object_hierarchy", "copy_container", "library_container_locator", + "get_library_container_draft_history", + "get_library_container_publish_history", + "get_library_container_publish_history_entries", + "get_library_container_creation_entry", ] log = logging.getLogger(__name__) +@dataclass(frozen=True) +class ContainerChildMetadata: + """ + Class that represents limited metadata about a child entity of a container + """ + display_name: str + key: LibraryUsageLocatorV2 | LibraryContainerLocator + + def get_container( container_key: LibraryContainerLocator, *, @@ -76,10 +93,13 @@ def get_container( """ container = get_container_from_key(container_key) if include_collections: - associated_collections = authoring_api.get_entity_collections( + # Temporarily alias collection_code to "key" so downstream consumers + # (search indexer, REST API) keep the same field name. We will update + # downstream consumers later: https://github.com/openedx/openedx-platform/issues/38406 + associated_collections = content_api.get_entity_collections( container.publishable_entity.learning_package_id, container_key.container_id, - ).values('key', 'title') + ).values("title", key=F("collection_code")) else: associated_collections = None container_meta = ContainerMetadata.from_container( @@ -87,13 +107,13 @@ def get_container( container, associated_collections=associated_collections, ) - assert container_meta.container_type.value == container_key.container_type + assert container_meta.container_type_code == container_key.container_type return container_meta def create_container( library_key: LibraryLocatorV2, - container_type: ContainerType, + container_cls: content_api.ContainerSubclass, slug: str | None, title: str, user_id: int | None, @@ -104,60 +124,32 @@ def create_container( It will initially be empty. """ + assert container_cls.type_code in LIBRARY_ALLOWED_CONTAINER_TYPES assert isinstance(library_key, LibraryLocatorV2) content_library = ContentLibrary.objects.get_by_key(library_key) assert content_library.learning_package_id # Should never happen but we made this a nullable field so need to check if slug is None: # Automatically generate a slug. Append a random suffix so it should be unique. - slug = slugify(title, allow_unicode=True) + '-' + uuid4().hex[-6:] + slug = slugify(title, allow_unicode=True) + "-" + uuid4().hex[-6:] # Make sure the slug is valid by first creating a key for the new container: - container_key = LibraryContainerLocator( + _container_key = LibraryContainerLocator( library_key, - container_type=container_type.value, + container_type=container_cls.type_code, container_id=slug, ) if not created: - created = datetime.now(tz=timezone.utc) - - container: Container - _initial_version: ContainerVersion + created = datetime.now(tz=timezone.utc) # noqa: UP017 # Then try creating the actual container: - match container_type: - case ContainerType.Unit: - container, _initial_version = authoring_api.create_unit_and_version( - content_library.learning_package_id, - key=slug, - title=title, - created=created, - created_by=user_id, - ) - case ContainerType.Subsection: - container, _initial_version = authoring_api.create_subsection_and_version( - content_library.learning_package_id, - key=slug, - title=title, - created=created, - created_by=user_id, - ) - case ContainerType.Section: - container, _initial_version = authoring_api.create_section_and_version( - content_library.learning_package_id, - key=slug, - title=title, - created=created, - created_by=user_id, - ) - case _: - raise NotImplementedError(f"Library does not support {container_type} yet") - - # .. event_implemented_name: LIBRARY_CONTAINER_CREATED - # .. event_type: org.openedx.content_authoring.content_library.container.created.v1 - LIBRARY_CONTAINER_CREATED.send_event( - library_container=LibraryContainerData( - container_key=container_key, - ) + container, _initial_version = content_api.create_container_and_version( + content_library.learning_package_id, + container_code=slug, + title=title, + container_cls=container_cls, + entities=[], + created=created, + created_by=user_id, ) return ContainerMetadata.from_container(library_key, container) @@ -173,83 +165,15 @@ def update_container( """ container = get_container_from_key(container_key) library_key = container_key.lib_key - created = datetime.now(tz=timezone.utc) - - container_type = ContainerType(container_key.container_type) - - version: ContainerVersion - affected_containers: list[ContainerMetadata] = [] - # Get children containers or components to update their index data - children = get_container_children( - container_key, - published=False, - ) - child_key_name = 'container_key' - - match container_type: - case ContainerType.Unit: - version = authoring_api.create_next_unit_version( - container.unit, - title=display_name, - created=created, - created_by=user_id, - ) - affected_containers = get_containers_contains_item(container_key) - # Components have usage_key instead of container_key - child_key_name = 'usage_key' - case ContainerType.Subsection: - version = authoring_api.create_next_subsection_version( - container.subsection, - title=display_name, - created=created, - created_by=user_id, - ) - affected_containers = get_containers_contains_item(container_key) - case ContainerType.Section: - version = authoring_api.create_next_section_version( - container.section, - title=display_name, - created=created, - created_by=user_id, - ) + created = datetime.now(tz=timezone.utc) # noqa: UP017 - # The `affected_containers` are not obtained, because the sections are - # not contained in any container. - case _: - raise NotImplementedError(f"Library does not support {container_type} yet") - - # Send event related to the updated container - # .. event_implemented_name: LIBRARY_CONTAINER_UPDATED - # .. event_type: org.openedx.content_authoring.content_library.container.updated.v1 - LIBRARY_CONTAINER_UPDATED.send_event( - library_container=LibraryContainerData( - container_key=container_key, - ) + version = content_api.create_next_container_version( + container, + title=display_name, + created=created, + created_by=user_id, ) - # Send events related to the containers that contains the updated container. - # This is to update the children display names used in the section/subsection previews. - for affected_container in affected_containers: - # .. event_implemented_name: LIBRARY_CONTAINER_UPDATED - # .. event_type: org.openedx.content_authoring.content_library.container.updated.v1 - LIBRARY_CONTAINER_UPDATED.send_event( - library_container=LibraryContainerData( - container_key=affected_container.container_key, - ) - ) - # Update children components and containers index data, for example, - # All subsections under a section have section key in index that needs to be updated. - # So if parent section name has been changed, it needs to be reflected in sections key of children - for child in children: - # .. event_implemented_name: CONTENT_OBJECT_ASSOCIATIONS_CHANGED - # .. event_type: org.openedx.content_authoring.content.object.associations.changed.v1 - CONTENT_OBJECT_ASSOCIATIONS_CHANGED.send_event( - content_object=ContentObjectChangedData( - object_id=str(getattr(child, child_key_name)), - changes=[container_key.container_type + "s"], - ), - ) - return ContainerMetadata.from_container(library_key, version.container) @@ -261,159 +185,28 @@ def delete_container( No-op if container doesn't exist or has already been soft-deleted. """ - library_key = container_key.lib_key - container = get_container_from_key(container_key) - - # Fetch related collections and containers before soft-delete - affected_collections = authoring_api.get_entity_collections( - container.publishable_entity.learning_package_id, - container.key, - ) - affected_containers = get_containers_contains_item(container_key) - # Get children containers or components to update their index data - children = get_container_children( - container_key, - published=False, - ) - authoring_api.soft_delete_draft(container.pk) - - # .. event_implemented_name: LIBRARY_CONTAINER_DELETED - # .. event_type: org.openedx.content_authoring.content_library.container.deleted.v1 - LIBRARY_CONTAINER_DELETED.send_event( - library_container=LibraryContainerData( - container_key=container_key, - ) - ) - - # For each collection, trigger LIBRARY_COLLECTION_UPDATED signal and set background=True to trigger - # collection indexing asynchronously. - # - # To delete the container on collections - for collection in affected_collections: - # .. event_implemented_name: LIBRARY_COLLECTION_UPDATED - # .. event_type: org.openedx.content_authoring.content_library.collection.updated.v1 - LIBRARY_COLLECTION_UPDATED.send_event( - library_collection=LibraryCollectionData( - collection_key=library_collection_locator( - library_key=library_key, - collection_key=collection.key, - ), - background=True, - ) - ) - # Send events related to the containers that contains the updated container. - # This is to update the children display names used in the section/subsection previews. - for affected_container in affected_containers: - # .. event_implemented_name: LIBRARY_CONTAINER_UPDATED - # .. event_type: org.openedx.content_authoring.content_library.container.updated.v1 - LIBRARY_CONTAINER_UPDATED.send_event( - library_container=LibraryContainerData( - container_key=affected_container.container_key, - ) - ) - container_type = ContainerType(container_key.container_type) - key_name = 'container_key' - if container_type == ContainerType.Unit: - # Components have usage_key instead of container_key - key_name = 'usage_key' - # Update children components and containers index data, for example, - # All subsections under a section have section key in index that needs to be updated. - # So if parent section is deleted, it needs to be removed from sections key of children - for child in children: - # .. event_implemented_name: CONTENT_OBJECT_ASSOCIATIONS_CHANGED - # .. event_type: org.openedx.content_authoring.content.object.associations.changed.v1 - CONTENT_OBJECT_ASSOCIATIONS_CHANGED.send_event( - content_object=ContentObjectChangedData( - object_id=str(getattr(child, key_name)), - changes=[container_key.container_type + "s"], - ), - ) + try: + container = get_container_from_key(container_key) + except Container.DoesNotExist: + # There may be cases where entries are created in the + # search index, but the container is not created + # (an intermediate error occurred). + # In that case, we keep the index updated by removing the entry, + # but still raise the error so the caller knows the container did not exist. + # .. event_implemented_name: LIBRARY_CONTAINER_DELETED + # .. event_type: org.openedx.content_authoring.content_library.container.deleted.v1 + LIBRARY_CONTAINER_DELETED.send_event(library_container=LibraryContainerData(container_key=container_key)) + raise + + content_api.soft_delete_draft(container.id) def restore_container(container_key: LibraryContainerLocator) -> None: """ [ 🛑 UNSTABLE ] Restore the specified library container. """ - library_key = container_key.lib_key container = get_container_from_key(container_key, include_deleted=True) - - affected_collections = authoring_api.get_entity_collections( - container.publishable_entity.learning_package_id, - container.key, - ) - - authoring_api.set_draft_version(container.pk, container.versioning.latest.pk) - # Fetch related containers after restore - affected_containers = get_containers_contains_item(container_key) - # Get children containers or components to update their index data - children = get_container_children( - container_key, - published=False, - ) - - # .. event_implemented_name: LIBRARY_CONTAINER_CREATED - # .. event_type: org.openedx.content_authoring.content_library.container.created.v1 - LIBRARY_CONTAINER_CREATED.send_event( - library_container=LibraryContainerData( - container_key=container_key, - ) - ) - - content_changes = ["collections", "tags"] - if affected_containers and len(affected_containers) > 0: - # Update parent key data in index. Eg. `sections` key in index for subsection - content_changes.append(str(affected_containers[0].container_type.value) + "s") - # Add tags, collections and parent data back to index - # .. event_implemented_name: CONTENT_OBJECT_ASSOCIATIONS_CHANGED - # .. event_type: org.openedx.content_authoring.content.object.associations.changed.v1 - CONTENT_OBJECT_ASSOCIATIONS_CHANGED.send_event( - content_object=ContentObjectChangedData( - object_id=str(container_key), - changes=content_changes, - ), - ) - - # For each collection, trigger LIBRARY_COLLECTION_UPDATED signal and set background=True to trigger - # collection indexing asynchronously. - # - # To restore the container on collections - for collection in affected_collections: - # .. event_implemented_name: LIBRARY_COLLECTION_UPDATED - # .. event_type: org.openedx.content_authoring.content_library.collection.updated.v1 - LIBRARY_COLLECTION_UPDATED.send_event( - library_collection=LibraryCollectionData( - collection_key=library_collection_locator( - library_key=library_key, - collection_key=collection.key, - ), - ) - ) - # Send events related to the containers that contains the updated container. - # This is to update the children display names used in the section/subsection previews. - for affected_container in affected_containers: - # .. event_implemented_name: LIBRARY_CONTAINER_UPDATED - # .. event_type: org.openedx.content_authoring.content_library.container.updated.v1 - LIBRARY_CONTAINER_UPDATED.send_event( - library_container=LibraryContainerData( - container_key=affected_container.container_key, - ) - ) - container_type = ContainerType(container_key.container_type) - key_name = 'container_key' - if container_type == ContainerType.Unit: - key_name = 'usage_key' - # Update children components and containers index data, for example, - # All subsections under a section have section key in index that needs to be updated. - # Should restore removed parent section in sections key of children subsections - for child in children: - # .. event_implemented_name: CONTENT_OBJECT_ASSOCIATIONS_CHANGED - # .. event_type: org.openedx.content_authoring.content.object.associations.changed.v1 - CONTENT_OBJECT_ASSOCIATIONS_CHANGED.send_event( - content_object=ContentObjectChangedData( - object_id=str(getattr(child, key_name)), - changes=[container_key.container_type + "s"], - ), - ) + content_api.set_draft_version(container.id, container.versioning.latest.pk) def get_container_children( @@ -422,37 +215,50 @@ def get_container_children( published=False, ) -> list[LibraryXBlockMetadata | ContainerMetadata]: """ - [ 🛑 UNSTABLE ] Get the entities contained in the given container - (e.g. the components/xblocks in a unit, units in a subsection, subsections in a section) + [ 🛑 UNSTABLE ] Get the entities contained in the given container (e.g. the + components in a unit, units in a subsection, subsections in a section). + """ + container = get_container_from_key(container_key) + + child_entities = content_api.get_entities_in_container(container, published=published) + result: list[LibraryXBlockMetadata | ContainerMetadata] = [] + for entry in child_entities: + if hasattr(entry.entity, "component"): # the child is a Component + result.append(LibraryXBlockMetadata.from_component( + container_key.lib_key, entry.entity.component, use_published=published, + )) + else: + assert isinstance(entry.entity.container, Container) + result.append(ContainerMetadata.from_container( + container_key.lib_key, entry.entity.container, use_published=published, + )) + return result + + +def get_container_children_list( + container_key: LibraryContainerLocator, *, + published: bool, +) -> list[ContainerChildMetadata]: + """ + [ 🛑 UNSTABLE ] Get the entities contained in the given container (e.g. the + components/xblocks in a unit, units in a subsection, subsections in a section) + + Returns a list of ``ContainerChildMetadata`` objects (which give only each + child's display name and opaque key, though the opaque key also includes + information on what "type" of component/container it is). """ container = get_container_from_key(container_key) - container_type = ContainerType(container_key.container_type) - - match container_type: - case ContainerType.Unit: - child_components = authoring_api.get_components_in_unit(container.unit, published=published) - return [LibraryXBlockMetadata.from_component( - container_key.lib_key, - entry.component - ) for entry in child_components] - case ContainerType.Subsection: - child_units = authoring_api.get_units_in_subsection(container.subsection, published=published) - return [ContainerMetadata.from_container( - container_key.lib_key, - entry.unit - ) for entry in child_units] - case ContainerType.Section: - child_subsections = authoring_api.get_subsections_in_section(container.section, published=published) - return [ContainerMetadata.from_container( - container_key.lib_key, - entry.subsection, - ) for entry in child_subsections] - case _: - child_entities = authoring_api.get_entities_in_container(container, published=published) - return [ContainerMetadata.from_container( - container_key.lib_key, - entry.entity - ) for entry in child_entities] + result: list[ContainerChildMetadata] = [] + for entry in content_api.get_entities_in_container(container, published=published): + key: LibraryUsageLocatorV2 | LibraryContainerLocator + if hasattr(entry.entity, "component"): # the child is a Component + key = library_component_usage_key(container_key.lib_key, entry.entity.component) + else: + assert isinstance(entry.entity.container, Container) + key = library_container_locator(container_key.lib_key, entry.entity.container) + display_name = entry.entity_version.title + result.append(ContainerChildMetadata(display_name=display_name, key=key)) + return result def get_container_children_count( @@ -463,122 +269,44 @@ def get_container_children_count( [ 🛑 UNSTABLE ] Get the count of entities contained in the given container (e.g. the components/xblocks in a unit) """ container = get_container_from_key(container_key) - return authoring_api.get_container_children_count(container, published=published) + return content_api.get_container_children_count(container, published=published) def update_container_children( container_key: LibraryContainerLocator, - children_ids: list[LibraryUsageLocatorV2] | list[LibraryContainerLocator], + children_keys: list[LibraryUsageLocatorV2] | list[LibraryContainerLocator], user_id: int | None, - entities_action: authoring_api.ChildrenEntitiesAction = authoring_api.ChildrenEntitiesAction.REPLACE, + entities_action: content_api.ChildrenEntitiesAction = content_api.ChildrenEntitiesAction.REPLACE, ): """ [ 🛑 UNSTABLE ] Adds children components or containers to given container. """ - library_key = container_key.lib_key - container_type = ContainerType(container_key.container_type) container = get_container_from_key(container_key) - created = datetime.now(tz=timezone.utc) - new_version: ContainerVersion - match container_type: - case ContainerType.Unit: - components = [get_component_from_usage_key(key) for key in children_ids] # type: ignore[arg-type] - new_version = authoring_api.create_next_unit_version( - container.unit, - components=components, # type: ignore[arg-type] - created=created, - created_by=user_id, - entities_action=entities_action, - ) - - for key in children_ids: - # .. event_implemented_name: CONTENT_OBJECT_ASSOCIATIONS_CHANGED - # .. event_type: org.openedx.content_authoring.content.object.associations.changed.v1 - CONTENT_OBJECT_ASSOCIATIONS_CHANGED.send_event( - content_object=ContentObjectChangedData( - object_id=str(key), - changes=["units"], - ), - ) - case ContainerType.Subsection: - units = [get_container_from_key(key).unit for key in children_ids] # type: ignore[arg-type] - new_version = authoring_api.create_next_subsection_version( - container.subsection, - units=units, # type: ignore[arg-type] - created=created, - created_by=user_id, - entities_action=entities_action, - ) - - for key in children_ids: - # .. event_implemented_name: CONTENT_OBJECT_ASSOCIATIONS_CHANGED - # .. event_type: org.openedx.content_authoring.content.object.associations.changed.v1 - CONTENT_OBJECT_ASSOCIATIONS_CHANGED.send_event( - content_object=ContentObjectChangedData( - object_id=str(key), - changes=["subsections"], - ), - ) - case ContainerType.Section: - subsections = [get_container_from_key(key).subsection for key in children_ids] # type: ignore[arg-type] - new_version = authoring_api.create_next_section_version( - container.section, - subsections=subsections, # type: ignore[arg-type] - created=created, - created_by=user_id, - entities_action=entities_action, - ) + created = datetime.now(tz=timezone.utc) # noqa: UP017 - for key in children_ids: - # .. event_implemented_name: CONTENT_OBJECT_ASSOCIATIONS_CHANGED - # .. event_type: org.openedx.content_authoring.content.object.associations.changed.v1 - CONTENT_OBJECT_ASSOCIATIONS_CHANGED.send_event( - content_object=ContentObjectChangedData( - object_id=str(key), - changes=["sections"], - ), - ) - case _: - raise ValueError(f"Invalid container type: {container_type}") - - # .. event_implemented_name: LIBRARY_CONTAINER_UPDATED - # .. event_type: org.openedx.content_authoring.content_library.container.updated.v1 - LIBRARY_CONTAINER_UPDATED.send_event( - library_container=LibraryContainerData( - container_key=container_key, - ) + new_version = content_api.create_next_container_version( + container, + created=created, + created_by=user_id, + entities=[get_entity_from_key(key) for key in children_keys], + entities_action=entities_action, ) - return ContainerMetadata.from_container(library_key, new_version.container) + return ContainerMetadata.from_container(container_key.lib_key, new_version.container) -def get_containers_contains_item( - key: LibraryUsageLocatorV2 | LibraryContainerLocator -) -> list[ContainerMetadata]: +def get_containers_contains_item(key: LibraryUsageLocatorV2 | LibraryContainerLocator) -> list[ContainerMetadata]: """ - [ 🛑 UNSTABLE ] Get containers that contains the item, that can be a component or another container. + [ 🛑 UNSTABLE ] Get list of draft containers that contain the item. Item can be a component or another container. """ - item: Component | Container - - if isinstance(key, LibraryUsageLocatorV2): - item = get_component_from_usage_key(key) - - elif isinstance(key, LibraryContainerLocator): - item = get_container_from_key(key) - - containers = authoring_api.get_containers_with_entity( - item.publishable_entity.pk, - ) - return [ - ContainerMetadata.from_container(key.lib_key, container) - for container in containers - ] + entity = get_entity_from_key(key) + containers = content_api.get_containers_with_entity(entity.id).select_related("container_type") + return [ContainerMetadata.from_container(key.lib_key, container) for container in containers] def publish_container_changes( container_key: LibraryContainerLocator, user_id: int | None, - call_post_publish_events_sync=False, ) -> None: """ [ 🛑 UNSTABLE ] Publish all unpublished changes in a container and all its child @@ -590,19 +318,9 @@ def publish_container_changes( learning_package = content_library.learning_package assert learning_package # The core publishing API is based on draft objects, so find the draft that corresponds to this container: - drafts_to_publish = authoring_api.get_all_drafts(learning_package.id).filter(entity__pk=container.pk) + drafts_to_publish = content_api.get_all_drafts(learning_package.id).filter(entity__pk=container.id) # Publish the container, which will also auto-publish any unpublished child components: - publish_log = authoring_api.publish_from_drafts( - learning_package.id, - draft_qset=drafts_to_publish, - published_by=user_id, - ) - # Update the search index (and anything else) for the affected container + blocks - # This is mostly synchronous but may complete some work asynchronously if there are a lot of changes. - if call_post_publish_events_sync: - tasks.send_events_after_publish(publish_log.pk, str(library_key)) - else: - tasks.wait_for_post_publish_events(publish_log, library_key) + content_api.publish_from_drafts(learning_package.id, draft_qset=drafts_to_publish, published_by=user_id) def copy_container(container_key: LibraryContainerLocator, user_id: int) -> UserClipboardData: @@ -611,7 +329,7 @@ def copy_container(container_key: LibraryContainerLocator, user_id: int) -> User """ container_metadata = get_container(container_key) container_serializer = ContainerSerializer(container_metadata) - block_type = ContainerType(container_key.container_type).olx_tag + block_type = content_api.get_container_subclass(container_key.container_type).olx_tag_name from openedx.core.djangoapps.content_staging import api as content_staging_api @@ -639,3 +357,323 @@ def get_library_object_hierarchy( https://github.com/openedx/edx-platform/pull/36813#issuecomment-3136631767 """ return ContainerHierarchy.create_from_library_object_key(object_key) + + +def get_library_container_draft_history( + container_key: LibraryContainerLocator, + request=None, +) -> list[LibraryHistoryEntry]: + """ + [ 🛑 UNSTABLE ] Return the combined draft history for a container and all of its descendant + components, sorted from most-recent to oldest. + + Each entry describes a single change log record: who made the change, when, + what the title was at that point. + """ + container = get_container_from_key(container_key) + # Collect entity IDs for all components nested inside this container. + component_entity_ids = content_api.get_descendant_component_entity_ids(container) + + @cache + def _contributor(user): + return make_contributor(user, request) + + results: list[LibraryHistoryEntry] = [] + # Process the container itself first, then each descendant component. + for item_id in [container.pk] + component_entity_ids: + for record in content_api.get_entity_draft_history(item_id).select_related( + "entity__component__component_type", + "entity__container__container_type", + "draft_change_log__changed_by__profile", + ): + # Use the new version when available; fall back to the old version + # (e.g. for delete records where new_version is None). + version = record.new_version if record.new_version is not None else record.old_version + # old_version is None only for the very first publish (entity had no prior published version) + old_version_num = record.old_version.version_num if record.old_version else 0 + # new_version is None for soft-delete publishes (container deleted without a new draft version) + new_version_num = record.new_version.version_num if record.new_version else None + item_type = get_entity_item_type(record.entity) + results.append(LibraryHistoryEntry( + contributor=_contributor(record.draft_change_log.changed_by), + changed_at=record.draft_change_log.changed_at, + title=version.title if version is not None else "", + item_type=item_type, + action=resolve_change_action(record.old_version, record.new_version), + old_version=old_version_num, + new_version=new_version_num, + )) + + # Return all entries sorted newest-first across the container and its children. + results.sort( + key=operator.attrgetter('changed_at', 'title'), + reverse=True, + ) + return results + + +def get_library_container_publish_history( + container_key: LibraryContainerLocator, + request=None, +) -> list[LibraryPublishHistoryGroup]: + """ + [ 🛑 UNSTABLE ] Return the publish history of a container as a list of groups. + + Pre-Verawood records (direct=None): one group per entity × publish event + (same PublishLog may produce multiple groups — one per entity in scope). + + Post-Verawood records (direct!=None): one group per unique PublishLog that + touched the container or any descendant. Contributors are accumulated across + all entities in that PublishLog within scope. direct_published_entities lists + the entities the user directly clicked "Publish" on. + + Groups are ordered most-recent-first. Returns [] if nothing has been published. + """ + container = get_container_from_key(container_key) + component_entity_ids = content_api.get_descendant_component_entity_ids(container) + all_entity_ids = [container.pk] + component_entity_ids + + # Collect all records grouped by publish_log_uuid. + publish_log_groups: dict[UUID, list[tuple[int, PublishLogRecord]]] = {} + for entity_id in all_entity_ids: + for pub_record in content_api.get_entity_publish_history(entity_id).select_related( + "entity__component__component_type", + "entity__container__container_type", + "new_version", + "old_version", + ): + uuid: UUID = pub_record.publish_log.uuid + publish_log_groups.setdefault(uuid, []).append((entity_id, pub_record)) + + groups = [] + for uuid, entity_records in publish_log_groups.items(): + # Era is uniform across all records in one PublishLog. + _, first_record = entity_records[0] + user_publish_intent_was_recorded = first_record.direct is not None + + if user_publish_intent_was_recorded: + # ONE merged group for this entire PublishLog. + groups.append( + _build_post_verawood_container_group( + uuid, entity_records, container_key, request + ) + ) + else: + # Pre-Verawood: one group per entity-record pair (separated). + for entity_id, pub_record in entity_records: + groups.append( + _build_pre_verawood_container_group( + pub_record, entity_id, container_key, request + ) + ) + groups.sort(key=operator.attrgetter('published_at', 'publish_log_uuid'), reverse=True) + return groups + + +def _build_post_verawood_container_group( + uuid: UUID, + entity_records: list[tuple[int, PublishLogRecord]], + container_key: LibraryContainerLocator, + request, +) -> LibraryPublishHistoryGroup: + """ + Build one merged LibraryPublishHistoryGroup for a Post-Verawood PublishLog. + + Queries the full PublishLog for direct=True records (covers both in-scope + and out-of-scope cases, e.g. a shared component published from a sibling). + Contributors are accumulated across all in-scope entity records. + """ + publish_log = entity_records[0][1].publish_log + direct_records = ( + publish_log.records + .filter(direct=True) + .select_related( + 'entity__component__component_type', + 'entity__container__container_type', + 'new_version', + 'old_version', + ) + ) + direct_published_entities = [ + direct_published_entity_from_record(r, container_key.lib_key) + for r in direct_records + ] + + seen_usernames: set[str] = set() + all_contributors = [] + for entity_id, pub_record in entity_records: + old_version_num = pub_record.old_version.version_num if pub_record.old_version else 0 + new_version_num = pub_record.new_version.version_num if pub_record.new_version else None + contributing_users = content_api.get_entity_version_contributors( + entity_id, + old_version_num=old_version_num, + new_version_num=new_version_num, + ).select_related('profile') + for user in contributing_users: + contributor = LibraryHistoryContributor.from_user(user, request) + if contributor.username not in seen_usernames: + seen_usernames.add(contributor.username) + all_contributors.append(contributor) + + return LibraryPublishHistoryGroup( + publish_log_uuid=uuid, + published_by=publish_log.published_by, + published_at=publish_log.published_at, + contributors=all_contributors, + direct_published_entities=direct_published_entities, + scope_entity_key=None, + ) + + +def _build_pre_verawood_container_group( + pub_record: PublishLogRecord, + entity_id: int, + container_key: LibraryContainerLocator, + request, +) -> LibraryPublishHistoryGroup: + """ + Build one LibraryPublishHistoryGroup for a Pre-Verawood record. + + One group per entity × publish event (separated). entity_key is approximated: + str(container_key) for the container itself, str(usage_key) for a component. + """ + old_version_num = pub_record.old_version.version_num if pub_record.old_version else 0 + new_version_num = pub_record.new_version.version_num if pub_record.new_version else None + contributing_users = content_api.get_entity_version_contributors( + entity_id, + old_version_num=old_version_num, + new_version_num=new_version_num, + ).select_related('profile') + contributors = [ + LibraryHistoryContributor.from_user(user, request) + for user in contributing_users + ] + + entity = direct_published_entity_from_record(pub_record, container_key.lib_key) + return LibraryPublishHistoryGroup( + publish_log_uuid=pub_record.publish_log.uuid, + published_by=pub_record.publish_log.published_by, + published_at=pub_record.publish_log.published_at, + contributors=contributors, + # Pre-Verawood: single approximated entry built from the record itself. + direct_published_entities=[entity], + scope_entity_key=entity.entity_key, + ) + + +def get_library_container_publish_history_entries( + scope_entity_key: LibraryContainerLocator, + publish_log_uuid: UUID, + request=None, +) -> list[LibraryHistoryEntry]: + """ + [ 🛑 UNSTABLE ] Return the individual draft change entries for all entities + in scope that participated in a specific publish event. + + scope_entity_key identifies the container being viewed — it defines which + entities' entries to return (the container + its descendants). This may differ + from the direct_published_entities in the publish group (e.g. a parent Section + was directly published, but the scope here is a child Unit). + + Post-Verawood (direct!=None): returns entries for all entities in scope that + participated in the PublishLog. + + Pre-Verawood (direct=None): returns entries only for the container itself + (old behavior — one group per entity, scope == directly published entity). + + Returns [] if no entities in scope participated in this publish event. + """ + container = get_container_from_key(scope_entity_key) + component_entity_ids = content_api.get_descendant_component_entity_ids(container) + scope_entity_ids = {container.pk} | set(component_entity_ids) + + publish_log_records = PublishLogRecord.objects.filter(publish_log__uuid=publish_log_uuid) + is_post_verawood = publish_log_records.filter(direct__isnull=False).exists() + + if is_post_verawood: + # Return entries for all entities in scope that participated in this PublishLog. + relevant_entity_ids = ( + set(publish_log_records.values_list('entity_id', flat=True)) & scope_entity_ids + ) + else: + # Pre-Verawood: scope_entity_key is the directly published entity. + # Return entries only for the container itself (old behavior). + relevant_entity_ids = {container.pk} & set( + publish_log_records.values_list('entity_id', flat=True) + ) + + if not relevant_entity_ids: + return [] + + @cache + def _contributor(user): + return make_contributor(user, request) + + entries = [] + for entity_id in relevant_entity_ids: + try: + records = ( + content_api.get_entity_publish_history_entries(entity_id, str(publish_log_uuid)) + .select_related( + 'entity__component__component_type', + 'entity__container__container_type', + 'draft_change_log__changed_by__profile', + ) + ) + except ObjectDoesNotExist: + continue + + for record in records: + version = record.new_version if record.new_version is not None else record.old_version + # old_version is None only for the very first publish (entity had no prior published version) + old_version_num = record.old_version.version_num if record.old_version else 0 + # new_version is None for soft-delete publishes (component deleted without a new draft version) + new_version_num = record.new_version.version_num if record.new_version else None + item_type = get_entity_item_type(record.entity) + entries.append(LibraryHistoryEntry( + contributor=_contributor(record.draft_change_log.changed_by), + changed_at=record.draft_change_log.changed_at, + title=version.title if version is not None else "", + item_type=item_type, + action=resolve_change_action(record.old_version, record.new_version), + old_version=old_version_num, + new_version=new_version_num, + )) + + # Return entries sorted newest-first; use title as tiebreaker for determinism. + entries.sort(key=operator.attrgetter('changed_at', 'title'), reverse=True) + return entries + + +def get_library_container_creation_entry( + container_key: LibraryContainerLocator, + request=None, +) -> LibraryHistoryEntry | None: + """ + [ 🛑 UNSTABLE ] Return the creation entry for a library container. + + This is a single LibraryHistoryEntry representing the moment the container + was first created. Returns None if the container has no + versions yet. + """ + container = get_container_from_key(container_key) + # TODO: replace with container.versioning.earliest once VersioningHelper exposes that helper. + first_version = ( + container.publishable_entity.versions + .order_by('version_num') + .select_related("created_by__profile") + .first() + ) + if first_version is None: + return None + + user = first_version.created_by + return LibraryHistoryEntry( + contributor=make_contributor(user, request), + changed_at=first_version.created, + title=first_version.title, + item_type=container.container_type.type_code, + action="created", + old_version=0, + new_version=first_version.version_num, + ) diff --git a/openedx/core/djangoapps/content_libraries/api/courseware_import.py b/openedx/core/djangoapps/content_libraries/api/courseware_import.py deleted file mode 100644 index de20243070d2..000000000000 --- a/openedx/core/djangoapps/content_libraries/api/courseware_import.py +++ /dev/null @@ -1,356 +0,0 @@ -""" -Content Libraries Python API to import blocks from Courseware -============================================================= - -Content Libraries can import blocks from Courseware (Modulestore). The import -can be done per-course, by listing its content, and supports both access to -remote platform instances as well as local modulestore APIs. Additionally, -there are Celery-based interfaces suitable for background processing controlled -through RESTful APIs (see :mod:`.views`). -""" -import abc -import collections -import base64 -import hashlib -import logging - -from django.conf import settings -import requests - -from opaque_keys.edx.locator import ( - LibraryUsageLocatorV2, - LibraryLocator as LibraryLocatorV1, -) -from opaque_keys.edx.keys import UsageKey -from edx_rest_api_client.client import OAuthAPIClient - -from openedx.core.lib.xblock_serializer.api import serialize_modulestore_block_for_learning_core -from xmodule.modulestore.django import modulestore - -from .. import tasks -from ..models import ContentLibrary, ContentLibraryBlockImportTask -from .blocks import ( - LibraryBlockAlreadyExists, - add_library_block_static_asset_file, - create_library_block, - get_library_block_static_asset_files, - get_library_block, - set_library_block_olx, -) -from .libraries import publish_changes - -log = logging.getLogger(__name__) - -__all__ = [ - "EdxModulestoreImportClient", - "EdxApiImportClient", - "import_blocks_create_task", -] - - -class BaseEdxImportClient(abc.ABC): - """ - Base class for all courseware import clients. - - Import clients are wrappers tailored to implement the steps used in the - import APIs and can leverage different backends. It is not aimed towards - being a generic API client for Open edX. - """ - - EXPORTABLE_BLOCK_TYPES = { - "drag-and-drop-v2", - "problem", - "html", - "video", - } - - def __init__(self, library_key=None, library=None, use_course_key_as_block_id_suffix=True): - """ - Initialize an import client for a library. - - The method accepts either a library object or a key to a library object. - """ - self.use_course_key_as_block_id_suffix = use_course_key_as_block_id_suffix - if bool(library_key) == bool(library): - raise ValueError('Provide at least one of `library_key` or ' - '`library`, but not both.') - if library is None: - library = ContentLibrary.objects.get_by_key(library_key) - self.library = library - - @abc.abstractmethod - def get_block_data(self, block_key): - """ - Get the block's OLX and static files, if any. - """ - - @abc.abstractmethod - def get_export_keys(self, course_key): - """ - Get all exportable block keys of a given course. - """ - - @abc.abstractmethod - def get_block_static_data(self, asset_file): - """ - Get the contents of an asset_file.. - """ - - def import_block(self, modulestore_key): - """ - Import a single modulestore block. - """ - block_data = self.get_block_data(modulestore_key) - - # Get or create the block in the library. - # - # To dedup blocks from different courses with the same ID, we hash the - # course key into the imported block id. - - course_key_id = base64.b32encode( - hashlib.blake2s( - str(modulestore_key.course_key).encode() - ).digest() - )[:16].decode().lower() - - # add the course_key_id if use_course_key_as_suffix is enabled to increase the namespace. - # The option exists to not use the course key as a suffix because - # in order to preserve learner state in the v1 to v2 libraries migration, - # the v2 and v1 libraries' child block ids must be the same. - block_id = ( - # Prepend 'c' to allow changing hash without conflicts. - f"{modulestore_key.block_id}_c{course_key_id}" - if self.use_course_key_as_block_id_suffix - else f"{modulestore_key.block_id}" - ) - - log.info('Importing to library block: id=%s', block_id) - try: - library_block = create_library_block( - self.library.library_key, - modulestore_key.block_type, - block_id, - ) - dest_key = library_block.usage_key - except LibraryBlockAlreadyExists: - dest_key = LibraryUsageLocatorV2( - lib_key=self.library.library_key, - block_type=modulestore_key.block_type, - usage_id=block_id, - ) - get_library_block(dest_key) - log.warning('Library block already exists: Appending static files ' - 'and overwriting OLX: %s', str(dest_key)) - - # Handle static files. - - files = [ - f.path for f in - get_library_block_static_asset_files(dest_key) - ] - for filename, static_file in block_data.get('static_files', {}).items(): - if filename in files: - # Files already added, move on. - continue - file_content = self.get_block_static_data(static_file) - add_library_block_static_asset_file(dest_key, filename, file_content) - files.append(filename) - - # Import OLX. - - set_library_block_olx(dest_key, block_data['olx']) - - def import_blocks_from_course(self, course_key, progress_callback): - """ - Import all eligible blocks from course key. - - Progress is reported through ``progress_callback``, guaranteed to be - called within an exception handler if ``exception is not None``. - """ - - # Query the course and rerieve all course blocks. - - export_keys = self.get_export_keys(course_key) - if not export_keys: - raise ValueError(f"The courseware course {course_key} does not have " - "any exportable content. No action taken.") - - # Import each block, skipping the ones that fail. - - for index, block_key in enumerate(export_keys): - try: - log.info('Importing block: %s/%s: %s', index + 1, len(export_keys), block_key) - self.import_block(block_key) - except Exception as exc: # pylint: disable=broad-except - log.exception("Error importing block: %s", block_key) - progress_callback(block_key, index + 1, len(export_keys), exc) - else: - log.info('Successfully imported: %s/%s: %s', index + 1, len(export_keys), block_key) - progress_callback(block_key, index + 1, len(export_keys), None) - - log.info("Publishing library: %s", self.library.library_key) - publish_changes(self.library.library_key) - - -class EdxModulestoreImportClient(BaseEdxImportClient): - """ - An import client based on the local instance of modulestore. - """ - - def __init__(self, modulestore_instance=None, **kwargs): - """ - Initialize the client with a modulestore instance. - """ - super().__init__(**kwargs) - self.modulestore = modulestore_instance or modulestore() - - def get_block_data(self, block_key): - """ - Get block OLX by serializing it from modulestore directly. - """ - block = self.modulestore.get_item(block_key) - data = serialize_modulestore_block_for_learning_core(block) - return {'olx': data.olx_str, - 'static_files': {s.name: s for s in data.static_files}} - - def get_export_keys(self, course_key): - """ - Retrieve the course from modulestore and traverse its content tree. - """ - course = self.modulestore.get_course(course_key) - if isinstance(course_key, LibraryLocatorV1): - course = self.modulestore.get_library(course_key) - export_keys = set() - blocks_q = collections.deque(course.get_children()) - while blocks_q: - block = blocks_q.popleft() - usage_id = block.scope_ids.usage_id - if usage_id in export_keys: - continue - if usage_id.block_type in self.EXPORTABLE_BLOCK_TYPES: - export_keys.add(usage_id) - if block.has_children: - blocks_q.extend(block.get_children()) - return list(export_keys) - - def get_block_static_data(self, asset_file): - """ - Get static content from its URL if available, otherwise from its data. - """ - if asset_file.data: - return asset_file.data - resp = requests.get(f"http://{settings.CMS_BASE}" + asset_file.url) - resp.raise_for_status() - return resp.content - - -class EdxApiImportClient(BaseEdxImportClient): - """ - An import client based on a remote Open Edx API interface. - - TODO: Look over this class. We'll probably need to completely re-implement - the import process. - """ - - URL_COURSES = "/api/courses/v1/courses/{course_key}" - - URL_MODULESTORE_BLOCK_OLX = "/api/olx-export/v1/xblock/{block_key}/" - - def __init__(self, lms_url, studio_url, oauth_key, oauth_secret, *args, **kwargs): - """ - Initialize the API client with URLs and OAuth keys. - """ - super().__init__(**kwargs) - self.lms_url = lms_url - self.studio_url = studio_url - self.oauth_client = OAuthAPIClient( - self.lms_url, - oauth_key, - oauth_secret, - ) - - def get_block_data(self, block_key): - """ - See parent's docstring. - """ - olx_path = self.URL_MODULESTORE_BLOCK_OLX.format(block_key=block_key) - resp = self._get(self.studio_url + olx_path) - return resp['blocks'][str(block_key)] - - def get_export_keys(self, course_key): - """ - See parent's docstring. - """ - course_blocks_url = self._get_course(course_key)['blocks_url'] - course_blocks = self._get( - course_blocks_url, - params={'all_blocks': True, 'depth': 'all'})['blocks'] - export_keys = [] - for block_info in course_blocks.values(): - if block_info['type'] in self.EXPORTABLE_BLOCK_TYPES: - export_keys.append(UsageKey.from_string(block_info['id'])) - return export_keys - - def get_block_static_data(self, asset_file): - """ - See parent's docstring. - """ - if (asset_file['url'].startswith(self.studio_url) - and 'export-file' in asset_file['url']): - # We must call download this file with authentication. But - # we only want to pass the auth headers if this is the same - # studio instance, or else we could leak credentials to a - # third party. - path = asset_file['url'][len(self.studio_url):] - resp = self._call('get', path) - else: - resp = requests.get(asset_file['url']) - resp.raise_for_status() - return resp.content - - def _get(self, *args, **kwargs): - """ - Perform a get request to the client. - """ - return self._json_call('get', *args, **kwargs) - - def _get_course(self, course_key): - """ - Request details for a course. - """ - course_url = self.lms_url + self.URL_COURSES.format(course_key=course_key) - return self._get(course_url) - - def _json_call(self, method, *args, **kwargs): - """ - Wrapper around request calls that ensures valid json responses. - """ - return self._call(method, *args, **kwargs).json() - - def _call(self, method, *args, **kwargs): - """ - Wrapper around request calls. - """ - response = getattr(self.oauth_client, method)(*args, **kwargs) - response.raise_for_status() - return response - - -def import_blocks_create_task(library_key, course_key, use_course_key_as_block_id_suffix=True): - """ - Create a new import block task. - - This API will schedule a celery task to perform the import, and it returns a - import task object for polling. - """ - library = ContentLibrary.objects.get_by_key(library_key) - import_task = ContentLibraryBlockImportTask.objects.create( - library=library, - course_id=course_key, - ) - result = tasks.import_blocks_from_course.apply_async( - args=(import_task.pk, str(course_key), use_course_key_as_block_id_suffix) - ) - log.info(f"Import block task created: import_task={import_task} " - f"celery_task={result.id}") - return import_task diff --git a/openedx/core/djangoapps/content_libraries/api/exceptions.py b/openedx/core/djangoapps/content_libraries/api/exceptions.py index e715f0856136..1fb555aaded0 100644 --- a/openedx/core/djangoapps/content_libraries/api/exceptions.py +++ b/openedx/core/djangoapps/content_libraries/api/exceptions.py @@ -2,13 +2,11 @@ Exceptions that can be thrown by the Content Libraries API. """ from django.db import IntegrityError - -from openedx_learning.api.authoring_models import Collection, Container +from openedx_content.models_api import Collection, Container from xblock.exceptions import XBlockNotFoundError from ..models import ContentLibrary - # The public API is only the following symbols: __all__ = [ "ContentLibraryNotFound", diff --git a/openedx/core/djangoapps/content_libraries/api/libraries.py b/openedx/core/djangoapps/content_libraries/api/libraries.py index f5d60e9fc826..305d396d4619 100644 --- a/openedx/core/djangoapps/content_libraries/api/libraries.py +++ b/openedx/core/djangoapps/content_libraries/api/libraries.py @@ -42,6 +42,7 @@ from __future__ import annotations import logging +import warnings from dataclasses import dataclass from dataclasses import field as dataclass_field from datetime import datetime @@ -57,21 +58,21 @@ from openedx_authz import api as authz_api from openedx_authz.api import assign_role_to_user_in_scope from openedx_authz.constants import permissions as authz_permissions +from openedx_content import api as content_api +from openedx_content.models_api import Component, LearningPackage from openedx_events.content_authoring.data import ContentLibraryData from openedx_events.content_authoring.signals import ( CONTENT_LIBRARY_CREATED, CONTENT_LIBRARY_DELETED, CONTENT_LIBRARY_UPDATED, ) -from openedx_learning.api import authoring as authoring_api -from openedx_learning.api.authoring_models import Component, LearningPackage from organizations.models import Organization from user_tasks.models import UserTaskArtifact, UserTaskStatus from xblock.core import XBlock from openedx.core.types import User as UserType -from .. import permissions, tasks +from .. import permissions from ..constants import ALL_RIGHTS_RESERVED from ..models import ContentLibrary, ContentLibraryPermission from .exceptions import LibraryAlreadyExists, LibraryPermissionIntegrityError @@ -123,7 +124,7 @@ class ContentLibraryMetadata: Class that represents the metadata about a content library. """ key: LibraryLocatorV2 - learning_package_id: int | None + learning_package_id: LearningPackage.ID | None title: str = "" description: str = "" num_blocks: int = 0 @@ -138,7 +139,6 @@ class ContentLibraryMetadata: # has_unpublished_deletes will be true when the draft version of the library's bundle # contains deletes of any XBlocks that were in the most recently published version has_unpublished_deletes: bool = False - allow_lti: bool = False # Allow any user (even unregistered users) to view and interact directly # with this library's content in the LMS allow_public_learning: bool = False @@ -200,7 +200,7 @@ class PublishableItem(LibraryItem): Common fields for anything that can be found in a content library that has draft/publish support. """ - draft_version_num: int + draft_version_num: int | None published_version_num: int | None = None published_display_name: str | None last_published: datetime | None = None @@ -212,6 +212,7 @@ class PublishableItem(LibraryItem): has_unpublished_changes: bool = False collections: list[CollectionMetadata] = dataclass_field(default_factory=list) can_stand_alone: bool = True + created_by: str | None = None @dataclass(frozen=True) @@ -303,7 +304,7 @@ def get_libraries_for_user(user, org=None, text_search=None, order=None) -> Quer def get_metadata(queryset: QuerySet[ContentLibrary], text_search: str | None = None) -> list[ContentLibraryMetadata]: """ - Take a list of ContentLibrary objects and return metadata from Learning Core. + Take a list of ContentLibrary objects and return metadata from openedx_content. """ if text_search: queryset = queryset.filter(org__short_name__icontains=text_search) @@ -322,7 +323,7 @@ def get_metadata(queryset: QuerySet[ContentLibrary], text_search: str | None = N allow_public_read=lib.allow_public_read, # These are currently dummy values to maintain the REST API contract - # while we shift to Learning Core models. + # while we shift to openedx_content models. num_blocks=0, last_published=None, has_unpublished_changes=False, @@ -335,15 +336,24 @@ def get_metadata(queryset: QuerySet[ContentLibrary], text_search: str | None = N return libraries -def require_permission_for_library_key(library_key: LibraryLocatorV2, user: UserType, permission) -> ContentLibrary: +def require_permission_for_library_key( + library_key: LibraryLocatorV2, user: UserType, permission: str | authz_api.data.PermissionData +) -> ContentLibrary: """ - Given any of the content library permission strings defined in - openedx.core.djangoapps.content_libraries.permissions, - check if the given user has that permission for the library with the - specified library ID. + Check if the user has the specified permission for a content library. - Raises django.core.exceptions.PermissionDenied if the user doesn't have - permission. + Args: + library_key: The library key identifying the content library + user: The user whose permissions are being checked + permission: Either a permission string from content_libraries.permissions + or a PermissionData instance from the authz API + + Returns: + ContentLibrary: The library object if permission check passes + + Raises: + ContentLibraryNotFound: If the library with the given key doesn't exist + PermissionDenied: If the user doesn't have the required permission """ library_obj = ContentLibrary.objects.get_by_key(library_key) # obj should be able to read any valid model object but mypy thinks it can only be @@ -364,9 +374,9 @@ def get_library(library_key: LibraryLocatorV2) -> ContentLibraryMetadata: ref = ContentLibrary.objects.get_by_key(library_key) learning_package = ref.learning_package assert learning_package is not None # Shouldn't happen - this is just for the type checker - num_blocks = authoring_api.get_all_drafts(learning_package.id).count() - last_publish_log = authoring_api.get_last_publish(learning_package.id) - last_draft_log = authoring_api.get_entities_with_unpublished_changes(learning_package.id) \ + num_blocks = content_api.get_all_drafts(learning_package.id).count() + last_publish_log = content_api.get_last_publish(learning_package.id) + last_draft_log = content_api.get_entities_with_unpublished_changes(learning_package.id) \ .order_by('-created').first() last_draft_created = last_draft_log.created if last_draft_log else None last_draft_created_by = last_draft_log.created_by.username if last_draft_log and last_draft_log.created_by else "" @@ -374,11 +384,12 @@ def get_library(library_key: LibraryLocatorV2) -> ContentLibraryMetadata: # TODO: I'm doing this one to match already-existing behavior, but this is # something that we should remove. It exists to accomodate some complexities - # with how Blockstore staged changes, but Learning Core works differently, + # with how Blockstore staged changes, but openedx_content works differently, # and has_unpublished_changes should be sufficient. # Ref: https://github.com/openedx/edx-platform/issues/34283 - has_unpublished_deletes = authoring_api.get_entities_with_unpublished_deletes(learning_package.id) \ - .exists() + has_unpublished_deletes = ( + content_api.get_entities_with_unpublished_deletes(learning_package.id).exists() + ) published_by = "" if last_publish_log and last_publish_log.published_by: @@ -393,7 +404,6 @@ def get_library(library_key: LibraryLocatorV2) -> ContentLibraryMetadata: published_by=published_by, last_draft_created=last_draft_created, last_draft_created_by=last_draft_created_by, - allow_lti=ref.allow_lti, allow_public_learning=ref.allow_public_learning, allow_public_read=ref.allow_public_read, has_unpublished_changes=has_unpublished_changes, @@ -401,7 +411,7 @@ def get_library(library_key: LibraryLocatorV2) -> ContentLibraryMetadata: license=ref.license, created=learning_package.created, updated=learning_package.updated, - learning_package_id=learning_package.pk, + learning_package_id=learning_package.id, ) @@ -436,7 +446,7 @@ def create_library( """ assert isinstance(org, Organization) validate_unicode_slug(slug) - is_learning_package_loaded = learning_package is not None + is_learning_package_loaded = learning_package is not None # noqa: F841 try: with transaction.atomic(): ref = ContentLibrary.objects.create( @@ -450,23 +460,23 @@ def create_library( if learning_package: # A temporary LearningPackage was passed in, so update its key to match the library, # and also update its title/description in case they differ. - authoring_api.update_learning_package( + content_api.update_learning_package( learning_package.id, - key=str(ref.library_key), + package_ref=str(ref.library_key), title=title, description=description, ) else: # We have to generate a new LearningPackage for this library. - learning_package = authoring_api.create_learning_package( - key=str(ref.library_key), + learning_package = content_api.create_learning_package( + package_ref=str(ref.library_key), title=title, description=description, ) ref.learning_package = learning_package ref.save() except IntegrityError: - raise LibraryAlreadyExists(slug) # lint-amnesty, pylint: disable=raise-missing-from + raise LibraryAlreadyExists(slug) # pylint: disable=raise-missing-from # noqa: B904 # .. event_implemented_name: CONTENT_LIBRARY_CREATED # .. event_type: org.openedx.content_authoring.content_library.created.v1 @@ -485,7 +495,7 @@ def create_library( allow_public_learning=ref.allow_public_learning, allow_public_read=ref.allow_public_read, license=library_license, - learning_package_id=ref.learning_package.pk, + learning_package_id=ref.learning_package.id, # type: ignore[union-attr] ) @@ -493,6 +503,14 @@ def get_library_team(library_key: LibraryLocatorV2) -> list[ContentLibraryPermis """ Get the list of users/groups granted permission to use this library. """ + warnings.warn( + "get_library_team is deprecated. " + "Use get_all_user_role_assignments_in_scope from the openedx-authz API instead. " + "See https://github.com/openedx/openedx-platform/issues/37409.", + DeprecationWarning, + stacklevel=2, + ) + ref = ContentLibrary.objects.get_by_key(library_key) return [ ContentLibraryPermissionEntry(user=entry.user, group=entry.group, access_level=entry.access_level) @@ -505,6 +523,14 @@ def get_library_user_permissions(library_key: LibraryLocatorV2, user: UserType) Fetch the specified user's access information. Will return None if no permissions have been granted. """ + warnings.warn( + "get_library_user_permissions is deprecated. " + "Use get_user_role_assignments_in_scope from the openedx-authz API instead. " + "See https://github.com/openedx/openedx-platform/issues/37409.", + DeprecationWarning, + stacklevel=2, + ) + if isinstance(user, AnonymousUser): return None # Mostly here for the type checker ref = ContentLibrary.objects.get_by_key(library_key) @@ -524,6 +550,14 @@ def set_library_user_permissions(library_key: LibraryLocatorV2, user: UserType, access_level should be one of the AccessLevel values defined above. """ + warnings.warn( + "set_library_user_permissions is deprecated. " + "Use assign_library_role_to_user instead. " + "See https://github.com/openedx/openedx-platform/issues/37409.", + DeprecationWarning, + stacklevel=2, + ) + if isinstance(user, AnonymousUser): raise TypeError("Invalid user type") # Mostly here for the type checker ref = ContentLibrary.objects.get_by_key(library_key) @@ -572,6 +606,14 @@ def set_library_group_permissions(library_key: LibraryLocatorV2, group, access_l access_level should be one of the AccessLevel values defined above. """ + warnings.warn( + "set_library_group_permissions is deprecated. " + "Use assign_library_role_to_user instead. " + "See https://github.com/openedx/openedx-platform/issues/37409.", + DeprecationWarning, + stacklevel=2, + ) + ref = ContentLibrary.objects.get_by_key(library_key) if access_level is None: @@ -625,7 +667,7 @@ def update_library( content_lib.save() if learning_pkg_changed: - authoring_api.update_learning_package( + content_api.update_learning_package( learning_package_id, title=title, description=description, @@ -677,7 +719,7 @@ def library_component_usage_key( return LibraryUsageLocatorV2( # type: ignore[abstract] library_key, block_type=component.component_type.name, - usage_id=component.local_key, + usage_id=component.component_code, ) @@ -717,15 +759,10 @@ def publish_changes(library_key: LibraryLocatorV2, user_id: int | None = None): """ learning_package = ContentLibrary.objects.get_by_key(library_key).learning_package assert learning_package is not None # shouldn't happen but it's technically possible. - publish_log = authoring_api.publish_all_drafts(learning_package.id, published_by=user_id) - - # Update the search index (and anything else) for the affected blocks - # This is mostly synchronous but may complete some work asynchronously if there are a lot of changes. - tasks.wait_for_post_publish_events(publish_log, library_key) - - # Unlike revert_changes below, we do not have to re-index collections, - # because publishing changes does not affect the component counts, and - # collections themselves don't have draft/published/unpublished status. + content_api.publish_all_drafts(learning_package.id, published_by=user_id) + # Note: Calling publish_all_drafts() just now will emit a ENTITIES_PUBLISHED event, and this content_libraries app's + # send_events_after_publish() task will receive that event and in turn emit LIBRARY_BLOCK_PUBLISHED and + # LIBRARY_CONTAINER_PUBLISHED events, which will cause the search index to be updated and potentially other effects. def revert_changes(library_key: LibraryLocatorV2, user_id: int | None = None) -> None: @@ -735,11 +772,8 @@ def revert_changes(library_key: LibraryLocatorV2, user_id: int | None = None) -> """ learning_package = ContentLibrary.objects.get_by_key(library_key).learning_package assert learning_package is not None # shouldn't happen but it's technically possible. - with authoring_api.bulk_draft_changes_for(learning_package.id) as draft_change_log: - authoring_api.reset_drafts_to_published(learning_package.id, reset_by=user_id) - - # Call the event handlers as needed. - tasks.wait_for_post_revert_events(draft_change_log, library_key) + with content_api.bulk_draft_changes_for(learning_package.id): + content_api.reset_drafts_to_published(learning_package.id, reset_by=user_id) def get_backup_task_status( @@ -772,9 +806,15 @@ def get_backup_task_status( def _transform_legacy_lib_permission_to_authz_permission(permission: str) -> str: """ Transform a legacy content library permission to an openedx-authz permission. + + Notes: + - There is no dedicated permission or role for can_create_content_library in openedx-authz yet, + so we reuse the same permission to rely on user.has_perm via Bridgekeeper. + - There is no dedicated can_learn_from_this_content_library permission + in the new authz system, + but we are mapping it to view_library in the new system. So the user who can view + library content can learn from it. """ - # There is no dedicated permission or role for can_create_content_library in openedx-authz yet, - # so we reuse the same permission to rely on user.has_perm via Bridgekeeper. return { permissions.CAN_CREATE_CONTENT_LIBRARY: permissions.CAN_CREATE_CONTENT_LIBRARY, permissions.CAN_DELETE_THIS_CONTENT_LIBRARY: authz_permissions.DELETE_LIBRARY.identifier, @@ -782,6 +822,7 @@ def _transform_legacy_lib_permission_to_authz_permission(permission: str) -> str permissions.CAN_EDIT_THIS_CONTENT_LIBRARY_TEAM: authz_permissions.MANAGE_LIBRARY_TEAM.identifier, permissions.CAN_VIEW_THIS_CONTENT_LIBRARY: authz_permissions.VIEW_LIBRARY.identifier, permissions.CAN_VIEW_THIS_CONTENT_LIBRARY_TEAM: authz_permissions.VIEW_LIBRARY_TEAM.identifier, + permissions.CAN_LEARN_FROM_THIS_CONTENT_LIBRARY: authz_permissions.VIEW_LIBRARY.identifier, }.get(permission, permission) @@ -794,6 +835,8 @@ def _transform_authz_permission_to_legacy_lib_permission(permission: str) -> str authz_permissions.CREATE_LIBRARY_COLLECTION.identifier: permissions.CAN_EDIT_THIS_CONTENT_LIBRARY, authz_permissions.EDIT_LIBRARY_COLLECTION.identifier: permissions.CAN_EDIT_THIS_CONTENT_LIBRARY, authz_permissions.DELETE_LIBRARY_COLLECTION.identifier: permissions.CAN_EDIT_THIS_CONTENT_LIBRARY, + authz_permissions.MANAGE_LIBRARY_TAGS.identifier: permissions.CAN_EDIT_THIS_CONTENT_LIBRARY, + authz_permissions.REUSE_LIBRARY_CONTENT.identifier: permissions.CAN_VIEW_THIS_CONTENT_LIBRARY, }.get(permission, permission) @@ -817,6 +860,11 @@ def user_has_permission_across_lib_authz_systems( Current gaps covered here: - CAN_CREATE_CONTENT_LIBRARY: we call user.has_perm via Bridgekeeper to verify the user is a course creator. - CAN_VIEW_THIS_CONTENT_LIBRARY: we respect the allow_public_read flag via Bridgekeeper. + - CAN_LEARN_FROM_THIS_CONTENT_LIBRARY: this permission doesn't exist in the new authz system, but we are treating + it as equivalent to view_library in the new system, so we check both the legacy permission and the authz permission. + This means that if a user can view the library content, they can learn from it. + If we want to remove the old check fully, we should either update the can_learn enforcement points + or add that specific permission to the authz system. Replace these with authz_api.is_user_allowed once openedx-authz supports these conditions natively (including global (*) roles). diff --git a/openedx/core/djangoapps/content_libraries/api/permissions.py b/openedx/core/djangoapps/content_libraries/api/permissions.py index 5b8bd4ba7e1a..3bfd09d1d8db 100644 --- a/openedx/core/djangoapps/content_libraries/api/permissions.py +++ b/openedx/core/djangoapps/content_libraries/api/permissions.py @@ -1,5 +1,8 @@ """ -Public permissions that are part of the content libraries API +Public permissions that are part of the content libraries API. + +Deprecated. This module re-exports legacy content library permissions. +See https://github.com/openedx/openedx-platform/issues/37409. """ # pylint: disable=unused-import @@ -10,7 +13,7 @@ CAN_EDIT_THIS_CONTENT_LIBRARY_TEAM, CAN_LEARN_FROM_THIS_CONTENT_LIBRARY, CAN_VIEW_THIS_CONTENT_LIBRARY, - CAN_VIEW_THIS_CONTENT_LIBRARY_TEAM + CAN_VIEW_THIS_CONTENT_LIBRARY_TEAM, ) LEGACY_LIB_PERMISSIONS = frozenset({ diff --git a/openedx/core/djangoapps/content_libraries/api/serializers.py b/openedx/core/djangoapps/content_libraries/api/serializers.py index 7590222d4521..a4f9b376763e 100644 --- a/openedx/core/djangoapps/content_libraries/api/serializers.py +++ b/openedx/core/djangoapps/content_libraries/api/serializers.py @@ -2,10 +2,11 @@ Serializer classes for containers """ from lxml import etree +from openedx_content import api as content_api +from openedx.core.djangoapps.content_tagging.api import TagValuesByObjectIdDict, get_all_object_tags from openedx.core.djangoapps.xblock import api as xblock_api from openedx.core.lib.xblock_serializer.api import StaticFile, XBlockSerializer -from openedx.core.djangoapps.content_tagging.api import TagValuesByObjectIdDict, get_all_object_tags from . import containers as container_api @@ -30,10 +31,10 @@ def _serialize_container(self, container_metadata: container_api.ContainerMetada Serialize the given container to OLX. """ # Create an XML node to hold the exported data - container_type = container_api.ContainerType(container_metadata.container_key.container_type) + container_cls = content_api.get_container_subclass(container_metadata.container_type_code) container_key = container_metadata.container_key - olx = etree.Element(container_type.olx_tag) + olx = etree.Element(container_cls.olx_tag_name) olx.attrib["copied_from_block"] = str(container_key) olx.attrib["copied_from_version"] = str(container_metadata.draft_version_num) diff --git a/openedx/core/djangoapps/content_libraries/api/tests/__init__.py b/openedx/core/djangoapps/content_libraries/api/tests/__init__.py new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/openedx/core/djangoapps/content_libraries/api/tests/test_backup.py b/openedx/core/djangoapps/content_libraries/api/tests/test_backup.py new file mode 100644 index 000000000000..a642b090a5dd --- /dev/null +++ b/openedx/core/djangoapps/content_libraries/api/tests/test_backup.py @@ -0,0 +1,88 @@ +""" +Tests for content library backup (zip export) utilities. +""" +from __future__ import annotations + +import shutil +import tempfile +import zipfile +from unittest.mock import MagicMock, patch + +import pytest +from django.test import TestCase +from opaque_keys.edx.locator import LibraryLocatorV2 +from path import Path + +from openedx.core.djangoapps.content_libraries.api.backup import extract_library_v2_zip_to_dir + +LIBRARY_KEY = LibraryLocatorV2(org='TestOrg', slug='test-lib') + + +class TestExtractLibraryV2ZipToDir(TestCase): + """ + Tests for ``extract_library_v2_zip_to_dir``. + """ + + def _make_zip_in_temp_dir(self, contents=None): + """ + Helper: create a real temp dir + zip file and return (temp_dir_path, zip_path). + ``contents`` is a dict of {filename: bytes} to write into the zip. + """ + temp_dir = Path(tempfile.mkdtemp()) + zip_path = str(temp_dir / 'library.zip') + with zipfile.ZipFile(zip_path, 'w') as zf: + for name, data in (contents or {'data.xml': b''}).items(): + zf.writestr(name, data) + return temp_dir, zip_path + + @patch('openedx.core.djangoapps.content_libraries.api.backup.get_user_model') + @patch('openedx.core.djangoapps.content_libraries.api.backup.create_library_v2_zip') + def test_successful_extraction(self, mock_create_zip, mock_get_user_model): + """ + On a successful call the function should: + - resolve the username to a user object via the user model, + - pass that user object to ``create_library_v2_zip``, + - create the target directory if it does not already exist, + - extract the zip contents into /, + - clean up the temporary zip directory. + """ + root_dir = Path(tempfile.mkdtemp()) + temp_zip_dir, zip_path = self._make_zip_in_temp_dir({'content.xml': b''}) + mock_create_zip.return_value = (temp_zip_dir, zip_path) + mock_user = MagicMock() + mock_get_user_model.return_value.objects.get.return_value = mock_user + + try: + target = root_dir / 'my-library' + assert not target.exists(), "Target dir should not exist before the call" + + extract_library_v2_zip_to_dir(LIBRARY_KEY, str(root_dir), 'my-library', username='testuser') + + mock_get_user_model.return_value.objects.get.assert_called_once_with(username='testuser') + mock_create_zip.assert_called_once_with(LIBRARY_KEY, mock_user) + assert target.isdir(), "Target dir should have been created" + assert (target / 'content.xml').exists(), "Zip content should be extracted" + assert not temp_zip_dir.exists(), "Temp zip dir should have been removed" + finally: + shutil.rmtree(root_dir, ignore_errors=True) + shutil.rmtree(temp_zip_dir, ignore_errors=True) + + @patch('openedx.core.djangoapps.content_libraries.api.backup.get_user_model') + @patch('openedx.core.djangoapps.content_libraries.api.backup.create_library_v2_zip') + def test_temp_dir_cleaned_up_even_on_extraction_error(self, mock_create_zip, mock_get_user_model): + """ + The temporary directory must be cleaned up even when extraction raises. + """ + root_dir = Path(tempfile.mkdtemp()) + temp_zip_dir, zip_path = self._make_zip_in_temp_dir() + mock_create_zip.return_value = (temp_zip_dir, zip_path) + mock_get_user_model.return_value.objects.get.return_value = None + + try: + with patch('zipfile.ZipFile.extractall', side_effect=OSError('disk full')): + with pytest.raises(OSError, match='disk full'): + extract_library_v2_zip_to_dir(LIBRARY_KEY, str(root_dir), 'my-library', username=None) + assert not temp_zip_dir.exists(), "Temp dir should be cleaned up on error" + finally: + shutil.rmtree(root_dir, ignore_errors=True) + shutil.rmtree(temp_zip_dir, ignore_errors=True) diff --git a/openedx/core/djangoapps/content_libraries/apps.py b/openedx/core/djangoapps/content_libraries/apps.py index 52c3e5179721..cd4ac24e4c93 100644 --- a/openedx/core/djangoapps/content_libraries/apps.py +++ b/openedx/core/djangoapps/content_libraries/apps.py @@ -5,7 +5,7 @@ from django.apps import AppConfig -from edx_django_utils.plugins import PluginURLs, PluginSettings +from edx_django_utils.plugins import PluginSettings, PluginURLs from openedx.core.djangoapps.plugins.constants import ProjectType @@ -16,7 +16,7 @@ class ContentLibrariesConfig(AppConfig): """ name = 'openedx.core.djangoapps.content_libraries' - verbose_name = 'Content Libraries (Learning-Core-based)' + verbose_name = 'Content Libraries' # This is designed as a plugin for now so that # the whole thing is self-contained and can easily be enabled/disabled plugin_app = { @@ -36,4 +36,4 @@ def ready(self): """ Import signal handler's module to ensure they are registered. """ - from . import signal_handlers # pylint: disable=unused-import + from . import signal_handlers # pylint: disable=unused-import # noqa: F401 diff --git a/openedx/core/djangoapps/content_libraries/auth.py b/openedx/core/djangoapps/content_libraries/auth.py deleted file mode 100644 index 1b35350cb396..000000000000 --- a/openedx/core/djangoapps/content_libraries/auth.py +++ /dev/null @@ -1,43 +0,0 @@ -""" -Content Library LTI authentication. - -This module offers an authentication backend to support LTI launches within -content libraries. -""" - - -import logging - -from django.contrib.auth.backends import ModelBackend - -from .models import LtiProfile - - -log = logging.getLogger(__name__) - - -class LtiAuthenticationBackend(ModelBackend): - """ - Authenticate based on content library LTI profile. - - The backend assumes the profile was previously created and its presence is - enough to assume the launch claims are valid. - """ - - # pylint: disable=arguments-differ - def authenticate(self, request, iss=None, aud=None, sub=None, **kwargs): - """ - Authenticate if the user in the request has an LTI profile. - """ - log.info('LTI 1.3 authentication: iss=%s, sub=%s', iss, sub) - try: - lti_profile = LtiProfile.objects.get_from_claims( - iss=iss, aud=aud, sub=sub) - except LtiProfile.DoesNotExist: - return None - user = lti_profile.user - log.info('LTI 1.3 authentication profile: profile=%s user=%s', - lti_profile, user) - if user and self.user_can_authenticate(user): - return user - return None diff --git a/openedx/core/djangoapps/content_libraries/constants.py b/openedx/core/djangoapps/content_libraries/constants.py index a01e0fbdda91..cb25a9db2e35 100644 --- a/openedx/core/djangoapps/content_libraries/constants.py +++ b/openedx/core/djangoapps/content_libraries/constants.py @@ -1,7 +1,6 @@ """ Constants used for the content libraries. """ from django.utils.translation import gettext_lazy as _ - # These are all the licenses we support so far. ALL_RIGHTS_RESERVED = '' CC_4_BY = 'CC:4.0:BY' diff --git a/openedx/core/djangoapps/content_libraries/docs/decisions/0001-index-libraries-in-elasticsearch.rst b/openedx/core/djangoapps/content_libraries/docs/decisions/0001-index-libraries-in-elasticsearch.rst index c1779094024a..c8dbc58ceb6d 100644 --- a/openedx/core/djangoapps/content_libraries/docs/decisions/0001-index-libraries-in-elasticsearch.rst +++ b/openedx/core/djangoapps/content_libraries/docs/decisions/0001-index-libraries-in-elasticsearch.rst @@ -11,14 +11,14 @@ In Dec 2023, we decided to remove the code supporting this decision, because: * The index is disabled on edx.org, which will initially be the only user of Content Libraries V2. * As we migrate libraries from Modulestore to Blockstore and then from - Blockstore to Learning Core, the unused indexing code increases complexity + Blockstore to openedx_content, the unused indexing code increases complexity and decreases certainty. * With the decision to migrate from Blockstore-the-service to an in-process - storage backend (that is: Blockstore-the-app or Learning Core), it seems + storage backend (that is: Blockstore-the-app or openedx_content), it seems that we will be able to simply use Django ORM in order to filter/sort/search Content Library V2 metadata for the library listing page. * Searching Content Library V2 *block* content would still require indexing, - but we would rather implement that in Learning Core than use the current + but we would rather implement that in openedx_content than use the current implementation in the content_libraries app, which is untested, library- specific, and doesn't take into account library versioning. It always uses the latest draft, which is good for Library Authoring purposes, but not good for diff --git a/openedx/core/djangoapps/content_libraries/library_context.py b/openedx/core/djangoapps/content_libraries/library_context.py index e1f08ac328dc..7cba96e0da94 100644 --- a/openedx/core/djangoapps/content_libraries/library_context.py +++ b/openedx/core/djangoapps/content_libraries/library_context.py @@ -4,13 +4,10 @@ import logging from django.core.exceptions import PermissionDenied -from rest_framework.exceptions import NotFound - -from openedx_events.content_authoring.data import LibraryBlockData, LibraryContainerData -from openedx_events.content_authoring.signals import LIBRARY_BLOCK_UPDATED, LIBRARY_CONTAINER_UPDATED from opaque_keys.edx.keys import UsageKeyV2 -from opaque_keys.edx.locator import LibraryUsageLocatorV2, LibraryLocatorV2 -from openedx_learning.api import authoring as authoring_api +from opaque_keys.edx.locator import LibraryLocatorV2, LibraryUsageLocatorV2 +from openedx_content import api as content_api +from rest_framework.exceptions import NotFound from openedx.core.djangoapps.content_libraries import api, permissions from openedx.core.djangoapps.content_libraries.models import ContentLibrary @@ -24,7 +21,7 @@ class LibraryContextImpl(LearningContext): """ Implements content libraries as a learning context. - This is the *new* content libraries based on Learning Core, not the old content + This is the *new* content libraries based on openedx_content, not the old content libraries based on modulestore. """ @@ -96,40 +93,9 @@ def block_exists(self, usage_key: LibraryUsageLocatorV2): if learning_package is None: return False - return authoring_api.component_exists_by_key( + return content_api.component_exists_by_code( learning_package.id, namespace='xblock.v1', type_name=usage_key.block_type, - local_key=usage_key.block_id, - ) - - def send_block_updated_event(self, usage_key: UsageKeyV2): - """ - Send a "block updated" event for the library block with the given usage_key. - """ - assert isinstance(usage_key, LibraryUsageLocatorV2) - # .. event_implemented_name: LIBRARY_BLOCK_UPDATED - # .. event_type: org.openedx.content_authoring.library_block.updated.v1 - LIBRARY_BLOCK_UPDATED.send_event( - library_block=LibraryBlockData( - library_key=usage_key.lib_key, - usage_key=usage_key, - ) + component_code=usage_key.block_id, ) - - def send_container_updated_events(self, usage_key: UsageKeyV2): - """ - Send "container updated" events for containers that contains the library block - with the given usage_key. - """ - assert isinstance(usage_key, LibraryUsageLocatorV2) - affected_containers = api.get_containers_contains_item(usage_key) - for container in affected_containers: - # .. event_implemented_name: LIBRARY_CONTAINER_UPDATED - # .. event_type: org.openedx.content_authoring.content_library.container.updated.v1 - LIBRARY_CONTAINER_UPDATED.send_event( - library_container=LibraryContainerData( - container_key=container.container_key, - background=True, - ) - ) diff --git a/openedx/core/djangoapps/content_libraries/management/commands/content_libraries_import.py b/openedx/core/djangoapps/content_libraries/management/commands/content_libraries_import.py deleted file mode 100644 index cd68112d2b67..000000000000 --- a/openedx/core/djangoapps/content_libraries/management/commands/content_libraries_import.py +++ /dev/null @@ -1,146 +0,0 @@ -""" -Command to import modulestore content into Content Libraries. -""" - -import argparse -import logging - -from django.conf import settings -from django.core.management import BaseCommand, CommandError - -from opaque_keys.edx.keys import CourseKey -from opaque_keys.edx.locator import LibraryLocatorV2 -from openedx.core.djangoapps.content_libraries import api as contentlib_api - - -log = logging.getLogger(__name__) - - -class Command(BaseCommand): - """ - Import modulestore content references from a course into a Content Libraries - library. - """ - - def add_arguments(self, parser): - """ - Add arguments to the argument parser. - """ - parser.add_argument( - 'library-key', - type=LibraryLocatorV2.from_string, - help=('Usage key of the Content Library to import content into.'), - ) - parser.add_argument( - 'course-key', - type=CourseKey.from_string, - help=('The Course Key string, used to identify the course to import ' - 'content from.'), - ) - subparser = parser.add_subparsers( - title='Courseware location and methods', - dest='method', - description=('Select the method and location to locate the course and ' - 'its contents.') - ) - api_parser = subparser.add_parser( - 'api', - - help=('Query and retrieve course blocks from a remote instance using ' - 'Open edX course and OLX export APIs. You need to enable API access ' - 'on the instance.') - ) - api_parser.add_argument( - '--lms-url', - default=settings.LMS_ROOT_URL, - help=("The LMS URL, used to retrieve course content (default: " - "'%(default)s')."), - ) - api_parser.add_argument( - '--studio-url', - default=f"https://{settings.CMS_BASE}", - help=("The Studio URL, used to retrieve block OLX content (default: " - "'%(default)s')"), - ) - oauth_group = api_parser.add_mutually_exclusive_group(required=False) - oauth_group.add_argument( - '--oauth-creds-file', - type=argparse.FileType('r'), - help=('The edX OAuth credentials in a filename. The first line is ' - 'the OAuth key, second line is the OAuth secret. This is ' - 'preferred compared to passing the credentials in the command ' - 'line.'), - ) - oauth_group.add_argument( - '--oauth-creds', - nargs=2, - help=('The edX OAuth credentials in the command line. The first ' - 'argument is the OAuth secret, the second argument is the ' - 'OAuth key. Notice that command line arguments are insecure, ' - 'see `--oauth-creds-file`.'), - ) - subparser.add_parser( - 'modulestore', - help=("Use a local modulestore instance to retrieve blocks database on " - "the instance where the command is being run. You don't need " - "to enable API access.") - ) - - def handle(self, *args, **options): - """ - Collect all blocks from a course that are "importable" and write them to the - a learning core library. - """ - - # Search for the library. - - try: - contentlib_api.get_library(options['library-key']) - except contentlib_api.ContentLibraryNotFound as exc: - raise CommandError("The library specified does not exist: " - f"{options['library-key']}") from exc - - # Validate the method and its arguments, instantiate the openedx client. - - if options['method'] == 'api': - if options['oauth_creds_file']: - with options['oauth_creds_file'] as creds_f: - oauth_key, oauth_secret = [v.strip() for v in creds_f.readlines()] - elif options['oauth_creds']: - oauth_key, oauth_secret = options['oauth_creds'] - else: - raise CommandError("Method 'api' requires one of the " - "--oauth-* options, and none was specified.") - edx_client = contentlib_api.EdxApiImportClient( - options['lms_url'], - options['studio_url'], - oauth_key, - oauth_secret, - library_key=options['library-key'], - ) - elif options['method'] == 'modulestore': - edx_client = contentlib_api.EdxModulestoreImportClient( - library_key=options['library-key'], - ) - else: - raise CommandError(f"Method not supported: {options['method']}") - - failed_blocks = [] - - def on_progress(block_key, block_num, block_count, exception=None): - self.stdout.write(f"{block_num}/{block_count}: {block_key}: ", ending='') - # In case stdout is a term and line buffered: - self.stdout.flush() - if exception: - self.stdout.write(self.style.ERROR('❌')) - log.error('Failed to import block: %s', block_key, exc_info=exception) - failed_blocks.append(block_key) - else: - self.stdout.write(self.style.SUCCESS('✓')) - - edx_client.import_blocks_from_course(options['course-key'], on_progress) - - if failed_blocks: - self.stdout.write(self.style.ERROR(f"❌ {len(failed_blocks)} failed:")) - for key in failed_blocks: - self.stdout.write(self.style.ERROR(str(key))) diff --git a/openedx/core/djangoapps/content_libraries/migrations/0001_initial.py b/openedx/core/djangoapps/content_libraries/migrations/0001_initial.py index d36a4406c1ae..a5632c9706a9 100644 --- a/openedx/core/djangoapps/content_libraries/migrations/0001_initial.py +++ b/openedx/core/djangoapps/content_libraries/migrations/0001_initial.py @@ -1,9 +1,9 @@ # Generated by Django 1.11.23 on 2019-08-28 20:27 +import django.db.models.deletion from django.conf import settings from django.db import migrations, models -import django.db.models.deletion class Migration(migrations.Migration): diff --git a/openedx/core/djangoapps/content_libraries/migrations/0005_contentlibraryblockimporttask.py b/openedx/core/djangoapps/content_libraries/migrations/0005_contentlibraryblockimporttask.py index ab852cf14c7e..f31307ef2322 100644 --- a/openedx/core/djangoapps/content_libraries/migrations/0005_contentlibraryblockimporttask.py +++ b/openedx/core/djangoapps/content_libraries/migrations/0005_contentlibraryblockimporttask.py @@ -1,7 +1,7 @@ # Generated by Django 2.2.24 on 2021-07-16 23:20 -from django.db import migrations, models import django.db.models.deletion +from django.db import migrations, models from opaque_keys.edx.django.models import CourseKeyField diff --git a/openedx/core/djangoapps/content_libraries/migrations/0005_ltigradedresource_ltiprofile.py b/openedx/core/djangoapps/content_libraries/migrations/0005_ltigradedresource_ltiprofile.py index 71aa56683e5a..6066b533a5d8 100644 --- a/openedx/core/djangoapps/content_libraries/migrations/0005_ltigradedresource_ltiprofile.py +++ b/openedx/core/djangoapps/content_libraries/migrations/0005_ltigradedresource_ltiprofile.py @@ -1,8 +1,8 @@ # Generated by Django 2.2.20 on 2021-05-11 15:43 +import django.db.models.deletion from django.conf import settings from django.db import migrations, models -import django.db.models.deletion class Migration(migrations.Migration): diff --git a/openedx/core/djangoapps/content_libraries/migrations/0006_auto_20210615_1916.py b/openedx/core/djangoapps/content_libraries/migrations/0006_auto_20210615_1916.py index 672be651d82a..3cb0d68560c8 100644 --- a/openedx/core/djangoapps/content_libraries/migrations/0006_auto_20210615_1916.py +++ b/openedx/core/djangoapps/content_libraries/migrations/0006_auto_20210615_1916.py @@ -1,7 +1,7 @@ # Generated by Django 2.2.20 on 2021-06-15 19:16 -from django.db import migrations, models import django.db.models.deletion +from django.db import migrations, models class Migration(migrations.Migration): diff --git a/openedx/core/djangoapps/content_libraries/migrations/0008_auto_20210818_2148.py b/openedx/core/djangoapps/content_libraries/migrations/0008_auto_20210818_2148.py index 6c368dec24c4..126e3b0b8267 100644 --- a/openedx/core/djangoapps/content_libraries/migrations/0008_auto_20210818_2148.py +++ b/openedx/core/djangoapps/content_libraries/migrations/0008_auto_20210818_2148.py @@ -1,8 +1,8 @@ # Generated by Django 2.2.24 on 2021-08-18 21:48 -from django.db import migrations, models import django.db.models.deletion import opaque_keys.edx.django.models +from django.db import migrations, models class Migration(migrations.Migration): diff --git a/openedx/core/djangoapps/content_libraries/migrations/0010_contentlibrary_learning_package_and_more.py b/openedx/core/djangoapps/content_libraries/migrations/0010_contentlibrary_learning_package_and_more.py index 372f51de310c..84a96467d623 100644 --- a/openedx/core/djangoapps/content_libraries/migrations/0010_contentlibrary_learning_package_and_more.py +++ b/openedx/core/djangoapps/content_libraries/migrations/0010_contentlibrary_learning_package_and_more.py @@ -1,7 +1,7 @@ # Generated by Django 4.2.9 on 2024-02-14 18:26 -from django.db import migrations, models import django.db.models.deletion +from django.db import migrations, models class Migration(migrations.Migration): diff --git a/openedx/core/djangoapps/content_libraries/migrations/0013_remove_unused_lti_tool.py b/openedx/core/djangoapps/content_libraries/migrations/0013_remove_unused_lti_tool.py new file mode 100644 index 000000000000..10babdc058cf --- /dev/null +++ b/openedx/core/djangoapps/content_libraries/migrations/0013_remove_unused_lti_tool.py @@ -0,0 +1,42 @@ +# Generated by Django 5.2.12 on 2026-04-07 17:56 + +from django.db import migrations + + +class Migration(migrations.Migration): + + dependencies = [ + ('content_libraries', '0001_squashed_0012_switch_to_openedx_content'), + ] + + operations = [ + migrations.AlterUniqueTogether( + name='ltigradedresource', + unique_together=None, + ), + migrations.RemoveField( + model_name='ltigradedresource', + name='profile', + ), + migrations.AlterUniqueTogether( + name='ltiprofile', + unique_together=None, + ), + migrations.RemoveField( + model_name='ltiprofile', + name='user', + ), + migrations.RemoveField( + model_name='contentlibrary', + name='authorized_lti_configs', + ), + migrations.DeleteModel( + name='ContentLibraryBlockImportTask', + ), + migrations.DeleteModel( + name='LtiGradedResource', + ), + migrations.DeleteModel( + name='LtiProfile', + ), + ] diff --git a/openedx/core/djangoapps/content_libraries/models.py b/openedx/core/djangoapps/content_libraries/models.py index 415821145605..da994ca978b7 100644 --- a/openedx/core/djangoapps/content_libraries/models.py +++ b/openedx/core/djangoapps/content_libraries/models.py @@ -4,66 +4,34 @@ ======================== This module contains the models for new Content Libraries. - -LTI 1.3 Models -============== - -Content Libraries serves learning-core-based content through LTI 1.3 launches. -The interface supports resource link launches and grading services. Two use -cases justify the current data model to support LTI launches. They are: - -1. Authentication and authorization. This use case demands management of user - lifecycle to authorize access to content and grade submission, and it - introduces a model to own the authentication business logic related to LTI. - -2. Grade and assignments. When AGS is supported, content libraries store - additional information concerning the launched resource so that, once the - grading sub-system submits the score, it can retrieve them to propagate the - score update into the LTI platform's grade book. - -Relationship with LMS's ``lti_provider``` models ------------------------------------------------- - -The data model above is similar to the one provided by the current LTI 1.1 -implementation for modulestore and courseware content. But, Content Libraries -is orthogonal. Its use-case is to offer standalone, embedded content from a -specific backend (learning core). As such, it decouples from LTI 1.1. and the -logic assume no relationship or impact across the two applications. The same -reasoning applies to steps beyond the data model, such as at the XBlock -runtime, authentication, and score handling, etc. """ from __future__ import annotations -import contextlib import logging +import warnings from typing import ClassVar -import uuid from django.contrib.auth import get_user_model from django.contrib.auth.models import Group from django.core.exceptions import ValidationError from django.db import models -from django.db import transaction from django.utils.translation import gettext_lazy as _ - -from opaque_keys.edx.django.models import CourseKeyField from opaque_keys.edx.locator import LibraryLocatorV2 -from pylti1p3.contrib.django import DjangoDbToolConf -from pylti1p3.contrib.django import DjangoMessageLaunch -from pylti1p3.contrib.django.lti1p3_tool_config.models import LtiTool -from pylti1p3.grade import Grade +from openedx_content.models_api import LearningPackage +from organizations.models import Organization # pylint: disable=wrong-import-order -from opaque_keys.edx.django.models import UsageKeyField -from openedx.core.djangoapps.content_libraries.constants import ( - LICENSE_OPTIONS, ALL_RIGHTS_RESERVED, -) -from openedx_learning.api.authoring_models import LearningPackage -from organizations.models import Organization # lint-amnesty, pylint: disable=wrong-import-order +from openedx.core.djangoapps.content_libraries.constants import ALL_RIGHTS_RESERVED, LICENSE_OPTIONS -from .apps import ContentLibrariesConfig +log = logging.getLogger(__name__) -log = logging.getLogger(__name__) +warnings.warn( # noqa: B028 + ( + "ContentLibraryPermission model and related content library authorization " + "APIs are deprecated. See https://github.com/openedx/openedx-platform/issues/37409." + ), + DeprecationWarning +) User = get_user_model() @@ -72,7 +40,7 @@ class ContentLibraryManager(models.Manager["ContentLibrary"]): """ Custom manager for ContentLibrary class. """ - def get_by_key(self, library_key) -> "ContentLibrary": + def get_by_key(self, library_key) -> "ContentLibrary": # noqa: UP037 """ Get the ContentLibrary for the given LibraryLocatorV2 key. """ @@ -85,9 +53,9 @@ class ContentLibrary(models.Model): """ A Content Library is a collection of content (XBlocks and/or static assets) - All actual content is stored in Learning Core, and any data that we'd want to + All actual content is stored in openedx_content, and any data that we'd want to transfer to another instance if this library were exported and then - re-imported on another Open edX instance should be kept in Learning Core. This + re-imported on another Open edX instance should be kept in openedx_content. This model in Studio should only be used to track settings specific to this Open edX instance, like who has permission to edit this content library. @@ -136,15 +104,6 @@ class ContentLibrary(models.Model): """), ) - authorized_lti_configs = models.ManyToManyField( - LtiTool, - related_name='content_libraries', - help_text=("List of authorized LTI tool configurations that can access " - "this library's content through LTI launches, if empty no LTI " - "launch is allowed."), - blank=True, - ) - class Meta: verbose_name_plural = "Content Libraries" unique_together = ("org", "slug") @@ -156,30 +115,7 @@ def library_key(self): """ return LibraryLocatorV2(org=self.org.short_name, slug=self.slug) - @property - def allow_lti(self): - """ - True if there is at least one LTI tool configuration associated if this - library. - """ - return self.authorized_lti_configs.exists() - - @classmethod - def authorize_lti_launch(cls, library_key, *, issuer, client_id=None): - """ - Check if the given Issuer and Client ID are authorized to launch content - from this library. - """ - return (ContentLibrary - .objects - .filter(authorized_lti_configs__issuer=issuer, - authorized_lti_configs__client_id=client_id, - authorized_lti_configs__is_active=True, - org__short_name=library_key.org, - slug=library_key.slug) - .exists()) - - def __str__(self): + def __str__(self): # noqa: DJ012 return f"ContentLibrary ({str(self.library_key)})" @@ -187,6 +123,8 @@ class ContentLibraryPermission(models.Model): """ Row recording permissions for a content library + Deprecated https://github.com/openedx/openedx-platform/issues/37409. + .. no_pii: """ library = models.ForeignKey(ContentLibrary, on_delete=models.CASCADE, related_name="permission_grants") @@ -211,7 +149,7 @@ class Meta: ('library', 'group'), ] - def save(self, *args, **kwargs): # lint-amnesty, pylint: disable=arguments-differ, signature-differs + def save(self, *args, **kwargs): # pylint: disable=arguments-differ, signature-differs """ Validate any constraints on the model. @@ -223,330 +161,6 @@ def save(self, *args, **kwargs): # lint-amnesty, pylint: disable=arguments-diff raise ValidationError(_("One and only one of 'user' and 'group' must be set.")) return super().save(*args, **kwargs) - def __str__(self): + def __str__(self): # noqa: DJ012 who = self.user.username if self.user else self.group.name return f"ContentLibraryPermission ({self.access_level} for {who})" - - -class ContentLibraryBlockImportTask(models.Model): - """ - Model of a task to import blocks from an external source (e.g. modulestore). - - .. no_pii: - """ - - library = models.ForeignKey( - ContentLibrary, - on_delete=models.CASCADE, - related_name='import_tasks', - ) - - TASK_CREATED = 'created' - TASK_PENDING = 'pending' - TASK_RUNNING = 'running' - TASK_FAILED = 'failed' - TASK_SUCCESSFUL = 'successful' - - TASK_STATE_CHOICES = ( - (TASK_CREATED, _('Task was created, but not queued to run.')), - (TASK_PENDING, _('Task was created and queued to run.')), - (TASK_RUNNING, _('Task is running.')), - (TASK_FAILED, _('Task finished, but some blocks failed to import.')), - (TASK_SUCCESSFUL, _('Task finished successfully.')), - ) - - state = models.CharField( - choices=TASK_STATE_CHOICES, - default=TASK_CREATED, - max_length=30, - verbose_name=_('state'), - help_text=_('The state of the block import task.'), - ) - - progress = models.FloatField( - default=0.0, - verbose_name=_('progress'), - help_text=_('A float from 0.0 to 1.0 representing the task progress.'), - ) - - course_id = CourseKeyField( - max_length=255, - db_index=True, - verbose_name=_('course ID'), - help_text=_('ID of the imported course.'), - ) - - created_at = models.DateTimeField(auto_now_add=True) - - updated_at = models.DateTimeField(auto_now=True) - - class Meta: - ordering = ['-created_at', '-updated_at'] - - @classmethod - @contextlib.contextmanager - def execute(cls, import_task_id): - """ - A context manager to manage a task that is being executed. - """ - self = cls.objects.get(pk=import_task_id) - self.state = self.TASK_RUNNING - self.save() - try: - yield self - self.state = self.TASK_SUCCESSFUL - except: # pylint: disable=broad-except - self.state = self.TASK_FAILED - raise - finally: - self.save() - - def save_progress(self, progress): - self.progress = progress - self.save(update_fields=['progress', 'updated_at']) - - def __str__(self): - return f'{self.course_id} to {self.library} #{self.pk}' - - -class LtiProfileManager(models.Manager): - """ - Custom manager of LtiProfile mode. - """ - - def get_from_claims(self, *, iss, aud, sub): - """ - Get the an instance from a LTI launch claims. - """ - return self.get(platform_id=iss, client_id=aud, subject_id=sub) - - def get_or_create_from_claims(self, *, iss, aud, sub): - """ - Get or create an instance from a LTI launch claims. - """ - try: - return self.get_from_claims(iss=iss, aud=aud, sub=sub) - except self.model.DoesNotExist: - # User will be created on ``save()``. - return self.create(platform_id=iss, client_id=aud, subject_id=sub) - - -class LtiProfile(models.Model): - """ - Content Libraries LTI's profile for Open edX users. - - Unless Anonymous, this should be a unique representation of the LTI subject - (as per the client token ``sub`` identify claim) that initiated an LTI - launch through Content Libraries. - - .. no_pii: - """ - - objects = LtiProfileManager() - - user = models.OneToOneField( - get_user_model(), - null=True, - on_delete=models.CASCADE, - related_name='contentlibraries_lti_profile', - # Translators: 'Open edX' is a trademark, please keep this untranslated - verbose_name=_('open edx user'), - ) - - platform_id = models.CharField( - max_length=255, - verbose_name=_('lti platform identifier'), - help_text=_("The LTI platform identifier to which this profile belongs " - "to.") - ) - - client_id = models.CharField( - max_length=255, - verbose_name=_('client identifier'), - help_text=_("The LTI client identifier generated by the LTI platform.") - ) - - subject_id = models.CharField( - max_length=255, - verbose_name=_('subject identifier'), - help_text=_('Identifies the entity that initiated the launch request, ' - 'commonly a user.') - ) - - created_at = models.DateTimeField( - auto_now_add=True - ) - - class Meta: - unique_together = ['platform_id', 'client_id', 'subject_id'] - - @property - def subject_url(self): - """ - An local URL that is known to uniquely identify this profile. - - We take advantage of the fact that platform id is required to be an URL - and append paths with the reamaining keys to it. - """ - return '/'.join([ - self.platform_id.rstrip('/'), - self.client_id, - self.subject_id - ]) - - def save(self, *args, **kwds): - """ - Get or create an edx user on save. - """ - if not self.user: - uid = uuid.uuid5(uuid.NAMESPACE_URL, self.subject_url) - username = f'urn:openedx:content_libraries:username:{uid}' - email = f'{uid}@{ContentLibrariesConfig.name}' - with transaction.atomic(): - if self.user is None: - self.user, created = User.objects.get_or_create( - username=username, - defaults={'email': email}) - if created: - # LTI users can only auth throught LTI launches. - self.user.set_unusable_password() - self.user.save() - super().save(*args, **kwds) - - def __str__(self): - return self.subject_id - - -class LtiGradedResourceManager(models.Manager): - """ - A custom manager for the graded resources model. - """ - - def upsert_from_ags_launch(self, user, block, resource_endpoint, resource_link): - """ - Update or create a graded resource at AGS launch. - """ - resource_id = resource_link['id'] - resource_title = resource_link.get('title') or None - lineitem = resource_endpoint['lineitem'] - lti_profile = user.contentlibraries_lti_profile - resource, _ = self.update_or_create( - profile=lti_profile, - usage_key=block.scope_ids.usage_id, - defaults={'resource_title': resource_title, - 'resource_id': resource_id, - 'ags_lineitem': lineitem} - ) - return resource - - def get_from_user_id(self, user_id, **kwds): - """ - Retrieve a resource for a given user id holding an lti profile. - """ - try: - user = get_user_model().objects.get(pk=user_id) - except get_user_model().DoesNotExist as exc: - raise self.model.DoesNotExist('User specified was not found.') from exc - profile = getattr(user, 'contentlibraries_lti_profile', None) - if not profile: - raise self.model.DoesNotExist('User does not have a LTI profile.') - kwds['profile'] = profile - return self.get(**kwds) - - -class LtiGradedResource(models.Model): - """ - A content libraries resource launched through LTI with AGS enabled. - - Essentially, an instance of this model represents a successful LTI AGS - launch. This model links the profile that launched the resource with the - resource itself, allowing identifcation of the link through its usage key - string and user id. - - .. no_pii: - """ - - objects = LtiGradedResourceManager() - - profile = models.ForeignKey( - LtiProfile, - on_delete=models.CASCADE, - related_name='lti_resources', - help_text=_('The authorized LTI profile that launched the resource ' - '(identifies the user).')) - - usage_key = UsageKeyField( - max_length=255, - help_text=_('The usage key string of the resource serving the ' - 'content of this launch.'), - ) - - resource_id = models.CharField( - max_length=255, - help_text=_('The LTI platform unique identifier of this resource, also ' - 'known as the "resource link id".'), - ) - - resource_title = models.CharField( - max_length=255, - null=True, - help_text=_('The LTI platform descriptive title for this resource.'), - ) - - ags_lineitem = models.CharField( - max_length=255, - null=False, - help_text=_('If AGS was enabled during launch, this should hold the ' - 'lineitem ID.')) - - class Meta: - unique_together = (['usage_key', 'profile']) - - def update_score(self, weighted_earned, weighted_possible, timestamp): - """ - Use LTI's score service to update the LTI platform's gradebook. - - This method synchronously send a request to the LTI platform to update - the assignment score. - """ - - launch_data = { - 'iss': self.profile.platform_id, - 'aud': self.profile.client_id, - 'https://purl.imsglobal.org/spec/lti-ags/claim/endpoint': { - 'lineitem': self.ags_lineitem, - 'scope': { - 'https://purl.imsglobal.org/spec/lti-ags/scope/lineitem', - 'https://purl.imsglobal.org/spec/lti-ags/scope/score', - } - } - } - - tool_config = DjangoDbToolConf() - - ags = ( - DjangoMessageLaunch(request=None, tool_config=tool_config) - .set_auto_validation(enable=False) - .set_jwt({'body': launch_data}) - .set_restored() - .validate_registration() - .get_ags() - ) - - if weighted_possible == 0: - weighted_score = 0 - else: - weighted_score = float(weighted_earned) / float(weighted_possible) - - ags.put_grade( - Grade() - .set_score_given(weighted_score) - .set_score_maximum(1) - .set_timestamp(timestamp.isoformat()) - .set_activity_progress('Submitted') - .set_grading_progress('FullyGraded') - .set_user_id(self.profile.subject_id) - ) - - def __str__(self): - return str(self.usage_key) diff --git a/openedx/core/djangoapps/content_libraries/permissions.py b/openedx/core/djangoapps/content_libraries/permissions.py index c3a8b68c947c..1d0c7f9c0544 100644 --- a/openedx/core/djangoapps/content_libraries/permissions.py +++ b/openedx/core/djangoapps/content_libraries/permissions.py @@ -1,11 +1,13 @@ """ -Permissions for Content Libraries (v2, Learning-Core-based) +Permissions for Content Libraries (v2, openedx_content-based) + +Deprecated: The legacy permission rules and constants that rely on ContentLibraryPermission +are deprecated in favor of openedx-authz. See https://github.com/openedx/openedx-platform/issues/37409. """ from bridgekeeper import perms, rules -from bridgekeeper.rules import Attribute, ManyRelation, Relation, blanket_rule, in_current_groups, Rule +from bridgekeeper.rules import Attribute, ManyRelation, Relation, Rule, blanket_rule, in_current_groups from django.conf import settings from django.db.models import Q - from openedx_authz import api as authz_api from openedx_authz.constants.permissions import VIEW_LIBRARY diff --git a/openedx/core/djangoapps/content_libraries/rest_api/blocks.py b/openedx/core/djangoapps/content_libraries/rest_api/blocks.py index e72980f6ba0d..73c0f574ca50 100644 --- a/openedx/core/djangoapps/content_libraries/rest_api/blocks.py +++ b/openedx/core/djangoapps/content_libraries/rest_api/blocks.py @@ -1,16 +1,19 @@ """ Content Library REST APIs related to XBlocks/Components and their static assets """ +from uuid import UUID + import edx_api_doc_tools as apidocs +from django.conf import settings from django.core.exceptions import ObjectDoesNotExist from django.db.transaction import non_atomic_requests from django.http import Http404, HttpResponse, StreamingHttpResponse -from django.urls import reverse from django.utils.decorators import method_decorator from drf_yasg.utils import swagger_auto_schema -from opaque_keys.edx.locator import LibraryLocatorV2, LibraryUsageLocatorV2 +from opaque_keys import InvalidKeyError +from opaque_keys.edx.locator import LibraryContainerLocator, LibraryLocatorV2, LibraryUsageLocatorV2 from openedx_authz.constants import permissions as authz_permissions -from openedx_learning.api import authoring as authoring_api +from openedx_content import api as content_api from rest_framework import status from rest_framework.exceptions import NotFound, ValidationError from rest_framework.generics import GenericAPIView @@ -18,6 +21,7 @@ from rest_framework.response import Response from rest_framework.views import APIView +import openedx.core.djangoapps.site_configuration.helpers as configuration_helpers from openedx.core.djangoapps.content_libraries import api, permissions from openedx.core.djangoapps.content_libraries.rest_api import serializers from openedx.core.djangoapps.xblock import api as xblock_api @@ -89,7 +93,7 @@ def post(self, request, lib_key_str): try: result = api.create_library_block(library_key, user_id=request.user.id, **serializer.validated_data) except api.IncompatibleTypesError as err: - raise ValidationError( # lint-amnesty, pylint: disable=raise-missing-from + raise ValidationError( # pylint: disable=raise-missing-from # noqa: B904 detail={'block_type': str(err)}, ) @@ -140,6 +144,120 @@ def delete(self, request, usage_key_str): # pylint: disable=unused-argument return Response({}) +@method_decorator(non_atomic_requests, name="dispatch") +@view_auth_classes() +class LibraryComponentDraftHistoryView(APIView): + """ + View to get the draft change history of a library component. + """ + serializer_class = serializers.LibraryHistoryEntrySerializer + + @convert_exceptions + def get(self, request, usage_key_str): + """ + Get the draft change history for a library component since its last publication. + """ + key = LibraryUsageLocatorV2.from_string(usage_key_str) + api.require_permission_for_library_key(key.lib_key, request.user, permissions.CAN_VIEW_THIS_CONTENT_LIBRARY) + history = api.get_library_component_draft_history(key, request=request) + return Response(self.serializer_class(history, many=True).data) + + +@method_decorator(non_atomic_requests, name="dispatch") +@view_auth_classes() +class LibraryComponentPublishHistoryView(APIView): + """ + View to get the publish history of a library component as a list of publish events. + """ + serializer_class = serializers.LibraryPublishHistoryGroupSerializer + + @convert_exceptions + def get(self, request, usage_key_str): + """ + Get the publish history for a library component, ordered most-recent-first. + """ + key = LibraryUsageLocatorV2.from_string(usage_key_str) + api.require_permission_for_library_key(key.lib_key, request.user, permissions.CAN_VIEW_THIS_CONTENT_LIBRARY) + history = api.get_library_component_publish_history(key, request=request) + return Response(self.serializer_class(history, many=True).data) + + +@method_decorator(non_atomic_requests, name="dispatch") +@view_auth_classes() +class LibraryPublishHistoryEntriesView(APIView): + """ + Unified view to get individual draft change entries for a specific publish event. + + Accepts any library entity key (component usage_key or container key) via the + scope_entity_key query parameter and routes to the appropriate API function. + + For containers, scope_entity_key identifies the container being viewed — not + necessarily the entity that was directly published. In Post-Verawood a parent + container may have been directly published, but scope_entity_key is the child + Unit the user is currently browsing. + """ + serializer_class = serializers.LibraryHistoryEntrySerializer + + @convert_exceptions + def get(self, request, lib_key_str): + """ + Get the draft change entries for a specific publish event, ordered most-recent-first. + + Query parameters: + - scope_entity_key: the usage_key (component) or container_key (scope container) + - publish_log_uuid: UUID of the publish event + """ + lib_key = LibraryLocatorV2.from_string(lib_key_str) + api.require_permission_for_library_key(lib_key, request.user, permissions.CAN_VIEW_THIS_CONTENT_LIBRARY) + scope_entity_key_str = request.query_params.get("scope_entity_key", "") + publish_log_uuid_str = request.query_params.get("publish_log_uuid", "") + if not scope_entity_key_str or not publish_log_uuid_str: + return Response({"error": "scope_entity_key and publish_log_uuid are required."}, status=400) + try: + publish_log_uuid = UUID(publish_log_uuid_str) + except ValueError: + return Response({"error": f"Invalid publish_log_uuid: {publish_log_uuid_str!r}"}, status=400) + + try: + usage_key = LibraryUsageLocatorV2.from_string(scope_entity_key_str) + entries = api.get_library_component_publish_history_entries( + usage_key, publish_log_uuid, request=request + ) + except ObjectDoesNotExist: + entries = [] + except (InvalidKeyError, AttributeError): + try: + container_key = LibraryContainerLocator.from_string(scope_entity_key_str) + entries = api.get_library_container_publish_history_entries( + container_key, publish_log_uuid, request=request + ) + except (InvalidKeyError, AttributeError): + return Response({"error": f"Invalid scope_entity_key: {scope_entity_key_str!r}"}, status=400) + + return Response(self.serializer_class(entries, many=True).data) + + +@method_decorator(non_atomic_requests, name="dispatch") +@view_auth_classes() +class LibraryComponentCreationEntryView(APIView): + """ + View to get the creation entry for a library component. + """ + serializer_class = serializers.LibraryHistoryEntrySerializer + + @convert_exceptions + def get(self, request, usage_key_str): + """ + Get the creation entry for a library component (the moment it was first saved). + """ + key = LibraryUsageLocatorV2.from_string(usage_key_str) + api.require_permission_for_library_key(key.lib_key, request.user, permissions.CAN_VIEW_THIS_CONTENT_LIBRARY) + entry = api.get_library_component_creation_entry(key, request=request) + if entry is None: + return Response(None) + return Response(self.serializer_class(entry).data) + + @method_decorator(non_atomic_requests, name="dispatch") @view_auth_classes() class LibraryBlockAssetListView(APIView): @@ -194,7 +312,7 @@ def put(self, request, usage_key_str, file_path): file_wrapper = request.data['content'] if file_wrapper.size > 20 * 1024 * 1024: # > 20 MiB # TODO: This check was written when V2 Libraries were backed by the Blockstore micro-service. - # Now that we're on Learning Core, do we still need it? Here's the original comment: + # Now that we're on openedx_content, do we still need it? Here's the original comment: # In the future, we need a way to use file_wrapper.chunks() to read # the file in chunks and stream that to Blockstore, but Blockstore # currently lacks an API for streaming file uploads. @@ -204,7 +322,7 @@ def put(self, request, usage_key_str, file_path): try: result = api.add_library_block_static_asset_file(usage_key, file_path, file_content, request.user) except ValueError: - raise ValidationError("Invalid file path") # lint-amnesty, pylint: disable=raise-missing-from + raise ValidationError("Invalid file path") # pylint: disable=raise-missing-from # noqa: B904 return Response(self.serializer_class(result).data) @convert_exceptions @@ -219,7 +337,7 @@ def delete(self, request, usage_key_str, file_path): try: api.delete_library_block_static_asset_file(usage_key, file_path, request.user) except ValueError: - raise ValidationError("Invalid file path") # lint-amnesty, pylint: disable=raise-missing-from + raise ValidationError("Invalid file path") # pylint: disable=raise-missing-from # noqa: B904 return Response(status=status.HTTP_204_NO_CONTENT) @@ -271,7 +389,7 @@ def patch(self, request: RestRequest, usage_key_str) -> Response: collection_keys = serializer.validated_data['collection_keys'] api.set_library_item_collections( library_key=key.lib_key, - entity_key=component.publishable_entity.key, + entity_ref=component.publishable_entity.entity_ref, collection_keys=collection_keys, created_by=request.user.id, content_library=content_library, @@ -280,28 +398,6 @@ def patch(self, request: RestRequest, usage_key_str) -> Response: return Response({'count': len(collection_keys)}) -@method_decorator(non_atomic_requests, name="dispatch") -@view_auth_classes() -class LibraryBlockLtiUrlView(APIView): - """ - Views to generate LTI URL for existing XBlocks in a content library. - - Returns 404 in case the block not found by the given key. - """ - @convert_exceptions - def get(self, request, usage_key_str): - """ - Get the LTI launch URL for the XBlock. - """ - key = LibraryUsageLocatorV2.from_string(usage_key_str) - api.require_permission_for_library_key(key.lib_key, request.user, permissions.CAN_VIEW_THIS_CONTENT_LIBRARY) - - # Get the block to validate its existence - api.get_library_block(key) - lti_login_url = f"{reverse('content_libraries:lti-launch')}?id={key}" - return Response({"lti_url": lti_login_url}) - - @method_decorator(non_atomic_requests, name="dispatch") @view_auth_classes() class LibraryBlockOlxView(APIView): @@ -337,9 +433,9 @@ def post(self, request, usage_key_str): serializer.is_valid(raise_exception=True) new_olx_str = serializer.validated_data["olx"] try: - version_num = api.set_library_block_olx(key, new_olx_str).version_num + version_num = api.set_library_block_olx(key, new_olx_str, created_by=request.user.id).version_num except ValueError as err: - raise ValidationError(detail=str(err)) # lint-amnesty, pylint: disable=raise-missing-from + raise ValidationError(detail=str(err)) # pylint: disable=raise-missing-from # noqa: B904 return Response(self.serializer_class({"olx": new_olx_str, "version_num": version_num}).data) @@ -392,7 +488,7 @@ def get_component_version_asset(request, component_version_uuid, asset_path): eventually). """ try: - component_version = authoring_api.get_component_version_by_uuid( + component_version = content_api.get_component_version_by_uuid( component_version_uuid ) except ObjectDoesNotExist as exc: @@ -400,18 +496,18 @@ def get_component_version_asset(request, component_version_uuid, asset_path): # Permissions check... learning_package = component_version.component.learning_package - library_key = LibraryLocatorV2.from_string(learning_package.key) + library_key = LibraryLocatorV2.from_string(learning_package.package_ref) api.require_permission_for_library_key( library_key, request.user, permissions.CAN_VIEW_THIS_CONTENT_LIBRARY, ) # We already have logic for getting the correct content and generating the - # proper headers in Learning Core, but the response generated here is an + # proper headers in openedx_content, but the response generated here is an # X-Accel-Redirect and lacks the actual content. We eventually want to use # this response in conjunction with a media reverse proxy (Caddy or Nginx), # but in the short term we're just going to remove the redirect and stream # the content directly. - redirect_response = authoring_api.get_redirect_response_for_component_asset( + redirect_response = content_api.get_redirect_response_for_component_asset( component_version_uuid, asset_path, public=False, @@ -423,8 +519,8 @@ def get_component_version_asset(request, component_version_uuid, asset_path): return redirect_response # If we got here, we know that the asset exists and it's okay to download. - cv_content = component_version.componentversioncontent_set.get(key=asset_path) - content = cv_content.content + cv_media = component_version.componentversionmedia_set.get(path=asset_path) + media = cv_media.media # Delete the re-direct part of the response headers. We'll copy the rest. headers = redirect_response.headers @@ -433,7 +529,14 @@ def get_component_version_asset(request, component_version_uuid, asset_path): # We need to set the content size header manually because this is a # streaming response. It's not included in the redirect headers because it's # not needed there (the reverse-proxy would have direct access to the file). - headers['Content-Length'] = content.size + headers['Content-Length'] = media.size + + # Some assets, such as PDFs, need to be embedded in an iFrame in the MFE + # studio. Permit this, so long as the file is in the cors_origin_whitelist. + cors_origin_whitelist = configuration_helpers.get_value( + 'CORS_ORIGIN_WHITELIST', getattr(settings, 'CORS_ORIGIN_WHITELIST', []), + ) + headers["Content-Security-Policy"] = f"frame-ancestors 'self' {' '.join(cors_origin_whitelist)};" if request.method == "HEAD": return HttpResponse(headers=headers) @@ -442,7 +545,7 @@ def get_component_version_asset(request, component_version_uuid, asset_path): # offsets or anything fancy, because we don't expect to run this view at # LMS-scale. return StreamingHttpResponse( - content.read_file().chunks(), + media.read_file().chunks(), headers=redirect_response.headers, ) diff --git a/openedx/core/djangoapps/content_libraries/rest_api/collections.py b/openedx/core/djangoapps/content_libraries/rest_api/collections.py index f4d579aa04a2..9875f31d79d5 100644 --- a/openedx/core/djangoapps/content_libraries/rest_api/collections.py +++ b/openedx/core/djangoapps/content_libraries/rest_api/collections.py @@ -3,29 +3,28 @@ """ from __future__ import annotations +from django.db import transaction from django.db.models import QuerySet from django.utils.text import slugify -from django.db import transaction - +from opaque_keys.edx.locator import LibraryLocatorV2 +from openedx_authz.constants import permissions as authz_permissions +from openedx_content import api as content_api +from openedx_content.models_api import Collection from rest_framework.decorators import action from rest_framework.response import Response -from rest_framework.viewsets import ModelViewSet from rest_framework.status import HTTP_204_NO_CONTENT +from rest_framework.viewsets import ModelViewSet -from opaque_keys.edx.locator import LibraryLocatorV2 -from openedx_authz.constants import permissions as authz_permissions -from openedx_learning.api import authoring as authoring_api -from openedx_learning.api.authoring_models import Collection +from openedx.core.types.http import RestRequest from .. import api, permissions from ..models import ContentLibrary -from .utils import convert_exceptions from .serializers import ( ContentLibraryCollectionSerializer, ContentLibraryCollectionUpdateSerializer, ContentLibraryItemKeysSerializer, ) -from openedx.core.types.http import RestRequest +from .utils import convert_exceptions class LibraryCollectionsView(ModelViewSet): @@ -34,7 +33,10 @@ class LibraryCollectionsView(ModelViewSet): """ serializer_class = ContentLibraryCollectionSerializer - lookup_field = 'key' + # URL kwarg is `key` for backwards compatibility. + # https://github.com/openedx/openedx-platform/issues/38406 + lookup_field = 'collection_code' + lookup_url_kwarg = 'key' def __init__(self, *args, **kwargs) -> None: """ @@ -72,7 +74,7 @@ def get_queryset(self) -> QuerySet[Collection]: """ content_library = self.get_content_library() assert content_library.learning_package_id - return authoring_api.get_collections(content_library.learning_package_id) + return content_api.get_collections(content_library.learning_package_id) def get_object(self) -> Collection: """ @@ -183,9 +185,9 @@ def destroy(self, request: RestRequest, *args, **kwargs) -> Response: ) collection = super().get_object() assert collection.learning_package_id - authoring_api.delete_collection( + content_api.delete_collection( collection.learning_package_id, - collection.key, + collection.collection_code, hard_delete=False, ) return Response(None, status=HTTP_204_NO_CONTENT) @@ -204,7 +206,7 @@ def restore(self, request: RestRequest, *args, **kwargs) -> Response: ) assert content_library.learning_package_id collection_key = kwargs["key"] - authoring_api.restore_collection( + content_api.restore_collection( content_library.learning_package_id, collection_key, ) diff --git a/openedx/core/djangoapps/content_libraries/rest_api/containers.py b/openedx/core/djangoapps/content_libraries/rest_api/containers.py index c60c40b9802d..6a63a723ed3a 100644 --- a/openedx/core/djangoapps/content_libraries/rest_api/containers.py +++ b/openedx/core/djangoapps/content_libraries/rest_api/containers.py @@ -8,15 +8,16 @@ from django.contrib.auth import get_user_model from django.db.transaction import non_atomic_requests from django.utils.decorators import method_decorator -from drf_yasg.utils import swagger_auto_schema from drf_yasg import openapi - -from opaque_keys.edx.locator import LibraryLocatorV2, LibraryContainerLocator +from drf_yasg.utils import swagger_auto_schema +from opaque_keys.edx.locator import LibraryContainerLocator, LibraryLocatorV2 from openedx_authz.constants import permissions as authz_permissions -from openedx_learning.api import authoring as authoring_api +from openedx_content import api as content_api +from openedx_content import models_api as content_models from rest_framework.generics import GenericAPIView from rest_framework.response import Response -from rest_framework.status import HTTP_204_NO_CONTENT, HTTP_200_OK +from rest_framework.status import HTTP_200_OK, HTTP_204_NO_CONTENT +from rest_framework.views import APIView from openedx.core.djangoapps.content_libraries import api, permissions from openedx.core.lib.api.view_utils import view_auth_classes @@ -51,10 +52,10 @@ def post(self, request, lib_key_str): serializer = serializers.LibraryContainerMetadataSerializer(data=request.data) serializer.is_valid(raise_exception=True) - container_type = serializer.validated_data['container_type'] + container_type_code = serializer.validated_data['container_type_code'] container = api.create_container( library_key, - container_type, + container_cls=content_api.get_container_subclass(container_type_code), title=serializer.validated_data['display_name'], slug=serializer.validated_data.get('slug'), user_id=request.user.id, @@ -190,7 +191,7 @@ def get(self, request, container_key: LibraryContainerLocator): permissions.CAN_VIEW_THIS_CONTENT_LIBRARY, ) child_entities = api.get_container_children(container_key, published=published) - if container_key.container_type == api.ContainerType.Unit.value: + if container_key.container_type == content_models.Unit.type_code: data = serializers.LibraryXBlockMetadataSerializer(child_entities, many=True).data else: data = serializers.LibraryContainerMetadataSerializer(child_entities, many=True).data @@ -200,7 +201,7 @@ def _update_component_children( self, request, container_key: LibraryContainerLocator, - action: authoring_api.ChildrenEntitiesAction, + action: content_api.ChildrenEntitiesAction, ): """ Helper function to update children in container. @@ -215,7 +216,7 @@ def _update_component_children( container = api.update_container_children( container_key, - children_ids=serializer.validated_data["usage_keys"], + children_keys=serializer.validated_data["usage_keys"], user_id=request.user.id, entities_action=action, ) @@ -237,7 +238,7 @@ def post(self, request, container_key: LibraryContainerLocator): return self._update_component_children( request, container_key, - action=authoring_api.ChildrenEntitiesAction.APPEND, + action=content_api.ChildrenEntitiesAction.APPEND, ) @convert_exceptions @@ -256,7 +257,7 @@ def delete(self, request, container_key: LibraryContainerLocator): return self._update_component_children( request, container_key, - action=authoring_api.ChildrenEntitiesAction.REMOVE, + action=content_api.ChildrenEntitiesAction.REMOVE, ) @convert_exceptions @@ -275,7 +276,7 @@ def patch(self, request, container_key: LibraryContainerLocator): return self._update_component_children( request, container_key, - action=authoring_api.ChildrenEntitiesAction.REPLACE, + action=content_api.ChildrenEntitiesAction.REPLACE, ) @@ -346,7 +347,7 @@ def patch(self, request: RestRequest, container_key: LibraryContainerLocator) -> collection_keys = serializer.validated_data['collection_keys'] api.set_library_item_collections( library_key=container_key.lib_key, - entity_key=container_key.container_id, + entity_ref=container_key.container_id, collection_keys=collection_keys, created_by=request.user.id, content_library=content_library, @@ -436,3 +437,76 @@ def get(self, request: RestRequest, container_key: LibraryContainerLocator) -> R ) hierarchy = api.get_library_object_hierarchy(container_key) return Response(self.serializer_class(hierarchy).data) + + +@method_decorator(non_atomic_requests, name="dispatch") +@view_auth_classes() +class LibraryContainerDraftHistoryView(GenericAPIView): + """ + View to get the draft change history of a library container. + """ + serializer_class = serializers.LibraryHistoryEntrySerializer + + @convert_exceptions + def get(self, request: RestRequest, container_key: LibraryContainerLocator) -> Response: + """ + Get the draft change history for a library containers since its last publication. + """ + api.require_permission_for_library_key( + container_key.lib_key, + request.user, + permissions.CAN_VIEW_THIS_CONTENT_LIBRARY, + ) + history = api.get_library_container_draft_history(container_key, request=request) + return Response(self.serializer_class(history, many=True).data) + + +@method_decorator(non_atomic_requests, name="dispatch") +@view_auth_classes() +class LibraryContainerPublishHistoryView(GenericAPIView): + """ + View to get the publish history of a library container as a list of publish events. + """ + serializer_class = serializers.LibraryPublishHistoryGroupSerializer + + @convert_exceptions + def get(self, request: RestRequest, container_key: LibraryContainerLocator) -> Response: + """ + Get the publish history for a library container, ordered most-recent-first. + + Each group in the response represents one publish event for one entity + (the container itself or a descendant component). Use entity_key from each + group together with the publish_history_entries/ endpoint to fetch the + individual draft change entries for that group. + """ + api.require_permission_for_library_key( + container_key.lib_key, + request.user, + permissions.CAN_VIEW_THIS_CONTENT_LIBRARY, + ) + history = api.get_library_container_publish_history(container_key, request=request) + return Response(self.serializer_class(history, many=True).data) + + +@method_decorator(non_atomic_requests, name="dispatch") +@view_auth_classes() +class LibraryContainerCreationEntryView(APIView): + """ + View to get the creation entry for a library container. + """ + serializer_class = serializers.LibraryHistoryEntrySerializer + + @convert_exceptions + def get(self, request: RestRequest, container_key: LibraryContainerLocator) -> Response: + """ + Get the creation entry for a library container (the moment it was first saved). + """ + api.require_permission_for_library_key( + container_key.lib_key, + request.user, + permissions.CAN_VIEW_THIS_CONTENT_LIBRARY, + ) + entry = api.get_library_container_creation_entry(container_key, request=request) + if entry is None: + return Response(None) + return Response(self.serializer_class(entry).data) diff --git a/openedx/core/djangoapps/content_libraries/rest_api/libraries.py b/openedx/core/djangoapps/content_libraries/rest_api/libraries.py index 2d50fa6c8644..3db1213604f4 100644 --- a/openedx/core/djangoapps/content_libraries/rest_api/libraries.py +++ b/openedx/core/djangoapps/content_libraries/rest_api/libraries.py @@ -3,7 +3,7 @@ Content Libraries Views ======================= -This module contains the REST APIs for Learning Core-based content libraries, +This module contains the REST APIs for openedx_content-based content libraries, and LTI 1.3 views (though I'm not sure how functional the LTI piece of this is right now). @@ -59,56 +59,41 @@ Historical note: These views used to be wrapped with @atomic because we wanted to make all views that operated on Blockstore (the predecessor - to Learning Core) atomic: + to openedx_content) atomic: https://github.com/openedx/edx-platform/pull/30456 """ -import itertools -import json import logging +import warnings import edx_api_doc_tools as apidocs -from django.conf import settings -from django.contrib.auth import authenticate, get_user_model, login +from django.contrib.auth import get_user_model from django.contrib.auth.models import Group from django.db.transaction import atomic, non_atomic_requests -from django.http import Http404, HttpResponseBadRequest, JsonResponse from django.shortcuts import get_object_or_404 from django.utils.decorators import method_decorator from django.utils.translation import gettext as _ -from django.views.decorators.clickjacking import xframe_options_exempt -from django.views.decorators.csrf import csrf_exempt -from django.views.generic.base import TemplateResponseMixin, View from drf_yasg.utils import swagger_auto_schema -from user_tasks.models import UserTaskStatus - from opaque_keys.edx.locator import LibraryLocatorV2, LibraryUsageLocatorV2 from openedx_authz.constants import permissions as authz_permissions from organizations.api import ensure_organization from organizations.exceptions import InvalidOrganizationException from organizations.models import Organization -from pylti1p3.contrib.django import DjangoCacheDataStorage, DjangoDbToolConf, DjangoMessageLaunch, DjangoOIDCLogin -from pylti1p3.exception import LtiException, OIDCException from rest_framework import status from rest_framework.exceptions import NotFound, PermissionDenied, ValidationError from rest_framework.generics import GenericAPIView from rest_framework.response import Response from rest_framework.views import APIView -from rest_framework.viewsets import GenericViewSet +from user_tasks.models import UserTaskStatus -import openedx.core.djangoapps.site_configuration.helpers as configuration_helpers +from cms.djangoapps.contentstore.storage import course_import_export_storage from cms.djangoapps.contentstore.views.course import ( get_allowed_organizations_for_libraries, - user_can_create_organizations + user_can_create_organizations, ) -from cms.djangoapps.contentstore.storage import course_import_export_storage -from openedx.core.djangoapps.content_libraries.tasks import restore_library - from openedx.core.djangoapps.content_libraries import api, permissions from openedx.core.djangoapps.content_libraries.api.libraries import get_backup_task_status from openedx.core.djangoapps.content_libraries.rest_api.serializers import ( ContentLibraryAddPermissionByEmailSerializer, - ContentLibraryBlockImportTaskCreateSerializer, - ContentLibraryBlockImportTaskSerializer, ContentLibraryFilterSerializer, ContentLibraryMetadataSerializer, ContentLibraryPermissionLevelSerializer, @@ -122,20 +107,26 @@ LibraryXBlockCreationSerializer, LibraryXBlockMetadataSerializer, LibraryXBlockTypeSerializer, - PublishableItemSerializer + PublishableItemSerializer, ) -from openedx.core.djangoapps.content_libraries.tasks import backup_library -from openedx.core.djangoapps.safe_sessions.middleware import mark_user_change_as_expected -from openedx.core.djangoapps.xblock import api as xblock_api +from openedx.core.djangoapps.content_libraries.tasks import backup_library, restore_library from openedx.core.lib.api.view_utils import view_auth_classes -from ..models import ContentLibrary, LtiGradedResource, LtiProfile from .utils import convert_exceptions User = get_user_model() log = logging.getLogger(__name__) +warnings.warn( # noqa: B028 + ( + "Content library team authorization REST APIs are deprecated. " + "See https://github.com/openedx/openedx-platform/issues/37409." + ), + DeprecationWarning +) + + class LibraryApiPaginationDocs: """ API docs for query params related to paginating ContentLibraryMetadata objects. @@ -236,7 +227,7 @@ def post(self, request): try: ensure_organization(org_name) except InvalidOrganizationException: - raise ValidationError( # lint-amnesty, pylint: disable=raise-missing-from + raise ValidationError( # pylint: disable=raise-missing-from # noqa: B904 detail={"org": f"No such organization '{org_name}' found."} ) # Ensure the user is allowed to create libraries under this org @@ -244,7 +235,7 @@ def post(self, request): user_can_create_organizations(request.user) or org_name in get_allowed_organizations_for_libraries(request.user) ): - raise ValidationError( # lint-amnesty, pylint: disable=raise-missing-from + raise ValidationError( # pylint: disable=raise-missing-from detail={"org": f"User not allowed to create libraries in '{org_name}'."} ) org = Organization.objects.get(short_name=org_name) @@ -261,7 +252,7 @@ def post(self, request): # users can then manage roles for others. api.assign_library_role_to_user(result.key, request.user, api.AccessLevel.ADMIN_LEVEL) except api.LibraryAlreadyExists: - raise ValidationError(detail={"slug": "A library with that ID already exists."}) # lint-amnesty, pylint: disable=raise-missing-from + raise ValidationError(detail={"slug": "A library with that ID already exists."}) # pylint: disable=raise-missing-from # noqa: B904 return Response(ContentLibraryMetadataSerializer(result).data) @@ -299,7 +290,7 @@ def patch(self, request, lib_key_str): try: api.update_library(key, **data) except api.IncompatibleTypesError as err: - raise ValidationError({'type': str(err)}) # lint-amnesty, pylint: disable=raise-missing-from + raise ValidationError({'type': str(err)}) # pylint: disable=raise-missing-from # noqa: B904 result = api.get_library(key) return Response(ContentLibraryMetadataSerializer(result).data) @@ -323,6 +314,8 @@ class LibraryTeamView(APIView): Note also the 'allow_public_' settings which can be edited by PATCHing the library itself (LibraryDetailsView.patch). + + Deprecated https://github.com/openedx/openedx-platform/issues/37409 """ @convert_exceptions def post(self, request, lib_key_str): @@ -330,6 +323,12 @@ def post(self, request, lib_key_str): Add a user to this content library via email, with permissions specified in the request body. """ + warnings.warn( + "LibraryTeamView is deprecated. Use RoleUserAPIView from openedx-authz instead.", + DeprecationWarning, + stacklevel=2, + ) + key = LibraryLocatorV2.from_string(lib_key_str) api.require_permission_for_library_key(key, request.user, permissions.CAN_EDIT_THIS_CONTENT_LIBRARY_TEAM) serializer = ContentLibraryAddPermissionByEmailSerializer(data=request.data) @@ -337,7 +336,7 @@ def post(self, request, lib_key_str): try: user = User.objects.get(email=serializer.validated_data.get('email')) except User.DoesNotExist: - raise ValidationError({'email': _('We could not find a user with that email address.')}) # lint-amnesty, pylint: disable=raise-missing-from + raise ValidationError({'email': _('We could not find a user with that email address.')}) # pylint: disable=raise-missing-from # noqa: B904 grant = api.get_library_user_permissions(key, user) if grant: return Response( @@ -347,7 +346,7 @@ def post(self, request, lib_key_str): try: api.set_library_user_permissions(key, user, access_level=serializer.validated_data["access_level"]) except api.LibraryPermissionIntegrityError as err: - raise ValidationError(detail=str(err)) # lint-amnesty, pylint: disable=raise-missing-from + raise ValidationError(detail=str(err)) # pylint: disable=raise-missing-from # noqa: B904 grant = api.get_library_user_permissions(key, user) return Response(ContentLibraryPermissionSerializer(grant).data) @@ -357,6 +356,12 @@ def get(self, request, lib_key_str): Get the list of users and groups who have permissions to view and edit this library. """ + warnings.warn( + "LibraryTeamView is deprecated. Use RoleUserAPIView from openedx-authz instead.", + DeprecationWarning, + stacklevel=2, + ) + key = LibraryLocatorV2.from_string(lib_key_str) api.require_permission_for_library_key(key, request.user, permissions.CAN_VIEW_THIS_CONTENT_LIBRARY_TEAM) team = api.get_library_team(key) @@ -369,6 +374,8 @@ class LibraryTeamUserView(APIView): """ View to add/remove/edit an individual user's permissions for a content library. + + Deprecated https://github.com/openedx/openedx-platform/issues/37409 """ @convert_exceptions def put(self, request, lib_key_str, username): @@ -376,6 +383,12 @@ def put(self, request, lib_key_str, username): Add a user to this content library, with permissions specified in the request body. """ + warnings.warn( + "LibraryTeamUserView is deprecated. Use RoleUserAPIView from openedx-authz instead.", + DeprecationWarning, + stacklevel=2, + ) + key = LibraryLocatorV2.from_string(lib_key_str) api.require_permission_for_library_key(key, request.user, permissions.CAN_EDIT_THIS_CONTENT_LIBRARY_TEAM) serializer = ContentLibraryPermissionLevelSerializer(data=request.data) @@ -384,7 +397,7 @@ def put(self, request, lib_key_str, username): try: api.set_library_user_permissions(key, user, access_level=serializer.validated_data["access_level"]) except api.LibraryPermissionIntegrityError as err: - raise ValidationError(detail=str(err)) # lint-amnesty, pylint: disable=raise-missing-from + raise ValidationError(detail=str(err)) # pylint: disable=raise-missing-from # noqa: B904 grant = api.get_library_user_permissions(key, user) return Response(ContentLibraryPermissionSerializer(grant).data) @@ -393,6 +406,12 @@ def get(self, request, lib_key_str, username): """ Gets the current permissions settings for a particular user. """ + warnings.warn( + "LibraryTeamUserView is deprecated. Use RoleUserAPIView from openedx-authz instead.", + DeprecationWarning, + stacklevel=2, + ) + key = LibraryLocatorV2.from_string(lib_key_str) api.require_permission_for_library_key(key, request.user, permissions.CAN_VIEW_THIS_CONTENT_LIBRARY_TEAM) user = get_object_or_404(User, username=username) @@ -407,13 +426,19 @@ def delete(self, request, lib_key_str, username): Remove the specified user's permission to access or edit this content library. """ + warnings.warn( + "LibraryTeamUserView is deprecated. Use RoleUserAPIView from openedx-authz instead.", + DeprecationWarning, + stacklevel=2, + ) + key = LibraryLocatorV2.from_string(lib_key_str) api.require_permission_for_library_key(key, request.user, permissions.CAN_EDIT_THIS_CONTENT_LIBRARY_TEAM) user = get_object_or_404(User, username=username) try: api.set_library_user_permissions(key, user, access_level=None) except api.LibraryPermissionIntegrityError as err: - raise ValidationError(detail=str(err)) # lint-amnesty, pylint: disable=raise-missing-from + raise ValidationError(detail=str(err)) # pylint: disable=raise-missing-from # noqa: B904 return Response({}) @@ -422,6 +447,8 @@ def delete(self, request, lib_key_str, username): class LibraryTeamGroupView(APIView): """ View to add/remove/edit a group's permissions for a content library. + + Deprecated https://github.com/openedx/openedx-platform/issues/37409 """ @convert_exceptions def put(self, request, lib_key_str, group_name): @@ -429,6 +456,12 @@ def put(self, request, lib_key_str, group_name): Add a group to this content library, with permissions specified in the request body. """ + warnings.warn( + "LibraryTeamGroupView is deprecated. Use RoleUserAPIView from openedx-authz instead.", + DeprecationWarning, + stacklevel=2, + ) + key = LibraryLocatorV2.from_string(lib_key_str) api.require_permission_for_library_key(key, request.user, permissions.CAN_EDIT_THIS_CONTENT_LIBRARY_TEAM) serializer = ContentLibraryPermissionLevelSerializer(data=request.data) @@ -443,6 +476,12 @@ def delete(self, request, lib_key_str, username): Remove the specified user's permission to access or edit this content library. """ + warnings.warn( + "LibraryTeamGroupView is deprecated. Use RoleUserAPIView from openedx-authz instead.", + DeprecationWarning, + stacklevel=2, + ) + key = LibraryLocatorV2.from_string(lib_key_str) api.require_permission_for_library_key(key, request.user, permissions.CAN_EDIT_THIS_CONTENT_LIBRARY_TEAM) group = get_object_or_404(Group, username=username) @@ -517,7 +556,7 @@ def post(self, request, lib_key_str): Import the contents of the user's clipboard and paste them into the Library """ library_key = LibraryLocatorV2.from_string(lib_key_str) - api.require_permission_for_library_key(library_key, request.user, permissions.CAN_EDIT_THIS_CONTENT_LIBRARY) + api.require_permission_for_library_key(library_key, request.user, authz_permissions.EDIT_LIBRARY_CONTENT) try: result = api.import_staged_content_from_user_clipboard(library_key, request.user) @@ -588,7 +627,7 @@ def post(self, request, lib_key_str): try: result = api.create_library_block(library_key, user_id=request.user.id, **serializer.validated_data) except api.IncompatibleTypesError as err: - raise ValidationError( # lint-amnesty, pylint: disable=raise-missing-from + raise ValidationError( # pylint: disable=raise-missing-from # noqa: B904 detail={'block_type': str(err)}, ) @@ -637,75 +676,6 @@ def delete(self, request, usage_key_str): # pylint: disable=unused-argument return Response({}) -@method_decorator(non_atomic_requests, name="dispatch") -@view_auth_classes() -class LibraryImportTaskViewSet(GenericViewSet): - """ - Import blocks from Courseware through modulestore. - """ - - queryset = [] # type: ignore[assignment] - serializer_class = ContentLibraryBlockImportTaskSerializer - - @convert_exceptions - def list(self, request, lib_key_str): - """ - List all import tasks for this library. - """ - library_key = LibraryLocatorV2.from_string(lib_key_str) - api.require_permission_for_library_key( - library_key, - request.user, - permissions.CAN_VIEW_THIS_CONTENT_LIBRARY - ) - queryset = ContentLibrary.objects.get_by_key(library_key).import_tasks - result = ContentLibraryBlockImportTaskSerializer(queryset, many=True).data - - return self.get_paginated_response( - self.paginate_queryset(result) - ) - - @convert_exceptions - @swagger_auto_schema( - request_body=ContentLibraryBlockImportTaskCreateSerializer, - responses={200: ContentLibraryBlockImportTaskSerializer} - ) - def create(self, request, lib_key_str): - """ - Create and queue an import tasks for this library. - """ - - library_key = LibraryLocatorV2.from_string(lib_key_str) - api.require_permission_for_library_key( - library_key, - request.user, - permissions.CAN_EDIT_THIS_CONTENT_LIBRARY, - ) - - serializer = ContentLibraryBlockImportTaskCreateSerializer(data=request.data) - serializer.is_valid(raise_exception=True) - course_key = serializer.validated_data['course_key'] - - import_task = api.import_blocks_create_task(library_key, course_key) - return Response(ContentLibraryBlockImportTaskSerializer(import_task).data) - - @convert_exceptions - def retrieve(self, request, lib_key_str, pk=None): - """ - Retrieve a import task for inspection. - """ - - library_key = LibraryLocatorV2.from_string(lib_key_str) - api.require_permission_for_library_key( - library_key, - request.user, - permissions.CAN_VIEW_THIS_CONTENT_LIBRARY, - ) - - import_task = api.ContentLibraryBlockImportTask.objects.get(pk=pk) - return Response(ContentLibraryBlockImportTaskSerializer(import_task).data) - - # Library Backup Views # ==================== @@ -883,273 +853,3 @@ def get(self, request): # serialize and return result result_serializer = LibraryRestoreTaskResultSerializer.from_task_status(task_status, request) return Response(result_serializer.data) - - -# LTI 1.3 Views -# ============= - - -def requires_lti_enabled(view_func): - """ - Modify the view function to raise 404 if content librarie LTI tool was not - enabled. - """ - def wrapped_view(*args, **kwargs): - lti_enabled = (settings.FEATURES.get('ENABLE_CONTENT_LIBRARIES') - and settings.FEATURES.get('ENABLE_CONTENT_LIBRARIES_LTI_TOOL')) - if not lti_enabled: - raise Http404() - return view_func(*args, **kwargs) - return wrapped_view - - -@method_decorator(non_atomic_requests, name="dispatch") -@method_decorator(requires_lti_enabled, name='dispatch') -class LtiToolView(View): - """ - Base LTI View initializing common attributes. - """ - - # pylint: disable=attribute-defined-outside-init - def setup(self, request, *args, **kwds): - """ - Initialize attributes shared by all LTI views. - """ - super().setup(request, *args, **kwds) - self.lti_tool_config = DjangoDbToolConf() - self.lti_tool_storage = DjangoCacheDataStorage(cache_name='default') - - -@method_decorator(non_atomic_requests, name="dispatch") -@method_decorator(csrf_exempt, name='dispatch') -class LtiToolLoginView(LtiToolView): - """ - Third-party Initiated Login view. - - The LTI platform will start the OpenID Connect flow by redirecting the User - Agent (UA) to this view. The redirect may be a form POST or a GET. On - success the view should redirect the UA to the LTI platform's authentication - URL. - """ - - LAUNCH_URI_PARAMETER = 'target_link_uri' - - def get(self, request): - return self.post(request) - - def post(self, request): - """Initialize 3rd-party login requests to redirect.""" - oidc_login = DjangoOIDCLogin( - self.request, - self.lti_tool_config, - launch_data_storage=self.lti_tool_storage) - launch_url = (self.request.POST.get(self.LAUNCH_URI_PARAMETER) - or self.request.GET.get(self.LAUNCH_URI_PARAMETER)) - try: - return oidc_login.redirect(launch_url) - except OIDCException as exc: - # Relying on downstream error messages, attempt to sanitize it up - # for customer facing errors. - log.error('LTI OIDC login failed: %s', exc) - return HttpResponseBadRequest('Invalid LTI login request.') - - -@method_decorator(non_atomic_requests, name="dispatch") -@method_decorator(csrf_exempt, name='dispatch') -@method_decorator(xframe_options_exempt, name='dispatch') -class LtiToolLaunchView(TemplateResponseMixin, LtiToolView): - """ - LTI platform tool launch view. - - The launch view supports resource link launches and AGS, when enabled by the - LTI platform. Other features and resouces are ignored. - """ - - template_name = 'xblock_v2/xblock_iframe.html' - - @property - def launch_data(self): - return self.launch_message.get_launch_data() - - def _authenticate_and_login(self, usage_key): - """ - Authenticate and authorize the user for this LTI message launch. - - We automatically create LTI profile for every valid launch, and - authenticate the LTI user associated with it. - """ - - # Check library authorization. - - if not ContentLibrary.authorize_lti_launch( - usage_key.lib_key, - issuer=self.launch_data['iss'], - client_id=self.launch_data['aud'] - ): - return None - - # Check LTI profile. - - LtiProfile.objects.get_or_create_from_claims( - iss=self.launch_data['iss'], - aud=self.launch_data['aud'], - sub=self.launch_data['sub']) - edx_user = authenticate( - self.request, - iss=self.launch_data['iss'], - aud=self.launch_data['aud'], - sub=self.launch_data['sub']) - - if edx_user is not None: - login(self.request, edx_user) - perms = api.get_library_user_permissions( - usage_key.lib_key, - self.request.user) - if not perms: - api.set_library_user_permissions( - usage_key.lib_key, - self.request.user, - api.AccessLevel.ADMIN_LEVEL) - - return edx_user - - def _bad_request_response(self): - """ - A default response for bad requests. - """ - return HttpResponseBadRequest('Invalid LTI tool launch.') - - def get_context_data(self): - """ - Setup the template context data. - """ - - handler_urls = { - str(key): xblock_api.get_handler_url(key, 'handler_name', self.request.user) - for key - in itertools.chain([self.block.scope_ids.usage_id], - getattr(self.block, 'children', [])) - } - - # We are defaulting to student view due to current use case (resource - # link launches). Launches within other views are not currently - # supported. - fragment = self.block.render('student_view') - lms_root_url = configuration_helpers.get_value('LMS_ROOT_URL', settings.LMS_ROOT_URL) - return { - 'fragment': fragment, - 'handler_urls_json': json.dumps(handler_urls), - 'lms_root_url': lms_root_url, - } - - def get_launch_message(self): - """ - Return the LTI 1.3 launch message object for the current request. - """ - launch_message = DjangoMessageLaunch( - self.request, - self.lti_tool_config, - launch_data_storage=self.lti_tool_storage) - # This will force the LTI launch validation steps. - launch_message.get_launch_data() - return launch_message - - # pylint: disable=attribute-defined-outside-init - def post(self, request): - """ - Process LTI platform launch requests. - """ - - # Parse LTI launch message. - - try: - self.launch_message = self.get_launch_message() - except LtiException as exc: - log.exception('LTI 1.3: Tool launch failed: %s', exc) - return self._bad_request_response() - - log.info("LTI 1.3: Launch message body: %s", - json.dumps(self.launch_data)) - - # Parse content key. - - usage_key_str = request.GET.get('id') - if not usage_key_str: - return self._bad_request_response() - usage_key = LibraryUsageLocatorV2.from_string(usage_key_str) - log.info('LTI 1.3: Launch block: id=%s', usage_key) - - # Authenticate the launch and setup LTI profiles. - - edx_user = self._authenticate_and_login(usage_key) - if not edx_user: - return self._bad_request_response() - - # Get the block. - - self.block = xblock_api.load_block( - usage_key, - user=self.request.user) - - # Handle Assignment and Grade Service request. - - self.handle_ags() - - # Render context and response. - context = self.get_context_data() - response = self.render_to_response(context) - mark_user_change_as_expected(edx_user.id) - return response - - def handle_ags(self): - """ - Handle AGS-enabled launches for block in the request. - """ - - # Validate AGS. - - if not self.launch_message.has_ags(): - return - - endpoint_claim = 'https://purl.imsglobal.org/spec/lti-ags/claim/endpoint' - endpoint = self.launch_data[endpoint_claim] - required_scopes = [ - 'https://purl.imsglobal.org/spec/lti-ags/scope/lineitem', - 'https://purl.imsglobal.org/spec/lti-ags/scope/score' - ] - - for scope in required_scopes: - if scope not in endpoint['scope']: - log.info('LTI 1.3: AGS: LTI platform does not support a required ' - 'scope: %s', scope) - return - lineitem = endpoint.get('lineitem') - if not lineitem: - log.info("LTI 1.3: AGS: LTI platform didn't pass lineitem, ignoring " - "request: %s", endpoint) - return - - # Create graded resource in the database for the current launch. - - resource_claim = 'https://purl.imsglobal.org/spec/lti/claim/resource_link' - resource_link = self.launch_data.get(resource_claim) - - resource = LtiGradedResource.objects.upsert_from_ags_launch( - self.request.user, self.block, endpoint, resource_link - ) - - log.info("LTI 1.3: AGS: Upserted LTI graded resource from launch: %s", - resource) - - -@method_decorator(non_atomic_requests, name="dispatch") -class LtiToolJwksView(LtiToolView): - """ - JSON Web Key Sets view. - """ - - def get(self, request): - """ - Return the JWKS. - """ - return JsonResponse(self.lti_tool_config.get_jwks(), safe=False) diff --git a/openedx/core/djangoapps/content_libraries/rest_api/serializers.py b/openedx/core/djangoapps/content_libraries/rest_api/serializers.py index c0bf07d087fc..cdfa2771d2f2 100644 --- a/openedx/core/djangoapps/content_libraries/rest_api/serializers.py +++ b/openedx/core/djangoapps/content_libraries/rest_api/serializers.py @@ -8,21 +8,18 @@ from django.core.validators import validate_unicode_slug from opaque_keys import InvalidKeyError, OpaqueKey from opaque_keys.edx.locator import LibraryContainerLocator, LibraryUsageLocatorV2 -from openedx_learning.api.authoring_models import Collection, LearningPackage +from openedx_content.models_api import Collection, LearningPackage from rest_framework import serializers from rest_framework.exceptions import ValidationError from user_tasks.models import UserTaskStatus -from openedx.core.djangoapps.content_libraries.tasks import LibraryRestoreTask from openedx.core.djangoapps.content_libraries import api -from openedx.core.djangoapps.content_libraries.api.containers import ContainerType from openedx.core.djangoapps.content_libraries.constants import ALL_RIGHTS_RESERVED, LICENSE_OPTIONS from openedx.core.djangoapps.content_libraries.models import ( ContentLibrary, - ContentLibraryBlockImportTask, - ContentLibraryPermission + ContentLibraryPermission, ) -from openedx.core.lib.api.serializers import CourseKeyField +from openedx.core.djangoapps.content_libraries.tasks import LibraryRestoreTask from .. import permissions @@ -51,7 +48,6 @@ class ContentLibraryMetadataSerializer(serializers.Serializer): published_by = serializers.CharField(read_only=True) last_draft_created = serializers.DateTimeField(format=DATETIME_FORMAT, read_only=True) last_draft_created_by = serializers.CharField(read_only=True) - allow_lti = serializers.BooleanField(default=False, read_only=True) allow_public_learning = serializers.BooleanField(default=False) allow_public_read = serializers.BooleanField(default=False) has_unpublished_changes = serializers.BooleanField(read_only=True) @@ -151,6 +147,7 @@ class PublishableItemSerializer(serializers.Serializer): last_draft_created_by = serializers.CharField(read_only=True) has_unpublished_changes = serializers.BooleanField(read_only=True) created = serializers.DateTimeField(format=DATETIME_FORMAT, read_only=True) + created_by = serializers.CharField(read_only=True, allow_null=True) modified = serializers.DateTimeField(format=DATETIME_FORMAT, read_only=True) # When creating a new XBlock in a library, the slug becomes the ID part of @@ -180,6 +177,98 @@ class LibraryXBlockMetadataSerializer(PublishableItemSerializer): block_type = serializers.CharField(source="usage_key.block_type") +class LibraryHistoryContributorSerializer(serializers.Serializer): + """ + Serializer for a contributor in a publish history group. + """ + username = serializers.CharField(read_only=True) + profile_image_urls = serializers.DictField(child=serializers.CharField(), read_only=True) + + +class LibraryHistoryEntrySerializer(serializers.Serializer): + """ + Serializer for a single entry in the history of a library item. + """ + contributor = LibraryHistoryContributorSerializer(allow_null=True, read_only=True) + changed_at = serializers.DateTimeField(format=DATETIME_FORMAT, read_only=True) + title = serializers.CharField(read_only=True) + item_type = serializers.CharField(read_only=True) + action = serializers.CharField(read_only=True) + old_version = serializers.IntegerField(read_only=True) + new_version = serializers.IntegerField(read_only=True, allow_null=True) + + +class UsageKeyV2Serializer(serializers.BaseSerializer): + """ + Serializes a library Component (XBlock) key. + """ + def to_representation(self, value: LibraryUsageLocatorV2) -> str: + """ + Returns the LibraryUsageLocatorV2 value as a string. + """ + return str(value) + + def to_internal_value(self, value: str) -> LibraryUsageLocatorV2: + """ + Returns a LibraryUsageLocatorV2 from the string value. + + Raises ValidationError if invalid LibraryUsageLocatorV2. + """ + try: + return LibraryUsageLocatorV2.from_string(value) + except InvalidKeyError as err: + raise ValidationError from err + + +class OpaqueKeySerializer(serializers.BaseSerializer): + """ + Serializes a OpaqueKey with the correct class. + """ + def to_representation(self, value: OpaqueKey) -> str: + """ + Returns the OpaqueKey value as a string. + """ + return str(value) + + def to_internal_value(self, value: str) -> OpaqueKey: + """ + Returns a LibraryUsageLocatorV2 or a LibraryContainerLocator from the string value. + + Raises ValidationError if invalid UsageKeyV2 or LibraryContainerLocator. + """ + try: + return LibraryUsageLocatorV2.from_string(value) + except InvalidKeyError: + try: + return LibraryContainerLocator.from_string(value) + except InvalidKeyError as err: + raise ValidationError from err + + +class DirectPublishedEntitySerializer(serializers.Serializer): + """ + Serializer for one entity the user directly requested to publish (direct=True). + """ + entity_key = OpaqueKeySerializer(read_only=True) + title = serializers.CharField(read_only=True) + entity_type = serializers.CharField(read_only=True) + + +class LibraryPublishHistoryGroupSerializer(serializers.Serializer): + """ + Serializer for a publish event summary in the publish history of a library item. + """ + publish_log_uuid = serializers.UUIDField(read_only=True) + published_by = serializers.SerializerMethodField() + published_at = serializers.DateTimeField(format=DATETIME_FORMAT, read_only=True) + contributors = LibraryHistoryContributorSerializer(many=True, read_only=True) + direct_published_entities = DirectPublishedEntitySerializer(many=True, read_only=True) + scope_entity_key = OpaqueKeySerializer(read_only=True, allow_null=True) + + def get_published_by(self, obj) -> str | None: + return obj.published_by.username if obj.published_by else None + + class LibraryXBlockTypeSerializer(serializers.Serializer): """ Serializer for LibraryXBlockType @@ -198,7 +287,7 @@ class LibraryXBlockCreationSerializer(serializers.Serializer): block_type = serializers.CharField() - # TODO: Rename to ``block_id`` or ``slug``. The Learning Core XBlock runtime + # TODO: Rename to ``block_id`` or ``slug``. The openedx_content XBlock runtime # doesn't use definition_ids, but this field is really just about requesting # a specific block_id, e.g. the "best_tropical_vacation_spots" portion of a # problem with UsageKey: @@ -252,21 +341,28 @@ class LibraryContainerMetadataSerializer(PublishableItemSerializer): Converts from ContainerMetadata to JSON-compatible data """ - # Use 'source' to get this as a string, not an enum value instance which the container_type field has. - container_type = serializers.CharField(source="container_key.container_type") + container_type_code = serializers.CharField(source="container_key.container_type") + # Deprecated (ambiguously named). Identical to container_type_code. + container_type = serializers.CharField(source="container_key.container_type", required=False) # When creating a new container in a library, the slug becomes the ID part of # the definition key and usage key: slug = serializers.CharField(write_only=True, required=False) - def to_internal_value(self, data): + def to_internal_value(self, data: dict): """ Convert JSON-ish data back to native python types. Returns a dictionary, not a ContainerMetadata instance. """ - result = super().to_internal_value(data) - result["container_type"] = ContainerType(data["container_type"]) - return result + if "container_type_code" not in data: + data["container_type_code"] = data.get("container_type") # Support deprecated field name + validated_data = super().to_internal_value(data) + # If creating a new container, the above function results in: + # {'display_name': '...', 'container_key': {'container_type': 'unit'}} + # Fix that: + validated_data["container_type_code"] = validated_data["container_key"]["container_type"] + del validated_data["container_key"] + return validated_data class LibraryContainerUpdateSerializer(serializers.Serializer): @@ -276,41 +372,18 @@ class LibraryContainerUpdateSerializer(serializers.Serializer): display_name = serializers.CharField() -class ContentLibraryBlockImportTaskSerializer(serializers.ModelSerializer): - """ - Serializer for a Content Library block import task. - """ - - org = serializers.SerializerMethodField() - - def get_org(self, obj): - return obj.course_id.org - - class Meta: - model = ContentLibraryBlockImportTask - fields = '__all__' - - -class ContentLibraryBlockImportTaskCreateSerializer(serializers.Serializer): - """ - Serializer to create a new block import task. - - The serializer accepts the following parameter: - - - The courseware course key to import blocks from. - """ - - course_key = CourseKeyField() - class ContentLibraryCollectionSerializer(serializers.ModelSerializer): """ Serializer for a Content Library Collection """ + # Expose Collection.collection_code as "key" to preserve the REST API field name. + # https://github.com/openedx/openedx-platform/issues/38406 + key = serializers.CharField(source='collection_code') class Meta: model = Collection - fields = '__all__' + exclude = ['collection_code'] class ContentLibraryCollectionUpdateSerializer(serializers.Serializer): @@ -322,53 +395,6 @@ class ContentLibraryCollectionUpdateSerializer(serializers.Serializer): description = serializers.CharField(allow_blank=True) -class UsageKeyV2Serializer(serializers.BaseSerializer): - """ - Serializes a library Component (XBlock) key. - """ - def to_representation(self, value: LibraryUsageLocatorV2) -> str: - """ - Returns the LibraryUsageLocatorV2 value as a string. - """ - return str(value) - - def to_internal_value(self, value: str) -> LibraryUsageLocatorV2: - """ - Returns a LibraryUsageLocatorV2 from the string value. - - Raises ValidationError if invalid LibraryUsageLocatorV2. - """ - try: - return LibraryUsageLocatorV2.from_string(value) - except InvalidKeyError as err: - raise ValidationError from err - - -class OpaqueKeySerializer(serializers.BaseSerializer): - """ - Serializes a OpaqueKey with the correct class. - """ - def to_representation(self, value: OpaqueKey) -> str: - """ - Returns the OpaqueKey value as a string. - """ - return str(value) - - def to_internal_value(self, value: str) -> OpaqueKey: - """ - Returns a LibraryUsageLocatorV2 or a LibraryContainerLocator from the string value. - - Raises ValidationError if invalid UsageKeyV2 or LibraryContainerLocator. - """ - try: - return LibraryUsageLocatorV2.from_string(value) - except InvalidKeyError: - try: - return LibraryContainerLocator.from_string(value) - except InvalidKeyError as err: - raise ValidationError from err - - class ContentLibraryItemContainerKeysSerializer(serializers.Serializer): """ Serializer for adding/removing items to/from a Container. @@ -470,14 +496,16 @@ class RestoreSuccessDataSerializer(serializers.Serializer): """ learning_package_id = serializers.IntegerField(source="lp_restored_data.id") title = serializers.CharField(source="lp_restored_data.title") - org = serializers.CharField(source="lp_restored_data.archive_org_key") - slug = serializers.CharField(source="lp_restored_data.archive_slug") + org = serializers.SerializerMethodField() + slug = serializers.SerializerMethodField() - # The `key` is a unique temporary key assigned to the learning package during the restore process, - # whereas the `archive_key` is the original key of the learning package from the backup. - # The temporary learning package key is replaced with a standard key once it is added to a content library. - key = serializers.CharField(source="lp_restored_data.key") - archive_key = serializers.CharField(source="lp_restored_data.archive_lp_key") + # The `package_ref` is a unique temporary key assigned to the learning + # package during the restore process, whereas the `archive_package_ref` is + # the original key of the learning package from the backup. The temporary + # learning package_ref is replaced with a standard key once it is added to a + # content library. + key = serializers.CharField(source="lp_restored_data.package_ref") + archive_key = serializers.CharField(source="lp_restored_data.archive_package_ref") containers = serializers.IntegerField(source="lp_restored_data.num_containers") components = serializers.IntegerField(source="lp_restored_data.num_components") @@ -490,6 +518,18 @@ class RestoreSuccessDataSerializer(serializers.Serializer): created_at = serializers.DateTimeField(source="backup_metadata.created_at", format=DATETIME_FORMAT) created_by = serializers.SerializerMethodField() + def get_org(self, obj) -> str: + """ + The org code/slug, as parsed from archive_package_ref, or "unknown" if unparseable. + """ + return obj["lp_restored_data"]["archive_org_code"] or "unknown" + + def get_slug(self, obj) -> str: + """ + The library code/slug, as parsed from archive_package_ref, or "unknown" if unparseable. + """ + return obj["lp_restored_data"]["archive_package_code"] or "unknown" + def get_created_by(self, obj): """ Get the user information of the archive creator, if available. diff --git a/openedx/core/djangoapps/content_libraries/rest_api/utils.py b/openedx/core/djangoapps/content_libraries/rest_api/utils.py index 99825fbe75f8..be492ec57fed 100644 --- a/openedx/core/djangoapps/content_libraries/rest_api/utils.py +++ b/openedx/core/djangoapps/content_libraries/rest_api/utils.py @@ -1,8 +1,8 @@ """ REST API utilities for content libraries """ -from functools import wraps import logging +from functools import wraps from opaque_keys import InvalidKeyError from rest_framework.exceptions import NotFound, ValidationError @@ -24,29 +24,29 @@ def wrapped_fn(*args, **kwargs): return fn(*args, **kwargs) except InvalidKeyError as exc: log.exception(str(exc)) - raise NotFound # lint-amnesty, pylint: disable=raise-missing-from + raise NotFound # pylint: disable=raise-missing-from # noqa: B904 except api.ContentLibraryNotFound: log.exception("Content library not found") - raise NotFound # lint-amnesty, pylint: disable=raise-missing-from + raise NotFound # pylint: disable=raise-missing-from # noqa: B904 except api.ContentLibraryBlockNotFound: log.exception("XBlock not found in content library") - raise NotFound # lint-amnesty, pylint: disable=raise-missing-from + raise NotFound # pylint: disable=raise-missing-from # noqa: B904 except api.ContentLibraryCollectionNotFound: log.exception("Collection not found in content library") - raise NotFound # lint-amnesty, pylint: disable=raise-missing-from + raise NotFound # pylint: disable=raise-missing-from # noqa: B904 except api.ContentLibraryContainerNotFound: log.exception("Container not found in content library") - raise NotFound # lint-amnesty, pylint: disable=raise-missing-from + raise NotFound # pylint: disable=raise-missing-from # noqa: B904 except api.LibraryCollectionAlreadyExists as exc: log.exception(str(exc)) - raise ValidationError(str(exc)) # lint-amnesty, pylint: disable=raise-missing-from + raise ValidationError(str(exc)) # pylint: disable=raise-missing-from # noqa: B904 except api.LibraryBlockAlreadyExists as exc: log.exception(str(exc)) - raise ValidationError(str(exc)) # lint-amnesty, pylint: disable=raise-missing-from + raise ValidationError(str(exc)) # pylint: disable=raise-missing-from # noqa: B904 except api.InvalidNameError as exc: log.exception(str(exc)) - raise ValidationError(str(exc)) # lint-amnesty, pylint: disable=raise-missing-from + raise ValidationError(str(exc)) # pylint: disable=raise-missing-from # noqa: B904 except api.BlockLimitReachedError as exc: log.exception(str(exc)) - raise ValidationError(str(exc)) # lint-amnesty, pylint: disable=raise-missing-from + raise ValidationError(str(exc)) # pylint: disable=raise-missing-from # noqa: B904 return wrapped_fn diff --git a/openedx/core/djangoapps/content_libraries/signal_handlers.py b/openedx/core/djangoapps/content_libraries/signal_handlers.py index 8a5b8bd89cc8..924bd3dbe601 100644 --- a/openedx/core/djangoapps/content_libraries/signal_handlers.py +++ b/openedx/core/djangoapps/content_libraries/signal_handlers.py @@ -4,222 +4,161 @@ import logging -from django.conf import settings -from django.db.models.signals import m2m_changed, post_delete, post_save +from attrs import asdict from django.dispatch import receiver -from opaque_keys import InvalidKeyError, OpaqueKey -from opaque_keys.edx.locator import LibraryLocatorV2, LibraryUsageLocatorV2 -from openedx_events.content_authoring.data import ContentObjectChangedData, LibraryCollectionData +from openedx_content import api as content_api +from openedx_content.api import signals as content_signals +from openedx_events.content_authoring.data import LibraryCollectionData from openedx_events.content_authoring.signals import ( - CONTENT_OBJECT_ASSOCIATIONS_CHANGED, LIBRARY_COLLECTION_CREATED, LIBRARY_COLLECTION_DELETED, - LIBRARY_COLLECTION_UPDATED + LIBRARY_COLLECTION_UPDATED, ) -from openedx_learning.api.authoring import get_components, get_containers -from openedx_learning.api.authoring_models import Collection, CollectionPublishableEntity, PublishableEntity -from lms.djangoapps.grades.api import signals as grades_signals - -from .api import library_collection_locator, library_component_usage_key, library_container_locator -from .models import ContentLibrary, LtiGradedResource +from . import tasks +from .api import library_collection_locator +from .models import ContentLibrary log = logging.getLogger(__name__) -@receiver(grades_signals.PROBLEM_WEIGHTED_SCORE_CHANGED) -def score_changed_handler(sender, **kwargs): # pylint: disable=unused-argument - """ - Match the score event to an LTI resource and update. +@receiver(content_signals.ENTITIES_DRAFT_CHANGED) +def entities_updated( + learning_package: content_signals.LearningPackageEventData, + change_log: content_signals.DraftChangeLogEventData, + **kwargs, +) -> None: """ + Entities (containers/components) have been changed - handle that as needed. - lti_enabled = (settings.FEATURES.get('ENABLE_CONTENT_LIBRARIES') - and settings.FEATURES.get('ENABLE_CONTENT_LIBRARIES_LTI_TOOL')) - if not lti_enabled: - return - - modified = kwargs.get('modified') - usage_id = kwargs.get('usage_id') - user_id = kwargs.get('user_id') - weighted_earned = kwargs.get('weighted_earned') - weighted_possible = kwargs.get('weighted_possible') - - if None in (modified, usage_id, user_id, weighted_earned, weighted_possible): - log.debug("LTI 1.3: Score Signal: Missing a required parameters, " - "ignoring: kwargs=%s", kwargs) - return - try: - usage_key = LibraryUsageLocatorV2.from_string(usage_id) - except InvalidKeyError: - log.debug("LTI 1.3: Score Signal: Not a content libraries v2 usage key, " - "ignoring: usage_id=%s", usage_id) - return - try: - resource = LtiGradedResource.objects.get_from_user_id( - user_id, usage_key=usage_key - ) - except LtiGradedResource.DoesNotExist: - log.debug("LTI 1.3: Score Signal: Unknown resource, ignoring: kwargs=%s", - kwargs) - else: - resource.update_score(weighted_earned, weighted_possible, modified) - log.info("LTI 1.3: Score Signal: Grade upgraded: resource; %s", - resource) + We receive this low-level event from `openedx_content`, and check if it + happened in a library. If so, we emit more detailed library-specific events. + This event change log includes entities that were directly edited as well as + their dependencies which may be only indirectly affected. -@receiver(post_save, sender=Collection, dispatch_uid="library_collection_saved") -def library_collection_saved(sender, instance, created, **kwargs): - """ - Raises LIBRARY_COLLECTION_CREATED if the Collection is new, - or LIBRARY_COLLECTION_UPDATED if updated an existing Collection. + 💾 This event is only received after the transaction has committed. + ⏳ This event is emitted synchronously and this handler is called + synchronously. If multiple entities were changed, we need to dispatch an + asynchronous handler to deal with them to avoid slowdowns. If only one + entity is changed, we want to deal with that synchronously so that we + can show the user correct data when the current requests completes. """ try: - library = ContentLibrary.objects.get(learning_package_id=instance.learning_package_id) + ContentLibrary.objects.get(learning_package_id=learning_package.id) except ContentLibrary.DoesNotExist: - log.error("{instance} is not associated with a content library.") - return - - if created: - # .. event_implemented_name: LIBRARY_COLLECTION_CREATED - # .. event_type: org.openedx.content_authoring.content_library.collection.created.v1 - LIBRARY_COLLECTION_CREATED.send_event( - library_collection=LibraryCollectionData( - collection_key=library_collection_locator( - library_key=library.library_key, - collection_key=instance.key, - ), - ) - ) - else: - # .. event_implemented_name: LIBRARY_COLLECTION_UPDATED - # .. event_type: org.openedx.content_authoring.content_library.collection.updated.v1 - LIBRARY_COLLECTION_UPDATED.send_event( - library_collection=LibraryCollectionData( - collection_key=library_collection_locator( - library_key=library.library_key, - collection_key=instance.key, - ), - ) - ) - - -@receiver(post_delete, sender=Collection, dispatch_uid="library_collection_deleted") -def library_collection_deleted(sender, instance, **kwargs): - """ - Raises LIBRARY_COLLECTION_DELETED for the deleted Collection. - """ - try: - library = ContentLibrary.objects.get(learning_package_id=instance.learning_package_id) - except ContentLibrary.DoesNotExist: - log.error("{instance} is not associated with a content library.") - return - - # .. event_implemented_name: LIBRARY_COLLECTION_DELETED - # .. event_type: org.openedx.content_authoring.content_library.collection.deleted.v1 - LIBRARY_COLLECTION_DELETED.send_event( - library_collection=LibraryCollectionData( - collection_key=library_collection_locator( - library_key=library.library_key, - collection_key=instance.key, - ), - ) + return # We don't care about non-library events. + + # The list of entities changed, both directly changed and indirectly affected (e.g. ancestor containers) + change_list = [asdict(change) for change in change_log.changes] + tasks.dispatch_and_wait( + tasks.send_change_events_for_modified_entities, + learning_package_id=learning_package.id, + change_list=change_list, + # If there are only a few entities changed, we'll call the handler synchronously so that everything is up to + # date when the requests finishes. (This is important for the Authoring MFE which uses the search index for its + # main UI listing components, containers, and collections in the library.) If many entities have changed, we'll + # handle it asynchronously but _try_ waiting a bit in case it finishes quickly. + wait_for_full_completion=len(change_list) < 5, ) -def _library_collection_entity_changed( - publishable_entity: PublishableEntity, - library_key: LibraryLocatorV2 | None = None, +@receiver(content_signals.ENTITIES_PUBLISHED) +def entities_published( + learning_package: content_signals.LearningPackageEventData, + change_log: content_signals.PublishLogEventData, + **kwargs, ) -> None: """ - Sends a CONTENT_OBJECT_ASSOCIATIONS_CHANGED event for the entity. - """ - if not library_key: - try: - library = ContentLibrary.objects.get( - learning_package_id=publishable_entity.learning_package_id, - ) - except ContentLibrary.DoesNotExist: - log.error("{publishable_entity} is not associated with a content library.") - return - - library_key = library.library_key + Entities (containers/components) have been published - handle that as needed. - assert library_key + We receive this low-level event from `openedx_content`, and check if it + happened in a library. If so, we emit more detailed library-specific events. - opaque_key: OpaqueKey + This event change log includes entities that were directly published as well + as other things that are affected as publish "side effects". - if hasattr(publishable_entity, 'component'): - opaque_key = library_component_usage_key( - library_key, - publishable_entity.component, - ) - elif hasattr(publishable_entity, 'container'): - opaque_key = library_container_locator( - library_key, - publishable_entity.container, - ) - else: - log.error("Unknown publishable entity type: %s", publishable_entity) - return - - # .. event_implemented_name: CONTENT_OBJECT_ASSOCIATIONS_CHANGED - # .. event_type: org.openedx.content_authoring.content.object.associations.changed.v1 - CONTENT_OBJECT_ASSOCIATIONS_CHANGED.send_event( - content_object=ContentObjectChangedData( - object_id=str(opaque_key), - changes=["collections"], - ), + 💾 This event is only received after the transaction has committed. + ⏳ This event is emitted synchronously and this handler is called + synchronously. If multiple entities were published, we need to dispatch + an asynchronous handler to deal with them to avoid slowdowns. If only one + entity was published, we want to deal with that synchronously so that we + can show the user correct data when the current requests completes. + """ + try: + library = ContentLibrary.objects.get(learning_package_id=learning_package.id) + except ContentLibrary.DoesNotExist: + return # We don't care about non-library events. + + tasks.dispatch_and_wait( + tasks.send_events_after_publish, + publish_log_id=change_log.publish_log_id, + library_key_str=str(library.library_key), + # If there are only a few entities published, we'll call the handler synchronously so that everything is up to + # date when the requests finishes: + wait_for_full_completion=len(change_log.changes) < 5, ) -@receiver(post_save, sender=CollectionPublishableEntity, dispatch_uid="library_collection_entity_saved") -def library_collection_entity_saved(sender, instance, created, **kwargs): - """ - Sends a CONTENT_OBJECT_ASSOCIATIONS_CHANGED event for components added to a collection. +@receiver(content_signals.COLLECTION_CHANGED) +def collection_updated( + learning_package: content_signals.LearningPackageEventData, + change: content_signals.CollectionChangeData, + **kwargs, +) -> None: """ - if created: - _library_collection_entity_changed(instance.entity) + A Collection has been updated - handle that as needed. + We receive this low-level event from `openedx_content`, and check if it + happened in a library. If so, we emit more detailed library-specific events. -@receiver(post_delete, sender=CollectionPublishableEntity, dispatch_uid="library_collection_entity_deleted") -def library_collection_entity_deleted(sender, instance, **kwargs): + ⏳ This event is emitted synchronously and this handler is called + synchronously. If multiple entities were changed, we need to dispatch an + asynchronous handler to deal with them to avoid slowdowns. """ - Sends a CONTENT_OBJECT_ASSOCIATIONS_CHANGED event for components removed from a collection. - """ - # Only trigger component updates if CollectionPublishableEntity was cascade deleted due to deletion of a collection. - if isinstance(kwargs.get('origin'), Collection): - _library_collection_entity_changed(instance.entity) - + try: + library = ContentLibrary.objects.get(learning_package_id=learning_package.id) + except ContentLibrary.DoesNotExist: + return # We don't care about non-library events. -@receiver(m2m_changed, sender=CollectionPublishableEntity, dispatch_uid="library_collection_entities_changed") -def library_collection_entities_changed(sender, instance, action, pk_set, **kwargs): - """ - Sends a CONTENT_OBJECT_ASSOCIATIONS_CHANGED event for components added/removed/cleared from a collection. - """ - if action not in ["post_add", "post_remove", "post_clear"]: - return + collection_key = library_collection_locator(library_key=library.library_key, collection_key=change.collection_code) + entities_changed = change.entities_added + change.entities_removed - try: - library = ContentLibrary.objects.get( - learning_package_id=instance.learning_package_id, + if change.created: # This is a newly-created collection, or was "un-deleted": + # .. event_implemented_name: LIBRARY_COLLECTION_CREATED + # .. event_type: org.openedx.content_authoring.content_library.collection.created.v1 + LIBRARY_COLLECTION_CREATED.send_event(library_collection=LibraryCollectionData(collection_key=collection_key)) + # As an example of what this event triggers, Collections are listed in the Meilisearch index as items in the + # library. So the handler will add this Collection as an entry in the Meilisearch index. + elif change.metadata_modified or entities_changed: + # The collection was renamed or its items were changed. + # This event is ambiguous but because the search index of the collection itself may have something like + # "contains 15 items", we _do_ need to emit it even when only the items have changed and not the metadata. + # .. event_implemented_name: LIBRARY_COLLECTION_UPDATED + # .. event_type: org.openedx.content_authoring.content_library.collection.updated.v1 + LIBRARY_COLLECTION_UPDATED.send_event(library_collection=LibraryCollectionData(collection_key=collection_key)) + elif change.deleted: + # .. event_implemented_name: LIBRARY_COLLECTION_DELETED + # .. event_type: org.openedx.content_authoring.content_library.collection.deleted.v1 + LIBRARY_COLLECTION_DELETED.send_event(library_collection=LibraryCollectionData(collection_key=collection_key)) + + if change.metadata_modified: + # If the collection was renamed, then in addition to LIBRARY_COLLECTION_UPDATED we need to send out a + # CONTENT_OBJECT_ASSOCIATIONS_CHANGED notice to update the "collections=..." field in the search index on all + # entities that are in the collection. + current_collection_entities = content_api.get_collection_entities(learning_package.id, change.collection_code) + # We also need to process any entities that happened to be removed as part of this same event (if any) + entities_changed = change.entities_removed + list(current_collection_entities.values_list("id", flat=True)) + + # Update any entities that were added/removed to this collection. + # If the collection was re-enabled (un-deleted), this will already include all entities in the collection. + # If the collection was renamed, we just now added all entities in the collection to this list of changed entities. + if entities_changed: + tasks.dispatch_and_wait( + tasks.send_collections_changed_events, + publishable_entity_ids=sorted(entities_changed), # sorted() is mostly for test purposes + learning_package_id=learning_package.id, + library_key_str=str(library.library_key), + # If there's only one changed entity, emit the event synchronously: + wait_for_full_completion=len(entities_changed) == 1, ) - except ContentLibrary.DoesNotExist: - log.error("{instance} is not associated with a content library.") - return - - if isinstance(instance, PublishableEntity): - _library_collection_entity_changed(instance, library.library_key) - return - - # When action=="post_clear", pk_set==None - # Since the collection instance now has an empty entities set, - # we don't know which ones were removed, so we need to update associations for all library - # components and containers. - components = get_components(instance.learning_package_id) - containers = get_containers(instance.learning_package_id) - if pk_set: - components = components.filter(pk__in=pk_set) - containers = containers.filter(pk__in=pk_set) - - for entity in list(components.all()) + list(containers.all()): - _library_collection_entity_changed(entity.publishable_entity, library.library_key) diff --git a/openedx/core/djangoapps/content_libraries/tasks.py b/openedx/core/djangoapps/content_libraries/tasks.py index bbbf847bfbc7..daea33a8ced6 100644 --- a/openedx/core/djangoapps/content_libraries/tasks.py +++ b/openedx/core/djangoapps/content_libraries/tasks.py @@ -4,49 +4,58 @@ Architecture note: Several functions in this file manage the copying/updating of blocks in modulestore - and learning core. These operations should only be performed within the context of CMS. + and openedx_content. These operations should only be performed within the context of CMS. However, due to existing edx-platform code structure, we've had to define the functions in shared source tree (openedx/) and the tasks are registered in both LMS and CMS. - To ensure that we're not accidentally importing things from learning core in the LMS context, + To ensure that we're not accidentally importing things from openedx_content in the LMS context, we use ensure_cms throughout this module. A longer-term solution to this issue would be to move the content_libraries app to cms: https://github.com/openedx/edx-platform/issues/33428 """ + from __future__ import annotations -from io import StringIO +import json import logging import os -from datetime import datetime -from tempfile import mkdtemp, NamedTemporaryFile -import json import shutil +from collections.abc import Iterable +from io import StringIO +from tempfile import NamedTemporaryFile -from django.core.files.base import ContentFile -from django.contrib.auth import get_user_model -from django.core.serializers.json import DjangoJSONEncoder -from django.conf import settings -from celery import shared_task +from celery import Task, shared_task +from celery.exceptions import TimeoutError as CeleryTimeout +from celery.result import AsyncResult from celery.utils.log import get_task_logger from celery_utils.logged_task import LoggedTask +from django.contrib.auth import get_user_model from django.core.files import File -from django.utils.text import slugify +from django.core.files.base import ContentFile +from django.core.serializers.json import DjangoJSONEncoder from edx_django_utils.monitoring import ( set_code_owner_attribute, set_code_owner_attribute_from_module, - set_custom_attribute + set_custom_attribute, ) -from opaque_keys.edx.keys import CourseKey +from opaque_keys import OpaqueKey from opaque_keys.edx.locator import ( BlockUsageLocator, - LibraryCollectionLocator, LibraryContainerLocator, - LibraryLocatorV2 + LibraryLocatorV2, + LibraryUsageLocatorV2, +) +from openedx_content import api as content_api +from openedx_content.models_api import LearningPackage, PublishableEntity, PublishLog +from openedx_events.content_authoring.data import ( + ContentObjectChangedData, + LibraryBlockData, + LibraryCollectionData, + LibraryContainerData, ) -from openedx_events.content_authoring.data import LibraryBlockData, LibraryCollectionData, LibraryContainerData from openedx_events.content_authoring.signals import ( + CONTENT_OBJECT_ASSOCIATIONS_CHANGED, LIBRARY_BLOCK_CREATED, LIBRARY_BLOCK_DELETED, LIBRARY_BLOCK_PUBLISHED, @@ -55,16 +64,14 @@ LIBRARY_CONTAINER_CREATED, LIBRARY_CONTAINER_DELETED, LIBRARY_CONTAINER_PUBLISHED, - LIBRARY_CONTAINER_UPDATED + LIBRARY_CONTAINER_UPDATED, ) -from openedx_learning.api import authoring as authoring_api -from openedx_learning.api.authoring import create_zip_file as create_lib_zip_file -from openedx_learning.api.authoring_models import DraftChangeLog, PublishLog -from path import Path +from openedx_tagging import api as tagging_api from user_tasks.models import UserTaskArtifact from user_tasks.tasks import UserTask, UserTaskStatus from xblock.fields import Scope +from cms.djangoapps.contentstore.storage import course_import_export_storage from openedx.core.lib import ensure_cms from xmodule.capa_block import ProblemBlock from xmodule.library_content_block import ANY_CAPA_TYPE_VALUE, LegacyLibraryContentBlock @@ -73,10 +80,8 @@ from xmodule.modulestore.exceptions import ItemNotFoundError from xmodule.modulestore.mixed import MixedModuleStore -from cms.djangoapps.contentstore.storage import course_import_export_storage - from . import api -from .models import ContentLibraryBlockImportTask +from .models import ContentLibrary log = logging.getLogger(__name__) TASK_LOGGER = get_task_logger(__name__) @@ -88,248 +93,313 @@ @shared_task(base=LoggedTask) @set_code_owner_attribute -def send_events_after_publish(publish_log_pk: int, library_key_str: str) -> None: +def send_change_events_for_modified_entities( + learning_package_id: LearningPackage.ID, + change_list: list[dict], # we want list[ChangeLogRecordData], but that's not JSON serializable, so use dicts +): """ - Send events to trigger actions like updating the search index, after we've - published some items in a library. - - We use the PublishLog record so we can detect exactly what was changed, - including any auto-published changes like child items in containers. - - This happens in a celery task so that it can be run asynchronously if - needed, because the "publish all changes" action can potentially publish - hundreds or even thousands of components/containers at once, and synchronous - event handlers like updating the search index may a while to complete in - that case. + Sends a various library-specific events for each modified library entity in + the given change log, after any kind of edit was made in the library. This + could be in response to an entity (component or container) being created, + modified, deleted, un-deleted, or one of its dependencies doing those + things. + + ⏳ This task is designed to be run asynchronously so it can handle many + entities, but you can also call it synchronously if you are only + processing a single entity. Handlers of the events that we emit here + should be synchronous and fast, to support the "update one item + synchronously" use case, but can be async if needed. """ - publish_log = PublishLog.objects.get(pk=publish_log_pk) - library_key = LibraryLocatorV2.from_string(library_key_str) - affected_entities = publish_log.records.select_related("entity", "entity__container", "entity__component").all() - affected_containers: set[LibraryContainerLocator] = set() - - # Update anything that needs to be updated (e.g. search index): - for record in affected_entities: - if hasattr(record.entity, "component"): - usage_key = api.library_component_usage_key(library_key, record.entity.component) - # Note that this item may be newly created, updated, or even deleted - but all we care about for this event - # is that the published version is now different. Only for draft changes do we send differentiated events. + changes = [content_api.signals.ChangeLogRecordData(**r) for r in change_list] + library = ContentLibrary.objects.get(learning_package_id=learning_package_id) + changes_by_entity_id = {change.entity_id: change for change in changes} + entities = ( + content_api.get_publishable_entities(learning_package_id) + .filter(id__in=changes_by_entity_id.keys()) + .select_related("component", "container") + ) - # .. event_implemented_name: LIBRARY_BLOCK_PUBLISHED - # .. event_type: org.openedx.content_authoring.library_block.published.v1 - LIBRARY_BLOCK_PUBLISHED.send_event( - library_block=LibraryBlockData(library_key=library_key, usage_key=usage_key) - ) - # Publishing a container will auto-publish its children, but publishing a single component or all changes - # in the library will NOT usually include any parent containers. But we do need to notify listeners that the - # parent container(s) have changed, e.g. so the search index can update the "has_unpublished_changes" - for parent_container in api.get_containers_contains_item(usage_key): - affected_containers.add(parent_container.container_key) - # TODO: should this be a CONTAINER_CHILD_PUBLISHED event instead of CONTAINER_PUBLISHED ? - elif hasattr(record.entity, "container"): - container_key = api.library_container_locator(library_key, record.entity.container) - affected_containers.add(container_key) - - try: - # We do need to notify listeners that the parent container(s) have changed, - # e.g. so the search index can update the "has_unpublished_changes" - for parent_container in api.get_containers_contains_item(container_key): - affected_containers.add(parent_container.container_key) - except api.ContentLibraryContainerNotFound: - # The deleted children remains in the entity, so, in this case, the container may not be found. - pass + for entity in entities: + change = changes_by_entity_id[entity.id] + entity_opaque_key: LibraryUsageLocatorV2 | LibraryContainerLocator + if hasattr(entity, "component"): + # This is a library XBlock (component) + entity_opaque_key = api.library_component_usage_key(library.library_key, entity.component) + event_data = LibraryBlockData(library_key=library.library_key, usage_key=entity_opaque_key) + if change.old_version is None and change.new_version: + # .. event_implemented_name: LIBRARY_BLOCK_CREATED + # .. event_type: org.openedx.content_authoring.library_block.created.v1 + LIBRARY_BLOCK_CREATED.send_event(library_block=event_data) + elif change.old_version and change.new_version is None: + # .. event_implemented_name: LIBRARY_BLOCK_DELETED + # .. event_type: org.openedx.content_authoring.library_block.deleted.v1 + LIBRARY_BLOCK_DELETED.send_event(library_block=event_data) + else: + # This component was modified. + # .. event_implemented_name: LIBRARY_BLOCK_UPDATED + # .. event_type: org.openedx.content_authoring.library_block.updated.v1 + LIBRARY_BLOCK_UPDATED.send_event(library_block=event_data) + + elif hasattr(entity, "container"): + entity_opaque_key = api.library_container_locator(library.library_key, entity.container) + event_data = LibraryContainerData(container_key=entity_opaque_key) + if change.old_version is None and change.new_version: + # .. event_implemented_name: LIBRARY_CONTAINER_CREATED + # .. event_type: org.openedx.content_authoring.content_library.container.created.v1 + LIBRARY_CONTAINER_CREATED.send_event(library_container=event_data) + elif change.old_version and change.new_version is None: + # .. event_implemented_name: LIBRARY_CONTAINER_DELETED + # .. event_type: org.openedx.content_authoring.content_library.container.deleted.v1 + LIBRARY_CONTAINER_DELETED.send_event(library_container=event_data) + else: + # .. event_implemented_name: LIBRARY_CONTAINER_UPDATED + # .. event_type: org.openedx.content_authoring.content_library.container.updated.v1 + LIBRARY_CONTAINER_UPDATED.send_event(library_container=event_data) + # TODO: to optimze this, once we have https://github.com/openedx/openedx-events/pull/570 merged, + # change the above event to use `send_async=not container_itself_changed`, so that direct changes are + # processed immediately but side effects can happen async. + + # If the version numbers are different, this container was modified. + # If not, it was included as a side effect of some other change, like its child being modified. + container_itself_changed = change.old_version != change.new_version + + if container_itself_changed: + # If entities were added/removed from this container, we need to notify things like the search index + # that the list of parent containers for each entity has changed. + check_container_content_changes.delay( + container_key_str=str(entity_opaque_key), + old_version_id=change.old_version_id, + new_version_id=change.new_version_id, + ) else: - log.warning( - f"PublishableEntity {record.entity.pk} / {record.entity.key} was modified during publish operation " - "but is of unknown type." - ) + log.error("Unknown publishable entity type: %s", entity) + continue + + if change.restored: + # This block/container was previously soft-deleted and is now un-deleted. It may have tags or collections. + # It would be best to expand the LIBRARY_BLOCK_CREATED event to include the "restored" flag, but in + # the interests of minimizing breaking event changes for now we'll just emit a + # CONTENT_OBJECT_ASSOCIATIONS_CHANGED event to ensure relevant search index records get updated. + association_changes: list[str] = [] + if content_api.get_entity_collections(learning_package_id, entity_ref=entity.entity_ref).exists(): + association_changes.append("collections") # This entity is part of at least one collection + if tagging_api.get_object_tags(str(entity_opaque_key)).exists(): + association_changes.append("tags") # This entity has tags + if association_changes: + # .. event_implemented_name: CONTENT_OBJECT_ASSOCIATIONS_CHANGED + # .. event_type: org.openedx.content_authoring.content.object.associations.changed.v1 + CONTENT_OBJECT_ASSOCIATIONS_CHANGED.send_event( + content_object=ContentObjectChangedData( + object_id=str(entity_opaque_key), + changes=association_changes, + ), + ) + # Notifying parent containers that a child has been restored is not necessary here - they'll already be + # included in 'change_list' [as side effects]. - for container_key in affected_containers: - # .. event_implemented_name: LIBRARY_CONTAINER_PUBLISHED - # .. event_type: org.openedx.content_authoring.content_library.container.published.v1 - LIBRARY_CONTAINER_PUBLISHED.send_event( - library_container=LibraryContainerData(container_key=container_key) - ) + # When entities are deleted or un-deleted (as drafts), update any associated collections, so their "# of draft + # entities in collection" count is correct. We only care about deleted or un-deleted, not newly created drafts, + # because it's currently impossible for a newly-created draft to be part of a collection. + deleted_or_undeleted_entity_ids = [ + r.entity_id for r in changes if r.new_version is None or (r.old_version is None and r.restored) + ] + if deleted_or_undeleted_entity_ids: + emit_collections_updated(library, entity_ids=deleted_or_undeleted_entity_ids) -def wait_for_post_publish_events(publish_log: PublishLog, library_key: LibraryLocatorV2): +def emit_collections_updated(library: ContentLibrary, entity_ids: list[PublishableEntity.ID]) -> None: """ - After publishing some changes, trigger the required event handlers (e.g. - update the search index). Try to wait for that to complete before returning, - up to some reasonable timeout, and then finish anything remaining - asynchonrously. + Helper function to notify affected collections after an entity is deleted/un-deleted/published/un-published. + + Used by `send_change_events_for_modified_entities()` and `send_events_after_publish()` """ - # Update the search index (and anything else) for the affected blocks - result = send_events_after_publish.apply_async(args=(publish_log.pk, str(library_key))) - # Try waiting a bit for those post-publish events to be handled: - try: - result.get(timeout=15) - except TimeoutError: - pass - # This is fine! The search index is still being updated, and/or other - # event handlers are still following up on the results, but the publish - # already *did* succeed, and the events will continue to be processed in - # the background by the celery worker until everything is updated. + # Check if any collections are affected: + affected_collections = ( + content_api.get_collections(library.learning_package_id, enabled=True).filter(entities__id__in=entity_ids) + ) + for collection in affected_collections: + collection_key = api.library_collection_locator( + library_key=library.library_key, + collection_key=collection.collection_code, + ) + # .. event_implemented_name: LIBRARY_COLLECTION_UPDATED + # .. event_type: org.openedx.content_authoring.content_library.collection.updated.v1 + LIBRARY_COLLECTION_UPDATED.send_event(library_collection=LibraryCollectionData(collection_key=collection_key)) @shared_task(base=LoggedTask) @set_code_owner_attribute -def send_events_after_revert(draft_change_log_id: int, library_key_str: str) -> None: +def check_container_content_changes( + container_key_str: str, + old_version_id: int | None, + new_version_id: int | None, +): """ - Send events to trigger actions like updating the search index, after we've - reverted some unpublished changes in a library. - - See notes on the analogous function above, send_events_after_publish. - """ - try: - draft_change_log = DraftChangeLog.objects.get(id=draft_change_log_id) - except DraftChangeLog.DoesNotExist: - # When a revert operation is a no-op, Learning Core deletes the empty - # DraftChangeLog, so we'll assume that's what happened here. - log.info(f"Library revert in {library_key_str} did not result in any changes.") - return + Whenever a container is edited, we need to check if child entities were + added or removed, and if so send out a CONTENT_OBJECT_ASSOCIATIONS_CHANGED + event for each added/removed child. - library_key = LibraryLocatorV2.from_string(library_key_str) - affected_entities = draft_change_log.records.select_related( - "entity", "entity__container", "entity__component", - ).all() + For example, removing an entity from a unit should result in:: - created_container_keys: set[LibraryContainerLocator] = set() - updated_container_keys: set[LibraryContainerLocator] = set() - deleted_container_keys: set[LibraryContainerLocator] = set() - affected_collection_keys: set[LibraryCollectionLocator] = set() + CONTENT_OBJECT_ASSOCIATIONS_CHANGED( + object_id=..., + changes=["units"], + ) - # Update anything that needs to be updated (e.g. search index): - for record in affected_entities: - # This will be true if the entity was [soft] deleted, but we're now reverting that deletion: - is_undeleted = (record.old_version is None and record.new_version is not None) - # This will be true if the entity was created and we're now deleting it by reverting that creation: - is_deleted = (record.old_version is not None and record.new_version is None) - if hasattr(record.entity, "component"): - usage_key = api.library_component_usage_key(library_key, record.entity.component) - event = LIBRARY_BLOCK_UPDATED - if is_deleted: - event = LIBRARY_BLOCK_DELETED - elif is_undeleted: - event = LIBRARY_BLOCK_CREATED - - # .. event_implemented_name: LIBRARY_BLOCK_UPDATED - # .. event_type: org.openedx.content_authoring.library_block.updated.v1 - - # .. event_implemented_name: LIBRARY_BLOCK_DELETED - # .. event_type: org.openedx.content_authoring.library_block.deleted.v1 - - # .. event_implemented_name: LIBRARY_BLOCK_CREATED - # .. event_type: org.openedx.content_authoring.library_block.created.v1 - event.send_event(library_block=LibraryBlockData(library_key=library_key, usage_key=usage_key)) - # If any containers contain this component, their child list / component count may need to be updated - # e.g. if this was a newly created component in the container and is now deleted, or this was deleted and - # is now restored. - for parent_container in api.get_containers_contains_item(usage_key): - updated_container_keys.add(parent_container.container_key) - - # TODO: do we also need to send CONTENT_OBJECT_ASSOCIATIONS_CHANGED for this component, or is - # LIBRARY_BLOCK_UPDATED sufficient? - elif hasattr(record.entity, "container"): - container_key = api.library_container_locator(library_key, record.entity.container) - if is_deleted: - deleted_container_keys.add(container_key) - elif is_undeleted: - created_container_keys.add(container_key) - else: - updated_container_keys.add(container_key) - else: - log.warning( - f"PublishableEntity {record.entity.pk} / {record.entity.key} was modified during publish operation " - "but is of unknown type." - ) - # If any collections contain this entity, their item count may need to be updated, e.g. if this was a - # newly created component in the collection and is now deleted, or this was deleted and is now re-added. - for parent_collection in authoring_api.get_entity_collections( - record.entity.learning_package_id, record.entity.key, - ): - collection_key = api.library_collection_locator( - library_key=library_key, - collection_key=parent_collection.key, - ) - affected_collection_keys.add(collection_key) + ⏳ This task is always run asynchronously. + """ + if old_version_id == new_version_id: + return # Same versions - for container_key in deleted_container_keys: - # .. event_implemented_name: LIBRARY_CONTAINER_DELETED - # .. event_type: org.openedx.content_authoring.content_library.container.deleted.v1 - LIBRARY_CONTAINER_DELETED.send_event( - library_container=LibraryContainerData(container_key=container_key) - ) - # Don't bother sending UPDATED events for these containers that are now deleted - created_container_keys.discard(container_key) - - for container_key in created_container_keys: - # .. event_implemented_name: LIBRARY_CONTAINER_CREATED - # .. event_type: org.openedx.content_authoring.content_library.container.created.v1 - LIBRARY_CONTAINER_CREATED.send_event( - library_container=LibraryContainerData(container_key=container_key) - ) + old_version = content_api.get_container_version(old_version_id) if old_version_id else None + new_version = content_api.get_container_version(new_version_id) if new_version_id else None - for container_key in updated_container_keys: - # .. event_implemented_name: LIBRARY_CONTAINER_UPDATED - # .. event_type: org.openedx.content_authoring.content_library.container.updated.v1 - LIBRARY_CONTAINER_UPDATED.send_event( - library_container=LibraryContainerData(container_key=container_key) - ) + # TODO: there is no "get entity list for container version" API in openedx_content + old_child_ids: Iterable[PublishableEntity.ID] = ( + old_version.entity_list.entitylistrow_set.values_list("entity_id", flat=True) if old_version else [] + ) + new_child_ids: Iterable[PublishableEntity.ID]= ( + new_version.entity_list.entitylistrow_set.values_list("entity_id", flat=True) if new_version else [] + ) - for collection_key in affected_collection_keys: - # .. event_implemented_name: LIBRARY_COLLECTION_UPDATED - # .. event_type: org.openedx.content_authoring.content_library.collection.updated.v1 - LIBRARY_COLLECTION_UPDATED.send_event( - library_collection=LibraryCollectionData(collection_key=collection_key) + # If the title has changed, we notify ALL children that their parent container(s) have changed, e.g. to update the + # list of "units this component is used in", "sections this subsection is used in", etc. in the search index. + old_title = old_version.title if old_version else "" + new_title = new_version.title if new_version else "" + if old_title != new_title: + # notify ALL current children, plus any deleted children, that their parent container(s) changed + changed_child_ids = list(set(new_child_ids) | (set(old_child_ids) - set(new_child_ids))) + else: + # Normal case: we only need to notify any added or removed children that their parent container(s) changed: + changed_child_ids = list(set(old_child_ids) ^ set(new_child_ids)) + + container_key = LibraryContainerLocator.from_string(container_key_str) + library = ContentLibrary.objects.get_by_key(container_key.lib_key) + entities = ( + content_api.get_publishable_entities(library.learning_package_id) + .filter(id__in=changed_child_ids) + .select_related("component", "container") + ) + for entity in entities: + child_key: LibraryUsageLocatorV2 | LibraryContainerLocator + if hasattr(entity, "component"): + child_key = api.library_component_usage_key(library.library_key, entity.component) + elif hasattr(entity, "container"): + child_key = api.library_container_locator(library.library_key, entity.container) + else: + log.error("Unknown publishable entity type: %s", entity) + continue + CONTENT_OBJECT_ASSOCIATIONS_CHANGED.send_event( + content_object=ContentObjectChangedData( + object_id=str(child_key), + changes=[container_key.container_type + "s"], # e.g. "units" + ), ) -def wait_for_post_revert_events(draft_change_log: DraftChangeLog, library_key: LibraryLocatorV2): +@shared_task(base=LoggedTask) +@set_code_owner_attribute +def send_collections_changed_events( + publishable_entity_ids: list[PublishableEntity.ID], + learning_package_id: LearningPackage.ID, + library_key_str: str, +): """ - After discard all changes in a library, trigger the required event handlers - (e.g. update the search index). Try to wait for that to complete before - returning, up to some reasonable timeout, and then finish anything remaining - asynchonrously. + Sends a CONTENT_OBJECT_ASSOCIATIONS_CHANGED event for each modified library + entity in the given list, because their associated collections have changed. + This is dispatched in response to a COLLECTION_CHANGED event, usually + because entities have been added to or removed from a collection. + + ⏳ This task is designed to be run asynchronously so it can handle many + entities, but you can also call it synchronously if you are only + processing a single entity. Handlers should be synchronous and fast, to + support the "update one item synchronously" use case, but can be async if + needed. """ - # Update the search index (and anything else) for the affected blocks - result = send_events_after_revert.apply_async(args=(draft_change_log.pk, str(library_key))) - # Try waiting a bit for those post-publish events to be handled: - try: - result.get(timeout=15) - except TimeoutError: - pass - # This is fine! The search index is still being updated, and/or other - # event handlers are still following up on the results, but the revert - # already *did* succeed, and the events will continue to be processed in - # the background by the celery worker until everything is updated. + library_key = LibraryLocatorV2.from_string(library_key_str) + entities = ( + content_api.get_publishable_entities(learning_package_id) + .filter(id__in=publishable_entity_ids) + # Ignore deleted items (both draft & published are deleted) that are still associated with the collection: + .exclude(draft__version=None, published__version=None) + .select_related("component", "container") + ) + + for entity in entities: + opaque_key: OpaqueKey + + if hasattr(entity, "component"): + opaque_key = api.library_component_usage_key(library_key, entity.component) + elif hasattr(entity, "container"): + opaque_key = api.library_container_locator(library_key, entity.container) + else: + log.error("Unknown publishable entity type: %s", entity) + continue + + # .. event_implemented_name: CONTENT_OBJECT_ASSOCIATIONS_CHANGED + # .. event_type: org.openedx.content_authoring.content.object.associations.changed.v1 + CONTENT_OBJECT_ASSOCIATIONS_CHANGED.send_event( + content_object=ContentObjectChangedData(object_id=str(opaque_key), changes=["collections"]), + ) @shared_task(base=LoggedTask) @set_code_owner_attribute -def import_blocks_from_course(import_task_id, course_key_str, use_course_key_as_block_id_suffix=True): +def send_events_after_publish(publish_log_id: int, library_key_str: str) -> None: """ - A Celery task to import blocks from a course through modulestore. - """ - ensure_cms("import_blocks_from_course may only be executed in a CMS context") + Send events to trigger actions like updating the search index, after we've + published some items in a library. - course_key = CourseKey.from_string(course_key_str) + We use the PublishLog record so we can detect exactly what was changed, + including any auto-published changes like child items in containers. - with ContentLibraryBlockImportTask.execute(import_task_id) as import_task: + This happens in a celery task so that it can be run asynchronously if + needed, because the "publish all changes" action can potentially publish + hundreds or even thousands of components/containers at once, and synchronous + event handlers like updating the search index may a while to complete in + that case. + """ + publish_log = PublishLog.objects.get(id=publish_log_id) + library_key = LibraryLocatorV2.from_string(library_key_str) + library = ContentLibrary.objects.get_by_key(library_key) + affected_entities = publish_log.records.select_related( + "entity", "entity__container", "entity__container__container_type", "entity__component", + ).all() - def on_progress(block_key, block_num, block_count, exception=None): - if exception: - log.exception('Import block failed: %s', block_key) - else: - log.info('Import block succesful: %s', block_key) - import_task.save_progress(block_num / block_count) + # Update anything that needs to be updated (e.g. search index): + for record in affected_entities: + if hasattr(record.entity, "component"): + usage_key = api.library_component_usage_key(library_key, record.entity.component) + # Note that this item may be newly created, updated, or even deleted - but all we care about for this event + # is that the published version is now different. Only for draft changes do we send differentiated events. - edx_client = api.EdxModulestoreImportClient( - library=import_task.library, - use_course_key_as_block_id_suffix=use_course_key_as_block_id_suffix - ) - edx_client.import_blocks_from_course( - course_key, on_progress - ) + # .. event_implemented_name: LIBRARY_BLOCK_PUBLISHED + # .. event_type: org.openedx.content_authoring.library_block.published.v1 + LIBRARY_BLOCK_PUBLISHED.send_event( + library_block=LibraryBlockData(library_key=library_key, usage_key=usage_key) + ) + elif hasattr(record.entity, "container"): + container_key = api.library_container_locator(library_key, record.entity.container) + # Note: this container may have been directly published, or perhaps one of its children was published and + # it hasn't technically changed. Such ancestors of published entities are still included in the publish log. + # .. event_implemented_name: LIBRARY_CONTAINER_PUBLISHED + # .. event_type: org.openedx.content_authoring.content_library.container.published.v1 + LIBRARY_CONTAINER_PUBLISHED.send_event( + library_container=LibraryContainerData(container_key=container_key) + ) + else: + log.warning( + f"PublishableEntity {record.entity.pk} / {record.entity.entity_ref} " + "was modified during publish operation but is of unknown type." + ) + + # When entities get newly published or their published version is deleted, update the "# of published entities in + # collection" count of any associated collections. + newly_published_or_unpublished_entity_ids = [ + r.entity_id for r in affected_entities if r.new_version is None or r.old_version is None + ] + if not newly_published_or_unpublished_entity_ids: + emit_collections_updated(library, entity_ids=newly_published_or_unpublished_entity_ids) def _filter_child(store, usage_key, capa_type): @@ -498,7 +568,7 @@ def _copy_overrides( if field.scope == Scope.settings and field.is_set_on(source_block): setattr(dest_block, field.name, field.read_from(source_block)) if source_block.has_children: - for source_child_key, dest_child_key in zip(source_block.children, dest_block.children): + for source_child_key, dest_child_key in zip(source_block.children, dest_block.children): # noqa: B905 _copy_overrides( store=store, user_id=user_id, @@ -553,15 +623,8 @@ def backup_library(self, user_id: int, library_key_str: str) -> None: self.status.set_state('Exporting') set_custom_attribute("exporting_started", str(library_key)) - root_dir = Path(mkdtemp()) - sanitized_lib_key = str(library_key).replace(":", "-") - sanitized_lib_key = slugify(sanitized_lib_key, allow_unicode=True) - timestamp = datetime.now().strftime("%Y-%m-%d-%H%M%S") - filename = f'{sanitized_lib_key}-{timestamp}.zip' - file_path = os.path.join(root_dir, filename) user = User.objects.get(id=user_id) - origin_server = getattr(settings, 'CMS_BASE', None) - create_lib_zip_file(lp_key=str(library_key), path=file_path, user=user, origin_server=origin_server) + _root_dir, file_path = api.create_library_v2_zip(library_key, user) set_custom_attribute("exporting_completed", str(library_key)) with open(file_path, 'rb') as zipfile: @@ -640,7 +703,7 @@ def load_learning_package(self, storage_path, user): TASK_LOGGER.info('Restoring learning package from temporary file %s', tmp_file.name) - result = authoring_api.load_learning_package(tmp_file.name, user=user) + result = content_api.load_learning_package(tmp_file.name, user=user) # If there was an error during the load, fail the task with the error log if result.get("status") == "error": @@ -671,7 +734,7 @@ def restore_library(self, user_id, storage_path): TASK_LOGGER.info( 'Restored learning package (id: %s) with key %s', learning_package_data.get('id'), - learning_package_data.get('key') + learning_package_data.get('package_ref') ) # Save the restore details as an artifact in JSON format @@ -692,3 +755,54 @@ def restore_library(self, user_id, storage_path): # Make sure to clean up the uploaded file from storage course_import_export_storage.delete(storage_path) TASK_LOGGER.info('Deleted uploaded file %s after restore', storage_path) + + +def dispatch_and_wait(task_fn: Task, wait_for_full_completion: bool = False, **kwargs) -> None: + """ + Try to wait for the given celery task to complete before returning, + up to some reasonable timeout, and then finish anything remaining work + asynchonrously. + + Note: we're not using async python, so this function will unfortunately + block the current CMS worker for a few seconds. + + Usage example + ------------- + + Instead of:: + + tasks.send_change_events_for_modified_entities.delay(...) + + Do:: + + dispatch_and_wait( + tasks.send_change_events_for_modified_entities, + ... + ) + + The ``wait_for_full_completion`` param is to simplify a common pattern. When + it's True, this will just call the function directly (not using celery) and + wait indefinitely for it to complete. When it's False, we'll dispatch the + task using celery and wait up to a given timeout. So you should set it True + if you are fairly certain the task will be able to complete quickly (e.g. + when processing a small number of changes). + """ + if wait_for_full_completion: + task_fn(**kwargs) + return + + result: AsyncResult = task_fn.delay(**kwargs) + # Try waiting a bit for the task to finish before we complete the request: + try: + # We use `disable_sync_subtasks=False` because some of our tasks emit + # events whose handlers then spawn additional tasks which are sometimes + # synchronous. Ideal usage of celery would be to "chain" the tasks + # instead of spawning subtasks, but that would require a major refactor. + result.get(timeout=10, disable_sync_subtasks=False) + except CeleryTimeout: + pass + # This is fine! The search index is still being updated, and/or other + # event handlers are still following up on the results, but the action + # that let to this event handler being called already *did* succeed, + # and the events will continue to be processed in the background by the + # celery worker until everything is updated. diff --git a/openedx/core/djangoapps/content_libraries/tests/__init__.py b/openedx/core/djangoapps/content_libraries/tests/__init__.py index 18083ab3e0ac..880199a78ea5 100644 --- a/openedx/core/djangoapps/content_libraries/tests/__init__.py +++ b/openedx/core/djangoapps/content_libraries/tests/__init__.py @@ -1,4 +1,4 @@ """ Python API for testing content libraries """ -from .base import * +from .base import * # noqa: F403 diff --git a/openedx/core/djangoapps/content_libraries/tests/base.py b/openedx/core/djangoapps/content_libraries/tests/base.py index 9ccd33f942c2..8e5a9bb264ff 100644 --- a/openedx/core/djangoapps/content_libraries/tests/base.py +++ b/openedx/core/djangoapps/content_libraries/tests/base.py @@ -1,15 +1,16 @@ """ -Tests for Learning-Core-based Content Libraries +Tests for openedx_content-based Content Libraries """ -from contextlib import contextmanager import json +from contextlib import contextmanager from io import BytesIO from urllib.parse import urlencode -from organizations.models import Organization -from rest_framework.test import APITransactionTestCase, APIClient from opaque_keys.edx.keys import ContainerKey, UsageKey -from opaque_keys.edx.locator import LibraryLocatorV2, LibraryCollectionLocator +from opaque_keys.edx.locator import LibraryCollectionLocator, LibraryLocatorV2 +from openedx_content import models_api as content_models +from organizations.models import Organization +from rest_framework.test import APIClient, APITransactionTestCase from common.djangoapps.student.tests.factories import UserFactory from common.djangoapps.util.json_request import JsonResponse as SpecialJsonResponse @@ -38,6 +39,10 @@ URL_LIB_RESTORE_GET = URL_LIB_RESTORE + '?{query_params}' # Get status/result of a library restore task URL_LIB_BLOCK = URL_PREFIX + 'blocks/{block_key}/' # Get data about a block, or delete it URL_LIB_BLOCK_PUBLISH = URL_LIB_BLOCK + 'publish/' # Publish changes from a specified XBlock +URL_LIB_BLOCK_DRAFT_HISTORY = URL_LIB_BLOCK + 'draft_history/' # Draft change history for a block +URL_LIB_BLOCK_PUBLISH_HISTORY = URL_LIB_BLOCK + 'publish_history/' # Publish event history for a block +URL_LIB_PUBLISH_HISTORY_ENTRIES = URL_LIB_DETAIL + 'publish_history_entries/' +URL_LIB_BLOCK_CREATION_ENTRY = URL_LIB_BLOCK + 'creation_entry/' URL_LIB_BLOCK_OLX = URL_LIB_BLOCK + 'olx/' # Get or set the OLX of the specified XBlock URL_LIB_BLOCK_ASSETS = URL_LIB_BLOCK + 'assets/' # List the static asset files of the specified XBlock URL_LIB_BLOCK_ASSET_FILE = URL_LIB_BLOCK + 'assets/{file_name}' # Get, delete, or upload a specific static asset file @@ -49,13 +54,12 @@ URL_LIB_CONTAINER_COLLECTIONS = URL_LIB_CONTAINER + 'collections/' # Handle associated collections URL_LIB_CONTAINER_PUBLISH = URL_LIB_CONTAINER + 'publish/' # Publish changes to the specified container + children URL_LIB_CONTAINER_COPY = URL_LIB_CONTAINER + 'copy/' # Copy the specified container to the clipboard +URL_LIB_CONTAINER_DRAFT_HISTORY = URL_LIB_CONTAINER + 'draft_history/' # Draft change history for a container +URL_LIB_CONTAINER_PUBLISH_HISTORY = URL_LIB_CONTAINER + 'publish_history/' # Publish event history for a container +URL_LIB_CONTAINER_CREATION_ENTRY = URL_LIB_CONTAINER + 'creation_entry/' # Creation entry for a container URL_LIB_COLLECTION = URL_LIB_COLLECTIONS + '{collection_key}/' # Get a collection in this library URL_LIB_COLLECTION_ITEMS = URL_LIB_COLLECTION + 'items/' # Get a collection in this library -URL_LIB_LTI_PREFIX = URL_PREFIX + 'lti/1.3/' -URL_LIB_LTI_JWKS = URL_LIB_LTI_PREFIX + 'pub/jwks/' -URL_LIB_LTI_LAUNCH = URL_LIB_LTI_PREFIX + 'launch/' - URL_BLOCK_RENDER_VIEW = '/api/xblock/v2/xblocks/{block_key}/view/{view_name}/' URL_BLOCK_EMBED_VIEW = '/xblocks/v2/{block_key}/embed/{view_name}/' # Returns HTML not JSON so its URL is different URL_BLOCK_GET_HANDLER_URL = '/api/xblock/v2/xblocks/{block_key}/handler_url/{handler_name}/' @@ -67,7 +71,7 @@ @skip_unless_cms # Content Libraries REST API is only available in Studio class ContentLibrariesRestApiTest(APITransactionTestCase): """ - Base class for Learning-Core-based Content Libraries test that use the REST API + Base class for openedx_content-based Content Libraries test that use the REST API These tests use the REST API, which in turn relies on the Python API. Some tests may use the python API directly if necessary to provide @@ -95,6 +99,11 @@ def setUp(self): self.clients_by_user = {} self.client.login(username=self.user.username, password="edx") + def tearDown(self): + # If we're working with Containers in test cases, we need this line: + content_models.Container.reset_cache() + return super().tearDown() + # Assertions def assertDictContainsEntries(self, big_dict, subset_dict): @@ -321,6 +330,48 @@ def _publish_library_block(self, block_key, expect_response=200): """ Publish changes from a specified XBlock """ return self._api('post', URL_LIB_BLOCK_PUBLISH.format(block_key=block_key), None, expect_response) + def _get_block_draft_history(self, block_key, expect_response=200): + """ Get the draft change history for a block since its last publication """ + return self._api('get', URL_LIB_BLOCK_DRAFT_HISTORY.format(block_key=block_key), None, expect_response) + + def _get_block_publish_history(self, block_key, expect_response=200): + """ Get the publish event history for a block """ + return self._api('get', URL_LIB_BLOCK_PUBLISH_HISTORY.format(block_key=block_key), None, expect_response) + + def _get_container_publish_history(self, container_key, expect_response=200): + """ Get the publish event history for a container """ + return self._api( + 'get', URL_LIB_CONTAINER_PUBLISH_HISTORY.format(container_key=container_key), None, expect_response + ) + + def _get_publish_history_entries(self, lib_key, scope_entity_key, publish_log_uuid, expect_response=200): + """ Get the draft change entries for a specific publish event (component or container) """ + url = URL_LIB_PUBLISH_HISTORY_ENTRIES.format(lib_key=lib_key) + url += f'?scope_entity_key={scope_entity_key}&publish_log_uuid={publish_log_uuid}' + return self._api('get', url, None, expect_response) + + def _get_block_publish_history_entries(self, block_key, publish_log_uuid, expect_response=200): + """ Get the draft change entries for a specific publish event for a component block """ + parsed_key = UsageKey.from_string(block_key) if isinstance(block_key, str) else block_key + lib_key = parsed_key.lib_key + return self._get_publish_history_entries(lib_key, block_key, publish_log_uuid, expect_response) + + def _get_container_publish_history_entries(self, container_key, publish_log_uuid, expect_response=200): + """ Get the draft change entries for a specific publish event for a container """ + parsed_key = ContainerKey.from_string(container_key) if isinstance(container_key, str) else container_key + lib_key = parsed_key.lib_key + return self._get_publish_history_entries(lib_key, container_key, publish_log_uuid, expect_response) + + def _get_block_creation_entry(self, block_key, expect_response=200): + """ Get the creation entry for a block (the moment it was first saved) """ + return self._api('get', URL_LIB_BLOCK_CREATION_ENTRY.format(block_key=block_key), None, expect_response) + + def _get_container_creation_entry(self, container_key, expect_response=200): + """ Get the creation entry for a container (the moment it was first saved) """ + return self._api( + 'get', URL_LIB_CONTAINER_CREATION_ENTRY.format(container_key=container_key), None, expect_response + ) + def _paste_clipboard_content_in_library(self, lib_key, expect_response=200): """ Paste's the users clipboard content into Library """ url = URL_LIB_PASTE_CLIPBOARD.format(lib_key=lib_key) @@ -378,7 +429,7 @@ def _embed_block( if version is not None: url += f"?version={version}" response = self.client.get(url) - assert response.status_code == expect_response, 'Unexpected response code {}:'.format(response.status_code) + assert response.status_code == expect_response, 'Unexpected response code {}:'.format(response.status_code) # noqa: UP032 # pylint: disable=line-too-long return response.content.decode() def _get_block_handler_url(self, block_key, handler_name): @@ -408,9 +459,15 @@ def _set_library_block_fields(self, block_key, new_fields, expect_response=200): """ Set the fields of a specific block in the library. This API is only used by the MFE editors. """ return self._api('post', URL_BLOCK_FIELDS_URL.format(block_key=block_key), new_fields, expect_response) - def _create_container(self, lib_key, container_type, slug: str | None, display_name: str, expect_response=200): + def _create_container(self, + lib_key, + container_type_code: str, + slug: str | None, + display_name: str, + expect_response=200, + ): """ Create a container (unit etc.) """ - data = {"container_type": container_type, "display_name": display_name} + data = {"container_type_code": container_type_code, "display_name": display_name} if slug: data["slug"] = slug return self._api('post', URL_LIB_CONTAINERS.format(lib_key=lib_key), data, expect_response) @@ -432,11 +489,11 @@ def _restore_container(self, container_key: ContainerKey | str, expect_response= """ Restore a deleted a container (unit etc.) """ return self._api('post', URL_LIB_CONTAINER_RESTORE.format(container_key=container_key), None, expect_response) - def _get_container_children(self, container_key: ContainerKey | str, expect_response=200): + def _get_container_children(self, container_key: ContainerKey | str, published=False, expect_response=200): """ Get container children""" return self._api( 'get', - URL_LIB_CONTAINER_CHILDREN.format(container_key=container_key), + URL_LIB_CONTAINER_CHILDREN.format(container_key=container_key) + ("?published=true" if published else ""), None, expect_response ) @@ -501,6 +558,15 @@ def _publish_container(self, container_key: ContainerKey | str, expect_response= """ Publish all changes in the specified container + children """ return self._api('post', URL_LIB_CONTAINER_PUBLISH.format(container_key=container_key), None, expect_response) + def _get_container_draft_history(self, container_key: ContainerKey | str, expect_response=200): + """ Get the draft change history for a container and its descendants since the last publication """ + return self._api( + 'get', + URL_LIB_CONTAINER_DRAFT_HISTORY.format(container_key=container_key), + None, + expect_response, + ) + def _copy_container(self, container_key: ContainerKey | str, expect_response=200): """ Copy the specified container to the clipboard """ return self._api('post', URL_LIB_CONTAINER_COPY.format(container_key=container_key), None, expect_response) diff --git a/openedx/core/djangoapps/content_libraries/tests/fields_test_block.py b/openedx/core/djangoapps/content_libraries/tests/fields_test_block.py index 0db5ac28d7a8..8978132f7870 100644 --- a/openedx/core/djangoapps/content_libraries/tests/fields_test_block.py +++ b/openedx/core/djangoapps/content_libraries/tests/fields_test_block.py @@ -3,10 +3,10 @@ """ import json -from webob import Response from web_fragments.fragment import Fragment -from xblock.core import XBlock, Scope +from webob import Response from xblock import fields +from xblock.core import Scope, XBlock class FieldsTestBlock(XBlock): diff --git a/openedx/core/djangoapps/content_libraries/tests/test_api.py b/openedx/core/djangoapps/content_libraries/tests/test_api.py index 2247a3188ee8..1060ec42713e 100644 --- a/openedx/core/djangoapps/content_libraries/tests/test_api.py +++ b/openedx/core/djangoapps/content_libraries/tests/test_api.py @@ -2,274 +2,58 @@ Tests for Content Library internal api. """ -import base64 -import hashlib import uuid from unittest import mock -from django.test import TestCase -from user_tasks.models import UserTaskStatus - -from opaque_keys.edx.keys import ( - CourseKey, - UsageKey, - UsageKeyV2, -) +from django.db import transaction +from opaque_keys.edx.keys import UsageKeyV2 from opaque_keys.edx.locator import LibraryContainerLocator, LibraryLocatorV2, LibraryUsageLocatorV2 +from openedx_authz.api.users import get_user_role_assignments_in_scope +from openedx_content import api as content_api +from openedx_content import models_api as content_models +from openedx_content.models_api import Component, Container from openedx_events.content_authoring.data import ( ContentObjectChangedData, + LibraryBlockData, LibraryCollectionData, LibraryContainerData, ) from openedx_events.content_authoring.signals import ( CONTENT_OBJECT_ASSOCIATIONS_CHANGED, + LIBRARY_BLOCK_DELETED, + LIBRARY_BLOCK_UPDATED, LIBRARY_COLLECTION_CREATED, LIBRARY_COLLECTION_DELETED, LIBRARY_COLLECTION_UPDATED, + LIBRARY_CONTAINER_DELETED, LIBRARY_CONTAINER_UPDATED, ) -from openedx_authz.api.users import get_user_role_assignments_in_scope -from openedx_learning.api import authoring as authoring_api +from openedx_events.testing import EventsIsolationMixin +from openedx_events.tooling import OpenEdxPublicSignal +from user_tasks.models import UserTaskStatus from common.djangoapps.student.tests.factories import UserFactory + from .. import api from ..models import ContentLibrary from .base import ContentLibrariesRestApiTest -class EdxModulestoreImportClientTest(TestCase): - """ - Tests for course importing APIs. - """ - - def setUp(self): - """ - Setup mocks and the test client. - """ - super().setUp() - self.mock_library = mock.MagicMock() - self.modulestore_mock = mock.MagicMock() - self.client = api.EdxModulestoreImportClient( - modulestore_instance=self.modulestore_mock, - library=self.mock_library - ) - - def test_instantiate_without_args(self): - """ - When instantiated without args, - Then raises. - """ - with self.assertRaises(ValueError): - api.EdxModulestoreImportClient() - - def test_import_blocks_from_course_without_course(self): - """ - Given no course, - Then raises. - """ - self.modulestore_mock.get_course.return_value.get_children.return_value = [] - with self.assertRaises(ValueError): - self.client.import_blocks_from_course('foobar', lambda *_: None) - - @mock.patch('openedx.core.djangoapps.content_libraries.api.courseware_import.create_library_block') - @mock.patch('openedx.core.djangoapps.content_libraries.api.courseware_import.get_library_block') - @mock.patch('openedx.core.djangoapps.content_libraries.api.courseware_import.get_library_block_static_asset_files') - @mock.patch('openedx.core.djangoapps.content_libraries.api.courseware_import.publish_changes') - @mock.patch('openedx.core.djangoapps.content_libraries.api.courseware_import.set_library_block_olx') - def test_import_blocks_from_course_on_block_with_olx( - self, - mock_set_library_block_olx, - mock_publish_changes, - mock_get_library_block_static_asset_files, - mock_get_library_block, - mock_create_library_block, - ): - """ - Given a course with one block - When called - Then extract OLX, write to library and publish. - """ - - usage_key_str = 'lb:foo:bar:foobar:1234' - library_key_str = 'lib:foo:bar' - - self.client.get_export_keys = mock.MagicMock(return_value=[UsageKey.from_string(usage_key_str)]) - self.client.get_block_data = mock.MagicMock(return_value={'olx': 'fake-olx'}) - - mock_create_library_block.side_effect = api.LibraryBlockAlreadyExists - self.mock_library.library_key = LibraryLocatorV2.from_string(library_key_str) - - self.client.import_blocks_from_course('foobar', lambda *_: None) - - mock_get_library_block.assert_called_once() - mock_get_library_block_static_asset_files.assert_called_once() - mock_set_library_block_olx.assert_called_once_with( - mock.ANY, 'fake-olx') - mock_publish_changes.assert_called_once() - - @mock.patch('openedx.core.djangoapps.content_libraries.api.courseware_import.create_library_block') - @mock.patch('openedx.core.djangoapps.content_libraries.api.courseware_import.get_library_block_static_asset_files') - @mock.patch('openedx.core.djangoapps.content_libraries.api.courseware_import.set_library_block_olx') - def test_import_block_when_called_twice_same_block_but_different_course( - self, - mock_set_library_block_olx, - mock_get_library_block_static_asset_files, - mock_create_library_block, - ): - """ - Given an block used by one course - And another block with same id use by a different course - And import_block() was called on the first block - When import_block() is called on the second block - Then create a library block for the second block - """ - course_key_str = 'block-v1:FakeCourse+FakeOrg+FakeRun+type@a-fake-block-type+block@fake-block-id' - - modulestore_usage_key = UsageKey.from_string(course_key_str) - expected_course_key_hash = base64.b32encode( - hashlib.blake2s( - str(modulestore_usage_key.course_key).encode() - ).digest() - )[:16].decode().lower() - expected_usage_id = f"{modulestore_usage_key.block_id}_c{expected_course_key_hash}" - - self.client.get_block_data = mock.MagicMock() - self.client.import_block(modulestore_usage_key) - - mock_create_library_block.assert_called_with( - self.client.library.library_key, - modulestore_usage_key.block_type, - expected_usage_id) - mock_get_library_block_static_asset_files.assert_called_once() - mock_set_library_block_olx.assert_called_once() - - -@mock.patch('openedx.core.djangoapps.content_libraries.api.courseware_import.OAuthAPIClient') -class EdxApiImportClientTest(TestCase): - """ - Tests for EdxApiImportClient. - """ - - LMS_URL = 'https://foobar_lms.example.com/' - - STUDIO_URL = 'https://foobar_studio.example.com/' - - library_key_str = 'lib:foobar_content:foobar_library' - - course_key_str = 'course-v1:AFakeCourse+FooBar+1' - - def create_mock_library(self, *, course_id=None, course_key_str=None): - """ - Create a library mock. - """ - mock_library = mock.MagicMock() - mock_library.library_key = LibraryLocatorV2.from_string( - self.library_key_str - ) - if course_key_str is None: - course_key_str = self.course_key_str - if course_id is None: - course_id = CourseKey.from_string(course_key_str) - type(mock_library).course_id = mock.PropertyMock(return_value=course_id) - return mock_library - - def create_client(self, *, mock_library=None): - """ - Create a edX API import client mock. - """ - return api.EdxApiImportClient( - self.LMS_URL, - self.STUDIO_URL, - 'foobar_oauth_key', - 'foobar_oauth_secret', - library=(mock_library or self.create_mock_library()), - ) - - def mock_oauth_client_response(self, mock_oauth_client, *, content=None, exception=None): - """ - Setup a mock response for oauth client GET calls. - """ - mock_response = mock.MagicMock() - mock_content = None - if exception: - mock_response.raise_for_status.side_effect = exception - if content: - mock_content = mock.PropertyMock(return_value='foobar_file_content') - type(mock_response).content = mock_content - mock_oauth_client.get.return_value = mock_response - if mock_content: - return mock_response, mock_content - return mock_response - - @mock.patch('openedx.core.djangoapps.content_libraries.api.courseware_import.add_library_block_static_asset_file') - @mock.patch('openedx.core.djangoapps.content_libraries.api.courseware_import.create_library_block') - @mock.patch('openedx.core.djangoapps.content_libraries.api.courseware_import.get_library_block_static_asset_files') - @mock.patch('openedx.core.djangoapps.content_libraries.api.courseware_import.publish_changes') - @mock.patch('openedx.core.djangoapps.content_libraries.api.courseware_import.set_library_block_olx') - def test_import_block_when_url_is_from_studio( - self, - mock_set_library_block_olx, - mock_publish_changes, - mock_get_library_block_static_asset_files, - mock_create_library_block, - mock_add_library_block_static_asset_file, - mock_oauth_client_class, - ): - """ - Given an block with one asset provided by a studio. - When import_block() is called on the block. - Then a GET to the API endpoint is. - """ - - # Setup mocks. - - static_filename = 'foobar_filename' - static_content = 'foobar_file_content' - block_olx = 'foobar-olx' - usage_key = UsageKey.from_string('lb:foo:bar:foobar:1234') - # We ensure ``export-file`` belongs to the URL. - asset_studio_url = f"{self.STUDIO_URL}/foo/bar/export-file/foo/bar" - block_data = { - 'olx': block_olx, - 'static_files': {static_filename: {'url': asset_studio_url}} - } - _, mock_content = self.mock_oauth_client_response( - mock_oauth_client_class.return_value, - content=static_content, - ) - mock_create_library_block.return_value.usage_key = usage_key - - # Create client and call. - - client = self.create_client() - client.get_block_data = mock.MagicMock(return_value=block_data) - client.import_block(usage_key) - - # Assertions. - - client.get_block_data.assert_called_once_with(usage_key) - mock_create_library_block.assert_called_once() - mock_get_library_block_static_asset_files.assert_called_once() - mock_content.assert_called() - mock_add_library_block_static_asset_file.assert_called_once_with( - usage_key, - static_filename, - static_content - ) - mock_set_library_block_olx.assert_called_once_with( - usage_key, - block_olx - ) - mock_publish_changes.assert_not_called() - - -class ContentLibraryCollectionsTest(ContentLibrariesRestApiTest): +class ContentLibraryCollectionsTest(ContentLibrariesRestApiTest, EventsIsolationMixin): """ Tests for Content Library API collections methods. Same guidelines as ContentLibrariesTestCase. """ + @classmethod + def setUpClass(cls): + """Test setup""" + super().setUpClass() + # By default, errors thrown in signal handlers get suppressed. We want to see them though! + # https://github.com/openedx/openedx-events/issues/569 + cls.allow_send_events_failure(*(s.event_type for s in OpenEdxPublicSignal.all_events())) + def setUp(self) -> None: super().setUp() @@ -320,7 +104,7 @@ def setUp(self) -> None: # Create a subsection container self.subsection1 = api.create_container( self.lib1.library_key, - api.ContainerType.Subsection, + content_models.Subsection, 'subsection-1', 'Subsection 1', None, @@ -341,7 +125,7 @@ def test_create_library_collection(self) -> None: description="Description for Collection 4", created_by=self.user.id, ) - assert collection.key == "COL4" + assert collection.collection_code == "COL4" assert collection.title == "Collection 4" assert collection.description == "Description for Collection 4" assert collection.created_by == self.user @@ -363,7 +147,7 @@ def test_create_library_collection(self) -> None: def test_create_library_collection_invalid_library(self) -> None: library_key = LibraryLocatorV2.from_string("lib:INVALID:test-lib-does-not-exist") - with self.assertRaises(api.ContentLibraryNotFound) as exc: + with self.assertRaises(api.ContentLibraryNotFound) as exc: # noqa: F841, PT027 api.create_library_collection( library_key, collection_key="COL4", @@ -376,10 +160,10 @@ def test_update_library_collection(self) -> None: self.col1 = api.update_library_collection( self.lib1.library_key, - self.col1.key, + self.col1.collection_code, title="New title for Collection 1", ) - assert self.col1.key == "COL1" + assert self.col1.collection_code == "COL1" assert self.col1.title == "New title for Collection 1" assert self.col1.description == "Description for Collection 1" assert self.col1.created_by == self.user @@ -400,10 +184,10 @@ def test_update_library_collection(self) -> None: ) def test_update_library_collection_wrong_library(self) -> None: - with self.assertRaises(api.ContentLibraryCollectionNotFound) as exc: + with self.assertRaises(api.ContentLibraryCollectionNotFound) as exc: # noqa: F841, PT027 api.update_library_collection( self.lib1.library_key, - self.col2.key, + self.col2.collection_code, ) def test_delete_library_collection(self) -> None: @@ -411,9 +195,9 @@ def test_delete_library_collection(self) -> None: LIBRARY_COLLECTION_DELETED.connect(event_receiver) assert self.lib1.learning_package_id is not None - authoring_api.delete_collection( + content_api.delete_collection( self.lib1.learning_package_id, - self.col1.key, + self.col1.collection_code, hard_delete=True, ) @@ -437,7 +221,7 @@ def test_update_library_collection_items(self) -> None: self.col1 = api.update_library_collection_items( self.lib1.library_key, - self.col1.key, + self.col1.collection_code, opaque_keys=[ LibraryUsageLocatorV2.from_string(self.lib1_problem_block["id"]), LibraryUsageLocatorV2.from_string(self.lib1_html_block["id"]), @@ -448,7 +232,7 @@ def test_update_library_collection_items(self) -> None: self.col1 = api.update_library_collection_items( self.lib1.library_key, - self.col1.key, + self.col1.collection_code, opaque_keys=[ LibraryUsageLocatorV2.from_string(self.lib1_html_block["id"]), ], @@ -466,7 +250,7 @@ def test_update_library_collection_components_event(self) -> None: api.update_library_collection_items( self.lib1.library_key, - self.col1.key, + self.col1.collection_code, opaque_keys=[ LibraryUsageLocatorV2.from_string(self.lib1_problem_block["id"]), LibraryUsageLocatorV2.from_string(self.lib1_html_block["id"]), @@ -478,11 +262,12 @@ def test_update_library_collection_components_event(self) -> None: self.assertDictContainsEntries( event_receiver.call_args_list[0].kwargs, { - "signal": CONTENT_OBJECT_ASSOCIATIONS_CHANGED, - "sender": None, - "content_object": ContentObjectChangedData( - object_id=self.lib1_problem_block["id"], - changes=["collections"], + "signal": LIBRARY_COLLECTION_UPDATED, + "library_collection": LibraryCollectionData( + collection_key=api.library_collection_locator( + self.lib1.library_key, + collection_key="COL1", + ), ), }, ) @@ -490,9 +275,8 @@ def test_update_library_collection_components_event(self) -> None: event_receiver.call_args_list[1].kwargs, { "signal": CONTENT_OBJECT_ASSOCIATIONS_CHANGED, - "sender": None, "content_object": ContentObjectChangedData( - object_id=self.lib1_html_block["id"], + object_id=self.lib1_problem_block["id"], changes=["collections"], ), }, @@ -501,9 +285,8 @@ def test_update_library_collection_components_event(self) -> None: event_receiver.call_args_list[2].kwargs, { "signal": CONTENT_OBJECT_ASSOCIATIONS_CHANGED, - "sender": None, "content_object": ContentObjectChangedData( - object_id=self.unit1["id"], + object_id=self.lib1_html_block["id"], changes=["collections"], ), }, @@ -511,22 +294,19 @@ def test_update_library_collection_components_event(self) -> None: self.assertDictContainsEntries( event_receiver.call_args_list[3].kwargs, { - "signal": LIBRARY_COLLECTION_UPDATED, - "sender": None, - "library_collection": LibraryCollectionData( - collection_key=api.library_collection_locator( - self.lib1.library_key, - collection_key="COL1", - ), + "signal": CONTENT_OBJECT_ASSOCIATIONS_CHANGED, + "content_object": ContentObjectChangedData( + object_id=self.unit1["id"], + changes=["collections"], ), }, ) def test_update_collection_components_from_wrong_library(self) -> None: - with self.assertRaises(api.ContentLibraryBlockNotFound) as exc: + with self.assertRaises(api.ContentLibraryBlockNotFound) as exc: # noqa: PT027 api.update_library_collection_items( self.lib2.library_key, - self.col2.key, + self.col2.collection_code, opaque_keys=[ LibraryUsageLocatorV2.from_string(self.lib1_problem_block["id"]), LibraryUsageLocatorV2.from_string(self.lib1_html_block["id"]), @@ -544,13 +324,15 @@ def test_set_library_component_collections(self) -> None: component = api.get_component_from_usage_key(UsageKeyV2.from_string(self.lib2_problem_block["id"])) api.set_library_item_collections( library_key=self.lib2.library_key, - entity_key=component.publishable_entity.key, - collection_keys=[self.col2.key, self.col3.key], + entity_ref=component.publishable_entity.entity_ref, + collection_keys=[self.col2.collection_code, self.col3.collection_code], ) assert self.lib2.learning_package_id is not None - assert len(authoring_api.get_collection(self.lib2.learning_package_id, self.col2.key).entities.all()) == 1 - assert len(authoring_api.get_collection(self.lib2.learning_package_id, self.col3.key).entities.all()) == 1 + col2 = content_api.get_collection(self.lib2.learning_package_id, self.col2.collection_code) + col3 = content_api.get_collection(self.lib2.learning_package_id, self.col3.collection_code) + assert len(col2.entities.all()) == 1 + assert len(col3.entities.all()) == 1 self.assertDictContainsEntries( event_receiver.call_args_list[0].kwargs, @@ -569,19 +351,21 @@ def test_set_library_component_collections(self) -> None: assert all(event["signal"] == LIBRARY_COLLECTION_UPDATED for event in collection_update_events) assert {event["library_collection"] for event in collection_update_events} == { LibraryCollectionData( - collection_key=api.library_collection_locator(self.lib2.library_key, collection_key=self.col2.key), - background=True, + collection_key=api.library_collection_locator( + self.lib2.library_key, collection_key=self.col2.collection_code + ) ), LibraryCollectionData( - collection_key=api.library_collection_locator(self.lib2.library_key, collection_key=self.col3.key), - background=True, - ) + collection_key=api.library_collection_locator( + self.lib2.library_key, collection_key=self.col3.collection_code + ) + ), } def test_delete_library_block(self) -> None: api.update_library_collection_items( self.lib1.library_key, - self.col1.key, + self.col1.collection_code, opaque_keys=[ LibraryUsageLocatorV2.from_string(self.lib1_problem_block["id"]), LibraryUsageLocatorV2.from_string(self.lib1_html_block["id"]), @@ -601,10 +385,8 @@ def test_delete_library_block(self) -> None: "sender": None, "library_collection": LibraryCollectionData( collection_key=api.library_collection_locator( - self.lib1.library_key, - collection_key=self.col1.key, + self.lib1.library_key, collection_key=self.col1.collection_code ), - background=True, ), }, ) @@ -612,7 +394,7 @@ def test_delete_library_block(self) -> None: def test_delete_library_container(self) -> None: api.update_library_collection_items( self.lib1.library_key, - self.col1.key, + self.col1.collection_code, opaque_keys=[ LibraryUsageLocatorV2.from_string(self.lib1_problem_block["id"]), LibraryUsageLocatorV2.from_string(self.lib1_html_block["id"]), @@ -635,44 +417,109 @@ def test_delete_library_container(self) -> None: assert event_receiver.call_count == 2 self.assertDictContainsEntries( event_receiver.call_args_list[0].kwargs, + { + "signal": LIBRARY_CONTAINER_UPDATED, + "sender": None, + "library_container": LibraryContainerData( + container_key=self.subsection1.container_key, + background=False, + ), + }, + ) + self.assertDictContainsEntries( + event_receiver.call_args_list[1].kwargs, { "signal": LIBRARY_COLLECTION_UPDATED, "sender": None, "library_collection": LibraryCollectionData( collection_key=api.library_collection_locator( self.lib1.library_key, - collection_key=self.col1.key, + collection_key=self.col1.collection_code, ), - background=True, ), }, ) + + def test_delete_container_when_container_does_not_exist(self) -> None: + """ + Test that delete_container raises Container.DoesNotExist and still sends + LIBRARY_CONTAINER_DELETED (to clean up stale search-index entries) when + the Container does not exist in the DB. + """ + container_key = LibraryContainerLocator.from_string(self.unit1["id"]) + + event_receiver = mock.Mock() + LIBRARY_CONTAINER_DELETED.connect(event_receiver) + self.addCleanup(LIBRARY_CONTAINER_DELETED.disconnect, event_receiver) + + with mock.patch( + "openedx.core.djangoapps.content_libraries.api.containers.get_container_from_key", + side_effect=Container.DoesNotExist, + ), mock.patch("openedx_content.api.soft_delete_draft") as mock_soft_delete: + with self.assertRaises(Container.DoesNotExist): # noqa: PT027 + api.delete_container(container_key) + mock_soft_delete.assert_not_called() + + assert event_receiver.call_count == 1 self.assertDictContainsEntries( - event_receiver.call_args_list[1].kwargs, + event_receiver.call_args_list[0].kwargs, { - "signal": LIBRARY_CONTAINER_UPDATED, - "sender": None, + "signal": LIBRARY_CONTAINER_DELETED, "library_container": LibraryContainerData( - container_key=self.subsection1.container_key, - background=False, - ) + container_key=container_key, + ), + }, + ) + + def test_delete_library_block_when_component_does_not_exist(self) -> None: + """ + Test that delete_library_block raises Component.DoesNotExist and still sends + LIBRARY_BLOCK_DELETED (to clean up stale search-index entries) when the + Component does not exist in the DB. + """ + usage_key = LibraryUsageLocatorV2.from_string(self.lib1_problem_block["id"]) + + event_receiver = mock.Mock() + LIBRARY_BLOCK_DELETED.connect(event_receiver) + self.addCleanup(LIBRARY_BLOCK_DELETED.disconnect, event_receiver) + + with mock.patch( + "openedx.core.djangoapps.content_libraries.api.blocks.get_component_from_usage_key", + side_effect=Component.DoesNotExist, + ), mock.patch("openedx_content.api.soft_delete_draft") as mock_soft_delete: + with self.assertRaises(Component.DoesNotExist): # noqa: PT027 + api.delete_library_block(usage_key) + mock_soft_delete.assert_not_called() + + assert event_receiver.call_count == 1 + self.assertDictContainsEntries( + event_receiver.call_args_list[0].kwargs, + { + "signal": LIBRARY_BLOCK_DELETED, + "library_block": LibraryBlockData( + library_key=self.lib1.library_key, + usage_key=usage_key, + ), }, ) def test_restore_library_block(self) -> None: + usage_key = LibraryUsageLocatorV2.from_string(self.lib1_problem_block["id"]) api.update_library_collection_items( self.lib1.library_key, - self.col1.key, + self.col1.collection_code, opaque_keys=[ - LibraryUsageLocatorV2.from_string(self.lib1_problem_block["id"]), + usage_key, LibraryUsageLocatorV2.from_string(self.lib1_html_block["id"]), ], ) + api.delete_library_block(usage_key) + event_receiver = mock.Mock() LIBRARY_COLLECTION_UPDATED.connect(event_receiver) - api.restore_library_block(LibraryUsageLocatorV2.from_string(self.lib1_problem_block["id"])) + api.restore_library_block(usage_key) assert event_receiver.call_count == 1 self.assertDictContainsEntries( @@ -683,9 +530,8 @@ def test_restore_library_block(self) -> None: "library_collection": LibraryCollectionData( collection_key=api.library_collection_locator( self.lib1.library_key, - collection_key=self.col1.key, + collection_key=self.col1.collection_code, ), - background=True, ), }, ) @@ -702,7 +548,7 @@ def test_add_component_and_revert(self) -> None: # Add component. Note: collections are not part of the draft/publish cycle so this is not a draft change. api.update_library_collection_items( self.lib1.library_key, - self.col1.key, + self.col1.collection_code, opaque_keys=[ LibraryUsageLocatorV2.from_string(self.lib1_html_block["id"]), LibraryUsageLocatorV2.from_string(new_problem_block["id"]), @@ -712,6 +558,8 @@ def test_add_component_and_revert(self) -> None: collection_update_event_receiver = mock.Mock() LIBRARY_COLLECTION_UPDATED.connect(collection_update_event_receiver) + # Reverting the change essentially deletes the item, so we should get an event that the collection's contents + # have been updated. api.revert_changes(self.lib1.library_key) assert collection_update_event_receiver.call_count == 1 @@ -723,7 +571,7 @@ def test_add_component_and_revert(self) -> None: "library_collection": LibraryCollectionData( collection_key=api.library_collection_locator( self.lib1.library_key, - collection_key=self.col1.key, + collection_key=self.col1.collection_code, ), ), }, @@ -737,7 +585,7 @@ def test_delete_component_and_revert(self) -> None: # Add components and publish api.update_library_collection_items( self.lib1.library_key, - self.col1.key, + self.col1.collection_code, opaque_keys=[ LibraryUsageLocatorV2.from_string(self.lib1_problem_block["id"]), LibraryUsageLocatorV2.from_string(self.lib1_html_block["id"]) @@ -762,7 +610,7 @@ def test_delete_component_and_revert(self) -> None: "library_collection": LibraryCollectionData( collection_key=api.library_collection_locator( self.lib1.library_key, - collection_key=self.col1.key, + collection_key=self.col1.collection_code, ), ), }, @@ -784,21 +632,21 @@ def setUp(self) -> None: self.lib1 = ContentLibrary.objects.get(slug="test-lib-cont-1") # Create Units - self.unit1 = api.create_container(self.lib1.library_key, api.ContainerType.Unit, 'unit-1', 'Unit 1', None) - self.unit2 = api.create_container(self.lib1.library_key, api.ContainerType.Unit, 'unit-2', 'Unit 2', None) - self.unit3 = api.create_container(self.lib1.library_key, api.ContainerType.Unit, 'unit-3', 'Unit 3', None) + self.unit1 = api.create_container(self.lib1.library_key, content_models.Unit, 'unit-1', 'Unit 1', None) + self.unit2 = api.create_container(self.lib1.library_key, content_models.Unit, 'unit-2', 'Unit 2', None) + self.unit3 = api.create_container(self.lib1.library_key, content_models.Unit, 'unit-3', 'Unit 3', None) # Create Subsections self.subsection1 = api.create_container( self.lib1.library_key, - api.ContainerType.Subsection, + content_models.Subsection, 'subsection-1', 'Subsection 1', None, ) self.subsection2 = api.create_container( self.lib1.library_key, - api.ContainerType.Subsection, + content_models.Subsection, 'subsection-2', 'Subsection 2', None, @@ -807,14 +655,14 @@ def setUp(self) -> None: # Create Sections self.section1 = api.create_container( self.lib1.library_key, - api.ContainerType.Section, + content_models.Section, 'section-1', 'Section 1', None, ) self.section2 = api.create_container( self.lib1.library_key, - api.ContainerType.Section, + content_models.Section, 'section-2', 'Section 2', None, @@ -899,420 +747,6 @@ def test_get_containers_contains_item(self): assert len(subsection_2_containers) == 1 assert subsection_2_containers[0].container_key == self.section1.container_key - def _validate_calls_of_html_block(self, event_mock): - """ - Validate that the `event_mock` has been called twice - using the `LIBRARY_CONTAINER_UPDATED` signal. - """ - assert event_mock.call_count == 2 - self.assertDictContainsEntries( - event_mock.call_args_list[0].kwargs, - { - "signal": LIBRARY_CONTAINER_UPDATED, - "sender": None, - "library_container": LibraryContainerData( - container_key=self.unit1.container_key, - background=True, - ) - }, - ) - self.assertDictContainsEntries( - event_mock.call_args_list[1].kwargs, - { - "signal": LIBRARY_CONTAINER_UPDATED, - "sender": None, - "library_container": LibraryContainerData( - container_key=self.unit2.container_key, - background=True, - ) - }, - ) - - def test_call_container_update_signal_when_delete_component(self) -> None: - container_update_event_receiver = mock.Mock() - LIBRARY_CONTAINER_UPDATED.connect(container_update_event_receiver) - - api.delete_library_block(self.html_block_usage_key) - self._validate_calls_of_html_block(container_update_event_receiver) - - def test_call_container_update_signal_when_restore_component(self) -> None: - api.delete_library_block(self.html_block_usage_key) - - container_update_event_receiver = mock.Mock() - LIBRARY_CONTAINER_UPDATED.connect(container_update_event_receiver) - api.restore_library_block(self.html_block_usage_key) - - self._validate_calls_of_html_block(container_update_event_receiver) - - def test_call_container_update_signal_when_update_olx(self) -> None: - block_olx = "Hello world!" - container_update_event_receiver = mock.Mock() - LIBRARY_CONTAINER_UPDATED.connect(container_update_event_receiver) - - self._set_library_block_olx(self.html_block_usage_key, block_olx) - self._validate_calls_of_html_block(container_update_event_receiver) - - def test_call_container_update_signal_when_update_component(self) -> None: - block_olx = "Hello world!" - container_update_event_receiver = mock.Mock() - LIBRARY_CONTAINER_UPDATED.connect(container_update_event_receiver) - - self._set_library_block_fields(self.html_block_usage_key, {"data": block_olx, "metadata": {}}) - self._validate_calls_of_html_block(container_update_event_receiver) - - def test_call_container_update_signal_when_update_unit(self) -> None: - container_update_event_receiver = mock.Mock() - LIBRARY_CONTAINER_UPDATED.connect(container_update_event_receiver) - self._update_container(self.unit1.container_key, 'New Unit Display Name') - - assert container_update_event_receiver.call_count == 3 - self.assertDictContainsEntries( - container_update_event_receiver.call_args_list[0].kwargs, - { - "signal": LIBRARY_CONTAINER_UPDATED, - "sender": None, - "library_container": LibraryContainerData( - container_key=self.unit1.container_key, - ) - }, - ) - self.assertDictContainsEntries( - container_update_event_receiver.call_args_list[1].kwargs, - { - "signal": LIBRARY_CONTAINER_UPDATED, - "sender": None, - "library_container": LibraryContainerData( - container_key=self.subsection1.container_key, - ) - }, - ) - self.assertDictContainsEntries( - container_update_event_receiver.call_args_list[2].kwargs, - { - "signal": LIBRARY_CONTAINER_UPDATED, - "sender": None, - "library_container": LibraryContainerData( - container_key=self.subsection2.container_key, - ) - }, - ) - - def test_call_container_update_signal_when_update_subsection(self) -> None: - container_update_event_receiver = mock.Mock() - LIBRARY_CONTAINER_UPDATED.connect(container_update_event_receiver) - self._update_container(self.subsection1.container_key, 'New Subsection Display Name') - - assert container_update_event_receiver.call_count == 3 - self.assertDictContainsEntries( - container_update_event_receiver.call_args_list[0].kwargs, - { - "signal": LIBRARY_CONTAINER_UPDATED, - "sender": None, - "library_container": LibraryContainerData( - container_key=self.subsection1.container_key, - ) - }, - ) - self.assertDictContainsEntries( - container_update_event_receiver.call_args_list[1].kwargs, - { - "signal": LIBRARY_CONTAINER_UPDATED, - "sender": None, - "library_container": LibraryContainerData( - container_key=self.section1.container_key, - ) - }, - ) - self.assertDictContainsEntries( - container_update_event_receiver.call_args_list[2].kwargs, - { - "signal": LIBRARY_CONTAINER_UPDATED, - "sender": None, - "library_container": LibraryContainerData( - container_key=self.section2.container_key, - ) - }, - ) - - def test_call_container_update_signal_when_update_section(self) -> None: - container_update_event_receiver = mock.Mock() - LIBRARY_CONTAINER_UPDATED.connect(container_update_event_receiver) - self._update_container(self.section1.container_key, 'New Section Display Name') - - assert container_update_event_receiver.call_count == 1 - self.assertDictContainsEntries( - container_update_event_receiver.call_args_list[0].kwargs, - { - "signal": LIBRARY_CONTAINER_UPDATED, - "sender": None, - "library_container": LibraryContainerData( - container_key=self.section1.container_key, - ) - }, - ) - - def test_call_object_changed_signal_when_remove_component(self) -> None: - html_block_1 = self._add_block_to_library( - self.lib1.library_key, "html", "html3", - ) - api.update_container_children( - self.unit2.container_key, - [LibraryUsageLocatorV2.from_string(html_block_1["id"])], - None, - entities_action=authoring_api.ChildrenEntitiesAction.APPEND, - ) - - event_reciver = mock.Mock() - CONTENT_OBJECT_ASSOCIATIONS_CHANGED.connect(event_reciver) - api.update_container_children( - self.unit2.container_key, - [LibraryUsageLocatorV2.from_string(html_block_1["id"])], - None, - entities_action=authoring_api.ChildrenEntitiesAction.REMOVE, - ) - - assert event_reciver.call_count == 1 - self.assertDictContainsEntries( - event_reciver.call_args_list[0].kwargs, - { - "signal": CONTENT_OBJECT_ASSOCIATIONS_CHANGED, - "sender": None, - "content_object": ContentObjectChangedData( - object_id=html_block_1["id"], - changes=["units"], - ), - }, - ) - - def test_call_object_changed_signal_when_remove_unit(self) -> None: - unit4 = api.create_container(self.lib1.library_key, api.ContainerType.Unit, 'unit-4', 'Unit 4', None) - - api.update_container_children( - self.subsection2.container_key, - [unit4.container_key], - None, - entities_action=authoring_api.ChildrenEntitiesAction.APPEND, - ) - - event_reciver = mock.Mock() - CONTENT_OBJECT_ASSOCIATIONS_CHANGED.connect(event_reciver) - api.update_container_children( - self.subsection2.container_key, - [unit4.container_key], - None, - entities_action=authoring_api.ChildrenEntitiesAction.REMOVE, - ) - - assert event_reciver.call_count == 1 - self.assertDictContainsEntries( - event_reciver.call_args_list[0].kwargs, - { - "signal": CONTENT_OBJECT_ASSOCIATIONS_CHANGED, - "sender": None, - "content_object": ContentObjectChangedData( - object_id=str(unit4.container_key), - changes=["subsections"], - ), - }, - ) - - def test_call_object_changed_signal_when_remove_subsection(self) -> None: - subsection3 = api.create_container( - self.lib1.library_key, - api.ContainerType.Subsection, - 'subsection-3', - 'Subsection 3', - None, - ) - - api.update_container_children( - self.section2.container_key, - [subsection3.container_key], - None, - entities_action=authoring_api.ChildrenEntitiesAction.APPEND, - ) - - event_reciver = mock.Mock() - CONTENT_OBJECT_ASSOCIATIONS_CHANGED.connect(event_reciver) - api.update_container_children( - self.section2.container_key, - [subsection3.container_key], - None, - entities_action=authoring_api.ChildrenEntitiesAction.REMOVE, - ) - - assert event_reciver.call_count == 1 - self.assertDictContainsEntries( - event_reciver.call_args_list[0].kwargs, - { - "signal": CONTENT_OBJECT_ASSOCIATIONS_CHANGED, - "sender": None, - "content_object": ContentObjectChangedData( - object_id=str(subsection3.container_key), - changes=["sections"], - ), - }, - ) - - def test_call_object_changed_signal_when_add_component(self) -> None: - event_reciver = mock.Mock() - CONTENT_OBJECT_ASSOCIATIONS_CHANGED.connect(event_reciver) - html_block_1 = self._add_block_to_library( - self.lib1.library_key, "html", "html4", - ) - html_block_2 = self._add_block_to_library( - self.lib1.library_key, "html", "html5", - ) - - api.update_container_children( - self.unit2.container_key, - [ - LibraryUsageLocatorV2.from_string(html_block_1["id"]), - LibraryUsageLocatorV2.from_string(html_block_2["id"]) - ], - None, - entities_action=authoring_api.ChildrenEntitiesAction.APPEND, - ) - - assert event_reciver.call_count == 2 - self.assertDictContainsEntries( - event_reciver.call_args_list[0].kwargs, - { - "signal": CONTENT_OBJECT_ASSOCIATIONS_CHANGED, - "sender": None, - "content_object": ContentObjectChangedData( - object_id=html_block_1["id"], - changes=["units"], - ), - }, - ) - self.assertDictContainsEntries( - event_reciver.call_args_list[1].kwargs, - { - "signal": CONTENT_OBJECT_ASSOCIATIONS_CHANGED, - "sender": None, - "content_object": ContentObjectChangedData( - object_id=html_block_2["id"], - changes=["units"], - ), - }, - ) - - def test_call_object_changed_signal_when_add_unit(self) -> None: - event_reciver = mock.Mock() - CONTENT_OBJECT_ASSOCIATIONS_CHANGED.connect(event_reciver) - - unit4 = api.create_container(self.lib1.library_key, api.ContainerType.Unit, 'unit-4', 'Unit 4', None) - unit5 = api.create_container(self.lib1.library_key, api.ContainerType.Unit, 'unit-5', 'Unit 5', None) - - api.update_container_children( - self.subsection2.container_key, - [unit4.container_key, unit5.container_key], - None, - entities_action=authoring_api.ChildrenEntitiesAction.APPEND, - ) - assert event_reciver.call_count == 2 - self.assertDictContainsEntries( - event_reciver.call_args_list[0].kwargs, - { - "signal": CONTENT_OBJECT_ASSOCIATIONS_CHANGED, - "sender": None, - "content_object": ContentObjectChangedData( - object_id=str(unit4.container_key), - changes=["subsections"], - ), - }, - ) - self.assertDictContainsEntries( - event_reciver.call_args_list[1].kwargs, - { - "signal": CONTENT_OBJECT_ASSOCIATIONS_CHANGED, - "sender": None, - "content_object": ContentObjectChangedData( - object_id=str(unit5.container_key), - changes=["subsections"], - ), - }, - ) - - def test_call_object_changed_signal_when_add_subsection(self) -> None: - event_reciver = mock.Mock() - CONTENT_OBJECT_ASSOCIATIONS_CHANGED.connect(event_reciver) - - subsection3 = api.create_container( - self.lib1.library_key, - api.ContainerType.Subsection, - 'subsection-3', - 'Subsection 3', - None, - ) - subsection4 = api.create_container( - self.lib1.library_key, - api.ContainerType.Subsection, - 'subsection-4', - 'Subsection 4', - None, - ) - api.update_container_children( - self.section2.container_key, - [subsection3.container_key, subsection4.container_key], - None, - entities_action=authoring_api.ChildrenEntitiesAction.APPEND, - ) - assert event_reciver.call_count == 2 - self.assertDictContainsEntries( - event_reciver.call_args_list[0].kwargs, - { - "signal": CONTENT_OBJECT_ASSOCIATIONS_CHANGED, - "sender": None, - "content_object": ContentObjectChangedData( - object_id=str(subsection3.container_key), - changes=["sections"], - ), - }, - ) - self.assertDictContainsEntries( - event_reciver.call_args_list[1].kwargs, - { - "signal": CONTENT_OBJECT_ASSOCIATIONS_CHANGED, - "sender": None, - "content_object": ContentObjectChangedData( - object_id=str(subsection4.container_key), - changes=["sections"], - ), - }, - ) - - def test_delete_component_and_revert(self) -> None: - """ - When a component is deleted and then the delete is reverted, signals - will be emitted to update any containing containers. - """ - # Add components and publish - api.update_container_children(self.unit3.container_key, [ - LibraryUsageLocatorV2.from_string(self.problem_block_2["id"]), - ], user_id=None) - api.publish_changes(self.lib1.library_key) - - # Delete component and revert - api.delete_library_block(LibraryUsageLocatorV2.from_string(self.problem_block_2["id"])) - - container_event_receiver = mock.Mock() - LIBRARY_CONTAINER_UPDATED.connect(container_event_receiver) - - api.revert_changes(self.lib1.library_key) - - assert container_event_receiver.call_count == 1 - self.assertDictContainsEntries( - container_event_receiver.call_args_list[0].kwargs, - { - "signal": LIBRARY_CONTAINER_UPDATED, - "sender": None, - "library_container": LibraryContainerData( - container_key=self.unit3.container_key - ), - }, - ) def test_copy_and_paste_container_same_library(self) -> None: # Copy a section with children @@ -1323,7 +757,7 @@ def test_copy_and_paste_container_same_library(self) -> None: ) # Verify that the container is copied - assert new_container.container_type == self.section1.container_type + assert new_container.container_type_code == self.section1.container_type_code assert new_container.display_name == self.section1.display_name # Verify that the children are linked @@ -1346,7 +780,7 @@ def test_copy_and_paste_container_another_library(self) -> None: ) # Verify that the container is copied - assert new_container.container_type == self.section1.container_type + assert new_container.container_type_code == self.section1.container_type_code assert new_container.display_name == self.section1.display_name # Verify that the children are copied @@ -1390,6 +824,26 @@ def test_copy_and_paste_container_another_library(self) -> None: # This is the same unit, so it should not be duplicated assert units_subsection1[0].container_key == units_subsection2[0].container_key + def test_set_library_block_olx_no_signal_on_rollback(self) -> None: + """ + LIBRARY_BLOCK_UPDATED is NOT emitted when set_library_block_olx is called + within a transaction that is later rolled back. + """ + event_receiver = mock.Mock() + LIBRARY_BLOCK_UPDATED.connect(event_receiver) + self.addCleanup(LIBRARY_BLOCK_UPDATED.disconnect, event_receiver) + + try: + with transaction.atomic(): + api.set_library_block_olx( + self.problem_block_usage_key, + "Updated inside rolled-back transaction", + ) + raise RuntimeError("Force rollback") + except RuntimeError: + pass + + assert event_receiver.call_count == 0 class ContentLibraryExportTest(ContentLibrariesRestApiTest): """ @@ -1600,7 +1054,7 @@ def test_library_creation_handles_authz_exception( # Library creation should still succeed (the exception should be caught/handled) # Note: Currently, the code doesn't catch this exception, so we expect it to propagate. # This test documents the current behavior and can be updated if error handling is added. - with self.assertRaises(Exception) as context: + with self.assertRaises(Exception) as context: # noqa: PT027 self._create_library("test-lib-role-4", "Test Library Role 4") assert "AuthZ unavailable" in str(context.exception) diff --git a/openedx/core/djangoapps/content_libraries/tests/test_auth.py b/openedx/core/djangoapps/content_libraries/tests/test_auth.py deleted file mode 100644 index 99d84b7fd7ea..000000000000 --- a/openedx/core/djangoapps/content_libraries/tests/test_auth.py +++ /dev/null @@ -1,35 +0,0 @@ -""" -Unit tests for Content Libraries authentication module. -""" - - -from django.test import TestCase - - -from ..models import LtiProfile -from ..models import get_user_model -from ..auth import LtiAuthenticationBackend - - -class LtiAuthenticationBackendTest(TestCase): - """ - AuthenticationBackend tests. - """ - - iss = 'http://foo.bar' - aud = 'a-random-test-aud' - sub = 'a-random-test-sub' - - def test_without_profile(self): - get_user_model().objects.create(username='foobar') - backend = LtiAuthenticationBackend() - user = backend.authenticate(None, iss=self.iss, aud=self.aud, sub=self.sub) - self.assertIsNone(user) - - def test_with_profile(self): - profile = LtiProfile.objects.create( - platform_id=self.iss, client_id=self.aud, subject_id=self.sub) - backend = LtiAuthenticationBackend() - user = backend.authenticate(None, iss=self.iss, aud=self.aud, sub=self.sub) - self.assertIsNotNone(user) - self.assertEqual(user.contentlibraries_lti_profile, profile) diff --git a/openedx/core/djangoapps/content_libraries/tests/test_command_content_libraries_import.py b/openedx/core/djangoapps/content_libraries/tests/test_command_content_libraries_import.py deleted file mode 100644 index 0f57b8f2d815..000000000000 --- a/openedx/core/djangoapps/content_libraries/tests/test_command_content_libraries_import.py +++ /dev/null @@ -1,47 +0,0 @@ -""" -Unit tests for content_libraries_import command. -""" - - -from unittest import mock -from io import StringIO - -from django.core.management import call_command -from django.core.management.base import CommandError -from django.test import TestCase - - -@mock.patch('openedx.core.djangoapps.content_libraries.management.commands.content_libraries_import.contentlib_api') -class ContentLibrariesImportTest(TestCase): - """ - Unit tests for content_libraries_import command. - """ - - library_key_str = 'lib:foo:bar' - - course_key_str = 'course-v1:foo+bar+foobar' - - def call_command(self, *args, **kwargs): - """ - Call command with default test paramters. - """ - out = StringIO() - kwargs['stdout'] = out - library_key = kwargs.pop('library_key', self.library_key_str) - course_key = kwargs.pop('course_key', self.course_key_str) - call_command('content_libraries_import', library_key, course_key, - 'api', - '--oauth-creds', 'fake-key', 'fake-secret', - *args, **kwargs) - return out - - def test_call_without_library(self, api_mock): - """ - Given library does not exists - Then raises command error - """ - from openedx.core.djangoapps.content_libraries.api import ContentLibraryNotFound - api_mock.ContentLibraryNotFound = ContentLibraryNotFound - api_mock.get_library.side_effect = ContentLibraryNotFound - with self.assertRaises(CommandError): - self.call_command() diff --git a/openedx/core/djangoapps/content_libraries/tests/test_containers.py b/openedx/core/djangoapps/content_libraries/tests/test_containers.py index 7e6eac3beda8..3900234f1db5 100644 --- a/openedx/core/djangoapps/content_libraries/tests/test_containers.py +++ b/openedx/core/djangoapps/content_libraries/tests/test_containers.py @@ -1,13 +1,13 @@ """ -Tests for Learning-Core-based Content Libraries +Tests for openedx_content-based Content Libraries """ -from datetime import datetime, timezone +import copy import textwrap +from datetime import UTC, datetime import ddt from freezegun import freeze_time - -from opaque_keys.edx.locator import LibraryLocatorV2 +from opaque_keys.edx.locator import LibraryContainerLocator, LibraryLocatorV2, LibraryUsageLocatorV2 from common.djangoapps.student.tests.factories import UserFactory from openedx.core.djangoapps.content_libraries import api @@ -39,8 +39,8 @@ class ContainersTestCase(ContentLibrariesRestApiTest): def setUp(self) -> None: super().setUp() - self.create_date = datetime(2024, 9, 8, 7, 6, 5, tzinfo=timezone.utc) - self.modified_date = datetime(2024, 10, 9, 8, 7, 6, tzinfo=timezone.utc) + self.create_date = datetime(2024, 9, 8, 7, 6, 5, tzinfo=UTC) + self.modified_date = datetime(2024, 10, 9, 8, 7, 6, tzinfo=UTC) self.lib = self._create_library( slug="containers", title="Container Test Library", @@ -104,10 +104,19 @@ def setUp(self) -> None: ) # Create blocks - self.problem_block = self._add_block_to_library(self.lib["id"], "problem", "Problem1", can_stand_alone=False) - self.html_block = self._add_block_to_library(self.lib["id"], "html", "Html1", can_stand_alone=False) - self.problem_block_2 = self._add_block_to_library(self.lib["id"], "problem", "Problem2", can_stand_alone=False) - self.html_block_2 = self._add_block_to_library(self.lib["id"], "html", "Html2") + with freeze_time(self.create_date): + self.problem_block = self._add_block_to_library( + self.lib["id"], "problem", "Problem1", can_stand_alone=False + ) + self.html_block = self._add_block_to_library( + self.lib["id"], "html", "Html1", can_stand_alone=False + ) + self.problem_block_2 = self._add_block_to_library( + self.lib["id"], "problem", "Problem2", can_stand_alone=False + ) + self.html_block_2 = self._add_block_to_library( + self.lib["id"], "html", "Html2" + ) with freeze_time(self.modified_date): # Add components to `unit_with_components` @@ -160,7 +169,7 @@ def test_container_crud(self, container_type, slug, display_name) -> None: Test Create, Read, Update, and Delete of a Containers """ # Create container: - create_date = datetime(2024, 9, 8, 7, 6, 5, tzinfo=timezone.utc) + create_date = datetime(2024, 9, 8, 7, 6, 5, tzinfo=UTC) with freeze_time(create_date): container_data = self._create_container( self.lib["id"], @@ -191,7 +200,7 @@ def test_container_crud(self, container_type, slug, display_name) -> None: self.assertDictContainsEntries(container_as_read, expected_data) # Update the container: - modified_date = datetime(2024, 10, 9, 8, 7, 6, tzinfo=timezone.utc) + modified_date = datetime(2024, 10, 9, 8, 7, 6, tzinfo=UTC) with freeze_time(modified_date): container_data = self._update_container(container_id, display_name=f"New Display Name for {container_type}") expected_data["last_draft_created"] = expected_data["modified"] = "2024-10-09T08:07:06Z" @@ -529,6 +538,194 @@ def test_section_replace_children(self) -> None: assert data[0]['id'] == new_subsection_1['id'] assert data[1]['id'] == new_subsection_2['id'] + def test_published_child_components(self) -> None: + """ + Test that we can get the published version of a unit. + """ + unit_key_str = self.unit_with_components["id"] + unit_key = LibraryContainerLocator.from_string(unit_key_str) + # Publish "unit with components" + self._publish_container(unit_key_str) + # Now both its draft and published versions contain 4 identical components: + assert api.get_container_children_count(unit_key, published=False) == 4 + assert api.get_container_children_count(unit_key, published=True) == 4 + + original_children = self._get_container_children(unit_key_str) + draft_edited_date = datetime(2024, 9, 8, 7, 6, 5, tzinfo=UTC) + # Modify the first component: + first_child_key_str = original_children[0]["id"] + with freeze_time(draft_edited_date): + self._set_library_block_olx(first_child_key_str, "") + # And delete the last one: + last_child_key_str = original_children[3]["id"] + with freeze_time(draft_edited_date): + self._delete_library_block(last_child_key_str) + + # Now the counts should be different - the draft has only three children: + assert api.get_container_children_count(unit_key, published=False) == 3 + assert api.get_container_children_count(unit_key, published=True) == 4 + + # Check the published version + expected_published = copy.deepcopy(original_children) + # The first child was modified since publish: + expected_published[0]["has_unpublished_changes"] = True + # The last child was modified (deleted) since publish: + expected_published[3]["has_unpublished_changes"] = True + expected_published[3]["last_draft_created"] = None + expected_published[3]["last_draft_created_by"] = "" + + assert self._get_container_children(unit_key_str, published=True) == expected_published + + # Check the draft version: + expected_draft = copy.deepcopy(original_children) + # The first child was modified since publish: + expected_draft[0]["display_name"] = "DRAFT problem" + expected_draft[0]["has_unpublished_changes"] = True + # The last child was modified (deleted) since publish: + del expected_draft[3] + + assert self._get_container_children(unit_key_str, published=False) == expected_draft + + def test_published_child_containers(self) -> None: + """ + Test that we can get the published version of a subsection. + """ + subsection_key_str = self.subsection_with_units["id"] + subsection_key = LibraryContainerLocator.from_string(subsection_key_str) + # Publish "subsection with units" + self._publish_container(subsection_key_str) + # Now both its draft and published versions contain 4 identical units: + assert api.get_container_children_count(subsection_key, published=False) == 4 + assert api.get_container_children_count(subsection_key, published=True) == 4 + + original_children = self._get_container_children(subsection_key_str) + draft_edited_date = datetime(2024, 9, 8, 7, 6, 5, tzinfo=UTC) + # Modify the first child unit: + first_child_key_str = original_children[0]["id"] + with freeze_time(draft_edited_date): + self._update_container(first_child_key_str, display_name="DRAFT unit") + # And delete the last one: + last_child_key_str = original_children[3]["id"] + with freeze_time(draft_edited_date): + self._delete_container(last_child_key_str) + + # Now the counts should be different - the draft has only three children: + assert api.get_container_children_count(subsection_key, published=False) == 3 + assert api.get_container_children_count(subsection_key, published=True) == 4 + + # Check the published version + expected_published = copy.deepcopy(original_children) + # The first child was modified since publish: + expected_published[0]["has_unpublished_changes"] = True + # The last child was modified (deleted) since publish: + expected_published[3]["has_unpublished_changes"] = True + expected_published[3]["last_draft_created"] = None + expected_published[3]["last_draft_created_by"] = "" # last draft was deleted. + + assert self._get_container_children(subsection_key_str, published=True)[0] == expected_published[0] + assert self._get_container_children(subsection_key_str, published=True)[3] == expected_published[3] + assert self._get_container_children(subsection_key_str, published=True) == expected_published + + # Check the draft version: + expected_draft = copy.deepcopy(original_children) + # The first child was modified since publish: + expected_draft[0]["display_name"] = "DRAFT unit" + expected_draft[0]["has_unpublished_changes"] = True + # The last child was modified (deleted) since publish: + del expected_draft[3] + + assert self._get_container_children(subsection_key_str, published=False) == expected_draft + + def test_get_container_children_queries(self): + """ + Test how many queries are used to retrieve the children of a container + """ + empty_unit_key = LibraryContainerLocator.from_string(self.unit["id"]) + unit_with_children_key = LibraryContainerLocator.from_string(self.unit_with_components["id"]) + EMPTY_QUERIES = 6 + PER_CHILD_QUERIES = 10 # There's room to optimize here. + with self.assertNumQueries(EMPTY_QUERIES): + result = api.get_container_children(empty_unit_key) + assert len(result) == 0 + with self.assertNumQueries(6): + num_children = api.get_container_children_count(unit_with_children_key) + with self.assertNumQueries(EMPTY_QUERIES + PER_CHILD_QUERIES * num_children): + result = api.get_container_children(unit_with_children_key) + assert len(result) == num_children + + def test_get_container_children_list_components(self) -> None: + """ + Test that we can use get_container_children_list() to get the draft and + published children of any container, simply and performantly. + """ + # Publish "unit with components" + unit_key_str = self.unit_with_components["id"] + unit_key = LibraryContainerLocator.from_string(unit_key_str) + self._publish_container(unit_key_str) + + original_list = api.get_container_children_list(unit_key, published=True) + assert original_list == [ + api.ContainerChildMetadata( + display_name='Blank Problem', + key=LibraryUsageLocatorV2.from_string('lb:CL-TEST:containers:problem:Problem1'), + ), + api.ContainerChildMetadata( + display_name='Text', + key=LibraryUsageLocatorV2.from_string('lb:CL-TEST:containers:html:Html1'), + ), + api.ContainerChildMetadata( + display_name='Blank Problem', + key=LibraryUsageLocatorV2.from_string('lb:CL-TEST:containers:problem:Problem2'), + ), + api.ContainerChildMetadata( + display_name='Text', + key=LibraryUsageLocatorV2.from_string('lb:CL-TEST:containers:html:Html2'), + ), + ] + + # Modify the first component: + first_child_key = original_list[0].key + self._set_library_block_olx(str(first_child_key), "") + # And delete the last one: + last_child_key = original_list[3].key + self._delete_library_block(str(last_child_key)) + + # Now the counts should be different - the draft has only three children: + assert api.get_container_children_list(unit_key, published=True) == original_list + assert api.get_container_children_list(unit_key, published=False) == [ + api.ContainerChildMetadata( + display_name='DRAFT problem', # new name + key=LibraryUsageLocatorV2.from_string('lb:CL-TEST:containers:problem:Problem1'), + ), + api.ContainerChildMetadata( + display_name='Text', + key=LibraryUsageLocatorV2.from_string('lb:CL-TEST:containers:html:Html1'), + ), + api.ContainerChildMetadata( + display_name='Blank Problem', + key=LibraryUsageLocatorV2.from_string('lb:CL-TEST:containers:problem:Problem2'), + ), + # last component was deleted. + ] + + + def test_get_container_children_list_queries(self): + """ + Test how many queries are used to retrieve the children of a container + """ + empty_unit_key = LibraryContainerLocator.from_string(self.unit["id"]) + unit_with_children_key = LibraryContainerLocator.from_string(self.unit_with_components["id"]) + EMPTY_QUERIES = 6 + PER_CHILD_QUERIES = 3 # There's room to optimize here - remove the componenttype lookups + with self.assertNumQueries(EMPTY_QUERIES): + result = api.get_container_children_list(empty_unit_key, published=False) + assert len(result) == 0 + with self.assertNumQueries(6): + num_children = api.get_container_children_count(unit_with_children_key) + with self.assertNumQueries(EMPTY_QUERIES + PER_CHILD_QUERIES * num_children): + result = api.get_container_children_list(unit_with_children_key, published=False) + assert len(result) == num_children + @ddt.data( "unit", "subsection", @@ -592,7 +789,7 @@ def test_unit_collections(self) -> None: result = self._patch_container_collections( self.unit["id"], - collection_keys=[col1.key], + collection_keys=[col1.collection_code], ) assert result['count'] == 1 @@ -601,10 +798,10 @@ def test_unit_collections(self) -> None: unit_as_read = self._get_container(self.unit["id"]) # Verify the collections - assert unit_as_read['collections'] == [{"title": col1.title, "key": col1.key}] + assert unit_as_read['collections'] == [{"title": col1.title, "key": col1.collection_code}] def test_section_hierarchy(self): - with self.assertNumQueries(133): + with self.assertNumQueries(126): hierarchy = self._get_container_hierarchy(self.section_with_subsections["id"]) assert hierarchy["object_key"] == self.section_with_subsections["id"] assert hierarchy["components"] == [ @@ -630,7 +827,7 @@ def test_section_hierarchy(self): ] def test_subsection_hierarchy(self): - with self.assertNumQueries(95): + with self.assertNumQueries(91): hierarchy = self._get_container_hierarchy(self.subsection_with_units["id"]) assert hierarchy["object_key"] == self.subsection_with_units["id"] assert hierarchy["components"] == [ @@ -653,7 +850,7 @@ def test_subsection_hierarchy(self): ] def test_units_hierarchy(self): - with self.assertNumQueries(60): + with self.assertNumQueries(56): hierarchy = self._get_container_hierarchy(self.unit_with_components["id"]) assert hierarchy["object_key"] == self.unit_with_components["id"] assert hierarchy["components"] == [ @@ -679,7 +876,7 @@ def test_container_hierarchy_not_found(self): ) def test_block_hierarchy(self): - with self.assertNumQueries(27): + with self.assertNumQueries(24): hierarchy = self._get_block_hierarchy(self.problem_block["id"]) assert hierarchy["object_key"] == self.problem_block["id"] assert hierarchy["components"] == [ @@ -840,6 +1037,7 @@ def test_copy_container(self) -> None: # Test the actual OLX in the clipboard: olx_data = staging_api.get_staged_content_olx(clipboard_data.content.id) assert olx_data is not None + # pylint: disable=line-too-long assert olx_data == textwrap.dedent(f"""\ @@ -858,6 +1056,7 @@ def test_copy_container(self) -> None: """) + # pylint: enable=line-too-long def test_publish_subsection(self) -> None: """ @@ -875,7 +1074,7 @@ def test_publish_subsection(self) -> None: ) # TODO -- remove this when containers publish their children: - # https://github.com/openedx/openedx-learning/pull/307 + # https://github.com/openedx/openedx-core/pull/307 # Removing the unit with components because the components (children of children) are not published. # If the unit is kept, the subsection continues to have changes even after it is published. self._remove_container_children( @@ -951,7 +1150,7 @@ def test_publish_section(self) -> None: ) # TODO -- remove this when containers publish their children: - # https://github.com/openedx/openedx-learning/pull/307 + # https://github.com/openedx/openedx-core/pull/307 # Removing the subsection with units because the units (children of children) are not published. # If the subsection is kept, the section continues to have changes even after it is published. self._remove_container_children( @@ -1012,3 +1211,114 @@ def test_publish_section(self) -> None: assert c2_units_after[1]["id"] == subsection_4["id"] assert c2_units_after[1]["has_unpublished_changes"] # unaffected assert c2_units_after[1]["published_by"] is None + + def test_container_draft_history_empty_after_publish(self): + """ + A container with no unpublished changes since its last publish has an empty draft history. + """ + unit = self._create_container(self.lib["id"], "unit", display_name="History Unit", slug=None) + self._publish_container(unit["id"]) + + history = self._get_container_draft_history(unit["id"]) + assert history == [] + + def test_container_draft_history_shows_unpublished_edits(self): + """ + Draft history contains entries for edits made since the last publication, + ordered most-recent-first, with the correct fields. + """ + with freeze_time(datetime(2026, 1, 1, tzinfo=UTC)): + unit = self._create_container(self.lib["id"], "unit", display_name="History Unit Edits", slug=None) + with freeze_time(datetime(2026, 2, 1, tzinfo=UTC)): + self._publish_container(unit["id"]) + + edit1_time = datetime(2026, 4, 1, 10, 0, 0, tzinfo=UTC) + with freeze_time(edit1_time): + self._update_container(unit["id"], display_name="History Unit Edits v2") + + edit2_time = datetime(2026, 4, 2, 10, 0, 0, tzinfo=UTC) + with freeze_time(edit2_time): + self._update_container(unit["id"], display_name="History Unit Edits v3") + + history = self._get_container_draft_history(unit["id"]) + assert len(history) == 2 + assert history[0]["changed_at"] == edit2_time.isoformat().replace("+00:00", "Z") + assert history[1]["changed_at"] == edit1_time.isoformat().replace("+00:00", "Z") + entry = history[0] + assert "contributor" in entry + assert "title" in entry + assert "action" in entry + + def test_container_draft_history_includes_descendant_components(self): + """ + The history of a container includes entries from its descendant components, + merged and sorted newest-first. + """ + with freeze_time(datetime(2026, 1, 1, tzinfo=UTC)): + unit = self._create_container(self.lib["id"], "unit", display_name="History Unit Children", slug=None) + block = self._add_block_to_library(self.lib["id"], "problem", "hist-prob", can_stand_alone=False) + self._add_container_children(unit["id"], children_ids=[block["id"]]) + with freeze_time(datetime(2026, 2, 1, tzinfo=UTC)): + self._publish_container(unit["id"]) + + container_edit_time = datetime(2026, 4, 1, 10, 0, 0, tzinfo=UTC) + with freeze_time(container_edit_time): + self._update_container(unit["id"], display_name="History Unit Children v2") + + block_edit_time = datetime(2026, 4, 2, 10, 0, 0, tzinfo=UTC) + with freeze_time(block_edit_time): + self._set_library_block_olx(block["id"], "

          edited

          ") + + history = self._get_container_draft_history(unit["id"]) + changed_at_list = [entry["changed_at"] for entry in history] + # Both the container edit and the block edit should appear in the history. + block_edit_time_str = block_edit_time.isoformat().replace("+00:00", "Z") + container_edit_time_str = container_edit_time.isoformat().replace("+00:00", "Z") + assert block_edit_time_str in changed_at_list + assert container_edit_time_str in changed_at_list + # History is sorted newest-first, so the block edit should come before the container edit. + assert changed_at_list.index(block_edit_time_str) < changed_at_list.index(container_edit_time_str) + + def test_container_draft_history_action_renamed(self): + """ + When the title changes, the action is 'renamed'. + """ + unit = self._create_container(self.lib["id"], "unit", display_name="Original Name", slug=None) + self._publish_container(unit["id"]) + self._update_container(unit["id"], display_name="New Name") + + history = self._get_container_draft_history(unit["id"]) + assert len(history) >= 1 + assert history[0]["action"] == "renamed" + + def test_container_draft_history_cleared_after_publish(self): + """ + After publishing, the draft history resets to empty. + """ + unit = self._create_container(self.lib["id"], "unit", display_name="Clear History Unit", slug=None) + self._publish_container(unit["id"]) + self._update_container(unit["id"], display_name="Updated Name") + assert len(self._get_container_draft_history(unit["id"])) >= 1 + + self._publish_container(unit["id"]) + assert self._get_container_draft_history(unit["id"]) == [] + + def test_container_draft_history_nonexistent_container(self): + """ + Requesting draft history for a non-existent container returns 404. + """ + self._get_container_draft_history( + "lct:CL-TEST:containers:unit:nonexistent", + expect_response=404, + ) + + def test_container_draft_history_permissions(self): + """ + A user without library access receives 403. + """ + unit = self._create_container(self.lib["id"], "unit", display_name="Auth Unit", slug=None) + self._update_container(unit["id"], display_name="Updated Auth Unit") + + unauthorized = UserFactory.create(username="noauth-container-hist", password="edx") + with self.as_user(unauthorized): + self._get_container_draft_history(unit["id"], expect_response=403) diff --git a/openedx/core/djangoapps/content_libraries/tests/test_content_libraries.py b/openedx/core/djangoapps/content_libraries/tests/test_content_libraries.py index 10d6c1ead94d..903e7e43a23e 100644 --- a/openedx/core/djangoapps/content_libraries/tests/test_content_libraries.py +++ b/openedx/core/djangoapps/content_libraries/tests/test_content_libraries.py @@ -1,11 +1,11 @@ """ -Tests for Learning-Core-based Content Libraries +Tests for openedx_content-based Content Libraries """ -from datetime import datetime, timezone import os -import zipfile -import uuid import tempfile +import uuid +import zipfile +from datetime import UTC, datetime from io import StringIO from unittest import skip from unittest.mock import ANY, patch @@ -13,18 +13,22 @@ import ddt import tomlkit from bridgekeeper import perms -from django.core.files.uploadedfile import SimpleUploadedFile from django.contrib.auth.models import Group +from django.core.files.uploadedfile import SimpleUploadedFile from django.db.models import Q from django.test import override_settings from django.test.client import Client from freezegun import freeze_time -from opaque_keys.edx.locator import LibraryLocatorV2, LibraryUsageLocatorV2, LibraryCollectionLocator +from opaque_keys.edx.locator import LibraryCollectionLocator, LibraryLocatorV2, LibraryUsageLocatorV2 +from openedx_authz import api as authz_api +from openedx_authz.constants import roles +from openedx_authz.constants.permissions import VIEW_LIBRARY +from openedx_authz.engine.enforcer import AuthzEnforcer +from openedx_content.models_api import LearningPackage from organizations.models import Organization -from rest_framework.test import APITestCase from rest_framework import status -from openedx_learning.api.authoring_models import LearningPackage -from user_tasks.models import UserTaskStatus, UserTaskArtifact +from rest_framework.test import APITestCase +from user_tasks.models import UserTaskArtifact, UserTaskStatus from common.djangoapps.student.tests.factories import UserFactory from openedx.core.djangoapps.content_libraries.constants import CC_4_BY @@ -36,12 +40,8 @@ URL_BLOCK_XBLOCK_HANDLER, ContentLibrariesRestApiTest, ) -from openedx_authz import api as authz_api -from openedx_authz.constants import roles -from openedx_authz.engine.enforcer import AuthzEnforcer from openedx.core.djangoapps.xblock import api as xblock_api from openedx.core.djangolib.testing.utils import skip_unless_cms -from openedx_authz.constants.permissions import VIEW_LIBRARY from ..models import ContentLibrary, ContentLibraryPermission from ..permissions import CAN_VIEW_THIS_CONTENT_LIBRARY, HasPermissionInContentLibraryScope @@ -51,7 +51,7 @@ @ddt.ddt class ContentLibrariesTestCase(ContentLibrariesRestApiTest): """ - General tests for Learning-Core-based Content Libraries + General tests for openedx_content-based Content Libraries These tests use the REST API, which in turn relies on the Python API. Some tests may use the python API directly if necessary to provide @@ -308,7 +308,7 @@ def test_library_blocks(self): # pylint: disable=too-many-statements Tests with some non-ASCII chars in slugs, titles, descriptions. """ - admin = UserFactory.create(username="Admin", email="admin@example.com", is_staff=True) + admin = UserFactory.create(username="Admin", email="admin@example.com", is_staff=True) # noqa: F841 lib = self._create_library(slug="téstlꜟط", title="A Tést Lꜟطrary", description="Tésting XBlocks") lib_id = lib["id"] @@ -318,11 +318,11 @@ def test_library_blocks(self): # pylint: disable=too-many-statements assert self._get_library_blocks(lib_id)['results'] == [] # Add a 'problem' XBlock to the library: - create_date = datetime(2024, 6, 6, 6, 6, 6, tzinfo=timezone.utc) + create_date = datetime(2024, 6, 6, 6, 6, 6, tzinfo=UTC) with freeze_time(create_date): - block_data = self._add_block_to_library(lib_id, "problem", "ࠒröblæm1") + block_data = self._add_block_to_library(lib_id, "problem", "problem1") self.assertDictContainsEntries(block_data, { - "id": "lb:CL-TEST:téstlꜟط:problem:ࠒröblæm1", + "id": "lb:CL-TEST:téstlꜟط:problem:problem1", "display_name": "Blank Problem", "block_type": "problem", "has_unpublished_changes": True, @@ -338,7 +338,7 @@ def test_library_blocks(self): # pylint: disable=too-many-statements assert self._get_library(lib_id)['has_unpublished_changes'] is True # Publish the changes: - publish_date = datetime(2024, 7, 7, 7, 7, 7, tzinfo=timezone.utc) + publish_date = datetime(2024, 7, 7, 7, 7, 7, tzinfo=UTC) with freeze_time(publish_date): self._commit_library_changes(lib_id) assert self._get_library(lib_id)['has_unpublished_changes'] is False @@ -357,7 +357,7 @@ def test_library_blocks(self): # pylint: disable=too-many-statements

          This is a normal capa problem with unicode 🔥. It has "maximum attempts" set to **5**.

          - + XBlock metadata only XBlock data/metadata and associated static asset files @@ -367,7 +367,7 @@ def test_library_blocks(self): # pylint: disable=too-many-statements           """.strip() - update_date = datetime(2024, 8, 8, 8, 8, 8, tzinfo=timezone.utc) + update_date = datetime(2024, 8, 8, 8, 8, 8, tzinfo=UTC) with freeze_time(update_date): self._set_library_block_olx(block_id, new_olx) # now reading it back, we should get that exact OLX (no change to whitespace etc.): @@ -382,7 +382,7 @@ def test_library_blocks(self): # pylint: disable=too-many-statements # Now view the XBlock's student_view (including draft changes): fragment = self._render_block_view(block_id, "student_view") assert 'resources' in fragment - assert 'Learning Core is designed to store.' in fragment['content'] + assert 'openedx_content is designed to store.' in fragment['content'] # Also call a handler to make sure that's working: handler_url = self._get_block_handler_url(block_id, "xmodule_handler") + "problem_get" @@ -409,7 +409,7 @@ def test_library_blocks(self): # pylint: disable=too-many-statements assert self._get_library_block_olx(block_id) == new_olx unpublished_block_data = self._get_library_block(block_id) assert unpublished_block_data['has_unpublished_changes'] is True - block_update_date = datetime(2024, 8, 8, 8, 8, 9, tzinfo=timezone.utc) + block_update_date = datetime(2024, 8, 8, 8, 8, 9, tzinfo=UTC) with freeze_time(block_update_date): self._publish_library_block(block_id) # Confirm the block is now published: @@ -432,7 +432,7 @@ def test_library_blocks_studio_view(self): assert self._get_library_blocks(lib_id)['results'] == [] # Add a 'html' XBlock to the library: - create_date = datetime(2024, 6, 6, 6, 6, 6, tzinfo=timezone.utc) + create_date = datetime(2024, 6, 6, 6, 6, 6, tzinfo=UTC) with freeze_time(create_date): block_data = self._add_block_to_library(lib_id, "problem", "problem1") self.assertDictContainsEntries(block_data, { @@ -452,7 +452,7 @@ def test_library_blocks_studio_view(self): assert self._get_library(lib_id)['has_unpublished_changes'] is True # Publish the changes: - publish_date = datetime(2024, 7, 7, 7, 7, 7, tzinfo=timezone.utc) + publish_date = datetime(2024, 7, 7, 7, 7, 7, tzinfo=UTC) with freeze_time(publish_date): self._commit_library_changes(lib_id) assert self._get_library(lib_id)['has_unpublished_changes'] is False @@ -469,7 +469,7 @@ def test_library_blocks_studio_view(self): assert '

          edit 1

          ") + + edit2_time = datetime(2026, 4, 2, 10, 0, 0, tzinfo=UTC) + with freeze_time(edit2_time): + self._set_library_block_olx(block_key, "

          edit 2

          ") + + history = self._get_block_draft_history(block_key) + assert len(history) == 2 + assert history[0]["changed_at"] == edit2_time.isoformat().replace("+00:00", "Z") + assert history[1]["changed_at"] == edit1_time.isoformat().replace("+00:00", "Z") + entry = history[0] + assert "contributor" in entry + assert "title" in entry + assert "action" in entry + + def test_draft_history_action_renamed(self): + """ + When the title changes between versions, the action is 'renamed'. + """ + lib = self._create_library(slug="draft-hist-rename", title="Draft History Rename") + block = self._add_block_to_library(lib["id"], "problem", "prob1") + block_key = block["id"] + + self._publish_library_block(block_key) + self._set_library_block_olx( + block_key, + '

          content

          ', + ) + + history = self._get_block_draft_history(block_key) + assert len(history) >= 1 + assert history[0]["action"] == "renamed" + + def test_draft_history_action_edited(self): + """ + When only the content changes (not the title), the action is 'edited'. + """ + lib = self._create_library(slug="draft-hist-edit", title="Draft History Edit") + block = self._add_block_to_library(lib["id"], "problem", "prob1") + block_key = block["id"] + + self._publish_library_block(block_key) + self._set_library_block_olx(block_key, "

          changed content

          ") + + history = self._get_block_draft_history(block_key) + assert len(history) >= 1 + assert history[0]["action"] == "edited" + + def test_draft_history_action_created(self): + """ + When a block is first created (old_version=None), the action is 'created'. + """ + lib = self._create_library(slug="draft-hist-create", title="Draft History Create") + block = self._add_block_to_library(lib["id"], "problem", "prob1") + block_key = block["id"] + + history = self._get_block_draft_history(block_key) + assert len(history) >= 1 + assert history[-1]["action"] == "created" + assert history[-1]["old_version"] == 0 + assert history[-1]["new_version"] is not None + + def test_draft_history_action_deleted(self): + """ + When a block is soft-deleted (new_version=None), the action is 'deleted'. + """ + lib = self._create_library(slug="draft-hist-delete", title="Draft History Delete") + block = self._add_block_to_library(lib["id"], "problem", "prob1") + block_key = block["id"] + + self._publish_library_block(block_key) + self._delete_library_block(block_key) + + history = self._get_block_draft_history(block_key) + assert len(history) >= 1 + assert history[0]["action"] == "deleted" + + def test_draft_history_cleared_after_publish(self): + """ + After publishing, the draft history resets to empty. + """ + lib = self._create_library(slug="draft-hist-clear", title="Draft History Clear") + block = self._add_block_to_library(lib["id"], "problem", "prob1") + block_key = block["id"] + + self._publish_library_block(block_key) + self._set_library_block_olx(block_key, "

          unpublished

          ") + assert len(self._get_block_draft_history(block_key)) >= 1 + + self._publish_library_block(block_key) + assert self._get_block_draft_history(block_key) == [] + + def test_draft_history_nonexistent_block(self): + """ + Requesting draft history for a non-existent block returns 404. + """ + self._get_block_draft_history("lb:CL-TEST:draft-hist-404:problem:nope", expect_response=404) + + def test_draft_history_permissions(self): + """ + A user without library access receives 403. + """ + lib = self._create_library(slug="draft-hist-auth", title="Draft History Auth") + block = self._add_block_to_library(lib["id"], "problem", "prob1") + block_key = block["id"] + self._set_library_block_olx(block_key, "

          edit

          ") + + unauthorized = UserFactory.create(username="noauth-draft", password="edx") + with self.as_user(unauthorized): + self._get_block_draft_history(block_key, expect_response=403) + + def test_publish_history_empty_before_first_publish(self): + """ + A block that has never been published has an empty publish history. + """ + lib = self._create_library(slug="hist-empty", title="History Empty") + block = self._add_block_to_library(lib["id"], "problem", "prob1") + history = self._get_block_publish_history(block["id"]) + assert history == [] + + def test_publish_history_after_single_publish(self): + """ + Post-Verawood: After one direct component publish (direct=True) the history + contains exactly one group with the correct publisher, timestamp, contributor, + and a single entry in direct_published_entities for the component itself. + """ + lib = self._create_library(slug="hist-single", title="History Single") + block = self._add_block_to_library(lib["id"], "problem", "prob1") + block_key = block["id"] + + publish_time = datetime(2026, 1, 10, 12, 0, 0, tzinfo=UTC) + with freeze_time(publish_time): + self._publish_library_block(block_key) + + history = self._get_block_publish_history(block_key) + assert len(history) == 1 + group = history[0] + assert group["published_by"] == self.user.username + assert group["published_at"] == publish_time.isoformat().replace("+00:00", "Z") + assert isinstance(group["publish_log_uuid"], str) + assert any(c["username"] == self.user.username for c in group["contributors"]) + # Post-Verawood: component was directly published → single entry for itself + assert len(group["direct_published_entities"]) == 1 + entity = group["direct_published_entities"][0] + assert entity["entity_key"] == block_key + assert entity["entity_type"] == "problem" + + def test_publish_history_deleted_block_retains_title(self): + """ + When a block is soft-deleted and published, the direct_published_entities + entry shows the block's last known title (from old_version), not an empty string. + """ + lib = self._create_library(slug="hist-delete-title", title="History Delete Title") + block = self._add_block_to_library(lib["id"], "problem", "prob1") + block_key = block["id"] + self._set_library_block_olx( + block_key, + '

          content

          ', + ) + self._publish_library_block(block_key) + self._delete_library_block(block_key) + self._publish_library_block(block_key) + + history = self._get_block_publish_history(block_key) + # Most recent publish is the deletion + deletion_group = history[0] + assert len(deletion_group["direct_published_entities"]) == 1 + assert deletion_group["direct_published_entities"][0]["title"] == "My Problem Title" + + def test_publish_history_multiple_publishes(self): + """ + Multiple publish events are returned newest-first. + """ + lib = self._create_library(slug="hist-multi", title="History Multi") + block = self._add_block_to_library(lib["id"], "problem", "prob1") + block_key = block["id"] + + first_publish = datetime(2026, 1, 1, 0, 0, 0, tzinfo=UTC) + with freeze_time(first_publish): + self._publish_library_block(block_key) + + self._set_library_block_olx(block_key, "

          v2

          ") + + second_publish = datetime(2026, 2, 1, 0, 0, 0, tzinfo=UTC) + with freeze_time(second_publish): + self._publish_library_block(block_key) + + history = self._get_block_publish_history(block_key) + assert len(history) == 2 + assert history[0]["published_at"] == second_publish.isoformat().replace("+00:00", "Z") + assert history[1]["published_at"] == first_publish.isoformat().replace("+00:00", "Z") + + def test_publish_history_tracks_contributors(self): + """ + Contributors for the first publish include the block creator. + Note: set_library_block_olx does not record created_by, so OLX + edits are not tracked as contributions. + """ + lib = self._create_library(slug="hist-contrib", title="History Contributors") + block = self._add_block_to_library(lib["id"], "problem", "prob1") + block_key = block["id"] + + with freeze_time(datetime(2026, 1, 1, tzinfo=UTC)): + self._publish_library_block(block_key) + + history = self._get_block_publish_history(block_key) + assert len(history) == 1 + group = history[0] + assert any(c["username"] == self.user.username for c in group["contributors"]) + + def test_publish_history_entries(self): + """ + The entries endpoint returns the individual draft change records for a publish event. + """ + lib = self._create_library(slug="hist-entries", title="History Entries") + block = self._add_block_to_library(lib["id"], "problem", "prob1") + block_key = block["id"] + + with freeze_time(datetime(2026, 2, 15, tzinfo=UTC)): + self._set_library_block_olx(block_key, "

          edit 1

          ") + with freeze_time(datetime(2026, 2, 20, tzinfo=UTC)): + self._set_library_block_olx(block_key, "

          edit 2

          ") + + with freeze_time(datetime(2026, 3, 1, tzinfo=UTC)): + self._publish_library_block(block_key) + + history = self._get_block_publish_history(block_key) + assert len(history) == 1 + publish_log_uuid = history[0]["publish_log_uuid"] + + entries = self._get_block_publish_history_entries(block_key, publish_log_uuid) + assert len(entries) >= 1 + entry = entries[0] + assert "contributor" in entry + assert "changed_at" in entry + assert "title" in entry + assert "action" in entry + assert "old_version" in entry + assert "new_version" in entry + + def test_draft_history_deleted_has_null_new_version(self): + """ + Deleted draft history entry exposes new_version as null. + """ + lib = self._create_library(slug="draft-hist-delete-null", title="Draft History Delete Null") + block = self._add_block_to_library(lib["id"], "problem", "prob1") + block_key = block["id"] + + self._publish_library_block(block_key) + self._delete_library_block(block_key) + + history = self._get_block_draft_history(block_key) + assert len(history) >= 1 + assert history[0]["action"] == "deleted" + assert history[0]["old_version"] > 0 + assert history[0]["new_version"] is None + + def test_publish_history_entries_unknown_uuid(self): + """ + Requesting entries for a publish_log_uuid unrelated to this component returns an empty list. + """ + lib = self._create_library(slug="hist-baduid", title="History Bad UUID") + block = self._add_block_to_library(lib["id"], "problem", "prob1") + block_key = block["id"] + + with freeze_time(datetime(2026, 1, 1, tzinfo=UTC)): + self._publish_library_block(block_key) + + fake_uuid = str(uuid.uuid4()) + entries = self._get_block_publish_history_entries(block_key, fake_uuid, expect_response=200) + assert entries == [] + + def test_publish_history_nonexistent_block(self): + """ + Requesting publish history for a non-existent block returns 404. + """ + self._get_block_publish_history("lb:CL-TEST:hist-404:problem:nope", expect_response=404) + + def test_publish_history_permissions(self): + """ + A user without library access receives 403. + """ + lib = self._create_library(slug="hist-auth", title="History Auth") + block = self._add_block_to_library(lib["id"], "problem", "prob1") + block_key = block["id"] + + with freeze_time(datetime(2026, 1, 1, tzinfo=UTC)): + self._publish_library_block(block_key) + + unauthorized = UserFactory.create(username="noauth-hist", password="edx") + with self.as_user(unauthorized): + self._get_block_publish_history(block_key, expect_response=403) + + # --- Post-Verawood publish history tests --- + + def test_post_verawood_component_published_directly(self): + """ + Post-Verawood, direct=True: when a component is published directly, + direct_published_entities has a single entry for the component itself. + The component's own history and the container's history both show the + component as the directly published entity. + """ + lib = self._create_library(slug="pv-comp-direct", title="PV Comp Direct") + unit = self._create_container(lib["id"], "unit", "u1", "Unit 1") + unit_key = unit["id"] + block = self._add_block_to_library(lib["id"], "problem", "prob1") + block_key = block["id"] + self._add_container_children(unit_key, [block_key]) + + # Publish the component directly (not the unit) + self._publish_library_block(block_key) + + # Component history: direct_published_entities = [component] + comp_history = self._get_block_publish_history(block_key) + assert len(comp_history) == 1 + entities = comp_history[0]["direct_published_entities"] + assert len(entities) == 1 + assert entities[0]["entity_key"] == block_key + assert entities[0]["entity_type"] == "problem" + # scope_entity_key is always the component itself for component history + assert comp_history[0]["scope_entity_key"] == block_key + + # Container history: same publish log → same direct_published_entities + unit_history = self._get_container_publish_history(unit_key) + assert len(unit_history) == 1 + entities = unit_history[0]["direct_published_entities"] + assert len(entities) == 1 + assert entities[0]["entity_key"] == block_key + assert entities[0]["entity_type"] == "problem" + # Post-Verawood container group: scope_entity_key is null (frontend uses current container) + assert unit_history[0]["scope_entity_key"] is None + + def test_post_verawood_unit_published_directly(self): + """ + Post-Verawood, direct=True on the Unit: when a Unit is published directly, + the Unit's history shows the unit as directly published. The child component's + history shows the unit as the directly published entity (direct=False on component). + """ + lib = self._create_library(slug="pv-unit-direct", title="PV Unit Direct") + unit = self._create_container(lib["id"], "unit", "u1", "Unit 1") + unit_key = unit["id"] + block = self._add_block_to_library(lib["id"], "problem", "prob1") + block_key = block["id"] + self._add_container_children(unit_key, [block_key]) + + # Publish the unit directly (component is published as a dependency) + self._publish_container(unit_key) + + # Container history: 1 group, unit is direct + unit_history = self._get_container_publish_history(unit_key) + assert len(unit_history) == 1 + entities = unit_history[0]["direct_published_entities"] + assert len(entities) == 1 + assert entities[0]["entity_key"] == unit_key + assert entities[0]["entity_type"] == "unit" + assert unit_history[0]["scope_entity_key"] is None + + # Component history: 1 group, unit is the directly published entity + comp_history = self._get_block_publish_history(block_key) + assert len(comp_history) == 1 + entities = comp_history[0]["direct_published_entities"] + assert len(entities) == 1 + assert entities[0]["entity_key"] == unit_key + assert entities[0]["entity_type"] == "unit" + assert comp_history[0]["scope_entity_key"] == block_key + + def test_post_verawood_container_history_merges_same_publish_log(self): + """ + Post-Verawood: when the Unit and a Component are both touched in the same + PublishLog, the container history returns ONE merged group (not two separate + groups as in Pre-Verawood). + """ + lib = self._create_library(slug="pv-merged", title="PV Merged") + unit = self._create_container(lib["id"], "unit", "u1", "Unit 1") + unit_key = unit["id"] + block = self._add_block_to_library(lib["id"], "problem", "prob1") + block_key = block["id"] + self._add_container_children(unit_key, [block_key]) + + self._publish_container(unit_key) + + unit_history = self._get_container_publish_history(unit_key) + # Post-Verawood: ONE merged group for the entire PublishLog + assert len(unit_history) == 1 + + def test_post_verawood_container_history_entries_scope(self): + """ + Post-Verawood: the entries endpoint for a container returns entries for all + entities in scope (container + descendants) that participated in the PublishLog, + not just the container itself. + """ + lib = self._create_library(slug="pv-entries-scope", title="PV Entries Scope") + unit = self._create_container(lib["id"], "unit", "u1", "Unit 1") + unit_key = unit["id"] + block = self._add_block_to_library(lib["id"], "problem", "prob1") + block_key = block["id"] + self._add_container_children(unit_key, [block_key]) + + self._publish_container(unit_key) + + unit_history = self._get_container_publish_history(unit_key) + assert len(unit_history) == 1 + publish_log_uuid = unit_history[0]["publish_log_uuid"] + + entries = self._get_container_publish_history_entries(unit_key, publish_log_uuid) + # Post-Verawood: entries for both the unit and the component + assert len(entries) >= 1 + item_types = {e["item_type"] for e in entries} + assert "unit" in item_types + assert "problem" in item_types + + def test_post_verawood_multiple_publishes_stay_separate(self): + """ + Post-Verawood: two separate publish events produce two separate groups, + ordered most-recent-first. + """ + lib = self._create_library(slug="pv-multi", title="PV Multi") + unit = self._create_container(lib["id"], "unit", "u1", "Unit 1") + unit_key = unit["id"] + block = self._add_block_to_library(lib["id"], "problem", "prob1") + block_key = block["id"] + self._add_container_children(unit_key, [block_key]) + + first_publish = datetime(2026, 1, 1, tzinfo=UTC) + with freeze_time(first_publish): + self._publish_container(unit_key) + + self._set_library_block_olx(block_key, "

          v2

          ") + + second_publish = datetime(2026, 2, 1, tzinfo=UTC) + with freeze_time(second_publish): + self._publish_container(unit_key) + + unit_history = self._get_container_publish_history(unit_key) + assert len(unit_history) == 2 + assert unit_history[0]["published_at"] == second_publish.isoformat().replace("+00:00", "Z") + assert unit_history[1]["published_at"] == first_publish.isoformat().replace("+00:00", "Z") + + # --- Pre-Verawood publish history tests --- + # Pre-Verawood records have direct=None. We simulate them by publishing and + # then backfilling direct=None on the resulting PublishLogRecords, mirroring + # what the 0007_publishlogrecord_direct migration does for historical data. + + def test_pre_verawood_component_history_uses_component_as_entity(self): + """ + Pre-Verawood (direct=None): component history has one group per publish event. + direct_published_entities has a single approximated entry for the component itself. + """ + from openedx_content.models_api import PublishLogRecord + + lib = self._create_library(slug="prev-comp", title="PreV Comp") + block = self._add_block_to_library(lib["id"], "problem", "prob1") + block_key = block["id"] + self._publish_library_block(block_key) + + # Simulate Pre-Verawood by backfilling direct=None + PublishLogRecord.objects.all().update(direct=None) + + history = self._get_block_publish_history(block_key) + assert len(history) == 1 + entities = history[0]["direct_published_entities"] + assert len(entities) == 1 + assert entities[0]["entity_key"] == block_key + assert entities[0]["entity_type"] == "problem" + assert history[0]["scope_entity_key"] == block_key + + def test_pre_verawood_container_history_produces_separate_groups(self): + """ + Pre-Verawood (direct=None): when a Unit and Component are published in the + same PublishLog, the container history produces SEPARATE groups — one per + entity (unlike Post-Verawood which merges into one group). + """ + from openedx_content.models_api import PublishLogRecord + + lib = self._create_library(slug="prev-separate", title="PreV Separate") + unit = self._create_container(lib["id"], "unit", "u1", "Unit 1") + unit_key = unit["id"] + block = self._add_block_to_library(lib["id"], "problem", "prob1") + block_key = block["id"] + self._add_container_children(unit_key, [block_key]) + self._publish_container(unit_key) + + # Simulate Pre-Verawood by backfilling direct=None + PublishLogRecord.objects.all().update(direct=None) + + unit_history = self._get_container_publish_history(unit_key) + # Pre-Verawood: one group per entity (unit + component = 2 groups) + assert len(unit_history) == 2 + # Each group's scope_entity_key matches its own entity_key + for group in unit_history: + assert group["scope_entity_key"] == group["direct_published_entities"][0]["entity_key"] + + def test_pre_verawood_container_history_entries_only_container_itself(self): + """ + Pre-Verawood (direct=None): the entries endpoint returns entries only for + the container itself, not for descendant components (old behavior preserved). + """ + from openedx_content.models_api import PublishLogRecord + + lib = self._create_library(slug="prev-entries", title="PreV Entries") + unit = self._create_container(lib["id"], "unit", "u1", "Unit 1") + unit_key = unit["id"] + block = self._add_block_to_library(lib["id"], "problem", "prob1") + block_key = block["id"] + self._add_container_children(unit_key, [block_key]) + self._publish_container(unit_key) + + # Simulate Pre-Verawood by backfilling direct=None + PublishLogRecord.objects.all().update(direct=None) + + unit_history = self._get_container_publish_history(unit_key) + # Find the group whose approximated entity_key is the unit itself + unit_group = next( + g for g in unit_history + if g["direct_published_entities"][0]["entity_key"] == unit_key + ) + publish_log_uuid = unit_group["publish_log_uuid"] + + entries = self._get_container_publish_history_entries(unit_key, publish_log_uuid) + # Pre-Verawood: entries only for the container itself + assert len(entries) >= 1 + # All entries should be for the unit, not the component + for entry in entries: + assert entry["item_type"] == "unit" + + def test_creation_entry_returns_first_version(self): + """ + The creation entry corresponds to the first time the block was saved, + with action='created' and the correct fields populated. + """ + lib = self._create_library(slug="creation-entry-basic", title="Creation Entry Basic") + block = self._add_block_to_library(lib["id"], "problem", "prob1") + block_key = block["id"] + + entry = self._get_block_creation_entry(block_key) + + assert entry is not None + assert entry["action"] == "created" + assert entry["item_type"] == "problem" + assert entry["old_version"] == 0 + assert entry["new_version"] == 1 + assert "changed_at" in entry + assert "title" in entry + assert "contributor" in entry + + def test_creation_entry_unchanged_after_edits(self): + """ + Subsequent edits and publishes do not affect the creation entry — it + always reflects the first saved version. + """ + lib = self._create_library(slug="creation-entry-stable", title="Creation Entry Stable") + block = self._add_block_to_library(lib["id"], "problem", "prob1") + block_key = block["id"] + + # Record the creation entry before any edits + entry_before = self._get_block_creation_entry(block_key) + + self._set_library_block_olx(block_key, "

          edited

          ") + self._publish_library_block(block_key) + + entry_after = self._get_block_creation_entry(block_key) + + assert entry_after["changed_at"] == entry_before["changed_at"] + assert entry_after["action"] == "created" + + def test_creation_entry_nonexistent_block(self): + """ + Requesting the creation entry for a non-existent block returns 404. + """ + self._get_block_creation_entry("lb:CL-TEST:creation-404:problem:nope", expect_response=404) + + def test_creation_entry_permissions(self): + """ + A user without library access receives 403. + """ + lib = self._create_library(slug="creation-entry-auth", title="Creation Entry Auth") + block = self._add_block_to_library(lib["id"], "problem", "prob1") + block_key = block["id"] + + unauthorized = UserFactory.create(username="noauth-creation", password="edx") + with self.as_user(unauthorized): + self._get_block_creation_entry(block_key, expect_response=403) + + def test_container_creation_entry_returns_first_version(self): + """ + The container creation entry corresponds to the first time the container was + saved, with action='created' and item_type matching the container type. + """ + lib = self._create_library(slug="ct-creation-basic", title="Container Creation Basic") + unit = self._create_container(lib["id"], "unit", slug="unit1", display_name="My Unit") + unit_key = unit["id"] + + entry = self._get_container_creation_entry(unit_key) + + assert entry is not None + assert entry["action"] == "created" + assert entry["item_type"] == "unit" + assert entry["old_version"] == 0 + assert entry["new_version"] == 1 + assert entry["title"] == "My Unit" + assert "changed_at" in entry + assert "contributor" in entry + + def test_container_creation_entry_unchanged_after_edits(self): + """ + Subsequent edits and publishes do not affect the creation entry — it always + reflects the first saved version of the container. + """ + lib = self._create_library(slug="ct-creation-stable", title="Container Creation Stable") + unit = self._create_container(lib["id"], "unit", slug="unit1", display_name="Original Title") + unit_key = unit["id"] + + entry_before = self._get_container_creation_entry(unit_key) + + self._update_container(unit_key, display_name="Updated Title") + self._publish_container(unit_key) + + entry_after = self._get_container_creation_entry(unit_key) + + assert entry_after["changed_at"] == entry_before["changed_at"] + assert entry_after["action"] == "created" + assert entry_after["title"] == "Original Title" + + def test_container_creation_entry_permissions(self): + """ + A user without library access receives 403 for the container creation entry. + """ + lib = self._create_library(slug="ct-creation-auth", title="Container Creation Auth") + unit = self._create_container(lib["id"], "unit", slug="unit1", display_name="Auth Unit") + unit_key = unit["id"] + + unauthorized = UserFactory.create(username="noauth-ct-creation", password="edx") + with self.as_user(unauthorized): + self._get_container_creation_entry(unit_key, expect_response=403) + class LibraryRestoreViewTestCase(ContentLibrariesRestApiTest): """ @@ -987,17 +1650,17 @@ def test_restore_library_success(self): with self.as_user(self.admin_user): response_data = self._start_library_restore_task(self.uploaded_zip_file) - self.assertIn('task_id', response_data) - self.assertIsNotNone(response_data['task_id']) + self.assertIn('task_id', response_data) # noqa: PT009 + self.assertIsNotNone(response_data['task_id']) # noqa: PT009 ## GET the task status and result (task is run synchronously in tests) with self.as_user(self.admin_user): response_data = self._get_library_restore_task(response_data['task_id']) - self.assertIn('state', response_data) - self.assertEqual(response_data['state'], 'Succeeded') + self.assertIn('state', response_data) # noqa: PT009 + self.assertEqual(response_data['state'], 'Succeeded') # noqa: PT009 - self.assertIn('result', response_data) + self.assertIn('result', response_data) # noqa: PT009 task_result = response_data.get('result', {}) # Validate the learning package data in the result @@ -1022,11 +1685,11 @@ def test_restore_library_success(self): }, } - self.assertIn('learning_package_id', task_result) - self.assertTrue(LearningPackage.objects.filter(pk=task_result['learning_package_id']).exists()) + self.assertIn('learning_package_id', task_result) # noqa: PT009 + self.assertTrue(LearningPackage.objects.filter(pk=task_result['learning_package_id']).exists()) # noqa: PT009 for key, value in expected.items(): - self.assertEqual(task_result[key], value) + self.assertEqual(task_result[key], value) # noqa: PT009 def test_create_content_library_from_restore(self): """ @@ -1035,19 +1698,19 @@ def test_create_content_library_from_restore(self): with self.as_user(self.admin_user): response_data = self._start_library_restore_task(self.uploaded_zip_file) - self.assertIn('task_id', response_data) - self.assertIsNotNone(response_data['task_id']) + self.assertIn('task_id', response_data) # noqa: PT009 + self.assertIsNotNone(response_data['task_id']) # noqa: PT009 with self.as_user(self.admin_user): response_data = self._get_library_restore_task(response_data['task_id']) - self.assertIn('state', response_data) - self.assertEqual(response_data['state'], 'Succeeded') + self.assertIn('state', response_data) # noqa: PT009 + self.assertEqual(response_data['state'], 'Succeeded') # noqa: PT009 task_result = response_data.get('result', {}) - self.assertIn('learning_package_id', task_result) + self.assertIn('learning_package_id', task_result) # noqa: PT009 learning_package_id = task_result['learning_package_id'] - self.assertTrue(LearningPackage.objects.filter(pk=learning_package_id).exists()) + self.assertTrue(LearningPackage.objects.filter(pk=learning_package_id).exists()) # noqa: PT009 library_title = "Restored Library" library_description = "A library restored from a learning package" @@ -1061,16 +1724,16 @@ def test_create_content_library_from_restore(self): learning_package=learning_package_id, ) - self.assertIn('id', create_response_data) + self.assertIn('id', create_response_data) # noqa: PT009 library_locator = LibraryLocatorV2.from_string(create_response_data['id']) content_library = ContentLibrary.objects.get_by_key(library_locator) - self.assertIsNotNone(content_library) - self.assertEqual(content_library.learning_package.id, learning_package_id) - self.assertEqual(content_library.learning_package.title, library_title) - self.assertEqual(content_library.learning_package.description, library_description) - self.assertIn(self.org_short_name, content_library.library_key.org) - self.assertIn(self.library_slug, content_library.library_key.slug) + self.assertIsNotNone(content_library) # noqa: PT009 + self.assertEqual(content_library.learning_package.id, learning_package_id) # noqa: PT009 + self.assertEqual(content_library.learning_package.title, library_title) # noqa: PT009 + self.assertEqual(content_library.learning_package.description, library_description) # noqa: PT009 + self.assertIn(self.org_short_name, content_library.library_key.org) # noqa: PT009 + self.assertIn(self.library_slug, content_library.library_key.slug) # noqa: PT009 def test_restore_library_unauthorized(self): """ @@ -1112,7 +1775,7 @@ def test_get_restore_task_unfinished(self): "error_log": None, } - self.assertEqual(response_data, expected) + self.assertEqual(response_data, expected) # noqa: PT009 in_progress_task_status = self._create_user_task_status(state=UserTaskStatus.IN_PROGRESS) @@ -1123,7 +1786,7 @@ def test_get_restore_task_unfinished(self): response_data = self._get_library_restore_task(in_progress_task_status.task_id) expected["state"] = UserTaskStatus.IN_PROGRESS - self.assertEqual(response_data, expected) + self.assertEqual(response_data, expected) # noqa: PT009 def test_task_user_mismatch(self): """ @@ -1164,7 +1827,7 @@ def test_task_artifact_text_not_json(self): "error_log": None, } - self.assertEqual(response_data, expected) + self.assertEqual(response_data, expected) # noqa: PT009 def test_failed_task_with_error_log(self): """ @@ -1179,7 +1842,7 @@ def test_failed_task_with_error_log(self): with self.as_user(self.admin_user): with patch( - "openedx.core.djangoapps.content_libraries.tasks.authoring_api.load_learning_package", + "openedx.core.djangoapps.content_libraries.tasks.content_api.load_learning_package", return_value=error_result ): response = self._start_library_restore_task(self.uploaded_zip_file) @@ -1194,7 +1857,7 @@ def test_failed_task_with_error_log(self): 'result': None, } - self.assertEqual(task_data, expected) + self.assertEqual(task_data, expected) # noqa: PT009 def test_uncaught_error_creates_error_log(self): """ @@ -1202,7 +1865,7 @@ def test_uncaught_error_creates_error_log(self): """ with self.as_user(self.admin_user): with patch( - "openedx.core.djangoapps.content_libraries.tasks.authoring_api.load_learning_package", + "openedx.core.djangoapps.content_libraries.tasks.content_api.load_learning_package", side_effect=Exception("Uncaught exception during processing.") ): response = self._start_library_restore_task(self.uploaded_zip_file) @@ -1217,7 +1880,7 @@ def test_uncaught_error_creates_error_log(self): 'result': None, } - self.assertEqual(task_data, expected) + self.assertEqual(task_data, expected) # noqa: PT009 @skip_unless_cms @@ -1280,19 +1943,19 @@ def test_authz_scope_filters_by_authorized_libraries(self): filtered = perms[CAN_VIEW_THIS_CONTENT_LIBRARY].filter(user, all_libs).distinct() # TEST: Verify exactly 2 libraries returned (lib1 and lib2, not lib3) - self.assertEqual(filtered.count(), 2, "Should return exactly 2 authorized libraries") + self.assertEqual(filtered.count(), 2, "Should return exactly 2 authorized libraries") # noqa: PT009 # TEST: Verify correct libraries are included/excluded slugs = set(filtered.values_list('slug', flat=True)) - self.assertIn('lib1', slugs, "lib1 (org1:lib1) should be included") - self.assertIn('lib2', slugs, "lib2 (org2:lib2) should be included") - self.assertNotIn('lib3', slugs, "lib3 (org1:lib3) should be excluded") + self.assertIn('lib1', slugs, "lib1 (org1:lib1) should be included") # noqa: PT009 + self.assertIn('lib2', slugs, "lib2 (org2:lib2) should be included") # noqa: PT009 + self.assertNotIn('lib3', slugs, "lib3 (org1:lib3) should be excluded") # noqa: PT009 # TEST: Verify the org/slug combinations match lib1_result = filtered.get(slug='lib1') lib2_result = filtered.get(slug='lib2') - self.assertEqual(lib1_result.org.short_name, 'org1') - self.assertEqual(lib2_result.org.short_name, 'org2') + self.assertEqual(lib1_result.org.short_name, 'org1') # noqa: PT009 + self.assertEqual(lib2_result.org.short_name, 'org2') # noqa: PT009 def test_authz_scope_individual_check_with_permission(self): """ @@ -1321,7 +1984,7 @@ def test_authz_scope_individual_check_with_permission(self): with patch("openedx_authz.api.is_user_allowed", return_value=True): result = perms[CAN_VIEW_THIS_CONTENT_LIBRARY].check(user, library_obj) - self.assertTrue(result, "Should return True when user is authorized") + self.assertTrue(result, "Should return True when user is authorized") # noqa: PT009 def test_authz_scope_individual_check_without_permission(self): """ @@ -1350,10 +2013,10 @@ def test_authz_scope_individual_check_without_permission(self): with patch('openedx_authz.api.is_user_allowed', return_value=False): result = perms[CAN_VIEW_THIS_CONTENT_LIBRARY].check(user, library_obj) - self.assertFalse(result, "Should return False when user is not authorized") + self.assertFalse(result, "Should return False when user is not authorized") # noqa: PT009 - self.assertFalse(library_obj.allow_public_read) - self.assertFalse(user.is_staff) + self.assertFalse(library_obj.allow_public_read) # noqa: PT009 + self.assertFalse(user.is_staff) # noqa: PT009 def test_authz_scope_handles_empty_scopes(self): """ @@ -1387,13 +2050,13 @@ def test_authz_scope_handles_empty_scopes(self): ContentLibrary.objects.filter(slug="empty-lib") ).distinct() - self.assertEqual( + self.assertEqual( # noqa: PT009 filtered.count(), 0, "Should return 0 libraries when user has no authorized scopes", ) - self.assertTrue( + self.assertTrue( # noqa: PT009 ContentLibrary.objects.filter(slug="empty-lib").exists(), "Library should exist in database", ) @@ -1427,10 +2090,10 @@ def test_authz_scope_q_object_has_correct_structure(self): q_obj = rule.query(user) # Test 1: Verify it returns a Q object - self.assertIsInstance(q_obj, Q) + self.assertIsInstance(q_obj, Q) # noqa: PT009 # Test 2: Verify Q object uses OR connector (for multiple scopes) - self.assertEqual( + self.assertEqual( # noqa: PT009 q_obj.connector, 'OR', "Should use OR to combine different library scopes", @@ -1440,38 +2103,38 @@ def test_authz_scope_q_object_has_correct_structure(self): q_str = str(q_obj) # Should filter by org__short_name field - self.assertIn( + self.assertIn( # noqa: PT009 "org__short_name", q_str, "Q object must filter by org__short_name field", ) # Should filter by slug field - self.assertIn( + self.assertIn( # noqa: PT009 "slug", q_str, "Q object must filter by slug field", ) # Should contain exact org values - self.assertIn( + self.assertIn( # noqa: PT009 "specific-org1", q_str, "Q object must include 'specific-org1'", ) - self.assertIn( + self.assertIn( # noqa: PT009 "specific-org2", q_str, "Q object must include 'specific-org2'", ) # Should contain exact slug values - self.assertIn( + self.assertIn( # noqa: PT009 "specific-slug1", q_str, "Q object must include 'specific-slug1'", ) - self.assertIn( + self.assertIn( # noqa: PT009 'specific-slug2', q_str, "Q object must include 'specific-slug2'", @@ -1525,7 +2188,7 @@ def test_authz_scope_q_object_matches_exact_org_slug_pairs(self): filtered = ContentLibrary.objects.filter(q_obj) # TEST: Verify EXACTLY 2 libraries match (lib1 and lib2 only) - self.assertEqual( + self.assertEqual( # noqa: PT009 filtered.count(), 2, "Must match EXACTLY 2 libraries - only those with authorized (org, slug) pairs", @@ -1533,7 +2196,7 @@ def test_authz_scope_q_object_matches_exact_org_slug_pairs(self): # TEST: Verify lib1 matches (pair-org1, pair-lib1) lib1_result = filtered.filter(slug='pair-lib1', org__short_name='pair-org1') - self.assertEqual( + self.assertEqual( # noqa: PT009 lib1_result.count(), 1, "Must match lib1: (pair-org1, pair-lib1) - this exact pair is authorized", @@ -1541,7 +2204,7 @@ def test_authz_scope_q_object_matches_exact_org_slug_pairs(self): # TEST: Verify lib2 matches (pair-org2, pair-lib2) lib2_result = filtered.filter(slug='pair-lib2', org__short_name='pair-org2') - self.assertEqual( + self.assertEqual( # noqa: PT009 lib2_result.count(), 1, "Must match lib2: (pair-org2, pair-lib2) - this exact pair is authorized", @@ -1549,7 +2212,7 @@ def test_authz_scope_q_object_matches_exact_org_slug_pairs(self): # TEST: Verify lib3 does NOT match (pair-org1, pair-lib3) lib3_result = filtered.filter(slug='pair-lib3', org__short_name='pair-org1') - self.assertEqual( + self.assertEqual( # noqa: PT009 lib3_result.count(), 0, "Must NOT match lib3: (pair-org1, pair-lib3) - only pair-lib1 is authorized for pair-org1", @@ -1557,7 +2220,7 @@ def test_authz_scope_q_object_matches_exact_org_slug_pairs(self): # TEST: Verify lib4 does NOT match (pair-org3, pair-lib1) lib4_result = filtered.filter(slug='pair-lib1', org__short_name='pair-org3') - self.assertEqual( + self.assertEqual( # noqa: PT009 lib4_result.count(), 0, "Must NOT match lib4: (pair-org3, pair-lib1) - only pair-org1 is authorized for pair-lib1", @@ -1566,7 +2229,7 @@ def test_authz_scope_q_object_matches_exact_org_slug_pairs(self): # TEST: Verify the result set contains exactly the right libraries result_pairs = set(filtered.values_list('org__short_name', 'slug')) expected_pairs = {('pair-org1', 'pair-lib1'), ('pair-org2', 'pair-lib2')} - self.assertEqual( + self.assertEqual( # noqa: PT009 result_pairs, expected_pairs, f"Result must contain exactly {expected_pairs}, got {result_pairs}", @@ -1605,10 +2268,10 @@ def test_authz_scope_with_combined_authz_and_legacy_permissions(self): lib1 = self._create_library(slug="comb-lib1", org="comb-org", title="AuthZ Only Library") lib2 = self._create_library(slug="comb-lib2", org="comb-org", title="Legacy Only Library") lib3 = self._create_library(slug="comb-lib3", org="comb-org", title="Both AuthZ and Legacy Library") - lib4 = self._create_library(slug="comb-lib4", org="comb-org", title="No Permissions Library") + lib4 = self._create_library(slug="comb-lib4", org="comb-org", title="No Permissions Library") # noqa: F841 # Retrieve library objects for permission assignment - lib1_obj = ContentLibrary.objects.get_by_key(LibraryLocatorV2.from_string(lib1['id'])) + lib1_obj = ContentLibrary.objects.get_by_key(LibraryLocatorV2.from_string(lib1['id'])) # noqa: F841 lib2_obj = ContentLibrary.objects.get_by_key(LibraryLocatorV2.from_string(lib2['id'])) lib3_obj = ContentLibrary.objects.get_by_key(LibraryLocatorV2.from_string(lib3['id'])) @@ -1640,7 +2303,7 @@ def test_authz_scope_with_combined_authz_and_legacy_permissions(self): filtered = perms[CAN_VIEW_THIS_CONTENT_LIBRARY].filter(user, all_libs).distinct() # TEST: Verify exactly 3 libraries returned (lib1, lib2, lib3 - NOT lib4) - self.assertEqual( + self.assertEqual( # noqa: PT009 filtered.count(), 3, "Should return exactly 3 libraries: AuthZ-only, legacy-only, and both", @@ -1648,14 +2311,14 @@ def test_authz_scope_with_combined_authz_and_legacy_permissions(self): # TEST: Verify correct libraries are included slugs = set(filtered.values_list('slug', flat=True)) - self.assertIn('comb-lib1', slugs, "lib1 should be accessible via AuthZ permission") - self.assertIn('comb-lib2', slugs, "lib2 should be accessible via legacy permission") - self.assertIn('comb-lib3', slugs, "lib3 should be accessible via BOTH AuthZ and legacy permissions") - self.assertNotIn('comb-lib4', slugs, "lib4 should NOT be accessible (no permissions)") + self.assertIn('comb-lib1', slugs, "lib1 should be accessible via AuthZ permission") # noqa: PT009 + self.assertIn('comb-lib2', slugs, "lib2 should be accessible via legacy permission") # noqa: PT009 + self.assertIn('comb-lib3', slugs, "lib3 should be accessible via BOTH AuthZ and legacy permissions") # noqa: PT009 # pylint: disable=line-too-long + self.assertNotIn('comb-lib4', slugs, "lib4 should NOT be accessible (no permissions)") # noqa: PT009 # TEST: Verify lib3 doesn't get duplicated despite having both permission types lib3_results = filtered.filter(slug='comb-lib3') - self.assertEqual( + self.assertEqual( # noqa: PT009 lib3_results.count(), 1, "lib3 should appear exactly once despite having both AuthZ and legacy permissions", @@ -1669,7 +2332,7 @@ def test_authz_scope_with_combined_authz_and_legacy_permissions(self): ('comb-org', 'comb-lib2'), # Legacy only ('comb-org', 'comb-lib3'), # Both } - self.assertEqual( + self.assertEqual( # noqa: PT009 result_pairs, expected_pairs, f"Should get exactly the 3 authorized libraries via OR logic, got {result_pairs}", @@ -1678,7 +2341,7 @@ def test_authz_scope_with_combined_authz_and_legacy_permissions(self): @ddt.ddt class ContentLibraryXBlockValidationTest(APITestCase): - """Tests only focused on service validation, no Learning Core interactions here.""" + """Tests only focused on service validation, no openedx_content interactions here.""" @ddt.data( (URL_BLOCK_METADATA_URL, dict(block_key='totally_invalid_key')), @@ -1691,7 +2354,7 @@ def test_invalid_key(self, endpoint, endpoint_parameters): response = self.client.get( endpoint.format(**endpoint_parameters), ) - self.assertEqual(response.status_code, 404) + self.assertEqual(response.status_code, 404) # noqa: PT009 def test_xblock_handler_invalid_key(self): """This endpoint is tested separately from the previous ones as it's not a DRF endpoint.""" @@ -1702,7 +2365,7 @@ def test_xblock_handler_invalid_key(self): user_id='random', secure_token='random', ))) - self.assertEqual(response.status_code, 404) + self.assertEqual(response.status_code, 404) # noqa: PT009 @skip_unless_cms @@ -1785,9 +2448,9 @@ def _seed_database_with_policies(cls): This simulates the one-time database seeding that would happen during application deployment, separate from the runtime policy loading. """ + import casbin import pkg_resources from openedx_authz.engine.utils import migrate_policy_between_enforcers - import casbin global_enforcer = AuthzEnforcer.get_enforcer() global_enforcer.load_policy() @@ -1982,3 +2645,24 @@ def test_delete_library_permissions(self): with self.as_user(user): result = self._delete_library(self.lib_id, expect_response=status.HTTP_200_OK) assert result == {} + + def test_learn_from_library_permissions(self): + """ + Verify that users with view permissions can learn from the library. + Learning from a library means being able to render/interact with blocks. + """ + # Create and publish a block + block_data = self._add_block_to_library(self.lib_id, "problem", "test_problem") + block_id = block_data["id"] + self._commit_library_changes(self.lib_id) + + # Users with view permissions should be able to learn from the library + for user in self.library_viewers: + with self.as_user(user): + # Rendering a block view requires CAN_LEARN permission + self._render_block_view(block_id, "student_view", expect_response=status.HTTP_200_OK) + + # Users without view permissions should NOT be able to learn from the library + for user in self._all_users_excluding(self.library_viewers): + with self.as_user(user): + self._render_block_view(block_id, "student_view", expect_response=status.HTTP_403_FORBIDDEN) diff --git a/openedx/core/djangoapps/content_libraries/tests/test_course_to_library.py b/openedx/core/djangoapps/content_libraries/tests/test_course_to_library.py index 5b77791e9377..7bc7da0fc868 100644 --- a/openedx/core/djangoapps/content_libraries/tests/test_course_to_library.py +++ b/openedx/core/djangoapps/content_libraries/tests/test_course_to_library.py @@ -1,14 +1,14 @@ """ -Tests for Imports from Courses to Learning-Core-based Content Libraries +Tests for Imports from Courses to openedx_content-based Content Libraries """ import ddt from opaque_keys.edx.locator import LibraryContainerLocator -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase -from xmodule.modulestore.tests.factories import ToyCourseFactory from common.djangoapps.student.tests.factories import UserFactory from openedx.core.djangoapps.content_libraries.tests.base import ContentLibrariesRestApiTest from openedx.core.djangolib.testing.utils import skip_unless_cms +from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase +from xmodule.modulestore.tests.factories import ToyCourseFactory @skip_unless_cms diff --git a/openedx/core/djangoapps/content_libraries/tests/test_embed_block.py b/openedx/core/djangoapps/content_libraries/tests/test_embed_block.py index 41abeed82986..8f0fb85eebc8 100644 --- a/openedx/core/djangoapps/content_libraries/tests/test_embed_block.py +++ b/openedx/core/djangoapps/content_libraries/tests/test_embed_block.py @@ -6,15 +6,14 @@ import re import ddt +import pytest from django.core.exceptions import ValidationError from django.test.utils import override_settings -import pytest from xblock.core import XBlock -from openedx.core.djangoapps.content_libraries.tests.base import ( - ContentLibrariesRestApiTest -) +from openedx.core.djangoapps.content_libraries.tests.base import ContentLibrariesRestApiTest from openedx.core.djangolib.testing.utils import skip_unless_cms + from .fields_test_block import FieldsTestBlock @@ -24,7 +23,7 @@ class LibrariesEmbedViewTestCase(ContentLibrariesRestApiTest): """ Tests for embed_view and interacting with draft/published/past versions of - Learning-Core-based XBlocks (in Content Libraries). + openedx_content-based XBlocks (in Content Libraries). These tests use the REST API, which in turn relies on the Python API. Some tests may use the python API directly if necessary to provide @@ -169,7 +168,7 @@ def check_fields(display_name, setting_field, content_field): # Now try changing the authored fields of a specific past version using a handler: html = self._embed_block(block_id, version=2) - with pytest.raises(ValidationError, match=expected_msg) as err: + with pytest.raises(ValidationError, match=expected_msg) as err: # noqa: F841 call_update_handler(display_name="DN-X", setting_field="SV-X", content_field="CV-X") # Make sure the fields were not updated: diff --git a/openedx/core/djangoapps/content_libraries/tests/test_events.py b/openedx/core/djangoapps/content_libraries/tests/test_events.py index 975cfbafb4d9..c89905d7dd37 100644 --- a/openedx/core/djangoapps/content_libraries/tests/test_events.py +++ b/openedx/core/djangoapps/content_libraries/tests/test_events.py @@ -1,44 +1,53 @@ """ -Tests for Learning-Core-based Content Libraries +Tests for openedx_content-based Content Libraries """ +from unittest import mock + +from django.db import transaction from opaque_keys.edx.locator import ( LibraryCollectionLocator, LibraryContainerLocator, LibraryLocatorV2, LibraryUsageLocatorV2, ) +from openedx_content import api as content_api +from openedx_content import models_api as content_models from openedx_events.content_authoring.signals import ( - ContentLibraryData, - LibraryBlockData, - LibraryCollectionData, - LibraryContainerData, CONTENT_LIBRARY_CREATED, CONTENT_LIBRARY_DELETED, CONTENT_LIBRARY_UPDATED, + CONTENT_OBJECT_ASSOCIATIONS_CHANGED, LIBRARY_BLOCK_CREATED, LIBRARY_BLOCK_DELETED, - LIBRARY_BLOCK_UPDATED, LIBRARY_BLOCK_PUBLISHED, + LIBRARY_BLOCK_UPDATED, LIBRARY_COLLECTION_CREATED, LIBRARY_COLLECTION_DELETED, LIBRARY_COLLECTION_UPDATED, LIBRARY_CONTAINER_CREATED, LIBRARY_CONTAINER_DELETED, - LIBRARY_CONTAINER_UPDATED, LIBRARY_CONTAINER_PUBLISHED, + LIBRARY_CONTAINER_UPDATED, + ContentLibraryData, + ContentObjectChangedData, + LibraryBlockData, + LibraryCollectionData, + LibraryContainerData, ) from openedx.core.djangoapps.content_libraries.tests.base import ContentLibrariesRestApiTest from openedx.core.djangolib.testing.utils import skip_unless_cms +from .. import api -@skip_unless_cms -class ContentLibrariesEventsTestCase(ContentLibrariesRestApiTest): + +class BaseEventsTestCase(ContentLibrariesRestApiTest): """ - Event tests for Learning-Core-based Content Libraries + Base class for testing library events These tests use the REST API, which in turn relies on the Python API. """ + # Note: we assume all events are already enabled, as they should be. We do # NOT use OpenEdxEventsTestMixin, because it disables any events that you # don't explicitly enable and does so in a way that interferes with other @@ -47,6 +56,7 @@ class ContentLibrariesEventsTestCase(ContentLibrariesRestApiTest): CONTENT_LIBRARY_CREATED, CONTENT_LIBRARY_DELETED, CONTENT_LIBRARY_UPDATED, + CONTENT_OBJECT_ASSOCIATIONS_CHANGED, LIBRARY_BLOCK_CREATED, LIBRARY_BLOCK_DELETED, LIBRARY_BLOCK_UPDATED, @@ -104,11 +114,30 @@ def expect_new_events(self, *expected_events: dict) -> None: found = True break if not found: - raise AssertionError(f"Event {expected} not found among actual events: {self.new_events}") + raise AssertionError(f"Event {expected} not found among actual events:\n{self.new_events_str}") if len(self.new_events) > 0: - raise AssertionError(f"Events were emitted but not expected: {self.new_events}") + raise AssertionError(f"Events were emitted but not expected:\n{self.new_events_str}") self.clear_events() + @property + def new_events_str(self) -> str: + """Friendly-ish string representation of self.new_events""" + simplified_events = [e.copy() for e in self.new_events] + for e in simplified_events: + if e["sender"] is None: + del e["sender"] + if e["from_event_bus"] is False: + del e["from_event_bus"] + del e["metadata"] + return "\n".join([str(e) for e in simplified_events]) + + +@skip_unless_cms +class ContentLibrariesEventsTestCase(BaseEventsTestCase): + """ + Event tests for openedx_content-based Content Libraries + """ + ############################## Libraries ################################## def test_content_library_crud_events(self) -> None: @@ -433,21 +462,87 @@ def test_publish_container(self) -> None: self.lib1_key, LibraryUsageLocatorV2.from_string(html_block["id"]), ), }, - { # Not 100% sure we want this, but a PUBLISHED event is emitted for container 2 - # because one of its children's published versions has changed, so whether or - # not it contains unpublished changes may have changed and the search index - # may need to be updated. It is not actually published though. - # TODO: should this be a CONTAINER_CHILD_PUBLISHED event? + # No PUBLISHED event is emitted for container 2, because it doesn't have a published version yet. + # Publishing 'html_block' would have potentially affected it if container 2's published version had a + # reference to 'html_block', but it doesn't yet until we publish it. + ) + + # note that container 2 is still unpublished + c2_after = self._get_container(container2["id"]) + assert c2_after["has_unpublished_changes"] + + # publish container2 now: + self._publish_container(container2["id"]) + self.expect_new_events( + { # An event for container 1 being published: "signal": LIBRARY_CONTAINER_PUBLISHED, "library_container": LibraryContainerData( container_key=LibraryContainerLocator.from_string(container2["id"]), ), }, + { # An event for the html block in container 2 only: + "signal": LIBRARY_BLOCK_PUBLISHED, + "library_block": LibraryBlockData( + self.lib1_key, LibraryUsageLocatorV2.from_string(html_block2["id"]), + ), + }, ) - # note that container 2 is still unpublished - c2_after = self._get_container(container2["id"]) - assert c2_after["has_unpublished_changes"] + def test_publish_container_propagation(self) -> None: + """ + Test the events that get emitted when we publish the changes to an entity + that is used in multiple published containers + """ + # Create two containers and add the same component to both: + container1 = self._create_container(self.lib1_key, "unit", display_name="Alpha Unit", slug=None) + container2 = self._create_container(self.lib1_key, "unit", display_name="Bravo Unit", slug=None) + problem_block = self._add_block_to_library(self.lib1_key, "problem", "Problem1", can_stand_alone=False) + self._add_container_children(container1["id"], children_ids=[problem_block["id"]]) + self._add_container_children(container2["id"], children_ids=[problem_block["id"]]) + # Publish everything: + self._commit_library_changes(self.lib1_key) + + # clear event log after the initial mock data setup is complete: + self.clear_events() + + # Now modify the problem that's shared by both containers and publish the new version + self._set_library_block_olx(problem_block["id"], "UPDATED") + self.clear_events() # Clears the LIBRARY_BLOCK_UPDATED event + 2x LIBRARY_CONTAINER_UPDATED events + + # Now both containers have unpublished changes: + assert self._get_container(container1["id"])["has_unpublished_changes"] + assert self._get_container(container2["id"])["has_unpublished_changes"] + # Publish container1, which also published the shared problem component: + self._publish_container(container1["id"]) + # Now neither container has unpublished changes (even though we never touched container2): + assert self._get_container(container1["id"])["has_unpublished_changes"] is False + assert self._get_container(container2["id"])["has_unpublished_changes"] is False + + # And publish events were emitted: + self.expect_new_events( + # An event for the problem block in container 1 being indirectly published: + { + "signal": LIBRARY_BLOCK_PUBLISHED, + "library_block": LibraryBlockData( + self.lib1_key, LibraryUsageLocatorV2.from_string(problem_block["id"]), + ), + }, + # An event for container 1 being published *directly*: + { + "signal": LIBRARY_CONTAINER_PUBLISHED, + "library_container": LibraryContainerData( + container_key=LibraryContainerLocator.from_string(container1["id"]), + ), + }, + # And this time a PUBLISHED event should also be emitted for container2. + # It's published version hasn't changed, but its "contains unpublished changes" status has. + { + "signal": LIBRARY_CONTAINER_PUBLISHED, + "library_container": LibraryContainerData( + container_key=LibraryContainerLocator.from_string(container2["id"]), + ), + }, + ) def test_publish_child_container(self): """ @@ -484,7 +579,17 @@ def test_publish_child_container(self): container_key=LibraryContainerLocator.from_string(unit["id"]), ), }, - { # An event for parent (subsection): + # No PUBLISHED event is emitted for the subsection, because it doesn't have a published version yet. + ) + + # note that subsection is still unpublished + c2_after = self._get_container(subsection["id"]) + assert c2_after["has_unpublished_changes"] + + # Now publish the subsection + self._publish_container(subsection["id"]) + self.expect_new_events( + { # An event for the subsection being published: "signal": LIBRARY_CONTAINER_PUBLISHED, "library_container": LibraryContainerData( container_key=LibraryContainerLocator.from_string(subsection["id"]), @@ -492,9 +597,27 @@ def test_publish_child_container(self): }, ) - # note that subsection is still unpublished - c2_after = self._get_container(subsection["id"]) - assert c2_after["has_unpublished_changes"] + # Now rename the unit: + self._update_container(unit["id"], 'New Unit Display Name') + self.clear_events() + # Publish changes to the unit: + self._publish_container(unit["id"]) + self.expect_new_events( + { # An event for the unit being published: + "signal": LIBRARY_CONTAINER_PUBLISHED, + "library_container": LibraryContainerData( + container_key=LibraryContainerLocator.from_string(unit["id"]), + ), + }, + # And this time we DO get notified that the parent container is affected, because the unit is in its + # published version, and this publish affects the parent's "contains_unpublished_changes" status. + { + "signal": LIBRARY_CONTAINER_PUBLISHED, + "library_container": LibraryContainerData( + container_key=LibraryContainerLocator.from_string(subsection["id"]), + ), + }, + ) def test_restore_unit(self) -> None: """ @@ -520,10 +643,16 @@ def test_restore_unit(self) -> None: # Restore the unit self._restore_container(container_data["id"]) - self.expect_new_events({ - "signal": LIBRARY_CONTAINER_CREATED, - "library_container": LibraryContainerData(container_key), - }) + self.expect_new_events( + { + "signal": LIBRARY_CONTAINER_CREATED, + "library_container": LibraryContainerData(container_key), + }, + # We used to emit CONTENT_OBJECT_ASSOCIATIONS_CHANGED here for the restored container, specifically noting + # that changes=["collections", "tags"], because deleted things may have collections+tags that are once + # again relevant when it is restored. However, the CREATED event should be sufficient for notifying of that. + # (Or should we emit CREATED+UPDATED to be extra sure?) + ) def test_restore_unit_via_revert(self) -> None: """ @@ -584,12 +713,720 @@ def test_collection_crud(self) -> None: "library_collection": LibraryCollectionData(collection_key), }) - # Soft delete the collection. NOTE: at the moment, it's only possible to "soft delete" collections via - # the REST API, which sends an UPDATED event because the collection is now "disabled" but not deleted. + # Soft delete the collection. Whether we "soft" or "hard" delete, it sends a "DELETED" event. + # If we later restore it, it would send a "CREATED" event. self._soft_delete_collection(collection_key) self.expect_new_events({ - "signal": LIBRARY_COLLECTION_UPDATED, # UPDATED not DELETED. If we do a hard delete, it should be DELETED. + "signal": LIBRARY_COLLECTION_DELETED, "library_collection": LibraryCollectionData(collection_key), }) - # TODO: move more of the event-related collection tests from test_api.py to here, and convert them to use REST APIs +@skip_unless_cms +class ContentLibraryContainerEventsTest(BaseEventsTestCase): + """ + Event tests for container operations: signals emitted when components and + containers are created, updated, deleted, and associated with one another. + + setUp() builds the following structure in lib1 (note that some entities + are shared across multiple parents, so this is a DAG, not a strict tree):: + + Section 1 Section 2 + ├── Subsection 1 ◄───────── (shared) ────────┴── Subsection 1 + │ ├── Unit 1 ◄────────────────┐ (shared) + │ │ ├── problem1 │ + │ │ └── html1 ◄──┐ │ + │ └── Unit 2 │(shared) │ + │ └── html1 ◄──┘ │ + └── Subsection 2 │ + └── Unit 1 ◄────────────────┘ + + Orphans (created but not attached to any parent): + Unit 3, problem2 + """ + + def setUp(self) -> None: + super().setUp() + + # Create Units + self.unit1 = api.create_container(self.lib1_key, content_models.Unit, 'unit-1', 'Unit 1', None) + self.unit2 = api.create_container(self.lib1_key, content_models.Unit, 'unit-2', 'Unit 2', None) + self.unit3 = api.create_container(self.lib1_key, content_models.Unit, 'unit-3', 'Unit 3', None) + + # Create Subsections + self.subsection1 = api.create_container( + self.lib1_key, content_models.Subsection, 'subsection-1', 'Subsection 1', None, + ) + self.subsection2 = api.create_container( + self.lib1_key, content_models.Subsection, 'subsection-2', 'Subsection 2', None, + ) + + # Create Sections + self.section1 = api.create_container( + self.lib1_key, content_models.Section, 'section-1', 'Section 1', None, + ) + self.section2 = api.create_container( + self.lib1_key, content_models.Section, 'section-2', 'Section 2', None, + ) + + # Create XBlocks + self.problem_block = self._add_block_to_library(self.lib1_key, "problem", "problem1") + self.problem_block_usage_key = LibraryUsageLocatorV2.from_string(self.problem_block["id"]) + self.problem_block_2 = self._add_block_to_library(self.lib1_key, "problem", "problem2") + self.html_block = self._add_block_to_library(self.lib1_key, "html", "html1") + self.html_block_usage_key = LibraryUsageLocatorV2.from_string(self.html_block["id"]) + + # Add content to units + api.update_container_children( + self.unit1.container_key, [self.problem_block_usage_key, self.html_block_usage_key], None, + ) + api.update_container_children( + self.unit2.container_key, [self.html_block_usage_key], None, + ) + + # Add units to subsections + api.update_container_children( + self.subsection1.container_key, [self.unit1.container_key, self.unit2.container_key], None, + ) + api.update_container_children( + self.subsection2.container_key, [self.unit1.container_key], None, + ) + + # Add subsections to sections + api.update_container_children( + self.section1.container_key, [self.subsection1.container_key, self.subsection2.container_key], None, + ) + api.update_container_children( + self.section2.container_key, [self.subsection1.container_key], None, + ) + + # Clear events emitted during setUp + self.clear_events() + + ############################## Component update signals ################################## + + def test_container_updated_when_component_deleted(self) -> None: + api.delete_library_block(self.html_block_usage_key) + self.expect_new_events( + # The block itself was deleted: + { + "signal": LIBRARY_BLOCK_DELETED, + "library_block": LibraryBlockData(self.lib1_key, self.html_block_usage_key), + }, + # That block was a child of two units, so both parent units are flagged as updated + # e.g. to update their "child_display_names" in the search index. + { + "signal": LIBRARY_CONTAINER_UPDATED, + "library_container": LibraryContainerData(container_key=self.unit1.container_key), + }, + { + "signal": LIBRARY_CONTAINER_UPDATED, + "library_container": LibraryContainerData(container_key=self.unit2.container_key), + }, + # openedx_content also lists ancestor containers of the affected units as changed. + # We don't strictly need this at the moment, at least as far as keeping our search index updated. + { + "signal": LIBRARY_CONTAINER_UPDATED, + "library_container": LibraryContainerData(container_key=self.subsection1.container_key), + }, + { + "signal": LIBRARY_CONTAINER_UPDATED, + "library_container": LibraryContainerData(container_key=self.subsection2.container_key), + }, + { + "signal": LIBRARY_CONTAINER_UPDATED, + "library_container": LibraryContainerData(container_key=self.section1.container_key), + }, + { + "signal": LIBRARY_CONTAINER_UPDATED, + "library_container": LibraryContainerData(container_key=self.section2.container_key), + }, + ) + + def test_container_updated_when_component_restored(self) -> None: + api.delete_library_block(self.html_block_usage_key) + self.clear_events() + + api.restore_library_block(self.html_block_usage_key) + self.expect_new_events( + # Restoring the block re-creates it: + { + "signal": LIBRARY_BLOCK_CREATED, + "library_block": LibraryBlockData(self.lib1_key, self.html_block_usage_key), + }, + # We used to emit CONTENT_OBJECT_ASSOCIATIONS_CHANGED here for the restored block, specifically noting + # that changes=["collections", "tags", "units"], because deleted things may have collections+tags+containers + # that are once again relevant when it is restored. However, the CREATED event should be sufficient for + # notifying of that. (Or should we emit CREATED+UPDATED to be extra sure?) + # The restored block is a child of two units, so both parent units are flagged as updated: + { + "signal": LIBRARY_CONTAINER_UPDATED, + "library_container": LibraryContainerData(container_key=self.unit1.container_key), + }, + { + "signal": LIBRARY_CONTAINER_UPDATED, + "library_container": LibraryContainerData(container_key=self.unit2.container_key), + }, + # openedx_content also lists ancestor containers of the affected units as changed. + # We don't strictly need this at the moment, at least as far as keeping our search index updated. + { + "signal": LIBRARY_CONTAINER_UPDATED, + "library_container": LibraryContainerData(container_key=self.subsection1.container_key), + }, + { + "signal": LIBRARY_CONTAINER_UPDATED, + "library_container": LibraryContainerData(container_key=self.subsection2.container_key), + }, + { + "signal": LIBRARY_CONTAINER_UPDATED, + "library_container": LibraryContainerData(container_key=self.section1.container_key), + }, + { + "signal": LIBRARY_CONTAINER_UPDATED, + "library_container": LibraryContainerData(container_key=self.section2.container_key), + }, + ) + + def test_container_updated_when_component_olx_updated(self) -> None: + self._set_library_block_olx(self.html_block_usage_key, "Hello world!") + self.expect_new_events( + # The block's OLX changed: + { + "signal": LIBRARY_BLOCK_UPDATED, + "library_block": LibraryBlockData(self.lib1_key, self.html_block_usage_key), + }, + # That block is used in two units, so both parent units are flagged as updated + # e.g. to update their "child_display_names" in the search index, if the child's name has changed. + { + "signal": LIBRARY_CONTAINER_UPDATED, + "library_container": LibraryContainerData(container_key=self.unit1.container_key), + }, + { + "signal": LIBRARY_CONTAINER_UPDATED, + "library_container": LibraryContainerData(container_key=self.unit2.container_key), + }, + # openedx_content also lists ancestor containers of the affected units as changed. + # We don't strictly need this at the moment, at least as far as keeping our search index updated. + { + "signal": LIBRARY_CONTAINER_UPDATED, + "library_container": LibraryContainerData(container_key=self.subsection1.container_key), + }, + { + "signal": LIBRARY_CONTAINER_UPDATED, + "library_container": LibraryContainerData(container_key=self.subsection2.container_key), + }, + { + "signal": LIBRARY_CONTAINER_UPDATED, + "library_container": LibraryContainerData(container_key=self.section1.container_key), + }, + { + "signal": LIBRARY_CONTAINER_UPDATED, + "library_container": LibraryContainerData(container_key=self.section2.container_key), + }, + ) + + def test_container_updated_when_component_fields_updated(self) -> None: + block_olx = "Hello world!" + self._set_library_block_fields(self.html_block_usage_key, {"data": block_olx, "metadata": {}}) + self.expect_new_events( + { + "signal": LIBRARY_BLOCK_UPDATED, + "library_block": LibraryBlockData(self.lib1_key, self.html_block_usage_key), + }, + # That block is used in two containers, so we expect events for them too: + # This is used e.g. to update "child_display_names" in the search index, if the child's name has changed. + { + "signal": LIBRARY_CONTAINER_UPDATED, + "library_container": LibraryContainerData(container_key=self.unit1.container_key), + }, + { + "signal": LIBRARY_CONTAINER_UPDATED, + "library_container": LibraryContainerData(container_key=self.unit2.container_key), + }, + # openedx_content also lists and parent containers of affected containers as changed, and so on... + # We don't strictly need this at the moment, at least as far as keeping our search index updated. + { + "signal": LIBRARY_CONTAINER_UPDATED, + "library_container": LibraryContainerData(container_key=self.subsection1.container_key), + }, + { + "signal": LIBRARY_CONTAINER_UPDATED, + "library_container": LibraryContainerData(container_key=self.subsection2.container_key), + }, + { + "signal": LIBRARY_CONTAINER_UPDATED, + "library_container": LibraryContainerData(container_key=self.section1.container_key), + }, + { + "signal": LIBRARY_CONTAINER_UPDATED, + "library_container": LibraryContainerData(container_key=self.section2.container_key), + }, + ) + + ############################## Container update signals ################################## + + def test_container_updated_when_unit_updated(self) -> None: + self._update_container(self.unit1.container_key, 'New Unit Display Name') + self.expect_new_events( + # We renamed this unit, so we get an UPDATED event for it: + { + "signal": LIBRARY_CONTAINER_UPDATED, + "library_container": LibraryContainerData(container_key=self.unit1.container_key), + }, + # We also get events for its parent containers + # e.g. to update their "child_display_names" in the search index. + { + "signal": LIBRARY_CONTAINER_UPDATED, + "library_container": LibraryContainerData(container_key=self.subsection1.container_key), + }, + { + "signal": LIBRARY_CONTAINER_UPDATED, + "library_container": LibraryContainerData(container_key=self.subsection2.container_key), + }, + # openedx_content also lists ancestor containers of the affected unit as changed. + # We don't strictly need this at the moment, at least as far as keeping our search index updated. + { + "signal": LIBRARY_CONTAINER_UPDATED, + "library_container": LibraryContainerData(container_key=self.section1.container_key), + }, + { + "signal": LIBRARY_CONTAINER_UPDATED, + "library_container": LibraryContainerData(container_key=self.section2.container_key), + }, + # Finally, any child components receive a "units changed" notification + # e.g. to update the "units this component is used in" in the search index. + { + "signal": CONTENT_OBJECT_ASSOCIATIONS_CHANGED, + "content_object": ContentObjectChangedData( + object_id=str(self.problem_block_usage_key), changes=["units"], + ), + }, + { + "signal": CONTENT_OBJECT_ASSOCIATIONS_CHANGED, + "content_object": ContentObjectChangedData( + object_id=str(self.html_block_usage_key), changes=["units"], + ), + }, + ) + + def test_container_updated_when_subsection_updated(self) -> None: + self._update_container(self.subsection1.container_key, 'New Subsection Display Name') + self.expect_new_events( + # We renamed this container, so we get an UPDATED event for it: + { + "signal": LIBRARY_CONTAINER_UPDATED, + "library_container": LibraryContainerData(container_key=self.subsection1.container_key), + }, + # We also get events for its parent containers + # e.g. to update their "child_display_names" in the search index + { + "signal": LIBRARY_CONTAINER_UPDATED, + "library_container": LibraryContainerData(container_key=self.section1.container_key), + }, + { + "signal": LIBRARY_CONTAINER_UPDATED, + "library_container": LibraryContainerData(container_key=self.section2.container_key), + }, + # Finally, any child containers receive a "subsections changed" notification + # e.g. to update the "subsections this unit is used in" in the search index. + { + "signal": CONTENT_OBJECT_ASSOCIATIONS_CHANGED, + "content_object": ContentObjectChangedData( + object_id=str(self.unit1.container_key), changes=["subsections"], + ), + }, + { + "signal": CONTENT_OBJECT_ASSOCIATIONS_CHANGED, + "content_object": ContentObjectChangedData( + object_id=str(self.unit2.container_key), changes=["subsections"], + ), + }, + ) + + def test_container_updated_when_section_updated(self) -> None: + self._update_container(self.section1.container_key, 'New Section Display Name') + self.expect_new_events( + { + "signal": LIBRARY_CONTAINER_UPDATED, + "library_container": LibraryContainerData(container_key=self.section1.container_key), + }, + { + "signal": CONTENT_OBJECT_ASSOCIATIONS_CHANGED, + "content_object": ContentObjectChangedData( + object_id=str(self.subsection1.container_key), changes=["sections"], + ), + }, + { + "signal": CONTENT_OBJECT_ASSOCIATIONS_CHANGED, + "content_object": ContentObjectChangedData( + object_id=str(self.subsection2.container_key), changes=["sections"], + ), + }, + ) + + ############################## Association change signals ################################## + + def test_associations_changed_when_component_removed(self) -> None: + html_block_3 = self._add_block_to_library(self.lib1_key, "html", "html3") + api.update_container_children( + self.unit2.container_key, + [LibraryUsageLocatorV2.from_string(html_block_3["id"])], + None, + entities_action=content_api.ChildrenEntitiesAction.APPEND, + ) + self.clear_events() + + api.update_container_children( + self.unit2.container_key, + [LibraryUsageLocatorV2.from_string(html_block_3["id"])], + None, + entities_action=content_api.ChildrenEntitiesAction.REMOVE, + ) + self.expect_new_events( + { + "signal": CONTENT_OBJECT_ASSOCIATIONS_CHANGED, + "content_object": ContentObjectChangedData( + object_id=html_block_3["id"], changes=["units"], + ), + }, + { + "signal": LIBRARY_CONTAINER_UPDATED, + "library_container": LibraryContainerData(container_key=self.unit2.container_key), + }, + # Because we removed html3 from unit2, the ancestor containers of unit2 are also emitted as changed. + # We don't strictly need this at the moment, at least as far as keeping our search index updated. + { + "signal": LIBRARY_CONTAINER_UPDATED, + "library_container": LibraryContainerData(container_key=self.subsection1.container_key), + }, + { + "signal": LIBRARY_CONTAINER_UPDATED, + "library_container": LibraryContainerData(container_key=self.section1.container_key), + }, + { + "signal": LIBRARY_CONTAINER_UPDATED, + "library_container": LibraryContainerData(container_key=self.section2.container_key), + }, + ) + + def test_associations_changed_when_unit_removed(self) -> None: + unit4 = api.create_container(self.lib1_key, content_models.Unit, 'unit-4', 'Unit 4', None) + api.update_container_children( + self.subsection2.container_key, + [unit4.container_key], + None, + entities_action=content_api.ChildrenEntitiesAction.APPEND, + ) + self.clear_events() + + api.update_container_children( + self.subsection2.container_key, + [unit4.container_key], + None, + entities_action=content_api.ChildrenEntitiesAction.REMOVE, + ) + self.expect_new_events( + # unit4 was removed from subsection2, so we get a notification that "parent subsection(s) have changed": + { + "signal": CONTENT_OBJECT_ASSOCIATIONS_CHANGED, + "content_object": ContentObjectChangedData( + object_id=str(unit4.container_key), changes=["subsections"], + ), + }, + # We modified subsection2 by changing its list of children, so we get a CONTAINER_UPDATED event for it: + { + "signal": LIBRARY_CONTAINER_UPDATED, + "library_container": LibraryContainerData(container_key=self.subsection2.container_key), + }, + # Because subsection2 itself was changed, we get change notifications for its ancestors. + # We don't strictly need this at the moment, at least as far as keeping our search index updated. + { + "signal": LIBRARY_CONTAINER_UPDATED, + "library_container": LibraryContainerData(container_key=self.section1.container_key), + }, + ) + + def test_associations_changed_when_subsection_removed(self) -> None: + subsection3 = api.create_container( + self.lib1_key, content_models.Subsection, 'subsection-3', 'Subsection 3', None, + ) + api.update_container_children( + self.section2.container_key, + [subsection3.container_key], + None, + entities_action=content_api.ChildrenEntitiesAction.APPEND, + ) + self.clear_events() + + api.update_container_children( + self.section2.container_key, + [subsection3.container_key], + None, + entities_action=content_api.ChildrenEntitiesAction.REMOVE, + ) + self.expect_new_events( + { + "signal": CONTENT_OBJECT_ASSOCIATIONS_CHANGED, + "content_object": ContentObjectChangedData( + object_id=str(subsection3.container_key), changes=["sections"], + ), + }, + { + "signal": LIBRARY_CONTAINER_UPDATED, + "library_container": LibraryContainerData(container_key=self.section2.container_key), + }, + ) + + def test_associations_changed_when_components_added(self) -> None: + html_block_1 = self._add_block_to_library(self.lib1_key, "html", "html4") + html_block_2 = self._add_block_to_library(self.lib1_key, "html", "html5") + self.clear_events() + + api.update_container_children( + self.unit2.container_key, + [ + LibraryUsageLocatorV2.from_string(html_block_1["id"]), + LibraryUsageLocatorV2.from_string(html_block_2["id"]), + ], + None, + entities_action=content_api.ChildrenEntitiesAction.APPEND, + ) + self.expect_new_events( + # We added html4 and html4 to a new unit, so they get "parent unit(s) changed" events: + { + "signal": CONTENT_OBJECT_ASSOCIATIONS_CHANGED, + "content_object": ContentObjectChangedData( + object_id=html_block_1["id"], changes=["units"], + ), + }, + { + "signal": CONTENT_OBJECT_ASSOCIATIONS_CHANGED, + "content_object": ContentObjectChangedData( + object_id=html_block_2["id"], changes=["units"], + ), + }, + # We modified unit2 by changing its list of children, so we get a CONTAINER_UPDATED event for it: + { + "signal": LIBRARY_CONTAINER_UPDATED, + "library_container": LibraryContainerData(container_key=self.unit2.container_key), + }, + # Because the unit itself was changed, we get change notifications for its ancestors. + # We don't strictly need this at the moment, at least as far as keeping our search index updated. + { + "signal": LIBRARY_CONTAINER_UPDATED, + "library_container": LibraryContainerData(container_key=self.subsection1.container_key), + }, + { + "signal": LIBRARY_CONTAINER_UPDATED, + "library_container": LibraryContainerData(container_key=self.section1.container_key), + }, + { + "signal": LIBRARY_CONTAINER_UPDATED, + "library_container": LibraryContainerData(container_key=self.section2.container_key), + }, + ) + + def test_associations_changed_when_units_added(self) -> None: + # Create "unit4" and "unit5" and add them to subsection2: + unit4 = api.create_container(self.lib1_key, content_models.Unit, 'unit-4', 'Unit 4', None) + unit5 = api.create_container(self.lib1_key, content_models.Unit, 'unit-5', 'Unit 5', None) + self.clear_events() + + api.update_container_children( + self.subsection2.container_key, + [unit4.container_key, unit5.container_key], + None, + entities_action=content_api.ChildrenEntitiesAction.APPEND, + ) + self.expect_new_events( + # Each unit was added to a new subsection, so we get a "subsections changed" event for each: + { + "signal": CONTENT_OBJECT_ASSOCIATIONS_CHANGED, + "content_object": ContentObjectChangedData( + object_id=str(unit4.container_key), changes=["subsections"], + ), + }, + { + "signal": CONTENT_OBJECT_ASSOCIATIONS_CHANGED, + "content_object": ContentObjectChangedData( + object_id=str(unit5.container_key), changes=["subsections"], + ), + }, + # The subsection itself was updated (its list of children changed): + { + "signal": LIBRARY_CONTAINER_UPDATED, + "library_container": LibraryContainerData(container_key=self.subsection2.container_key), + }, + # And because the subsection itself was changed, we get change notifications for its ancestors. + { + "signal": LIBRARY_CONTAINER_UPDATED, + "library_container": LibraryContainerData(container_key=self.section1.container_key), + }, + ) + + def test_associations_changed_when_subsections_added(self) -> None: + subsection3 = api.create_container( + self.lib1_key, content_models.Subsection, 'subsection-3', 'Subsection 3', None, + ) + subsection4 = api.create_container( + self.lib1_key, content_models.Subsection, 'subsection-4', 'Subsection 4', None, + ) + self.clear_events() + + api.update_container_children( + self.section2.container_key, + [subsection3.container_key, subsection4.container_key], + None, + entities_action=content_api.ChildrenEntitiesAction.APPEND, + ) + self.expect_new_events( + { + "signal": CONTENT_OBJECT_ASSOCIATIONS_CHANGED, + "content_object": ContentObjectChangedData( + object_id=str(subsection3.container_key), changes=["sections"], + ), + }, + { + "signal": CONTENT_OBJECT_ASSOCIATIONS_CHANGED, + "content_object": ContentObjectChangedData( + object_id=str(subsection4.container_key), changes=["sections"], + ), + }, + { + "signal": LIBRARY_CONTAINER_UPDATED, + "library_container": LibraryContainerData(container_key=self.section2.container_key), + }, + ) + + ############################## Revert signals ################################## + + def test_container_updated_when_component_delete_reverted(self) -> None: + """ + When a component is deleted and then the delete is reverted, signals + will be emitted to update any containing containers. + """ + problem_block_2_key = LibraryUsageLocatorV2.from_string(self.problem_block_2["id"]) + api.update_container_children(self.unit3.container_key, [problem_block_2_key], user_id=None) + api.publish_changes(self.lib1_key) + api.delete_library_block(problem_block_2_key) + self.clear_events() + + api.revert_changes(self.lib1_key) + self.expect_new_events( + { + "signal": LIBRARY_BLOCK_CREATED, + "library_block": LibraryBlockData(library_key=self.lib1_key, usage_key=problem_block_2_key), + }, + { + "signal": LIBRARY_CONTAINER_UPDATED, + "library_container": LibraryContainerData(container_key=self.unit3.container_key), + }, + ) + + ############################## Transaction/signal correctness ################################## + + def test_no_signal_on_set_block_olx_rollback(self) -> None: + """ + LIBRARY_BLOCK_UPDATED is NOT emitted when set_library_block_olx is called + within a transaction that is later rolled back. + """ + try: + with transaction.atomic(): + api.set_library_block_olx( + self.problem_block_usage_key, + "Updated inside rolled-back transaction", + ) + raise RuntimeError("Force rollback") + except RuntimeError: + pass + + self.expect_new_events() + + def test_signal_emitted_when_set_block_olx_succeeds(self) -> None: + """ + LIBRARY_BLOCK_UPDATED IS emitted when set_library_block_olx completes + successfully. + """ + api.set_library_block_olx( + self.problem_block_usage_key, + "Updated successfully", + ) + self.expect_new_events( + { + "signal": LIBRARY_BLOCK_UPDATED, + "library_block": LibraryBlockData( + library_key=self.lib1_key, + usage_key=self.problem_block_usage_key, + ), + }, + # Since the problem is part of a unit, we also get LIBRARY_CONTAINER_UPDATED on the parent unit. + # This is used e.g. to update "child_display_names" in the search index, if the child's name has changed. + { + "signal": LIBRARY_CONTAINER_UPDATED, + "library_container": LibraryContainerData(container_key=self.unit1.container_key), + }, + # openedx_content also lists and parent containers of affected containers as changed, and so on... + # We don't strictly need this at the moment, at least as far as keeping our search index updated. + { + "signal": LIBRARY_CONTAINER_UPDATED, + "library_container": LibraryContainerData(container_key=self.subsection1.container_key), + }, + { + "signal": LIBRARY_CONTAINER_UPDATED, + "library_container": LibraryContainerData(container_key=self.subsection2.container_key), + }, + { + "signal": LIBRARY_CONTAINER_UPDATED, + "library_container": LibraryContainerData(container_key=self.section1.container_key), + }, + { + "signal": LIBRARY_CONTAINER_UPDATED, + "library_container": LibraryContainerData(container_key=self.section2.container_key), + }, + ) + + def test_no_signals_on_import_container_failure(self) -> None: + """ + When import_staged_content_from_user_clipboard fails mid-way, none of + LIBRARY_CONTAINER_CREATED, LIBRARY_BLOCK_CREATED, or LIBRARY_BLOCK_UPDATED + are emitted, so the search index is not polluted with orphan entries. + """ + api.copy_container(self.unit1.container_key, self.user.id) + + with mock.patch( + "openedx.core.djangoapps.content_libraries.api.blocks.update_container_children", + side_effect=RuntimeError("Simulated failure"), + ), self.assertRaises(RuntimeError): # noqa: PT027 + api.import_staged_content_from_user_clipboard(self.lib1_key, self.user) + + self.expect_new_events() + + def test_signals_emitted_on_import_container_success(self) -> None: + """ + When import_staged_content_from_user_clipboard succeeds, LIBRARY_CONTAINER_CREATED + is emitted for the new container, along with association change events for its children. + """ + api.copy_container(self.unit1.container_key, self.user.id) + new_container = api.import_staged_content_from_user_clipboard(self.lib1_key, self.user) + new_container_key = new_container.container_key # type: ignore[attr-defined] + self.expect_new_events( + { + "signal": LIBRARY_CONTAINER_CREATED, + "library_container": LibraryContainerData(container_key=new_container_key), + }, + { + "signal": CONTENT_OBJECT_ASSOCIATIONS_CHANGED, + "content_object": ContentObjectChangedData( + object_id=str(self.problem_block_usage_key), changes=["units"], + ), + }, + { + "signal": CONTENT_OBJECT_ASSOCIATIONS_CHANGED, + "content_object": ContentObjectChangedData( + object_id=str(self.html_block_usage_key), changes=["units"], + ), + }, + { + "signal": LIBRARY_CONTAINER_UPDATED, + "library_container": LibraryContainerData(container_key=new_container_key), + }, + ) diff --git a/openedx/core/djangoapps/content_libraries/tests/test_models.py b/openedx/core/djangoapps/content_libraries/tests/test_models.py index eded47a305d2..88213499afbc 100644 --- a/openedx/core/djangoapps/content_libraries/tests/test_models.py +++ b/openedx/core/djangoapps/content_libraries/tests/test_models.py @@ -3,22 +3,10 @@ """ -from unittest import mock - from django.test import TestCase -from django.test import RequestFactory -from django.contrib.auth import get_user_model - -from pylti1p3.contrib.django.lti1p3_tool_config.models import LtiToolKey - from organizations.models import Organization -from opaque_keys.edx.locator import LibraryLocatorV2, LibraryUsageLocatorV2 -from ..models import ALL_RIGHTS_RESERVED -from ..models import ContentLibrary -from ..models import LtiGradedResource -from ..models import LtiProfile -from ..models import LtiTool +from ..models import ALL_RIGHTS_RESERVED, ContentLibrary class ContentLibraryTest(TestCase): @@ -39,264 +27,3 @@ def _create_library(self, **kwds): license=ALL_RIGHTS_RESERVED, **kwds, ) - - def test_authorize_lti_launch_when_no_library(self): - """ - Given no library - When authorize_lti_launch is called - Then return False - """ - self.assertFalse(ContentLibrary.objects.exists()) - authorized = ContentLibrary.authorize_lti_launch( - LibraryLocatorV2(org='foo', slug='foobar'), - issuer='http://a-fake-issuer', - client_id='a-fake-client-id') - self.assertFalse(authorized) - - def test_authorize_lti_launch_when_null(self): - """ - Given a library WITHOUT an lti tool set - When authorize_lti_launch is called - Then return False - """ - library = self._create_library() - authorized = ContentLibrary.authorize_lti_launch( - library.library_key, - issuer='http://a-fake-issuer', - client_id='a-fake-client-id') - self.assertFalse(authorized) - - def test_authorize_lti_launch_when_not_null(self): - """ - Given a library WITH an lti tool set - When authorize_lti_launch is called with different issuers - Then return False - """ - issuer = 'http://a-fake-issuer' - client_id = 'a-fake-client-id' - library = self._create_library() - library.authorized_lti_configs.add(LtiTool.objects.create( - issuer=issuer, - client_id=client_id, - tool_key=LtiToolKey.objects.create() - )) - authorized = ContentLibrary.authorize_lti_launch( - library.library_key, - issuer='http://another-fake-issuer', - client_id='another-fake-client-id') - self.assertFalse(authorized) - - def test_authorize_lti_launch_when_not_null_and_inactive(self): - """ - Given a library WITH an lti tool set - When authorize_lti_launch is called with the same issuers - And lti tool is inactive - Then return False - """ - issuer = 'http://a-fake-issuer' - client_id = 'a-fake-client-id' - library = self._create_library() - library.authorized_lti_configs.add(LtiTool.objects.create( - issuer=issuer, - client_id=client_id, - is_active=False, - tool_key=LtiToolKey.objects.create() - )) - authorized = ContentLibrary.authorize_lti_launch( - library.library_key, - issuer='http://another-fake-issuer', - client_id='another-fake-client-id') - self.assertFalse(authorized) - - def test_authorize_lti_launch_when_not_null_and_active(self): - """ - Given a library WITH an lti tool set - When authorize_lti_launch is called with the same issuers - And lti tool is active - Then return True - """ - issuer = 'http://a-fake-issuer' - client_id = 'a-fake-client-id' - library = self._create_library() - library.authorized_lti_configs.add(LtiTool.objects.create( - issuer=issuer, - client_id=client_id, - is_active=True, # redudant since it defaults to True - tool_key=LtiToolKey.objects.create() - )) - authorized = ContentLibrary.authorize_lti_launch( - library.library_key, - issuer=issuer, - client_id=client_id) - self.assertTrue(authorized) - - -class LtiProfileTest(TestCase): - """ - LtiProfile model tests. - """ - - def test_get_from_claims_doesnotexists(self): - with self.assertRaises(LtiProfile.DoesNotExist): - LtiProfile.objects.get_from_claims(iss='iss', aud='aud', sub='sub') - - def test_get_from_claims_exists(self): - """ - Given a LtiProfile with iss and sub, - When get_from_claims() - Then return the same object. - """ - - iss = 'http://foo.example.com/' - sub = 'randomly-selected-sub-for-testing' - aud = 'randomly-selected-aud-for-testing' - profile = LtiProfile.objects.create( - platform_id=iss, - client_id=aud, - subject_id=sub) - - queried_profile = LtiProfile.objects.get_from_claims( - iss=iss, aud=aud, sub=sub) - - self.assertEqual( - queried_profile, - profile, - 'The queried profile is equal to the profile created.') - - def test_subject_url(self): - """ - Given a profile - Then has a valid subject_url. - """ - iss = 'http://foo.example.com' - sub = 'randomly-selected-sub-for-testing' - aud = 'randomly-selected-aud-for-testing' - expected_url = 'http://foo.example.com/randomly-selected-aud-for-testing/randomly-selected-sub-for-testing' - profile = LtiProfile.objects.create( - platform_id=iss, - client_id=aud, - subject_id=sub) - self.assertEqual(expected_url, profile.subject_url) - - def test_create_with_user(self): - """ - Given a profile without a user - When save is called - Then a user is created. - """ - - iss = 'http://foo.example.com/' - sub = 'randomly-selected-sub-for-testing' - aud = 'randomly-selected-aud-for-testing' - profile = LtiProfile.objects.create( - platform_id=iss, - client_id=aud, - subject_id=sub) - self.assertIsNotNone(profile.user) - self.assertTrue( - profile.user.username.startswith('urn:openedx:content_libraries:username:')) - - def test_get_or_create_from_claims(self): - """ - Given a profile does not exist - When get or create - And get or create again - Then the same profile is returned. - """ - iss = 'http://foo.example.com/' - sub = 'randomly-selected-sub-for-testing' - aud = 'randomly-selected-aud-for-testing' - self.assertFalse(LtiProfile.objects.exists()) - profile = LtiProfile.objects.get_or_create_from_claims(iss=iss, aud=aud, sub=sub) - self.assertIsNotNone(profile.user) - self.assertEqual(iss, profile.platform_id) - self.assertEqual(sub, profile.subject_id) - - profile_two = LtiProfile.objects.get_or_create_from_claims(iss=iss, aud=aud, sub=sub) - self.assertEqual(profile_two, profile) - - def test_get_or_create_from_claims_twice(self): - """ - Given a profile - When another profile is created - Then success - """ - iss = 'http://foo.example.com/' - aud = 'randomly-selected-aud-for-testing' - sub_one = 'randomly-selected-sub-for-testing' - sub_two = 'another-randomly-sub-for-testing' - self.assertFalse(LtiProfile.objects.exists()) - LtiProfile.objects.get_or_create_from_claims(iss=iss, aud=aud, sub=sub_one) - LtiProfile.objects.get_or_create_from_claims(iss=iss, aud=aud, sub=sub_two) - - -class LtiResourceTest(TestCase): - """ - LtiGradedResource model tests. - """ - - iss = 'fake-iss-for-test' - - sub = 'fake-sub-for-test' - - aud = 'fake-aud-for-test' - - def setUp(self): - super().setUp() - self.request_factory = RequestFactory() - - def test_get_from_user_id_when_no_user_then_not_found(self): - user_id = 0 - with self.assertRaises(LtiGradedResource.DoesNotExist): - LtiGradedResource.objects.get_from_user_id(user_id) - - def test_get_from_user_id_when_no_profile_then_not_found(self): - user = get_user_model().objects.create(username='foobar') - with self.assertRaises(LtiGradedResource.DoesNotExist): - LtiGradedResource.objects.get_from_user_id(user.pk) - - def test_get_from_user_id_when_profile_then_found(self): - profile = LtiProfile.objects.get_or_create_from_claims( - iss=self.iss, aud=self.aud, sub=self.sub) - LtiGradedResource.objects.create(profile=profile) - resource = LtiGradedResource.objects.get_from_user_id(profile.user.pk) - self.assertEqual(profile, resource.profile) - - def test_upsert_from_ags_launch(self): - """ - Give no graded resource - When get_or_create_from_launch twice - Then created at first, retrieved at second. - """ - - resource_id = 'resource-foobar' - usage_key = 'lb:foo:bar:fooz:barz' - lineitem = 'http://canvas.docker/api/lti/courses/1/line_items/7' - resource_endpoint = { - "lineitem": lineitem, - "scope": [ - "https://purl.imsglobal.org/spec/lti-ags/scope/lineitem", - "https://purl.imsglobal.org/spec/lti-ags/scope/score" - ], - } - resource_link = { - "id": resource_id, - "title": "A custom title", - } - - profile = LtiProfile.objects.get_or_create_from_claims( - iss=self.iss, aud=self.aud, sub=self.sub) - block_mock = mock.Mock() - block_mock.scope_ids.usage_id = LibraryUsageLocatorV2.from_string(usage_key) - res = LtiGradedResource.objects.upsert_from_ags_launch( - profile.user, block_mock, resource_endpoint, resource_link) - - self.assertEqual(resource_id, res.resource_id) - self.assertEqual(lineitem, res.ags_lineitem) - self.assertEqual(usage_key, str(res.usage_key)) - self.assertEqual(profile, res.profile) - - res2 = LtiGradedResource.objects.upsert_from_ags_launch( - profile.user, block_mock, resource_endpoint, resource_link) - - self.assertEqual(res, res2) diff --git a/openedx/core/djangoapps/content_libraries/tests/test_runtime.py b/openedx/core/djangoapps/content_libraries/tests/test_runtime.py index 97699dbf8d6b..b67b21498166 100644 --- a/openedx/core/djangoapps/content_libraries/tests/test_runtime.py +++ b/openedx/core/djangoapps/content_libraries/tests/test_runtime.py @@ -1,33 +1,33 @@ """ -Test the Learning-Core-based XBlock runtime and content libraries together. +Test the openedx_content-based XBlock runtime and content libraries together. """ import json +import django.utils.translation from completion.test_utils import CompletionWaffleTestMixin from django.db import connections, transaction from django.test import TestCase, override_settings from django.utils.text import slugify -import django.utils.translation from organizations.models import Organization from rest_framework.test import APIClient from xblock.core import XBlock +from common.djangoapps.student.tests.factories import UserFactory +from common.test.utils import assert_dict_contains_subset from lms.djangoapps.courseware.model_data import get_score from openedx.core.djangoapps.content_libraries import api as library_api +from openedx.core.djangoapps.content_libraries.constants import ALL_RIGHTS_RESERVED from openedx.core.djangoapps.content_libraries.tests.base import ( - URL_BLOCK_RENDER_VIEW, + URL_BLOCK_FIELDS_URL, URL_BLOCK_GET_HANDLER_URL, URL_BLOCK_METADATA_URL, - URL_BLOCK_FIELDS_URL, + URL_BLOCK_RENDER_VIEW, ) from openedx.core.djangoapps.content_libraries.tests.user_state_block import UserStateTestBlock -from openedx.core.djangoapps.content_libraries.constants import ALL_RIGHTS_RESERVED from openedx.core.djangoapps.dark_lang.models import DarkLangConfig from openedx.core.djangoapps.xblock import api as xblock_api -from openedx.core.djangolib.testing.utils import skip_unless_lms, skip_unless_cms +from openedx.core.djangolib.testing.utils import skip_unless_cms, skip_unless_lms from openedx.core.lib.xblock_serializer import api as serializer_api -from common.djangoapps.student.tests.factories import UserFactory -from common.test.utils import assert_dict_contains_subset class ContentLibraryContentTestMixin: @@ -64,7 +64,7 @@ def setUp(self): @skip_unless_cms class ContentLibraryOlxTests(ContentLibraryContentTestMixin, TestCase): """ - Basic test of the Learning-Core-based XBlock serialization-deserialization, using XBlocks in a content library. + Basic test of the openedx_content-based XBlock serialization-deserialization, using XBlocks in a content library. """ def test_html_round_trip(self): @@ -116,7 +116,7 @@ def test_html_round_trip(self): f'\n' ) - # Save the block to LC, and re-load it. + # Save the block to openedx_content, and re-load it. library_api.set_library_block_olx(usage_key, olx_1) library_api.publish_changes(self.library.key) block_saved_1 = xblock_api.load_block(usage_key, self.staff_user) @@ -131,7 +131,7 @@ def test_html_round_trip(self): ).olx_str assert olx_2 == canonical_olx - # Now, save that OLX back to LC, and re-load it again. + # Now, save that OLX back to openedx_content, and re-load it again. library_api.set_library_block_olx(usage_key, olx_2) library_api.publish_changes(self.library.key) block_saved_2 = xblock_api.load_block(usage_key, self.staff_user) @@ -149,7 +149,7 @@ def test_html_round_trip(self): class ContentLibraryRuntimeTests(ContentLibraryContentTestMixin, TestCase): """ - Basic tests of the Learning-Core-based XBlock runtime using XBlocks in a + Basic tests of the openedx_content-based XBlock runtime using XBlocks in a content library. """ def test_dndv2_sets_translator(self): @@ -180,7 +180,7 @@ def test_xblock_metadata(self):

          This is a normal capa problem. It has "maximum attempts" set to **5**.

          - + XBlock metadata only XBlock data/metadata and associated static asset files @@ -471,7 +471,7 @@ def test_scores_persisted(self):

          This is a normal capa problem. It has "maximum attempts" set to **5**.

          - + XBlock metadata only XBlock data/metadata and associated static asset files @@ -543,7 +543,7 @@ def test_i18n(self):

          This is a normal capa problem. It has "maximum attempts" set to **5**.

          - + XBlock metadata only XBlock data/metadata and associated static asset files diff --git a/openedx/core/djangoapps/content_libraries/tests/test_static_assets.py b/openedx/core/djangoapps/content_libraries/tests/test_static_assets.py index 91d9556b01f1..a964705b486e 100644 --- a/openedx/core/djangoapps/content_libraries/tests/test_static_assets.py +++ b/openedx/core/djangoapps/content_libraries/tests/test_static_assets.py @@ -1,14 +1,13 @@ """ -Tests for static asset files in Learning-Core-based Content Libraries +Tests for static asset files in openedx_content-based Content Libraries """ from uuid import UUID +from django.test.utils import override_settings from opaque_keys.edx.keys import UsageKey from common.djangoapps.student.tests.factories import UserFactory -from openedx.core.djangoapps.content_libraries.tests.base import ( - ContentLibrariesRestApiTest, -) +from openedx.core.djangoapps.content_libraries.tests.base import ContentLibrariesRestApiTest from openedx.core.djangoapps.xblock.api import get_component_from_usage_key from openedx.core.djangolib.testing.utils import skip_unless_cms @@ -31,7 +30,7 @@ @skip_unless_cms class ContentLibrariesStaticAssetsTest(ContentLibrariesRestApiTest): """ - Tests for static asset files in Learning-Core-based Content Libraries + Tests for static asset files in openedx_content-based Content Libraries """ def test_asset_filenames(self): @@ -72,7 +71,7 @@ def test_asset_filenames(self): def test_video_transcripts(self): """ - Test that video blocks can read transcript files out of learning core. + Test that video blocks can read transcript files out of openedx_content. """ library = self._create_library(slug="transcript-test-lib", title="Transcripts Test Library") block = self._add_block_to_library(library["id"], "video", "video1") @@ -111,12 +110,13 @@ def check_download(): check_sjson() check_download() # Publish the OLX and the transcript file, since published data gets - # served differently by Learning Core and we should test that too. + # served differently by openedx_content and we should test that too. self._commit_library_changes(library["id"]) check_sjson() check_download() +@override_settings(CORS_ORIGIN_WHITELIST=["https://example.com/", "https://example2.com/"]) @skip_unless_cms class ContentLibrariesComponentVersionAssetTest(ContentLibrariesRestApiTest): """ @@ -146,6 +146,11 @@ def test_good_responses(self): f"/library_assets/component_versions/{self.draft_component_version.uuid}/static/test.svg" ) assert good_head_response.headers == get_response.headers + assert "Content-Security-Policy" in get_response.headers + assert get_response.headers["Content-Security-Policy"] == ( + "frame-ancestors 'self' https://example.com/ https://example2.com/;" + ) + def test_missing(self): """Test asset requests that should 404.""" @@ -162,7 +167,7 @@ def test_missing(self): ) assert response.status_code == 404 - # File-like ComponenVersionContent entry that isn't an actually + # File-like ComponentVersionMedia entry that isn't an actually # downloadable file... response = self.client.get( f"/library_assets/component_versions/{self.draft_component_version.uuid}/block.xml" diff --git a/openedx/core/djangoapps/content_libraries/tests/test_tasks.py b/openedx/core/djangoapps/content_libraries/tests/test_tasks.py index a200471c00bd..439b4fe9aa4e 100644 --- a/openedx/core/djangoapps/content_libraries/tests/test_tasks.py +++ b/openedx/core/djangoapps/content_libraries/tests/test_tasks.py @@ -4,11 +4,12 @@ from unittest import mock from django.test import override_settings -from ..models import ContentLibrary -from .base import ContentLibrariesRestApiTest +from user_tasks.models import UserTaskArtifact from openedx.core.djangoapps.content_libraries.tasks import backup_library -from user_tasks.models import UserTaskArtifact + +from ..models import ContentLibrary +from .base import ContentLibrariesRestApiTest class ContentLibraryBackupTaskTest(ContentLibrariesRestApiTest): diff --git a/openedx/core/djangoapps/content_libraries/tests/test_versioned_apis.py b/openedx/core/djangoapps/content_libraries/tests/test_versioned_apis.py index 20d0b38f0b7c..29498104b536 100644 --- a/openedx/core/djangoapps/content_libraries/tests/test_versioned_apis.py +++ b/openedx/core/djangoapps/content_libraries/tests/test_versioned_apis.py @@ -4,10 +4,9 @@ from django.test.utils import override_settings from xblock.core import XBlock -from openedx.core.djangoapps.content_libraries.tests.base import ( - ContentLibrariesRestApiTest -) +from openedx.core.djangoapps.content_libraries.tests.base import ContentLibrariesRestApiTest from openedx.core.djangolib.testing.utils import skip_unless_cms + from .fields_test_block import FieldsTestBlock diff --git a/openedx/core/djangoapps/content_libraries/tests/test_views_collections.py b/openedx/core/djangoapps/content_libraries/tests/test_views_collections.py index ce9b0e880dee..9f8e5dc1cde3 100644 --- a/openedx/core/djangoapps/content_libraries/tests/test_views_collections.py +++ b/openedx/core/djangoapps/content_libraries/tests/test_views_collections.py @@ -3,16 +3,16 @@ """ from __future__ import annotations -import ddt -from openedx_learning.api.authoring_models import Collection +import ddt from opaque_keys.edx.locator import LibraryLocatorV2 +from openedx_content.models_api import Collection -from openedx.core.djangolib.testing.utils import skip_unless_cms +from common.djangoapps.student.tests.factories import UserFactory from openedx.core.djangoapps.content_libraries import api -from openedx.core.djangoapps.content_libraries.tests.base import ContentLibrariesRestApiTest from openedx.core.djangoapps.content_libraries.models import ContentLibrary -from common.djangoapps.student.tests.factories import UserFactory +from openedx.core.djangoapps.content_libraries.tests.base import ContentLibrariesRestApiTest +from openedx.core.djangolib.testing.utils import skip_unless_cms URL_PREFIX = '/api/libraries/v2/{lib_key}/' URL_LIB_COLLECTIONS = URL_PREFIX + 'collections/' @@ -88,7 +88,7 @@ def test_get_library_collection(self): Test retrieving a Content Library Collection """ resp = self.client.get( - URL_LIB_COLLECTION.format(lib_key=self.lib2.library_key, collection_key=self.col3.key) + URL_LIB_COLLECTION.format(lib_key=self.lib2.library_key, collection_key=self.col3.collection_code) ) # Check that correct Content Library Collection data retrieved @@ -103,7 +103,7 @@ def test_get_library_collection(self): random_user = UserFactory.create(username="Random", email="random@example.com") with self.as_user(random_user): resp = self.client.get( - URL_LIB_COLLECTION.format(lib_key=self.lib2.library_key, collection_key=self.col3.key) + URL_LIB_COLLECTION.format(lib_key=self.lib2.library_key, collection_key=self.col3.collection_code) ) assert resp.status_code == 403 @@ -113,7 +113,7 @@ def test_get_invalid_library_collection(self): """ # Fetch collection that belongs to a different library, it should fail resp = self.client.get( - URL_LIB_COLLECTION.format(lib_key=self.lib1.library_key, collection_key=self.col3.key) + URL_LIB_COLLECTION.format(lib_key=self.lib1.library_key, collection_key=self.col3.collection_code) ) assert resp.status_code == 404 @@ -144,7 +144,7 @@ def test_list_library_collections(self): {"key": "COL1", "title": "Collection 1", "description": "Description for Collection 1"}, {"key": "COL2", "title": "Collection 2", "description": "Description for Collection 2"}, ] - for collection, expected in zip(resp.data["results"], expected_collections): + for collection, expected in zip(resp.data["results"], expected_collections): # noqa: B905 self.assertDictContainsEntries(collection, expected) # Check that a random user without permissions cannot access Content Library Collections @@ -183,7 +183,7 @@ def test_create_library_collection(self): self.assertDictContainsEntries(resp.data, post_data) created_collection = Collection.objects.get(id=resp.data["id"]) - self.assertIsNotNone(created_collection) + self.assertIsNotNone(created_collection) # noqa: PT009 # Check that user with read only access cannot create new Content Library Collection reader = UserFactory.create(username="Reader", email="reader@example.com") @@ -247,9 +247,9 @@ def test_create_invalid_library_collection(self): assert resp.status_code == 400 - # Create collection with an existing collection.key; it should fail + # Create collection with an existing collection.collection_code; it should fail post_data_existing_key = { - "key": self.col1.key, + "key": self.col1.collection_code, "title": "Collection 4", } resp = self.client.post( @@ -275,7 +275,7 @@ def test_update_library_collection(self): "title": "Collection 3 Updated", } resp = self.client.patch( - URL_LIB_COLLECTION.format(lib_key=self.lib2.library_key, collection_key=self.col3.key), + URL_LIB_COLLECTION.format(lib_key=self.lib2.library_key, collection_key=self.col3.collection_code), patch_data, format="json" ) @@ -285,8 +285,8 @@ def test_update_library_collection(self): self.assertDictContainsEntries(resp.data, patch_data) created_collection = Collection.objects.get(id=resp.data["id"]) - self.assertIsNotNone(created_collection) - self.assertEqual(created_collection.title, patch_data["title"]) + self.assertIsNotNone(created_collection) # noqa: PT009 + self.assertEqual(created_collection.title, patch_data["title"]) # noqa: PT009 # Check that user with read only access cannot update a Content Library Collection reader = UserFactory.create(username="Reader", email="reader@example.com") @@ -297,7 +297,7 @@ def test_update_library_collection(self): "title": "Collection 3 should not update", } resp = self.client.patch( - URL_LIB_COLLECTION.format(lib_key=self.lib2.library_key, collection_key=self.col3.key), + URL_LIB_COLLECTION.format(lib_key=self.lib2.library_key, collection_key=self.col3.collection_code), patch_data, format="json" ) @@ -313,7 +313,7 @@ def test_update_invalid_library_collection(self): } # Update collection that belongs to a different library, it should fail resp = self.client.patch( - URL_LIB_COLLECTION.format(lib_key=self.lib1.library_key, collection_key=self.col3.key), + URL_LIB_COLLECTION.format(lib_key=self.lib1.library_key, collection_key=self.col3.collection_code), patch_data, format="json" ) @@ -331,7 +331,7 @@ def test_update_invalid_library_collection(self): # Update collection with invalid library_key provided, it should fail resp = self.client.patch( - URL_LIB_COLLECTION.format(lib_key=123, collection_key=self.col3.key), + URL_LIB_COLLECTION.format(lib_key=123, collection_key=self.col3.collection_code), patch_data, format="json" ) @@ -342,22 +342,22 @@ def test_delete_library_collection(self): Test soft-deleting and restoring a Content Library Collection """ resp = self.client.delete( - URL_LIB_COLLECTION.format(lib_key=self.lib2.library_key, collection_key=self.col3.key) + URL_LIB_COLLECTION.format(lib_key=self.lib2.library_key, collection_key=self.col3.collection_code) ) assert resp.status_code == 204 resp = self.client.get( - URL_LIB_COLLECTION.format(lib_key=self.lib2.library_key, collection_key=self.col3.key) + URL_LIB_COLLECTION.format(lib_key=self.lib2.library_key, collection_key=self.col3.collection_code) ) assert resp.status_code == 404 resp = self.client.post( - URL_LIB_COLLECTION_RESTORE.format(lib_key=self.lib2.library_key, collection_key=self.col3.key) + URL_LIB_COLLECTION_RESTORE.format(lib_key=self.lib2.library_key, collection_key=self.col3.collection_code) ) assert resp.status_code == 204 resp = self.client.get( - URL_LIB_COLLECTION.format(lib_key=self.lib2.library_key, collection_key=self.col3.key) + URL_LIB_COLLECTION.format(lib_key=self.lib2.library_key, collection_key=self.col3.collection_code) ) # Check that correct Content Library Collection data retrieved expected_collection = { @@ -375,7 +375,7 @@ def test_get_components(self): resp = self.client.get( URL_LIB_COLLECTION_COMPONENTS.format( lib_key=self.lib1.library_key, - collection_key=self.col1.key, + collection_key=self.col1.collection_code, ), ) assert resp.status_code == 405 @@ -388,7 +388,7 @@ def test_update_components(self): resp = self.client.patch( URL_LIB_COLLECTION_COMPONENTS.format( lib_key=self.lib1.library_key, - collection_key=self.col1.key, + collection_key=self.col1.collection_code, ), data={ "usage_keys": [ @@ -404,7 +404,7 @@ def test_update_components(self): resp = self.client.delete( URL_LIB_COLLECTION_COMPONENTS.format( lib_key=self.lib1.library_key, - collection_key=self.col1.key, + collection_key=self.col1.collection_code, ), data={ "usage_keys": [ @@ -423,7 +423,7 @@ def test_update_containers(self): resp = self.client.patch( URL_LIB_COLLECTION_COMPONENTS.format( lib_key=self.lib1.library_key, - collection_key=self.col1.key, + collection_key=self.col1.collection_code, ), data={ "usage_keys": [ @@ -440,7 +440,7 @@ def test_update_containers(self): resp = self.client.delete( URL_LIB_COLLECTION_COMPONENTS.format( lib_key=self.lib1.library_key, - collection_key=self.col1.key, + collection_key=self.col1.collection_code, ), data={ "usage_keys": [ @@ -460,7 +460,7 @@ def test_update_components_wrong_collection(self, method): resp = getattr(self.client, method)( URL_LIB_COLLECTION_COMPONENTS.format( lib_key=self.lib2.library_key, - collection_key=self.col1.key, + collection_key=self.col1.collection_code, ), data={ "usage_keys": [ @@ -478,7 +478,7 @@ def test_update_components_missing_data(self, method): resp = getattr(self.client, method)( URL_LIB_COLLECTION_COMPONENTS.format( lib_key=self.lib2.library_key, - collection_key=self.col3.key, + collection_key=self.col3.collection_code, ), ) assert resp.status_code == 400 @@ -494,7 +494,7 @@ def test_update_components_from_another_library(self, method): resp = getattr(self.client, method)( URL_LIB_COLLECTION_COMPONENTS.format( lib_key=self.lib2.library_key, - collection_key=self.col3.key, + collection_key=self.col3.collection_code, ), data={ "usage_keys": [ @@ -515,7 +515,7 @@ def test_update_components_permissions(self, method): resp = getattr(self.client, method)( URL_LIB_COLLECTION_COMPONENTS.format( lib_key=self.lib1.library_key, - collection_key=self.col1.key, + collection_key=self.col1.collection_code, ), ) assert resp.status_code == 403 diff --git a/openedx/core/djangoapps/content_libraries/tests/test_views_lti.py b/openedx/core/djangoapps/content_libraries/tests/test_views_lti.py deleted file mode 100644 index b1ee61ca50f9..000000000000 --- a/openedx/core/djangoapps/content_libraries/tests/test_views_lti.py +++ /dev/null @@ -1,89 +0,0 @@ -""" -Tests for LTI views. -""" - -from django.conf import settings -from django.test import TestCase, override_settings - -from .base import ( - ContentLibrariesRestApiTest, - URL_LIB_LTI_JWKS, - skip_unless_cms, -) - - -def override_features(**kwargs): - """ - Wrapps ``override_settings`` to override ``settings.FEATURES``. - """ - return override_settings(FEATURES={**settings.FEATURES, **kwargs}) - - -@skip_unless_cms -class LtiToolJwksViewTest(TestCase): - """ - Test JWKS view. - """ - - def test_when_lti_disabled_return_404(self): - """ - Given LTI toggle is disabled - When JWKS requested - Then return 404 - """ - response = self.client.get(URL_LIB_LTI_JWKS) - self.assertEqual(response.status_code, 404) - - @override_features(ENABLE_CONTENT_LIBRARIES=True, - ENABLE_CONTENT_LIBRARIES_LTI_TOOL=True) - def test_when_no_keys_then_return_empty(self): - """ - Given no LTI tool in the database. - When JWKS requested. - Then return empty - """ - response = self.client.get(URL_LIB_LTI_JWKS) - self.assertEqual(response.status_code, 200) - self.assertJSONEqual(response.content, '{"keys": []}') - - -class LibraryBlockLtiUrlViewTestMixin: - """ - Test generating LTI URL for a block in a library. - """ - - def test_lti_url_generation(self): - """ - Test the LTI URL generated from the block ID. - """ - - library = self._create_library( - slug="libgg", title="A Test Library", description="Testing library", - ) - - block = self._add_block_to_library(library['id'], 'problem', 'problem') - usage_key = str(block['id']) - - url = f'/api/libraries/v2/blocks/{usage_key}/lti/' - expected_lti_url = f"/api/libraries/v2/lti/1.3/launch/?id={usage_key}" - - response = self._api("get", url, None, expect_response=200) - - self.assertDictEqual(response, {"lti_url": expected_lti_url}) - - def test_block_not_found(self): - """ - Test the LTI URL cannot be generated as the block not found. - """ - self._api("get", '/api/libraries/v2/blocks/lb:CL-TEST:libgg:problem:bad-block/lti/', None, expect_response=404) - - -@override_features(ENABLE_CONTENT_LIBRARIES=True, - ENABLE_CONTENT_LIBRARIES_LTI_TOOL=True) -class LibraryBlockLtiUrlViewTest( - LibraryBlockLtiUrlViewTestMixin, - ContentLibrariesRestApiTest, -): - """ - Test generating LTI URL for a block in a library, using the installed Learning Core app. - """ diff --git a/openedx/core/djangoapps/content_libraries/tests/user_state_block.py b/openedx/core/djangoapps/content_libraries/tests/user_state_block.py index 16329a18ca65..488ecf984353 100644 --- a/openedx/core/djangoapps/content_libraries/tests/user_state_block.py +++ b/openedx/core/djangoapps/content_libraries/tests/user_state_block.py @@ -5,8 +5,8 @@ import json from webob import Response -from xblock.core import XBlock, Scope from xblock import fields +from xblock.core import Scope, XBlock class UserStateTestBlock(XBlock): diff --git a/openedx/core/djangoapps/content_libraries/urls.py b/openedx/core/djangoapps/content_libraries/urls.py index 9dc12e943156..8fabe7d96cca 100644 --- a/openedx/core/djangoapps/content_libraries/urls.py +++ b/openedx/core/djangoapps/content_libraries/urls.py @@ -2,7 +2,7 @@ URL configuration for Studio's Content Libraries REST API """ -from django.urls import include, path, re_path, register_converter +from django.urls import include, path, register_converter from rest_framework import routers from .rest_api import blocks, collections, containers, libraries, url_converters @@ -15,11 +15,6 @@ register_converter(url_converters.LibraryContainerLocatorConverter, "lib_container_key") -# Router for importing blocks from courseware. - -import_blocks_router = routers.DefaultRouter() -import_blocks_router.register(r'tasks', libraries.LibraryImportTaskViewSet, basename='import-block-task') - library_collections_router = routers.DefaultRouter() library_collections_router.register( r'collections', collections.LibraryCollectionsView, basename="library-collections" @@ -51,8 +46,8 @@ path('team/user//', libraries.LibraryTeamUserView.as_view()), # Add/Edit (PUT) or remove (DELETE) a group's permission to use this library path('team/group//', libraries.LibraryTeamGroupView.as_view()), - # Import blocks into this library. - path('import_blocks/', include(import_blocks_router.urls)), + # Get draft change entries for a specific publish event (component or container) + path('publish_history_entries/', blocks.LibraryPublishHistoryEntriesView.as_view()), # Paste contents of clipboard into library path('paste_clipboard/', libraries.LibraryPasteClipboardView.as_view()), # Start a backup task for this library @@ -69,14 +64,18 @@ path('collections/', blocks.LibraryBlockCollectionsView.as_view(), name='update-collections'), # Get the full hierarchy that the block belongs to path('hierarchy/', blocks.LibraryBlockHierarchy.as_view()), - # Get the LTI URL of a specific XBlock - path('lti/', blocks.LibraryBlockLtiUrlView.as_view(), name='lti-url'), # Get the OLX source code of the specified block: path('olx/', blocks.LibraryBlockOlxView.as_view()), # CRUD for static asset files associated with a block in the library: path('assets/', blocks.LibraryBlockAssetListView.as_view()), path('assets/', blocks.LibraryBlockAssetView.as_view()), path('publish/', blocks.LibraryBlockPublishView.as_view()), + # Get the draft change history for this block + path('draft_history/', blocks.LibraryComponentDraftHistoryView.as_view()), + # Get the publish history for this block (list of publish events) + path('publish_history/', blocks.LibraryComponentPublishHistoryView.as_view()), + # Get the creation entry for this block + path('creation_entry/', blocks.LibraryComponentCreationEntryView.as_view()), # Future: discard changes for just this one block ])), # Containers are Sections, Subsections, and Units @@ -94,11 +93,12 @@ # Publish a container (or reset to last published) path('publish/', containers.LibraryContainerPublishView.as_view()), path('copy/', containers.LibraryContainerCopyView.as_view()), - ])), - re_path(r'^lti/1.3/', include([ - path('login/', libraries.LtiToolLoginView.as_view(), name='lti-login'), - path('launch/', libraries.LtiToolLaunchView.as_view(), name='lti-launch'), - path('pub/jwks/', libraries.LtiToolJwksView.as_view(), name='lti-pub-jwks'), + # Get the draft change history for this container + path('draft_history/', containers.LibraryContainerDraftHistoryView.as_view()), + # Get the publish history for this container (list of publish events) + path('publish_history/', containers.LibraryContainerPublishHistoryView.as_view()), + # Get the creation entry for this container + path('creation_entry/', containers.LibraryContainerCreationEntryView.as_view()), ])), ])), path('library_assets/', include([ diff --git a/openedx/core/djangoapps/content_staging/README.rst b/openedx/core/djangoapps/content_staging/README.rst index 71c43c4bffab..5960ee6a1f25 100644 --- a/openedx/core/djangoapps/content_staging/README.rst +++ b/openedx/core/djangoapps/content_staging/README.rst @@ -17,7 +17,7 @@ As this app is designed only for ephemeral use cases, API consumers should not expect that staged content will be stored for longer than 24 hours. This app is part of the CMS and is not intended to work with the LMS. It may be -moved from the CMS into the future Learning Core project. +moved from the CMS into the future openedx_content project. --------------- Clipboard Usage diff --git a/openedx/core/djangoapps/content_staging/admin.py b/openedx/core/djangoapps/content_staging/admin.py index 2ae6b92ce0e5..c7a8a99d2195 100644 --- a/openedx/core/djangoapps/content_staging/admin.py +++ b/openedx/core/djangoapps/content_staging/admin.py @@ -4,6 +4,7 @@ from django.contrib import admin from django.urls import reverse from django.utils.html import format_html + from .models import StagedContent, StagedContentFile, UserClipboard diff --git a/openedx/core/djangoapps/content_staging/api.py b/openedx/core/djangoapps/content_staging/api.py index b73d550ed8cb..1700f2358739 100644 --- a/openedx/core/djangoapps/content_staging/api.py +++ b/openedx/core/djangoapps/content_staging/api.py @@ -10,7 +10,7 @@ from django.db import transaction from django.http import HttpRequest from opaque_keys import InvalidKeyError -from opaque_keys.edx.keys import AssetKey, UsageKey, ContainerKey +from opaque_keys.edx.keys import AssetKey, ContainerKey, UsageKey from xblock.core import XBlock from openedx.core.djangoapps.content_tagging.api import TagValuesByObjectIdDict @@ -23,17 +23,14 @@ CLIPBOARD_PURPOSE, StagedContentData, StagedContentFileData, + StagedContentID, StagedContentStatus, UserClipboardData, ) -from .models import ( - UserClipboard as _UserClipboard, - StagedContent as _StagedContent, - StagedContentFile as _StagedContentFile, -) -from .serializers import ( - UserClipboardSerializer as _UserClipboardSerializer, -) +from .models import StagedContent as _StagedContent +from .models import StagedContentFile as _StagedContentFile +from .models import UserClipboard as _UserClipboard +from .serializers import UserClipboardSerializer as _UserClipboardSerializer from .tasks import delete_expired_clipboards log = logging.getLogger(__name__) @@ -325,26 +322,26 @@ def _user_clipboard_model_to_data(clipboard: _UserClipboard) -> UserClipboardDat ) -def get_staged_content_olx(staged_content_id: int) -> str | None: +def get_staged_content_olx(staged_content_id: StagedContentID) -> str | None: """ Get the OLX (as a string) for the given StagedContent. Does not check permissions! """ try: - sc = _StagedContent.objects.get(pk=staged_content_id) + sc = _StagedContent.objects.get(id=staged_content_id) return sc.olx except _StagedContent.DoesNotExist: return None -def get_staged_content_static_files(staged_content_id: int) -> list[StagedContentFileData]: +def get_staged_content_static_files(staged_content_id: StagedContentID) -> list[StagedContentFileData]: """ Get the filenames and metadata for any static files used by the given staged content. Does not check permissions! """ - sc = _StagedContent.objects.get(pk=staged_content_id) + sc = _StagedContent.objects.get(id=staged_content_id) def str_to_key(source_key_str: str): if not source_key_str: @@ -370,13 +367,13 @@ def str_to_key(source_key_str: str): ] -def get_staged_content_static_file_data(staged_content_id: int, filename: str) -> bytes | None: +def get_staged_content_static_file_data(staged_content_id: StagedContentID, filename: str) -> bytes | None: """ Get the data for the static asset associated with the given staged content. Does not check permissions! """ - sc = _StagedContent.objects.get(pk=staged_content_id) + sc = _StagedContent.objects.get(id=staged_content_id) file_data_obj = sc.files.filter(filename=filename).first() if file_data_obj: return file_data_obj.data_file.open().read() diff --git a/openedx/core/djangoapps/content_staging/data.py b/openedx/core/djangoapps/content_staging/data.py index 95128c7f6870..47572058a332 100644 --- a/openedx/core/djangoapps/content_staging/data.py +++ b/openedx/core/djangoapps/content_staging/data.py @@ -2,15 +2,20 @@ Public python data types for content staging """ from __future__ import annotations -from attrs import field, frozen, validators + from datetime import datetime +from typing import NewType +from attrs import field, frozen, validators from django.db.models import TextChoices from django.utils.translation import gettext_lazy as _ -from opaque_keys.edx.keys import UsageKey, AssetKey, LearningContextKey, ContainerKey +from opaque_keys.edx.keys import AssetKey, ContainerKey, LearningContextKey, UsageKey from openedx.core.djangoapps.content_tagging.api import TagValuesByObjectIdDict +# Typed primary key for the StagedContent model / StagedContentData +StagedContentID = NewType("StagedContentID", int) + class StagedContentStatus(TextChoices): """ The status of this staged content. """ @@ -41,7 +46,7 @@ class StagedContentData: (OLX content that isn't part of any course at the moment) """ - id: int = field(validator=validators.instance_of(int)) + id: StagedContentID = field(validator=validators.instance_of(int)) # type: ignore[assignment] user_id: int = field(validator=validators.instance_of(int)) created: datetime = field(validator=validators.instance_of(datetime)) purpose: str = field(validator=validators.instance_of(str)) diff --git a/openedx/core/djangoapps/content_staging/migrations/0001_initial.py b/openedx/core/djangoapps/content_staging/migrations/0001_initial.py index fa777a60cccc..97e06c6200ec 100644 --- a/openedx/core/djangoapps/content_staging/migrations/0001_initial.py +++ b/openedx/core/djangoapps/content_staging/migrations/0001_initial.py @@ -1,9 +1,9 @@ # Generated by Django 3.2.18 on 2023-03-16 23:45 -from django.conf import settings -from django.db import migrations, models import django.db.models.deletion import opaque_keys.edx.django.models +from django.conf import settings +from django.db import migrations, models class Migration(migrations.Migration): diff --git a/openedx/core/djangoapps/content_staging/migrations/0002_stagedcontentfile.py b/openedx/core/djangoapps/content_staging/migrations/0002_stagedcontentfile.py index 5c3501ac0d9d..0215d14b64a1 100644 --- a/openedx/core/djangoapps/content_staging/migrations/0002_stagedcontentfile.py +++ b/openedx/core/djangoapps/content_staging/migrations/0002_stagedcontentfile.py @@ -1,7 +1,7 @@ # Generated by Django 3.2.19 on 2023-06-02 00:47 -from django.db import migrations, models import django.db.models.deletion +from django.db import migrations, models class Migration(migrations.Migration): diff --git a/openedx/core/djangoapps/content_staging/migrations/0003_olx_unicode.py b/openedx/core/djangoapps/content_staging/migrations/0003_olx_unicode.py index 1a1c414bf193..2c523a9b4636 100644 --- a/openedx/core/djangoapps/content_staging/migrations/0003_olx_unicode.py +++ b/openedx/core/djangoapps/content_staging/migrations/0003_olx_unicode.py @@ -1,7 +1,7 @@ # Generated by Django 3.2.23 on 2023-12-07 20:10 +import openedx_django_lib.fields from django.db import migrations -import openedx_learning.lib.fields class Migration(migrations.Migration): @@ -14,11 +14,11 @@ class Migration(migrations.Migration): migrations.AlterField( model_name='stagedcontent', name='display_name', - field=openedx_learning.lib.fields.MultiCollationCharField(db_collations={'mysql': 'utf8mb4_unicode_ci', 'sqlite': 'NOCASE'}, max_length=768), + field=openedx_django_lib.fields.MultiCollationCharField(db_collations={'mysql': 'utf8mb4_unicode_ci', 'sqlite': 'NOCASE'}, max_length=768), ), migrations.AlterField( model_name='stagedcontent', name='olx', - field=openedx_learning.lib.fields.MultiCollationTextField(db_collations={'mysql': 'utf8mb4_bin', 'sqlite': 'BINARY'}), + field=openedx_django_lib.fields.MultiCollationTextField(db_collations={'mysql': 'utf8mb4_bin', 'sqlite': 'BINARY'}), ), ] diff --git a/openedx/core/djangoapps/content_staging/models.py b/openedx/core/djangoapps/content_staging/models.py index 0e7426f2389c..d1a58b15744f 100644 --- a/openedx/core/djangoapps/content_staging/models.py +++ b/openedx/core/djangoapps/content_staging/models.py @@ -1,6 +1,7 @@ """ Models for content staging (and clipboard) """ + from __future__ import annotations import logging @@ -11,11 +12,11 @@ from django.utils.translation import gettext_lazy as _ from opaque_keys import InvalidKeyError from opaque_keys.edx.keys import ContainerKey, LearningContextKey, UsageKey -from openedx_learning.lib.fields import MultiCollationTextField, case_insensitive_char_field +from openedx_django_lib.fields import MultiCollationTextField, TypedAutoField, case_insensitive_char_field from openedx.core.djangoapps.content.course_overviews.api import get_course_overview_or_none -from .data import CLIPBOARD_PURPOSE, StagedContentStatus +from .data import CLIPBOARD_PURPOSE, StagedContentID, StagedContentStatus log = logging.getLogger(__name__) @@ -37,14 +38,21 @@ class StagedContent(models.Model): Use as a clipboard: for any given user, the most recent row with purpose=CLIPBOARD is the "current" clipboard content. But it can only be pasted if its status is READY. + + .. no_pii: """ class Meta: verbose_name_plural = _("Staged Content") - id = models.AutoField(primary_key=True) + type ID = StagedContentID + + class IDField(TypedAutoField[ID]): + pass + + id = IDField(primary_key=True) # The user that created and owns this staged content. Only this user can read it. - user = models.ForeignKey(User, null=False, on_delete=models.CASCADE) + user = models.ForeignKey(User, null=False, on_delete=models.CASCADE) # noqa: DJ012 created = models.DateTimeField(null=False, auto_now_add=True) # What this StagedContent is for (e.g. "clipboard" for clipboard) purpose = models.CharField(max_length=64) @@ -77,18 +85,20 @@ def olx_filename(self) -> str: """ Get a filename that can be used for the OLX content of this staged content """ return f"{self.suggested_url_name}.xml" - def __str__(self): + def __str__(self): # noqa: DJ012 """ String representation of this instance """ return f'Staged {self.block_type} block "{self.display_name}" ({self.status})' -class StagedContentFile(models.Model): +class StagedContentFile(models.Model): # noqa: DJ008 """ A data file ("Static Asset") associated with some StagedContent. These usually come from a course's Files & Uploads page, but can also come from per-xblock file storage (e.g. video transcripts or images used in v2 content libraries). + + .. no_pii: """ for_content = models.ForeignKey(StagedContent, on_delete=models.CASCADE, related_name="files") filename = models.CharField(max_length=255, blank=False) @@ -101,11 +111,13 @@ class StagedContentFile(models.Model): md5_hash = models.CharField(max_length=32, blank=True) -class UserClipboard(models.Model): +class UserClipboard(models.Model): # noqa: DJ008 """ Each user has a clipboard that can hold one item at a time, where an item is some OLX content that can be used in a course, such as an XBlock, a Unit, or a Subsection. + + .. no_pii: """ # The user that copied something. Clipboards are user-specific and # previously copied items are not kept. @@ -157,7 +169,7 @@ def clean(self): f"StagedContent.purpose must be '{CLIPBOARD_PURPOSE}' to use it as clipboard content." ) - def save(self, *args, **kwargs): + def save(self, *args, **kwargs): # noqa: DJ012 """ Save this model instance """ # Enforce checks on save: self.full_clean() diff --git a/openedx/core/djangoapps/content_staging/serializers.py b/openedx/core/djangoapps/content_staging/serializers.py index 753e040972c1..45b08ee99e1b 100644 --- a/openedx/core/djangoapps/content_staging/serializers.py +++ b/openedx/core/djangoapps/content_staging/serializers.py @@ -6,6 +6,7 @@ from common.djangoapps.student.auth import has_studio_read_access from xmodule.modulestore.django import modulestore from xmodule.modulestore.exceptions import ItemNotFoundError + from .models import StagedContent diff --git a/openedx/core/djangoapps/content_staging/tasks.py b/openedx/core/djangoapps/content_staging/tasks.py index 951a6f0a645d..d676ad6acbcc 100644 --- a/openedx/core/djangoapps/content_staging/tasks.py +++ b/openedx/core/djangoapps/content_staging/tasks.py @@ -2,6 +2,7 @@ Celery tasks for Content Staging. """ from __future__ import annotations # for list[int] type + import logging from celery import shared_task @@ -16,7 +17,7 @@ @shared_task(base=LoggedTask) @set_code_owner_attribute -def delete_expired_clipboards(staged_content_ids: list[int]): +def delete_expired_clipboards(staged_content_ids: list[StagedContent.ID]): """ A Celery task to delete StagedContent clipboard entries that are no longer relevant. diff --git a/openedx/core/djangoapps/content_staging/tests/test_clipboard.py b/openedx/core/djangoapps/content_staging/tests/test_clipboard.py index 5d332563a8f2..4c26f2c97cca 100644 --- a/openedx/core/djangoapps/content_staging/tests/test_clipboard.py +++ b/openedx/core/djangoapps/content_staging/tests/test_clipboard.py @@ -3,16 +3,16 @@ Tests for the clipboard functionality """ from textwrap import dedent +from typing import cast from xml.etree import ElementTree from rest_framework.test import APIClient + +from openedx.core.djangoapps.content_staging import api as python_api from xmodule.contentstore.django import contentstore from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase, upload_file_to_course from xmodule.modulestore.tests.factories import BlockFactory, CourseFactory, ToyCourseFactory -from openedx.core.djangoapps.content_staging import api as python_api - - CLIPBOARD_ENDPOINT = "/api/content-staging/v1/clipboard/" # OLX of the video in the toy course using course_key.make_usage_key("video", "sample_video") @@ -35,7 +35,7 @@ class ClipboardTestCase(ModuleStoreTestCase): Test Clipboard functionality """ - def test_empty_clipboard(self): + def test_empty_clipboard(self) -> None: """ When a user has no content on their clipboard, we get an empty 200 response """ @@ -70,7 +70,7 @@ def _setup_course(self): return (course_key, client) - def test_copy_video(self): + def test_copy_video(self) -> None: """ Test copying a video from the course, and retrieve it using the REST API """ @@ -103,7 +103,7 @@ def test_copy_video(self): # Now if we GET the clipboard again, the GET response should exactly equal the last POST response: assert client.get(CLIPBOARD_ENDPOINT).json() == response_data - def test_copy_video_python_get(self): + def test_copy_video_python_get(self) -> None: """ Test copying a video from the course, and retrieve it using the python API """ @@ -126,9 +126,10 @@ def test_copy_video_python_get(self): assert clipboard_data.content.display_name == "default" # Test the actual OLX in the clipboard: olx_data = python_api.get_staged_content_olx(clipboard_data.content.id) + assert olx_data is not None self.assertXmlEqual(olx_data, SAMPLE_VIDEO_OLX) - def test_copy_html(self): + def test_copy_html(self) -> None: """ Test copying an HTML XBlock from the course """ @@ -166,7 +167,7 @@ def test_copy_html(self): # Now if we GET the clipboard again, the GET response should exactly equal the last POST response: assert client.get(CLIPBOARD_ENDPOINT).json() == response_data - def test_copy_unit(self): + def test_copy_unit(self) -> None: """ Test copying a unit (vertical block) from the course """ @@ -242,7 +243,7 @@ def test_copy_unit(self): # Now if we GET the clipboard again, the GET response should exactly equal the last POST response: assert client.get(CLIPBOARD_ENDPOINT).json() == response_data - def test_copy_several_things(self): + def test_copy_several_things(self) -> None: """ Test that the clipboard only holds one thing at a time. """ @@ -275,7 +276,7 @@ def test_copy_several_things(self): # The OLX link from the video will no longer work: assert client.get(old_olx_url).status_code == 404 - def test_copy_static_assets(self): + def test_copy_static_assets(self) -> None: """ Test copying an HTML from the course that references a static asset file. """ @@ -295,8 +296,9 @@ def test_copy_static_assets(self): # Validate the response: assert response.status_code == 200 response_data = response.json() - staged_content_id = response_data["content"]["id"] + staged_content_id = cast(python_api.StagedContentID, response_data["content"]["id"]) olx_str = python_api.get_staged_content_olx(staged_content_id) + assert olx_str is not None assert '' in olx_str static_assets = python_api.get_staged_content_static_files(staged_content_id) @@ -307,7 +309,7 @@ def test_copy_static_assets(self): data=None, )] - def test_copy_static_assets_nonexistent(self): + def test_copy_static_assets_nonexistent(self) -> None: """ Test copying a HTML block which references non-existent static assets. """ @@ -332,11 +334,12 @@ def test_copy_static_assets_nonexistent(self): response_data = response.json() staged_content_id = response_data["content"]["id"] olx_str = python_api.get_staged_content_olx(staged_content_id) + assert olx_str is not None assert '' in olx_str static_assets = python_api.get_staged_content_static_files(staged_content_id) assert static_assets == [] - def test_no_course_permission(self): + def test_no_course_permission(self) -> None: """ Test that a user without read access cannot copy items in a course """ @@ -353,7 +356,7 @@ def test_no_course_permission(self): response = nonstaff_client.get(CLIPBOARD_ENDPOINT) assert response.json()["content"] is None - def test_no_stealing_clipboard_content(self): + def test_no_stealing_clipboard_content(self) -> None: """ Test that a user cannot see another user's clipboard """ @@ -370,7 +373,7 @@ def test_no_stealing_clipboard_content(self): response = nonstaff_client.get(olx_url) assert response.status_code == 403 - def assertXmlEqual(self, xml_str_a: str, xml_str_b: str): + def assertXmlEqual(self, xml_str_a: str, xml_str_b: str) -> None: """ Assert that the given XML strings are equal, ignoring attribute order and some whitespace variations. """ a = ElementTree.canonicalize(xml_str_a, strip_text=True) b = ElementTree.canonicalize(xml_str_b, strip_text=True) diff --git a/openedx/core/djangoapps/content_staging/urls.py b/openedx/core/djangoapps/content_staging/urls.py index 8953d68de35a..c7b5a860e7a0 100644 --- a/openedx/core/djangoapps/content_staging/urls.py +++ b/openedx/core/djangoapps/content_staging/urls.py @@ -1,7 +1,7 @@ """ Studio URL configuration for Content Staging (& Clipboard) """ -from django.urls import path, include +from django.urls import include, path from . import views diff --git a/openedx/core/djangoapps/content_staging/views.py b/openedx/core/djangoapps/content_staging/views.py index 37bfa54d7df2..f013c0114a74 100644 --- a/openedx/core/djangoapps/content_staging/views.py +++ b/openedx/core/djangoapps/content_staging/views.py @@ -3,19 +3,20 @@ """ from __future__ import annotations +import edx_api_doc_tools as apidocs from django.db import transaction from django.http import HttpResponse from django.shortcuts import get_object_or_404 from django.utils.decorators import method_decorator -import edx_api_doc_tools as apidocs from opaque_keys import InvalidKeyError from opaque_keys.edx.keys import UsageKey from opaque_keys.edx.locator import CourseLocator, LibraryLocatorV2 +from openedx_authz.constants import permissions as authz_permissions from rest_framework.exceptions import NotFound, PermissionDenied, ValidationError from rest_framework.response import Response from rest_framework.views import APIView -from common.djangoapps.student.auth import has_studio_read_access +from common.djangoapps.student.auth import has_studio_read_access from openedx.core.djangoapps.xblock import api as xblock_api from openedx.core.lib.api.view_utils import view_auth_classes from xmodule.modulestore.django import modulestore @@ -24,7 +25,7 @@ from . import api from .data import StagedContentStatus from .models import StagedContent -from .serializers import UserClipboardSerializer, PostToClipboardSerializer +from .serializers import PostToClipboardSerializer, UserClipboardSerializer @view_auth_classes(is_authenticated=True) @@ -92,7 +93,7 @@ def post(self, request): try: usage_key = UsageKey.from_string(request.data["usage_key"]) except (ValueError, InvalidKeyError): - raise ValidationError('Invalid usage key') # lint-amnesty, pylint: disable=raise-missing-from + raise ValidationError('Invalid usage key') # pylint: disable=raise-missing-from # noqa: B904 if usage_key.block_type in ('course', 'chapter', 'sequential'): raise ValidationError('Requested XBlock tree is too large') course_key = usage_key.context_key @@ -114,7 +115,7 @@ def post(self, request): lib_api.require_permission_for_library_key( course_key, request.user, - lib_api.permissions.CAN_VIEW_THIS_CONTENT_LIBRARY + authz_permissions.REUSE_LIBRARY_CONTENT ) block = xblock_api.load_block(usage_key, user=None) version_num = lib_api.get_library_block(usage_key).draft_version_num diff --git a/openedx/core/djangoapps/content_tagging/api.py b/openedx/core/djangoapps/content_tagging/api.py index 7f22d1bbc486..ed77d9516ee5 100644 --- a/openedx/core/djangoapps/content_tagging/api.py +++ b/openedx/core/djangoapps/content_tagging/api.py @@ -2,27 +2,24 @@ Content Tagging APIs """ from __future__ import annotations -import io -from itertools import groupby import csv -from typing import Iterator -from opaque_keys.edx.keys import CourseKey, CollectionKey, ContainerKey, UsageKey +import io +from itertools import groupby +from typing import Iterator # noqa: UP035 -import openedx_tagging.core.tagging.api as oel_tagging +import openedx_tagging.api as oel_tagging from django.db.models import Exists, OuterRef, Q, QuerySet from django.utils.timezone import now +from opaque_keys.edx.keys import CollectionKey, ContainerKey, CourseKey, UsageKey from opaque_keys.edx.locator import LibraryLocatorV2 -from openedx_tagging.core.tagging.models import ObjectTag, Taxonomy -from openedx_tagging.core.tagging.models.utils import TAGS_CSV_SEPARATOR +from openedx_events.content_authoring.data import ContentObjectChangedData, ContentObjectData +from openedx_events.content_authoring.signals import CONTENT_OBJECT_ASSOCIATIONS_CHANGED, CONTENT_OBJECT_TAGS_CHANGED +from openedx_tagging.models import ObjectTag, Taxonomy +from openedx_tagging.models.utils import TAGS_CSV_SEPARATOR from organizations.models import Organization -from .helpers.objecttag_export_helpers import build_object_tree_with_objecttags, iterate_with_level -from openedx_events.content_authoring.data import ContentObjectData, ContentObjectChangedData -from openedx_events.content_authoring.signals import ( - CONTENT_OBJECT_ASSOCIATIONS_CHANGED, - CONTENT_OBJECT_TAGS_CHANGED, -) +from .helpers.objecttag_export_helpers import build_object_tree_with_objecttags, iterate_with_level from .models import TaxonomyOrg from .types import ContentKey, TagValuesByObjectIdDict, TagValuesByTaxonomyIdDict, TaxonomyDict from .utils import check_taxonomy_context_key_org, get_content_key_from_string, get_context_key_from_key @@ -326,7 +323,7 @@ def import_course_tags_from_csv(csv_path, course_id) -> None: Import tags from a csv file generated on export. """ # Open csv file and extract the tags - with open(csv_path, 'r') as csv_file: + with open(csv_path, 'r') as csv_file: # noqa: UP015 csv_reader = csv.DictReader(csv_file) tags_in_blocks = list(csv_reader) diff --git a/openedx/core/djangoapps/content_tagging/apps.py b/openedx/core/djangoapps/content_tagging/apps.py index de52da36780b..92fef25069b1 100644 --- a/openedx/core/djangoapps/content_tagging/apps.py +++ b/openedx/core/djangoapps/content_tagging/apps.py @@ -13,4 +13,4 @@ class ContentTaggingConfig(AppConfig): def ready(self): # Connect signal handlers - from . import handlers # pylint: disable=unused-import + from . import handlers # pylint: disable=unused-import # noqa: F401 diff --git a/openedx/core/djangoapps/content_tagging/auth.py b/openedx/core/djangoapps/content_tagging/auth.py index 73040111ab53..78c4cf3e9533 100644 --- a/openedx/core/djangoapps/content_tagging/auth.py +++ b/openedx/core/djangoapps/content_tagging/auth.py @@ -1,14 +1,73 @@ """ Functions to validate the access in content tagging actions """ +import logging +from opaque_keys import InvalidKeyError +from opaque_keys.edx.keys import CourseKey +from openedx_authz import api as authz_api +from openedx_authz.constants.permissions import COURSES_EXPORT_TAGS +from openedx_tagging import rules as oel_tagging_rules -from openedx_tagging.core.tagging import rules as oel_tagging_rules +from openedx.core import toggles as core_toggles + +from .utils import get_context_key_from_key_string + +log = logging.getLogger(__name__) def has_view_object_tags_access(user, object_id): + """ + Check if the user has access to view object tags for the given object. + """ + # If authz is enabled, check for the export tags authz permission + course_key = None + # Try to parse the object_id as a CourseKey, if it fails, + # it means object_id is not a course, so we don't validate against authz + # and fallback to the legacy check. + try: + course_key = CourseKey.from_string(object_id) + except InvalidKeyError: + pass + + if course_key and core_toggles.enable_authz_course_authoring(course_key): + return authz_api.is_user_allowed( + user.username, COURSES_EXPORT_TAGS.identifier, str(course_key) + ) + + # Always check for tagging permissions return user.has_perm( "oel_tagging.view_objecttag", # The obj arg expects a model, but we are passing an object oel_tagging_rules.ObjectTagPermissionItem(taxonomy=None, object_id=object_id), # type: ignore[arg-type] ) + + +def should_use_course_authz_for_object(object_id) -> tuple[bool, CourseKey | None]: + """ + Check if openedx-authz should be used for the given object based on the context key and toggle. + + This intentionally scopes to course objects only. For non-course objects + (e.g. content libraries), this returns (False, None), and callers are + expected to fall back to legacy django-rules permissions, which handle + library authz checks separately (see can_change_object_tag_objectid + in rules.py). + + Returns (should_use_authz, course_key) where: + - should_use_authz: True if authz should be used, False otherwise + - course_key: The CourseKey if object is a course and the toggle is active, None otherwise + """ + # Extract context_key and ensure it is a CourseKey (not a LibraryLocatorV2, etc.) + try: + context_key = get_context_key_from_key_string(object_id) + if not isinstance(context_key, CourseKey): + return False, None + except (ValueError, AttributeError): + return False, None + + # Check if toggle is active + if not core_toggles.enable_authz_course_authoring(context_key): + return False, None + + # Authz should be used for this course object + return True, context_key diff --git a/openedx/core/djangoapps/content_tagging/handlers.py b/openedx/core/djangoapps/content_tagging/handlers.py index 86cbb7167cbe..f271f6d73cd9 100644 --- a/openedx/core/djangoapps/content_tagging/handlers.py +++ b/openedx/core/djangoapps/content_tagging/handlers.py @@ -2,24 +2,19 @@ Automatic tagging of content """ -import crum import logging +import crum from django.dispatch import receiver -from openedx_events.content_authoring.data import ( - CourseData, - DuplicatedXBlockData, - XBlockData, - LibraryBlockData, -) +from openedx_events.content_authoring.data import CourseData, DuplicatedXBlockData, LibraryBlockData, XBlockData from openedx_events.content_authoring.signals import ( COURSE_CREATED, + LIBRARY_BLOCK_CREATED, + LIBRARY_BLOCK_UPDATED, XBLOCK_CREATED, XBLOCK_DELETED, - XBLOCK_UPDATED, XBLOCK_DUPLICATED, - LIBRARY_BLOCK_CREATED, - LIBRARY_BLOCK_UPDATED, + XBLOCK_UPDATED, ) from .api import copy_object_tags @@ -27,8 +22,8 @@ delete_course_tags, delete_xblock_tags, update_course_tags, - update_xblock_tags, update_library_block_tags, + update_xblock_tags, ) from .toggles import CONTENT_TAGGING_AUTO diff --git a/openedx/core/djangoapps/content_tagging/helpers/objecttag_export_helpers.py b/openedx/core/djangoapps/content_tagging/helpers/objecttag_export_helpers.py index cb7865e136c6..0c3a6d994eba 100644 --- a/openedx/core/djangoapps/content_tagging/helpers/objecttag_export_helpers.py +++ b/openedx/core/djangoapps/content_tagging/helpers/objecttag_export_helpers.py @@ -4,7 +4,7 @@ from __future__ import annotations -from typing import Any, Callable, Iterator, Union +from typing import Any, Callable, Iterator, Union # noqa: UP035 from attrs import define from opaque_keys.edx.keys import CourseKey, UsageKey @@ -141,7 +141,7 @@ def build_object_tree_with_objecttags( """ Returns the object with the tags associated with it. """ - get_tagged_children: Union[ + get_tagged_children: Union[ # noqa: UP007 # _get_course_tagged_object_and_children type Callable[[library_api.LibraryXBlockMetadata, dict[str, dict[int, list[Any]]]], tuple[TaggedContent, None]], # _get_library_block_tagged_object type diff --git a/openedx/core/djangoapps/content_tagging/migrations/0001_initial.py b/openedx/core/djangoapps/content_tagging/migrations/0001_initial.py index 7d74d7ab73a0..8e99e89dab5b 100644 --- a/openedx/core/djangoapps/content_tagging/migrations/0001_initial.py +++ b/openedx/core/djangoapps/content_tagging/migrations/0001_initial.py @@ -1,7 +1,7 @@ # Generated by Django 3.2.20 on 2023-07-25 06:17 -from django.db import migrations, models import django.db.models.deletion +from django.db import migrations, models class Migration(migrations.Migration): diff --git a/openedx/core/djangoapps/content_tagging/migrations/0001_squashed.py b/openedx/core/djangoapps/content_tagging/migrations/0001_squashed.py index fa00df307c64..039fcd23428e 100644 --- a/openedx/core/djangoapps/content_tagging/migrations/0001_squashed.py +++ b/openedx/core/djangoapps/content_tagging/migrations/0001_squashed.py @@ -1,7 +1,7 @@ # Generated by Django 3.2.21 on 2023-10-09 23:12 -from django.db import migrations, models import django.db.models.deletion +from django.db import migrations, models class Migration(migrations.Migration): diff --git a/openedx/core/djangoapps/content_tagging/migrations/0002_system_defined_taxonomies.py b/openedx/core/djangoapps/content_tagging/migrations/0002_system_defined_taxonomies.py index 14a3e6ace128..377f077b0694 100644 --- a/openedx/core/djangoapps/content_tagging/migrations/0002_system_defined_taxonomies.py +++ b/openedx/core/djangoapps/content_tagging/migrations/0002_system_defined_taxonomies.py @@ -1,6 +1,7 @@ # Generated by Django 3.2.20 on 2023-07-31 21:07 from django.db import migrations + import openedx.core.djangoapps.content_tagging.models.base diff --git a/openedx/core/djangoapps/content_tagging/models/__init__.py b/openedx/core/djangoapps/content_tagging/models/__init__.py index 4a25224b4bae..6ddfa23fefbe 100644 --- a/openedx/core/djangoapps/content_tagging/models/__init__.py +++ b/openedx/core/djangoapps/content_tagging/models/__init__.py @@ -1,6 +1,4 @@ """ Content Tagging and System defined models """ -from .base import ( - TaxonomyOrg, -) +from .base import TaxonomyOrg # noqa: F401 diff --git a/openedx/core/djangoapps/content_tagging/models/base.py b/openedx/core/djangoapps/content_tagging/models/base.py index d799d8795194..6779a6008e16 100644 --- a/openedx/core/djangoapps/content_tagging/models/base.py +++ b/openedx/core/djangoapps/content_tagging/models/base.py @@ -6,11 +6,11 @@ from django.db import models from django.db.models import Q, QuerySet from django.utils.translation import gettext as _ -from openedx_tagging.core.tagging.models import Taxonomy +from openedx_tagging.models import Taxonomy from organizations.models import Organization -class TaxonomyOrg(models.Model): +class TaxonomyOrg(models.Model): # noqa: DJ008 """ Represents the many-to-many relationship between Taxonomies and Organizations. diff --git a/openedx/core/djangoapps/content_tagging/rest_api/urls.py b/openedx/core/djangoapps/content_tagging/rest_api/urls.py index d7f012bb7ba1..2cd82d03b4d9 100644 --- a/openedx/core/djangoapps/content_tagging/rest_api/urls.py +++ b/openedx/core/djangoapps/content_tagging/rest_api/urls.py @@ -2,7 +2,7 @@ Taxonomies API URLs. """ -from django.urls import path, include +from django.urls import include, path from .v1 import urls as v1_urls diff --git a/openedx/core/djangoapps/content_tagging/rest_api/v1/filters.py b/openedx/core/djangoapps/content_tagging/rest_api/v1/filters.py index e4fa403fa526..a51bf6c99812 100644 --- a/openedx/core/djangoapps/content_tagging/rest_api/v1/filters.py +++ b/openedx/core/djangoapps/content_tagging/rest_api/v1/filters.py @@ -2,13 +2,13 @@ API Filters for content tagging org """ +import openedx_tagging.rules as oel_tagging from django.db.models import Exists, OuterRef, Q from rest_framework.filters import BaseFilterBackend -import openedx_tagging.core.tagging.rules as oel_tagging - -from ...rules import get_admin_orgs, get_user_orgs from ...models import TaxonomyOrg +from ...rules import get_admin_orgs, get_user_orgs +from ...utils import rules_cache class UserOrgFilterBackend(BaseFilterBackend): @@ -63,7 +63,30 @@ class ObjectTagTaxonomyOrgFilterBackend(BaseFilterBackend): Filter for ObjectTagViewSet to only show taxonomies that the user can view. """ - def filter_queryset(self, request, queryset, _): + def filter_queryset(self, request, queryset, view): + # Authz path: filter by course org only. + # The legacy validation layer (check_taxonomy_context_key_org in rules.py) enforces + # that tags can only be applied to a course from global taxonomies or taxonomies + # owned by the course's org. This is narrower than the legacy filter path below, + # which filters by all the user's orgs, but it matches the actual enforcement — + # a user can never apply an OrgA taxonomy to an OrgB course regardless of their + # permissions. + should_use_authz, course_key = getattr(view, '_authz_check', (False, None)) + if should_use_authz and course_key: + course_orgs = rules_cache.get_orgs([course_key.org]) if course_key.org else [] + return queryset.filter(taxonomy__enabled=True).filter( + Exists( + TaxonomyOrg.objects + .filter(taxonomy=OuterRef("taxonomy_id"), rel_type=TaxonomyOrg.RelType.OWNER) + .filter(Q(org=None) | Q(org__in=course_orgs)) + ) + ).prefetch_related('taxonomy__taxonomyorg_set') + + # Legacy path: filter by all the user's orgs. + # This is broader than necessary for this endpoint (see authz path comment above). + # Users may see taxonomies from orgs unrelated to the current course — those + # taxonomies can't have tags applied here (blocked by check_taxonomy_context_key_org), + # but they still appear in the response with can_tag_object=false. if oel_tagging.is_taxonomy_admin(request.user): return queryset.prefetch_related('taxonomy__taxonomyorg_set') diff --git a/openedx/core/djangoapps/content_tagging/rest_api/v1/serializers.py b/openedx/core/djangoapps/content_tagging/rest_api/v1/serializers.py index bda2ae163c45..22d875670817 100644 --- a/openedx/core/djangoapps/content_tagging/rest_api/v1/serializers.py +++ b/openedx/core/djangoapps/content_tagging/rest_api/v1/serializers.py @@ -4,16 +4,18 @@ from __future__ import annotations -from rest_framework import serializers, fields - -from openedx_tagging.core.tagging.rest_api.v1.serializers import ( +from openedx_authz import api as authz_api +from openedx_authz.constants.permissions import COURSES_MANAGE_TAGS +from openedx_tagging.rest_api.v1.serializers import ( ObjectTagMinimalSerializer, + ObjectTagsByTaxonomySerializer, TaxonomyListQueryParamsSerializer, TaxonomySerializer, ) - from organizations.models import Organization +from rest_framework import fields, serializers +from ...auth import should_use_course_authz_for_object from ...models import TaxonomyOrg @@ -97,12 +99,35 @@ class Meta: read_only_fields = ["orgs", "all_orgs"] +class ObjectTagOrgByTaxonomySerializer(ObjectTagsByTaxonomySerializer): + """ + Extend ObjectTagsByTaxonomySerializer to conditionally use openedx-authz for can_tag_object. + """ + + def can_tag_object(self, obj_tag) -> bool | None: + """ + Check if the user is authorized to tag the provided object. + Conditionally use openedx-authz for course objects with the toggle enabled. + """ + should_use_authz, course_key = should_use_course_authz_for_object(obj_tag.object_id) + if should_use_authz: + request = self.context.get('request') + if request and hasattr(request, 'user'): + return authz_api.is_user_allowed( + request.user.username, COURSES_MANAGE_TAGS.identifier, str(course_key) + ) + return False + + # Fall back to parent implementation + return super().can_tag_object(obj_tag) + + class ObjectTagCopiedMinimalSerializer(ObjectTagMinimalSerializer): """ Serializer for Object Tags. - This override `get_can_delete_objecttag` to avoid delete - object tags if is copied. + This overrides `can_delete_object_tag` to avoid deleting + object tags if they are copied and to conditionally use openedx-authz. """ is_copied = serializers.BooleanField(read_only=True) @@ -110,14 +135,25 @@ class ObjectTagCopiedMinimalSerializer(ObjectTagMinimalSerializer): class Meta(ObjectTagMinimalSerializer.Meta): fields = ObjectTagMinimalSerializer.Meta.fields + ["is_copied"] - def get_can_delete_objecttag(self, instance): + def can_delete_object_tag(self, instance) -> bool | None: """ - Verify if the user can delete the object tag. + Check if the user is authorized to delete the provided tag. - Override to return `False` if the object tag is copied. + Override to return `False` if the object tag is copied, + and conditionally use openedx-authz for course objects with the toggle enabled. """ if instance.is_copied: # The user can't delete copied tags. return False - return super().get_can_delete_objecttag(instance) + should_use_authz, course_key = should_use_course_authz_for_object(instance.object_id) + if should_use_authz: + request = self.context.get('request') + if request and hasattr(request, 'user'): + return authz_api.is_user_allowed( + request.user.username, COURSES_MANAGE_TAGS.identifier, str(course_key) + ) + return False + + # Fall back to parent implementation + return super().can_delete_object_tag(instance) diff --git a/openedx/core/djangoapps/content_tagging/rest_api/v1/tests/test_views.py b/openedx/core/djangoapps/content_tagging/rest_api/v1/tests/test_views.py index a4094c301bb8..0422845cc346 100644 --- a/openedx/core/djangoapps/content_tagging/rest_api/v1/tests/test_views.py +++ b/openedx/core/djangoapps/content_tagging/rest_api/v1/tests/test_views.py @@ -7,20 +7,23 @@ import abc import json from io import BytesIO -from unittest.mock import MagicMock +from unittest.mock import MagicMock, patch from urllib.parse import parse_qs, urlparse import ddt from django.contrib.auth import get_user_model from django.core.files.uploadedfile import SimpleUploadedFile +from django.urls import reverse from edx_django_utils.cache import RequestCache from opaque_keys.edx.locator import BlockUsageLocator, CourseLocator, LibraryCollectionLocator, LibraryContainerLocator -from openedx_tagging.core.tagging.models import Tag, Taxonomy -from openedx_tagging.core.tagging.models.system_defined import SystemDefinedTaxonomy -from openedx_tagging.core.tagging.rest_api.v1.serializers import TaxonomySerializer +from openedx_authz.constants import permissions as authz_permissions +from openedx_authz.constants.roles import COURSE_AUDITOR, COURSE_EDITOR, COURSE_STAFF +from openedx_tagging.models import Tag, Taxonomy +from openedx_tagging.models.system_defined import SystemDefinedTaxonomy +from openedx_tagging.rest_api.v1.serializers import TaxonomySerializer from organizations.models import Organization from rest_framework import status -from rest_framework.test import APITestCase +from rest_framework.test import APIClient, APITestCase from common.djangoapps.student.auth import add_users, update_org_role from common.djangoapps.student.roles import ( @@ -29,13 +32,17 @@ OrgContentCreatorRole, OrgInstructorRole, OrgLibraryUserRole, - OrgStaffRole + OrgStaffRole, ) -from common.djangoapps.student.tests.factories import UserFactory +from common.djangoapps.student.tests.factories import StaffFactory, UserFactory +from openedx.core.djangoapps.authz.tests.mixins import CourseAuthzTestMixin from openedx.core.djangoapps.content_libraries.api import AccessLevel, create_library, set_library_user_permissions from openedx.core.djangoapps.content_tagging import api as tagging_api +from openedx.core.djangoapps.content_tagging.api import set_taxonomy_orgs from openedx.core.djangoapps.content_tagging.models import TaxonomyOrg from openedx.core.djangolib.testing.utils import skip_unless_cms +from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase +from xmodule.modulestore.tests.factories import CourseFactory from ....tests.test_objecttag_export_helpers import TaggedCourseMixin @@ -332,7 +339,7 @@ def _test_list_taxonomy( response = self.client.get(url, query_params, format="json") assert response.status_code == status.HTTP_200_OK - self.assertEqual(set(t["name"] for t in response.data["results"]), set(expected_taxonomies)) + self.assertEqual(set(t["name"] for t in response.data["results"]), set(expected_taxonomies)) # noqa: PT009 def test_list_taxonomy_staff(self) -> None: """ @@ -446,7 +453,7 @@ def test_list_taxonomy_pagination( assert response.status_code == status.HTTP_200_OK if len(expected_taxonomies) > 0 else status.HTTP_404_NOT_FOUND if status.is_success(response.status_code): - self.assertEqual(set(t["name"] for t in response.data["results"]), set(expected_taxonomies)) + self.assertEqual(set(t["name"] for t in response.data["results"]), set(expected_taxonomies)) # noqa: PT009 parsed_url = urlparse(response.data["next"]) next_page = parse_qs(parsed_url.query).get("page", [None])[0] @@ -514,12 +521,12 @@ def test_create_taxonomy(self, user_attr: str, expected_status: int) -> None: @ddt.data( ('staff', 11), - ("content_creatorA", 22), - ("library_staffA", 22), - ("library_userA", 22), - ("instructorA", 22), - ("course_instructorA", 22), - ("course_staffA", 22), + ("content_creatorA", 23), + ("library_staffA", 23), + ("library_userA", 23), + ("instructorA", 23), + ("course_instructorA", 23), + ("course_staffA", 23), ) @ddt.unpack def test_list_taxonomy_query_count(self, user_attr: str, expected_queries: int): @@ -1624,6 +1631,35 @@ def test_tag_library(self, user_attr, taxonomy_attr, tag_values, expected_status assert status.is_success(new_response.status_code) assert new_response.data == response.data + @ddt.data("libraryA", "collection_key", "container_key") + @patch("openedx_authz.api.is_user_allowed") + @patch("openedx.core.djangoapps.content_tagging.rules.has_studio_write_access") + def test_tag_library_objects_with_manage_library_tags_permission( + self, + object_attr, + mock_has_studio_write_access, + mock_is_user_allowed, + ): + """ + Users with MANAGE_LIBRARY_TAGS permission should be able to tag: + - the library itself + - collections in the library + - containers in the library + """ + mock_is_user_allowed.return_value = True + object_id = getattr(self, object_attr) + + self.client.force_authenticate(user=self.library_userA) + response = self._call_put_request(object_id, self.tA1.pk, ["Tag 1"]) + + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 + mock_is_user_allowed.assert_called_with( + self.library_userA.username, + authz_permissions.MANAGE_LIBRARY_TAGS.identifier, + self.libraryA, + ) + mock_has_studio_write_access.assert_not_called() + @ddt.data( "staffA", "staff", @@ -1944,19 +1980,19 @@ def test_get_copied_tags(self): assert response.data[str(object_id_2)]["taxonomies"] == expected_tags @ddt.data( - ('staff', 'courseA', 8), - ('staff', 'libraryA', 8), - ('staff', 'collection_key', 8), - ("content_creatorA", 'courseA', 17, False), - ("content_creatorA", 'libraryA', 17, False), - ("content_creatorA", 'collection_key', 17, False), - ("library_staffA", 'libraryA', 17, False), # Library users can only view objecttags, not change them? - ("library_staffA", 'collection_key', 17, False), - ("library_userA", 'libraryA', 17, False), - ("library_userA", 'collection_key', 17, False), - ("instructorA", 'courseA', 17), - ("course_instructorA", 'courseA', 17), - ("course_staffA", 'courseA', 17), + ('staff', 'courseA', 10), + ('staff', 'libraryA', 17), + ('staff', 'collection_key', 17), + ("content_creatorA", 'courseA', 20, False), + ("content_creatorA", 'libraryA', 23, False), + ("content_creatorA", 'collection_key', 23, False), + ("library_staffA", 'libraryA', 23, False), # Library users can only view objecttags, not change them? + ("library_staffA", 'collection_key', 23, False), + ("library_userA", 'libraryA', 23, False), + ("library_userA", 'collection_key', 23, False), + ("instructorA", 'courseA', 20), + ("course_instructorA", 'courseA', 20), + ("course_staffA", 'courseA', 20), ) @ddt.unpack def test_object_tags_query_count( @@ -1964,7 +2000,7 @@ def test_object_tags_query_count( user_attr: str, object_attr: str, expected_queries: int, - expected_perm: bool = True): + expected_perm: bool = True): # noqa: PT028 """ Test how many queries are used when retrieving object tags and permissions """ @@ -2051,6 +2087,277 @@ def test_export_course_invalid_id(self) -> None: response = self.client.get(url) assert response.status_code == status.HTTP_403_FORBIDDEN +@skip_unless_cms +class TestContentObjectChildrenExportViewWithAuthz(CourseAuthzTestMixin, SharedModuleStoreTestCase, APITestCase): + """ + Tests Tags Export in Course authorization using openedx-authz. + """ + + authz_roles_to_assign = [COURSE_STAFF.external_key] + + @classmethod + def setUpClass(cls): + super().setUpClass() + cls.password = 'test' + cls.course = CourseFactory.create() + cls.course_key = cls.course.id + cls.staff = StaffFactory(course_key=cls.course_key, password=cls.password) + + def get_url(self, course_key): + return reverse('content_tagging:taxonomy-object-tag-export', kwargs={'context_id': course_key}) + + def test_authorized_user_can_access(self): + """User with COURSE_STAFF role can access.""" + resp = self.authorized_client.get(self.get_url(self.course_key)) + self.assertEqual(resp.status_code, status.HTTP_200_OK) # noqa: PT009 + + def test_unauthorized_user_cannot_access(self): + """User without role cannot access.""" + resp = self.unauthorized_client.get(self.get_url(self.course_key)) + self.assertEqual(resp.status_code, status.HTTP_403_FORBIDDEN) # noqa: PT009 + + def test_role_scoped_to_course(self): + """Authorization should only apply to the assigned course.""" + other_course = self.store.create_course("OtherOrg", "OtherCourse", "Run", self.staff.id) + + resp = self.authorized_client.get(self.get_url(other_course.id)) + self.assertEqual(resp.status_code, status.HTTP_403_FORBIDDEN) # noqa: PT009 + + def test_staff_user_allowed_via_legacy(self): + """Staff users should still pass through legacy fallback.""" + self.client.force_authenticate(user=self.staff) + resp = self.client.get(self.get_url(self.course_key)) + self.assertEqual(resp.status_code, status.HTTP_200_OK) # noqa: PT009 + + def test_superuser_allowed(self): + """Superusers should always be allowed.""" + superuser = UserFactory(is_superuser=True) + client = APIClient() + client.force_authenticate(user=superuser) + resp = client.get(self.get_url(self.course_key)) + self.assertEqual(resp.status_code, status.HTTP_200_OK) # noqa: PT009 + + +@skip_unless_cms +class TestObjectTagOrgViewWithAuthz(CourseAuthzTestMixin, SharedModuleStoreTestCase, APITestCase): + """ + Test ObjectTagOrgView with authz permissions. + """ + + authz_roles_to_assign = [COURSE_STAFF.external_key] + + @classmethod + def setUpClass(cls): + super().setUpClass() + cls.course = CourseFactory.create() + cls.course_key = cls.course.id + + def setUp(self): + super().setUp() + + # Create another course for cross-course scoping tests + self.other_course = self.store.create_course("OtherOrg", "OtherCourse", "Run", self.authorized_user.id) + self.other_course_key = self.other_course.id + + # Create taxonomy + self.taxonomy = tagging_api.create_taxonomy( + name="Test Taxonomy", + description="Test taxonomy for authz", + ) + set_taxonomy_orgs(self.taxonomy, all_orgs=True) + + # Create tags + self.tag1 = self.taxonomy.add_tag("Tag 1") + self.tag2 = self.taxonomy.add_tag("Tag 2") + + # Create auditor user with view-only permissions + self.auditor_user = UserFactory(password=self.password) + self.auditor_client = APIClient() + self.auditor_client.force_authenticate(user=self.auditor_user) + + # Assign auditor role to auditor_user + self.add_user_to_role_in_course( + self.auditor_user, + COURSE_AUDITOR.external_key, + self.course_key + ) + + def _update_tags_request(self, object_id, tags_data=None): + """Helper method to make PUT request to update tags.""" + if tags_data is None: + tags_data = [ + { + "taxonomy": self.taxonomy.pk, + "tags": ["Tag 1", "Tag 2"] + } + ] + + url = OBJECT_TAG_UPDATE_URL.format(object_id=object_id) + return url, {"tagsData": tags_data} + + def _get_tags_request(self, object_id): + """Helper method to make GET request to retrieve tags.""" + url = OBJECT_TAGS_URL.format(object_id=object_id) + return url + + def test_course_staff_can_update_tags(self): + """course_staff can update tags → 200""" + url, data = self._update_tags_request(str(self.course_key)) + response = self.authorized_client.put(url, data, format='json') + assert response.status_code == status.HTTP_200_OK + + def test_course_auditor_denied_update(self): + """course_auditor denied → 403""" + url, data = self._update_tags_request(str(self.course_key)) + response = self.auditor_client.put(url, data, format='json') + assert response.status_code == status.HTTP_403_FORBIDDEN + + def test_no_role_user_denied_update(self): + """No-role user denied → 403""" + url, data = self._update_tags_request(str(self.course_key)) + response = self.unauthorized_client.put(url, data, format='json') + assert response.status_code == status.HTTP_403_FORBIDDEN + + def test_superuser_allowed_update(self): + """Superuser allowed → 200""" + url, data = self._update_tags_request(str(self.course_key)) + response = self.super_client.put(url, data, format='json') + assert response.status_code == status.HTTP_200_OK + + def test_django_staff_allowed_update(self): + """Django is_staff allowed → 200""" + url, data = self._update_tags_request(str(self.course_key)) + response = self.staff_client.put(url, data, format='json') + assert response.status_code == status.HTTP_200_OK + + def test_cross_course_scoping_denied(self): + """course_staff for course A tags course B → 403""" + url, data = self._update_tags_request(str(self.other_course_key)) + response = self.authorized_client.put(url, data, format='json') + assert response.status_code == status.HTTP_403_FORBIDDEN + + def test_course_staff_sees_manage_permissions(self): + """course_staff sees can_tag_object=True, can_delete_objecttag=True""" + # First add some tags to the course + url, data = self._update_tags_request(str(self.course_key)) + response = self.authorized_client.put(url, data, format='json') + assert response.status_code == status.HTTP_200_OK + + # Now check permissions in GET response + url = self._get_tags_request(str(self.course_key)) + response = self.authorized_client.get(url) + assert response.status_code == status.HTTP_200_OK + + # Check serializer permissions in response data + taxonomies = response.data[str(self.course_key)]["taxonomies"] + assert len(taxonomies) == 1 + for taxonomy_data in taxonomies: + assert taxonomy_data.get('can_tag_object') is True + tags = taxonomy_data.get('tags', []) + assert len(tags) == 2 + for tag_data in tags: + assert tag_data.get('can_delete_objecttag') is True + + def test_course_auditor_sees_view_only_permissions(self): + """course_auditor sees can_tag_object=False, can_delete_objecttag=False""" + # First add some tags using authorized user + url, data = self._update_tags_request(str(self.course_key)) + response = self.authorized_client.put(url, data, format='json') + assert response.status_code == status.HTTP_200_OK + + # Now check permissions as auditor in GET response + url = self._get_tags_request(str(self.course_key)) + response = self.auditor_client.get(url) + assert response.status_code == status.HTTP_200_OK + + # Check serializer permissions in response data + taxonomies = response.data[str(self.course_key)]["taxonomies"] + assert len(taxonomies) == 1 + for taxonomy_data in taxonomies: + assert taxonomy_data.get('can_tag_object') is False + tags = taxonomy_data.get('tags', []) + assert len(tags) == 2 + for tag_data in tags: + assert tag_data.get('can_delete_objecttag') is False + + def test_no_role_user_denied_view(self): + """No-role user denied on view → 403 (checks view_course)""" + url = self._get_tags_request(str(self.course_key)) + response = self.unauthorized_client.get(url) + assert response.status_code == status.HTTP_403_FORBIDDEN + + def test_course_editor_sees_org_scoped_taxonomy_tags(self): + """ + A course editor (authz-only, no legacy org roles) can see tags from + an org-scoped taxonomy applied to their course. + + Reproduces the scenario from review: admin tags a course with an + org-scoped taxonomy, course editor should see those tags. + """ + # Create an Organization matching the course's org + course_org, _ = Organization.objects.get_or_create( + short_name=self.course_key.org + ) + + # Create an org-scoped taxonomy (not global) + org_taxonomy = tagging_api.create_taxonomy( + name="Org Taxonomy", + description="Taxonomy scoped to course org", + ) + set_taxonomy_orgs(org_taxonomy, orgs=[course_org]) + org_taxonomy.add_tag("OrgTag") + + # Admin tags the course with the org-scoped taxonomy + tagging_api.tag_object( + object_id=str(self.course_key), + taxonomy=org_taxonomy, + tags=["OrgTag"], + ) + + # Create a course editor with authz only (no legacy roles) + editor_user = UserFactory(password=self.password) + editor_client = APIClient() + editor_client.force_authenticate(user=editor_user) + self.add_user_to_role_in_course( + editor_user, COURSE_EDITOR.external_key, self.course_key + ) + + # Course editor should see the org-scoped taxonomy tags + url = self._get_tags_request(str(self.course_key)) + response = editor_client.get(url) + assert response.status_code == status.HTTP_200_OK + + taxonomies = response.data[str(self.course_key)]["taxonomies"] + org_tax_names = [t["name"] for t in taxonomies] + assert "Org Taxonomy" in org_tax_names + + def test_library_fallthrough_to_legacy(self): + """Library object_id falls through to legacy permissions""" + # Create organization for library + org, _ = Organization.objects.get_or_create(short_name="TestOrg") + + # Create library + library = create_library( + org=org, + slug="test-lib", + title="Test Library", + description="Test library for authz fallthrough", + ) + library_key = library.key + + # Grant library access to authorized_user + set_library_user_permissions( + library_key, + self.authorized_user, + AccessLevel.ADMIN_LEVEL + ) + + # Test that library requests fall through to legacy permissions + url = self._get_tags_request(str(library_key)) + response = self.authorized_client.get(url) + # Should succeed via legacy permissions, not authz + assert response.status_code == status.HTTP_200_OK + @skip_unless_cms @ddt.ddt diff --git a/openedx/core/djangoapps/content_tagging/rest_api/v1/urls.py b/openedx/core/djangoapps/content_tagging/rest_api/v1/urls.py index 50fec093c1fb..4ed33e3ae31b 100644 --- a/openedx/core/djangoapps/content_tagging/rest_api/v1/urls.py +++ b/openedx/core/djangoapps/content_tagging/rest_api/v1/urls.py @@ -3,9 +3,9 @@ """ from django.urls.conf import include, path -from openedx_tagging.core.tagging.rest_api.v1 import views as oel_tagging_views -from openedx_tagging.core.tagging.rest_api.v1 import views_import as oel_tagging_views_import -from openedx_tagging.core.tagging.rest_api.v1.views import ObjectTagCountsView +from openedx_tagging.rest_api.v1 import views as oel_tagging_views +from openedx_tagging.rest_api.v1 import views_import as oel_tagging_views_import +from openedx_tagging.rest_api.v1.views import ObjectTagCountsView from rest_framework.routers import DefaultRouter from . import views @@ -29,6 +29,7 @@ path( "object_tags//export/", views.ObjectTagExportView.as_view(), + name="taxonomy-object-tag-export", ), path('', include(router.urls)) ] diff --git a/openedx/core/djangoapps/content_tagging/rest_api/v1/views.py b/openedx/core/djangoapps/content_tagging/rest_api/v1/views.py index c2da760e9327..556ea06cfe1e 100644 --- a/openedx/core/djangoapps/content_tagging/rest_api/v1/views.py +++ b/openedx/core/djangoapps/content_tagging/rest_api/v1/views.py @@ -3,24 +3,26 @@ """ from __future__ import annotations +import functools +from typing import TYPE_CHECKING + from django.db.models import Count from django.http import StreamingHttpResponse -from openedx_tagging.core.tagging import rules as oel_tagging_rules -from openedx_tagging.core.tagging.rest_api.v1.views import ObjectTagView, TaxonomyView +from openedx_authz import api as authz_api +from openedx_authz.constants.permissions import COURSES_MANAGE_TAGS, COURSES_VIEW_COURSE +from openedx_events.content_authoring.data import ContentObjectChangedData, ContentObjectData +from openedx_events.content_authoring.signals import CONTENT_OBJECT_ASSOCIATIONS_CHANGED, CONTENT_OBJECT_TAGS_CHANGED +from openedx_tagging import rules as oel_tagging_rules +from openedx_tagging.rest_api.v1.views import ObjectTagView, TaxonomyView from rest_framework import status from rest_framework.decorators import action from rest_framework.exceptions import PermissionDenied, ValidationError +from rest_framework.permissions import IsAuthenticated from rest_framework.response import Response from rest_framework.views import APIView -from openedx_events.content_authoring.data import ContentObjectData, ContentObjectChangedData -from openedx_events.content_authoring.signals import ( - CONTENT_OBJECT_ASSOCIATIONS_CHANGED, - CONTENT_OBJECT_TAGS_CHANGED, -) from openedx.core.types.http import RestRequest -from ...auth import has_view_object_tags_access from ...api import ( create_taxonomy, generate_csv_rows, @@ -28,17 +30,22 @@ get_taxonomies_for_org, get_taxonomy, get_unassigned_taxonomies, - set_taxonomy_orgs + set_taxonomy_orgs, ) +from ...auth import has_view_object_tags_access, should_use_course_authz_for_object from ...rules import get_admin_orgs from .filters import ObjectTagTaxonomyOrgFilterBackend, UserOrgFilterBackend from .serializers import ( ObjectTagCopiedMinimalSerializer, + ObjectTagOrgByTaxonomySerializer, TaxonomyOrgListQueryParamsSerializer, TaxonomyOrgSerializer, TaxonomyUpdateOrgBodySerializer, ) +if TYPE_CHECKING: + from opaque_keys.edx.keys import CourseKey + class TaxonomyOrgView(TaxonomyView): """ @@ -154,9 +161,70 @@ class ObjectTagOrgView(ObjectTagView): Refer to ObjectTagView docstring for usage details. """ + # Serializer overrides minimal_serializer_class = ObjectTagCopiedMinimalSerializer + object_tags_serializer_class = ObjectTagOrgByTaxonomySerializer + filter_backends = [ObjectTagTaxonomyOrgFilterBackend] + @functools.cached_property + def _authz_check(self) -> tuple[bool, CourseKey | None]: + """ + Cache the authz toggle + key-parsing result for the current object_id. + + Safe to cache per-instance because DRF creates a new view instance per request. + """ + object_id = self.kwargs.get('object_id') + if object_id: + return should_use_course_authz_for_object(object_id) + return False, None + + def get_permissions(self): + """ + Override get_permissions when using openedx-authz. + + When the toggle is enabled for course objects, we need to change the default + permission classes set by the parent ObjectTagView so that only openedx-authz + permissions are used. + """ + if self._authz_check[0]: + return [IsAuthenticated()] + + return super().get_permissions() + + def ensure_has_view_object_tag_permission(self, user, taxonomy, object_id): + """ + Check if user has permission to view object tags. + + This method is overridden to conditionally use openedx-authz when the toggle is enabled. + """ + should_use_authz, course_key = self._authz_check + if should_use_authz and not authz_api.is_user_allowed( + user.username, COURSES_VIEW_COURSE.identifier, str(course_key) + ): + raise PermissionDenied("You do not have permission to view object tags.") + if not should_use_authz: + # Fall back to parent implementation + super().ensure_has_view_object_tag_permission(user, taxonomy, object_id) + + def ensure_user_has_can_tag_object_permissions(self, user, tags_data, object_id): + """ + Check if user has permission to tag object for each taxonomy in tags_data. + + This method is overridden to conditionally use openedx-authz when the toggle is enabled. + + When using openedx-authz, if the user has manage tags permission for the course, + they can tag the object regardless of the taxonomy. + """ + should_use_authz, course_key = self._authz_check + if should_use_authz and not authz_api.is_user_allowed( + user.username, COURSES_MANAGE_TAGS.identifier, str(course_key) + ): + raise PermissionDenied("You do not have permission to manage object tags.") + if not should_use_authz: + # Fall back to parent implementation + super().ensure_user_has_can_tag_object_permissions(user, tags_data, object_id) + def update(self, request, *args, **kwargs) -> Response: """ Extend the update method to fire CONTENT_OBJECT_ASSOCIATIONS_CHANGED event @@ -193,7 +261,7 @@ def get(self, request: RestRequest, **kwargs) -> StreamingHttpResponse: Export a CSV with all children and tags for a given course/context. """ - class Echo(object): + class Echo(object): # noqa: UP004 """ Class that implements just the write method of the file-like interface, used for the streaming response. diff --git a/openedx/core/djangoapps/content_tagging/rules.py b/openedx/core/djangoapps/content_tagging/rules.py index 72b744f5bf8e..3b70076189ef 100644 --- a/openedx/core/djangoapps/content_tagging/rules.py +++ b/openedx/core/djangoapps/content_tagging/rules.py @@ -5,8 +5,11 @@ from typing import Union import django.contrib.auth.models -import openedx_tagging.core.tagging.rules as oel_tagging +import openedx_tagging.rules as oel_tagging import rules +from opaque_keys.edx.locator import LibraryLocatorV2 +from openedx_authz import api as authz_api +from openedx_authz.constants import permissions as authz_permissions from organizations.models import Organization from common.djangoapps.student.auth import has_studio_read_access, has_studio_write_access @@ -17,14 +20,13 @@ OrgContentCreatorRole, OrgInstructorRole, OrgLibraryUserRole, - OrgStaffRole + OrgStaffRole, ) from .models import TaxonomyOrg from .utils import check_taxonomy_context_key_org, get_context_key_from_key_string, rules_cache - -UserType = Union[django.contrib.auth.models.User, django.contrib.auth.models.AnonymousUser] +UserType = Union[django.contrib.auth.models.User, django.contrib.auth.models.AnonymousUser] # noqa: UP007 def is_org_admin(user: UserType, orgs: list[Organization] | None = None) -> bool: @@ -218,7 +220,13 @@ def can_change_taxonomy(user: UserType, taxonomy: oel_tagging.Taxonomy) -> bool: @rules.predicate def can_change_object_tag_objectid(user: UserType, object_id: str) -> bool: """ - Everyone that has permission to edit the object should be able to tag it. + Return True if the user may add or modify tags on the given object. + + For Content Libraries V2, this requires either explicit library tagging permission + (MANAGE_LIBRARY_TAGS) or org-level admin access for the library's org. + + For other contexts (courses, xblocks, etc.), this requires studio write access or + org-level admin access for the object's org. """ if not object_id: return True @@ -229,6 +237,16 @@ def can_change_object_tag_objectid(user: UserType, object_id: str) -> bool: except (ValueError, AssertionError): return False + # For Content Libraries V2, prefer explicit library tagging permission, + # however, org-level admins are also allowed to perform these operations. + if isinstance(context_key, LibraryLocatorV2) and authz_api.is_user_allowed( + user.username, + authz_permissions.MANAGE_LIBRARY_TAGS.identifier, + str(context_key), + ): + return True + + # For other contexts (courses, xblocks, etc.), use general write or org-admin access if has_studio_write_access(user, context_key): return True @@ -276,7 +294,13 @@ def can_view_object_tag_objectid(user: UserType, object_id: str) -> bool: @rules.predicate def can_remove_object_tag_objectid(user: UserType, object_id: str) -> bool: """ - Everyone that has permission to edit the object should be able remove tags from it. + Return True if the user may remove tags from the given object. + + For Content Libraries V2, this requires either explicit library tagging permission + (MANAGE_LIBRARY_TAGS) or org-level admin access for the library's org. + + For other contexts (courses, xblocks, etc.), this requires studio write access or + org-level admin access for the object's org. """ if not object_id: raise ValueError("object_id must be provided") @@ -290,6 +314,16 @@ def can_remove_object_tag_objectid(user: UserType, object_id: str) -> bool: except (ValueError, AssertionError): return False + # For Content Libraries V2, prefer explicit library tagging permission, + # however, org-level admins are also allowed to perform these operations. + if isinstance(context_key, LibraryLocatorV2) and authz_api.is_user_allowed( + user.username, + authz_permissions.MANAGE_LIBRARY_TAGS.identifier, + str(context_key), + ): + return True + + # For other contexts (courses, xblocks, etc.), use general write or org-admin access if has_studio_write_access(user, context_key): return True diff --git a/openedx/core/djangoapps/content_tagging/tasks.py b/openedx/core/djangoapps/content_tagging/tasks.py index bd90aad6eaba..8f67f737c2d3 100644 --- a/openedx/core/djangoapps/content_tagging/tasks.py +++ b/openedx/core/djangoapps/content_tagging/tasks.py @@ -12,7 +12,7 @@ from edx_django_utils.monitoring import set_code_owner_attribute from opaque_keys.edx.keys import CourseKey, UsageKey from opaque_keys.edx.locator import LibraryUsageLocatorV2 -from openedx_tagging.core.tagging.models import Taxonomy +from openedx_tagging.models import Taxonomy from xmodule.modulestore.django import modulestore diff --git a/openedx/core/djangoapps/content_tagging/tests/test_api.py b/openedx/core/djangoapps/content_tagging/tests/test_api.py index 2661c02fd15c..a3d965cef1c7 100644 --- a/openedx/core/djangoapps/content_tagging/tests/test_api.py +++ b/openedx/core/djangoapps/content_tagging/tests/test_api.py @@ -2,17 +2,18 @@ import io import os import tempfile + import ddt from django.test.testcases import TestCase from fs.osfs import OSFS from opaque_keys.edx.keys import CourseKey, UsageKey -from opaque_keys.edx.locator import LibraryLocatorV2, LibraryCollectionLocator, LibraryContainerLocator -from openedx_tagging.core.tagging.models import ObjectTag +from opaque_keys.edx.locator import LibraryCollectionLocator, LibraryContainerLocator, LibraryLocatorV2 +from openedx_tagging.models import ObjectTag from organizations.models import Organization -from .test_objecttag_export_helpers import TestGetAllObjectTagsMixin, TaggedCourseMixin from .. import api from ..utils import rules_cache +from .test_objecttag_export_helpers import TaggedCourseMixin, TestGetAllObjectTagsMixin class TestTaxonomyMixin: @@ -446,18 +447,18 @@ def test_export_tags_in_csv_file(self) -> None: file_path = os.path.join(file_dir_name, file_name) - self.assertTrue(os.path.exists(file_path)) + self.assertTrue(os.path.exists(file_path)) # noqa: PT009 - with open(file_path, 'r') as f: + with open(file_path, 'r') as f: # noqa: UP015 content = f.read() cleaned_content = content.replace('\r\n', '\n') cleaned_expected_csv = self.expected_csv.replace('\r\n', '\n') - self.assertEqual(cleaned_content, cleaned_expected_csv) + self.assertEqual(cleaned_content, cleaned_expected_csv) # noqa: PT009 def test_import_tags_invalid_format(self) -> None: csv_path = self._create_csv_file('invalid format, Invalid\r\ntest1, test2') - with self.assertRaises(ValueError) as exc: + with self.assertRaises(ValueError) as exc: # noqa: PT027 api.import_course_tags_from_csv(csv_path, self.course.id) assert "Invalid format of csv in" in str(exc.exception) diff --git a/openedx/core/djangoapps/content_tagging/tests/test_objecttag_export_helpers.py b/openedx/core/djangoapps/content_tagging/tests/test_objecttag_export_helpers.py index eaeea3bda225..f5525f530628 100644 --- a/openedx/core/djangoapps/content_tagging/tests/test_objecttag_export_helpers.py +++ b/openedx/core/djangoapps/content_tagging/tests/test_objecttag_export_helpers.py @@ -4,7 +4,7 @@ import time from unittest.mock import patch -from openedx_tagging.core.tagging.models import ObjectTag +from openedx_tagging.models import ObjectTag from organizations.models import Organization from openedx.core.djangoapps.content_libraries import api as library_api @@ -279,7 +279,7 @@ def setUp(self): untagged_sequential.children.append(untagged_vertical) # /Untagged blocks - vertical = BlockFactory.create( + vertical = BlockFactory.create( # noqa: F841 parent=self.sequential, category="vertical", display_name="test vertical1", @@ -442,7 +442,7 @@ def test_build_library_object_tree(self) -> None: """ Test if we can export a library """ - with self.assertNumQueries(11): + with self.assertNumQueries(10): tagged_library = build_object_tree_with_objecttags(self.library.key, self.all_library_object_tags) assert tagged_library == self.expected_library_tagged_xblock diff --git a/openedx/core/djangoapps/content_tagging/tests/test_rules.py b/openedx/core/djangoapps/content_tagging/tests/test_rules.py index d53256f510a4..4432310147c7 100644 --- a/openedx/core/djangoapps/content_tagging/tests/test_rules.py +++ b/openedx/core/djangoapps/content_tagging/tests/test_rules.py @@ -1,19 +1,20 @@ """Tests content_tagging rules-based permissions""" +from unittest.mock import patch + import ddt from django.contrib.auth import get_user_model from django.test import TestCase -from opaque_keys.edx.locator import BlockUsageLocator, CourseLocator -from openedx_tagging.core.tagging.models import ( - Tag, - UserSystemDefinedTaxonomy, -) -from openedx_tagging.core.tagging.rules import ObjectTagPermissionItem +from opaque_keys.edx.locator import BlockUsageLocator, CourseLocator, LibraryLocatorV2 +from openedx_authz.constants import permissions as authz_permissions +from openedx_tagging.models import Tag, UserSystemDefinedTaxonomy +from openedx_tagging.rules import ObjectTagPermissionItem from common.djangoapps.student.auth import add_users, update_org_role from common.djangoapps.student.roles import CourseStaffRole, OrgStaffRole from .. import api +from ..rules import can_change_object_tag_objectid, can_remove_object_tag_objectid from .test_api import TestTaxonomyMixin User = get_user_model() @@ -608,3 +609,137 @@ def test_view_object_tag_diabled(self): assert not self.user_both_orgs.has_perm(perm, self.disabled_course_tag) assert not self.user_org2.has_perm(perm, self.disabled_course_tag) assert not self.learner.has_perm(perm, self.disabled_course_tag) + + +class TestRulesLibraryV2Permissions(TestTaxonomyMixin, TestCase): + """ + Tests for Content Library V2 permissions with MANAGE_LIBRARY_TAGS. + """ + + def setUp(self): + super().setUp() + + self.library_user = User.objects.create( + username="library_user", + email="library_user@example.com", + ) + self.org_admin = User.objects.create( + username="org_admin", + email="org_admin@example.com", + ) + self.regular_user = User.objects.create( + username="regular_user", + email="regular_user@example.com", + ) + self.superuser = User.objects.create( + username="superuser", + email="superuser@example.com", + is_superuser=True, + ) + + # Make org_admin an OrgStaffRole for org1 + update_org_role( + self.superuser, + OrgStaffRole, + self.org_admin, + [self.org1.short_name], + ) + + self.library_key = LibraryLocatorV2.from_string(f"lib:{self.org1.short_name}:test_library") + + @patch("openedx_authz.api.is_user_allowed") + def test_change_objecttag_objectid_with_manage_library_tags_permission(self, mock_is_user_allowed): + """ + Test that a user with MANAGE_LIBRARY_TAGS permission can change tags on a library. + """ + mock_is_user_allowed.return_value = True + + result = can_change_object_tag_objectid(self.library_user, str(self.library_key)) + + self.assertTrue(result) # noqa: PT009 + mock_is_user_allowed.assert_called_once_with( + self.library_user.username, + authz_permissions.MANAGE_LIBRARY_TAGS.identifier, + str(self.library_key), + ) + + @patch("openedx_authz.api.is_user_allowed") + def test_change_objecttag_objectid_without_manage_library_tags_but_org_admin(self, mock_is_user_allowed): + """ + Test that an org admin can change tags on a library even without + explicit MANAGE_LIBRARY_TAGS permission. + """ + mock_is_user_allowed.return_value = False + + result = can_change_object_tag_objectid(self.org_admin, str(self.library_key)) + + self.assertTrue(result) # noqa: PT009 + + @patch("openedx_authz.api.is_user_allowed") + def test_change_objecttag_objectid_without_permissions(self, mock_is_user_allowed): + """ + Test that a regular user without MANAGE_LIBRARY_TAGS permission and + without org admin access cannot change tags. + """ + mock_is_user_allowed.return_value = False + + result = can_change_object_tag_objectid(self.regular_user, str(self.library_key)) + + self.assertFalse(result) # noqa: PT009 + + @patch("openedx_authz.api.is_user_allowed") + def test_remove_objecttag_objectid_with_manage_library_tags_permission(self, mock_is_user_allowed): + """ + Test that a user with MANAGE_LIBRARY_TAGS permission can remove tags + from a library. + """ + mock_is_user_allowed.return_value = True + + result = can_remove_object_tag_objectid(self.library_user, str(self.library_key)) + + self.assertTrue(result) # noqa: PT009 + mock_is_user_allowed.assert_called_once_with( + self.library_user.username, + authz_permissions.MANAGE_LIBRARY_TAGS.identifier, + str(self.library_key), + ) + + @patch("openedx_authz.api.is_user_allowed") + def test_remove_objecttag_objectid_without_manage_library_tags_but_org_admin(self, mock_is_user_allowed): + """ + Test that an org admin can remove tags from a library even without + explicit MANAGE_LIBRARY_TAGS permission. + """ + mock_is_user_allowed.return_value = False + + result = can_remove_object_tag_objectid(self.org_admin, str(self.library_key)) + + self.assertTrue(result) # noqa: PT009 + + @patch("openedx_authz.api.is_user_allowed") + def test_remove_objecttag_objectid_without_permissions(self, mock_is_user_allowed): + """ + Test that a regular user without MANAGE_LIBRARY_TAGS permission and + without org admin access cannot remove tags. + """ + mock_is_user_allowed.return_value = False + + result = can_remove_object_tag_objectid(self.regular_user, str(self.library_key)) + + self.assertFalse(result) # noqa: PT009 + + def test_invalid_library_key(self): + """ + Test that invalid library keys return False. + """ + self.assertFalse(can_change_object_tag_objectid(self.library_user, "invalid_key")) # noqa: PT009 + self.assertFalse(can_remove_object_tag_objectid(self.library_user, "invalid_key")) # noqa: PT009 + + def test_empty_object_id(self): + """ + Test behavior with empty object_id. + """ + self.assertTrue(can_change_object_tag_objectid(self.library_user, "")) # noqa: PT009 + + with self.assertRaises(ValueError): # noqa: PT027 + can_remove_object_tag_objectid(self.library_user, "") diff --git a/openedx/core/djangoapps/content_tagging/tests/test_tasks.py b/openedx/core/djangoapps/content_tagging/tests/test_tasks.py index 997fffbaad8e..f36f5c475e1b 100644 --- a/openedx/core/djangoapps/content_tagging/tests/test_tasks.py +++ b/openedx/core/djangoapps/content_tagging/tests/test_tasks.py @@ -5,21 +5,24 @@ from unittest.mock import patch -from django.test import override_settings, LiveServerTestCase from django.http import HttpRequest +from django.test import LiveServerTestCase, override_settings from edx_toggles.toggles.testutils import override_waffle_flag -from openedx_tagging.core.tagging.models import Tag, Taxonomy, ObjectTag +from openedx_tagging.models import ObjectTag, Tag, Taxonomy from organizations.models import Organization from common.djangoapps.student.tests.factories import UserFactory +from openedx.core.djangoapps.content_libraries.api import ( + create_library, + create_library_block, + delete_library_block, + restore_library_block, +) from openedx.core.djangolib.testing.utils import skip_unless_cms from xmodule.modulestore.tests.django_utils import ( TEST_DATA_SPLIT_MODULESTORE, - ModuleStoreTestCase, ImmediateOnCommitMixin, -) -from openedx.core.djangoapps.content_libraries.api import ( - create_library, create_library_block, delete_library_block, restore_library_block + ModuleStoreTestCase, ) from .. import api @@ -41,9 +44,9 @@ def setUp(self): running migrations. So data created by our migrations is not present. In particular, the Language Taxonomy is not present. So this mixin will create the taxonomy, simulating the effect of the following migrations: - 1. openedx_tagging.core.tagging.migrations.0012_language_taxonomy + 1. openedx_tagging.migrations.0012_language_taxonomy 2. content_tagging.migrations.0007_system_defined_org_2 - 3. openedx_tagging.core.tagging.migrations.0015_taxonomy_export_id + 3. openedx_tagging.migrations.0015_taxonomy_export_id """ super().setUp() Taxonomy.objects.get_or_create(id=-1, defaults={ @@ -54,7 +57,7 @@ def setUp(self): "allow_free_text": False, "visible_to_authors": True, "export_id": "-1_languages", - "_taxonomy_class": "openedx_tagging.core.tagging.models.system_defined.LanguageTaxonomy", + "_taxonomy_class": "openedx_tagging.models.system_defined.LanguageTaxonomy", }) TaxonomyOrg.objects.get_or_create(taxonomy_id=-1, defaults={"org": None}) @@ -285,7 +288,8 @@ def test_create_delete_restore_library_block(self): fake_request = HttpRequest() fake_request.LANGUAGE_CODE = "pt-br" - with patch('crum.get_current_request', return_value=fake_request): + # Note: self.captureOnCommitCallbacks(execute=True) is required for the library events to fire here. + with patch('crum.get_current_request', return_value=fake_request), self.captureOnCommitCallbacks(execute=True): # Create Library Block library_block = create_library_block(library.key, "problem", "Problem1") diff --git a/openedx/core/djangoapps/content_tagging/toggles.py b/openedx/core/djangoapps/content_tagging/toggles.py index 3162a529833c..a6b0a4e19afa 100644 --- a/openedx/core/djangoapps/content_tagging/toggles.py +++ b/openedx/core/djangoapps/content_tagging/toggles.py @@ -6,7 +6,6 @@ from openedx.core.djangoapps.waffle_utils import CourseWaffleFlag - # .. toggle_name: content_tagging.auto # .. toggle_implementation: CourseWaffleFlag # .. toggle_default: False diff --git a/openedx/core/djangoapps/content_tagging/types.py b/openedx/core/djangoapps/content_tagging/types.py index 6e54caa05129..2c4aac1690cb 100644 --- a/openedx/core/djangoapps/content_tagging/types.py +++ b/openedx/core/djangoapps/content_tagging/types.py @@ -3,15 +3,15 @@ """ from __future__ import annotations -from typing import Dict, List, Union +from typing import Dict, List, Union # noqa: UP035 -from opaque_keys.edx.keys import CourseKey, UsageKey, CollectionKey, ContainerKey +from opaque_keys.edx.keys import CollectionKey, ContainerKey, CourseKey, UsageKey from opaque_keys.edx.locator import LibraryLocatorV2 -from openedx_tagging.core.tagging.models import Taxonomy +from openedx_tagging.models import Taxonomy -ContentKey = Union[LibraryLocatorV2, CourseKey, UsageKey, CollectionKey, ContainerKey] -ContextKey = Union[LibraryLocatorV2, CourseKey] +ContentKey = Union[LibraryLocatorV2, CourseKey, UsageKey, CollectionKey, ContainerKey] # noqa: UP007 +ContextKey = Union[LibraryLocatorV2, CourseKey] # noqa: UP007 -TagValuesByTaxonomyIdDict = Dict[int, List[str]] -TagValuesByObjectIdDict = Dict[str, TagValuesByTaxonomyIdDict] -TaxonomyDict = Dict[int, Taxonomy] +TagValuesByTaxonomyIdDict = Dict[int, List[str]] # noqa: UP006 +TagValuesByObjectIdDict = Dict[str, TagValuesByTaxonomyIdDict] # noqa: UP006 +TaxonomyDict = Dict[int, Taxonomy] # noqa: UP006 diff --git a/openedx/core/djangoapps/content_tagging/urls.py b/openedx/core/djangoapps/content_tagging/urls.py index b81c01e1b048..fe04e8072aa2 100644 --- a/openedx/core/djangoapps/content_tagging/urls.py +++ b/openedx/core/djangoapps/content_tagging/urls.py @@ -1,7 +1,7 @@ """ Content Tagging URLs """ -from django.urls import path, include +from django.urls import include, path from .rest_api import urls diff --git a/openedx/core/djangoapps/content_tagging/utils.py b/openedx/core/djangoapps/content_tagging/utils.py index f6e488325133..658f23d16b5d 100644 --- a/openedx/core/djangoapps/content_tagging/utils.py +++ b/openedx/core/djangoapps/content_tagging/utils.py @@ -5,9 +5,9 @@ from edx_django_utils.cache import RequestCache from opaque_keys import InvalidKeyError -from opaque_keys.edx.keys import CourseKey, CollectionKey, ContainerKey, UsageKey +from opaque_keys.edx.keys import CollectionKey, ContainerKey, CourseKey, UsageKey from opaque_keys.edx.locator import LibraryLocatorV2 -from openedx_tagging.core.tagging.models import Taxonomy +from openedx_tagging.models import Taxonomy from organizations.models import Organization from .models import TaxonomyOrg diff --git a/openedx/core/djangoapps/contentserver/migrations/0001_initial.py b/openedx/core/djangoapps/contentserver/migrations/0001_initial.py index c43f49f8ce97..27755b65609f 100644 --- a/openedx/core/djangoapps/contentserver/migrations/0001_initial.py +++ b/openedx/core/djangoapps/contentserver/migrations/0001_initial.py @@ -1,9 +1,9 @@ #pylint: skip-file -from django.db import migrations, models import django.db.models.deletion from django.conf import settings +from django.db import migrations, models class Migration(migrations.Migration): diff --git a/openedx/core/djangoapps/contentserver/migrations/0002_cdnuseragentsconfig.py b/openedx/core/djangoapps/contentserver/migrations/0002_cdnuseragentsconfig.py index f0d579ff5a1a..14b25c0da126 100644 --- a/openedx/core/djangoapps/contentserver/migrations/0002_cdnuseragentsconfig.py +++ b/openedx/core/djangoapps/contentserver/migrations/0002_cdnuseragentsconfig.py @@ -1,6 +1,6 @@ -from django.db import migrations, models import django.db.models.deletion from django.conf import settings +from django.db import migrations, models class Migration(migrations.Migration): diff --git a/openedx/core/djangoapps/contentserver/test/test_contentserver.py b/openedx/core/djangoapps/contentserver/test/test_contentserver.py index df29b64d2781..63f79a748967 100644 --- a/openedx/core/djangoapps/contentserver/test/test_contentserver.py +++ b/openedx/core/djangoapps/contentserver/test/test_contentserver.py @@ -32,7 +32,7 @@ log = logging.getLogger(__name__) TEST_DATA_CONTENTSTORE = copy.deepcopy(settings.CONTENTSTORE) -TEST_DATA_CONTENTSTORE['DOC_STORE_CONFIG']['db'] = 'test_xcontent_%s' % uuid4().hex +TEST_DATA_CONTENTSTORE['DOC_STORE_CONFIG']['db'] = 'test_xcontent_%s' % uuid4().hex # noqa: UP031 TEST_DATA_DIR = settings.COMMON_TEST_DATA_ROOT FAKE_MD5_HASH = 'ffffffffffffffffffffffffffffffff' @@ -300,7 +300,7 @@ def test_range_request_full_file(self): assert resp.status_code == 206 # HTTP_206_PARTIAL_CONTENT assert resp['Content-Range'] ==\ - 'bytes {first}-{last}/{length}'.format(first=0, last=(self.length_unlocked - 1), + 'bytes {first}-{last}/{length}'.format(first=0, last=(self.length_unlocked - 1), # noqa: UP032 length=self.length_unlocked) assert resp['Content-Length'] == str(self.length_unlocked) @@ -312,12 +312,12 @@ def test_range_request_partial_file(self): """ first_byte = self.length_unlocked // 4 last_byte = self.length_unlocked // 2 - resp = self.client.get(self.url_unlocked, HTTP_RANGE='bytes={first}-{last}'.format( + resp = self.client.get(self.url_unlocked, HTTP_RANGE='bytes={first}-{last}'.format( # noqa: UP032 first=first_byte, last=last_byte)) assert resp.status_code == 206 # HTTP_206_PARTIAL_CONTENT - assert resp['Content-Range'] == 'bytes {first}-{last}/{length}'.format(first=first_byte, + assert resp['Content-Range'] == 'bytes {first}-{last}/{length}'.format(first=first_byte, # noqa: UP032 last=last_byte, length=self.length_unlocked) assert resp['Content-Length'] == str((last_byte - first_byte) + 1) @@ -328,7 +328,7 @@ def test_range_request_multiple_ranges(self): """ first_byte = self.length_unlocked / 4 last_byte = self.length_unlocked / 2 - resp = self.client.get(self.url_unlocked, HTTP_RANGE='bytes={first}-{last}, -100'.format( + resp = self.client.get(self.url_unlocked, HTTP_RANGE='bytes={first}-{last}, -100'.format( # noqa: UP032 first=first_byte, last=last_byte)) assert resp.status_code == 200 @@ -354,7 +354,7 @@ def test_range_request_malformed_invalid_range(self): Test that a range request with malformed Range (first_byte > last_byte) outputs 416 Requested Range Not Satisfiable. """ - resp = self.client.get(self.url_unlocked, HTTP_RANGE='bytes={first}-{last}'.format( + resp = self.client.get(self.url_unlocked, HTTP_RANGE='bytes={first}-{last}'.format( # noqa: UP032 first=(self.length_unlocked // 2), last=(self.length_unlocked // 4))) assert resp.status_code == 416 @@ -363,7 +363,7 @@ def test_range_request_malformed_out_of_bounds(self): Test that a range request with malformed Range (first_byte, last_byte == totalLength, offset by 1 error) outputs 416 Requested Range Not Satisfiable. """ - resp = self.client.get(self.url_unlocked, HTTP_RANGE='bytes={first}-{last}'.format( + resp = self.client.get(self.url_unlocked, HTTP_RANGE='bytes={first}-{last}'.format( # noqa: UP032 first=(self.length_unlocked), last=(self.length_unlocked))) assert resp.status_code == 416 @@ -526,6 +526,6 @@ def test_valid_syntax(self, header_value, excepted_ranges_length, expected_range ) @ddt.unpack def test_invalid_syntax(self, header_value, exception_class, exception_message_regex): - self.assertRaisesRegex( + self.assertRaisesRegex( # noqa: PT027 exception_class, exception_message_regex, views.parse_range_header, header_value, self.content_length ) diff --git a/openedx/core/djangoapps/contentserver/views.py b/openedx/core/djangoapps/contentserver/views.py index cbdb4124fef7..be985d5b0680 100644 --- a/openedx/core/djangoapps/contentserver/views.py +++ b/openedx/core/djangoapps/contentserver/views.py @@ -14,7 +14,7 @@ HttpResponseForbidden, HttpResponseNotFound, HttpResponseNotModified, - HttpResponsePermanentRedirect + HttpResponsePermanentRedirect, ) from django.views.decorators.http import require_safe from edx_django_utils.monitoring import set_custom_attribute @@ -169,7 +169,7 @@ def process_request(request): if 0 <= first <= last < content.length: # If the byte range is satisfiable response = HttpResponse(content.stream_data_in_range(first, last)) - response['Content-Range'] = 'bytes {first}-{last}/{length}'.format( + response['Content-Range'] = 'bytes {first}-{last}/{length}'.format( # noqa: UP032 first=first, last=last, length=content.length ) response['Content-Length'] = str(last - first + 1) @@ -226,7 +226,7 @@ def set_caching_headers(content, location, response): set_custom_attribute('contentserver.cacheable', True) response['Expires'] = get_expiration_value(datetime.datetime.utcnow(), cache_ttl) - response['Cache-Control'] = "public, max-age={ttl}, s-maxage={ttl}".format(ttl=cache_ttl) + response['Cache-Control'] = "public, max-age={ttl}, s-maxage={ttl}".format(ttl=cache_ttl) # noqa: UP032 elif is_restricted: set_custom_attribute('contentserver.cacheable', False) @@ -365,7 +365,7 @@ def parse_range_header(header_value, content_length): for byte_range_string in byte_ranges_string.split(','): byte_range_string = byte_range_string.strip() # Case 0: - if '-' not in byte_range_string: # Invalid syntax of header value. # lint-amnesty, pylint: disable=no-else-raise + if '-' not in byte_range_string: # Invalid syntax of header value. # pylint: disable=no-else-raise raise ValueError('Invalid syntax.') # Case 1: -500 elif byte_range_string.startswith('-'): diff --git a/openedx/core/djangoapps/cors_csrf/middleware.py b/openedx/core/djangoapps/cors_csrf/middleware.py index 8122231e32ef..1bd8accf2709 100644 --- a/openedx/core/djangoapps/cors_csrf/middleware.py +++ b/openedx/core/djangoapps/cors_csrf/middleware.py @@ -52,7 +52,6 @@ from .helpers import is_cross_domain_request_allowed, skip_cross_domain_referer_check - log = logging.getLogger(__name__) diff --git a/openedx/core/djangoapps/cors_csrf/migrations/0001_initial.py b/openedx/core/djangoapps/cors_csrf/migrations/0001_initial.py index 46c0f759f559..4c09f5e598de 100644 --- a/openedx/core/djangoapps/cors_csrf/migrations/0001_initial.py +++ b/openedx/core/djangoapps/cors_csrf/migrations/0001_initial.py @@ -1,6 +1,6 @@ -from django.db import migrations, models import django.db.models.deletion from django.conf import settings +from django.db import migrations, models class Migration(migrations.Migration): diff --git a/openedx/core/djangoapps/cors_csrf/models.py b/openedx/core/djangoapps/cors_csrf/models.py index 386bdf228003..11a287b8dfe6 100644 --- a/openedx/core/djangoapps/cors_csrf/models.py +++ b/openedx/core/djangoapps/cors_csrf/models.py @@ -3,7 +3,6 @@ from config_models.models import ConfigurationModel from django.db import models - from django.utils.translation import gettext_lazy as _ diff --git a/openedx/core/djangoapps/cors_csrf/tests/test_authentication.py b/openedx/core/djangoapps/cors_csrf/tests/test_authentication.py index 1de265b0a81d..237e341bcd8d 100644 --- a/openedx/core/djangoapps/cors_csrf/tests/test_authentication.py +++ b/openedx/core/djangoapps/cors_csrf/tests/test_authentication.py @@ -3,12 +3,11 @@ from unittest.mock import patch +from django.conf import settings from django.middleware.csrf import get_token from django.test import TestCase -from django.test.utils import override_settings from django.test.client import RequestFactory -from django.conf import settings - +from django.test.utils import override_settings from rest_framework.exceptions import PermissionDenied from ..authentication import SessionAuthenticationCrossDomainCsrf @@ -32,7 +31,7 @@ def setUp(self): def test_perform_csrf_referer_check(self): request = self._fake_request() - with self.assertRaisesRegex(PermissionDenied, 'CSRF'): + with self.assertRaisesRegex(PermissionDenied, 'CSRF'): # noqa: PT027 self.auth.enforce_csrf(request) @patch.dict(settings.FEATURES, { diff --git a/openedx/core/djangoapps/cors_csrf/tests/test_decorators.py b/openedx/core/djangoapps/cors_csrf/tests/test_decorators.py index 917b62e0e531..a43a90b5420b 100644 --- a/openedx/core/djangoapps/cors_csrf/tests/test_decorators.py +++ b/openedx/core/djangoapps/cors_csrf/tests/test_decorators.py @@ -13,7 +13,7 @@ def fake_view(request): """Fake view that returns the request META as a JSON-encoded string. """ - return HttpResponse(json.dumps(request.META)) # lint-amnesty, pylint: disable=http-response-with-json-dumps + return HttpResponse(json.dumps(request.META)) # pylint: disable=http-response-with-json-dumps class TestEnsureCsrfCookieCrossDomain(TestCase): diff --git a/openedx/core/djangoapps/cors_csrf/tests/test_middleware.py b/openedx/core/djangoapps/cors_csrf/tests/test_middleware.py index 119824607ded..9262dcec7f53 100644 --- a/openedx/core/djangoapps/cors_csrf/tests/test_middleware.py +++ b/openedx/core/djangoapps/cors_csrf/tests/test_middleware.py @@ -3,18 +3,18 @@ """ -from unittest.mock import patch, Mock +from unittest.mock import Mock, patch + import ddt import pytest -from django.test import TestCase -from django.test.utils import override_settings -from django.core.exceptions import MiddlewareNotUsed, ImproperlyConfigured +from django.core.exceptions import ImproperlyConfigured, MiddlewareNotUsed from django.http import HttpResponse from django.middleware.csrf import CsrfViewMiddleware +from django.test import TestCase +from django.test.utils import override_settings from ..middleware import CorsCSRFMiddleware, CsrfCrossDomainCookieMiddleware - SENTINEL = object() @@ -271,7 +271,7 @@ def _assert_cookie_sent(self, response, is_set): assert self.COOKIE_NAME in response.cookies cookie_header = str(response.cookies[self.COOKIE_NAME]) - expected = 'Set-Cookie: {name}={value}; Domain={domain};'.format( + expected = 'Set-Cookie: {name}={value}; Domain={domain};'.format( # noqa: UP032 name=self.COOKIE_NAME, value=self.COOKIE_VALUE, domain=self.COOKIE_DOMAIN diff --git a/openedx/core/djangoapps/cors_csrf/tests/test_views.py b/openedx/core/djangoapps/cors_csrf/tests/test_views.py index a5f7c31b8800..c780a7fd6acc 100644 --- a/openedx/core/djangoapps/cors_csrf/tests/test_views.py +++ b/openedx/core/djangoapps/cors_csrf/tests/test_views.py @@ -3,12 +3,11 @@ import json -from django.conf import settings -from django.urls import NoReverseMatch, reverse -from django.test import TestCase - import ddt from config_models.models import cache +from django.conf import settings +from django.test import TestCase +from django.urls import NoReverseMatch, reverse from openedx.core.djangolib.testing.utils import skip_unless_lms diff --git a/openedx/core/djangoapps/course_apps/api.py b/openedx/core/djangoapps/course_apps/api.py index acd2c8f552be..74fc157c0ebb 100644 --- a/openedx/core/djangoapps/course_apps/api.py +++ b/openedx/core/djangoapps/course_apps/api.py @@ -3,12 +3,12 @@ """ from django.contrib.auth import get_user_model from opaque_keys.edx.keys import CourseKey + from openedx.core.djangoapps.course_apps.models import CourseAppStatus from .plugins import CourseAppsPluginManager from .signals import COURSE_APP_STATUS_INIT - User = get_user_model() diff --git a/openedx/core/djangoapps/course_apps/apps.py b/openedx/core/djangoapps/course_apps/apps.py index 87c1bde6ad47..32f9646af9f5 100644 --- a/openedx/core/djangoapps/course_apps/apps.py +++ b/openedx/core/djangoapps/course_apps/apps.py @@ -25,4 +25,4 @@ class CourseAppsConfig(AppConfig): def ready(self): # Connect signal handlers - from . import handlers # pylint: disable=unused-import + from . import handlers # pylint: disable=unused-import # noqa: F401 diff --git a/openedx/core/djangoapps/course_apps/docs/decisions/001-course-apps.rst b/openedx/core/djangoapps/course_apps/docs/decisions/001-course-apps.rst index 4491779a2751..cccd0eba8776 100644 --- a/openedx/core/djangoapps/course_apps/docs/decisions/001-course-apps.rst +++ b/openedx/core/djangoapps/course_apps/docs/decisions/001-course-apps.rst @@ -105,14 +105,14 @@ check. Course App Plugin Class ======================= -To be loaded as a Course App, you need to provide an entrypoint in ``setup.py`` +To be loaded as a Course App, you need to provide an entrypoint in ``pyproject.toml`` with the namespace ``openedx.course_app``. The entry should point to a Python class with the following basic structure: .. code-block:: python class CourseApp: - # The app id should match what is specified in the setup.py entrypoint + # The app id should match what is specified in the pyproject.toml entrypoint app_id: str = 'wiki' name: str = 'Wiki' description: str = 'A short description of what the Wiki does.' diff --git a/openedx/core/djangoapps/course_apps/handlers.py b/openedx/core/djangoapps/course_apps/handlers.py index c116ffce6557..8a93986a20ee 100644 --- a/openedx/core/djangoapps/course_apps/handlers.py +++ b/openedx/core/djangoapps/course_apps/handlers.py @@ -4,6 +4,7 @@ from django.db import transaction from django.dispatch import receiver from opaque_keys.edx.keys import CourseKey + from xmodule.modulestore.django import SignalHandler from .models import CourseAppStatus diff --git a/openedx/core/djangoapps/course_apps/migrations/0001_initial.py b/openedx/core/djangoapps/course_apps/migrations/0001_initial.py index 2376f9dd9d30..95ae30bbd8b3 100644 --- a/openedx/core/djangoapps/course_apps/migrations/0001_initial.py +++ b/openedx/core/djangoapps/course_apps/migrations/0001_initial.py @@ -1,12 +1,12 @@ # Generated by Django 2.2.24 on 2021-07-13 07:48 -from django.conf import settings -from django.db import migrations, models import django.db.models.deletion import django.utils.timezone import model_utils.fields import opaque_keys.edx.django.models import simple_history.models +from django.conf import settings +from django.db import migrations, models class Migration(migrations.Migration): diff --git a/openedx/core/djangoapps/course_apps/models.py b/openedx/core/djangoapps/course_apps/models.py index f23c9b606f0e..d1100bf365ec 100644 --- a/openedx/core/djangoapps/course_apps/models.py +++ b/openedx/core/djangoapps/course_apps/models.py @@ -1,7 +1,7 @@ """ Models to store course apps data. """ -from typing import Dict +from typing import Dict # noqa: UP035 from django.db import models from model_utils.models import TimeStampedModel @@ -27,7 +27,7 @@ def __str__(self): return f'CourseAppStatus(course_key="{self.course_key}", app_id="{self.app_id}", enabled="{self.enabled})"' @classmethod - def get_all_app_status_data_for_course(cls, course_key: CourseKey) -> Dict[str, bool]: + def get_all_app_status_data_for_course(cls, course_key: CourseKey) -> Dict[str, bool]: # noqa: UP006 """ Get a dictionary containing the status of all apps linked to the course. diff --git a/openedx/core/djangoapps/course_apps/plugins.py b/openedx/core/djangoapps/course_apps/plugins.py index 183c7a2396d6..0a416310853f 100644 --- a/openedx/core/djangoapps/course_apps/plugins.py +++ b/openedx/core/djangoapps/course_apps/plugins.py @@ -1,13 +1,12 @@ """ Course Apps plugin base class and plugin manager. """ -from typing import Dict, Iterator, Optional - from abc import ABC, abstractmethod +from typing import Dict, Iterator, Optional # noqa: UP035 + from edx_django_utils.plugins import PluginManager from opaque_keys.edx.keys import CourseKey - # Stevedore extension point namespaces COURSE_APPS_PLUGIN_NAMESPACE = "openedx.course_app" @@ -24,7 +23,7 @@ class CourseApp(ABC): # A description for the app. description: str = "" # A map of documentation links for the app - documentation_links: Dict = { + documentation_links: Dict = { # noqa: UP006 # eg: # "learn_more_configuration": "https://..." } @@ -61,7 +60,7 @@ def is_enabled(cls, course_key: CourseKey) -> bool: @classmethod @abstractmethod - def set_enabled(cls, course_key: CourseKey, enabled: bool, user: 'User') -> bool: + def set_enabled(cls, course_key: CourseKey, enabled: bool, user: 'User') -> bool: # noqa: F821 """ Update the status of this app for the provided course and return the new status. @@ -76,7 +75,7 @@ def set_enabled(cls, course_key: CourseKey, enabled: bool, user: 'User') -> bool @classmethod @abstractmethod - def get_allowed_operations(cls, course_key: CourseKey, user: Optional['User'] = None) -> Dict[str, bool]: + def get_allowed_operations(cls, course_key: CourseKey, user: Optional['User'] = None) -> Dict[str, bool]: # noqa: F821, UP006 # pylint: disable=line-too-long """ Returns a dictionary of available operations for this app. diff --git a/openedx/core/djangoapps/course_apps/rest_api/tests/test_views.py b/openedx/core/djangoapps/course_apps/rest_api/tests/test_views.py index 768643a7a204..b2a509a7ead0 100644 --- a/openedx/core/djangoapps/course_apps/rest_api/tests/test_views.py +++ b/openedx/core/djangoapps/course_apps/rest_api/tests/test_views.py @@ -8,13 +8,14 @@ import ddt from django.test import Client from django.urls import reverse -from xmodule.modulestore import ModuleStoreEnum -from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase -from xmodule.modulestore.tests.factories import CourseFactory from common.djangoapps.student.roles import CourseStaffRole from common.djangoapps.student.tests.factories import UserFactory from openedx.core.djangolib.testing.utils import skip_unless_cms +from xmodule.modulestore import ModuleStoreEnum +from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase +from xmodule.modulestore.tests.factories import CourseFactory + from ...tests.utils import make_test_course_app diff --git a/openedx/core/djangoapps/course_apps/rest_api/tests/test_views_permissions.py b/openedx/core/djangoapps/course_apps/rest_api/tests/test_views_permissions.py new file mode 100644 index 000000000000..968a62a3414d --- /dev/null +++ b/openedx/core/djangoapps/course_apps/rest_api/tests/test_views_permissions.py @@ -0,0 +1,102 @@ +""" +Integration tests verifying authz permissions for CourseAppsView. +""" +import contextlib +from unittest import mock + +from django.urls import reverse +from openedx_authz.constants.roles import COURSE_AUDITOR, COURSE_LIMITED_STAFF, COURSE_STAFF +from rest_framework.test import APIClient + +from common.djangoapps.student.tests.factories import UserFactory +from openedx.core.djangoapps.authz.tests.mixins import CourseAuthoringAuthzTestMixin +from openedx.core.djangolib.testing.utils import skip_unless_cms +from xmodule.modulestore import ModuleStoreEnum +from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase +from xmodule.modulestore.tests.factories import CourseFactory + +from ...tests.utils import make_test_course_app + + +@skip_unless_cms +class CourseAppsAuthzTest(CourseAuthoringAuthzTestMixin, SharedModuleStoreTestCase): + """ + Integration tests for CourseAppsView authz permissions. + """ + + @classmethod + def setUpClass(cls): + super().setUpClass() + cls.course = CourseFactory.create(default_store=ModuleStoreEnum.Type.split) + + def setUp(self): + super().setUp() + self.url = reverse('course_apps_api:v1:course_apps', kwargs={'course_id': self.course.id}) + + @contextlib.contextmanager + def _setup_plugin_mock(self): + """Patch get_available_plugins to return a test plugin.""" + patcher = mock.patch('openedx.core.djangoapps.course_apps.plugins.PluginManager.get_available_plugins') + mock_plugins = patcher.start() + mock_plugins.return_value = { + 'app1': make_test_course_app(app_id='app1', name='App One', is_available=True), + } + yield + patcher.stop() + + # --- GET - requires courses.view_pages_and_resources --- + + def test_staff_can_list_apps(self): + self.add_user_to_role_in_course(self.authorized_user, COURSE_STAFF.external_key, self.course.id) + with self._setup_plugin_mock(): + resp = self.authorized_client.get(self.url) + assert resp.status_code == 200 + + def test_auditor_can_list_apps(self): + self.add_user_to_role_in_course(self.authorized_user, COURSE_AUDITOR.external_key, self.course.id) + with self._setup_plugin_mock(): + resp = self.authorized_client.get(self.url) + assert resp.status_code == 200 + + def test_limited_staff_cannot_list_apps(self): + self.add_user_to_role_in_course(self.authorized_user, COURSE_LIMITED_STAFF.external_key, self.course.id) + resp = self.authorized_client.get(self.url) + assert resp.status_code == 403 + + def test_unauthorized_cannot_list_apps(self): + resp = self.unauthorized_client.get(self.url) + assert resp.status_code == 403 + + # --- PATCH - requires courses.manage_pages_and_resources --- + + def test_staff_can_toggle_app(self): + """Asserts not-403 rather than 200 because the test plugin may not fully process the toggle.""" + self.add_user_to_role_in_course(self.authorized_user, COURSE_STAFF.external_key, self.course.id) + with self._setup_plugin_mock(): + resp = self.authorized_client.patch( + self.url, data={'id': 'app1', 'enabled': True}, format='json', + ) + assert resp.status_code != 403 + + def test_auditor_cannot_toggle_app(self): + self.add_user_to_role_in_course(self.authorized_user, COURSE_AUDITOR.external_key, self.course.id) + resp = self.authorized_client.patch( + self.url, data={'id': 'app1', 'enabled': True}, format='json', + ) + assert resp.status_code == 403 + + def test_unauthorized_cannot_toggle_app(self): + resp = self.unauthorized_client.patch( + self.url, data={'id': 'app1', 'enabled': True}, format='json', + ) + assert resp.status_code == 403 + + # --- Superuser bypass --- + + def test_superuser_can_list_apps(self): + superuser = UserFactory(is_superuser=True) + client = APIClient() + client.force_authenticate(user=superuser) + with self._setup_plugin_mock(): + resp = client.get(self.url) + assert resp.status_code == 200 diff --git a/openedx/core/djangoapps/course_apps/rest_api/urls.py b/openedx/core/djangoapps/course_apps/rest_api/urls.py index c4e47b068b41..c93e2d156e3c 100644 --- a/openedx/core/djangoapps/course_apps/rest_api/urls.py +++ b/openedx/core/djangoapps/course_apps/rest_api/urls.py @@ -2,6 +2,7 @@ API urls for course app v1 APIs. """ from django.urls import include, path + from .v1 import urls as v1_apis urlpatterns = [ diff --git a/openedx/core/djangoapps/course_apps/rest_api/v1/urls.py b/openedx/core/djangoapps/course_apps/rest_api/v1/urls.py index 95d5c6e89fac..aa62c5ce14c2 100644 --- a/openedx/core/djangoapps/course_apps/rest_api/v1/urls.py +++ b/openedx/core/djangoapps/course_apps/rest_api/v1/urls.py @@ -1,7 +1,8 @@ -# lint-amnesty, pylint: disable=missing-module-docstring +# pylint: disable=missing-module-docstring from django.urls import re_path from openedx.core.constants import COURSE_ID_PATTERN + from .views import CourseAppsView app_name = "openedx.core.djangoapps.course_apps" diff --git a/openedx/core/djangoapps/course_apps/rest_api/v1/views.py b/openedx/core/djangoapps/course_apps/rest_api/v1/views.py index 511dd4d956b4..6c34376cdcaf 100644 --- a/openedx/core/djangoapps/course_apps/rest_api/v1/views.py +++ b/openedx/core/djangoapps/course_apps/rest_api/v1/views.py @@ -1,6 +1,6 @@ # pylint: disable=missing-module-docstring import logging -from typing import Dict +from typing import Dict # noqa: UP035 from django.contrib.auth import get_user_model from edx_api_doc_tools import path_parameter, schema @@ -8,16 +8,22 @@ from edx_rest_framework_extensions.auth.jwt.authentication import JwtAuthentication from edx_rest_framework_extensions.auth.session.authentication import SessionAuthenticationAllowInactiveUser from opaque_keys.edx.keys import CourseKey +from openedx_authz.constants.permissions import ( + COURSES_MANAGE_PAGES_AND_RESOURCES, + COURSES_VIEW_PAGES_AND_RESOURCES, +) from rest_framework import serializers, views from rest_framework.exceptions import ValidationError from rest_framework.permissions import BasePermission from rest_framework.request import Request from rest_framework.response import Response -from common.djangoapps.student.auth import has_studio_write_access +from openedx.core.djangoapps.authz.constants import LegacyAuthoringPermission +from openedx.core.djangoapps.authz.decorators import user_has_course_permission from openedx.core.djangoapps.course_apps.models import CourseAppStatus from openedx.core.lib.api.authentication import BearerAuthenticationAllowInactiveUser from openedx.core.lib.api.view_utils import DeveloperErrorViewMixin, validate_course_key, verify_course_exists + from ...api import is_course_app_enabled, set_course_app_enabled from ...plugins import CourseApp, CourseAppsPluginManager @@ -25,19 +31,24 @@ log = logging.getLogger(__name__) -class HasStudioWriteAccess(BasePermission): +class HasPagesAndResourcesAccess(BasePermission): """ - Check if the user has write access to studio. + Check if the user has access to Pages & Resources. + + Uses authz permissions when the feature flag is enabled, + falling back to legacy studio access. + GET requests check view permission, all others check manage permission. """ def has_permission(self, request, view): - """ - Check if the user has write access to studio. - """ user = request.user course_key_string = view.kwargs.get("course_id") course_key = validate_course_key(course_key_string) - return has_studio_write_access(user, course_key) + if request.method == 'GET': + authz_perm = COURSES_VIEW_PAGES_AND_RESOURCES.identifier + else: + authz_perm = COURSES_MANAGE_PAGES_AND_RESOURCES.identifier + return user_has_course_permission(user, authz_perm, course_key, LegacyAuthoringPermission.WRITE) class CourseAppSerializer(serializers.Serializer): # pylint: disable=abstract-method @@ -59,7 +70,7 @@ class CourseAppSerializer(serializers.Serializer): # pylint: disable=abstract-m help_text="What all operations are supported by the app.", ) - def to_representation(self, instance: CourseApp) -> Dict: + def to_representation(self, instance: CourseApp) -> Dict: # noqa: UP006 course_key = self.context.get("course_key") request = self.context.get("request") app_status = self.context.get("app_status") @@ -87,7 +98,7 @@ class CourseAppsView(DeveloperErrorViewMixin, views.APIView): BearerAuthenticationAllowInactiveUser, SessionAuthenticationAllowInactiveUser, ) - permission_classes = (HasStudioWriteAccess,) + permission_classes = (HasPagesAndResourcesAccess,) @schema( parameters=[ diff --git a/openedx/core/djangoapps/course_apps/tests/test_api.py b/openedx/core/djangoapps/course_apps/tests/test_api.py index a8a72672ea63..44005a26aab2 100644 --- a/openedx/core/djangoapps/course_apps/tests/test_api.py +++ b/openedx/core/djangoapps/course_apps/tests/test_api.py @@ -7,10 +7,11 @@ import ddt from django.test import TestCase from opaque_keys.edx.locator import CourseLocator + from openedx.core.djangoapps.course_apps.models import CourseAppStatus -from .utils import make_test_course_app from ..api import is_course_app_enabled, set_course_app_enabled +from .utils import make_test_course_app @ddt.ddt diff --git a/openedx/core/djangoapps/course_apps/tests/test_notes_app.py b/openedx/core/djangoapps/course_apps/tests/test_notes_app.py index db2d3563b821..2ef5a26e0fe1 100644 --- a/openedx/core/djangoapps/course_apps/tests/test_notes_app.py +++ b/openedx/core/djangoapps/course_apps/tests/test_notes_app.py @@ -8,7 +8,9 @@ from lms.djangoapps.edxnotes.plugins import EdxNotesCourseApp from openedx.core.djangoapps.course_apps.tests.utils import TabBasedCourseAppTestMixin from openedx.core.djangolib.testing.utils import skip_unless_cms -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + ModuleStoreTestCase, # pylint: disable=wrong-import-order +) @skip_unless_cms diff --git a/openedx/core/djangoapps/course_apps/tests/test_proctoring_app.py b/openedx/core/djangoapps/course_apps/tests/test_proctoring_app.py index 55bea1de4089..23dfe39202f5 100644 --- a/openedx/core/djangoapps/course_apps/tests/test_proctoring_app.py +++ b/openedx/core/djangoapps/course_apps/tests/test_proctoring_app.py @@ -8,8 +8,11 @@ from lms.djangoapps.courseware.plugins import ProctoringCourseApp from openedx.core.djangolib.testing.utils import skip_unless_cms -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase, CourseUserType # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( # pylint: disable=wrong-import-order + CourseUserType, + ModuleStoreTestCase, +) +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order @skip_unless_cms @@ -56,7 +59,7 @@ def test_proctoring_app_set_enabled(self): """ Test that setting enable status on proctoring app should raise exception. """ - with self.assertRaisesRegex(ValueError, "Proctoring cannot be enabled/disabled via this API."): + with self.assertRaisesRegex(ValueError, "Proctoring cannot be enabled/disabled via this API."): # noqa: PT027 ProctoringCourseApp().set_enabled( course_key=self.course.id, enabled=True, diff --git a/openedx/core/djangoapps/course_apps/tests/test_wiki_app.py b/openedx/core/djangoapps/course_apps/tests/test_wiki_app.py index 0119f3a79aca..0045df44c8a1 100644 --- a/openedx/core/djangoapps/course_apps/tests/test_wiki_app.py +++ b/openedx/core/djangoapps/course_apps/tests/test_wiki_app.py @@ -5,7 +5,9 @@ from lms.djangoapps.course_wiki.plugins.course_app import WikiCourseApp from openedx.core.djangoapps.course_apps.tests.utils import TabBasedCourseAppTestMixin from openedx.core.djangolib.testing.utils import skip_unless_cms -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + ModuleStoreTestCase, # pylint: disable=wrong-import-order +) @skip_unless_cms diff --git a/openedx/core/djangoapps/course_apps/tests/utils.py b/openedx/core/djangoapps/course_apps/tests/utils.py index 962593ee425c..b16cffb63b7f 100644 --- a/openedx/core/djangoapps/course_apps/tests/utils.py +++ b/openedx/core/djangoapps/course_apps/tests/utils.py @@ -1,15 +1,15 @@ """ Test utilities for course apps. """ -from typing import Type +from typing import Type # noqa: UP035 from opaque_keys.edx.keys import CourseKey from common.djangoapps.student.tests.factories import AdminFactory, CourseEnrollmentFactory, UserFactory from openedx.core.djangoapps.course_apps.plugins import CourseApp from openedx.core.djangolib.testing.utils import skip_unless_cms -from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order def make_test_course_app( @@ -17,7 +17,7 @@ def make_test_course_app( name: str = "Test Course App", description: str = "Test Course App Description", is_available: bool = True, -) -> Type[CourseApp]: +) -> Type[CourseApp]: # noqa: UP006 """ Creates a test plugin entrypoint based on provided parameters.""" @@ -47,7 +47,7 @@ def get_allowed_operations(cls, course_key, user=None): # pylint=disable=unused } @classmethod - def set_enabled(cls, course_key: CourseKey, enabled: bool, user: 'User') -> bool: + def set_enabled(cls, course_key: CourseKey, enabled: bool, user: 'User') -> bool: # noqa: F821 cls._enabled[course_key] = enabled return enabled diff --git a/openedx/core/djangoapps/course_date_signals/admin.py b/openedx/core/djangoapps/course_date_signals/admin.py index b317a1acc718..3e2f9f06aeb9 100644 --- a/openedx/core/djangoapps/course_date_signals/admin.py +++ b/openedx/core/djangoapps/course_date_signals/admin.py @@ -9,5 +9,4 @@ from .models import SelfPacedRelativeDatesConfig - admin.site.register(SelfPacedRelativeDatesConfig, StackedConfigModelAdmin) diff --git a/openedx/core/djangoapps/course_date_signals/apps.py b/openedx/core/djangoapps/course_date_signals/apps.py index 97a6580eee0c..da16956b7750 100644 --- a/openedx/core/djangoapps/course_date_signals/apps.py +++ b/openedx/core/djangoapps/course_date_signals/apps.py @@ -5,11 +5,11 @@ from django.apps import AppConfig -class CourseDatesSignalsConfig(AppConfig): # lint-amnesty, pylint: disable=missing-class-docstring +class CourseDatesSignalsConfig(AppConfig): # pylint: disable=missing-class-docstring name = 'openedx.core.djangoapps.course_date_signals' def ready(self): """ Connect handlers to signals. """ - from . import handlers # lint-amnesty, pylint: disable=unused-import, unused-variable + from . import handlers # pylint: disable=unused-import, unused-variable # noqa: F401 diff --git a/openedx/core/djangoapps/course_date_signals/handlers.py b/openedx/core/djangoapps/course_date_signals/handlers.py index 6f3f4ed9a713..62626e85aaac 100644 --- a/openedx/core/djangoapps/course_date_signals/handlers.py +++ b/openedx/core/djangoapps/course_date_signals/handlers.py @@ -1,8 +1,8 @@ """Signal handlers for writing course dates into edx_when.""" -from datetime import timedelta import logging +from datetime import timedelta from django.dispatch import receiver from edx_when.api import FIELDS_TO_EXTRACT, set_dates_for_course @@ -10,9 +10,9 @@ from cms.djangoapps.contentstore.config.waffle import CUSTOM_RELATIVE_DATES from openedx.core.lib.graph_traversals import get_children, leaf_filter, traverse_pre_order -from xmodule.modulestore import ModuleStoreEnum # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.django import SignalHandler, modulestore # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.util.misc import is_xblock_an_assignment # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore import ModuleStoreEnum # pylint: disable=wrong-import-order +from xmodule.modulestore.django import SignalHandler, modulestore # pylint: disable=wrong-import-order +from xmodule.util.misc import is_xblock_an_assignment # pylint: disable=wrong-import-order from .models import SelfPacedRelativeDatesConfig from .utils import spaced_out_sections @@ -33,12 +33,12 @@ def _field_values(fields, xblock): try: result[field.name] = field.read_from(xblock) except TypeError as exception: - exception_message = "{message}, Block-location:{location}, Field-name:{field_name}".format( + exception_message = "{message}, Block-location:{location}, Field-name:{field_name}".format( # noqa: UP032 # pylint: disable=line-too-long message=str(exception), location=str(xblock.location), field_name=field.name ) - raise TypeError(exception_message) # lint-amnesty, pylint: disable=raise-missing-from + raise TypeError(exception_message) # pylint: disable=raise-missing-from # noqa: B904 return result @@ -53,7 +53,7 @@ def _has_assignment_blocks(item): ) -def _gather_graded_items(root, due): # lint-amnesty, pylint: disable=missing-function-docstring +def _gather_graded_items(root, due): # pylint: disable=missing-function-docstring items = [root] has_non_ora_scored_content = False collected_items = [] diff --git a/openedx/core/djangoapps/course_date_signals/tests.py b/openedx/core/djangoapps/course_date_signals/tests.py index ee1e95b7b5a2..938949ce2703 100644 --- a/openedx/core/djangoapps/course_date_signals/tests.py +++ b/openedx/core/djangoapps/course_date_signals/tests.py @@ -1,24 +1,24 @@ -# lint-amnesty, pylint: disable=missing-module-docstring +# pylint: disable=missing-module-docstring from datetime import timedelta -from unittest.mock import patch # lint-amnesty, pylint: disable=wrong-import-order +from unittest.mock import patch # pylint: disable=wrong-import-order from edx_toggles.toggles.testutils import override_waffle_flag -from xmodule.modulestore.tests.django_utils import TEST_DATA_SPLIT_MODULESTORE, ModuleStoreTestCase -from xmodule.modulestore.tests.factories import CourseFactory, BlockFactory from cms.djangoapps.contentstore.config.waffle import CUSTOM_RELATIVE_DATES from openedx.core.djangoapps.course_date_signals.handlers import ( _gather_graded_items, _get_custom_pacing_children, _has_assignment_blocks, - extract_dates_from_course + extract_dates_from_course, ) from openedx.core.djangoapps.course_date_signals.models import SelfPacedRelativeDatesConfig +from xmodule.modulestore.tests.django_utils import TEST_DATA_SPLIT_MODULESTORE, ModuleStoreTestCase +from xmodule.modulestore.tests.factories import BlockFactory, CourseFactory from . import utils -class SelfPacedDueDatesTests(ModuleStoreTestCase): # lint-amnesty, pylint: disable=missing-class-docstring +class SelfPacedDueDatesTests(ModuleStoreTestCase): # pylint: disable=missing-class-docstring MODULESTORE = TEST_DATA_SPLIT_MODULESTORE def setUp(self): @@ -37,7 +37,7 @@ def test_basic_spacing(self): (3, 'Section 3', timedelta(days=28)), ] with patch.object(utils, 'get_expected_duration', return_value=timedelta(weeks=4)): - actual = [(idx, section.display_name, offset) for (idx, section, offset) in utils.spaced_out_sections(self.course)] # lint-amnesty, pylint: disable=line-too-long + actual = [(idx, section.display_name, offset) for (idx, section, offset) in utils.spaced_out_sections(self.course)] # pylint: disable=line-too-long assert actual == expected_sections @@ -51,7 +51,7 @@ def test_hidden_sections(self): (3, 'Section 3', timedelta(days=28)), ] with patch.object(utils, 'get_expected_duration', return_value=timedelta(weeks=4)): - actual = [(idx, section.display_name, offset) for (idx, section, offset) in utils.spaced_out_sections(self.course)] # lint-amnesty, pylint: disable=line-too-long + actual = [(idx, section.display_name, offset) for (idx, section, offset) in utils.spaced_out_sections(self.course)] # pylint: disable=line-too-long assert actual == expected_sections @@ -128,7 +128,7 @@ def test_sequence_with_graded_and_ungraded_assignments(self): (graded_problem_1.location, {'due': 5}), ] sequence = self.store.get_item(sequence.location) - self.assertCountEqual(_gather_graded_items(sequence, 5), expected_graded_items) + self.assertCountEqual(_gather_graded_items(sequence, 5), expected_graded_items) # noqa: PT009 def test_sequence_with_ora_and_non_ora_assignments(self): """ @@ -159,7 +159,7 @@ def test_sequence_with_ora_and_non_ora_assignments(self): (graded_problem_1.location, {'due': 5}), ] sequence = self.store.get_item(sequence.location) - self.assertCountEqual(_gather_graded_items(sequence, 5), expected_graded_items) + self.assertCountEqual(_gather_graded_items(sequence, 5), expected_graded_items) # noqa: PT009 def test_get_custom_pacing_children(self): """ @@ -179,7 +179,7 @@ def test_get_custom_pacing_children(self): (vertical3.location, {'due': timedelta(weeks=2)}) ] sequence = self.store.get_item(sequence.location) - self.assertCountEqual(_get_custom_pacing_children(sequence, 2), expected_dates) + self.assertCountEqual(_get_custom_pacing_children(sequence, 2), expected_dates) # noqa: PT009 with self.store.bulk_operations(self.course.id): # A subsection with multiple units, each of which has a problem. @@ -191,19 +191,19 @@ def test_get_custom_pacing_children(self): (problem2.location, {'due': timedelta(weeks=2)}) ]) sequence = self.store.get_item(sequence.location) - self.assertCountEqual(_get_custom_pacing_children(sequence, 2), expected_dates) + self.assertCountEqual(_get_custom_pacing_children(sequence, 2), expected_dates) # noqa: PT009 # A subsection that has ORA as a problem. ORA should not inherit due date. BlockFactory.create(parent=vertical3, category='openassessment') sequence = self.store.get_item(sequence.location) - self.assertCountEqual(_get_custom_pacing_children(sequence, 2), expected_dates) + self.assertCountEqual(_get_custom_pacing_children(sequence, 2), expected_dates) # noqa: PT009 # A subsection that has an ORA problem and a non ORA problem. ORA should # not inherit due date, but non ORA problems should. problem3 = BlockFactory(parent=vertical3, category='problem') expected_dates.append((problem3.location, {'due': timedelta(weeks=2)})) sequence = self.store.get_item(sequence.location) - self.assertCountEqual(_get_custom_pacing_children(sequence, 2), expected_dates) + self.assertCountEqual(_get_custom_pacing_children(sequence, 2), expected_dates) # noqa: PT009 class SelfPacedCustomDueDateTests(ModuleStoreTestCase): @@ -239,7 +239,7 @@ def test_extract_dates_from_course_inheritance(self): (problem.location, {'due': timedelta(days=21)}) ] course = self.store.get_item(self.course.location) - self.assertCountEqual(extract_dates_from_course(course), expected_dates) + self.assertCountEqual(extract_dates_from_course(course), expected_dates) # noqa: PT009 @override_waffle_flag(CUSTOM_RELATIVE_DATES, active=True) def test_extract_dates_from_course_custom_and_default_pls_one_subsection(self): @@ -260,7 +260,7 @@ def test_extract_dates_from_course_custom_and_default_pls_one_subsection(self): (sequential.location, {'due': timedelta(days=21)}) ] course = self.store.get_item(self.course.location) - self.assertCountEqual(extract_dates_from_course(course), expected_dates) + self.assertCountEqual(extract_dates_from_course(course), expected_dates) # noqa: PT009 @override_waffle_flag(CUSTOM_RELATIVE_DATES, active=True) def test_extract_dates_from_course_custom_and_default_pls_one_subsection_graded(self): @@ -294,7 +294,7 @@ def test_extract_dates_from_course_custom_and_default_pls_one_subsection_graded( ] course = self.store.get_item(self.course.location) with patch.object(utils, 'get_expected_duration', return_value=timedelta(weeks=6)): - self.assertCountEqual(extract_dates_from_course(course), expected_dates) + self.assertCountEqual(extract_dates_from_course(course), expected_dates) # noqa: PT009 @override_waffle_flag(CUSTOM_RELATIVE_DATES, active=True) def test_extract_dates_from_course_custom_and_default_pls_multiple_subsections_graded(self): @@ -335,7 +335,7 @@ def test_extract_dates_from_course_custom_and_default_pls_multiple_subsections_g course = self.store.get_item(self.course.location) with patch.object(utils, 'get_expected_duration', return_value=timedelta(weeks=8)): - self.assertCountEqual(extract_dates_from_course(course), expected_dates) + self.assertCountEqual(extract_dates_from_course(course), expected_dates) # noqa: PT009 @override_waffle_flag(CUSTOM_RELATIVE_DATES, active=True) def test_extract_dates_from_course_all_subsections(self): @@ -356,7 +356,7 @@ def test_extract_dates_from_course_all_subsections(self): (sequential3.location, {'due': timedelta(days=35)}) ] course = self.store.get_item(self.course.location) - self.assertCountEqual(extract_dates_from_course(course), expected_dates) + self.assertCountEqual(extract_dates_from_course(course), expected_dates) # noqa: PT009 @override_waffle_flag(CUSTOM_RELATIVE_DATES, active=True) def test_extract_dates_from_course_no_subsections(self): @@ -369,4 +369,4 @@ def test_extract_dates_from_course_no_subsections(self): BlockFactory.create(category='sequential', parent=self.chapter) expected_dates = [(self.course.location, {})] course = self.store.get_item(self.course.location) - self.assertCountEqual(extract_dates_from_course(course), expected_dates) + self.assertCountEqual(extract_dates_from_course(course), expected_dates) # noqa: PT009 diff --git a/openedx/core/djangoapps/course_date_signals/utils.py b/openedx/core/djangoapps/course_date_signals/utils.py index 78447f32610c..7a3db05f5dec 100644 --- a/openedx/core/djangoapps/course_date_signals/utils.py +++ b/openedx/core/djangoapps/course_date_signals/utils.py @@ -6,11 +6,21 @@ from datetime import timedelta +from django.conf import settings + +from openedx.core.djangoapps.catalog.models import CatalogIntegration from openedx.core.djangoapps.catalog.utils import get_course_run_details +MIN_DURATION = timedelta(weeks=settings.COURSE_ACCESS_DURATION_MIN_WEEKS) +MAX_DURATION = timedelta(weeks=settings.COURSE_ACCESS_DURATION_MAX_WEEKS) + -MIN_DURATION = timedelta(weeks=4) -MAX_DURATION = timedelta(weeks=18) +def _catalog_integration_enabled(): + """ + Check if catalog integration is enabled + """ + catalog_integration = CatalogIntegration.current() + return catalog_integration.is_enabled() def get_expected_duration(course_id): @@ -20,12 +30,13 @@ def get_expected_duration(course_id): access_duration = MIN_DURATION - # The user course expiration date is the content availability date - # plus the weeks_to_complete field from course-discovery. - discovery_course_details = get_course_run_details(course_id, ['weeks_to_complete']) - expected_weeks = discovery_course_details.get('weeks_to_complete') - if expected_weeks: - access_duration = timedelta(weeks=expected_weeks) + if _catalog_integration_enabled(): + discovery_course_details = get_course_run_details( + course_id, ['weeks_to_complete'] + ) + expected_weeks = discovery_course_details.get('weeks_to_complete') + if expected_weeks: + access_duration = timedelta(weeks=expected_weeks) # Course access duration is bounded by the min and max duration. access_duration = max(MIN_DURATION, min(MAX_DURATION, access_duration)) diff --git a/openedx/core/djangoapps/course_groups/api.py b/openedx/core/djangoapps/course_groups/api.py index a4dec915fbe5..cf718adbf6f9 100644 --- a/openedx/core/djangoapps/course_groups/api.py +++ b/openedx/core/djangoapps/course_groups/api.py @@ -3,7 +3,7 @@ """ -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from openedx.core.djangoapps.course_groups.models import CohortMembership diff --git a/openedx/core/djangoapps/course_groups/cohorts.py b/openedx/core/djangoapps/course_groups/cohorts.py index 5bded799fdb9..81f4df0e0fee 100644 --- a/openedx/core/djangoapps/course_groups/cohorts.py +++ b/openedx/core/djangoapps/course_groups/cohorts.py @@ -7,7 +7,7 @@ import logging import random -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.core.exceptions import ValidationError from django.core.validators import validate_email from django.db import IntegrityError @@ -18,10 +18,10 @@ from edx_django_utils.cache import RequestCache from eventtracking import tracker +from common.djangoapps.student.models import get_user_by_username_or_email from lms.djangoapps.courseware import courses from openedx.core.lib.cache_utils import request_cached from openedx.core.lib.courses import get_course_by_id -from common.djangoapps.student.models import get_user_by_username_or_email from .models import ( CohortMembership, @@ -29,7 +29,7 @@ CourseCohortsSettings, CourseUserGroup, CourseUserGroupPartitionGroup, - UnregisteredLearnerCohortAssignments + UnregisteredLearnerCohortAssignments, ) from .signals.signals import COHORT_MEMBERSHIP_UPDATED @@ -37,7 +37,7 @@ @receiver(post_save, sender=CourseUserGroup) -def _cohort_added(sender, **kwargs): # lint-amnesty, pylint: disable=unused-argument +def _cohort_added(sender, **kwargs): # pylint: disable=unused-argument """Emits a tracking log event each time a cohort is created""" instance = kwargs["instance"] if kwargs["created"] and instance.group_type == CourseUserGroup.COHORT: @@ -48,7 +48,7 @@ def _cohort_added(sender, **kwargs): # lint-amnesty, pylint: disable=unused-arg @receiver(m2m_changed, sender=CourseUserGroup.users.through) -def _cohort_membership_changed(sender, **kwargs): # lint-amnesty, pylint: disable=unused-argument +def _cohort_membership_changed(sender, **kwargs): # pylint: disable=unused-argument """Emits a tracking log event each time cohort membership is modified""" def get_event_iter(user_id_iter, cohort_iter): """ @@ -319,7 +319,7 @@ def migrate_cohort_settings(course): return cohort_settings -def get_course_cohorts(course=None, course_id=None, assignment_type=None): +def get_course_cohorts(course=None, course_id=None, assignment_type=None, ordering='asc'): """ Get a list of all the cohorts in the given course. This will include auto cohorts, regardless of whether or not the auto cohorts include any users. @@ -327,6 +327,8 @@ def get_course_cohorts(course=None, course_id=None, assignment_type=None): Arguments: course: the course for which cohorts should be returned assignment_type: cohort assignment type + ordering: sort direction for results by name. Use 'desc' for descending order. + Any other value (including the default 'asc') results in ascending order. Returns: A list of CourseUserGroup objects. Empty if there are no cohorts. Does @@ -343,6 +345,11 @@ def get_course_cohorts(course=None, course_id=None, assignment_type=None): group_type=CourseUserGroup.COHORT ) query_set = query_set.filter(cohort__assignment_type=assignment_type) if assignment_type else query_set + ordering = ordering.lower() + if ordering not in ('asc', 'desc'): + raise ValueError(f"Invalid ordering value '{ordering}'. Must be 'asc' or 'desc'.") + sort_field = '-name' if ordering == 'desc' else 'name' + query_set = query_set.order_by(sort_field) return list(query_set) @@ -390,7 +397,7 @@ def add_cohort(course_key, name, assignment_type): try: course = get_course_by_id(course_key) except Http404: - raise ValueError("Invalid course_key") # lint-amnesty, pylint: disable=raise-missing-from + raise ValueError("Invalid course_key") # pylint: disable=raise-missing-from # noqa: B904 cohort = CourseCohort.create( cohort_name=name, @@ -432,7 +439,7 @@ def remove_user_from_cohort(cohort, username_or_email): membership.delete() COHORT_MEMBERSHIP_UPDATED.send(sender=None, user=user, course_key=course_key) except CohortMembership.DoesNotExist: - raise ValueError(f"User {username_or_email} was not present in cohort {cohort}") # lint-amnesty, pylint: disable=raise-missing-from + raise ValueError(f"User {username_or_email} was not present in cohort {cohort}") # pylint: disable=raise-missing-from # noqa: B904 def add_user_to_cohort(cohort, username_or_email_or_user): @@ -504,10 +511,10 @@ def add_user_to_cohort(cohort, username_or_email_or_user): return (None, None, True) except ValidationError as invalid: - if "@" in username_or_email_or_user: # lint-amnesty, pylint: disable=no-else-raise + if "@" in username_or_email_or_user: # pylint: disable=no-else-raise raise invalid else: - raise ex # lint-amnesty, pylint: disable=raise-missing-from + raise ex # pylint: disable=raise-missing-from # noqa: B904 def get_group_info_for_cohort(cohort, use_cached=False): @@ -603,7 +610,7 @@ def _get_course_cohort_settings(course_key): return course_cohort_settings -def get_legacy_discussion_settings(course_key): # lint-amnesty, pylint: disable=missing-function-docstring +def get_legacy_discussion_settings(course_key): # pylint: disable=missing-function-docstring try: course_cohort_settings = CourseCohortsSettings.objects.get(course_id=course_key) diff --git a/openedx/core/djangoapps/course_groups/migrations/0001_initial.py b/openedx/core/djangoapps/course_groups/migrations/0001_initial.py index 7c76c121d957..06a704e8a0d2 100644 --- a/openedx/core/djangoapps/course_groups/migrations/0001_initial.py +++ b/openedx/core/djangoapps/course_groups/migrations/0001_initial.py @@ -1,5 +1,5 @@ -from django.db import migrations, models from django.conf import settings +from django.db import migrations, models from opaque_keys.edx.django.models import CourseKeyField diff --git a/openedx/core/djangoapps/course_groups/models.py b/openedx/core/djangoapps/course_groups/models.py index b8e91800665a..954b2bc669fd 100644 --- a/openedx/core/djangoapps/course_groups/models.py +++ b/openedx/core/djangoapps/course_groups/models.py @@ -6,20 +6,25 @@ import json import logging -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.core.exceptions import ValidationError from django.db import models, transaction from django.db.models.signals import pre_delete from django.dispatch import receiver - from opaque_keys.edx.django.models import CourseKeyField +from openedx_events.learning.data import ( # pylint: disable=wrong-import-order + CohortData, + CourseData, + UserData, + UserPersonalData, +) +from openedx_events.learning.signals import ( + COHORT_MEMBERSHIP_CHANGED, # pylint: disable=wrong-import-order +) from openedx_filters.learning.filters import CohortAssignmentRequested, CohortChangeRequested from openedx.core.djangolib.model_mixins import DeletableByUserValue -from openedx_events.learning.data import CohortData, CourseData, UserData, UserPersonalData # lint-amnesty, pylint: disable=wrong-import-order -from openedx_events.learning.signals import COHORT_MEMBERSHIP_CHANGED # lint-amnesty, pylint: disable=wrong-import-order - log = logging.getLogger(__name__) @@ -46,7 +51,7 @@ class CourseUserGroup(models.Model): class Meta: unique_together = (('name', 'course_id'), ) - name = models.CharField(max_length=255, + name = models.CharField(max_length=255, # noqa: DJ012 help_text=("What is the name of this group? " "Must be unique within a course.")) users = models.ManyToManyField(User, db_index=True, related_name='course_groups', @@ -82,11 +87,11 @@ def create(cls, name, course_id, group_type=COHORT): name=name ) - def __str__(self): + def __str__(self): # noqa: DJ012 return self.name -class CohortMembership(models.Model): +class CohortMembership(models.Model): # noqa: DJ008 """ Used internally to enforce our particular definition of uniqueness. @@ -99,7 +104,7 @@ class CohortMembership(models.Model): class Meta: unique_together = (('user', 'course_id'), ) - def clean_fields(self, *args, **kwargs): # lint-amnesty, pylint: disable=signature-differs + def clean_fields(self, *args, **kwargs): # pylint: disable=signature-differs if self.course_id is None: self.course_id = self.course_user_group.course_id super().clean_fields(*args, **kwargs) @@ -137,7 +142,7 @@ def assign(cls, cohort, user): membership.course_user_group.users.add(user) previous_cohort = None elif membership.course_user_group == cohort: - raise ValueError("User {user_name} already present in cohort {cohort_name}".format( + raise ValueError("User {user_name} already present in cohort {cohort_name}".format( # noqa: UP032 user_name=user.username, cohort_name=cohort.name)) else: @@ -159,7 +164,7 @@ def assign(cls, cohort, user): membership.save() return membership, previous_cohort - def save(self, *args, **kwargs): + def save(self, *args, **kwargs): # noqa: DJ012 self.full_clean(validate_unique=False) # .. event_implemented_name: COHORT_MEMBERSHIP_CHANGED @@ -197,7 +202,7 @@ def remove_user_from_cohort(sender, instance, **kwargs): # pylint: disable=unus instance.course_user_group.save() -class CourseUserGroupPartitionGroup(models.Model): +class CourseUserGroupPartitionGroup(models.Model): # noqa: DJ008 """ Create User Partition Info. @@ -214,7 +219,7 @@ class CourseUserGroupPartitionGroup(models.Model): updated_at = models.DateTimeField(auto_now=True) -class CourseCohortsSettings(models.Model): +class CourseCohortsSettings(models.Model): # noqa: DJ008 """ This model represents cohort settings for courses. The only non-deprecated fields are `is_cohorted` and `course_id`. @@ -230,7 +235,7 @@ class CourseCohortsSettings(models.Model): help_text="Which course are these settings associated with?", ) - _cohorted_discussions = models.TextField(db_column='cohorted_discussions', null=True, blank=True) # JSON list + _cohorted_discussions = models.TextField(db_column='cohorted_discussions', null=True, blank=True) # JSON list # noqa: DJ001 # pylint: disable=line-too-long # Note that although a default value is specified here for always_cohort_inline_discussions (False), # in reality the default value at the time that cohorting is enabled for a course comes from @@ -255,7 +260,7 @@ def cohorted_discussions(self, value): self._cohorted_discussions = json.dumps(value) -class CourseCohort(models.Model): +class CourseCohort(models.Model): # noqa: DJ008 """ This model represents cohort related info. @@ -291,7 +296,7 @@ def create(cls, cohort_name=None, course_id=None, course_user_group=None, assign return course_cohort -class UnregisteredLearnerCohortAssignments(DeletableByUserValue, models.Model): +class UnregisteredLearnerCohortAssignments(DeletableByUserValue, models.Model): # noqa: DJ008 """ Tracks the assignment of an unregistered learner to a course's cohort. @@ -303,6 +308,13 @@ class UnregisteredLearnerCohortAssignments(DeletableByUserValue, models.Model): class Meta: unique_together = (('course_id', 'email'), ) - course_user_group = models.ForeignKey(CourseUserGroup, on_delete=models.CASCADE) + course_user_group = models.ForeignKey(CourseUserGroup, on_delete=models.CASCADE) # noqa: DJ012 email = models.CharField(blank=True, max_length=255, db_index=True) course_id = CourseKeyField(max_length=255) + + @classmethod + def redact_before_delete_fields(cls): + """ + Redact email before deleting records for downstream soft-delete systems. + """ + return {'email': 'redacted-before-delete@safe.com'} diff --git a/openedx/core/djangoapps/course_groups/partition_scheme.py b/openedx/core/djangoapps/course_groups/partition_scheme.py index 60e7c5f915c2..c5aaffbb8852 100644 --- a/openedx/core/djangoapps/course_groups/partition_scheme.py +++ b/openedx/core/djangoapps/course_groups/partition_scheme.py @@ -8,9 +8,11 @@ from lms.djangoapps.courseware.masquerade import ( get_course_masquerade, get_masquerading_user_group, - is_masquerading_as_specific_student + is_masquerading_as_specific_student, +) +from xmodule.partitions.partitions import ( + NoSuchUserPartitionGroupError, # pylint: disable=wrong-import-order ) -from xmodule.partitions.partitions import NoSuchUserPartitionGroupError # lint-amnesty, pylint: disable=wrong-import-order from .cohorts import get_cohort, get_group_info_for_cohort diff --git a/openedx/core/djangoapps/course_groups/permissions.py b/openedx/core/djangoapps/course_groups/permissions.py index 7229d6fba4aa..cfc3aefb2f8c 100644 --- a/openedx/core/djangoapps/course_groups/permissions.py +++ b/openedx/core/djangoapps/course_groups/permissions.py @@ -5,11 +5,13 @@ from opaque_keys.edx.keys import CourseKey from rest_framework import permissions +from common.djangoapps.student.roles import CourseInstructorRole, CourseStaffRole, GlobalStaff +from lms.djangoapps.discussion.django_comment_client.utils import get_user_role_names from openedx.core.djangoapps.django_comment_common.models import ( - FORUM_ROLE_ADMINISTRATOR, FORUM_ROLE_COMMUNITY_TA, FORUM_ROLE_MODERATOR + FORUM_ROLE_ADMINISTRATOR, + FORUM_ROLE_COMMUNITY_TA, + FORUM_ROLE_MODERATOR, ) -from common.djangoapps.student.roles import CourseStaffRole, GlobalStaff, CourseInstructorRole -from lms.djangoapps.discussion.django_comment_client.utils import get_user_role_names class IsStaffOrAdmin(permissions.BasePermission): diff --git a/openedx/core/djangoapps/course_groups/rest_api/docs/content-groups-api-v2-spec.yaml b/openedx/core/djangoapps/course_groups/rest_api/docs/content-groups-api-v2-spec.yaml index e6ea6d54df93..633d9fdddf01 100644 --- a/openedx/core/djangoapps/course_groups/rest_api/docs/content-groups-api-v2-spec.yaml +++ b/openedx/core/djangoapps/course_groups/rest_api/docs/content-groups-api-v2-spec.yaml @@ -46,10 +46,10 @@ paths: get: tags: - Content Groups - summary: List content group configurations + summary: List content groups description: | - Returns all content group configurations (scheme='cohort') for a course. - If no content group exists, an empty one is automatically created. + Returns the content groups for a course along with the configuration ID + and a link to Studio for managing content groups. operationId: listGroupConfigurations produces: - application/json @@ -153,20 +153,15 @@ definitions: ContentGroupsListResponse: type: object properties: - all_group_configurations: + id: + type: integer + nullable: true + description: ID of the content group configuration (null if none exists) + groups: type: array items: - $ref: '#/definitions/ContentGroupConfiguration' - description: List of content group configurations - should_show_enrollment_track: - type: boolean - description: Whether enrollment track groups should be displayed - should_show_experiment_groups: - type: boolean - description: Whether experiment groups should be displayed - group_configuration_url: - type: string - description: Base URL for accessing individual configurations - course_outline_url: + $ref: '#/definitions/Group' + description: Flat list of content groups for the course + studio_content_groups_link: type: string - description: URL to the course outline + description: Full URL to Studio's content group configuration page diff --git a/openedx/core/djangoapps/course_groups/rest_api/serializers.py b/openedx/core/djangoapps/course_groups/rest_api/serializers.py index 651d58a966da..e9403f8b81cd 100644 --- a/openedx/core/djangoapps/course_groups/rest_api/serializers.py +++ b/openedx/core/djangoapps/course_groups/rest_api/serializers.py @@ -36,10 +36,15 @@ class ContentGroupConfigurationSerializer(serializers.Serializer): class ContentGroupsListResponseSerializer(serializers.Serializer): """ Response serializer for listing all content groups. + + Returns the content group configuration ID, a flat list of content groups, + and a link to Studio where instructors can manage content groups. """ - all_group_configurations = ContentGroupConfigurationSerializer(many=True) - should_show_enrollment_track = serializers.BooleanField() - should_show_experiment_groups = serializers.BooleanField() - context_course = serializers.JSONField(required=False, allow_null=True) - group_configuration_url = serializers.CharField() - course_outline_url = serializers.CharField() + id = serializers.IntegerField( + allow_null=True, + help_text="ID of the content group configuration (null if none exists)" + ) + groups = GroupSerializer(many=True) + studio_content_groups_link = serializers.CharField( + help_text="Full URL to Studio's content group configuration page" + ) diff --git a/openedx/core/djangoapps/course_groups/rest_api/tests/test_views.py b/openedx/core/djangoapps/course_groups/rest_api/tests/test_views.py index c09f068718b3..fb22189eb866 100644 --- a/openedx/core/djangoapps/course_groups/rest_api/tests/test_views.py +++ b/openedx/core/djangoapps/course_groups/rest_api/tests/test_views.py @@ -3,15 +3,18 @@ """ from unittest.mock import patch +from django.test import override_settings from rest_framework import status from rest_framework.test import APIClient -from xmodule.partitions.partitions import Group, UserPartition from common.djangoapps.student.tests.factories import UserFactory -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase -from xmodule.modulestore.tests.factories import CourseFactory from openedx.core.djangoapps.course_groups.constants import COHORT_SCHEME from openedx.core.djangolib.testing.utils import skip_unless_lms +from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase +from xmodule.modulestore.tests.factories import CourseFactory +from xmodule.partitions.partitions import Group, UserPartition + +TEST_STUDIO_BASE_URL = "https://studio.example.com" @skip_unless_lms @@ -28,10 +31,16 @@ def setUp(self): self.api_client.force_authenticate(user=self.user) def _get_url(self, course_id=None): - """Helper to get the list URL""" + """Helper to get the API URL""" course_id = course_id or str(self.course.id) return f'/api/cohorts/v2/courses/{course_id}/group_configurations' + def _get_expected_studio_url(self, course_id=None): + """Helper to get the expected Studio URL""" + course_id = course_id or str(self.course.id) + return f'{TEST_STUDIO_BASE_URL}/course/{course_id}/group_configurations' + + @override_settings(MFE_CONFIG={"STUDIO_BASE_URL": TEST_STUDIO_BASE_URL}) @patch('lms.djangoapps.instructor.permissions.InstructorPermission.has_permission') def test_list_content_groups_returns_json(self, mock_perm): """Verify endpoint returns JSON with correct structure""" @@ -53,22 +62,30 @@ def test_list_content_groups_returns_json(self, mock_perm): response = self.api_client.get(self._get_url()) - self.assertEqual(response.status_code, status.HTTP_200_OK) - self.assertEqual(response['Content-Type'], 'application/json') + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 + self.assertEqual(response['Content-Type'], 'application/json') # noqa: PT009 data = response.json() - self.assertIn('all_group_configurations', data) - self.assertIn('should_show_enrollment_track', data) - self.assertIn('should_show_experiment_groups', data) + self.assertIn('id', data) # noqa: PT009 + self.assertIn('groups', data) # noqa: PT009 + self.assertIn('studio_content_groups_link', data) # noqa: PT009 + + # Verify partition ID is returned + self.assertEqual(data['id'], 50) # noqa: PT009 - configs = data['all_group_configurations'] - self.assertEqual(len(configs), 1) - self.assertEqual(configs[0]['scheme'], COHORT_SCHEME) - self.assertEqual(len(configs[0]['groups']), 2) + # Verify groups + groups = data['groups'] + self.assertEqual(len(groups), 2) # noqa: PT009 + self.assertEqual(groups[0]['name'], 'Content Group A') # noqa: PT009 + self.assertEqual(groups[1]['name'], 'Content Group B') # noqa: PT009 + + # Verify full Studio URL + expected_studio_url = self._get_expected_studio_url() + self.assertEqual(data['studio_content_groups_link'], expected_studio_url) # noqa: PT009 @patch('lms.djangoapps.instructor.permissions.InstructorPermission.has_permission') def test_list_content_groups_filters_non_cohort_partitions(self, mock_perm): - """Verify only cohort-scheme partitions are returned""" + """Verify only groups from cohort-scheme partitions are returned""" mock_perm.return_value = True self.course.user_partitions = [ @@ -92,31 +109,38 @@ def test_list_content_groups_filters_non_cohort_partitions(self, mock_perm): response = self.api_client.get(self._get_url()) data = response.json() - configs = data['all_group_configurations'] - self.assertEqual(len(configs), 1) - self.assertEqual(configs[0]['id'], 50) - self.assertEqual(configs[0]['scheme'], COHORT_SCHEME) + # Verify cohort partition ID is returned + self.assertEqual(data['id'], 50) # noqa: PT009 + + # Only groups from cohort partition should be returned + groups = data['groups'] + self.assertEqual(len(groups), 1) # noqa: PT009 + self.assertEqual(groups[0]['name'], 'Group A') # noqa: PT009 + @override_settings(MFE_CONFIG={"STUDIO_BASE_URL": TEST_STUDIO_BASE_URL}) @patch('lms.djangoapps.instructor.permissions.InstructorPermission.has_permission') - def test_list_auto_creates_empty_content_group_if_none_exists(self, mock_perm): - """Verify empty content group is auto-created when none exists""" + def test_list_returns_empty_groups_when_none_exist(self, mock_perm): + """Verify empty groups array and null id when no content groups exist""" mock_perm.return_value = True response = self.api_client.get(self._get_url()) data = response.json() - configs = data['all_group_configurations'] - self.assertEqual(len(configs), 1) - self.assertEqual(configs[0]['scheme'], COHORT_SCHEME) - self.assertEqual(len(configs[0]['groups']), 0) + # ID should be null when no partition exists + self.assertIsNone(data['id']) # noqa: PT009 + self.assertEqual(len(data['groups']), 0) # noqa: PT009 + + # Verify full Studio URL + expected_studio_url = self._get_expected_studio_url() + self.assertEqual(data['studio_content_groups_link'], expected_studio_url) # noqa: PT009 def test_list_requires_authentication(self): """Verify endpoint requires authentication""" client = APIClient() response = client.get(self._get_url()) - self.assertIn(response.status_code, [status.HTTP_401_UNAUTHORIZED, status.HTTP_403_FORBIDDEN]) + self.assertIn(response.status_code, [status.HTTP_401_UNAUTHORIZED, status.HTTP_403_FORBIDDEN]) # noqa: PT009 @patch('lms.djangoapps.instructor.permissions.InstructorPermission.has_permission') def test_list_invalid_course_key_returns_400(self, mock_perm): @@ -124,7 +148,7 @@ def test_list_invalid_course_key_returns_400(self, mock_perm): mock_perm.return_value = True response = self.api_client.get('/api/cohorts/v2/courses/course-v1:invalid+course+key/group_configurations') - self.assertEqual(response.status_code, status.HTTP_404_NOT_FOUND) + self.assertEqual(response.status_code, status.HTTP_404_NOT_FOUND) # noqa: PT009 @skip_unless_lms @@ -165,13 +189,13 @@ def test_get_configuration_details(self, mock_perm): response = self.api_client.get(self._get_url()) - self.assertEqual(response.status_code, status.HTTP_200_OK) + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 data = response.json() - self.assertEqual(data['id'], 50) - self.assertEqual(data['name'], 'Test Content Groups') - self.assertEqual(data['scheme'], COHORT_SCHEME) - self.assertEqual(len(data['groups']), 2) + self.assertEqual(data['id'], 50) # noqa: PT009 + self.assertEqual(data['name'], 'Test Content Groups') # noqa: PT009 + self.assertEqual(data['scheme'], COHORT_SCHEME) # noqa: PT009 + self.assertEqual(len(data['groups']), 2) # noqa: PT009 @skip_unless_lms @@ -199,10 +223,10 @@ def test_staff_user_can_access(self, mock_perm): client.force_authenticate(user=self.staff_user) response = client.get(self._get_url()) - self.assertEqual(response.status_code, status.HTTP_200_OK) + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 def test_unauthenticated_user_denied(self): """Verify unauthenticated users are denied""" client = APIClient() response = client.get(self._get_url()) - self.assertIn(response.status_code, [status.HTTP_401_UNAUTHORIZED, status.HTTP_403_FORBIDDEN]) + self.assertIn(response.status_code, [status.HTTP_401_UNAUTHORIZED, status.HTTP_403_FORBIDDEN]) # noqa: PT009 diff --git a/openedx/core/djangoapps/course_groups/rest_api/views.py b/openedx/core/djangoapps/course_groups/rest_api/views.py index f44705629b96..9bf884b6a22d 100644 --- a/openedx/core/djangoapps/course_groups/rest_api/views.py +++ b/openedx/core/djangoapps/course_groups/rest_api/views.py @@ -2,29 +2,25 @@ REST API views for content group configurations. """ import edx_api_doc_tools as apidocs -from common.djangoapps.util.db import MYSQL_MAX_INT, generate_int_id +from django.conf import settings from opaque_keys import InvalidKeyError from opaque_keys.edx.keys import CourseKey from rest_framework import status from rest_framework.permissions import IsAuthenticated from rest_framework.response import Response from rest_framework.views import APIView -from xmodule.modulestore.exceptions import ItemNotFoundError -from xmodule.partitions.partitions import MINIMUM_UNUSED_PARTITION_ID, UserPartition from lms.djangoapps.instructor import permissions -from openedx.core.djangoapps.course_groups.constants import ( - COHORT_SCHEME, - CONTENT_GROUP_CONFIGURATION_DESCRIPTION, - CONTENT_GROUP_CONFIGURATION_NAME, -) +from openedx.core.djangoapps.course_groups.constants import COHORT_SCHEME from openedx.core.djangoapps.course_groups.partition_scheme import get_cohorted_user_partition from openedx.core.djangoapps.course_groups.rest_api.serializers import ( ContentGroupConfigurationSerializer, ContentGroupsListResponseSerializer, ) +from openedx.core.djangoapps.site_configuration import helpers as configuration_helpers from openedx.core.lib.api.view_utils import DeveloperErrorViewMixin from openedx.core.lib.courses import get_course_by_id +from xmodule.modulestore.exceptions import ItemNotFoundError class GroupConfigurationsListView(DeveloperErrorViewMixin, APIView): @@ -72,26 +68,26 @@ def get(self, request, course_id): content_group_partition = get_cohorted_user_partition(course) - if content_group_partition is None: - used_ids = {p.id for p in course.user_partitions} - content_group_partition = UserPartition( - id=generate_int_id(MINIMUM_UNUSED_PARTITION_ID, MYSQL_MAX_INT, used_ids), - name=str(CONTENT_GROUP_CONFIGURATION_NAME), - description=str(CONTENT_GROUP_CONFIGURATION_DESCRIPTION), - groups=[], - scheme_id=COHORT_SCHEME - ) - - context = { - "all_group_configurations": [content_group_partition.to_json()], - "should_show_enrollment_track": False, - "should_show_experiment_groups": True, - "context_course": None, - "group_configuration_url": f"/api/cohorts/v2/courses/{course_id}/group_configurations", - "course_outline_url": f"/api/contentstore/v1/courses/{course_id}", + # Extract partition ID and groups, or None/empty list if no partition exists + if content_group_partition is not None: + partition_id = content_group_partition.id + groups = [group.to_json() for group in content_group_partition.groups] + else: + partition_id = None + groups = [] + + # Build full Studio URL for content group configuration + mfe_config = configuration_helpers.get_value("MFE_CONFIG", settings.MFE_CONFIG) + studio_base_url = mfe_config.get("STUDIO_BASE_URL", "") + studio_content_groups_link = f"{studio_base_url}/course/{course_id}/group_configurations" + + response_data = { + "id": partition_id, + "groups": groups, + "studio_content_groups_link": studio_content_groups_link, } - serializer = ContentGroupsListResponseSerializer(context) + serializer = ContentGroupsListResponseSerializer(response_data) return Response(serializer.data, status=status.HTTP_200_OK) diff --git a/openedx/core/djangoapps/course_groups/serializers.py b/openedx/core/djangoapps/course_groups/serializers.py index 039413908461..5356950c0efe 100644 --- a/openedx/core/djangoapps/course_groups/serializers.py +++ b/openedx/core/djangoapps/course_groups/serializers.py @@ -3,7 +3,7 @@ """ -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from rest_framework import serializers diff --git a/openedx/core/djangoapps/course_groups/tests/helpers.py b/openedx/core/djangoapps/course_groups/tests/helpers.py index abe917d8dcb6..a309af2f367b 100644 --- a/openedx/core/djangoapps/course_groups/tests/helpers.py +++ b/openedx/core/djangoapps/course_groups/tests/helpers.py @@ -10,8 +10,8 @@ from opaque_keys.edx.locator import CourseLocator from openedx.core.djangoapps.django_comment_common.models import CourseDiscussionSettings -from xmodule.modulestore import ModuleStoreEnum # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore import ModuleStoreEnum # pylint: disable=wrong-import-order +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order from ..cohorts import set_course_cohorted from ..models import CohortMembership, CourseCohort, CourseCohortsSettings, CourseUserGroup @@ -34,8 +34,8 @@ def users(self, create, extracted, **kwargs): # pylint: disable=unused-argument Returns the users associated with the cohort. """ if extracted: - self.users.add(*extracted) # lint-amnesty, pylint: disable=no-member - for user in self.users.all(): # lint-amnesty, pylint: disable=no-member + self.users.add(*extracted) # pylint: disable=no-member + for user in self.users.all(): # pylint: disable=no-member CohortMembership.objects.create( user=user, course_user_group=self, @@ -105,8 +105,8 @@ def config_course_cohorts( course, is_cohorted, discussion_division_scheme=CourseDiscussionSettings.COHORT, - auto_cohorts=[], - manual_cohorts=[], + auto_cohorts=[], # noqa: B006 + manual_cohorts=[], # noqa: B006 ): """ Set and configure cohorts for a course. diff --git a/openedx/core/djangoapps/course_groups/tests/test_api_views.py b/openedx/core/djangoapps/course_groups/tests/test_api_views.py index b87dc98fca59..64e5372a5da3 100644 --- a/openedx/core/djangoapps/course_groups/tests/test_api_views.py +++ b/openedx/core/djangoapps/course_groups/tests/test_api_views.py @@ -3,20 +3,21 @@ """ -import json import tempfile import ddt from django.urls import reverse -from openedx.core.djangoapps.oauth_dispatch.tests.factories import ApplicationFactory, AccessTokenFactory -from openedx.core.djangolib.testing.utils import skip_unless_lms from common.djangoapps.student.tests.factories import UserFactory -from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import ToyCourseFactory # lint-amnesty, pylint: disable=wrong-import-order - -from .. import cohorts -from .helpers import CohortFactory +from openedx.core.djangoapps.course_groups import cohorts +from openedx.core.djangoapps.course_groups.tests.helpers import CohortFactory +from openedx.core.djangoapps.course_groups.views import link_cohort_to_partition_group +from openedx.core.djangoapps.oauth_dispatch.tests.factories import AccessTokenFactory, ApplicationFactory +from openedx.core.djangolib.testing.utils import skip_unless_lms +from xmodule.modulestore.tests.django_utils import ( + SharedModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import ToyCourseFactory # pylint: disable=wrong-import-order USERNAME = 'honor' USER_MAIL = 'honor@example.com' @@ -24,7 +25,7 @@ HANDLER_POST_PAYLOAD = '{"name":"Default","user_count":0,"assignment_type":"random","user_partition_id":null\ ,"group_id":null}' HANDLER_PATCH_PAYLOAD = '{"name":"Default Group","group_id":null,"user_partition_id":null,"assignment_type":"random"}' -ADD_USER_PAYLOAD = json.dumps({'users': [USER_MAIL, ]}) +ADD_USER_PAYLOAD = {'users': [USER_MAIL, ]} CSV_DATA = f'''email,cohort\n{USER_MAIL},DEFAULT''' @@ -307,7 +308,7 @@ def test_list_users_in_cohort(self, is_staff, status): assert response.status_code == status if status == 200: - results = json.loads(response.content.decode('utf-8'))['results'] + results = response.json()['results'] expected_results = [{ 'username': user.username, 'email': user.email, @@ -406,7 +407,7 @@ def test_add_users_to_cohort_different_types_of_users(self): "invalid": ["foo@bar"], "present": ["user2"] } - assert json.loads(response.content.decode('utf-8')) == expected_response + assert response.json() == expected_response def test_remove_user_from_cohort_missing_username(self): """ @@ -458,3 +459,194 @@ def test_add_users_csv(self, is_staff, payload, status): response = self.client.post(path=path, data={'uploaded-file': file_pointer}) assert response.status_code == status + + def test_post_cohort_with_group_id(self): + """ + Test creating a cohort with group_id and user_partition_id. + """ + path = reverse('api_cohorts:cohort_handler', kwargs={'course_key_string': self.course_str}) + self.client.login(username=self.staff_user.username, password=self.password) + + payload = { + 'name': 'TestCohort', + 'assignment_type': 'manual', + 'group_id': 1, + 'user_partition_id': 50 + } + response = self.client.post(path=path, data=payload, content_type='application/json') + assert response.status_code == 200 + + data = response.json() + assert data['name'] == 'TestCohort' + assert data['assignment_type'] == 'manual' + assert data['group_id'] == 1 + assert data['user_partition_id'] == 50 + assert data['user_count'] == 0 + assert 'id' in data + + def test_post_cohort_with_group_id_missing_partition_id(self): + """ + Test that creating a cohort with group_id but without user_partition_id returns an error. + """ + path = reverse('api_cohorts:cohort_handler', kwargs={'course_key_string': self.course_str}) + self.client.login(username=self.staff_user.username, password=self.password) + + payload = { + 'name': 'TestCohort', + 'assignment_type': 'manual', + 'group_id': 1 + } + response = self.client.post(path=path, data=payload, content_type='application/json') + assert response.status_code == 400 + + data = response.json() + assert data['developer_message'] == 'If group_id is specified, user_partition_id must also be specified.' + assert data['error_code'] == 'missing-user-partition-id' + + def test_patch_cohort_set_group_id(self): + """ + Test updating a cohort to set group_id and user_partition_id. + """ + cohort = cohorts.add_cohort(self.course_key, "TestCohort", "manual") + path = reverse( + 'api_cohorts:cohort_handler', + kwargs={'course_key_string': self.course_str, 'cohort_id': cohort.id} + ) + self.client.login(username=self.staff_user.username, password=self.password) + + payload = { + 'group_id': 2, + 'user_partition_id': 50 + } + response = self.client.patch(path=path, data=payload, content_type='application/json') + assert response.status_code == 204 + + # Verify by fetching the cohort + response = self.client.get(path=path) + data = response.json() + assert data['id'] == cohort.id + assert data['name'] == 'TestCohort' + assert data['assignment_type'] == 'manual' + assert data['group_id'] == 2 + assert data['user_partition_id'] == 50 + + def test_patch_cohort_remove_group_id(self): + """ + Test updating a cohort to remove the group_id association by setting it to null. + """ + cohort = cohorts.add_cohort(self.course_key, "TestCohort", "manual") + link_cohort_to_partition_group(cohort, 50, 1) + + path = reverse( + 'api_cohorts:cohort_handler', + kwargs={'course_key_string': self.course_str, 'cohort_id': cohort.id} + ) + self.client.login(username=self.staff_user.username, password=self.password) + + # Verify the cohort has a group_id + response = self.client.get(path=path) + data = response.json() + assert data['id'] == cohort.id + assert data['name'] == 'TestCohort' + assert data['group_id'] == 1 + assert data['user_partition_id'] == 50 + + # Remove the group_id by setting it to null + payload = {'group_id': None} + response = self.client.patch(path=path, data=payload, content_type='application/json') + assert response.status_code == 204 + + # Verify the group_id was removed but other fields unchanged + response = self.client.get(path=path) + data = response.json() + assert data['id'] == cohort.id + assert data['name'] == 'TestCohort' + assert data['assignment_type'] == 'manual' + assert data['group_id'] is None + assert data['user_partition_id'] is None + + def test_patch_cohort_with_group_id_missing_partition_id(self): + """ + Test that updating a cohort with group_id but without user_partition_id returns an error. + """ + cohort = cohorts.add_cohort(self.course_key, "TestCohort", "manual") + path = reverse( + 'api_cohorts:cohort_handler', + kwargs={'course_key_string': self.course_str, 'cohort_id': cohort.id} + ) + self.client.login(username=self.staff_user.username, password=self.password) + + payload = {'group_id': 2} + response = self.client.patch(path=path, data=payload, content_type='application/json') + assert response.status_code == 400 + + data = response.json() + assert data['developer_message'] == 'If group_id is specified, user_partition_id must also be specified.' + assert data['error_code'] == 'missing-user-partition-id' + + def test_get_cohorts_default_ordering(self): + """ + Test that cohorts are returned in ascending alphabetical order by default. + """ + cohorts.add_cohort(self.course_key, "Zebra", "manual") + cohorts.add_cohort(self.course_key, "Alpha", "manual") + cohorts.add_cohort(self.course_key, "Mango", "manual") + + path = reverse('api_cohorts:cohort_handler', kwargs={'course_key_string': self.course_str}) + self.client.login(username=self.staff_user.username, password=self.password) + response = self.client.get(path=path) + + assert response.status_code == 200 + names = [c['name'] for c in response.json()] + assert names == ['Alpha', 'Mango', 'Zebra'] + + def test_get_cohorts_desc_ordering(self): + """ + Test that cohorts are returned in descending alphabetical order when ordering=desc. + """ + cohorts.add_cohort(self.course_key, "Zebra", "manual") + cohorts.add_cohort(self.course_key, "Alpha", "manual") + cohorts.add_cohort(self.course_key, "Mango", "manual") + + path = reverse('api_cohorts:cohort_handler', kwargs={'course_key_string': self.course_str}) + self.client.login(username=self.staff_user.username, password=self.password) + response = self.client.get(path=path, data={'ordering': 'desc'}) + + assert response.status_code == 200 + names = [c['name'] for c in response.json()] + assert names == ['Zebra', 'Mango', 'Alpha'] + + def test_get_cohorts_invalid_ordering(self): + """ + Test that an invalid ordering value returns a 400 error. + """ + path = reverse('api_cohorts:cohort_handler', kwargs={'course_key_string': self.course_str}) + self.client.login(username=self.staff_user.username, password=self.password) + response = self.client.get(path=path, data={'ordering': 'invalid'}) + + assert response.status_code == 400 + assert response.json().get('error_code') == 'invalid-ordering-value' + + def test_patch_cohort_with_name_only(self): + """ + Test that PATCH with only name is now valid (previously required assignment_type too). + """ + cohort = cohorts.add_cohort(self.course_key, "OldName", "manual") + path = reverse( + 'api_cohorts:cohort_handler', + kwargs={'course_key_string': self.course_str, 'cohort_id': cohort.id} + ) + self.client.login(username=self.staff_user.username, password=self.password) + + payload = {'name': 'NewName'} + response = self.client.patch(path=path, data=payload, content_type='application/json') + assert response.status_code == 204 + + # Verify the name was updated and other fields unchanged + response = self.client.get(path=path) + data = response.json() + assert data['id'] == cohort.id + assert data['name'] == 'NewName' + assert data['assignment_type'] == 'manual' + assert data['group_id'] is None + assert data['user_partition_id'] is None diff --git a/openedx/core/djangoapps/course_groups/tests/test_cohorts.py b/openedx/core/djangoapps/course_groups/tests/test_cohorts.py index 910eff2b0d01..ad37edadc131 100644 --- a/openedx/core/djangoapps/course_groups/tests/test_cohorts.py +++ b/openedx/core/djangoapps/course_groups/tests/test_cohorts.py @@ -4,21 +4,27 @@ # pylint: disable=no-member from unittest.mock import call, patch -import pytest + import ddt -from django.contrib.auth.models import AnonymousUser, User # lint-amnesty, pylint: disable=imported-auth-user -from django.db import IntegrityError +import pytest +from django.contrib.auth.models import AnonymousUser, User # pylint: disable=imported-auth-user +from django.db import IntegrityError, connection from django.http import Http404 from django.test import TestCase +from django.test.utils import CaptureQueriesContext from opaque_keys.edx.keys import CourseKey from opaque_keys.edx.locator import CourseLocator -from openedx_events.tests.utils import OpenEdxEventsTestMixin +from openedx_events.testing import OpenEdxEventsTestMixin from common.djangoapps.student.models import CourseEnrollment from common.djangoapps.student.tests.factories import UserFactory -from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.django_utils import TEST_DATA_SPLIT_MODULESTORE, ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import ToyCourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from openedx.core.djangolib.testing.utils import assert_redact_before_delete +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( # pylint: disable=wrong-import-order + TEST_DATA_SPLIT_MODULESTORE, + ModuleStoreTestCase, +) +from xmodule.modulestore.tests.factories import ToyCourseFactory # pylint: disable=wrong-import-order from .. import cohorts from ..models import CourseCohort, CourseUserGroup, CourseUserGroupPartitionGroup, UnregisteredLearnerCohortAssignments @@ -26,30 +32,13 @@ @patch("openedx.core.djangoapps.course_groups.cohorts.tracker", autospec=True) -class TestCohortSignals(TestCase, OpenEdxEventsTestMixin): +class TestCohortSignals(OpenEdxEventsTestMixin, TestCase): """ Test cases to validate event emissions for various cohort-related workflows """ ENABLED_OPENEDX_EVENTS = [] - @classmethod - def setUpClass(cls): - """ - Set up class method for the Test class. - - This method starts manually events isolation. Explanation here: - openedx/core/djangoapps/user_authn/views/tests/test_events.py#L44 - """ - super().setUpClass() - cls.start_events_isolation() - - @classmethod - def tearDownClass(cls): - """ Don't let our event isolation affect other test cases """ - super().tearDownClass() - cls.enable_all_events() # Re-enable events other than the ENABLED_OPENEDX_EVENTS subset we isolated. - def setUp(self): super().setUp() self.course_key = CourseLocator("dummy", "dummy", "dummy") @@ -235,7 +224,7 @@ def test_cannot_set_assignment_type(self): assert cohorts.get_assignment_type(cohort) == CourseCohort.RANDOM exception_msg = "There must be one cohort to which students can automatically be assigned." - with pytest.raises(ValueError) as context_manager: + with pytest.raises(ValueError) as context_manager: # noqa: PT011 cohorts.set_assignment_type(cohort, CourseCohort.MANUAL) assert exception_msg == str(context_manager.value) @@ -643,7 +632,7 @@ def test_set_cohorted_with_invalid_data_type(self): """ course = modulestore().get_course(self.toy_course_key) - with pytest.raises(ValueError) as value_error: + with pytest.raises(ValueError) as value_error: # noqa: PT011 cohorts.set_course_cohorted(course.id, 'not a boolean') assert 'Cohorted must be a boolean' == str(value_error.value) @@ -798,12 +787,18 @@ def setUp(self): ) def test_retired_user_has_deleted_record(self): - was_retired = UnregisteredLearnerCohortAssignments.delete_by_user_value( - value='learner@example.com', - field='email' - ) + with CaptureQueriesContext(connection) as ctx: + was_retired = UnregisteredLearnerCohortAssignments.delete_by_user_value( + value='learner@example.com', + field='email' + ) assert was_retired + assert_redact_before_delete( + [q['sql'] for q in ctx], + table=UnregisteredLearnerCohortAssignments._meta.db_table, + expected_redacted_value_list=['redacted-before-delete@safe.com'], + ) search_retired_user_results = \ UnregisteredLearnerCohortAssignments.objects.filter( diff --git a/openedx/core/djangoapps/course_groups/tests/test_events.py b/openedx/core/djangoapps/course_groups/tests/test_events.py index f11e95088fd0..958651e613f3 100644 --- a/openedx/core/djangoapps/course_groups/tests/test_events.py +++ b/openedx/core/djangoapps/course_groups/tests/test_events.py @@ -4,25 +4,32 @@ Classes: CohortEventTest: Test event sent after cohort membership changes. """ -from openedx.core.djangoapps.course_groups.models import CohortMembership -from unittest.mock import Mock # lint-amnesty, pylint: disable=wrong-import-order - -from openedx_events.learning.data import CohortData, CourseData, UserData, UserPersonalData # lint-amnesty, pylint: disable=wrong-import-order -from openedx_events.learning.signals import COHORT_MEMBERSHIP_CHANGED # lint-amnesty, pylint: disable=wrong-import-order -from openedx_events.tests.utils import OpenEdxEventsTestMixin # lint-amnesty, pylint: disable=wrong-import-order +from unittest.mock import Mock # pylint: disable=wrong-import-order + +from openedx_events.learning.data import ( # pylint: disable=wrong-import-order + CohortData, + CourseData, + UserData, + UserPersonalData, +) +from openedx_events.learning.signals import ( + COHORT_MEMBERSHIP_CHANGED, # pylint: disable=wrong-import-order +) +from openedx_events.testing import OpenEdxEventsTestMixin # pylint: disable=wrong-import-order from common.djangoapps.student.tests.factories import UserFactory +from common.test.utils import assert_dict_contains_subset from openedx.core.djangoapps.content.course_overviews.tests.factories import CourseOverviewFactory -from openedx.core.djangolib.testing.utils import skip_unless_lms - +from openedx.core.djangoapps.course_groups.models import CohortMembership from openedx.core.djangoapps.course_groups.tests.helpers import CohortFactory - -from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from common.test.utils import assert_dict_contains_subset +from openedx.core.djangolib.testing.utils import skip_unless_lms +from xmodule.modulestore.tests.django_utils import ( + SharedModuleStoreTestCase, # pylint: disable=wrong-import-order +) @skip_unless_lms -class CohortEventTest(SharedModuleStoreTestCase, OpenEdxEventsTestMixin): +class CohortEventTest(OpenEdxEventsTestMixin, SharedModuleStoreTestCase): """ Tests for the Open edX Events associated with the cohort update process. @@ -36,23 +43,6 @@ class CohortEventTest(SharedModuleStoreTestCase, OpenEdxEventsTestMixin): "org.openedx.learning.cohort_membership.changed.v1", ] - @classmethod - def setUpClass(cls): - """ - Set up class method for the Test class. - - This method starts manually events isolation. Explanation here: - openedx/core/djangoapps/user_authn/views/tests/test_events.py#L44 - """ - super().setUpClass() - cls.start_events_isolation() - - @classmethod - def tearDownClass(cls): - """ Don't let our event isolation affect other test cases """ - super().tearDownClass() - cls.enable_all_events() # Re-enable events other than the ENABLED_OPENEDX_EVENTS subset we isolated. - def setUp(self): # pylint: disable=arguments-differ super().setUp() self.course = CourseOverviewFactory() @@ -90,7 +80,7 @@ def test_send_cohort_membership_changed_event(self): user=self.user, ) - self.assertTrue(self.receiver_called) + self.assertTrue(self.receiver_called) # noqa: PT009 assert_dict_contains_subset( self, { diff --git a/openedx/core/djangoapps/course_groups/tests/test_filters.py b/openedx/core/djangoapps/course_groups/tests/test_filters.py index f51818d676bf..22bb473d5a16 100755 --- a/openedx/core/djangoapps/course_groups/tests/test_filters.py +++ b/openedx/core/djangoapps/course_groups/tests/test_filters.py @@ -4,7 +4,6 @@ from django.test import override_settings from openedx_filters import PipelineStep from openedx_filters.learning.filters import CohortAssignmentRequested, CohortChangeRequested -from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase from common.djangoapps.student.tests.factories import UserFactory from openedx.core.djangoapps.content.course_overviews.tests.factories import CourseOverviewFactory @@ -15,6 +14,7 @@ ) from openedx.core.djangoapps.course_groups.tests.helpers import CohortFactory from openedx.core.djangolib.testing.utils import skip_unless_lms +from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase class TestCohortChangeStep(PipelineStep): @@ -118,7 +118,7 @@ def test_cohort_change_filter_executed(self): cohort_membership, _ = CohortMembership.assign(cohort=self.second_cohort, user=self.user) - self.assertEqual( + self.assertEqual( # noqa: PT009 {"cohort_info": "Changed from Cohort FirstCohort to Cohort SecondCohort"}, cohort_membership.user.profile.get_meta(), ) @@ -145,7 +145,7 @@ def test_cohort_assignment_filter_executed(self): cohort_membership, _ = CohortMembership.assign(user=self.user, cohort=self.second_cohort, ) - self.assertEqual( + self.assertEqual( # noqa: PT009 {"cohort_info": "User assigned to Cohort SecondCohort"}, cohort_membership.user.profile.get_meta(), ) @@ -170,7 +170,7 @@ def test_cohort_change_filter_prevent_move(self): """ CohortMembership.assign(cohort=self.first_cohort, user=self.user) - with self.assertRaises(CohortChangeNotAllowed): + with self.assertRaises(CohortChangeNotAllowed): # noqa: PT027 CohortMembership.assign(cohort=self.second_cohort, user=self.user) @override_settings( @@ -191,7 +191,7 @@ def test_cohort_assignment_filter_prevent_move(self): - CohortAssignmentRequested is triggered and executes TestStopAssignmentChangeStep. - The user can't be assigned to the cohort. """ - with self.assertRaises(CohortAssignmentNotAllowed): + with self.assertRaises(CohortAssignmentNotAllowed): # noqa: PT027 CohortMembership.assign(cohort=self.second_cohort, user=self.user) @override_settings(OPEN_EDX_FILTERS_CONFIG={}) @@ -207,7 +207,7 @@ def test_cohort_change_without_filter_configuration(self): cohort_membership, _ = CohortMembership.assign(cohort=self.second_cohort, user=self.user) - self.assertEqual({}, cohort_membership.user.profile.get_meta()) + self.assertEqual({}, cohort_membership.user.profile.get_meta()) # noqa: PT009 @override_settings(OPEN_EDX_FILTERS_CONFIG={}) def test_cohort_assignment_without_filter_configuration(self): @@ -220,4 +220,4 @@ def test_cohort_assignment_without_filter_configuration(self): """ cohort_membership, _ = CohortMembership.assign(cohort=self.second_cohort, user=self.user) - self.assertEqual({}, cohort_membership.user.profile.get_meta()) + self.assertEqual({}, cohort_membership.user.profile.get_meta()) # noqa: PT009 diff --git a/openedx/core/djangoapps/course_groups/tests/test_partition_scheme.py b/openedx/core/djangoapps/course_groups/tests/test_partition_scheme.py index 73f824d9fab5..b2651ecb9401 100644 --- a/openedx/core/djangoapps/course_groups/tests/test_partition_scheme.py +++ b/openedx/core/djangoapps/course_groups/tests/test_partition_scheme.py @@ -5,16 +5,24 @@ from unittest.mock import patch + import django.test +from common.djangoapps.student.tests.factories import UserFactory from lms.djangoapps.courseware.tests.test_masquerade import StaffMasqueradeTestCase from openedx.core.djangoapps.user_api.partition_schemes import RandomUserPartitionScheme from openedx.core.djangolib.testing.utils import skip_unless_lms -from common.djangoapps.student.tests.factories import UserFactory -from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.django_utils import TEST_DATA_SPLIT_MODULESTORE, ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import ToyCourseFactory # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.partitions.partitions import Group, UserPartition, UserPartitionError # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( # pylint: disable=wrong-import-order + TEST_DATA_SPLIT_MODULESTORE, + ModuleStoreTestCase, +) +from xmodule.modulestore.tests.factories import ToyCourseFactory # pylint: disable=wrong-import-order +from xmodule.partitions.partitions import ( # pylint: disable=wrong-import-order + Group, + UserPartition, + UserPartitionError, +) from ..cohorts import add_user_to_cohort, get_course_cohorts, remove_user_from_cohort from ..models import CourseUserGroupPartitionGroup @@ -223,7 +231,7 @@ def test_missing_group(self): with patch('openedx.core.djangoapps.course_groups.partition_scheme.log') as mock_log: self.assert_student_in_group(None, new_user_partition) assert mock_log.warning.called - self.assertRegex(mock_log.warning.call_args[0][0], 'group not found') + self.assertRegex(mock_log.warning.call_args[0][0], 'group not found') # noqa: PT009 def test_missing_partition(self): """ @@ -248,18 +256,18 @@ def test_missing_partition(self): with patch('openedx.core.djangoapps.course_groups.partition_scheme.log') as mock_log: self.assert_student_in_group(None, new_user_partition) assert mock_log.warning.called - self.assertRegex(mock_log.warning.call_args[0][0], 'partition mismatch') + self.assertRegex(mock_log.warning.call_args[0][0], 'partition mismatch') # noqa: PT009 class TestExtension(django.test.TestCase): """ Ensure that the scheme extension is correctly plugged in (via entry point - in setup.py) + in pyproject.toml) """ def test_get_scheme(self): assert UserPartition.get_scheme('cohort') == CohortPartitionScheme - with self.assertRaisesRegex(UserPartitionError, 'Unrecognized scheme'): + with self.assertRaisesRegex(UserPartitionError, 'Unrecognized scheme'): # noqa: PT027 UserPartition.get_scheme('other') diff --git a/openedx/core/djangoapps/course_groups/tests/test_views.py b/openedx/core/djangoapps/course_groups/tests/test_views.py index b4eaad513923..08bfd61216c2 100644 --- a/openedx/core/djangoapps/course_groups/tests/test_views.py +++ b/openedx/core/djangoapps/course_groups/tests/test_views.py @@ -7,19 +7,20 @@ import json from collections import namedtuple + import pytest -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.http import Http404 from django.test.client import RequestFactory from opaque_keys.edx.locator import CourseLocator -from openedx.core.djangoapps.django_comment_common.models import CourseDiscussionSettings from common.djangoapps.student.models import CourseEnrollment -from common.djangoapps.student.tests.factories import InstructorFactory -from common.djangoapps.student.tests.factories import StaffFactory -from common.djangoapps.student.tests.factories import UserFactory -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from common.djangoapps.student.tests.factories import InstructorFactory, StaffFactory, UserFactory +from openedx.core.djangoapps.django_comment_common.models import CourseDiscussionSettings +from xmodule.modulestore.tests.django_utils import ( + ModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order from ..cohorts import DEFAULT_COHORT_NAME, get_cohort, get_cohort_by_id, get_cohort_by_name, get_group_info_for_cohort from ..models import CourseCohort, CourseUserGroup @@ -29,7 +30,7 @@ course_cohort_settings_handler, link_cohort_to_partition_group, remove_user_from_cohort, - users_in_cohort + users_in_cohort, ) from .helpers import CohortFactory, CourseCohortFactory, config_course_cohorts, config_course_cohorts_legacy @@ -93,7 +94,7 @@ def _verify_non_staff_cannot_access(self, view, request_method, view_args): request = RequestFactory().request() request.user = self.non_staff_user view_args.insert(0, request) - self.assertRaises(Http404, view, *view_args) + self.assertRaises(Http404, view, *view_args) # noqa: PT027 def get_handler(self, course, cohort=None, expected_response_code=200, handler=cohort_handler, user=None): """ @@ -997,7 +998,7 @@ def test_delimiters(self): """ unknown = "unknown_user" response_dict = self.request_add_users_to_cohort( - " {} {}\t{}, \r\n{}".format( + " {} {}\t{}, \r\n{}".format( # noqa: UP032 unknown, self.cohort1_users[0].username, self.cohort2_users[0].username, diff --git a/openedx/core/djangoapps/course_groups/urls.py b/openedx/core/djangoapps/course_groups/urls.py index 46fb0db85d80..508bb4650561 100644 --- a/openedx/core/djangoapps/course_groups/urls.py +++ b/openedx/core/djangoapps/course_groups/urls.py @@ -11,28 +11,28 @@ urlpatterns = [ re_path( - r'^v1/settings/{}$'.format( + r'^v1/settings/{}$'.format( # noqa: UP032 settings.COURSE_KEY_PATTERN, ), openedx.core.djangoapps.course_groups.views.CohortSettings.as_view(), name='cohort_settings', ), re_path( - r'^v1/courses/{}/cohorts/(?P[0-9]+)?$'.format( + r'^v1/courses/{}/cohorts/(?P[0-9]+)?$'.format( # noqa: UP032 settings.COURSE_KEY_PATTERN, ), openedx.core.djangoapps.course_groups.views.CohortHandler.as_view(), name='cohort_handler', ), re_path( - r'^v1/courses/{}/cohorts/(?P[0-9]+)/users/(?P.+)?$'.format( + r'^v1/courses/{}/cohorts/(?P[0-9]+)/users/(?P.+)?$'.format( # noqa: UP032 settings.COURSE_KEY_PATTERN, ), openedx.core.djangoapps.course_groups.views.CohortUsers.as_view(), name='cohort_users', ), re_path( - r'^v1/courses/{}/users?$'.format( + r'^v1/courses/{}/users?$'.format( # noqa: UP032 settings.COURSE_KEY_PATTERN, ), lms.djangoapps.instructor.views.api.CohortCSV.as_view(), diff --git a/openedx/core/djangoapps/course_groups/views.py b/openedx/core/djangoapps/course_groups/views.py index da66240e74b9..4f42516fda14 100644 --- a/openedx/core/djangoapps/course_groups/views.py +++ b/openedx/core/djangoapps/course_groups/views.py @@ -7,7 +7,7 @@ import re from django.contrib.auth.decorators import login_required -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.core.exceptions import ValidationError from django.core.paginator import EmptyPage, Paginator from django.http import Http404, HttpResponseBadRequest @@ -24,8 +24,10 @@ from rest_framework.response import Response from rest_framework.serializers import Serializer -from lms.djangoapps.courseware.courses import get_course, get_course_with_access from common.djangoapps.edxmako.shortcuts import render_to_response +from common.djangoapps.student.auth import has_course_author_access +from common.djangoapps.util.json_request import JsonResponse, expect_json +from lms.djangoapps.courseware.courses import get_course, get_course_with_access from openedx.core.djangoapps.course_groups.models import ( CohortAssignmentNotAllowed, CohortChangeNotAllowed, @@ -34,8 +36,6 @@ from openedx.core.djangoapps.course_groups.permissions import IsStaffOrAdmin from openedx.core.lib.api.authentication import BearerAuthenticationAllowInactiveUser from openedx.core.lib.api.view_utils import DeveloperErrorViewMixin -from common.djangoapps.student.auth import has_course_author_access -from common.djangoapps.util.json_request import JsonResponse, expect_json from . import api, cohorts from .models import CourseUserGroup, CourseUserGroupPartitionGroup @@ -313,7 +313,7 @@ def add_users_to_cohort(request, course_key_string, cohort_id): try: cohort = cohorts.get_cohort_by_id(course_key, cohort_id) except CourseUserGroup.DoesNotExist: - raise Http404("Cohort (ID {cohort_id}) not found for {course_key_string}".format( # lint-amnesty, pylint: disable=raise-missing-from + raise Http404("Cohort (ID {cohort_id}) not found for {course_key_string}".format( # pylint: disable=raise-missing-from # noqa: B904, UP032 cohort_id=cohort_id, course_key_string=course_key_string )) @@ -366,7 +366,7 @@ def add_users_to_cohort(request, course_key_string, cohort_id): @ensure_csrf_cookie @require_POST -def remove_user_from_cohort(request, course_key_string, cohort_id): # lint-amnesty, pylint: disable=unused-argument +def remove_user_from_cohort(request, course_key_string, cohort_id): # pylint: disable=unused-argument """ Expects 'username': username in POST data. @@ -424,6 +424,44 @@ def _get_cohort_response(cohort, course): return Response(_get_cohort_representation(cohort, course), status=status.HTTP_200_OK) +def _update_cohort_partition_group(cohort, group_id, user_partition_id, api_error_func): + """ + Helper method to update the partition group association for a cohort. + + Note: This logic is duplicated from the legacy cohort_handler function (lines 218-234). + We chose not to refactor cohort_handler to use this helper because: + 1. cohort_handler returns JsonResponse for errors, while this helper uses DRF's api_error pattern + 2. Unifying the error handling would require changing cohort_handler's interface or adding + try/except blocks, which could have downstream effects on existing callers + 3. The legacy endpoint may be deprecated in favor of the v1 API in the future + + Args: + cohort: The cohort to update + group_id: The group_id from the request (can be None to unlink, or an integer to link) + user_partition_id: The user_partition_id from the request + api_error_func: Function to call to raise API errors (e.g., self.api_error) + + Raises: + API error if group_id is provided without user_partition_id + """ + if group_id is not None: + if user_partition_id is None: + raise api_error_func( + status.HTTP_400_BAD_REQUEST, + 'If group_id is specified, user_partition_id must also be specified.', + 'missing-user-partition-id' + ) + existing_group_id, existing_partition_id = cohorts.get_group_info_for_cohort(cohort) + if group_id != existing_group_id or user_partition_id != existing_partition_id: + unlink_cohort_partition_group(cohort) + link_cohort_to_partition_group(cohort, user_partition_id, group_id) + else: + # If group_id was explicitly set to None, unlink the cohort from any partition group + existing_group_id, _ = cohorts.get_group_info_for_cohort(cohort) + if existing_group_id is not None: + unlink_cohort_partition_group(cohort) + + def _get_cohort_settings_response(course_key): """ Helper method to return a serialized response for the cohort settings. @@ -480,7 +518,7 @@ def put(self, request, course_key_string): try: cohorts.set_course_cohorted(course_key, request.data.get('is_cohorted')) except ValueError as err: - raise self.api_error(status.HTTP_400_BAD_REQUEST, err) + raise self.api_error(status.HTTP_400_BAD_REQUEST, err) # noqa: B904 return _get_cohort_settings_response(course_key) @@ -494,11 +532,37 @@ class CohortHandler(DeveloperErrorViewMixin, APIPermissions): **Example Requests**: - GET /api/cohorts/v1/courses/{course_id}/cohorts - POST /api/cohorts/v1/courses/{course_id}/cohorts + GET /api/cohorts/v1/courses/{course_id}/cohorts/ + GET /api/cohorts/v1/courses/{course_id}/cohorts/?ordering=asc + GET /api/cohorts/v1/courses/{course_id}/cohorts/?ordering=desc + POST /api/cohorts/v1/courses/{course_id}/cohorts/ GET /api/cohorts/v1/courses/{course_id}/cohorts/{cohort_id} PATCH /api/cohorts/v1/courses/{course_id}/cohorts/{cohort_id} + **GET Query Parameters** + + * ordering (optional): Sort direction for the cohort list by name. Accepted values are + "asc" (ascending, default) and "desc" (descending). Returns HTTP 400 for invalid values. + + **POST Request Values** + + * name (required): The string identifier for a cohort. + * assignment_type (required): The string representing the assignment type ("manual" or "random"). + * user_partition_id (optional): The integer identifier of the UserPartition (content group configuration). + * group_id (optional): The integer identifier of the specific group in the partition. + If group_id is specified, user_partition_id must also be specified. + + **PATCH Request Values** + + * name (optional): The string identifier for a cohort. + * assignment_type (optional): The string representing the assignment type ("manual" or "random"). + * user_partition_id (optional): The integer identifier of the UserPartition (content group configuration). + * group_id (optional): The integer identifier of the specific group in the partition. + Set group_id to null to remove the content group association. + If group_id is specified (non-null), user_partition_id must also be specified. + + At least one of name, assignment_type, or group_id must be provided. + **Response Values** * cohorts: List of cohorts. @@ -507,8 +571,8 @@ class CohortHandler(DeveloperErrorViewMixin, APIPermissions): * id: The integer identifier for a cohort. * user_count: The number of students in the cohort. * assignment_type: The string representing the assignment type. - * user_partition_id: The integer identified of the UserPartition. - * group_id: The integer identified of the specific group in the partition. + * user_partition_id: The integer identifier of the UserPartition. + * group_id: The integer identifier of the specific group in the partition. """ queryset = [] @@ -518,7 +582,14 @@ def get(self, request, course_key_string, cohort_id=None): """ course_key, course = _get_course_with_access(request, course_key_string, 'load') if not cohort_id: - all_cohorts = cohorts.get_course_cohorts(course) + ordering = request.query_params.get('ordering', 'asc').lower() + if ordering not in ('asc', 'desc'): + raise self.api_error( + status.HTTP_400_BAD_REQUEST, + 'Invalid ordering value. Must be "asc" or "desc".', + 'invalid-ordering-value' + ) + all_cohorts = cohorts.get_course_cohorts(course, ordering=ordering) paginator = NamespacedPageNumberPagination() paginator.max_page_size = MAX_PAGE_SIZE page = paginator.paginate_queryset(all_cohorts, request) @@ -547,12 +618,20 @@ def post(self, request, course_key_string, cohort_id=None): raise self.api_error(status.HTTP_400_BAD_REQUEST, '"assignment_type" must be specified to create cohort.', 'missing-assignment-type') - return _get_cohort_response( - cohorts.add_cohort(course_key, name, assignment_type), course) + + cohort = cohorts.add_cohort(course_key, name, assignment_type) + + # Handle optional group_id and user_partition_id for content group association + group_id = request.data.get('group_id') + user_partition_id = request.data.get('user_partition_id') + if group_id is not None or user_partition_id is not None: + _update_cohort_partition_group(cohort, group_id, user_partition_id, self.api_error) + + return _get_cohort_response(cohort, course) def patch(self, request, course_key_string, cohort_id=None): """ - Endpoint to update a cohort name and/or assignment type. + Endpoint to update a cohort name, assignment type, and/or content group association. """ if cohort_id is None: raise self.api_error(status.HTTP_405_METHOD_NOT_ALLOWED, @@ -560,9 +639,16 @@ def patch(self, request, course_key_string, cohort_id=None): 'missing-cohort-id') name = request.data.get('name') assignment_type = request.data.get('assignment_type') - if not any((name, assignment_type)): + # has_group_id checks key presence rather than truthiness because + # group_id=null is a valid request to unlink the content group association, + # which is distinct from group_id not being sent at all (no change). + has_group_id = 'group_id' in request.data + group_id = request.data.get('group_id') + user_partition_id = request.data.get('user_partition_id') + + if not any((name, assignment_type, has_group_id)): raise self.api_error(status.HTTP_400_BAD_REQUEST, - 'Request must include name and/or assignment type.', + 'Request must include name, assignment_type, and/or group_id.', 'missing-fields') course_key, _ = _get_course_with_access(request, course_key_string) cohort = cohorts.get_cohort_by_id(course_key, cohort_id) @@ -577,7 +663,12 @@ def patch(self, request, course_key_string, cohort_id=None): try: cohorts.set_assignment_type(cohort, assignment_type) except ValueError as e: - raise self.api_error(status.HTTP_400_BAD_REQUEST, str(e), 'last-random-cohort') + raise self.api_error(status.HTTP_400_BAD_REQUEST, str(e), 'last-random-cohort') # noqa: B904 + + # Handle group_id and user_partition_id for content group association + if has_group_id: + _update_cohort_partition_group(cohort, group_id, user_partition_id, self.api_error) + return Response(status=status.HTTP_204_NO_CONTENT) @@ -679,11 +770,11 @@ def _get_course_and_cohort(self, request, course_key_string, cohort_id): try: cohort = cohorts.get_cohort_by_id(course_key, cohort_id) except CourseUserGroup.DoesNotExist: - msg = 'Cohort (ID {cohort_id}) not found for {course_key_string}'.format( + msg = 'Cohort (ID {cohort_id}) not found for {course_key_string}'.format( # noqa: UP032 cohort_id=cohort_id, course_key_string=course_key_string ) - raise self.api_error(status.HTTP_404_NOT_FOUND, msg, 'cohort-not-found') # lint-amnesty, pylint: disable=raise-missing-from + raise self.api_error(status.HTTP_404_NOT_FOUND, msg, 'cohort-not-found') # pylint: disable=raise-missing-from # noqa: B904 return course_key, cohort def get(self, request, course_key_string, cohort_id, username=None): # pylint: disable=unused-argument @@ -716,9 +807,9 @@ def delete(self, request, course_key_string, cohort_id, username=None): try: api.remove_user_from_cohort(course_key, username, cohort.id) except User.DoesNotExist: - raise self.api_error(status.HTTP_404_NOT_FOUND, 'User does not exist.', 'user-not-found') # lint-amnesty, pylint: disable=raise-missing-from + raise self.api_error(status.HTTP_404_NOT_FOUND, 'User does not exist.', 'user-not-found') # pylint: disable=raise-missing-from # noqa: B904 except CohortMembership.DoesNotExist: # pylint: disable=duplicate-except - raise self.api_error( # lint-amnesty, pylint: disable=raise-missing-from + raise self.api_error( # pylint: disable=raise-missing-from # noqa: B904 status.HTTP_400_BAD_REQUEST, 'User not assigned to the given cohort.', 'user-not-in-cohort' diff --git a/openedx/core/djangoapps/course_live/README.rst b/openedx/core/djangoapps/course_live/README.rst index c24dcb61fecf..cefb461644c3 100644 --- a/openedx/core/djangoapps/course_live/README.rst +++ b/openedx/core/djangoapps/course_live/README.rst @@ -1,2 +1,5 @@ +Course Live +=========== + This plugin app allow you to enable/disable the live tab in a course. The live tab is used to integrate video conferencing tools like "Zoom". diff --git a/openedx/core/djangoapps/course_live/docs/decisions/001-course-live.rst b/openedx/core/djangoapps/course_live/docs/decisions/001-course-live.rst index 27ee3b488482..9fbed126c654 100644 --- a/openedx/core/djangoapps/course_live/docs/decisions/001-course-live.rst +++ b/openedx/core/djangoapps/course_live/docs/decisions/001-course-live.rst @@ -29,10 +29,10 @@ Decision We proposed to add the course live as a plugin with the following structure Course Live App Plugin Class ------------------------ +---------------------------- -The app will be loaded as a plugin and added to `setup.py` with the namespace -"openedx.course_app". +The app will be loaded as a plugin and added to ``pyproject.toml`` with the namespace +``openedx.course_app``. .. code-block :: python diff --git a/openedx/core/djangoapps/course_live/migrations/0001_initial.py b/openedx/core/djangoapps/course_live/migrations/0001_initial.py index 7deb99f9f4bf..fceb3ec249d8 100644 --- a/openedx/core/djangoapps/course_live/migrations/0001_initial.py +++ b/openedx/core/djangoapps/course_live/migrations/0001_initial.py @@ -1,12 +1,12 @@ # Generated by Django 3.2.12 on 2022-02-23 08:07 -from django.conf import settings -from django.db import migrations, models import django.db.models.deletion import django.utils.timezone import model_utils.fields import opaque_keys.edx.django.models import simple_history.models +from django.conf import settings +from django.db import migrations, models class Migration(migrations.Migration): diff --git a/openedx/core/djangoapps/course_live/plugins.py b/openedx/core/djangoapps/course_live/plugins.py index c211e27a61b0..b95c28bdfa27 100644 --- a/openedx/core/djangoapps/course_live/plugins.py +++ b/openedx/core/djangoapps/course_live/plugins.py @@ -1,9 +1,9 @@ """ Course app configuration for live. """ -from typing import Dict, Optional -from django.conf import settings +from typing import Dict, Optional # noqa: UP035 +from django.conf import settings from django.contrib.auth import get_user_model from django.utils.translation import gettext_noop as _ from lti_consumer.models import LtiConfiguration @@ -57,7 +57,7 @@ def set_enabled(cls, course_key: CourseKey, enabled: bool, user: User) -> bool: return configuration.enabled @classmethod - def get_allowed_operations(cls, course_key: CourseKey, user: Optional[User] = None) -> Dict[str, bool]: + def get_allowed_operations(cls, course_key: CourseKey, user: Optional[User] = None) -> Dict[str, bool]: # noqa: UP006, UP045 # pylint: disable=line-too-long """ Return allowed operations for live app. """ diff --git a/openedx/core/djangoapps/course_live/providers.py b/openedx/core/djangoapps/course_live/providers.py index 5379ae260b7a..f36cf8d18d47 100644 --- a/openedx/core/djangoapps/course_live/providers.py +++ b/openedx/core/djangoapps/course_live/providers.py @@ -2,7 +2,8 @@ LTI Providers for course live module """ from abc import ABC -from typing import List, Dict +from typing import Dict, List # noqa: UP035 + from django.conf import settings @@ -12,10 +13,10 @@ class LiveProvider(ABC): """ id: str name: str - features: List[str] = [] + features: List[str] = [] # noqa: UP006 requires_username: bool = False requires_email: bool = False - additional_parameters: List[str] = [] + additional_parameters: List[str] = [] # noqa: UP006 @property def has_free_tier(self) -> bool: @@ -66,7 +67,7 @@ class HasGlobalCredentials(ABC): url: str @staticmethod - def get_global_keys() -> Dict: + def get_global_keys() -> Dict: # noqa: UP006 """ Get keys from settings """ @@ -121,7 +122,7 @@ def is_enabled(self) -> bool: return True @staticmethod - def get_global_keys() -> Dict: + def get_global_keys() -> Dict: # noqa: UP006 """ Get keys from settings """ @@ -147,13 +148,13 @@ class ProviderManager: """ This class provides access to all available provider objects """ - providers: Dict[str, LiveProvider] + providers: Dict[str, LiveProvider] # noqa: UP006 def __init__(self): # auto detect live providers. self.providers = {provider.id: provider() for provider in LiveProvider.__subclasses__()} - def get_enabled_providers(self) -> Dict[str, LiveProvider]: + def get_enabled_providers(self) -> Dict[str, LiveProvider]: # noqa: UP006 """ Get Enabled providers """ diff --git a/openedx/core/djangoapps/course_live/tests/test_views.py b/openedx/core/djangoapps/course_live/tests/test_views.py index 97ed4c9ce194..495dfccc969a 100644 --- a/openedx/core/djangoapps/course_live/tests/test_views.py +++ b/openedx/core/djangoapps/course_live/tests/test_views.py @@ -2,12 +2,14 @@ Test for course live app views """ import json + import ddt from django.test import RequestFactory from django.urls import reverse from lti_consumer.models import CourseAllowPIISharingInLTIFlag, LtiConfiguration from markupsafe import Markup from rest_framework.test import APITestCase + from xmodule.modulestore import ModuleStoreEnum from xmodule.modulestore.tests.django_utils import CourseUserType, ModuleStoreTestCase from xmodule.modulestore.tests.factories import CourseFactory @@ -76,7 +78,7 @@ def test_pii_sharing_not_allowed(self): Test response if PII sharing is not allowed """ response = self._get() - self.assertEqual(response.status_code, 200) + self.assertEqual(response.status_code, 200) # noqa: PT009 expected_data = { 'course_key': None, 'provider_type': '', @@ -90,7 +92,7 @@ def test_pii_sharing_not_allowed(self): 'free_tier': False, 'pii_sharing_allowed': False } - self.assertEqual(response.data, expected_data) + self.assertEqual(response.data, expected_data) # noqa: PT009 def test_pii_sharing_is_allowed(self): """ @@ -98,7 +100,7 @@ def test_pii_sharing_is_allowed(self): """ CourseAllowPIISharingInLTIFlag.objects.create(course_id=self.course.id, enabled=True) response = self._get() - self.assertEqual(response.status_code, 200) + self.assertEqual(response.status_code, 200) # noqa: PT009 expected_data = { 'enabled': True, 'course_key': None, @@ -113,7 +115,7 @@ def test_pii_sharing_is_allowed(self): 'provider_type': '' } content = json.loads(response.content.decode('utf-8')) - self.assertEqual(content, expected_data) + self.assertEqual(content, expected_data) # noqa: PT009 @ddt.data(('zoom', False, False), ('big_blue_button', False, True)) @ddt.unpack @@ -124,26 +126,26 @@ def test_create_configurations_data(self, provider, share_email, share_username) lti_config, data, response = self.create_course_live_config(provider) course_live_configurations = CourseLiveConfiguration.get(self.course.id) lti_configuration = course_live_configurations.get(self.course.id).lti_configuration - self.assertEqual(self.course.id, course_live_configurations.course_key) - self.assertEqual(data['enabled'], course_live_configurations.enabled) - self.assertEqual(data['provider_type'], course_live_configurations.provider_type) + self.assertEqual(self.course.id, course_live_configurations.course_key) # noqa: PT009 + self.assertEqual(data['enabled'], course_live_configurations.enabled) # noqa: PT009 + self.assertEqual(data['provider_type'], course_live_configurations.provider_type) # noqa: PT009 - self.assertEqual(lti_config['lti_1p1_client_key'], lti_configuration.lti_1p1_client_key) - self.assertEqual(lti_config['lti_1p1_client_secret'], lti_configuration.lti_1p1_client_secret) - self.assertEqual(lti_config['lti_1p1_launch_url'], lti_configuration.lti_1p1_launch_url) + self.assertEqual(lti_config['lti_1p1_client_key'], lti_configuration.lti_1p1_client_key) # noqa: PT009 + self.assertEqual(lti_config['lti_1p1_client_secret'], lti_configuration.lti_1p1_client_secret) # noqa: PT009 + self.assertEqual(lti_config['lti_1p1_launch_url'], lti_configuration.lti_1p1_launch_url) # noqa: PT009 provider_instance = ProviderManager().get_enabled_providers().get(provider) additional_param = {'additional_parameters': {}} if provider_instance.additional_parameters: additional_param = {'additional_parameters': {'custom_instructor_email': 'email@example.com'}} - self.assertEqual({ + self.assertEqual({ # noqa: PT009 'pii_share_username': share_username, 'pii_share_email': share_email, **additional_param }, lti_configuration.lti_config) - self.assertEqual(response.status_code, 200) + self.assertEqual(response.status_code, 200) # noqa: PT009 @ddt.data(('zoom', False, False), ('big_blue_button', False, True)) @ddt.unpack @@ -172,26 +174,26 @@ def test_update_configurations_data(self, provider, share_email, share_username) live_configurations = CourseLiveConfiguration.get(self.course.id) lti_configuration = live_configurations.get(self.course.id).lti_configuration - self.assertEqual(self.course.id, live_configurations.course_key) - self.assertEqual(updated_data['enabled'], live_configurations.enabled) - self.assertEqual(updated_data['provider_type'], live_configurations.provider_type) + self.assertEqual(self.course.id, live_configurations.course_key) # noqa: PT009 + self.assertEqual(updated_data['enabled'], live_configurations.enabled) # noqa: PT009 + self.assertEqual(updated_data['provider_type'], live_configurations.provider_type) # noqa: PT009 - self.assertEqual(updated_lti_config.get('lti_1p1_client_key'), lti_configuration.lti_1p1_client_key) - self.assertEqual(lti_config.get('lti_1p1_client_secret'), lti_configuration.lti_1p1_client_secret) - self.assertEqual(updated_lti_config.get('lti_1p1_launch_url'), lti_configuration.lti_1p1_launch_url) + self.assertEqual(updated_lti_config.get('lti_1p1_client_key'), lti_configuration.lti_1p1_client_key) # noqa: PT009 # pylint: disable=line-too-long + self.assertEqual(lti_config.get('lti_1p1_client_secret'), lti_configuration.lti_1p1_client_secret) # noqa: PT009 # pylint: disable=line-too-long + self.assertEqual(updated_lti_config.get('lti_1p1_launch_url'), lti_configuration.lti_1p1_launch_url) # noqa: PT009 # pylint: disable=line-too-long provider_instance = ProviderManager().get_enabled_providers().get(provider) additional_param = {'additional_parameters': {}} if provider_instance.additional_parameters: additional_param = updated_lti_config.get('lti_config') - self.assertEqual({ + self.assertEqual({ # noqa: PT009 'pii_share_username': share_username, 'pii_share_email': share_email, **additional_param }, lti_configuration.lti_config) - self.assertEqual(response.status_code, 200) + self.assertEqual(response.status_code, 200) # noqa: PT009 @ddt.data(('zoom', False, False), ('big_blue_button', False, True)) @ddt.unpack @@ -225,8 +227,8 @@ def test_create_configurations_response(self, provider, share_email, share_usern } content = json.loads(response.content.decode('utf-8')) - self.assertEqual(response.status_code, 200) - self.assertEqual(content, expected_data) + self.assertEqual(response.status_code, 200) # noqa: PT009 + self.assertEqual(content, expected_data) # noqa: PT009 @ddt.data(('zoom', False, False), ('big_blue_button', False, True)) @ddt.unpack @@ -251,7 +253,7 @@ def test_update_configurations_response(self, provider, share_email, share_usern } response = self._post(updated_data) content = json.loads(response.content.decode('utf-8')) - self.assertEqual(response.status_code, 200) + self.assertEqual(response.status_code, 200) # noqa: PT009 provider_instance = ProviderManager().get_enabled_providers().get(provider) additional_param = {'additional_parameters': {}} @@ -275,7 +277,7 @@ def test_update_configurations_response(self, provider, share_email, share_usern }, 'pii_sharing_allowed': share_email or share_username } - self.assertEqual(content, expected_data) + self.assertEqual(content, expected_data) # noqa: PT009 def test_post_error_messages(self): """ @@ -287,8 +289,8 @@ def test_post_error_messages(self): expected_data = { 'provider_type': ['This field is required.'], } - self.assertEqual(content, expected_data) - self.assertEqual(response.status_code, 400) + self.assertEqual(content, expected_data) # noqa: PT009 + self.assertEqual(response.status_code, 400) # noqa: PT009 def test_non_staff_user_access(self): """ @@ -297,13 +299,13 @@ def test_non_staff_user_access(self): self.user = self.create_user_for_course(self.course, user_type=CourseUserType.UNENROLLED) response = self._get() content = json.loads(response.content.decode('utf-8')) - self.assertEqual(response.status_code, 403) - self.assertEqual(content, {'detail': 'You do not have permission to perform this action.'}) + self.assertEqual(response.status_code, 403) # noqa: PT009 + self.assertEqual(content, {'detail': 'You do not have permission to perform this action.'}) # noqa: PT009 response = self._post({}) content = json.loads(response.content.decode('utf-8')) - self.assertEqual(response.status_code, 403) - self.assertEqual(content, {'detail': 'You do not have permission to perform this action.'}) + self.assertEqual(response.status_code, 403) # noqa: PT009 + self.assertEqual(content, {'detail': 'You do not have permission to perform this action.'}) # noqa: PT009 def test_courseware_api_has_live_tab(self): """ @@ -314,7 +316,7 @@ def test_courseware_api_has_live_tab(self): response = self.client.get(url) content = json.loads(response.content.decode('utf-8')) data = next((tab for tab in content['tabs'] if tab['tab_id'] == 'lti_live'), None) - self.assertEqual(data, { + self.assertEqual(data, { # noqa: PT009 'tab_id': 'lti_live', 'title': 'Live', 'url': f'http://learning-mfe/course/{self.course.id}/live' @@ -348,8 +350,8 @@ def test_create_configurations_response_free_tier(self, provider, share_email, s } content = json.loads(response.content.decode('utf-8')) - self.assertEqual(response.status_code, 200) - self.assertEqual(content, expected_data) + self.assertEqual(response.status_code, 200) # noqa: PT009 + self.assertEqual(content, expected_data) # noqa: PT009 class TestCourseLiveProvidersView(ModuleStoreTestCase, APITestCase): @@ -382,7 +384,7 @@ def test_response_has_correct_data(self): } response = self.client.get(self.url) content = json.loads(response.content.decode('utf-8')) - self.assertEqual(content, expected_data) + self.assertEqual(content, expected_data) # noqa: PT009 class TestCourseLiveIFrameView(ModuleStoreTestCase, APITestCase): @@ -428,9 +430,9 @@ def test_api_returns_live_iframe(self): ) live_config.save() response = self.client.get(self.url) - self.assertEqual(response.status_code, 200) - self.assertIsInstance(response.data['iframe'], Markup) - self.assertIn('iframe', str(response.data['iframe'])) + self.assertEqual(response.status_code, 200) # noqa: PT009 + self.assertIsInstance(response.data['iframe'], Markup) # noqa: PT009 + self.assertIn('iframe', str(response.data['iframe'])) # noqa: PT009 def test_non_authenticated_user(self): """ @@ -438,7 +440,7 @@ def test_non_authenticated_user(self): """ self.client.logout() response = self.client.get(self.url) - self.assertEqual(response.status_code, 401) + self.assertEqual(response.status_code, 401) # noqa: PT009 def test_not_enrolled_user(self): """ @@ -446,7 +448,7 @@ def test_not_enrolled_user(self): """ self.user = self.create_user_for_course(self.course, user_type=CourseUserType.UNENROLLED) response = self.client.get(self.url) - self.assertEqual(response.status_code, 403) + self.assertEqual(response.status_code, 403) # noqa: PT009 def test_live_configuration_disabled(self): """ @@ -458,4 +460,4 @@ def test_live_configuration_disabled(self): provider_type="zoom", ) response = self.client.get(self.url) - self.assertEqual(response.data['developer_message'], 'Course live is not enabled for this course.') + self.assertEqual(response.data['developer_message'], 'Course live is not enabled for this course.') # noqa: PT009 # pylint: disable=line-too-long diff --git a/openedx/core/djangoapps/course_live/urls.py b/openedx/core/djangoapps/course_live/urls.py index e8fa2fc1d500..d39fdc4b445a 100644 --- a/openedx/core/djangoapps/course_live/urls.py +++ b/openedx/core/djangoapps/course_live/urls.py @@ -9,7 +9,7 @@ from openedx.core.djangoapps.course_live.views import ( CourseLiveConfigurationView, CourseLiveIframeView, - CourseLiveProvidersView + CourseLiveProvidersView, ) urlpatterns = [ diff --git a/openedx/core/djangoapps/course_live/views.py b/openedx/core/djangoapps/course_live/views.py index d148e9301897..a25358571f4c 100644 --- a/openedx/core/djangoapps/course_live/views.py +++ b/openedx/core/djangoapps/course_live/views.py @@ -1,7 +1,7 @@ """ View for course live app """ -from typing import Dict +from typing import Dict # noqa: UP035 import edx_api_doc_tools as apidocs from edx_rest_framework_extensions.auth.jwt.authentication import JwtAuthentication @@ -19,9 +19,10 @@ from openedx.core.djangoapps.course_live.permissions import IsEnrolledOrStaff, IsStaffOrInstructor from openedx.core.djangoapps.course_live.tab import CourseLiveTab from openedx.core.lib.api.authentication import BearerAuthenticationAllowInactiveUser -from .providers import ProviderManager + from ...lib.api.view_utils import verify_course_exists from .models import CourseLiveConfiguration +from .providers import ProviderManager from .serializers import CourseLiveConfigurationSerializer @@ -192,7 +193,7 @@ def get(self, request, course_id: str, **_kwargs) -> Response: return Response(data) @staticmethod - def get_provider_data(course_id: str) -> Dict: + def get_provider_data(course_id: str) -> Dict: # noqa: UP006 """ Get provider data for specified course Args: diff --git a/openedx/core/djangoapps/courseware_api/serializers.py b/openedx/core/djangoapps/courseware_api/serializers.py index c4b6476cb764..366264d1b44c 100644 --- a/openedx/core/djangoapps/courseware_api/serializers.py +++ b/openedx/core/djangoapps/courseware_api/serializers.py @@ -4,8 +4,8 @@ from rest_framework import serializers -from lms.djangoapps.course_home_api.progress.serializers import CertificateDataSerializer from lms.djangoapps.course_home_api.outline.serializers import CourseGoalsSerializer +from lms.djangoapps.course_home_api.progress.serializers import CertificateDataSerializer from openedx.core.lib.api.fields import AbsoluteURLField @@ -57,7 +57,7 @@ class Meta: ref_name = 'courseware_api' -class CourseProgramSerializer(serializers.Serializer): # lint-amnesty, pylint: disable=abstract-method, missing-class-docstring +class CourseProgramSerializer(serializers.Serializer): # pylint: disable=abstract-method, missing-class-docstring progress = serializers.SerializerMethodField() slug = serializers.CharField() title = serializers.CharField() diff --git a/openedx/core/djangoapps/courseware_api/tests/pacts/verify_pact.py b/openedx/core/djangoapps/courseware_api/tests/pacts/verify_pact.py index 10c209d08542..81568ef7e3a1 100644 --- a/openedx/core/djangoapps/courseware_api/tests/pacts/verify_pact.py +++ b/openedx/core/djangoapps/courseware_api/tests/pacts/verify_pact.py @@ -10,7 +10,6 @@ from openedx.features.discounts.applicability import DISCOUNT_APPLICABILITY_FLAG - log = logging.getLogger(__name__) logging.basicConfig(level=logging.DEBUG) @@ -21,27 +20,16 @@ class ProviderVerificationServer(LiveServerTestCase): """ Live Server for Pact Verification""" - @classmethod - def setUpClass(cls): - super().setUpClass() - - cls.PACT_URL = cls.live_server_url - - cls.verifier = Verifier( - provider='lms', - provider_base_url=cls.PACT_URL, - ) - - @classmethod - def tearDownClass(cls): - super().tearDownClass() - @override_waffle_flag(DISCOUNT_APPLICABILITY_FLAG, active=True) def test_verify_pact(self): - output, _ = self.verifier.verify_pacts( - os.path.join(PACT_DIR, PACT_FILE), - headers=['Pact-Authentication: Allow', ], - provider_states_setup_url=f"{self.PACT_URL}{reverse('courseware_api:provider-state-view')}", + ( + Verifier(name='lms') + .add_transport(url=self.live_server_url) + .add_source(os.path.join(PACT_DIR, PACT_FILE)) + .add_custom_header('Pact-Authentication', 'Allow') + .state_handler( + f"{self.live_server_url}{reverse('courseware_api:provider-state-view')}", + body=True, + ) + .verify() ) - - assert output == 0 diff --git a/openedx/core/djangoapps/courseware_api/tests/pacts/views.py b/openedx/core/djangoapps/courseware_api/tests/pacts/views.py index 11abeac9cc5c..345f9aaa42c1 100644 --- a/openedx/core/djangoapps/courseware_api/tests/pacts/views.py +++ b/openedx/core/djangoapps/courseware_api/tests/pacts/views.py @@ -8,13 +8,13 @@ from django.views.decorators.csrf import csrf_exempt from django.views.decorators.http import require_POST from opaque_keys.edx.keys import CourseKey, UsageKey -from xmodule.modulestore.tests.django_utils import ModuleStoreIsolationMixin -from xmodule.modulestore.tests.factories import CourseFactory, BlockFactory, ToyCourseFactory from common.djangoapps.course_modes.models import CourseMode from common.djangoapps.course_modes.tests.factories import CourseModeFactory from common.djangoapps.student.models import CourseEnrollment from openedx.features.course_duration_limits.models import CourseDurationLimitConfig +from xmodule.modulestore.tests.django_utils import ModuleStoreIsolationMixin +from xmodule.modulestore.tests.factories import BlockFactory, CourseFactory, ToyCourseFactory class ProviderState(ModuleStoreIsolationMixin): @@ -129,7 +129,7 @@ def provider_state(request): state = request_body.get('state') if state in state_setup_mapping: - print('Setting up provider state for state value: {}'.format(state)) + print('Setting up provider state for state value: {}'.format(state)) # noqa: UP032 state_setup_mapping[state](request) return JsonResponse({'result': state}) diff --git a/openedx/core/djangoapps/courseware_api/tests/test_views.py b/openedx/core/djangoapps/courseware_api/tests/test_views.py index 62fd6d557b34..2d44fefdf2bf 100644 --- a/openedx/core/djangoapps/courseware_api/tests/test_views.py +++ b/openedx/core/djangoapps/courseware_api/tests/test_views.py @@ -3,9 +3,9 @@ """ from datetime import datetime, timedelta -from urllib.parse import urlencode from typing import Optional from unittest import mock +from urllib.parse import urlencode import ddt from completion.test_utils import CompletionWaffleTestMixin, submit_completions_for_testing @@ -13,39 +13,37 @@ from django.contrib.auth import get_user_model from django.test import override_settings from django.test.client import RequestFactory - from edx_django_utils.cache import TieredCache from edx_toggles.toggles.testutils import override_waffle_flag, override_waffle_switch -from xmodule.data import CertificatesDisplayBehaviors -from xmodule.modulestore.django import modulestore -from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase -from xmodule.modulestore.tests.factories import BlockFactory, ToyCourseFactory -from xmodule.partitions.partitions import ENROLLMENT_TRACK_PARTITION_ID from common.djangoapps.course_modes.models import CourseMode from common.djangoapps.course_modes.tests.factories import CourseModeFactory +from common.djangoapps.student.models import CourseEnrollment, CourseEnrollmentCelebration +from common.djangoapps.student.roles import CourseInstructorRole +from common.djangoapps.student.tests.factories import CourseEnrollmentCelebrationFactory, UserFactory from lms.djangoapps.certificates.api import get_certificate_url from lms.djangoapps.certificates.tests.factories import ( - GeneratedCertificateFactory, LinkedInAddToProfileConfigurationFactory + GeneratedCertificateFactory, + LinkedInAddToProfileConfigurationFactory, ) from lms.djangoapps.courseware.access_utils import ACCESS_DENIED, ACCESS_GRANTED from lms.djangoapps.courseware.models import LastSeenCoursewareTimezone from lms.djangoapps.courseware.tabs import ExternalLinkCourseTab from lms.djangoapps.courseware.tests.helpers import MasqueradeMixin from lms.djangoapps.courseware.toggles import ( + COURSEWARE_MFE_MILESTONES_STREAK_DISCOUNT, COURSEWARE_MICROFRONTEND_PROGRESS_MILESTONES, COURSEWARE_MICROFRONTEND_PROGRESS_MILESTONES_STREAK_CELEBRATION, ) -from lms.djangoapps.courseware.toggles import COURSEWARE_MFE_MILESTONES_STREAK_DISCOUNT from lms.djangoapps.verify_student.services import IDVerificationService -from common.djangoapps.student.models import ( - CourseEnrollment, CourseEnrollmentCelebration -) -from common.djangoapps.student.roles import CourseInstructorRole -from common.djangoapps.student.tests.factories import CourseEnrollmentCelebrationFactory, UserFactory from openedx.core.djangoapps.agreements.api import create_integrity_signature from openedx.core.djangolib.testing.utils import skip_unless_lms from openedx.features.course_experience.waffle import ENABLE_COURSE_ABOUT_SIDEBAR_HTML +from xmodule.data import CertificatesDisplayBehaviors +from xmodule.modulestore.django import modulestore +from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase +from xmodule.modulestore.tests.factories import BlockFactory, ToyCourseFactory +from xmodule.partitions.partitions import ENROLLMENT_TRACK_PARTITION_ID User = get_user_model() @@ -183,7 +181,7 @@ def test_enrolled_course_metadata(self, logged_in, enrollment_mode): request = RequestFactory().request() cert_url = get_certificate_url(course_id=self.course.id, uuid=cert.verify_uuid) linkedin_url_params = { - 'name': '{platform_name} Verified Certificate for {course_name}'.format( + 'name': '{platform_name} Verified Certificate for {course_name}'.format( # noqa: UP032 platform_name=settings.PLATFORM_NAME, course_name=self.course.display_name, ), 'certUrl': request.build_absolute_uri(cert_url), @@ -194,7 +192,7 @@ def test_enrolled_course_metadata(self, logged_in, enrollment_mode): 'issueMonth': cert.created_date.month, } expected_linkedin_url = ( - 'https://www.linkedin.com/profile/add?startTask=CERTIFICATION_NAME&{params}'.format( + 'https://www.linkedin.com/profile/add?startTask=CERTIFICATION_NAME&{params}'.format( # noqa: UP032 params=urlencode(linkedin_url_params) ) ) @@ -281,7 +279,7 @@ def test_course_access( mfe_is_visible: bool, username: str, enroll_user: bool, - masquerade_role: Optional[str], + masquerade_role: Optional[str], # noqa: UP045 ): """ Test that course_access is calculated correctly based on @@ -439,7 +437,7 @@ def test_learning_assistant_enabled(self, setting_enabled): response = self.client.get(self.url) learning_assistant_enabled = response.json()['learning_assistant_enabled'] - self.assertEqual(learning_assistant_enabled, setting_enabled) + self.assertEqual(learning_assistant_enabled, setting_enabled) # noqa: PT009 @ddt.ddt diff --git a/openedx/core/djangoapps/courseware_api/views.py b/openedx/core/djangoapps/courseware_api/views.py index 3ad5430c774a..8d10cb223e6d 100644 --- a/openedx/core/djangoapps/courseware_api/views.py +++ b/openedx/core/djangoapps/courseware_api/views.py @@ -19,44 +19,42 @@ from rest_framework.response import Response from rest_framework.views import APIView -from xmodule.modulestore import ModuleStoreEnum # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.django import modulestore -from xmodule.modulestore.exceptions import ItemNotFoundError, NoPathToItem -from xmodule.modulestore.search import path_to_location -from xmodule.x_module import PUBLIC_VIEW, STUDENT_VIEW - from common.djangoapps.course_modes.models import CourseMode, get_course_prices +from common.djangoapps.student.models import ( + CourseEnrollment, + CourseEnrollmentCelebration, + LinkedInAddToProfileConfiguration, +) +from common.djangoapps.util.milestones_helpers import get_prerequisite_courses_display from common.djangoapps.util.views import expose_header -from lms.djangoapps.edxnotes.helpers import is_feature_enabled from lms.djangoapps.certificates.api import get_certificate_url, get_eligible_certificate from lms.djangoapps.commerce.utils import EcommerceService from lms.djangoapps.course_api.api import course_detail -from lms.djangoapps.course_goals.models import UserActivity from lms.djangoapps.course_goals.api import get_course_goal +from lms.djangoapps.course_goals.models import UserActivity from lms.djangoapps.courseware.access import has_access from lms.djangoapps.courseware.access_utils import check_public_access +from lms.djangoapps.courseware.block_render import get_block_by_usage_id +from lms.djangoapps.courseware.context_processor import user_timezone_locale_prefs from lms.djangoapps.courseware.courses import ( get_course_about_section, get_course_with_access, get_permission_for_course_about, ) - -from lms.djangoapps.courseware.context_processor import user_timezone_locale_prefs from lms.djangoapps.courseware.entrance_exams import course_has_entrance_exam, user_has_passed_entrance_exam from lms.djangoapps.courseware.masquerade import ( + is_masquerading_as_non_audit_enrollment, is_masquerading_as_specific_student, setup_masquerade, - is_masquerading_as_non_audit_enrollment, ) from lms.djangoapps.courseware.models import LastSeenCoursewareTimezone from lms.djangoapps.courseware.permissions import VIEW_COURSEWARE -from lms.djangoapps.courseware.block_render import get_block_by_usage_id from lms.djangoapps.courseware.toggles import course_exit_page_is_active, course_is_invitation_only from lms.djangoapps.courseware.views.views import get_cert_data +from lms.djangoapps.edxnotes.helpers import is_feature_enabled from lms.djangoapps.gating.api import get_entrance_exam_score, get_entrance_exam_usage_key from lms.djangoapps.grades.api import CourseGradeFactory from lms.djangoapps.instructor.enrollment import uses_shib -from common.djangoapps.util.milestones_helpers import get_prerequisite_courses_display from lms.djangoapps.verify_student.services import IDVerificationService from openedx.core.djangoapps.agreements.api import get_integrity_signature from openedx.core.djangoapps.courseware_api.utils import get_celebrations_dict @@ -66,20 +64,17 @@ from openedx.core.lib.api.authentication import BearerAuthenticationAllowInactiveUser from openedx.core.lib.api.view_utils import DeveloperErrorViewMixin from openedx.core.lib.courses import get_course_by_id -from openedx.features.course_experience import ENABLE_COURSE_GOALS -from openedx.features.course_experience.waffle import ENABLE_COURSE_ABOUT_SIDEBAR_HTML from openedx.features.content_type_gating.models import ContentTypeGatingConfig from openedx.features.course_duration_limits.access import get_access_expiration_data +from openedx.features.course_experience import ENABLE_COURSE_GOALS +from openedx.features.course_experience.waffle import ENABLE_COURSE_ABOUT_SIDEBAR_HTML from openedx.features.discounts.utils import generate_offer_data -from common.djangoapps.student.models import ( - CourseEnrollment, - CourseEnrollmentCelebration, - LinkedInAddToProfileConfiguration -) -from xmodule.course_block import ( - COURSE_VISIBILITY_PUBLIC, - COURSE_VISIBILITY_PUBLIC_OUTLINE, -) +from xmodule.course_block import COURSE_VISIBILITY_PUBLIC, COURSE_VISIBILITY_PUBLIC_OUTLINE +from xmodule.modulestore import ModuleStoreEnum # pylint: disable=wrong-import-order +from xmodule.modulestore.django import modulestore +from xmodule.modulestore.exceptions import ItemNotFoundError, NoPathToItem +from xmodule.modulestore.search import path_to_location +from xmodule.x_module import PUBLIC_VIEW, STUDENT_VIEW from .serializers import CourseInfoSerializer @@ -691,7 +686,7 @@ def set_last_seen_courseware_timezone(self, user): if not user.id: return - cache_key = 'browser_timezone_{}'.format(str(user.id)) + cache_key = 'browser_timezone_{}'.format(str(user.id)) # noqa: UP032 browser_timezone = self.request.query_params.get('browser_timezone', None) cached_value = TieredCache.get_cached_response(cache_key) if not cached_value.is_found: @@ -779,7 +774,7 @@ class SequenceMetadata(DeveloperErrorViewMixin, APIView): SessionAuthenticationAllowInactiveUser, ) - def get(self, request, usage_key_string, *args, **kwargs): # lint-amnesty, pylint: disable=unused-argument + def get(self, request, usage_key_string, *args, **kwargs): # pylint: disable=unused-argument """ Return response to a GET request. """ @@ -860,7 +855,7 @@ class Resume(DeveloperErrorViewMixin, APIView): ) permission_classes = (IsAuthenticated,) - def get(self, request, course_key_string, *args, **kwargs): # lint-amnesty, pylint: disable=unused-argument + def get(self, request, course_key_string, *args, **kwargs): # pylint: disable=unused-argument """ Return response to a GET request. """ @@ -916,7 +911,7 @@ class Celebration(DeveloperErrorViewMixin, APIView): permission_classes = (IsAuthenticated,) http_method_names = ['post'] - def post(self, request, course_key_string, *args, **kwargs): # lint-amnesty, pylint: disable=unused-argument + def post(self, request, course_key_string, *args, **kwargs): # pylint: disable=unused-argument """ Handle a POST request. """ diff --git a/openedx/core/djangoapps/crawlers/migrations/0001_initial.py b/openedx/core/djangoapps/crawlers/migrations/0001_initial.py index 336b31e1a8aa..2293e58c2f4c 100644 --- a/openedx/core/djangoapps/crawlers/migrations/0001_initial.py +++ b/openedx/core/djangoapps/crawlers/migrations/0001_initial.py @@ -1,6 +1,6 @@ -from django.db import migrations, models import django.db.models.deletion from django.conf import settings +from django.db import migrations, models class Migration(migrations.Migration): diff --git a/openedx/core/djangoapps/crawlers/tests/test_models.py b/openedx/core/djangoapps/crawlers/tests/test_models.py index e7813faa467c..e0497794af30 100644 --- a/openedx/core/djangoapps/crawlers/tests/test_models.py +++ b/openedx/core/djangoapps/crawlers/tests/test_models.py @@ -4,13 +4,14 @@ import ddt -from django.test import TestCase from django.http import HttpRequest +from django.test import TestCase + from ..models import CrawlersConfig @ddt.ddt -class CrawlersConfigTest(TestCase): # lint-amnesty, pylint: disable=missing-class-docstring +class CrawlersConfigTest(TestCase): # pylint: disable=missing-class-docstring def setUp(self): super().setUp() diff --git a/openedx/core/djangoapps/credentials/apps.py b/openedx/core/djangoapps/credentials/apps.py index b70cf0461db9..10d1babacda0 100644 --- a/openedx/core/djangoapps/credentials/apps.py +++ b/openedx/core/djangoapps/credentials/apps.py @@ -44,4 +44,6 @@ class CredentialsConfig(AppConfig): def ready(self): # Register celery workers - from openedx.core.djangoapps.credentials.tasks.v1 import tasks # lint-amnesty, pylint: disable=unused-import, unused-variable + from openedx.core.djangoapps.credentials.tasks.v1 import ( # pylint: disable=unused-import, unused-variable + tasks, # noqa: F401 + ) diff --git a/openedx/core/djangoapps/credentials/management/commands/create_credentials_api_configuration.py b/openedx/core/djangoapps/credentials/management/commands/create_credentials_api_configuration.py index 95fb0ebbfa9e..8a4102246cab 100644 --- a/openedx/core/djangoapps/credentials/management/commands/create_credentials_api_configuration.py +++ b/openedx/core/djangoapps/credentials/management/commands/create_credentials_api_configuration.py @@ -2,6 +2,7 @@ Django management command used to enable Credentials functionality in this Open edX instance. """ from django.core.management.base import BaseCommand, CommandError + from openedx.core.djangoapps.credentials.models import CredentialsApiConfig diff --git a/openedx/core/djangoapps/credentials/management/commands/notify_credentials.py b/openedx/core/djangoapps/credentials/management/commands/notify_credentials.py index 374975cf3ae7..a74b8b923c73 100644 --- a/openedx/core/djangoapps/credentials/management/commands/notify_credentials.py +++ b/openedx/core/djangoapps/credentials/management/commands/notify_credentials.py @@ -10,7 +10,6 @@ import logging import shlex - from datetime import datetime, timedelta from zoneinfo import ZoneInfo @@ -20,12 +19,12 @@ from opaque_keys import InvalidKeyError from opaque_keys.edx.keys import CourseKey -from openedx.core.djangoapps.credentials.models import NotifyCredentialsConfig -from openedx.core.djangoapps.credentials.tasks.v1.tasks import handle_notify_credentials from openedx.core.djangoapps.catalog.api import ( - get_programs_from_cache_by_uuid, get_course_run_key_for_program_from_cache, + get_programs_from_cache_by_uuid, ) +from openedx.core.djangoapps.credentials.models import NotifyCredentialsConfig +from openedx.core.djangoapps.credentials.tasks.v1.tasks import handle_notify_credentials log = logging.getLogger(__name__) @@ -226,5 +225,5 @@ def _get_validated_course_run_keys(self, course_run_keys): # keep the string; the celery task needs JSON serializable data. validated_course_run_keys.append(str(CourseKey.from_string(course_run_key))) except InvalidKeyError as exc: - raise CommandError("{} is not a parsable CourseKey".format(course_run_key)) from exc + raise CommandError("{} is not a parsable CourseKey".format(course_run_key)) from exc # noqa: UP032 return validated_course_run_keys diff --git a/openedx/core/djangoapps/credentials/management/commands/tests/test_create_credentials_api_configuration.py b/openedx/core/djangoapps/credentials/management/commands/tests/test_create_credentials_api_configuration.py index 9aea1e25ea63..60dc873251e2 100644 --- a/openedx/core/djangoapps/credentials/management/commands/tests/test_create_credentials_api_configuration.py +++ b/openedx/core/djangoapps/credentials/management/commands/tests/test_create_credentials_api_configuration.py @@ -2,9 +2,8 @@ Tests for the create_credentials_api_configuration command """ -from unittest import TestCase +from unittest import TestCase, mock -from unittest import mock import pytest from django.core.management import call_command diff --git a/openedx/core/djangoapps/credentials/management/commands/tests/test_notify_credentials.py b/openedx/core/djangoapps/credentials/management/commands/tests/test_notify_credentials.py index f7bed3446aca..fc2b56a1de2c 100644 --- a/openedx/core/djangoapps/credentials/management/commands/tests/test_notify_credentials.py +++ b/openedx/core/djangoapps/credentials/management/commands/tests/test_notify_credentials.py @@ -1,4 +1,4 @@ -""" # lint-amnesty, pylint: disable=django-not-configured +""" # pylint: disable=django-not-configured Tests the ``notify_credentials`` management command. """ @@ -10,11 +10,11 @@ from django.test import TestCase, override_settings from freezegun import freeze_time -from openedx.core.djangoapps.catalog.tests.factories import ProgramFactory, CourseFactory, CourseRunFactory +from common.djangoapps.student.tests.factories import UserFactory +from openedx.core.djangoapps.catalog.tests.factories import CourseFactory, CourseRunFactory, ProgramFactory from openedx.core.djangoapps.credentials.models import NotifyCredentialsConfig from openedx.core.djangoapps.site_configuration.tests.factories import SiteConfigurationFactory from openedx.core.djangolib.testing.utils import skip_unless_lms -from common.djangoapps.student.tests.factories import UserFactory from ..notify_credentials import Command @@ -148,35 +148,35 @@ def test_auto_execution_different_schedule(self, mock_task): assert mock_task.call_args[0][0] == self.expected_options def test_date_args(self, mock_task): - self.expected_options['start_date'] = datetime(2017, 1, 31, 0, 0, tzinfo=timezone.utc) + self.expected_options['start_date'] = datetime(2017, 1, 31, 0, 0, tzinfo=timezone.utc) # noqa: UP017 call_command(Command(), '--start-date', '2017-01-31') assert mock_task.called assert mock_task.call_args[0][0] == self.expected_options mock_task.reset_mock() - self.expected_options['start_date'] = datetime(2017, 2, 1, 0, 0, tzinfo=timezone.utc) - self.expected_options['end_date'] = datetime(2017, 2, 2, 0, 0, tzinfo=timezone.utc) + self.expected_options['start_date'] = datetime(2017, 2, 1, 0, 0, tzinfo=timezone.utc) # noqa: UP017 + self.expected_options['end_date'] = datetime(2017, 2, 2, 0, 0, tzinfo=timezone.utc) # noqa: UP017 call_command(Command(), '--start-date', '2017-02-01', '--end-date', '2017-02-02') assert mock_task.called assert mock_task.call_args[0][0] == self.expected_options mock_task.reset_mock() self.expected_options['start_date'] = None - self.expected_options['end_date'] = datetime(2017, 2, 2, 0, 0, tzinfo=timezone.utc) + self.expected_options['end_date'] = datetime(2017, 2, 2, 0, 0, tzinfo=timezone.utc) # noqa: UP017 call_command(Command(), '--end-date', '2017-02-02') assert mock_task.called assert mock_task.call_args[0][0] == self.expected_options mock_task.reset_mock() - self.expected_options['start_date'] = datetime(2017, 2, 1, 0, 0, tzinfo=timezone.utc) - self.expected_options['end_date'] = datetime(2017, 2, 1, 4, 0, tzinfo=timezone.utc) + self.expected_options['start_date'] = datetime(2017, 2, 1, 0, 0, tzinfo=timezone.utc) # noqa: UP017 + self.expected_options['end_date'] = datetime(2017, 2, 1, 4, 0, tzinfo=timezone.utc) # noqa: UP017 call_command(Command(), '--start-date', "2017-02-01 00:00:00", '--end-date', '2017-02-01 04:00:00') assert mock_task.called assert mock_task.call_args[0][0] == self.expected_options def test_username_arg(self, mock_task): - self.expected_options['start_date'] = datetime(2017, 2, 1, 0, 0, tzinfo=timezone.utc) - self.expected_options['end_date'] = datetime(2017, 2, 2, 0, 0, tzinfo=timezone.utc) + self.expected_options['start_date'] = datetime(2017, 2, 1, 0, 0, tzinfo=timezone.utc) # noqa: UP017 + self.expected_options['end_date'] = datetime(2017, 2, 2, 0, 0, tzinfo=timezone.utc) # noqa: UP017 self.expected_options['user_ids'] = [str(self.user2.id)] call_command( 'notify_credentials', '--start-date', '2017-02-01', '--end-date', '2017-02-02', '--user_ids', self.user2.id @@ -195,8 +195,8 @@ def test_username_arg(self, mock_task): assert mock_task.call_args[0][0] == self.expected_options mock_task.reset_mock() - self.expected_options['start_date'] = datetime(2017, 2, 1, 0, 0, tzinfo=timezone.utc) - self.expected_options['end_date'] = datetime(2017, 2, 2, 0, 0, tzinfo=timezone.utc) + self.expected_options['start_date'] = datetime(2017, 2, 1, 0, 0, tzinfo=timezone.utc) # noqa: UP017 + self.expected_options['end_date'] = datetime(2017, 2, 2, 0, 0, tzinfo=timezone.utc) # noqa: UP017 self.expected_options['user_ids'] = [str(self.user.id)] call_command( 'notify_credentials', '--start-date', '2017-02-01', '--end-date', '2017-02-02', '--user_ids', self.user.id @@ -226,33 +226,33 @@ def test_username_arg(self, mock_task): mock_task.reset_mock() def test_no_args(self, mock_task): - with self.assertRaisesRegex(CommandError, 'You must specify a filter.*'): + with self.assertRaisesRegex(CommandError, 'You must specify a filter.*'): # noqa: PT027 call_command(Command()) assert not mock_task.called def test_dry_run(self, mock_task): - self.expected_options['start_date'] = datetime(2017, 2, 1, 0, 0, tzinfo=timezone.utc) + self.expected_options['start_date'] = datetime(2017, 2, 1, 0, 0, tzinfo=timezone.utc) # noqa: UP017 self.expected_options['dry_run'] = True call_command(Command(), '--dry-run', '--start-date', '2017-02-01') assert mock_task.called assert mock_task.call_args[0][0] == self.expected_options def test_hand_off(self, mock_task): - self.expected_options['start_date'] = datetime(2017, 2, 1, 0, 0, tzinfo=timezone.utc) + self.expected_options['start_date'] = datetime(2017, 2, 1, 0, 0, tzinfo=timezone.utc) # noqa: UP017 self.expected_options['notify_programs'] = True call_command(Command(), '--start-date', '2017-02-01', '--notify_programs') assert mock_task.called assert mock_task.call_args[0][0] == self.expected_options def test_delay(self, mock_task): - self.expected_options['start_date'] = datetime(2017, 2, 1, 0, 0, tzinfo=timezone.utc) + self.expected_options['start_date'] = datetime(2017, 2, 1, 0, 0, tzinfo=timezone.utc) # noqa: UP017 self.expected_options['delay'] = 0.2 call_command(Command(), '--start-date', '2017-02-01', '--delay', '0.2') assert mock_task.called assert mock_task.call_args[0][0] == self.expected_options def test_page_size(self, mock_task): - self.expected_options['start_date'] = datetime(2017, 2, 1, 0, 0, tzinfo=timezone.utc) + self.expected_options['start_date'] = datetime(2017, 2, 1, 0, 0, tzinfo=timezone.utc) # noqa: UP017 self.expected_options['page_size'] = 2 call_command(Command(), '--start-date', '2017-02-01', '--page-size=2') assert mock_task.called @@ -263,7 +263,7 @@ def test_site(self, mock_task): site_values={'course_org_filter': ['testX']} ) self.expected_options['site'] = site_config.site.domain - self.expected_options['start_date'] = datetime(2017, 1, 1, 0, 0, tzinfo=timezone.utc) + self.expected_options['start_date'] = datetime(2017, 1, 1, 0, 0, tzinfo=timezone.utc) # noqa: UP017 call_command(Command(), '--site', site_config.site.domain, '--start-date', '2017-01-01') assert mock_task.called @@ -271,7 +271,7 @@ def test_site(self, mock_task): def test_args_from_database(self, mock_task): # Nothing in the database, should default to disabled - with self.assertRaisesRegex(CommandError, 'NotifyCredentialsConfig is disabled.*'): + with self.assertRaisesRegex(CommandError, 'NotifyCredentialsConfig is disabled.*'): # noqa: PT027 call_command(Command(), '--start-date', '2017-01-01', '--args-from-database') # Add a config @@ -281,13 +281,13 @@ def test_args_from_database(self, mock_task): config.save() # Not told to use config, should ignore it - self.expected_options['start_date'] = datetime(2017, 1, 1, 0, 0, tzinfo=timezone.utc) + self.expected_options['start_date'] = datetime(2017, 1, 1, 0, 0, tzinfo=timezone.utc) # noqa: UP017 call_command(Command(), '--start-date', '2017-01-01') assert mock_task.called assert mock_task.call_args[0][0] == self.expected_options # Told to use it, and enabled. Should use config in preference of command line - self.expected_options['start_date'] = datetime(2017, 3, 1, 0, 0, tzinfo=timezone.utc) + self.expected_options['start_date'] = datetime(2017, 3, 1, 0, 0, tzinfo=timezone.utc) # noqa: UP017 self.expected_options['skip_checks'] = False call_command(Command(), '--start-date', '2017-01-01', '--args-from-database') assert mock_task.called @@ -297,7 +297,7 @@ def test_args_from_database(self, mock_task): config.save() # Explicitly disabled - with self.assertRaisesRegex(CommandError, 'NotifyCredentialsConfig is disabled.*'): + with self.assertRaisesRegex(CommandError, 'NotifyCredentialsConfig is disabled.*'): # noqa: PT027 call_command(Command(), '--start-date', '2017-01-01', '--args-from-database') def test_args_revoke_program_cert(self, mock_task): diff --git a/openedx/core/djangoapps/credentials/models.py b/openedx/core/djangoapps/credentials/models.py index 716d0e96aeec..760d24d112cb 100644 --- a/openedx/core/djangoapps/credentials/models.py +++ b/openedx/core/djangoapps/credentials/models.py @@ -8,7 +8,6 @@ from config_models.models import ConfigurationModel from django.conf import settings from django.db import models - from django.utils.translation import gettext_lazy as _ from openedx.core.djangoapps.site_configuration import helpers diff --git a/openedx/core/djangoapps/credentials/settings/production.py b/openedx/core/djangoapps/credentials/settings/production.py index f25e83ecc3a4..edbe4a0c056e 100644 --- a/openedx/core/djangoapps/credentials/settings/production.py +++ b/openedx/core/djangoapps/credentials/settings/production.py @@ -1,7 +1,7 @@ """Production settings for Credentials""" -def plugin_settings(settings): # lint-amnesty, pylint: disable=missing-function-docstring +def plugin_settings(settings): # pylint: disable=missing-function-docstring # Credentials Settings settings.CREDENTIALS_INTERNAL_SERVICE_URL = settings.ENV_TOKENS.get( 'CREDENTIALS_INTERNAL_SERVICE_URL', settings.CREDENTIALS_INTERNAL_SERVICE_URL diff --git a/openedx/core/djangoapps/credentials/tasks/v1/tasks.py b/openedx/core/djangoapps/credentials/tasks/v1/tasks.py index 603ab88e9255..953d138cbfc9 100644 --- a/openedx/core/djangoapps/credentials/tasks/v1/tasks.py +++ b/openedx/core/djangoapps/credentials/tasks/v1/tasks.py @@ -16,16 +16,13 @@ from opaque_keys.edx.keys import CourseKey from common.djangoapps.course_modes.models import CourseMode -from lms.djangoapps.certificates.api import ( - get_generated_certificate, - get_recently_modified_certificates -) +from lms.djangoapps.certificates.api import get_generated_certificate, get_recently_modified_certificates from lms.djangoapps.certificates.data import CertificateStatuses from lms.djangoapps.grades.api import CourseGradeFactory, get_recently_modified_grades from openedx.core.djangoapps.catalog.utils import get_programs from openedx.core.djangoapps.content.course_overviews.models import CourseOverview -from openedx.core.djangoapps.credentials.helpers import is_learner_records_enabled_for_org from openedx.core.djangoapps.credentials.api import is_credentials_enabled +from openedx.core.djangoapps.credentials.helpers import is_learner_records_enabled_for_org from openedx.core.djangoapps.credentials.utils import get_credentials_api_base_url, get_credentials_api_client from openedx.core.djangoapps.programs.signals import ( handle_course_cert_awarded, diff --git a/openedx/core/djangoapps/credentials/tests/test_signals.py b/openedx/core/djangoapps/credentials/tests/test_signals.py index cd1771fb9204..d408c9b59fbf 100644 --- a/openedx/core/djangoapps/credentials/tests/test_signals.py +++ b/openedx/core/djangoapps/credentials/tests/test_signals.py @@ -3,15 +3,19 @@ from unittest import mock -from django.conf import settings # lint-amnesty, pylint: disable=unused-import -from django.test import TestCase, override_settings # lint-amnesty, pylint: disable=unused-import +from django.conf import settings # pylint: disable=unused-import # noqa: F401 +from django.test import TestCase, override_settings # pylint: disable=unused-import # noqa: F401 +from common.djangoapps.student.tests.factories import UserFactory from lms.djangoapps.certificates.tests.factories import GeneratedCertificateFactory from lms.djangoapps.grades.course_grade_factory import CourseGradeFactory from openedx.core.djangolib.testing.utils import skip_unless_lms -from common.djangoapps.student.tests.factories import UserFactory -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory as XModuleCourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + ModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import ( + CourseFactory as XModuleCourseFactory, # pylint: disable=wrong-import-order +) SIGNALS_MODULE = 'openedx.core.djangoapps.credentials.signals' diff --git a/openedx/core/djangoapps/credentials/tests/test_tasks.py b/openedx/core/djangoapps/credentials/tests/test_tasks.py index 6fb752302bd1..de0dd7f0c1fb 100644 --- a/openedx/core/djangoapps/credentials/tests/test_tasks.py +++ b/openedx/core/djangoapps/credentials/tests/test_tasks.py @@ -3,8 +3,8 @@ """ import logging +from datetime import datetime, timedelta, timezone from unittest import mock -from datetime import datetime, timezone, timedelta import ddt import pytest @@ -19,10 +19,10 @@ from common.djangoapps.student.tests.factories import UserFactory from lms.djangoapps.certificates.api import get_recently_modified_certificates from lms.djangoapps.certificates.data import CertificateStatuses +from lms.djangoapps.certificates.tests.factories import CertificateDateOverrideFactory, GeneratedCertificateFactory from lms.djangoapps.grades.models import PersistentCourseGrade from lms.djangoapps.grades.models_api import get_recently_modified_grades from lms.djangoapps.grades.tests.utils import mock_passing_grade -from lms.djangoapps.certificates.tests.factories import CertificateDateOverrideFactory, GeneratedCertificateFactory from openedx.core.djangoapps.catalog.tests.factories import CourseFactory, CourseRunFactory, ProgramFactory from openedx.core.djangoapps.content.course_overviews.tests.factories import CourseOverviewFactory from openedx.core.djangoapps.credentials.helpers import is_learner_records_enabled @@ -31,7 +31,6 @@ from openedx.core.djangolib.testing.utils import skip_unless_lms from xmodule.data import CertificatesDisplayBehaviors - User = get_user_model() LOGGER_NAME = "openedx.core.djangoapps.credentials.tasks.v1.tasks" TASKS_MODULE = 'openedx.core.djangoapps.credentials.tasks.v1.tasks' @@ -74,7 +73,7 @@ def test_happy_path(self, mock_get_api_client): assert mock_get_api_client.call_args[0] == (self.user,) assert api_client.post.call_count == 1 - self.assertDictEqual(api_client.post.call_args[1]['data'], { + self.assertDictEqual(api_client.post.call_args[1]['data'], { # noqa: PT009 'username': 'user', 'course_run': 'course-v1:org+course+run', 'letter_grade': 'A', @@ -91,7 +90,7 @@ def test_retry(self, mock_get_api_client): task = tasks.send_grade_to_credentials.delay('user', 'course-v1:org+course+run', True, 'A', 1.0, None) - pytest.raises(Exception, task.get) + pytest.raises(Exception, task.get) # noqa: B017 assert mock_get_api_client.call_count == 11 @@ -197,8 +196,8 @@ def test_auto_execution(self, mock_send): tasks.handle_notify_credentials(options=self.options, course_keys=[]) assert mock_send.called - self.assertListEqual(list(mock_send.call_args[0][0]), [cert3, cert1, cert2]) - self.assertListEqual(list(mock_send.call_args[0][1]), [grade1, grade2]) + self.assertListEqual(list(mock_send.call_args[0][0]), [cert3, cert1, cert2]) # noqa: PT009 + self.assertListEqual(list(mock_send.call_args[0][1]), [grade1, grade2]) # noqa: PT009 assert len(list(mock_send.call_args[0][0])) <= len(total_certificates) assert len(list(mock_send.call_args[0][1])) <= len(total_grades) @@ -259,52 +258,52 @@ def test_certs_with_modified_date_overrides(self, mock_send): # The three certs should now be included in the arguments because of the # the altered date overrides. assert mock_send.called - self.assertListEqual(list(mock_send.call_args[0][0]), [self.cert1, self.cert2, self.cert3]) + self.assertListEqual(list(mock_send.call_args[0][0]), [self.cert1, self.cert2, self.cert3]) # noqa: PT009 assert self.cert1 in mock_send.call_args[0][0] assert self.cert2 in mock_send.call_args[0][0] assert self.cert3 in mock_send.call_args[0][0] @mock.patch(TASKS_MODULE + '.send_notifications') def test_date_args(self, mock_send): - self.options['start_date'] = datetime(2017, 1, 31, 0, 0, tzinfo=timezone.utc) + self.options['start_date'] = datetime(2017, 1, 31, 0, 0, tzinfo=timezone.utc) # noqa: UP017 tasks.handle_notify_credentials(options=self.options, course_keys=[]) assert mock_send.called - self.assertListEqual(list(mock_send.call_args[0][0]), [self.cert2, self.cert4, self.cert3]) - self.assertListEqual(list(mock_send.call_args[0][1]), [self.grade2, self.grade4, self.grade3]) + self.assertListEqual(list(mock_send.call_args[0][0]), [self.cert2, self.cert4, self.cert3]) # noqa: PT009 + self.assertListEqual(list(mock_send.call_args[0][1]), [self.grade2, self.grade4, self.grade3]) # noqa: PT009 mock_send.reset_mock() - self.options['start_date'] = datetime(2017, 2, 1, 0, 0, tzinfo=timezone.utc) - self.options['end_date'] = datetime(2017, 2, 2, 0, 0, tzinfo=timezone.utc) + self.options['start_date'] = datetime(2017, 2, 1, 0, 0, tzinfo=timezone.utc) # noqa: UP017 + self.options['end_date'] = datetime(2017, 2, 2, 0, 0, tzinfo=timezone.utc) # noqa: UP017 tasks.handle_notify_credentials(options=self.options, course_keys=[]) assert mock_send.called - self.assertListEqual(list(mock_send.call_args[0][0]), [self.cert2, self.cert4]) - self.assertListEqual(list(mock_send.call_args[0][1]), [self.grade2, self.grade4]) + self.assertListEqual(list(mock_send.call_args[0][0]), [self.cert2, self.cert4]) # noqa: PT009 + self.assertListEqual(list(mock_send.call_args[0][1]), [self.grade2, self.grade4]) # noqa: PT009 mock_send.reset_mock() self.options['start_date'] = None - self.options['end_date'] = datetime(2017, 2, 2, 0, 0, tzinfo=timezone.utc) + self.options['end_date'] = datetime(2017, 2, 2, 0, 0, tzinfo=timezone.utc) # noqa: UP017 tasks.handle_notify_credentials(options=self.options, course_keys=[]) assert mock_send.called - self.assertListEqual(list(mock_send.call_args[0][0]), [self.cert1, self.cert2, self.cert4]) - self.assertListEqual(list(mock_send.call_args[0][1]), [self.grade1, self.grade2, self.grade4]) + self.assertListEqual(list(mock_send.call_args[0][0]), [self.cert1, self.cert2, self.cert4]) # noqa: PT009 + self.assertListEqual(list(mock_send.call_args[0][1]), [self.grade1, self.grade2, self.grade4]) # noqa: PT009 mock_send.reset_mock() - self.options['start_date'] = datetime(2017, 2, 1, 0, 0, tzinfo=timezone.utc) - self.options['end_date'] = datetime(2017, 2, 1, 4, 0, tzinfo=timezone.utc) + self.options['start_date'] = datetime(2017, 2, 1, 0, 0, tzinfo=timezone.utc) # noqa: UP017 + self.options['end_date'] = datetime(2017, 2, 1, 4, 0, tzinfo=timezone.utc) # noqa: UP017 tasks.handle_notify_credentials(options=self.options, course_keys=[]) assert mock_send.called - self.assertListEqual(list(mock_send.call_args[0][0]), [self.cert2]) - self.assertListEqual(list(mock_send.call_args[0][1]), [self.grade2]) + self.assertListEqual(list(mock_send.call_args[0][0]), [self.cert2]) # noqa: PT009 + self.assertListEqual(list(mock_send.call_args[0][1]), [self.grade2]) # noqa: PT009 @mock.patch(TASKS_MODULE + '.send_notifications') def test_username_arg(self, mock_send): - self.options['start_date'] = datetime(2017, 2, 1, 0, 0, tzinfo=timezone.utc) - self.options['end_date'] = datetime(2017, 2, 2, 0, 0, tzinfo=timezone.utc) + self.options['start_date'] = datetime(2017, 2, 1, 0, 0, tzinfo=timezone.utc) # noqa: UP017 + self.options['end_date'] = datetime(2017, 2, 2, 0, 0, tzinfo=timezone.utc) # noqa: UP017 self.options['user_ids'] = [str(self.user2.id)] tasks.handle_notify_credentials(options=self.options, course_keys=[]) assert mock_send.called - self.assertListEqual(list(mock_send.call_args[0][0]), [self.cert4]) - self.assertListEqual(list(mock_send.call_args[0][1]), [self.grade4]) + self.assertListEqual(list(mock_send.call_args[0][0]), [self.cert4]) # noqa: PT009 + self.assertListEqual(list(mock_send.call_args[0][1]), [self.grade4]) # noqa: PT009 mock_send.reset_mock() self.options['start_date'] = None @@ -312,17 +311,17 @@ def test_username_arg(self, mock_send): self.options['user_ids'] = [str(self.user2.id)] tasks.handle_notify_credentials(options=self.options, course_keys=[]) assert mock_send.called - self.assertListEqual(list(mock_send.call_args[0][0]), [self.cert4]) - self.assertListEqual(list(mock_send.call_args[0][1]), [self.grade4]) + self.assertListEqual(list(mock_send.call_args[0][0]), [self.cert4]) # noqa: PT009 + self.assertListEqual(list(mock_send.call_args[0][1]), [self.grade4]) # noqa: PT009 mock_send.reset_mock() - self.options['start_date'] = datetime(2017, 2, 1, 0, 0, tzinfo=timezone.utc) - self.options['end_date'] = datetime(2017, 2, 2, 0, 0, tzinfo=timezone.utc) + self.options['start_date'] = datetime(2017, 2, 1, 0, 0, tzinfo=timezone.utc) # noqa: UP017 + self.options['end_date'] = datetime(2017, 2, 2, 0, 0, tzinfo=timezone.utc) # noqa: UP017 self.options['user_ids'] = [str(self.user.id)] tasks.handle_notify_credentials(options=self.options, course_keys=[]) assert mock_send.called - self.assertListEqual(list(mock_send.call_args[0][0]), [self.cert2]) - self.assertListEqual(list(mock_send.call_args[0][1]), [self.grade2]) + self.assertListEqual(list(mock_send.call_args[0][0]), [self.cert2]) # noqa: PT009 + self.assertListEqual(list(mock_send.call_args[0][1]), [self.grade2]) # noqa: PT009 mock_send.reset_mock() self.options['start_date'] = None @@ -330,8 +329,8 @@ def test_username_arg(self, mock_send): self.options['user_ids'] = [str(self.user.id)] tasks.handle_notify_credentials(options=self.options, course_keys=[]) assert mock_send.called - self.assertListEqual(list(mock_send.call_args[0][0]), [self.cert1, self.cert2, self.cert3]) - self.assertListEqual(list(mock_send.call_args[0][1]), [self.grade1, self.grade2, self.grade3]) + self.assertListEqual(list(mock_send.call_args[0][0]), [self.cert1, self.cert2, self.cert3]) # noqa: PT009 + self.assertListEqual(list(mock_send.call_args[0][1]), [self.grade1, self.grade2, self.grade3]) # noqa: PT009 mock_send.reset_mock() self.options['start_date'] = None @@ -339,13 +338,13 @@ def test_username_arg(self, mock_send): self.options['user_ids'] = [str(self.user.id), str(self.user2.id)] tasks.handle_notify_credentials(options=self.options, course_keys=[]) assert mock_send.called - self.assertListEqual(list(mock_send.call_args[0][0]), [self.cert1, self.cert2, self.cert4, self.cert3]) - self.assertListEqual(list(mock_send.call_args[0][1]), [self.grade1, self.grade2, self.grade4, self.grade3]) + self.assertListEqual(list(mock_send.call_args[0][0]), [self.cert1, self.cert2, self.cert4, self.cert3]) # noqa: PT009 # pylint: disable=line-too-long + self.assertListEqual(list(mock_send.call_args[0][1]), [self.grade1, self.grade2, self.grade4, self.grade3]) # noqa: PT009 # pylint: disable=line-too-long mock_send.reset_mock() @mock.patch(TASKS_MODULE + '.send_notifications') def test_dry_run(self, mock_send): - self.options['start_date'] = datetime(2017, 2, 1, 0, 0, tzinfo=timezone.utc) + self.options['start_date'] = datetime(2017, 2, 1, 0, 0, tzinfo=timezone.utc) # noqa: UP017 self.options['dry_run'] = True tasks.handle_notify_credentials(options=self.options, course_keys=[]) assert not mock_send.called @@ -354,7 +353,7 @@ def test_dry_run(self, mock_send): @mock.patch(TASKS_MODULE + '.send_grade_if_interesting') @mock.patch(TASKS_MODULE + '.handle_course_cert_changed') def test_hand_off(self, mock_grade_interesting, mock_program_changed, mock_program_awarded): - self.options['start_date'] = datetime(2017, 2, 1, 0, 0, tzinfo=timezone.utc) + self.options['start_date'] = datetime(2017, 2, 1, 0, 0, tzinfo=timezone.utc) # noqa: UP017 tasks.handle_notify_credentials(options=self.options, course_keys=[]) assert mock_grade_interesting.call_count == 3 assert mock_program_changed.call_count == 3 @@ -363,7 +362,7 @@ def test_hand_off(self, mock_grade_interesting, mock_program_changed, mock_progr mock_program_changed.reset_mock() mock_program_awarded.reset_mock() - self.options['start_date'] = datetime(2017, 2, 1, 0, 0, tzinfo=timezone.utc) + self.options['start_date'] = datetime(2017, 2, 1, 0, 0, tzinfo=timezone.utc) # noqa: UP017 self.options['notify_programs'] = True tasks.handle_notify_credentials(options=self.options, course_keys=[]) assert mock_grade_interesting.call_count == 3 @@ -372,13 +371,13 @@ def test_hand_off(self, mock_grade_interesting, mock_program_changed, mock_progr @mock.patch(TASKS_MODULE + '.time') def test_delay(self, mock_time): - self.options['start_date'] = datetime(2017, 2, 1, 0, 0, tzinfo=timezone.utc) + self.options['start_date'] = datetime(2017, 2, 1, 0, 0, tzinfo=timezone.utc) # noqa: UP017 self.options['page_size'] = 2 tasks.handle_notify_credentials(options=self.options, course_keys=[]) assert mock_time.sleep.call_count == 0 mock_time.sleep.reset_mock() - self.options['start_date'] = datetime(2017, 2, 1, 0, 0, tzinfo=timezone.utc) + self.options['start_date'] = datetime(2017, 2, 1, 0, 0, tzinfo=timezone.utc) # noqa: UP017 self.options['page_size'] = 2 self.options['delay'] = 0.2 tasks.handle_notify_credentials(options=self.options, course_keys=[]) @@ -388,19 +387,19 @@ def test_delay(self, mock_time): @override_settings(DEBUG=True) def test_page_size(self): - self.options['start_date'] = datetime(2017, 1, 1, 0, 0, tzinfo=timezone.utc) + self.options['start_date'] = datetime(2017, 1, 1, 0, 0, tzinfo=timezone.utc) # noqa: UP017 reset_queries() tasks.handle_notify_credentials(options=self.options, course_keys=[]) baseline = len(connection.queries) - self.options['start_date'] = datetime(2017, 1, 1, 0, 0, tzinfo=timezone.utc) + self.options['start_date'] = datetime(2017, 1, 1, 0, 0, tzinfo=timezone.utc) # noqa: UP017 self.options['page_size'] = 1 reset_queries() tasks.handle_notify_credentials(options=self.options, course_keys=[]) assert len(connection.queries) == (baseline + 6) # two extra page queries each for certs & grades - self.options['start_date'] = datetime(2017, 1, 1, 0, 0, tzinfo=timezone.utc) + self.options['start_date'] = datetime(2017, 1, 1, 0, 0, tzinfo=timezone.utc) # noqa: UP017 self.options['page_size'] = 2 reset_queries() tasks.handle_notify_credentials(options=self.options, course_keys=[]) @@ -413,23 +412,23 @@ def test_site(self, mock_grade_interesting): site_values={'course_org_filter': ['testX']} ) - self.options['start_date'] = datetime(2017, 1, 1, 0, 0, tzinfo=timezone.utc) + self.options['start_date'] = datetime(2017, 1, 1, 0, 0, tzinfo=timezone.utc) # noqa: UP017 self.options['site'] = site_config.site.domain tasks.handle_notify_credentials(options=self.options, course_keys=[]) assert mock_grade_interesting.call_count == 1 @mock.patch(TASKS_MODULE + '.send_notifications') def test_send_notifications_failure(self, mock_send): - self.options['start_date'] = datetime(2017, 1, 31, 0, 0, tzinfo=timezone.utc) + self.options['start_date'] = datetime(2017, 1, 31, 0, 0, tzinfo=timezone.utc) # noqa: UP017 mock_send.side_effect = boom - with pytest.raises(Exception): + with pytest.raises(Exception): # noqa: B017, PT011 tasks.handle_notify_credentials(options=self.options, course_keys=[]) @mock.patch(TASKS_MODULE + '.send_grade_if_interesting') def test_send_grade_failure(self, mock_send_grade): - self.options['start_date'] = datetime(2017, 1, 31, 0, 0, tzinfo=timezone.utc) + self.options['start_date'] = datetime(2017, 1, 31, 0, 0, tzinfo=timezone.utc) # noqa: UP017 mock_send_grade.side_effect = boom - with pytest.raises(Exception): + with pytest.raises(Exception): # noqa: B017, PT011 tasks.handle_notify_credentials(options=self.options, course_keys=[]) @ddt.data([True], [False]) @@ -477,7 +476,7 @@ def setUp(self): ) @ddt.unpack def test_send_grade_if_right_cert(self, called, mode, status, mock_is_course_run_in_a_program, - mock_send_grade_to_credentials, _mock_is_learner_issuance_enabled): + mock_send_grade_to_credentials, _mock_is_learner_issuance_enabled): # noqa: PT019 mock_is_course_run_in_a_program.return_value = True # Test direct send @@ -495,20 +494,20 @@ def test_send_grade_if_right_cert(self, called, mode, status, mock_is_course_run tasks.send_grade_if_interesting(self.user, self.key, None, None, 'A', 1.0) assert mock_send_grade_to_credentials.delay.called is called - def test_send_grade_missing_cert(self, _, mock_send_grade_to_credentials, _mock_is_learner_issuance_enabled): + def test_send_grade_missing_cert(self, _, mock_send_grade_to_credentials, _mock_is_learner_issuance_enabled): # noqa: PT019 # pylint: disable=line-too-long tasks.send_grade_if_interesting(self.user, self.key, None, None, 'A', 1.0) assert not mock_send_grade_to_credentials.delay.called @ddt.data([True], [False]) @ddt.unpack def test_send_grade_if_in_a_program(self, in_program, mock_is_course_run_in_a_program, - mock_send_grade_to_credentials, _mock_is_learner_issuance_enabled): + mock_send_grade_to_credentials, _mock_is_learner_issuance_enabled): # noqa: PT019 # pylint: disable=line-too-long mock_is_course_run_in_a_program.return_value = in_program tasks.send_grade_if_interesting(self.user, self.key, 'verified', 'downloadable', 'A', 1.0) assert mock_send_grade_to_credentials.delay.called is in_program def test_send_grade_queries_grade(self, mock_is_course_run_in_a_program, mock_send_grade_to_credentials, - _mock_is_learner_issuance_enabled): + _mock_is_learner_issuance_enabled): # noqa: PT019 mock_is_course_run_in_a_program.return_value = True last_updated = datetime.now() @@ -520,15 +519,15 @@ def test_send_grade_queries_grade(self, mock_is_course_run_in_a_program, mock_se ) mock_send_grade_to_credentials.delay.reset_mock() - def test_send_grade_without_issuance_enabled(self, _mock_is_course_run_in_a_program, + def test_send_grade_without_issuance_enabled(self, _mock_is_course_run_in_a_program, # noqa: PT019 mock_send_grade_to_credentials, mock_is_learner_issuance_enabled): mock_is_learner_issuance_enabled.return_value = False tasks.send_grade_if_interesting(self.user, self.key, 'verified', 'downloadable', None, None) assert mock_is_learner_issuance_enabled.called assert not mock_send_grade_to_credentials.delay.called - def test_send_grade_records_enabled(self, _mock_is_course_run_in_a_program, mock_send_grade_to_credentials, - _mock_is_learner_issuance_enabled): + def test_send_grade_records_enabled(self, _mock_is_course_run_in_a_program, mock_send_grade_to_credentials, # noqa: PT019 # pylint: disable=line-too-long + _mock_is_learner_issuance_enabled): # noqa: PT019 # pylint: disable=line-too-long site_config = SiteConfigurationFactory.create( site_values={'course_org_filter': [self.key.org]} ) @@ -545,8 +544,8 @@ def test_send_grade_records_enabled(self, _mock_is_course_run_in_a_program, mock assert not mock_send_grade_to_credentials.delay.called def test_send_grade_records_disabled_globally( - self, _mock_is_course_run_in_a_program, mock_send_grade_to_credentials, - _mock_is_learner_issuance_enabled + self, _mock_is_course_run_in_a_program, mock_send_grade_to_credentials, # noqa: PT019 + _mock_is_learner_issuance_enabled # noqa: PT019 ): assert is_learner_records_enabled() with override_settings(ENABLE_LEARNER_RECORDS=False): @@ -792,7 +791,7 @@ def setUp(self): self_paced=False, ) self.co_instructor_paced_cdb_end_with_date = CourseOverviewFactory( - certificate_available_date=(datetime.now(timezone.utc) + timedelta(days=30)), + certificate_available_date=(datetime.now(timezone.utc) + timedelta(days=30)), # noqa: UP017 certificates_display_behavior=CertificatesDisplayBehaviors.END_WITH_DATE, id=CourseKey.from_string(self.co_instructor_paced_cdb_end_with_date_key), self_paced=False, diff --git a/openedx/core/djangoapps/credentials/tests/test_utils.py b/openedx/core/djangoapps/credentials/tests/test_utils.py index 17ea280537c3..056ab357563b 100644 --- a/openedx/core/djangoapps/credentials/tests/test_utils.py +++ b/openedx/core/djangoapps/credentials/tests/test_utils.py @@ -7,10 +7,7 @@ from openedx.core.djangoapps.credentials.models import CredentialsApiConfig from openedx.core.djangoapps.credentials.tests import factories from openedx.core.djangoapps.credentials.tests.mixins import CredentialsApiConfigMixin -from openedx.core.djangoapps.credentials.utils import ( - get_credentials, - get_credentials_records_url, -) +from openedx.core.djangoapps.credentials.utils import get_credentials, get_credentials_records_url from openedx.core.djangoapps.oauth_dispatch.tests.factories import ApplicationFactory from openedx.core.djangolib.testing.utils import CacheIsolationTestCase, skip_unless_lms diff --git a/openedx/core/djangoapps/credentials/utils.py b/openedx/core/djangoapps/credentials/utils.py index 9e8ad6b04df0..e3fdc11ab5d5 100644 --- a/openedx/core/djangoapps/credentials/utils.py +++ b/openedx/core/djangoapps/credentials/utils.py @@ -1,7 +1,7 @@ """Helper functions for working with Credentials.""" import logging -from typing import Dict, List +from typing import Dict, List # noqa: UP035 from urllib.parse import urljoin import requests @@ -71,7 +71,7 @@ def get_credentials( program_uuid: str = None, credential_type: str = None, raise_on_error: bool = False, -) -> List[Dict]: +) -> List[Dict]: # noqa: UP006 """ Given a user, get credentials earned from the credentials service. diff --git a/openedx/core/djangoapps/credit/admin.py b/openedx/core/djangoapps/credit/admin.py index 6431fbaaf7b2..06c9f3f9dac8 100644 --- a/openedx/core/djangoapps/credit/admin.py +++ b/openedx/core/djangoapps/credit/admin.py @@ -12,7 +12,7 @@ CreditProvider, CreditRequest, CreditRequirement, - CreditRequirementStatus + CreditRequirementStatus, ) diff --git a/openedx/core/djangoapps/credit/api/__init__.py b/openedx/core/djangoapps/credit/api/__init__.py index 4f392d51838e..1c38e15e272b 100644 --- a/openedx/core/djangoapps/credit/api/__init__.py +++ b/openedx/core/djangoapps/credit/api/__init__.py @@ -4,5 +4,5 @@ This module aggregates the API functions from the eligibility and provider APIs. """ -from .eligibility import * # pylint: disable=wildcard-import -from .provider import * # pylint: disable=wildcard-import +from .eligibility import * # pylint: disable=wildcard-import # noqa: F403 +from .provider import * # pylint: disable=wildcard-import # noqa: F403 diff --git a/openedx/core/djangoapps/credit/api/eligibility.py b/openedx/core/djangoapps/credit/api/eligibility.py index 79546aa0b4fd..b2d5cd5d682c 100644 --- a/openedx/core/djangoapps/credit/api/eligibility.py +++ b/openedx/core/djangoapps/credit/api/eligibility.py @@ -9,6 +9,7 @@ from opaque_keys.edx.keys import CourseKey from common.djangoapps.course_modes.models import CourseMode +from common.djangoapps.student.models import CourseEnrollment from openedx.core.djangoapps.credit.email_utils import send_credit_notifications from openedx.core.djangoapps.credit.exceptions import InvalidCreditCourse, InvalidCreditRequirements from openedx.core.djangoapps.credit.models import ( @@ -16,9 +17,8 @@ CreditEligibility, CreditRequest, CreditRequirement, - CreditRequirementStatus + CreditRequirementStatus, ) -from common.djangoapps.student.models import CourseEnrollment # TODO: Cleanup this mess! ECOM-2908 @@ -80,7 +80,7 @@ def set_credit_requirements(course_key, requirements): try: credit_course = CreditCourse.get_credit_course(course_key=course_key) except CreditCourse.DoesNotExist: - raise InvalidCreditCourse() # lint-amnesty, pylint: disable=raise-missing-from + raise InvalidCreditCourse() # pylint: disable=raise-missing-from # noqa: B904 old_requirements = CreditRequirement.get_course_requirements(course_key=course_key) requirements_to_disable = _get_requirements_to_disable(old_requirements, requirements) @@ -430,7 +430,7 @@ def _validate_requirements(requirements): if invalid_params: invalid_requirements.append( - "{requirement} has missing/invalid parameters: {params}".format( + "{requirement} has missing/invalid parameters: {params}".format( # noqa: UP032 requirement=requirement, params=invalid_params, ) diff --git a/openedx/core/djangoapps/credit/api/provider.py b/openedx/core/djangoapps/credit/api/provider.py index 5628130b37be..356f89974cfb 100644 --- a/openedx/core/djangoapps/credit/api/provider.py +++ b/openedx/core/djangoapps/credit/api/provider.py @@ -6,28 +6,28 @@ import datetime import logging import uuid - from zoneinfo import ZoneInfo + from django.db import transaction from edx_proctoring.api import get_last_exam_completion_date +from common.djangoapps.student.models import CourseEnrollment, User +from common.djangoapps.util.date_utils import to_timestamp +from common.djangoapps.util.json_request import JsonResponse from openedx.core.djangoapps.credit.exceptions import ( CreditProviderNotConfigured, CreditRequestNotFound, InvalidCreditStatus, RequestAlreadyCompleted, - UserIsNotEligible + UserIsNotEligible, ) from openedx.core.djangoapps.credit.models import ( CreditEligibility, CreditProvider, CreditRequest, - CreditRequirementStatus + CreditRequirementStatus, ) from openedx.core.djangoapps.credit.signature import get_shared_secret_key, signature -from common.djangoapps.student.models import CourseEnrollment, User -from common.djangoapps.util.date_utils import to_timestamp -from common.djangoapps.util.json_request import JsonResponse # TODO: Cleanup this mess! ECOM-2908 @@ -118,8 +118,8 @@ def check_keys_exist(shared_secret_key, provider_id): Raise CreditProviderNotConfigured if no key available. """ # Accounts for old way of storing provider key - if shared_secret_key is None: # lint-amnesty, pylint: disable=no-else-raise - msg = 'Credit provider with ID "{provider_id}" does not have a secret key configured.'.format( + if shared_secret_key is None: # pylint: disable=no-else-raise + msg = 'Credit provider with ID "{provider_id}" does not have a secret key configured.'.format( # noqa: UP032 provider_id=provider_id ) log.error(msg) @@ -128,7 +128,7 @@ def check_keys_exist(shared_secret_key, provider_id): # Accounts for new way of storing provider key elif isinstance(shared_secret_key, list) and not any(shared_secret_key): msg = 'Could not retrieve secret key for credit provider [{}]. ' \ - 'Unable to validate requests from provider.'.format(provider_id) + 'Unable to validate requests from provider.'.format(provider_id) # noqa: UP032 log.error(msg) raise CreditProviderNotConfigured(msg) @@ -211,10 +211,10 @@ def create_credit_request(course_key, provider_id, username): 'but the user is not eligible for credit', username, course_key ) - raise UserIsNotEligible # lint-amnesty, pylint: disable=raise-missing-from + raise UserIsNotEligible # pylint: disable=raise-missing-from # noqa: B904 except CreditProvider.DoesNotExist: log.error('Credit provider with ID "%s" has not been configured.', provider_id) - raise CreditProviderNotConfigured # lint-amnesty, pylint: disable=raise-missing-from + raise CreditProviderNotConfigured # pylint: disable=raise-missing-from # noqa: B904 # Check if we've enabled automatic integration with the credit # provider. If not, we'll show the user a link to a URL @@ -283,9 +283,9 @@ def create_credit_request(course_key, provider_id, username): except (CreditRequirementStatus.DoesNotExist, TypeError, KeyError): msg = 'Could not retrieve final grade from the credit eligibility table for ' \ - 'user [{user_id}] in course [{course_key}].'.format(user_id=user.id, course_key=course_key) + 'user [{user_id}] in course [{course_key}].'.format(user_id=user.id, course_key=course_key) # noqa: UP032 log.exception(msg) - raise UserIsNotEligible(msg) # lint-amnesty, pylint: disable=raise-missing-from + raise UserIsNotEligible(msg) # pylint: disable=raise-missing-from # noqa: B904 # Getting the students's enrollment date course_enrollment = CourseEnrollment.get_enrollment(user, course_key) @@ -309,7 +309,7 @@ def create_credit_request(course_key, provider_id, username): "user_mailing_address": "", "user_country": ( user.profile.country.code - if user.profile.country.code is not None + if user.profile.country is not None else "" ), } @@ -375,13 +375,13 @@ def update_credit_request_status(request_uuid, provider_id, status): request_uuid, old_status, status, provider_id ) except CreditRequest.DoesNotExist: - msg = ( + msg = ( # noqa: UP032 'Credit provider with ID "{provider_id}" attempted to ' 'update request with UUID "{request_uuid}", but no request ' 'with this UUID is associated with the provider.' ).format(provider_id=provider_id, request_uuid=request_uuid) log.warning(msg) - raise CreditRequestNotFound(msg) # lint-amnesty, pylint: disable=raise-missing-from + raise CreditRequestNotFound(msg) # pylint: disable=raise-missing-from # noqa: B904 def get_credit_requests_for_user(username): diff --git a/openedx/core/djangoapps/credit/apps.py b/openedx/core/djangoapps/credit/apps.py index e057cc5cab77..4230335085de 100644 --- a/openedx/core/djangoapps/credit/apps.py +++ b/openedx/core/djangoapps/credit/apps.py @@ -15,7 +15,7 @@ class CreditConfig(AppConfig): name = 'openedx.core.djangoapps.credit' def ready(self): - from .signals import handlers # lint-amnesty, pylint: disable=unused-import + from .signals import handlers # pylint: disable=unused-import # noqa: F401 if settings.FEATURES.get('ENABLE_SPECIAL_EXAMS'): from .services import CreditService set_runtime_service('credit', CreditService()) diff --git a/openedx/core/djangoapps/credit/email_utils.py b/openedx/core/djangoapps/credit/email_utils.py index a190aca852b2..2c1d8d68b9e6 100644 --- a/openedx/core/djangoapps/credit/email_utils.py +++ b/openedx/core/djangoapps/credit/email_utils.py @@ -13,14 +13,14 @@ from urllib.parse import urljoin from django.conf import settings -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.contrib.staticfiles import finders from django.core.cache import cache from django.core.mail import EmailMessage, SafeMIMEText from django.urls import reverse from django.utils.translation import gettext as _ +from edx_django_utils.plugins import pluggable_override from eventtracking import tracker -from xmodule.modulestore.django import modulestore from common.djangoapps.edxmako.shortcuts import render_to_string from common.djangoapps.edxmako.template import Template @@ -28,12 +28,12 @@ from openedx.core.djangoapps.credit.models import CreditConfig, CreditProvider from openedx.core.djangoapps.site_configuration import helpers as configuration_helpers from openedx.core.djangolib.markup import HTML -from edx_django_utils.plugins import pluggable_override +from xmodule.modulestore.django import modulestore log = logging.getLogger(__name__) -def send_credit_notifications(username, course_key): # lint-amnesty, pylint: disable=too-many-statements +def send_credit_notifications(username, course_key): # pylint: disable=too-many-statements """Sends email notification to user on different phases during credit course e.g., credit eligibility, credit payment etc. """ @@ -249,7 +249,7 @@ def get_credit_provider_attribute_values(course_key, attribute_name): attribute_values = None if credit_config.is_cache_enabled: - cache_key = '{key_prefix}.{course_key}.{attribute_name}'.format( + cache_key = '{key_prefix}.{course_key}.{attribute_name}'.format( # noqa: UP032 key_prefix=credit_config.CACHE_KEY, course_key=course_id, attribute_name=attribute_name diff --git a/openedx/core/djangoapps/credit/exceptions.py b/openedx/core/djangoapps/credit/exceptions.py index a63f950c982e..9f0a2ad02da1 100644 --- a/openedx/core/djangoapps/credit/exceptions.py +++ b/openedx/core/djangoapps/credit/exceptions.py @@ -13,56 +13,56 @@ class CreditApiBadRequest(Exception): Could not complete a request to the credit API because there was a problem with the request (as opposed to an internal error). """ - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass class InvalidCreditRequirements(CreditApiBadRequest): """ The requirement dictionary provided has invalid format. """ - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass class InvalidCreditCourse(CreditApiBadRequest): """ The course is not configured for credit. """ - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass class UserIsNotEligible(CreditApiBadRequest): """ The user has not satisfied eligibility requirements for credit. """ - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass class CreditProviderNotConfigured(CreditApiBadRequest): """ The requested credit provider is not configured correctly for the course. """ - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass class RequestAlreadyCompleted(CreditApiBadRequest): """ The user has already submitted a request and received a response from the credit provider. """ - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass class CreditRequestNotFound(CreditApiBadRequest): """ The request does not exist. """ - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass class InvalidCreditStatus(CreditApiBadRequest): """ The status is not either "approved" or "rejected". """ - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass class InvalidCreditRequest(APIException): diff --git a/openedx/core/djangoapps/credit/models.py b/openedx/core/djangoapps/credit/models.py index d6be33828117..c5ce3cf9e8b5 100644 --- a/openedx/core/djangoapps/credit/models.py +++ b/openedx/core/djangoapps/credit/models.py @@ -9,15 +9,15 @@ import datetime import logging from collections import defaultdict - from zoneinfo import ZoneInfo + from config_models.models import ConfigurationModel from django.conf import settings from django.core.cache import cache from django.core.validators import RegexValidator from django.db import IntegrityError, models, transaction from django.dispatch import receiver -from django.utils.translation import gettext as _ # lint-amnesty, pylint: disable=unused-import +from django.utils.translation import gettext as _ # pylint: disable=unused-import # noqa: F401 from django.utils.translation import gettext_lazy from edx_django_utils.cache import RequestCache from jsonfield.fields import JSONField @@ -105,7 +105,7 @@ class CreditProvider(TimeStampedModel): ) ) - fulfillment_instructions = models.TextField( + fulfillment_instructions = models.TextField( # noqa: DJ001 null=True, blank=True, help_text=gettext_lazy( @@ -262,7 +262,7 @@ def get_credit_course(cls, course_key): """ return cls.objects.get(course_key=course_key, enabled=True) - def __str__(self): + def __str__(self): # noqa: DJ012 """Unicode representation of the credit course. """ return str(self.course_key) @@ -508,7 +508,7 @@ def remove_requirement_status(cls, username, requirement): requirement_status.delete() except cls.DoesNotExist: log_msg = ( - 'The requirement status {requirement} does not exist for username {username}.'.format( + 'The requirement status {requirement} does not exist for username {username}.'.format( # noqa: UP032 requirement=requirement, username=username ) @@ -641,7 +641,7 @@ def is_user_eligible_for_credit(cls, course_key, username): def __str__(self): """Unicode representation of the credit eligibility. """ - return "{user}, {course}".format( + return "{user}, {course}".format( # noqa: UP032 user=self.username, course=self.course.course_key, ) @@ -766,7 +766,7 @@ def get_user_request_status(cls, username, course_key): def __str__(self): """Unicode representation of a credit request.""" - return "{course}, {provider}, {status}".format( + return "{course}, {provider}, {status}".format( # noqa: UP032 course=self.course.course_key, provider=self.provider.provider_id, status=self.status, diff --git a/openedx/core/djangoapps/credit/serializers.py b/openedx/core/djangoapps/credit/serializers.py index 56ffe7a960b2..ad649ea2b518 100644 --- a/openedx/core/djangoapps/credit/serializers.py +++ b/openedx/core/djangoapps/credit/serializers.py @@ -3,16 +3,16 @@ import datetime import logging - from zoneinfo import ZoneInfo + from django.conf import settings from rest_framework import serializers from rest_framework.exceptions import PermissionDenied +from common.djangoapps.util.date_utils import from_timestamp from openedx.core.djangoapps.credit.models import CreditCourse, CreditEligibility, CreditProvider, CreditRequest from openedx.core.djangoapps.credit.signature import get_shared_secret_key, signature from openedx.core.lib.api.serializers import CourseKeyField -from common.djangoapps.util.date_utils import from_timestamp log = logging.getLogger(__name__) @@ -97,7 +97,7 @@ def _check_keys_exist_for_provider(self, secret_key, provider_id): # Accounts for old way of storing provider key if secret_key is None: msg = 'Could not retrieve secret key for credit provider [{}]. ' \ - 'Unable to validate requests from provider.'.format(provider_id) + 'Unable to validate requests from provider.'.format(provider_id) # noqa: UP032 log.error(msg) raise PermissionDenied(msg) @@ -105,7 +105,7 @@ def _check_keys_exist_for_provider(self, secret_key, provider_id): # We need at least 1 key here that we can use to validate the signature if isinstance(secret_key, list) and not any(secret_key): msg = 'Could not retrieve secret key for credit provider [{}]. ' \ - 'Unable to validate requests from provider.'.format(provider_id) + 'Unable to validate requests from provider.'.format(provider_id) # noqa: UP032 log.error(msg) raise PermissionDenied(msg) diff --git a/openedx/core/djangoapps/credit/services.py b/openedx/core/djangoapps/credit/services.py index 16ec0c47358c..0849498dcd40 100644 --- a/openedx/core/djangoapps/credit/services.py +++ b/openedx/core/djangoapps/credit/services.py @@ -1,17 +1,16 @@ """ Implementation of "credit" XBlock service """ -from datetime import datetime, timedelta import logging +from datetime import datetime, timedelta -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.core.exceptions import ObjectDoesNotExist from opaque_keys.edx.keys import CourseKey from common.djangoapps.student.models import CourseEnrollment from openedx.core.djangoapps.content.course_overviews.models import CourseOverview - log = logging.getLogger(__name__) @@ -40,9 +39,7 @@ def is_credit_course(self, course_key_or_id): # This seems to need to be here otherwise we get # circular references when starting up the app - from openedx.core.djangoapps.credit.api.eligibility import ( - is_credit_course, - ) + from openedx.core.djangoapps.credit.api.eligibility import is_credit_course course_key = _get_course_key(course_key_or_id) @@ -72,10 +69,7 @@ def get_credit_state(self, user_id, course_key_or_id, return_course_info=False): # This seems to need to be here otherwise we get # circular references when starting up the app - from openedx.core.djangoapps.credit.api.eligibility import ( - is_credit_course, - get_credit_requirement_status, - ) + from openedx.core.djangoapps.credit.api.eligibility import get_credit_requirement_status, is_credit_course # since we have to do name matching during various # verifications, User must have a UserProfile @@ -138,9 +132,9 @@ def set_credit_requirement_status(self, user_id, course_key_or_id, req_namespace # This seems to need to be here otherwise we get # circular references when starting up the app + from openedx.core.djangoapps.credit.api.eligibility import is_credit_course from openedx.core.djangoapps.credit.api.eligibility import ( - is_credit_course, - set_credit_requirement_status as api_set_credit_requirement_status + set_credit_requirement_status as api_set_credit_requirement_status, ) course_key = _get_course_key(course_key_or_id) @@ -153,7 +147,7 @@ def set_credit_requirement_status(self, user_id, course_key_or_id, req_namespace # table. This will be to help debug any issues that might # arise in production log_msg = ( - 'set_credit_requirement_status was called with ' + 'set_credit_requirement_status was called with ' # noqa: UP032 'user_id={user_id}, course_key_or_id={course_key_or_id} ' 'req_namespace={req_namespace}, req_name={req_name}, ' 'status={status}, reason={reason}'.format( @@ -194,9 +188,9 @@ def remove_credit_requirement_status(self, user_id, course_key_or_id, req_namesp # This seems to need to be here otherwise we get # circular references when starting up the app + from openedx.core.djangoapps.credit.api.eligibility import is_credit_course from openedx.core.djangoapps.credit.api.eligibility import ( - is_credit_course, - remove_credit_requirement_status as api_remove_credit_requirement_status + remove_credit_requirement_status as api_remove_credit_requirement_status, ) course_key = _get_course_key(course_key_or_id) @@ -209,7 +203,7 @@ def remove_credit_requirement_status(self, user_id, course_key_or_id, req_namesp # table. This will be to help debug any issues that might # arise in production log_msg = ( - 'remove_credit_requirement_status was called with ' + 'remove_credit_requirement_status was called with ' # noqa: UP032 'user_id={user_id}, course_key_or_id={course_key_or_id} ' 'req_namespace={req_namespace}, req_name={req_name}, '.format( user_id=user_id, diff --git a/openedx/core/djangoapps/credit/signals/handlers.py b/openedx/core/djangoapps/credit/signals/handlers.py index 3748f1cfba86..db103ced0501 100644 --- a/openedx/core/djangoapps/credit/signals/handlers.py +++ b/openedx/core/djangoapps/credit/signals/handlers.py @@ -15,13 +15,13 @@ EXAM_ATTEMPT_REJECTED, EXAM_ATTEMPT_RESET, EXAM_ATTEMPT_SUBMITTED, - EXAM_ATTEMPT_VERIFIED + EXAM_ATTEMPT_VERIFIED, ) from openedx.core.djangoapps.credit.api.eligibility import ( is_credit_course, remove_credit_requirement_status, - set_credit_requirement_status + set_credit_requirement_status, ) from openedx.core.djangoapps.signals.signals import COURSE_GRADE_CHANGED diff --git a/openedx/core/djangoapps/credit/tasks.py b/openedx/core/djangoapps/credit/tasks.py index 79ef613e3d19..a8227e504352 100644 --- a/openedx/core/djangoapps/credit/tasks.py +++ b/openedx/core/djangoapps/credit/tasks.py @@ -13,8 +13,8 @@ from openedx.core.djangoapps.credit.api import set_credit_requirements from openedx.core.djangoapps.credit.exceptions import InvalidCreditRequirements from openedx.core.djangoapps.credit.models import CreditCourse -from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.exceptions import ItemNotFoundError # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order +from xmodule.modulestore.exceptions import ItemNotFoundError # pylint: disable=wrong-import-order LOGGER = get_task_logger(__name__) @@ -40,7 +40,7 @@ def update_credit_course_requirements(course_id): set_credit_requirements(course_key, requirements) except (InvalidKeyError, ItemNotFoundError, InvalidCreditRequirements) as exc: LOGGER.error('Error on adding the requirements for course %s - %s', course_id, str(exc)) - raise update_credit_course_requirements.retry(args=[course_id], exc=exc) + raise update_credit_course_requirements.retry(args=[course_id], exc=exc) # noqa: B904 LOGGER.info('Requirements added for course %s', course_id) @@ -144,7 +144,7 @@ def _get_proctoring_requirements(course_key): if requirements: log_msg = ( - 'Registering the following as \'proctored_exam\' credit requirements: {log_msg}'.format( + 'Registering the following as \'proctored_exam\' credit requirements: {log_msg}'.format( # noqa: UP032 log_msg=requirements ) ) diff --git a/openedx/core/djangoapps/credit/tests/factories.py b/openedx/core/djangoapps/credit/tests/factories.py index 5489b7bb0668..eae8ceade2c8 100644 --- a/openedx/core/djangoapps/credit/tests/factories.py +++ b/openedx/core/djangoapps/credit/tests/factories.py @@ -4,21 +4,21 @@ import datetime import json import uuid +from zoneinfo import ZoneInfo import factory +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from factory.fuzzy import FuzzyText -from zoneinfo import ZoneInfo -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from common.djangoapps.util.date_utils import to_timestamp from openedx.core.djangoapps.credit.models import ( CreditCourse, CreditEligibility, CreditProvider, CreditRequest, CreditRequirement, - CreditRequirementStatus + CreditRequirementStatus, ) -from common.djangoapps.util.date_utils import to_timestamp class CreditCourseFactory(factory.django.DjangoModelFactory): @@ -89,7 +89,7 @@ def post(obj, create, extracted, **kwargs): "user_email": user.email, "user_full_name": user_profile.name, "user_mailing_address": "", - "user_country": user_profile.country.code or "", + "user_country": user_profile.country.code if user_profile.country else "", }) obj.save() diff --git a/openedx/core/djangoapps/credit/tests/test_api.py b/openedx/core/djangoapps/credit/tests/test_api.py index 2ec31641dd1d..666b744499e6 100644 --- a/openedx/core/djangoapps/credit/tests/test_api.py +++ b/openedx/core/djangoapps/credit/tests/test_api.py @@ -6,17 +6,21 @@ import datetime import json from unittest import mock -import pytest +from zoneinfo import ZoneInfo + import ddt import httpretty -from zoneinfo import ZoneInfo -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +import pytest +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.core import mail from django.db import connection from django.test.utils import override_settings from opaque_keys.edx.keys import CourseKey from common.djangoapps.course_modes.models import CourseMode +from common.djangoapps.student.models import CourseEnrollment +from common.djangoapps.student.tests.factories import UserFactory +from common.djangoapps.util.date_utils import from_timestamp from lms.djangoapps.commerce.tests import TEST_API_URL from openedx.core.djangoapps.credit import api from openedx.core.djangoapps.credit.email_utils import get_credit_provider_attribute_values, make_providers_strings @@ -26,7 +30,7 @@ InvalidCreditRequirements, InvalidCreditStatus, RequestAlreadyCompleted, - UserIsNotEligible + UserIsNotEligible, ) from openedx.core.djangoapps.credit.models import ( CreditConfig, @@ -35,14 +39,13 @@ CreditProvider, CreditRequest, CreditRequirement, - CreditRequirementStatus + CreditRequirementStatus, ) from openedx.core.djangolib.testing.utils import skip_unless_lms -from common.djangoapps.student.models import CourseEnrollment -from common.djangoapps.student.tests.factories import UserFactory -from common.djangoapps.util.date_utils import from_timestamp -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + ModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order TEST_CREDIT_PROVIDER_SECRET_KEY = "931433d583c84ca7ba41784bad3232e6" TEST_CREDIT_PROVIDER_SECRET_KEY_TWO = "abcf433d583c8baebae1784bad3232e6" @@ -969,7 +972,7 @@ def test_credit_request(self): assert parameters['final_grade'] == str(self.FINAL_GRADE) # Validate user information - for key in self.USER_INFO.keys(): # lint-amnesty, pylint: disable=consider-iterating-dictionary + for key in self.USER_INFO.keys(): # pylint: disable=consider-iterating-dictionary param_key = f'user_{key}' assert param_key in parameters expected = '' if key == 'mailing_address' else self.USER_INFO[key] @@ -1220,7 +1223,7 @@ def test_get_credit_provider_display_names_method(self): """Verify that parsed providers list is returns after getting course production information.""" self._mock_ecommerce_courses_api(self.course_key, self.COURSE_API_RESPONSE) response_providers = get_credit_provider_attribute_values(self.course_key, 'display_name') - self.assertListEqual(self.PROVIDERS_LIST, response_providers) + self.assertListEqual(self.PROVIDERS_LIST, response_providers) # noqa: PT009 @mock.patch('openedx.core.djangoapps.credit.email_utils.get_ecommerce_api_client') def test_get_credit_provider_display_names_method_with_exception(self, mock_get_client): @@ -1240,11 +1243,11 @@ def test_get_credit_provider_display_names_caching(self): # Warm up the cache. response_providers = get_credit_provider_attribute_values(self.course_key, 'display_name') - self.assertListEqual(self.PROVIDERS_LIST, response_providers) + self.assertListEqual(self.PROVIDERS_LIST, response_providers) # noqa: PT009 # Hit the cache. response_providers = get_credit_provider_attribute_values(self.course_key, 'display_name') - self.assertListEqual(self.PROVIDERS_LIST, response_providers) + self.assertListEqual(self.PROVIDERS_LIST, response_providers) # noqa: PT009 # Verify only one request was made. assert len(httpretty.httpretty.latest_requests) == 1 @@ -1259,10 +1262,10 @@ def test_get_credit_provider_display_names_without_caching(self): self._mock_ecommerce_courses_api(self.course_key, self.COURSE_API_RESPONSE) response_providers = get_credit_provider_attribute_values(self.course_key, 'display_name') - self.assertListEqual(self.PROVIDERS_LIST, response_providers) + self.assertListEqual(self.PROVIDERS_LIST, response_providers) # noqa: PT009 response_providers = get_credit_provider_attribute_values(self.course_key, 'display_name') - self.assertListEqual(self.PROVIDERS_LIST, response_providers) + self.assertListEqual(self.PROVIDERS_LIST, response_providers) # noqa: PT009 assert len(httpretty.httpretty.latest_requests) == 2 diff --git a/openedx/core/djangoapps/credit/tests/test_models.py b/openedx/core/djangoapps/credit/tests/test_models.py index 2e3b02692a41..4a7fa510ecb1 100644 --- a/openedx/core/djangoapps/credit/tests/test_models.py +++ b/openedx/core/djangoapps/credit/tests/test_models.py @@ -7,19 +7,19 @@ from django.test import TestCase from opaque_keys.edx.keys import CourseKey +from common.djangoapps.student.tests.factories import UserFactory from openedx.core.djangoapps.credit.models import ( CreditCourse, CreditProvider, CreditRequest, CreditRequirement, - CreditRequirementStatus + CreditRequirementStatus, ) from openedx.core.djangoapps.user_api.accounts.tests.retirement_helpers import ( # pylint: disable=unused-import RetirementTestCase, - setup_retirement_states + setup_retirement_states, # noqa: F401 ) from openedx.core.djangoapps.user_api.models import UserRetirementStatus -from common.djangoapps.student.tests.factories import UserFactory def add_credit_course(course_key): diff --git a/openedx/core/djangoapps/credit/tests/test_serializers.py b/openedx/core/djangoapps/credit/tests/test_serializers.py index 18c397b4d48f..d79e53a7a1a1 100644 --- a/openedx/core/djangoapps/credit/tests/test_serializers.py +++ b/openedx/core/djangoapps/credit/tests/test_serializers.py @@ -4,9 +4,9 @@ from django.test import TestCase from rest_framework.exceptions import PermissionDenied +from common.djangoapps.student.tests.factories import UserFactory from openedx.core.djangoapps.credit import serializers, signature from openedx.core.djangoapps.credit.tests.factories import CreditEligibilityFactory, CreditProviderFactory -from common.djangoapps.student.tests.factories import UserFactory class CreditProviderSerializerTests(TestCase): @@ -26,7 +26,7 @@ def test_data(self): 'fulfillment_instructions': provider.fulfillment_instructions, 'thumbnail_url': provider.thumbnail_url, } - self.assertDictEqual(serializer.data, expected) + self.assertDictEqual(serializer.data, expected) # noqa: PT009 class CreditEligibilitySerializerTests(TestCase): @@ -42,7 +42,7 @@ def test_data(self): 'deadline': eligibility.deadline.strftime('%Y-%m-%dT%H:%M:%S.%fZ'), 'username': user.username, } - self.assertDictEqual(serializer.data, expected) + self.assertDictEqual(serializer.data, expected) # noqa: PT009 class CreditProviderCallbackSerializerTests(TestCase): @@ -56,7 +56,7 @@ def test_check_keys_exist_for_provider_string(self): serializer = serializers.CreditProviderCallbackSerializer() with pytest.raises(PermissionDenied): - serializer._check_keys_exist_for_provider(secret_key, provider_id) # lint-amnesty, pylint: disable=protected-access + serializer._check_keys_exist_for_provider(secret_key, provider_id) # pylint: disable=protected-access def test_check_keys_exist_for_provider_list_no_keys(self): """ @@ -70,7 +70,7 @@ def test_check_keys_exist_for_provider_list_no_keys(self): serializer = serializers.CreditProviderCallbackSerializer() with pytest.raises(PermissionDenied): - serializer._check_keys_exist_for_provider(secret_key, provider_id) # lint-amnesty, pylint: disable=protected-access + serializer._check_keys_exist_for_provider(secret_key, provider_id) # pylint: disable=protected-access def test_check_keys_exist_for_provider_list_with_key_present(self): """ @@ -82,7 +82,7 @@ def test_check_keys_exist_for_provider_list_with_key_present(self): provider_id = 'asu' serializer = serializers.CreditProviderCallbackSerializer() - result = serializer._check_keys_exist_for_provider(secret_key, provider_id) # lint-amnesty, pylint: disable=assignment-from-no-return, protected-access + result = serializer._check_keys_exist_for_provider(secret_key, provider_id) # pylint: disable=assignment-from-no-return, protected-access # No return value, so we expect successful execution to return None assert result is None @@ -101,7 +101,7 @@ def test_compare_signatures_string_key(self): ) with pytest.raises(PermissionDenied): # The first arg here is key we have (that doesn't match the sig) - serializer._compare_signatures('abcd1234', provider.provider_id) # lint-amnesty, pylint: disable=protected-access + serializer._compare_signatures('abcd1234', provider.provider_id) # pylint: disable=protected-access def test_compare_signatures_list_key(self): """ @@ -120,7 +120,7 @@ def test_compare_signatures_list_key(self): with pytest.raises(PermissionDenied): # The first arg here is the list of keys he have (that dont matcht the sig) - serializer._compare_signatures( # lint-amnesty, pylint: disable=protected-access + serializer._compare_signatures( # pylint: disable=protected-access ['abcd1234', 'xyz789'], provider.provider_id ) diff --git a/openedx/core/djangoapps/credit/tests/test_services.py b/openedx/core/djangoapps/credit/tests/test_services.py index 7f6b38463509..278e6b1df89f 100644 --- a/openedx/core/djangoapps/credit/tests/test_services.py +++ b/openedx/core/djangoapps/credit/tests/test_services.py @@ -3,18 +3,21 @@ """ -from unittest.mock import patch from datetime import datetime +from unittest.mock import patch + import ddt from common.djangoapps.course_modes.models import CourseMode +from common.djangoapps.student.models import CourseEnrollment, UserProfile from openedx.core.djangoapps.content.course_overviews.models import CourseOverview from openedx.core.djangoapps.credit.api.eligibility import set_credit_requirements from openedx.core.djangoapps.credit.models import CreditCourse from openedx.core.djangoapps.credit.services import CreditService -from common.djangoapps.student.models import CourseEnrollment, UserProfile -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + ModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order @ddt.ddt @@ -205,7 +208,7 @@ def test_invalid_user(self): ) # mark the grade as satisfied - retval = self.service.set_credit_requirement_status( # lint-amnesty, pylint: disable=assignment-from-none + retval = self.service.set_credit_requirement_status( # pylint: disable=assignment-from-none self.user.id, self.course.id, 'grade', @@ -214,7 +217,7 @@ def test_invalid_user(self): assert retval is None # remove the requirement status with the invalid user id - retval = self.service.remove_credit_requirement_status( # lint-amnesty, pylint: disable=assignment-from-none + retval = self.service.remove_credit_requirement_status( # pylint: disable=assignment-from-none 0, self.course.id, 'grade', @@ -373,7 +376,7 @@ def test_bad_user(self): ) # mark the grade as satisfied - retval = self.service.set_credit_requirement_status( # lint-amnesty, pylint: disable=assignment-from-none + retval = self.service.set_credit_requirement_status( # pylint: disable=assignment-from-none 0, self.course.id, 'grade', diff --git a/openedx/core/djangoapps/credit/tests/test_signals.py b/openedx/core/djangoapps/credit/tests/test_signals.py index 592c042a05b9..d6a0f5911c4f 100644 --- a/openedx/core/djangoapps/credit/tests/test_signals.py +++ b/openedx/core/djangoapps/credit/tests/test_signals.py @@ -5,9 +5,9 @@ from datetime import datetime, timedelta, timezone from unittest import mock from uuid import uuid4 +from zoneinfo import ZoneInfo import ddt -from zoneinfo import ZoneInfo from django.test.client import RequestFactory from opaque_keys.edx.keys import UsageKey from openedx_events.data import EventsMetadata @@ -17,7 +17,7 @@ EXAM_ATTEMPT_REJECTED, EXAM_ATTEMPT_RESET, EXAM_ATTEMPT_SUBMITTED, - EXAM_ATTEMPT_VERIFIED + EXAM_ATTEMPT_VERIFIED, ) from common.djangoapps.course_modes.models import CourseMode @@ -31,12 +31,13 @@ listen_for_exam_reset, listen_for_exam_submitted, listen_for_exam_verified, - listen_for_grade_calculation + listen_for_grade_calculation, ) from openedx.core.djangolib.testing.utils import skip_unless_lms -from xmodule.modulestore.tests.django_utils import \ - ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + ModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order @skip_unless_lms @@ -205,7 +206,7 @@ def _get_exam_event_metadata(event_signal): minorversion=0, source='openedx/lms/web', sourcehost='lms.test', - time=datetime.now(timezone.utc) + time=datetime.now(timezone.utc) # noqa: UP017 ) @mock.patch('openedx.core.djangoapps.credit.signals.handlers.remove_credit_requirement_status', autospec=True) diff --git a/openedx/core/djangoapps/credit/tests/test_tasks.py b/openedx/core/djangoapps/credit/tests/test_tasks.py index 47c4b50925e9..719bad872205 100644 --- a/openedx/core/djangoapps/credit/tests/test_tasks.py +++ b/openedx/core/djangoapps/credit/tests/test_tasks.py @@ -4,16 +4,21 @@ from datetime import datetime - from unittest import mock + from edx_proctoring.api import create_exam from openedx.core.djangoapps.credit.api import get_credit_requirements from openedx.core.djangoapps.credit.exceptions import InvalidCreditRequirements from openedx.core.djangoapps.credit.models import CreditCourse from openedx.core.djangoapps.credit.signals.handlers import on_course_publish -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory, BlockFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + ModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import ( # pylint: disable=wrong-import-order + BlockFactory, + CourseFactory, +) class TestTaskExecution(ModuleStoreTestCase): diff --git a/openedx/core/djangoapps/credit/tests/test_views.py b/openedx/core/djangoapps/credit/tests/test_views.py index 02428557ded0..b07b76877792 100644 --- a/openedx/core/djangoapps/credit/tests/test_views.py +++ b/openedx/core/djangoapps/credit/tests/test_views.py @@ -5,21 +5,23 @@ import datetime import json +from zoneinfo import ZoneInfo import ddt -from zoneinfo import ZoneInfo from django.conf import settings from django.test import Client, TestCase from django.test.utils import override_settings from django.urls import reverse from opaque_keys.edx.keys import CourseKey +from common.djangoapps.student.tests.factories import AdminFactory, UserFactory +from common.djangoapps.util.date_utils import to_timestamp from openedx.core.djangoapps.credit.models import ( CreditCourse, CreditProvider, CreditRequest, CreditRequirement, - CreditRequirementStatus + CreditRequirementStatus, ) from openedx.core.djangoapps.credit.serializers import CreditEligibilitySerializer, CreditProviderSerializer from openedx.core.djangoapps.credit.signature import signature @@ -27,13 +29,11 @@ CreditCourseFactory, CreditEligibilityFactory, CreditProviderFactory, - CreditRequestFactory + CreditRequestFactory, ) from openedx.core.djangoapps.oauth_dispatch.jwt import create_jwt_for_user -from openedx.core.djangoapps.oauth_dispatch.tests.factories import ApplicationFactory, AccessTokenFactory +from openedx.core.djangoapps.oauth_dispatch.tests.factories import AccessTokenFactory, ApplicationFactory from openedx.core.djangolib.testing.utils import skip_unless_lms -from common.djangoapps.student.tests.factories import AdminFactory, UserFactory -from common.djangoapps.util.date_utils import to_timestamp JSON = 'application/json' @@ -44,7 +44,7 @@ class ApiTestCaseMixin: def assert_error_response(self, response, msg, status_code=400): """ Validate the response's status and detail message. """ assert response.status_code == status_code - self.assertDictEqual(response.data, {'detail': msg}) + self.assertDictEqual(response.data, {'detail': msg}) # noqa: PT009 class UserMixin: @@ -200,7 +200,7 @@ def assert_course_created(self, course_id, response): assert response.status_code == 201 # Verify the API returns the serialized CreditCourse - self.assertDictEqual(json.loads(response.content.decode('utf-8')), data) + self.assertDictEqual(json.loads(response.content.decode('utf-8')), data) # noqa: PT009 # Verify the CreditCourse was actually created course_key = CourseKey.from_string(course_id) @@ -241,7 +241,7 @@ def test_get(self): assert response.status_code == 200 # Verify the API returns the serialized CreditCourse - self.assertDictEqual(json.loads(response.content.decode('utf-8')), self._serialize_credit_course(cc1)) + self.assertDictEqual(json.loads(response.content.decode('utf-8')), self._serialize_credit_course(cc1)) # noqa: PT009 # pylint: disable=line-too-long def test_list(self): """ Verify the endpoint supports listing all CreditCourse objects. """ @@ -253,7 +253,7 @@ def test_list(self): assert response.status_code == 200 # Verify the API returns a list of serialized CreditCourse objects - self.assertListEqual(json.loads(response.content.decode('utf-8')), expected) + self.assertListEqual(json.loads(response.content.decode('utf-8')), expected) # noqa: PT009 def test_update(self): """ Verify the endpoint supports updating a CreditCourse object. """ @@ -267,7 +267,7 @@ def test_update(self): assert response.status_code == 200 # Verify the serialized CreditCourse is returned - self.assertDictEqual(json.loads(response.content.decode('utf-8')), data) + self.assertDictEqual(json.loads(response.content.decode('utf-8')), data) # noqa: PT009 # Verify the data was persisted credit_course = CreditCourse.objects.get(course_key=credit_course.course_key) @@ -430,7 +430,7 @@ def test_post_user_not_eligible(self): course_key = credit_course.course_key response = self.post_credit_request(username, course_key) - msg = '[{username}] is not eligible for credit for [{course_key}].'.format(username=username, + msg = '[{username}] is not eligible for credit for [{course_key}].'.format(username=username, # noqa: UP032 course_key=course_key) self.assert_error_response(response, msg) @@ -659,7 +659,7 @@ def setUp(self): def create_url(self, eligibility): """ Returns a URL that can be used to view eligibility data. """ - return '{path}?username={username}&course_key={course_key}'.format( + return '{path}?username={username}&course_key={course_key}'.format( # noqa: UP032 path=reverse(self.view_name), username=eligibility.username, course_key=eligibility.course.course_key @@ -671,7 +671,7 @@ def assert_valid_get_response(self, eligibility): response = self.client.get(url) assert response.status_code == 200 - self.assertListEqual(response.data, CreditEligibilitySerializer([eligibility], many=True).data) + self.assertListEqual(response.data, CreditEligibilitySerializer([eligibility], many=True).data) # noqa: PT009 def test_get(self): """ Verify the endpoint returns eligibility information for the give user and course. """ @@ -682,7 +682,7 @@ def test_get_with_missing_parameters(self): is not provided. """ response = self.client.get(reverse(self.view_name)) assert response.status_code == 400 - self.assertDictEqual(response.data, + self.assertDictEqual(response.data, # noqa: PT009 {'detail': 'Both the course_key and username querystring parameters must be supplied.'}) def test_get_with_invalid_course_key(self): @@ -690,7 +690,7 @@ def test_get_with_invalid_course_key(self): url = f'{reverse(self.view_name)}?username=edx&course_key=a' response = self.client.get(url) assert response.status_code == 400 - self.assertDictEqual(response.data, {'detail': '[a] is not a valid course key.'}) + self.assertDictEqual(response.data, {'detail': '[a] is not a valid course key.'}) # noqa: PT009 def test_staff_can_view_all(self): """ Verify that staff users can view eligibility data for all users. """ diff --git a/openedx/core/djangoapps/credit/views.py b/openedx/core/djangoapps/credit/views.py index d61316b49c26..0767fc4fa4ee 100644 --- a/openedx/core/djangoapps/credit/views.py +++ b/openedx/core/djangoapps/credit/views.py @@ -5,8 +5,8 @@ import datetime import logging - from zoneinfo import ZoneInfo + from django.conf import settings from django.utils.decorators import method_decorator from django.views.decorators.csrf import csrf_exempt @@ -23,20 +23,20 @@ CreditApiBadRequest, InvalidCourseKey, InvalidCreditRequest, - UserNotEligibleException + UserNotEligibleException, ) from openedx.core.djangoapps.credit.models import ( CREDIT_PROVIDER_ID_REGEX, CreditCourse, CreditEligibility, CreditProvider, - CreditRequest + CreditRequest, ) from openedx.core.djangoapps.credit.serializers import ( CreditCourseSerializer, CreditEligibilitySerializer, CreditProviderCallbackSerializer, - CreditProviderSerializer + CreditProviderSerializer, ) from openedx.core.lib.api.authentication import BearerAuthentication from openedx.core.lib.api.mixins import PutAsCreateMixin @@ -86,7 +86,7 @@ def post(self, request, provider_id): try: course_key = CourseKey.from_string(course_key) except InvalidKeyError: - raise InvalidCourseKey(course_key) # lint-amnesty, pylint: disable=raise-missing-from + raise InvalidCourseKey(course_key) # pylint: disable=raise-missing-from # noqa: B904 # Validate the username username = request.data.get('username') @@ -101,7 +101,7 @@ def post(self, request, provider_id): credit_request = create_credit_request(course_key, provider.provider_id, username) return Response(credit_request) except CreditApiBadRequest as ex: - raise InvalidCreditRequest(str(ex)) # lint-amnesty, pylint: disable=raise-missing-from + raise InvalidCreditRequest(str(ex)) # pylint: disable=raise-missing-from # noqa: B904 class CreditProviderCallbackView(views.APIView): @@ -162,7 +162,7 @@ def filter_queryset(self, queryset): try: course_key = CourseKey.from_string(course_key) except InvalidKeyError: - raise ValidationError({'detail': f'[{course_key}] is not a valid course key.'}) # lint-amnesty, pylint: disable=raise-missing-from + raise ValidationError({'detail': f'[{course_key}] is not a valid course key.'}) # pylint: disable=raise-missing-from # noqa: B904 return queryset.filter( username=username, course__course_key=course_key, diff --git a/openedx/core/djangoapps/dark_lang/middleware.py b/openedx/core/djangoapps/dark_lang/middleware.py index 817d544e9ff4..42fd3fa5ccbf 100644 --- a/openedx/core/djangoapps/dark_lang/middleware.py +++ b/openedx/core/djangoapps/dark_lang/middleware.py @@ -10,8 +10,8 @@ from django.conf import settings -from django.utils.translation.trans_real import parse_accept_lang_header from django.utils.deprecation import MiddlewareMixin +from django.utils.translation.trans_real import parse_accept_lang_header from openedx.core.djangoapps.dark_lang import DARK_LANGUAGE_KEY from openedx.core.djangoapps.dark_lang.models import DarkLangConfig diff --git a/openedx/core/djangoapps/dark_lang/migrations/0001_initial.py b/openedx/core/djangoapps/dark_lang/migrations/0001_initial.py index 6c8ab882e876..adf374ca59c9 100644 --- a/openedx/core/djangoapps/dark_lang/migrations/0001_initial.py +++ b/openedx/core/djangoapps/dark_lang/migrations/0001_initial.py @@ -1,6 +1,6 @@ -from django.db import migrations, models import django.db.models.deletion from django.conf import settings +from django.db import migrations, models class Migration(migrations.Migration): diff --git a/openedx/core/djangoapps/dark_lang/tests.py b/openedx/core/djangoapps/dark_lang/tests.py index 765d2ea3091f..53f9eaf63e15 100644 --- a/openedx/core/djangoapps/dark_lang/tests.py +++ b/openedx/core/djangoapps/dark_lang/tests.py @@ -11,14 +11,14 @@ from django.http import HttpRequest from django.test.client import Client +from common.djangoapps.student.tests.factories import UserFactory from openedx.core.djangoapps.dark_lang.middleware import DarkLangMiddleware from openedx.core.djangoapps.dark_lang.models import DarkLangConfig from openedx.core.djangoapps.site_configuration.tests.test_util import ( with_site_configuration, with_site_configuration_context, ) -from openedx.core.djangolib.testing.utils import CacheIsolationTestCase -from common.djangoapps.student.tests.factories import UserFactory +from openedx.core.djangolib.testing.utils import CacheIsolationTestCase, skip_unless_lms UNSET = object() @@ -251,7 +251,7 @@ def _post_set_preview_lang(self, preview_language): """ Sends a post request to set the preview language """ - return self.client.post('/update_lang/', {'preview_language': preview_language, 'action': 'set_preview_language'}) # lint-amnesty, pylint: disable=line-too-long + return self.client.post('/update_lang/', {'preview_language': preview_language, 'action': 'set_preview_language'}) # pylint: disable=line-too-long def _post_clear_preview_lang(self): """ @@ -259,6 +259,7 @@ def _post_clear_preview_lang(self): """ return self.client.post('/update_lang/', {'action': 'reset_preview_language'}) + @skip_unless_lms def test_preview_lang_with_released_language(self): # Preview lang should always override selection self._post_set_preview_lang('rel') @@ -272,6 +273,7 @@ def test_preview_lang_with_released_language(self): self.client.get('/home') self.assert_cookie_lang_equals('rel') + @skip_unless_lms def test_preview_lang_with_dark_language(self): self._post_set_preview_lang('unrel') self.client.get('/home') @@ -290,6 +292,7 @@ def test_empty_preview_language(self): self.client.get('/home') self.assert_cookie_lang_equals('rel') + @skip_unless_lms def test_clear_lang(self): # Clear a language when no language was set self._post_clear_preview_lang() @@ -335,6 +338,7 @@ def test_accept_chinese_language_codes(self): self.process_middleware_request(accept='zh-Hans;q=1.0, zh-Hant-TW;q=0.5, zh-HK;q=0.3') ) + @skip_unless_lms def test_language_cookie_is_set(self): site_lang = settings.LANGUAGE_CODE url = '/dashboard' @@ -370,6 +374,7 @@ def test_language_cookie_is_set(self): assert response.cookies.get(settings.LANGUAGE_COOKIE_NAME).value == '' assert response['Content-Language'] == site_lang + @skip_unless_lms @with_site_configuration(configuration={'LANGUAGE_CODE': 'es'}) def test_preview_language_ignores_site_configuration(self): """ diff --git a/openedx/core/djangoapps/dark_lang/urls.py b/openedx/core/djangoapps/dark_lang/urls.py index d824b385a414..46baf51deaa7 100644 --- a/openedx/core/djangoapps/dark_lang/urls.py +++ b/openedx/core/djangoapps/dark_lang/urls.py @@ -3,6 +3,7 @@ """ from django.urls import path + from openedx.core.djangoapps.dark_lang import views app_name = 'dark_lang' diff --git a/openedx/core/djangoapps/dark_lang/views.py b/openedx/core/djangoapps/dark_lang/views.py index 4d0ce352b3ba..9aae2a819e68 100644 --- a/openedx/core/djangoapps/dark_lang/views.py +++ b/openedx/core/djangoapps/dark_lang/views.py @@ -29,7 +29,7 @@ class PreviewLanguageFragmentView(EdxFragmentView): POST - updates or clears the setting to the given dark language """ - def render_to_fragment(self, request, course_id=None, **kwargs): # lint-amnesty, pylint: disable=arguments-differ, unused-argument + def render_to_fragment(self, request, course_id=None, **kwargs): # pylint: disable=arguments-differ, unused-argument """ Renders the language preview view as a fragment. """ @@ -60,7 +60,7 @@ def get(self, request, *args, **kwargs): return super().get(request, *args, **kwargs) @method_decorator(login_required) - def post(self, request, **kwargs): # lint-amnesty, pylint: disable=unused-argument + def post(self, request, **kwargs): # pylint: disable=unused-argument """ Accept requests to update the preview language. """ diff --git a/openedx/core/djangoapps/discussions/admin.py b/openedx/core/djangoapps/discussions/admin.py index 810f57e95226..ae125d76e187 100644 --- a/openedx/core/djangoapps/discussions/admin.py +++ b/openedx/core/djangoapps/discussions/admin.py @@ -8,8 +8,7 @@ from openedx.core.djangoapps.config_model_utils.admin import StackedConfigModelAdmin -from .models import DiscussionsConfiguration -from .models import ProviderFilter +from .models import DiscussionsConfiguration, ProviderFilter class DiscussionsConfigurationAdmin(SimpleHistoryAdmin): diff --git a/openedx/core/djangoapps/discussions/apps.py b/openedx/core/djangoapps/discussions/apps.py index ba0b66942586..3bf4435bd2f9 100644 --- a/openedx/core/djangoapps/discussions/apps.py +++ b/openedx/core/djangoapps/discussions/apps.py @@ -2,8 +2,7 @@ Configure the django app """ from django.apps import AppConfig -from edx_django_utils.plugins import PluginSettings -from edx_django_utils.plugins import PluginURLs +from edx_django_utils.plugins import PluginSettings, PluginURLs from openedx.core.djangoapps.plugins.constants import ProjectType @@ -32,4 +31,4 @@ class DiscussionsConfig(AppConfig): } def ready(self): - from . import handlers # pylint: disable=unused-import + from . import handlers # pylint: disable=unused-import # noqa: F401 diff --git a/openedx/core/djangoapps/discussions/config/waffle_utils.py b/openedx/core/djangoapps/discussions/config/waffle_utils.py index d44b7af5ad8c..0b2c579cb095 100644 --- a/openedx/core/djangoapps/discussions/config/waffle_utils.py +++ b/openedx/core/djangoapps/discussions/config/waffle_utils.py @@ -4,7 +4,7 @@ from openedx.core.djangoapps.discussions.config.waffle import ( ENABLE_PAGES_AND_RESOURCES_MICROFRONTEND, - OVERRIDE_DISCUSSION_LEGACY_SETTINGS_FLAG + OVERRIDE_DISCUSSION_LEGACY_SETTINGS_FLAG, ) diff --git a/openedx/core/djangoapps/discussions/handlers.py b/openedx/core/djangoapps/discussions/handlers.py index f43aaf4b09eb..d63e412afcc2 100644 --- a/openedx/core/djangoapps/discussions/handlers.py +++ b/openedx/core/djangoapps/discussions/handlers.py @@ -5,12 +5,13 @@ from uuid import uuid4 from django.db import transaction - from openedx_events.learning.data import CourseDiscussionConfigurationData from openedx_events.learning.signals import COURSE_DISCUSSIONS_CHANGED + +from openedx.core.djangoapps.course_apps.models import CourseAppStatus from openedx.core.djangoapps.discussions.models import ( - DiscussionTopicLink, DiscussionsConfiguration, + DiscussionTopicLink, get_default_provider_type, ) @@ -96,12 +97,26 @@ def update_course_discussion_config(configuration: CourseDiscussionConfiguration log.info(f"Course {course_key} doesn't have discussion configuration model yet. Creating a new one.") DiscussionsConfiguration( context_key=course_key, + enabled=configuration.enabled, provider_type=provider_id, plugin_configuration=configuration.plugin_configuration, enable_in_context=configuration.enable_in_context, enable_graded_units=configuration.enable_graded_units, unit_level_visibility=configuration.unit_level_visibility, ).save() + else: + DiscussionsConfiguration.objects.filter( + context_key=course_key, + ).update(enabled=configuration.enabled) + + # Also update CourseAppStatus to keep the Pages & Resources UI in sync. + # The update_course_apps_status task may run before this handler due to + # the COURSE_PUBLISH_TASK_DELAY countdown, caching a stale enabled value. + CourseAppStatus.update_status_for_course_app( + course_key=course_key, + app_id="discussion", + enabled=configuration.enabled, + ) COURSE_DISCUSSIONS_CHANGED.connect(handle_course_discussion_config_update) diff --git a/openedx/core/djangoapps/discussions/migrations/0001_initial.py b/openedx/core/djangoapps/discussions/migrations/0001_initial.py index b42d633998cc..2e9a57e7214b 100644 --- a/openedx/core/djangoapps/discussions/migrations/0001_initial.py +++ b/openedx/core/djangoapps/discussions/migrations/0001_initial.py @@ -1,5 +1,3 @@ -from django.conf import settings -from django.db import migrations, models import django.db.models.deletion import django.utils.timezone import jsonfield.encoder @@ -7,6 +5,8 @@ import model_utils.fields import opaque_keys.edx.django.models import simple_history.models +from django.conf import settings +from django.db import migrations, models class Migration(migrations.Migration): diff --git a/openedx/core/djangoapps/discussions/migrations/0002_add_provider_filter.py b/openedx/core/djangoapps/discussions/migrations/0002_add_provider_filter.py index b8320e580cf3..ed57ed24d026 100644 --- a/openedx/core/djangoapps/discussions/migrations/0002_add_provider_filter.py +++ b/openedx/core/djangoapps/discussions/migrations/0002_add_provider_filter.py @@ -1,9 +1,10 @@ # Generated by Django 2.2.17 on 2021-02-02 06:35 -from django.conf import settings -from django.db import migrations, models import django.db.models.deletion import django_mysql.models +from django.conf import settings +from django.db import migrations, models + import openedx.core.djangoapps.config_model_utils.models diff --git a/openedx/core/djangoapps/discussions/migrations/0003_alter_provider_filter_list.py b/openedx/core/djangoapps/discussions/migrations/0003_alter_provider_filter_list.py index 41edcf461d0c..19bfe01f63a0 100644 --- a/openedx/core/djangoapps/discussions/migrations/0003_alter_provider_filter_list.py +++ b/openedx/core/djangoapps/discussions/migrations/0003_alter_provider_filter_list.py @@ -1,7 +1,7 @@ # Generated by Django 2.2.19 on 2021-03-23 14:46 -from django.db import migrations, models import django_mysql.models +from django.db import migrations, models class Migration(migrations.Migration): diff --git a/openedx/core/djangoapps/discussions/migrations/0004_historicalprogramdiscussionsconfiguration_programdiscussionsconfiguration.py b/openedx/core/djangoapps/discussions/migrations/0004_historicalprogramdiscussionsconfiguration_programdiscussionsconfiguration.py index 872d2887a7e4..8daf1a9f38d2 100644 --- a/openedx/core/djangoapps/discussions/migrations/0004_historicalprogramdiscussionsconfiguration_programdiscussionsconfiguration.py +++ b/openedx/core/djangoapps/discussions/migrations/0004_historicalprogramdiscussionsconfiguration_programdiscussionsconfiguration.py @@ -1,11 +1,11 @@ # Generated by Django 2.2.24 on 2021-08-31 11:18 -from django.conf import settings -from django.db import migrations, models import django.db.models.deletion import django.utils.timezone import model_utils.fields import simple_history.models +from django.conf import settings +from django.db import migrations, models class Migration(migrations.Migration): diff --git a/openedx/core/djangoapps/discussions/migrations/0005_auto_20210910_0940.py b/openedx/core/djangoapps/discussions/migrations/0005_auto_20210910_0940.py index 7b067f8c34f1..fbe89f86c0df 100644 --- a/openedx/core/djangoapps/discussions/migrations/0005_auto_20210910_0940.py +++ b/openedx/core/djangoapps/discussions/migrations/0005_auto_20210910_0940.py @@ -1,7 +1,7 @@ # Generated by Django 2.2.24 on 2021-09-10 09:40 -from django.db import migrations import jsonfield.fields +from django.db import migrations class Migration(migrations.Migration): diff --git a/openedx/core/djangoapps/discussions/migrations/0006_auto_20211006_0441.py b/openedx/core/djangoapps/discussions/migrations/0006_auto_20211006_0441.py index 664a12bcf71c..1b51397df86a 100644 --- a/openedx/core/djangoapps/discussions/migrations/0006_auto_20211006_0441.py +++ b/openedx/core/djangoapps/discussions/migrations/0006_auto_20211006_0441.py @@ -1,7 +1,7 @@ # Generated by Django 2.2.24 on 2021-10-06 04:41 -from django.db import migrations, models import django_mysql.models +from django.db import migrations, models class Migration(migrations.Migration): diff --git a/openedx/core/djangoapps/discussions/migrations/0008_auto_20220119_0746.py b/openedx/core/djangoapps/discussions/migrations/0008_auto_20220119_0746.py index 61797a5b651a..94d09a0158dc 100644 --- a/openedx/core/djangoapps/discussions/migrations/0008_auto_20220119_0746.py +++ b/openedx/core/djangoapps/discussions/migrations/0008_auto_20220119_0746.py @@ -1,11 +1,11 @@ # Generated by Django 3.2.11 on 2022-01-19 07:46 -from django.conf import settings -from django.db import migrations, models import django.db.models.deletion import django.utils.timezone import model_utils.fields import simple_history.models +from django.conf import settings +from django.db import migrations, models class Migration(migrations.Migration): diff --git a/openedx/core/djangoapps/discussions/migrations/0011_auto_20220510_0716.py b/openedx/core/djangoapps/discussions/migrations/0011_auto_20220510_0716.py index a5d016be9632..cc9221556cd2 100644 --- a/openedx/core/djangoapps/discussions/migrations/0011_auto_20220510_0716.py +++ b/openedx/core/djangoapps/discussions/migrations/0011_auto_20220510_0716.py @@ -1,7 +1,7 @@ # Generated by Django 3.2.13 on 2022-05-10 07:16 -from django.db import migrations, models import django_mysql.models +from django.db import migrations, models class Migration(migrations.Migration): diff --git a/openedx/core/djangoapps/discussions/migrations/0012_auto_20220511_0827.py b/openedx/core/djangoapps/discussions/migrations/0012_auto_20220511_0827.py index 89f2261c64c6..9601b57f4de8 100644 --- a/openedx/core/djangoapps/discussions/migrations/0012_auto_20220511_0827.py +++ b/openedx/core/djangoapps/discussions/migrations/0012_auto_20220511_0827.py @@ -1,7 +1,7 @@ # Generated by Django 3.2.13 on 2022-05-11 08:27 -from django.db import migrations, models import django_mysql.models +from django.db import migrations, models class Migration(migrations.Migration): diff --git a/openedx/core/djangoapps/discussions/migrations/0013_auto_20220802_1154.py b/openedx/core/djangoapps/discussions/migrations/0013_auto_20220802_1154.py index 3108dd27e977..bd1199aea64f 100644 --- a/openedx/core/djangoapps/discussions/migrations/0013_auto_20220802_1154.py +++ b/openedx/core/djangoapps/discussions/migrations/0013_auto_20220802_1154.py @@ -1,6 +1,7 @@ # Generated by Django 3.2.14 on 2022-08-02 11:54 from django.db import migrations, models + import openedx.core.djangoapps.discussions.models diff --git a/openedx/core/djangoapps/discussions/migrations/0019_sync_discussion_config_enabled_with_tab.py b/openedx/core/djangoapps/discussions/migrations/0019_sync_discussion_config_enabled_with_tab.py new file mode 100644 index 000000000000..598c366d6004 --- /dev/null +++ b/openedx/core/djangoapps/discussions/migrations/0019_sync_discussion_config_enabled_with_tab.py @@ -0,0 +1,51 @@ +""" +Backfill DiscussionsConfiguration.enabled and CourseAppStatus.enabled for +existing courses to match CourseOverviewTab.is_hidden. + +When a course is imported, the discussion tab's is_hidden value is carried over +from the source course. However, DiscussionsConfiguration.enabled and +CourseAppStatus.enabled default to True and are not updated from the imported +tab state, causing a desync. + +This is a one-time backfill for existing courses. Going forward, the +update_course_discussion_config handler keeps these values in sync on every +course publish. +""" + +from django.db import migrations + + +def sync_enabled_from_course_overview_tab(apps, schema_editor): + CourseOverviewTab = apps.get_model("course_overviews", "CourseOverviewTab") + DiscussionsConfiguration = apps.get_model("discussions", "DiscussionsConfiguration") + CourseAppStatus = apps.get_model("course_apps", "CourseAppStatus") + + discussion_tabs = CourseOverviewTab.objects.filter(tab_id="discussion").select_related("course_overview") + + for tab in discussion_tabs.iterator(): + course_key = tab.course_overview_id + expected_enabled = not tab.is_hidden + DiscussionsConfiguration.objects.filter( + context_key=course_key, + ).exclude( + enabled=expected_enabled, + ).update(enabled=expected_enabled) + CourseAppStatus.objects.filter( + course_key=course_key, + app_id="discussion", + ).exclude( + enabled=expected_enabled, + ).update(enabled=expected_enabled) + + +class Migration(migrations.Migration): + + dependencies = [ + ("discussions", "0018_auto_20230904_1054"), + ("course_overviews", "0030_backfill_new_catalog_courseruns"), + ("course_apps", "0002_alter_historicalcourseappstatus_options"), + ] + + operations = [ + migrations.RunPython(sync_enabled_from_course_overview_tab, migrations.RunPython.noop), + ] diff --git a/openedx/core/djangoapps/discussions/models.py b/openedx/core/djangoapps/discussions/models.py index f47b661c9ad2..930b6daa324d 100644 --- a/openedx/core/djangoapps/discussions/models.py +++ b/openedx/core/djangoapps/discussions/models.py @@ -5,14 +5,14 @@ import logging from collections import namedtuple -from typing import List, Type, TypeVar +from enum import Enum # pylint: disable=wrong-import-order +from typing import List, Type, TypeVar # noqa: UP035 from django.conf import settings from django.core.exceptions import ValidationError from django.db import models from django.utils.translation import gettext_lazy as _ from django_mysql.models import ListCharField -from enum import Enum # lint-amnesty, pylint: disable=wrong-import-order from jsonfield import JSONField from lti_consumer.models import LtiConfiguration from model_utils.models import TimeStampedModel @@ -20,10 +20,10 @@ from opaque_keys.edx.keys import CourseKey from simple_history.models import HistoricalRecords -from openedx.core.djangoapps.discussions.config.waffle import ENABLE_NEW_STRUCTURE_DISCUSSIONS from openedx.core.djangoapps.config_model_utils.models import StackedConfigurationModel from openedx.core.djangoapps.content.course_overviews.models import CourseOverview from openedx.core.djangoapps.course_groups.models import CourseUserGroup +from openedx.core.djangoapps.discussions.config.waffle import ENABLE_NEW_STRUCTURE_DISCUSSIONS from openedx.core.djangoapps.site_configuration import helpers as configuration_helpers log = logging.getLogger(__name__) @@ -305,7 +305,7 @@ def pii_sharing_required_message(provider_name): } -def get_supported_providers() -> List[str]: +def get_supported_providers() -> List[str]: # noqa: UP006 """ Return the list of supported discussion providers @@ -376,7 +376,7 @@ def __str__(self): ) @property - def available_providers(self) -> List[str]: + def available_providers(self) -> List[str]: # noqa: UP006 """ Return a filtered list of available providers """ @@ -396,7 +396,7 @@ def available_providers(self) -> List[str]: return _providers @classmethod - def get_available_providers(cls, course_key: CourseKey) -> List[str]: + def get_available_providers(cls, course_key: CourseKey) -> List[str]: # noqa: UP006 _filter = cls.current(course_key=course_key) providers = _filter.available_providers return providers @@ -480,7 +480,7 @@ def clean(self): raise ValidationError('Context Key should be an existing learning context.') def __str__(self): - return "DiscussionsConfiguration(context_key='{context_key}', provider='{provider}', enabled={enabled})".format( + return "DiscussionsConfiguration(context_key='{context_key}', provider='{provider}', enabled={enabled})".format( # noqa: UP032 # pylint: disable=line-too-long context_key=self.context_key, provider=self.provider_type, enabled=self.enabled, @@ -515,7 +515,7 @@ def is_enabled(cls, context_key: CourseKey) -> bool: return configuration.enabled @classmethod - def get(cls: Type[T], context_key: CourseKey) -> T: + def get(cls: Type[T], context_key: CourseKey) -> T: # noqa: UP006 """ Lookup a model by context_key """ @@ -530,11 +530,11 @@ def get(cls: Type[T], context_key: CourseKey) -> T: return configuration @property - def available_providers(self) -> List[str]: + def available_providers(self) -> List[str]: # noqa: UP006 return ProviderFilter.current(course_key=self.context_key).available_providers @classmethod - def get_available_providers(cls, context_key: CourseKey) -> List[str]: + def get_available_providers(cls, context_key: CourseKey) -> List[str]: # noqa: UP006 return ProviderFilter.current(course_key=context_key).available_providers @classmethod @@ -559,7 +559,7 @@ class DiscussionTopicLink(models.Model): """ A model linking discussion topics ids to the part of a course they are linked to. - ..no_pii: + .. no_pii: """ context_key = LearningContextKeyField( db_index=True, diff --git a/openedx/core/djangoapps/discussions/permissions.py b/openedx/core/djangoapps/discussions/permissions.py index 7028defc3e00..be3e7e46d251 100644 --- a/openedx/core/djangoapps/discussions/permissions.py +++ b/openedx/core/djangoapps/discussions/permissions.py @@ -1,11 +1,17 @@ """ API library for Django REST Framework permissions-oriented workflows """ +from openedx_authz import api as authz_api +from openedx_authz.constants.permissions import ( + COURSES_MANAGE_PAGES_AND_RESOURCES, + COURSES_VIEW_PAGES_AND_RESOURCES, +) from rest_framework.exceptions import PermissionDenied from rest_framework.permissions import BasePermission -from common.djangoapps.student.roles import CourseStaffRole, GlobalStaff, CourseInstructorRole +from common.djangoapps.student.roles import CourseInstructorRole, CourseStaffRole, GlobalStaff from lms.djangoapps.discussion.django_comment_client.utils import has_discussion_privileges +from openedx.core import toggles as core_toggles from openedx.core.lib.api.view_utils import validate_course_key DEFAULT_MESSAGE = "You're not authorized to perform this operation." @@ -14,27 +20,43 @@ } -class IsStaffOrCourseTeam(BasePermission): +def _legacy_is_staff_or_course_team(user, course_key): + """Legacy permission check: allows global staff, course instructor, course staff, or discussion moderators/TAs.""" + if GlobalStaff().has_user(user): + return True + return ( + CourseInstructorRole(course_key).has_user(user) + or CourseStaffRole(course_key).has_user(user) + or has_discussion_privileges(user, course_key) + ) + + +class HasPagesAndResourcesAccess(BasePermission): """ - Check if user is global or course staff + Check if user has access to Pages & Resources. - Permission that checks to see if the user is global staff, course - staff, course admin, or has discussion privileges. If none of those conditions are - met, HTTP403 is returned. + When the authz feature flag is enabled, uses authz permissions. + GET requests check view permission, all others check manage permission. + Falls back to has_discussion_privileges when authz denies access + (transitional until discussion roles are migrated to authz). + When the flag is off, falls back to legacy behavior: global staff, + course instructor, course staff, or discussion privileges. """ def has_permission(self, request, view): course_key_string = view.kwargs.get('course_key_string') course_key = validate_course_key(course_key_string) - if GlobalStaff().has_user(request.user): - return True + if core_toggles.enable_authz_course_authoring(course_key): + if request.method == 'GET': + authz_perm = COURSES_VIEW_PAGES_AND_RESOURCES.identifier + else: + authz_perm = COURSES_MANAGE_PAGES_AND_RESOURCES.identifier + if authz_api.is_user_allowed(request.user.username, authz_perm, str(course_key)): + return True + return has_discussion_privileges(request.user, course_key) - return ( - CourseInstructorRole(course_key).has_user(request.user) or - CourseStaffRole(course_key).has_user(request.user) or - has_discussion_privileges(request.user, course_key) - ) + return _legacy_is_staff_or_course_team(request.user, course_key) def user_permissions_for_course(course, user): diff --git a/openedx/core/djangoapps/discussions/plugins.py b/openedx/core/djangoapps/discussions/plugins.py index f48c31d12b78..06b62e92aa23 100644 --- a/openedx/core/djangoapps/discussions/plugins.py +++ b/openedx/core/djangoapps/discussions/plugins.py @@ -1,7 +1,7 @@ """ Course app configuration for discussions. """ -from typing import Dict, Optional +from typing import Dict, Optional # noqa: UP035 from django.conf import settings from django.contrib.auth import get_user_model @@ -9,6 +9,7 @@ from opaque_keys.edx.keys import CourseKey from openedx.core.djangoapps.course_apps.plugins import CourseApp + from .models import DiscussionsConfiguration User = get_user_model() @@ -53,7 +54,7 @@ def set_enabled(cls, course_key: CourseKey, enabled: bool, user: 'User') -> bool return configuration.enabled @classmethod - def get_allowed_operations(cls, course_key: CourseKey, user: Optional[User] = None) -> Dict[str, bool]: + def get_allowed_operations(cls, course_key: CourseKey, user: Optional[User] = None) -> Dict[str, bool]: # noqa: UP006, UP045 # pylint: disable=line-too-long """ Return allowed operations for discussions app. """ diff --git a/openedx/core/djangoapps/discussions/serializers.py b/openedx/core/djangoapps/discussions/serializers.py index 5e042575a2c7..53b2acfed8fd 100644 --- a/openedx/core/djangoapps/discussions/serializers.py +++ b/openedx/core/djangoapps/discussions/serializers.py @@ -5,14 +5,15 @@ from lti_consumer.api import get_lti_pii_sharing_state_for_course from lti_consumer.models import LtiConfiguration from rest_framework import serializers -from xmodule.modulestore.django import modulestore from openedx.core.djangoapps.discussions.tasks import update_discussions_settings_from_course_task from openedx.core.djangoapps.django_comment_common.models import CourseDiscussionSettings from openedx.core.lib.courses import get_course_by_id +from xmodule.modulestore.django import modulestore + +from ..content.course_overviews.models import CourseOverviewTab from .models import DiscussionsConfiguration, Provider from .utils import available_division_schemes, get_divided_discussions -from ..content.course_overviews.models import CourseOverviewTab class LtiSerializer(serializers.ModelSerializer): diff --git a/openedx/core/djangoapps/discussions/services.py b/openedx/core/djangoapps/discussions/services.py new file mode 100644 index 000000000000..db3b774cc638 --- /dev/null +++ b/openedx/core/djangoapps/discussions/services.py @@ -0,0 +1,39 @@ +""" +Discussion Configuration Service for XBlock runtime. + +This service provides discussion-related configuration and feature flags +that are specific to the edx-platform implementation +for the extracted discussion block in xblocks-contrib repository. +""" + +from django.conf import settings +from django.contrib.auth.models import User # pylint: disable=imported-auth-user +from opaque_keys.edx.keys import CourseKey + +from openedx.core.djangoapps.discussions.models import DiscussionsConfiguration, Provider +from openedx.core.djangoapps.django_comment_common.models import has_permission + + +class DiscussionConfigService: + """ + Service for providing discussion-related configuration and feature flags. + """ + + def has_permission(self, user: User, permission: str, course_id: CourseKey | None = None) -> bool: + """ + Return whether the user has the given discussion permission for a given course. + """ + return has_permission(user, permission, course_id) + + def is_discussion_visible(self, course_key: CourseKey) -> bool: + """ + Discussion Xblock does not support new OPEN_EDX provider + """ + provider = DiscussionsConfiguration.get(course_key) + return provider.provider_type == Provider.LEGACY + + def is_discussion_enabled(self) -> bool: + """ + Return True if discussions are enabled; else False + """ + return settings.ENABLE_DISCUSSION_SERVICE diff --git a/openedx/core/djangoapps/discussions/tasks.py b/openedx/core/djangoapps/discussions/tasks.py index afb43b32cd33..4599f33454d4 100644 --- a/openedx/core/djangoapps/discussions/tasks.py +++ b/openedx/core/djangoapps/discussions/tasks.py @@ -11,9 +11,9 @@ from xmodule.modulestore import ModuleStoreEnum from xmodule.modulestore.django import modulestore -from .config.waffle import ENABLE_NEW_STRUCTURE_DISCUSSIONS -from .models import DiscussionsConfiguration, Provider, DiscussionTopicLink +from .config.waffle import ENABLE_NEW_STRUCTURE_DISCUSSIONS +from .models import DiscussionsConfiguration, DiscussionTopicLink, Provider from .utils import get_accessible_discussion_xblocks_by_course_id log = logging.getLogger(__name__) @@ -88,8 +88,20 @@ def update_discussions_settings_from_course( ) contexts.extend(list(discussable_units)) + # Derive enabled from the discussion tab's is_hidden state. + # When a course is imported or rerun, course.tabs are copied verbatim + # from the source but DiscussionsConfiguration is not, so we pass the + # tab state through config_data for the handler to reconcile. + enabled = True + if course: + for tab in course.tabs: + if getattr(tab, 'tab_id', None) == 'discussion': + enabled = not tab.is_hidden + break + config_data = CourseDiscussionConfigurationData( course_key=course_key, + enabled=enabled, enable_in_context=enable_in_context, enable_graded_units=enable_graded_units, unit_level_visibility=unit_level_visibility, diff --git a/openedx/core/djangoapps/discussions/tests/test_admin.py b/openedx/core/djangoapps/discussions/tests/test_admin.py index d16d73dd8bef..3ba12a66d68a 100644 --- a/openedx/core/djangoapps/discussions/tests/test_admin.py +++ b/openedx/core/djangoapps/discussions/tests/test_admin.py @@ -28,5 +28,5 @@ def test_change_view(self): ) url = reverse('admin:discussions_discussionsconfiguration_change', args=[discussion_config.context_key]) response = self.client.get(url) - self.assertEqual(response.status_code, 200) + self.assertEqual(response.status_code, 200) # noqa: PT009 self.assertContains(response, 'course-v1:test+test+06_25_2024') diff --git a/openedx/core/djangoapps/discussions/tests/test_handlers.py b/openedx/core/djangoapps/discussions/tests/test_handlers.py index 7e493063da31..b16ecd9f8470 100644 --- a/openedx/core/djangoapps/discussions/tests/test_handlers.py +++ b/openedx/core/djangoapps/discussions/tests/test_handlers.py @@ -7,10 +7,11 @@ import ddt from django.test import TestCase from opaque_keys.edx.keys import CourseKey - from openedx_events.learning.data import CourseDiscussionConfigurationData, DiscussionTopicContext + +from openedx.core.djangoapps.course_apps.models import CourseAppStatus from openedx.core.djangoapps.discussions.handlers import update_course_discussion_config -from openedx.core.djangoapps.discussions.models import DiscussionTopicLink, DiscussionsConfiguration +from openedx.core.djangoapps.discussions.models import DiscussionsConfiguration, DiscussionTopicLink @ddt.ddt @@ -55,6 +56,7 @@ def test_configuration_for_new_course(self): config_data = CourseDiscussionConfigurationData( course_key=new_key, provider_type="openedx", + plugin_configuration={}, ) assert not DiscussionsConfiguration.objects.filter(context_key=new_key).exists() update_course_discussion_config(config_data) @@ -191,3 +193,69 @@ def test_enabled_units_change(self): assert existing_topic_link.title == "Section 10|Subsection 10|Unit 10" # If there is no stored context, then continue using the Unit name. assert existing_topic_link_2.title == "Unit 11" + + def test_new_config_uses_enabled_from_configuration(self): + """ + When creating a new DiscussionsConfiguration, the handler should use + the enabled value from the configuration data. + """ + new_key = CourseKey.from_string("course-v1:test+test+disabled") + config_data = CourseDiscussionConfigurationData( + course_key=new_key, + provider_type="openedx", + enabled=False, + plugin_configuration={}, + ) + update_course_discussion_config(config_data) + db_config = DiscussionsConfiguration.objects.get(context_key=new_key) + assert db_config.enabled is False + + def test_existing_config_updated_enabled_from_configuration(self): + """ + When the configuration already exists, the handler should update + enabled from the configuration data. + """ + config_data = CourseDiscussionConfigurationData( + course_key=self.course_key, + provider_type="openedx", + enabled=False, + ) + update_course_discussion_config(config_data) + db_config = DiscussionsConfiguration.objects.get(context_key=self.course_key) + assert db_config.enabled is False + + def test_course_app_status_created_for_new_course(self): + """ + When no CourseAppStatus row exists yet (new course), the handler should + create one with the correct enabled value. + """ + new_key = CourseKey.from_string("course-v1:test+test+new_app_status") + assert not CourseAppStatus.objects.filter(course_key=new_key, app_id="discussion").exists() + config_data = CourseDiscussionConfigurationData( + course_key=new_key, + provider_type="openedx", + enabled=False, + plugin_configuration={}, + ) + update_course_discussion_config(config_data) + app_status = CourseAppStatus.objects.get(course_key=new_key, app_id="discussion") + assert app_status.enabled is False + + def test_course_app_status_updated_for_existing_course(self): + """ + When a CourseAppStatus row already exists (old course), the handler + should update it with the correct enabled value. + """ + CourseAppStatus.objects.create( + course_key=self.course_key, + app_id="discussion", + enabled=True, + ) + config_data = CourseDiscussionConfigurationData( + course_key=self.course_key, + provider_type="openedx", + enabled=False, + ) + update_course_discussion_config(config_data) + app_status = CourseAppStatus.objects.get(course_key=self.course_key, app_id="discussion") + assert app_status.enabled is False diff --git a/openedx/core/djangoapps/discussions/tests/test_models.py b/openedx/core/djangoapps/discussions/tests/test_models.py index efa30a0b48db..ea8f25e3a2a4 100644 --- a/openedx/core/djangoapps/discussions/tests/test_models.py +++ b/openedx/core/djangoapps/discussions/tests/test_models.py @@ -6,18 +6,20 @@ import ddt import pytest - from django.test import TestCase from edx_toggles.toggles.testutils import override_waffle_flag from opaque_keys.edx.keys import CourseKey from organizations.models import Organization from ..config.waffle import ENABLE_NEW_STRUCTURE_DISCUSSIONS -from ..models import DEFAULT_CONFIG_ENABLED, Provider, get_default_provider_type -from ..models import DiscussionsConfiguration -from ..models import ProviderFilter -from ..models import PostingRestriction - +from ..models import ( + DEFAULT_CONFIG_ENABLED, + DiscussionsConfiguration, + PostingRestriction, + Provider, + ProviderFilter, + get_default_provider_type, +) SUPPORTED_PROVIDERS = [ 'legacy', @@ -43,7 +45,7 @@ def setUp(self): self.provider_denied = SUPPORTED_PROVIDERS[1] @patch('openedx.core.djangoapps.discussions.models.get_supported_providers', return_value=SUPPORTED_PROVIDERS) - def test_get_nonexistent(self, _default_providers): + def test_get_nonexistent(self, _default_providers): # noqa: PT019 """ Assert we retrieve defaults when no configuration set """ @@ -51,7 +53,7 @@ def test_get_nonexistent(self, _default_providers): assert len(providers) == len(SUPPORTED_PROVIDERS) @patch('openedx.core.djangoapps.discussions.models.get_supported_providers', return_value=SUPPORTED_PROVIDERS) - def test_get_allow(self, _default_providers): + def test_get_allow(self, _default_providers): # noqa: PT019 """ Assert we can set the allow list """ @@ -64,7 +66,7 @@ def test_get_allow(self, _default_providers): assert len(providers) == 1 @patch('openedx.core.djangoapps.discussions.models.get_supported_providers', return_value=SUPPORTED_PROVIDERS) - def test_get_deny(self, _default_providers): + def test_get_deny(self, _default_providers): # noqa: PT019 """ Assert we can set the deny list """ @@ -76,7 +78,7 @@ def test_get_deny(self, _default_providers): assert self.provider_denied not in providers @patch('openedx.core.djangoapps.discussions.models.get_supported_providers', return_value=SUPPORTED_PROVIDERS) - def test_get_allow_and_deny(self, _default_providers): + def test_get_allow_and_deny(self, _default_providers): # noqa: PT019 """ Assert we can add an item to both allow and deny lists """ @@ -91,7 +93,7 @@ def test_get_allow_and_deny(self, _default_providers): assert self.provider_allowed in providers @patch('openedx.core.djangoapps.discussions.models.get_supported_providers', return_value=SUPPORTED_PROVIDERS) - def test_get_allow_or_deny(self, _default_providers): + def test_get_allow_or_deny(self, _default_providers): # noqa: PT019 """ Assert we can exclusively add an items to both allow and deny lists """ @@ -106,7 +108,7 @@ def test_get_allow_or_deny(self, _default_providers): assert self.provider_allowed in providers @patch('openedx.core.djangoapps.discussions.models.get_supported_providers', return_value=SUPPORTED_PROVIDERS) - def test_override(self, _default_providers): + def test_override(self, _default_providers): # noqa: PT019 """ Assert we can override a configuration and get the latest data """ diff --git a/openedx/core/djangoapps/discussions/tests/test_tasks.py b/openedx/core/djangoapps/discussions/tests/test_tasks.py index 00b715c945e6..f3465eb832f8 100644 --- a/openedx/core/djangoapps/discussions/tests/test_tasks.py +++ b/openedx/core/djangoapps/discussions/tests/test_tasks.py @@ -14,7 +14,7 @@ update_unit_discussion_state_from_discussion_blocks, ) from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase -from xmodule.modulestore.tests.factories import CourseFactory, BlockFactory +from xmodule.modulestore.tests.factories import BlockFactory, CourseFactory class DiscussionConfigUpdateMixin: @@ -184,6 +184,28 @@ def test_custom_discussion_settings(self, settings, context_count, present_units assert present_units <= units_in_config assert not missing_units & units_in_config + @ddt.data( + # (tab_is_hidden, expected_enabled) + (True, False), # import with hidden tab → disabled + (False, True), # import with visible tab → enabled + ) + @ddt.unpack + def test_config_data_enabled_from_discussion_tab(self, tab_is_hidden, expected_enabled): + """ + update_discussions_settings_from_course should set config_data.enabled + based on the discussion tab's is_hidden state. + """ + course = self.store.get_course(self.course.id) + for tab in course.tabs: + if getattr(tab, 'tab_id', None) == 'discussion': + tab['is_hidden'] = tab_is_hidden + break + self.store.update_item(course, self.user.id) + + config_data = update_discussions_settings_from_course(self.course.id) + + assert config_data.enabled is expected_enabled + @ddt.ddt class MigrateUnitDiscussionStateFromXBlockTestCase(ModuleStoreTestCase, DiscussionConfigUpdateMixin): diff --git a/openedx/core/djangoapps/discussions/tests/test_transformer.py b/openedx/core/djangoapps/discussions/tests/test_transformer.py index 3768eb1ea92a..cf0cad623dbd 100644 --- a/openedx/core/djangoapps/discussions/tests/test_transformer.py +++ b/openedx/core/djangoapps/discussions/tests/test_transformer.py @@ -2,16 +2,12 @@ Tests for discussions course block transformer """ -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase -from xmodule.modulestore.tests.factories import CourseFactory, BlockFactory - from lms.djangoapps.course_blocks.api import get_course_blocks from lms.djangoapps.course_blocks.transformers.tests.helpers import TransformerRegistryTestMixin -from openedx.core.djangoapps.discussions.models import ( - DiscussionTopicLink, - get_default_provider_type, -) +from openedx.core.djangoapps.discussions.models import DiscussionTopicLink, get_default_provider_type from openedx.core.djangoapps.discussions.transformers import DiscussionsTopicLinkTransformer +from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase +from xmodule.modulestore.tests.factories import BlockFactory, CourseFactory class DiscussionsTopicLinkTransformerTestCase(TransformerRegistryTestMixin, ModuleStoreTestCase): diff --git a/openedx/core/djangoapps/discussions/tests/test_views.py b/openedx/core/djangoapps/discussions/tests/test_views.py index 64d342480a4b..bb0a275692ef 100644 --- a/openedx/core/djangoapps/discussions/tests/test_views.py +++ b/openedx/core/djangoapps/discussions/tests/test_views.py @@ -23,7 +23,7 @@ from ..config.waffle import ENABLE_NEW_STRUCTURE_DISCUSSIONS from ..models import AVAILABLE_PROVIDER_MAP, DEFAULT_CONFIG_ENABLED, Provider, get_default_provider_type -from ..permissions import IsStaffOrCourseTeam +from ..permissions import HasPagesAndResourcesAccess DATA_LEGACY_COHORTS = { 'divided_inline_discussions': [], @@ -534,7 +534,7 @@ def test_post_legacy_invalid(self, plugin_configuration): 'provider_type': Provider.LEGACY, 'plugin_configuration': plugin_configuration, } - with self.assertRaises(ValidationError): + with self.assertRaises(ValidationError): # noqa: PT027 response = self._post(payload) if status.is_client_error(response.status_code): raise ValidationError(str(response.status_code)) @@ -573,7 +573,7 @@ def test_post_cohorts_invalid(self, key, value): key: value, } } - with self.assertRaises(ValidationError): + with self.assertRaises(ValidationError): # noqa: PT027 response = self._post(payload) if status.is_client_error(response.status_code): raise ValidationError(str(response.status_code)) @@ -641,7 +641,7 @@ def test_unable_to_change_provider_for_running_course(self, user_type): """ Ensure that certain users cannot change provider for a running course. """ - self.course.start = datetime.now(timezone.utc) - timedelta(days=5) + self.course.start = datetime.now(timezone.utc) - timedelta(days=5) # noqa: UP017 self.course = self.update_course(self.course, self.user.id) # use the global staff user to do the initial config @@ -664,7 +664,7 @@ def test_global_staff_can_change_provider_for_running_course(self): """ Ensure that global staff can change provider for a running course. """ - self.course.start = datetime.now(timezone.utc) - timedelta(days=5) + self.course.start = datetime.now(timezone.utc) - timedelta(days=5) # noqa: UP017 self.course = self.update_course(self.course, self.user.id) # use the global staff user to do the initial config @@ -864,12 +864,12 @@ def setUp(self): self.url = reverse('sync-discussion-topics', kwargs={'course_key_string': self.course_key_string}) # Mock the permission class for course team checking - self.original_has_permission = IsStaffOrCourseTeam.has_permission - IsStaffOrCourseTeam.has_permission = Mock(return_value=True) + self.original_has_permission = HasPagesAndResourcesAccess.has_permission + HasPagesAndResourcesAccess.has_permission = Mock(return_value=True) def tearDown(self): # Restore original permission method - IsStaffOrCourseTeam.has_permission = self.original_has_permission + HasPagesAndResourcesAccess.has_permission = self.original_has_permission super().tearDown() @patch('openedx.core.djangoapps.discussions.views.update_discussions_settings_from_course_task') @@ -880,8 +880,8 @@ def test_sync_discussion_topics_staff_user(self, mock_update): self.client.force_authenticate(user=self.staff_user) response = self.client.post(self.url) - self.assertEqual(response.status_code, status.HTTP_200_OK) - self.assertEqual(response.data['status'], 'success') + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 + self.assertEqual(response.data['status'], 'success') # noqa: PT009 mock_update.assert_called_once_with(self.course_key_string) @patch('openedx.core.djangoapps.discussions.views.update_discussions_settings_from_course_task') @@ -892,12 +892,12 @@ def test_sync_discussion_topics_course_team(self, mock_update): self.client.force_authenticate(user=self.instructor_user) # Mock the course team permission check - IsStaffOrCourseTeam.has_permission = Mock(return_value=True) + HasPagesAndResourcesAccess.has_permission = Mock(return_value=True) response = self.client.post(self.url) - self.assertEqual(response.status_code, status.HTTP_200_OK) - self.assertEqual(response.data['status'], 'success') + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 + self.assertEqual(response.data['status'], 'success') # noqa: PT009 mock_update.assert_called_once() def test_sync_discussion_topics_unauthorized(self): @@ -907,7 +907,7 @@ def test_sync_discussion_topics_unauthorized(self): # Don't authenticate the request response = self.client.post(self.url) - self.assertEqual(response.status_code, status.HTTP_401_UNAUTHORIZED) + self.assertEqual(response.status_code, status.HTTP_401_UNAUTHORIZED) # noqa: PT009 def test_sync_discussion_topics_forbidden(self): """ @@ -916,11 +916,11 @@ def test_sync_discussion_topics_forbidden(self): self.client.force_authenticate(user=self.student_user) # Mock the course team permission check to return False - IsStaffOrCourseTeam.has_permission = Mock(return_value=False) + HasPagesAndResourcesAccess.has_permission = Mock(return_value=False) response = self.client.post(self.url) - self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN) + self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN) # noqa: PT009 def test_invalid_http_method(self): """ @@ -929,4 +929,4 @@ def test_invalid_http_method(self): self.client.force_authenticate(user=self.staff_user) response = self.client.get(self.url) - self.assertEqual(response.status_code, status.HTTP_405_METHOD_NOT_ALLOWED) + self.assertEqual(response.status_code, status.HTTP_405_METHOD_NOT_ALLOWED) # noqa: PT009 diff --git a/openedx/core/djangoapps/discussions/tests/test_views_permissions.py b/openedx/core/djangoapps/discussions/tests/test_views_permissions.py new file mode 100644 index 000000000000..a1c1154fab58 --- /dev/null +++ b/openedx/core/djangoapps/discussions/tests/test_views_permissions.py @@ -0,0 +1,93 @@ +""" +Integration tests verifying authz permissions for discussions views. +""" +from django.urls import reverse +from openedx_authz.constants.roles import COURSE_AUDITOR, COURSE_LIMITED_STAFF, COURSE_STAFF +from rest_framework.test import APIClient + +from common.djangoapps.student.tests.factories import UserFactory +from openedx.core.djangoapps.authz.tests.mixins import CourseAuthoringAuthzTestMixin +from xmodule.modulestore import ModuleStoreEnum +from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase +from xmodule.modulestore.tests.factories import CourseFactory + + +class DiscussionsAuthzTest(CourseAuthoringAuthzTestMixin, ModuleStoreTestCase): + """ + Integration tests for discussions views authz permissions. + """ + + def setUp(self): + super().setUp() + self.course = CourseFactory.create(default_store=ModuleStoreEnum.Type.split) + self.settings_url = reverse( + 'discussions-settings', + kwargs={'course_key_string': str(self.course.id)}, + ) + self.providers_url = reverse( + 'discussions-providers', + kwargs={'course_key_string': str(self.course.id)}, + ) + + # --- GET settings - requires courses.view_pages_and_resources --- + + def test_staff_can_get_settings(self): + self.add_user_to_role_in_course(self.authorized_user, COURSE_STAFF.external_key, self.course.id) + resp = self.authorized_client.get(self.settings_url) + assert resp.status_code == 200 + + def test_auditor_can_get_settings(self): + self.add_user_to_role_in_course(self.authorized_user, COURSE_AUDITOR.external_key, self.course.id) + resp = self.authorized_client.get(self.settings_url) + assert resp.status_code == 200 + + def test_limited_staff_cannot_get_settings(self): + self.add_user_to_role_in_course(self.authorized_user, COURSE_LIMITED_STAFF.external_key, self.course.id) + resp = self.authorized_client.get(self.settings_url) + assert resp.status_code == 403 + + def test_unauthorized_cannot_get_settings(self): + resp = self.unauthorized_client.get(self.settings_url) + assert resp.status_code == 403 + + # --- POST settings - requires courses.manage_pages_and_resources --- + + def test_staff_can_post_settings(self): + """Asserts not-403 rather than 200 because the empty payload may fail validation.""" + self.add_user_to_role_in_course(self.authorized_user, COURSE_STAFF.external_key, self.course.id) + resp = self.authorized_client.post(self.settings_url, data={}, format='json') + assert resp.status_code != 403 + + def test_auditor_cannot_post_settings(self): + self.add_user_to_role_in_course(self.authorized_user, COURSE_AUDITOR.external_key, self.course.id) + resp = self.authorized_client.post(self.settings_url, data={}, format='json') + assert resp.status_code == 403 + + def test_unauthorized_cannot_post_settings(self): + resp = self.unauthorized_client.post(self.settings_url, data={}, format='json') + assert resp.status_code == 403 + + # --- GET providers - requires courses.view_pages_and_resources --- + + def test_staff_can_get_providers(self): + self.add_user_to_role_in_course(self.authorized_user, COURSE_STAFF.external_key, self.course.id) + resp = self.authorized_client.get(self.providers_url) + assert resp.status_code == 200 + + def test_auditor_can_get_providers(self): + self.add_user_to_role_in_course(self.authorized_user, COURSE_AUDITOR.external_key, self.course.id) + resp = self.authorized_client.get(self.providers_url) + assert resp.status_code == 200 + + def test_unauthorized_cannot_get_providers(self): + resp = self.unauthorized_client.get(self.providers_url) + assert resp.status_code == 403 + + # --- Superuser bypass --- + + def test_superuser_can_get_settings(self): + superuser = UserFactory(is_superuser=True) + client = APIClient() + client.force_authenticate(user=superuser) + resp = client.get(self.settings_url) + assert resp.status_code == 200 diff --git a/openedx/core/djangoapps/discussions/transformers.py b/openedx/core/djangoapps/discussions/transformers.py index 8fcf78bc1f98..89916c38834e 100644 --- a/openedx/core/djangoapps/discussions/transformers.py +++ b/openedx/core/djangoapps/discussions/transformers.py @@ -3,7 +3,7 @@ """ from openedx.core.djangoapps.content.block_structure.transformer import BlockStructureTransformer -from openedx.core.djangoapps.discussions.models import DiscussionTopicLink, DiscussionsConfiguration +from openedx.core.djangoapps.discussions.models import DiscussionsConfiguration, DiscussionTopicLink from openedx.core.djangoapps.discussions.url_helpers import get_discussions_mfe_topic_url @@ -19,8 +19,8 @@ class DiscussionsTopicLinkTransformer(BlockStructureTransformer): @classmethod def name(cls): """ - Unique identifier for the transformer's class; - same identifier used in setup.py. + Unique identifier for the transformer's class. + This must match the entry point name in the package configuration. """ return "discussions_link" diff --git a/openedx/core/djangoapps/discussions/url_helpers.py b/openedx/core/djangoapps/discussions/url_helpers.py index 60b29d919762..d36e30bc6e03 100644 --- a/openedx/core/djangoapps/discussions/url_helpers.py +++ b/openedx/core/djangoapps/discussions/url_helpers.py @@ -8,7 +8,7 @@ from opaque_keys.edx.keys import CourseKey -def _get_url_with_view_query_params(path: str, view: Optional[str] = None) -> str: +def _get_url_with_view_query_params(path: str, view: Optional[str] = None) -> str: # noqa: UP045 """ Helper function to build url if a url is configured @@ -34,7 +34,7 @@ def _get_url_with_view_query_params(path: str, view: Optional[str] = None) -> st return url -def get_discussions_mfe_url(course_key: CourseKey, view: Optional[str] = None) -> str: +def get_discussions_mfe_url(course_key: CourseKey, view: Optional[str] = None) -> str: # noqa: UP045 """ Returns the url for discussions for the specified course in the discussions MFE. @@ -48,7 +48,7 @@ def get_discussions_mfe_url(course_key: CourseKey, view: Optional[str] = None) - return _get_url_with_view_query_params(f"{course_key}/", view) -def get_discussions_mfe_topic_url(course_key: CourseKey, topic_id: str, view: Optional[str] = None) -> str: +def get_discussions_mfe_topic_url(course_key: CourseKey, topic_id: str, view: Optional[str] = None) -> str: # noqa: UP045 # pylint: disable=line-too-long """ Returns the url for discussions for the specified course and topic in the discussions MFE. diff --git a/openedx/core/djangoapps/discussions/urls.py b/openedx/core/djangoapps/discussions/urls.py index 6b70ca5f984b..f994fa1c91a4 100644 --- a/openedx/core/djangoapps/discussions/urls.py +++ b/openedx/core/djangoapps/discussions/urls.py @@ -8,7 +8,7 @@ CombinedDiscussionsConfigurationView, DiscussionsConfigurationSettingsView, DiscussionsProvidersView, - SyncDiscussionTopicsView + SyncDiscussionTopicsView, ) urlpatterns = [ diff --git a/openedx/core/djangoapps/discussions/utils.py b/openedx/core/djangoapps/discussions/utils.py index 7c26a4e482e6..99b0f06a63e4 100644 --- a/openedx/core/djangoapps/discussions/utils.py +++ b/openedx/core/djangoapps/discussions/utils.py @@ -2,7 +2,7 @@ Shared utility code related to discussions. """ import logging -from typing import Dict, List, Optional, Tuple +from typing import Dict, List, Optional, Tuple # noqa: UP035 from opaque_keys.edx.keys import CourseKey @@ -11,12 +11,15 @@ from openedx.core.djangoapps.django_comment_common.models import CourseDiscussionSettings from openedx.core.lib.cache_utils import request_cached from openedx.core.lib.courses import get_course_by_id -from xmodule.discussion_block import DiscussionXBlock from openedx.core.types import User -from xmodule.course_block import CourseBlock # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.partitions.partitions import ENROLLMENT_TRACK_PARTITION_ID, Group # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.partitions.partitions_service import PartitionService # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.course_block import CourseBlock # pylint: disable=wrong-import-order +from xmodule.discussion_block import DiscussionXBlock +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order +from xmodule.partitions.partitions import ( # pylint: disable=wrong-import-order + ENROLLMENT_TRACK_PARTITION_ID, + Group, +) +from xmodule.partitions.partitions_service import PartitionService # pylint: disable=wrong-import-order log = logging.getLogger(__name__) @@ -24,7 +27,7 @@ def get_divided_discussions( course: CourseBlock, discussion_settings: CourseDiscussionSettings, -) -> Tuple[List[str], List[str]]: +) -> Tuple[List[str], List[str]]: # noqa: UP006 """ Returns the course-wide and inline divided discussion ids separately. """ @@ -43,7 +46,7 @@ def get_divided_discussions( return divided_course_wide_discussions, divided_inline_discussions -def get_discussion_categories_ids(course: CourseBlock, user: Optional[User], include_all: bool = False) -> List[str]: +def get_discussion_categories_ids(course: CourseBlock, user: Optional[User], include_all: bool = False) -> List[str]: # noqa: UP006, UP045 # pylint: disable=line-too-long """ Returns a list of available ids of categories for the course that are accessible to the given user. @@ -62,9 +65,9 @@ def get_discussion_categories_ids(course: CourseBlock, user: Optional[User], inc def get_accessible_discussion_xblocks( course: CourseBlock, - user: Optional[User], + user: Optional[User], # noqa: UP045 include_all: bool = False, -) -> List[DiscussionXBlock]: +) -> List[DiscussionXBlock]: # noqa: UP006 """ Return a list of all valid discussion xblocks in this course that are accessible to the given user. @@ -76,9 +79,9 @@ def get_accessible_discussion_xblocks( @request_cached() def get_accessible_discussion_xblocks_by_course_id( course_id: CourseKey, - user: Optional[User] = None, + user: Optional[User] = None, # noqa: UP045 include_all: bool = False -) -> List[DiscussionXBlock]: +) -> List[DiscussionXBlock]: # noqa: UP006 """ Return a list of all valid discussion xblocks in this course. Checks for the given user's access if include_all is False. @@ -91,7 +94,7 @@ def get_accessible_discussion_xblocks_by_course_id( ] -def available_division_schemes(course_key: CourseKey) -> List[str]: +def available_division_schemes(course_key: CourseKey) -> List[str]: # noqa: UP006 """ Returns a list of possible discussion division schemes for this course. This takes into account if cohorts are enabled and if there are multiple @@ -136,7 +139,7 @@ def enrollment_track_group_count(course_key: CourseKey) -> int: return len(_get_enrollment_track_groups(course_key)) -def _get_enrollment_track_groups(course_key: CourseKey) -> List[Group]: +def _get_enrollment_track_groups(course_key: CourseKey) -> List[Group]: # noqa: UP006 """ Helper method that returns an array of the Groups in the EnrollmentTrackUserPartition for the given course. If no such partition exists on the course, an empty array is returned. @@ -146,7 +149,7 @@ def _get_enrollment_track_groups(course_key: CourseKey) -> List[Group]: return partition.groups if partition else [] -def get_group_names_by_id(course_discussion_settings: CourseDiscussionSettings) -> Dict[str, str]: +def get_group_names_by_id(course_discussion_settings: CourseDiscussionSettings) -> Dict[str, str]: # noqa: UP006 """ Creates of a dict of group_id to learner-facing group names, for the division_scheme in use as specified by course_discussion_settings. diff --git a/openedx/core/djangoapps/discussions/views.py b/openedx/core/djangoapps/discussions/views.py index b74d88ca038f..cafa78415aef 100644 --- a/openedx/core/djangoapps/discussions/views.py +++ b/openedx/core/djangoapps/discussions/views.py @@ -1,7 +1,7 @@ """ Handle view-logic for the discussions app. """ -from typing import Dict +from typing import Dict # noqa: UP035 import edx_api_doc_tools as apidocs from edx_rest_framework_extensions.auth.jwt.authentication import JwtAuthentication @@ -18,7 +18,7 @@ from .config.waffle import ENABLE_NEW_STRUCTURE_DISCUSSIONS from .models import AVAILABLE_PROVIDER_MAP, DiscussionsConfiguration, Features, Provider -from .permissions import IsStaffOrCourseTeam, check_course_permissions +from .permissions import HasPagesAndResourcesAccess, check_course_permissions from .serializers import DiscussionsConfigurationSerializer, DiscussionsProvidersSerializer from .tasks import update_discussions_settings_from_course_task @@ -32,7 +32,7 @@ class DiscussionsConfigurationSettingsView(APIView): BearerAuthenticationAllowInactiveUser, SessionAuthenticationAllowInactiveUser ) - permission_classes = (IsStaffOrCourseTeam,) + permission_classes = (HasPagesAndResourcesAccess,) @apidocs.schema( parameters=[ @@ -63,7 +63,7 @@ def get(self, request: Request, course_key_string: str, **_kwargs) -> Response: return Response(data) @staticmethod - def get_configuration_data(request: Request, course_key_string: str) -> Dict: + def get_configuration_data(request: Request, course_key_string: str) -> Dict: # noqa: UP006 """ Get discussions configuration data for the course Args: @@ -134,7 +134,7 @@ class DiscussionsProvidersView(APIView): BearerAuthenticationAllowInactiveUser, SessionAuthenticationAllowInactiveUser ) - permission_classes = (IsStaffOrCourseTeam,) + permission_classes = (HasPagesAndResourcesAccess,) @apidocs.schema( parameters=[ @@ -160,7 +160,7 @@ def get(self, request, course_key_string: str, **_kwargs) -> Response: return Response(data) @staticmethod - def get_provider_data(course_key_string: str, show_all: bool = False) -> Dict: + def get_provider_data(course_key_string: str, show_all: bool = False) -> Dict: # noqa: UP006 """ Get provider data for specified course Args: @@ -258,7 +258,7 @@ class SyncDiscussionTopicsView(APIView): View for syncing discussion topics for a course. """ authentication_classes = (BearerAuthenticationAllowInactiveUser, SessionAuthenticationAllowInactiveUser) - permission_classes = (IsAuthenticated, IsStaffOrCourseTeam) + permission_classes = (IsAuthenticated, HasPagesAndResourcesAccess) def post(self, request, course_key_string): """ diff --git a/openedx/core/djangoapps/django_comment_common/README.rst b/openedx/core/djangoapps/django_comment_common/README.rst index 80e956823280..e87803224d16 100644 --- a/openedx/core/djangoapps/django_comment_common/README.rst +++ b/openedx/core/djangoapps/django_comment_common/README.rst @@ -1 +1,4 @@ +Django Comment Common +===================== + See ``lms/djangoapps/discussion/README.rst`` diff --git a/openedx/core/djangoapps/django_comment_common/comment_client/README.rst b/openedx/core/djangoapps/django_comment_common/comment_client/README.rst index 80e956823280..6e99a7de8cd5 100644 --- a/openedx/core/djangoapps/django_comment_common/comment_client/README.rst +++ b/openedx/core/djangoapps/django_comment_common/comment_client/README.rst @@ -1 +1,4 @@ +Comment Client +============== + See ``lms/djangoapps/discussion/README.rst`` diff --git a/openedx/core/djangoapps/django_comment_common/comment_client/__init__.py b/openedx/core/djangoapps/django_comment_common/comment_client/__init__.py index 3f856f063d74..95f3eae4e429 100644 --- a/openedx/core/djangoapps/django_comment_common/comment_client/__init__.py +++ b/openedx/core/djangoapps/django_comment_common/comment_client/__init__.py @@ -1,3 +1,8 @@ # pylint: disable=missing-docstring,wildcard-import -from .comment_client import * -from .utils import CommentClient500Error, CommentClientError, CommentClientMaintenanceError, CommentClientRequestError +from .comment_client import * # noqa: F403 +from .utils import ( # noqa: F401 + CommentClient500Error, + CommentClientError, + CommentClientMaintenanceError, + CommentClientRequestError, +) diff --git a/openedx/core/djangoapps/django_comment_common/comment_client/comment.py b/openedx/core/djangoapps/django_comment_common/comment_client/comment.py index 2d1c53f62b4a..bd74b895113b 100644 --- a/openedx/core/djangoapps/django_comment_common/comment_client/comment.py +++ b/openedx/core/djangoapps/django_comment_common/comment_client/comment.py @@ -1,16 +1,13 @@ # pylint: disable=missing-docstring,protected-access import logging -import time from bs4 import BeautifulSoup +from forum import api as forum_api from openedx.core.djangoapps.django_comment_common.comment_client import models, settings from .thread import Thread from .utils import CommentClientRequestError, get_course_key -from forum import api as forum_api -from forum.backends.mongodb.comments import Comment as ForumComment - log = logging.getLogger(__name__) @@ -130,43 +127,6 @@ def retrieve_all(cls, params=None): per_page=params.get('per_page', 10), ) - @classmethod - def get_user_comment_count(cls, user_id, course_ids): - """ - Returns comments and responses count of user in the given course_ids. - TODO: Add support for MySQL backend as well - """ - query_params = { - "course_id": {"$in": course_ids}, - "author_id": str(user_id), - "_type": "Comment" - } - return ForumComment()._collection.count_documents(query_params) # pylint: disable=protected-access - - @classmethod - def delete_user_comments(cls, user_id, course_ids): - """ - Deletes comments and responses of user in the given course_ids. - TODO: Add support for MySQL backend as well - """ - start_time = time.time() - query_params = { - "course_id": {"$in": course_ids}, - "author_id": str(user_id), - } - comments_deleted = 0 - comments = ForumComment().get_list(**query_params) - log.info(f"<> Fetched comments for user {user_id} in {time.time() - start_time} seconds") - for comment in comments: - start_time = time.time() - comment_id = comment.get("_id") - course_id = comment.get("course_id") - if comment_id: - forum_api.delete_comment(comment_id, course_id=course_id) - comments_deleted += 1 - log.info(f"<> Deleted comment {comment_id} in {time.time() - start_time} seconds." - f" Comment Found: {comment_id is not None}") - return comments_deleted def _url_for_thread_comments(thread_id): diff --git a/openedx/core/djangoapps/django_comment_common/comment_client/comment_client.py b/openedx/core/djangoapps/django_comment_common/comment_client/comment_client.py index bfd7b687f45f..0011228cbe76 100644 --- a/openedx/core/djangoapps/django_comment_common/comment_client/comment_client.py +++ b/openedx/core/djangoapps/django_comment_common/comment_client/comment_client.py @@ -1,6 +1,6 @@ """Import other classes here so they can be imported from here.""" # pylint: disable=unused-import -from .comment import Comment -from .commentable import Commentable -from .thread import Thread -from .user import User +from .comment import Comment # noqa: F401 +from .commentable import Commentable # noqa: F401 +from .thread import Thread # noqa: F401 +from .user import User # noqa: F401 diff --git a/openedx/core/djangoapps/django_comment_common/comment_client/course.py b/openedx/core/djangoapps/django_comment_common/comment_client/course.py index 1dad0ca159aa..2f7309ab592e 100644 --- a/openedx/core/djangoapps/django_comment_common/comment_client/course.py +++ b/openedx/core/djangoapps/django_comment_common/comment_client/course.py @@ -2,15 +2,14 @@ """Provides base Commentable model class""" from __future__ import annotations -from typing import Dict, Optional +from typing import Dict, Optional # noqa: UP035 from edx_django_utils.monitoring import function_trace -from opaque_keys.edx.keys import CourseKey - from forum import api as forum_api +from opaque_keys.edx.keys import CourseKey -def get_course_commentable_counts(course_key: CourseKey) -> Dict[str, Dict[str, int]]: +def get_course_commentable_counts(course_key: CourseKey) -> Dict[str, Dict[str, int]]: # noqa: UP006 """ Get stats about the count of different types of threads for each commentable (topic). @@ -33,7 +32,7 @@ def get_course_commentable_counts(course_key: CourseKey) -> Dict[str, Dict[str, @function_trace("get_course_user_stats") -def get_course_user_stats(course_key: CourseKey, params: Optional[Dict] = None) -> Dict[str, Dict[str, int]]: +def get_course_user_stats(course_key: CourseKey, params: Optional[Dict] = None) -> Dict[str, Dict[str, int]]: # noqa: UP006, UP045 # pylint: disable=line-too-long """ Get stats about a user's participation in a course. @@ -71,7 +70,7 @@ def get_course_user_stats(course_key: CourseKey, params: Optional[Dict] = None) @function_trace("update_course_users_stats") -def update_course_users_stats(course_key: CourseKey) -> Dict: +def update_course_users_stats(course_key: CourseKey) -> Dict: # noqa: UP006 """ Update the user stats for all users for a particular course. diff --git a/openedx/core/djangoapps/django_comment_common/comment_client/models.py b/openedx/core/djangoapps/django_comment_common/comment_client/models.py index e788ac5e9ea0..5ca2464d83ce 100644 --- a/openedx/core/djangoapps/django_comment_common/comment_client/models.py +++ b/openedx/core/djangoapps/django_comment_common/comment_client/models.py @@ -3,9 +3,10 @@ import logging -from .utils import CommentClientRequestError, extract, get_course_key from forum import api as forum_api +from .utils import CommentClientRequestError, extract, get_course_key + log = logging.getLogger(__name__) @@ -33,7 +34,7 @@ def __getattr__(self, name): return self.attributes[name] except KeyError: if self.retrieved or self.id is None: - raise AttributeError(f"Field {name} does not exist") # lint-amnesty, pylint: disable=raise-missing-from + raise AttributeError(f"Field {name} does not exist") # pylint: disable=raise-missing-from # noqa: B904 self.retrieve() return self.__getattr__(name) @@ -107,7 +108,7 @@ def _update_from_response(self, response_data): setattr(self, k, v) else: log.warning( - "Unexpected field {field_name} in model {model_name}".format( + "Unexpected field {field_name} in model {model_name}".format( # noqa: UP032 field_name=k, model_name=self.__class__.__name__ ) @@ -168,7 +169,7 @@ def url(cls, action, params=None): params = {} if cls.base_url is None: raise CommentClientRequestError("Must provide base_url when using default url function") - if action not in cls.DEFAULT_ACTIONS: # lint-amnesty, pylint: disable=no-else-raise + if action not in cls.DEFAULT_ACTIONS: # pylint: disable=no-else-raise raise ValueError( f"Invalid action {action}. The supported action must be in {str(cls.DEFAULT_ACTIONS)}" ) @@ -176,7 +177,7 @@ def url(cls, action, params=None): try: return cls.url_with_id(params) except KeyError: - raise CommentClientRequestError(f"Cannot perform action {action} without id") # lint-amnesty, pylint: disable=raise-missing-from + raise CommentClientRequestError(f"Cannot perform action {action} without id") # pylint: disable=raise-missing-from # noqa: B904 else: # action must be in DEFAULT_ACTIONS_WITHOUT_ID now return cls.url_without_id() diff --git a/openedx/core/djangoapps/django_comment_common/comment_client/settings.py b/openedx/core/djangoapps/django_comment_common/comment_client/settings.py index 075aba03ede0..4bbb42045087 100644 --- a/openedx/core/djangoapps/django_comment_common/comment_client/settings.py +++ b/openedx/core/djangoapps/django_comment_common/comment_client/settings.py @@ -1,4 +1,4 @@ -# lint-amnesty, pylint: disable=cyclic-import, missing-module-docstring +# pylint: disable=cyclic-import, missing-module-docstring from django.conf import settings if hasattr(settings, "COMMENTS_SERVICE_URL"): diff --git a/openedx/core/djangoapps/django_comment_common/comment_client/subscriptions.py b/openedx/core/djangoapps/django_comment_common/comment_client/subscriptions.py index a2e8ff8c2b2b..e3b46a6d5051 100644 --- a/openedx/core/djangoapps/django_comment_common/comment_client/subscriptions.py +++ b/openedx/core/djangoapps/django_comment_common/comment_client/subscriptions.py @@ -3,10 +3,11 @@ """ import logging -from . import models, settings, utils from forum import api as forum_api from forum.backend import get_backend +from . import models, settings, utils + log = logging.getLogger(__name__) diff --git a/openedx/core/djangoapps/django_comment_common/comment_client/thread.py b/openedx/core/djangoapps/django_comment_common/comment_client/thread.py index ffb9147acab4..516fc59e03ec 100644 --- a/openedx/core/djangoapps/django_comment_common/comment_client/thread.py +++ b/openedx/core/djangoapps/django_comment_common/comment_client/thread.py @@ -2,16 +2,12 @@ import logging -import time from eventtracking import tracker - from forum import api as forum_api -from forum.backends.mongodb.threads import CommentThread as ForumThread from . import models, settings, utils - log = logging.getLogger(__name__) @@ -102,7 +98,7 @@ def search(cls, query_params): } ) log.info( - 'forum_text_search query="{search_query}" corrected_text="{corrected_text}" course_id={course_id} ' + 'forum_text_search query="{search_query}" corrected_text="{corrected_text}" course_id={course_id} ' # noqa: UP032 # pylint: disable=line-too-long 'group_id={group_id} page={requested_page} total_results={total_results}'.format( search_query=search_query, corrected_text=corrected_text, @@ -218,43 +214,6 @@ def un_pin(self, user, thread_id, course_id=None): ) self._update_from_response(response) - @classmethod - def get_user_threads_count(cls, user_id, course_ids): - """ - Returns threads count of user in the given course_ids. - TODO: Add support for MySQL backend as well - """ - query_params = { - "course_id": {"$in": course_ids}, - "author_id": str(user_id), - "_type": "CommentThread" - } - return ForumThread()._collection.count_documents(query_params) # pylint: disable=protected-access - - @classmethod - def delete_user_threads(cls, user_id, course_ids): - """ - Deletes threads of user in the given course_ids. - TODO: Add support for MySQL backend as well - """ - start_time = time.time() - query_params = { - "course_id": {"$in": course_ids}, - "author_id": str(user_id), - } - threads_deleted = 0 - threads = ForumThread().get_list(**query_params) - log.info(f"<> Fetched threads for user {user_id} in {time.time() - start_time} seconds") - for thread in threads: - start_time = time.time() - thread_id = thread.get("_id") - course_id = thread.get("course_id") - if thread_id: - forum_api.delete_thread(thread_id, course_id=course_id) - threads_deleted += 1 - log.info(f"<> Deleted thread {thread_id} in {time.time() - start_time} seconds." - f" Thread Found: {thread_id is not None}") - return threads_deleted def _clean_forum_params(params): diff --git a/openedx/core/djangoapps/django_comment_common/comment_client/user.py b/openedx/core/djangoapps/django_comment_common/comment_client/user.py index bd208545ce56..2e9c86469aca 100644 --- a/openedx/core/djangoapps/django_comment_common/comment_client/user.py +++ b/openedx/core/djangoapps/django_comment_common/comment_client/user.py @@ -1,10 +1,11 @@ # pylint: disable=missing-docstring,protected-access """ User model wrapper for comment service""" -from . import models, settings, utils from forum import api as forum_api from forum.utils import ForumV2RequestError, str_to_bool +from . import models, settings, utils + class User(models.Model): @@ -36,7 +37,7 @@ def read(self, source): Calls forum service to mark thread as read for the user """ course_id = self.attributes.get("course_id") - course_key = utils.get_course_key(course_id) + course_key = utils.get_course_key(course_id) # noqa: F841 forum_api.mark_thread_as_read(self.id, source.id, course_id=str(course_id)) def follow(self, source, course_id=None): @@ -170,7 +171,7 @@ def _retrieve(self, *args, **kwargs): }) try: response = forum_api.get_user(**params) - except ForumV2RequestError as e: + except ForumV2RequestError as e: # noqa: F841 self.save({"course_id": course_id}) response = forum_api.get_user(**params) self._update_from_response(response) diff --git a/openedx/core/djangoapps/django_comment_common/comment_client/utils.py b/openedx/core/djangoapps/django_comment_common/comment_client/utils.py index ccdced767e00..8a38ba20923c 100644 --- a/openedx/core/djangoapps/django_comment_common/comment_client/utils.py +++ b/openedx/core/djangoapps/django_comment_common/comment_client/utils.py @@ -4,20 +4,20 @@ import logging -import requests # pylint: disable=unused-import +import requests # pylint: disable=unused-import # noqa: F401 from opaque_keys.edx.keys import CourseKey log = logging.getLogger(__name__) def strip_none(dic): - return {k: v for k, v in dic.items() if v is not None} # lint-amnesty, pylint: disable=consider-using-dict-comprehension + return {k: v for k, v in dic.items() if v is not None} # pylint: disable=consider-using-dict-comprehension def strip_blank(dic): def _is_blank(v): return isinstance(v, str) and len(v.strip()) == 0 - return {k: v for k, v in dic.items() if not _is_blank(v)} # lint-amnesty, pylint: disable=consider-using-dict-comprehension + return {k: v for k, v in dic.items() if not _is_blank(v)} # pylint: disable=consider-using-dict-comprehension def extract(dic, keys): diff --git a/openedx/core/djangoapps/django_comment_common/migrations/0006_coursediscussionsettings_discussions_id_map.py b/openedx/core/djangoapps/django_comment_common/migrations/0006_coursediscussionsettings_discussions_id_map.py index bc30ad314f12..c83d72455102 100644 --- a/openedx/core/djangoapps/django_comment_common/migrations/0006_coursediscussionsettings_discussions_id_map.py +++ b/openedx/core/djangoapps/django_comment_common/migrations/0006_coursediscussionsettings_discussions_id_map.py @@ -1,8 +1,8 @@ # Generated by Django 1.11.12 on 2018-04-23 21:09 -from django.db import migrations import jsonfield.fields +from django.db import migrations class Migration(migrations.Migration): diff --git a/openedx/core/djangoapps/django_comment_common/migrations/0007_discussionsidmapping.py b/openedx/core/djangoapps/django_comment_common/migrations/0007_discussionsidmapping.py index ba396e025c15..a32c1c703469 100644 --- a/openedx/core/djangoapps/django_comment_common/migrations/0007_discussionsidmapping.py +++ b/openedx/core/djangoapps/django_comment_common/migrations/0007_discussionsidmapping.py @@ -1,9 +1,9 @@ # Generated by Django 1.11.13 on 2018-06-13 12:10 -from django.db import migrations import jsonfield.fields import opaque_keys.edx.django.models +from django.db import migrations class Migration(migrations.Migration): diff --git a/openedx/core/djangoapps/django_comment_common/models.py b/openedx/core/djangoapps/django_comment_common/models.py index bd7b8fe66e67..887e40ef8f4e 100644 --- a/openedx/core/djangoapps/django_comment_common/models.py +++ b/openedx/core/djangoapps/django_comment_common/models.py @@ -6,21 +6,22 @@ from config_models.models import ConfigurationModel from django.conf import settings -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.db import models from django.db.models.signals import post_save from django.dispatch import receiver - from django.utils.translation import gettext_noop +from edx_django_utils.cache import DEFAULT_REQUEST_CACHE from jsonfield.fields import JSONField from opaque_keys.edx.django.models import CourseKeyField +from opaque_keys.edx.keys import CourseKey -from openedx.core.djangoapps.xmodule_django.models import NoneToEmptyManager -from openedx.core.lib.cache_utils import request_cached from common.djangoapps.student.models import CourseEnrollment from common.djangoapps.student.roles import GlobalStaff -from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.exceptions import ItemNotFoundError # lint-amnesty, pylint: disable=wrong-import-order +from openedx.core.djangoapps.xmodule_django.models import NoneToEmptyManager +from openedx.core.lib.cache_utils import request_cached +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order +from xmodule.modulestore.exceptions import ItemNotFoundError # pylint: disable=wrong-import-order FORUM_ROLE_ADMINISTRATOR = gettext_noop('Administrator') FORUM_ROLE_MODERATOR = gettext_noop('Moderator') @@ -77,7 +78,7 @@ class Role(models.Model): objects = NoneToEmptyManager() - name = models.CharField(max_length=30, null=False, blank=False) + name = models.CharField(max_length=30, null=False, blank=False) # noqa: DJ012 users = models.ManyToManyField(User, related_name="roles") course_id = CourseKeyField(max_length=255, blank=True, db_index=True) @@ -105,7 +106,7 @@ def inherit_permissions(self, role): self.add_permission(per) def add_permission(self, permission): - self.permissions.add(Permission.objects.get_or_create(name=permission)[0]) # lint-amnesty, pylint: disable=no-member + self.permissions.add(Permission.objects.get_or_create(name=permission)[0]) # pylint: disable=no-member def has_permission(self, permission): """ @@ -193,6 +194,37 @@ def all_permissions_for_user_in_course(user, course_id): return permission_names +def has_permission(user, permission, course_id=None): + """ + This function resolves all discussion-related permissions for the given + user and course, caches them for the duration of the request, and verifies + whether the requested permission is present. + + Args: + user (User): Django user whose permissions are being checked. + permission (str): Discussion permission identifier + (e.g., "create_comment", "create_thread"). + course_id (CourseKey): Course context in which to evaluate + the permission + + Returns: + bool: True if the user has the specified permission in the given + course context; False otherwise. + """ + assert isinstance(course_id, (type(None), CourseKey)) + request_cache_dict = DEFAULT_REQUEST_CACHE.data + cache_key = "django_comment_client.permissions.has_permission.all_permissions.{}.{}".format( # noqa: UP032 + user.id, course_id + ) + if cache_key in request_cache_dict: + all_permissions = request_cache_dict[cache_key] + else: + all_permissions = all_permissions_for_user_in_course(user, course_id) + request_cache_dict[cache_key] = all_permissions + + return permission in all_permissions + + class ForumsConfig(ConfigurationModel): """ Config for the connection to the cs_comments_service forums backend. @@ -221,7 +253,7 @@ def __str__(self): return f"ForumsConfig: timeout={self.connection_timeout}" -class CourseDiscussionSettings(models.Model): +class CourseDiscussionSettings(models.Model): # noqa: DJ008 """ Settings for course discussions @@ -240,7 +272,7 @@ class CourseDiscussionSettings(models.Model): ) always_divide_inline_discussions = models.BooleanField(default=False) reported_content_email_notifications = models.BooleanField(default=False) - _divided_discussions = models.TextField(db_column='divided_discussions', null=True, blank=True) # JSON list + _divided_discussions = models.TextField(db_column='divided_discussions', null=True, blank=True) # JSON list # noqa: DJ001 # pylint: disable=line-too-long COHORT = 'cohort' ENROLLMENT_TRACK = 'enrollment_track' @@ -309,7 +341,7 @@ def update(self, validated_data: dict): return self -class DiscussionsIdMapping(models.Model): +class DiscussionsIdMapping(models.Model): # noqa: DJ008 """ This model is a performance optimization, updated on course publish. diff --git a/openedx/core/djangoapps/django_comment_common/tests.py b/openedx/core/djangoapps/django_comment_common/tests.py index e0d87a341371..d9fedcd4811d 100644 --- a/openedx/core/djangoapps/django_comment_common/tests.py +++ b/openedx/core/djangoapps/django_comment_common/tests.py @@ -5,14 +5,16 @@ from django.test import TestCase from opaque_keys.edx.locator import CourseLocator -from openedx.core.djangoapps.course_groups.cohorts import CourseCohortsSettings -from openedx.core.djangoapps.django_comment_common.models import CourseDiscussionSettings, Role from common.djangoapps.student.models import CourseEnrollment from common.djangoapps.student.tests.factories import UserFactory -from xmodule.modulestore import ModuleStoreEnum # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from openedx.core.djangoapps.course_groups.cohorts import CourseCohortsSettings +from openedx.core.djangoapps.django_comment_common.models import CourseDiscussionSettings, Role +from xmodule.modulestore import ModuleStoreEnum # pylint: disable=wrong-import-order +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + ModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order class RoleAssignmentTest(TestCase): @@ -128,7 +130,7 @@ def test_invalid_data_types(self): discussion_settings = CourseDiscussionSettings.get(self.course.id) for field in fields: - with pytest.raises(ValueError) as value_error: + with pytest.raises(ValueError) as value_error: # noqa: PT011 discussion_settings.update({field['name']: invalid_value}) assert str(value_error.value) == exception_msg_template.format(field['name'], field['type'].__name__) diff --git a/openedx/core/djangoapps/django_comment_common/utils.py b/openedx/core/djangoapps/django_comment_common/utils.py index fd3a918bcb28..89d074653ae1 100644 --- a/openedx/core/djangoapps/django_comment_common/utils.py +++ b/openedx/core/djangoapps/django_comment_common/utils.py @@ -8,7 +8,7 @@ FORUM_ROLE_GROUP_MODERATOR, FORUM_ROLE_MODERATOR, FORUM_ROLE_STUDENT, - Role + Role, ) diff --git a/openedx/core/djangoapps/embargo/api.py b/openedx/core/djangoapps/embargo/api.py index 0934d13aab63..ef12b93e293d 100644 --- a/openedx/core/djangoapps/embargo/api.py +++ b/openedx/core/djangoapps/embargo/api.py @@ -7,7 +7,7 @@ """ import logging -from typing import List, Optional +from typing import List, Optional # noqa: UP035 from django.conf import settings from django.core.cache import cache @@ -30,8 +30,8 @@ def redirect_if_blocked( request: Request, course_key: CourseKey, access_point: str = 'enrollment', - user: Optional[types.User] = None, -) -> Optional[str]: + user: Optional[types.User] = None, # noqa: UP045 +) -> Optional[str]: # noqa: UP045 """ Redirect if the user does not have access to the course. @@ -61,9 +61,9 @@ def redirect_if_blocked( def check_course_access( course_key: CourseKey, - user: Optional[types.User] = None, - ip_addresses: Optional[List[str]] = None, - url: Optional[str] = None, + user: Optional[types.User] = None, # noqa: UP045 + ip_addresses: Optional[List[str]] = None, # noqa: UP006, UP045 + url: Optional[str] = None, # noqa: UP045 ) -> bool: """ Check is the user with this ip_addresses chain has access to the given course @@ -169,7 +169,7 @@ def _get_user_country_from_profile(user: types.User) -> str: profile_country = cache.get(cache_key) if profile_country is None: profile = getattr(user, 'profile', None) - if profile is not None and profile.country.code is not None: + if profile is not None and profile.country is not None: profile_country = profile.country.code.upper() else: profile_country = "" @@ -178,7 +178,7 @@ def _get_user_country_from_profile(user: types.User) -> str: return profile_country -def get_embargo_response(request: Request, course_key: CourseKey, user: types.User) -> Optional[Response]: +def get_embargo_response(request: Request, course_key: CourseKey, user: types.User) -> Optional[Response]: # noqa: UP045 # pylint: disable=line-too-long """ Check whether any country access rules block the user from enrollment. @@ -196,7 +196,7 @@ def get_embargo_response(request: Request, course_key: CourseKey, user: types.Us return Response( status=status.HTTP_403_FORBIDDEN, data={ - "message": ( + "message": ( # noqa: UP032 "Users from this location cannot access the course '{course_id}'." ).format(course_id=str(course_key)), "user_message_url": request.build_absolute_uri(redirect_url) diff --git a/openedx/core/djangoapps/embargo/exceptions.py b/openedx/core/djangoapps/embargo/exceptions.py index 9185b3aae195..ba140e14eb72 100644 --- a/openedx/core/djangoapps/embargo/exceptions.py +++ b/openedx/core/djangoapps/embargo/exceptions.py @@ -5,7 +5,7 @@ class InvalidAccessPoint(Exception): """The requested access point is not supported. """ def __init__(self, access_point, *args, **kwargs): - msg = ( + msg = ( # noqa: UP032 "Access point '{access_point}' should be either 'enrollment' or 'courseware'" ).format(access_point=access_point) super().__init__(msg, *args, **kwargs) diff --git a/openedx/core/djangoapps/embargo/forms.py b/openedx/core/djangoapps/embargo/forms.py index 5faa1ea5fb9e..94e96584ed10 100644 --- a/openedx/core/djangoapps/embargo/forms.py +++ b/openedx/core/djangoapps/embargo/forms.py @@ -4,6 +4,7 @@ import ipaddress + from django import forms from django.utils.translation import gettext as _ from opaque_keys import InvalidKeyError @@ -27,7 +28,7 @@ class RestrictedCourseForm(forms.ModelForm): """ class Meta: model = RestrictedCourse - fields = '__all__' + fields = '__all__' # noqa: DJ007 def clean_course_key(self): """Validate the course key. @@ -48,7 +49,7 @@ def clean_course_key(self): try: course_key = CourseKey.from_string(cleaned_id) except InvalidKeyError: - raise forms.ValidationError(error_msg) # lint-amnesty, pylint: disable=raise-missing-from + raise forms.ValidationError(error_msg) # pylint: disable=raise-missing-from # noqa: B904 if not modulestore().has_course(course_key): raise forms.ValidationError(error_msg) @@ -61,7 +62,7 @@ class IPFilterForm(forms.ModelForm): class Meta: model = IPFilter - fields = '__all__' + fields = '__all__' # noqa: DJ007 def _is_valid_ip(self, address): """Whether or not address is a valid ipv4 address or ipv6 address""" diff --git a/openedx/core/djangoapps/embargo/middleware.py b/openedx/core/djangoapps/embargo/middleware.py index d35dba11b2fd..b5abe0d82717 100644 --- a/openedx/core/djangoapps/embargo/middleware.py +++ b/openedx/core/djangoapps/embargo/middleware.py @@ -32,9 +32,9 @@ from django.conf import settings from django.core.exceptions import MiddlewareNotUsed +from django.shortcuts import redirect from django.urls import reverse from django.utils.deprecation import MiddlewareMixin -from django.shortcuts import redirect from edx_django_utils import ip from rest_framework.request import Request from rest_framework.response import Response @@ -67,7 +67,7 @@ def __init__(self, *args, **kwargs): raise MiddlewareNotUsed() super().__init__(*args, **kwargs) - def process_request(self, request: Request) -> Optional[Response]: + def process_request(self, request: Request) -> Optional[Response]: # noqa: UP045 """Block requests based on embargo rules. This will perform the following checks: @@ -133,7 +133,7 @@ def process_request(self, request: Request) -> Optional[Response]: # This applies only to courseware URLs. return self.country_access_rules(request) - def country_access_rules(self, request: Request) -> Optional[Response]: + def country_access_rules(self, request: Request) -> Optional[Response]: # noqa: UP045 """ Check the country access rules for a given course. Applies only to courseware URLs. diff --git a/openedx/core/djangoapps/embargo/migrations/0001_initial.py b/openedx/core/djangoapps/embargo/migrations/0001_initial.py index ae9f011e1b29..25ac29f68757 100644 --- a/openedx/core/djangoapps/embargo/migrations/0001_initial.py +++ b/openedx/core/djangoapps/embargo/migrations/0001_initial.py @@ -1,7 +1,7 @@ -from django.db import migrations, models -import django_countries.fields import django.db.models.deletion +import django_countries.fields from django.conf import settings +from django.db import migrations, models from opaque_keys.edx.django.models import CourseKeyField diff --git a/openedx/core/djangoapps/embargo/migrations/0003_add_global_restricted_country_model.py b/openedx/core/djangoapps/embargo/migrations/0003_add_global_restricted_country_model.py index d9a422202c48..4b016162e716 100644 --- a/openedx/core/djangoapps/embargo/migrations/0003_add_global_restricted_country_model.py +++ b/openedx/core/djangoapps/embargo/migrations/0003_add_global_restricted_country_model.py @@ -1,7 +1,7 @@ # Generated by Django 4.2.18 on 2025-01-29 08:19 -from django.db import migrations, models import django.db.models.deletion +from django.db import migrations, models class Migration(migrations.Migration): diff --git a/openedx/core/djangoapps/embargo/models.py b/openedx/core/djangoapps/embargo/models.py index b3a452079c78..a2e7496fbda9 100644 --- a/openedx/core/djangoapps/embargo/models.py +++ b/openedx/core/djangoapps/embargo/models.py @@ -15,7 +15,7 @@ import ipaddress import json import logging -from typing import List, Optional +from typing import List, Optional # noqa: UP035 from config_models.models import ConfigurationModel from django.core.cache import cache @@ -51,7 +51,7 @@ class EmbargoedCourse(models.Model): course_id = CourseKeyField(max_length=255, db_index=True, unique=True) # Whether or not to embargo - embargoed = models.BooleanField(default=False) + embargoed = models.BooleanField(default=False) # noqa: DJ012 @classmethod def is_embargoed(cls, course_id): @@ -66,7 +66,7 @@ def is_embargoed(cls, course_id): except cls.DoesNotExist: return False - def __str__(self): + def __str__(self): # noqa: DJ012 not_em = "Not " if self.embargoed: not_em = "" @@ -244,7 +244,7 @@ def snapshot(self): ] } - def message_key_for_access_point(self, access_point: str) -> Optional[str]: + def message_key_for_access_point(self, access_point: str) -> Optional[str]: # noqa: UP045 """Determine which message to show the user. The message can be configured per-course and depends @@ -263,7 +263,7 @@ def message_key_for_access_point(self, access_point: str) -> Optional[str]: elif access_point == 'courseware': return self.access_msg_key - def __str__(self): + def __str__(self): # noqa: DJ012 return str(self.course_key) @classmethod @@ -381,12 +381,12 @@ class Country(models.Model): ) def __str__(self): - return "{name} ({code})".format( + return "{name} ({code})".format( # noqa: UP032 name=str(self.country.name), code=str(self.country) ) - class Meta: + class Meta: # noqa: DJ012 """Default ordering is ascending by country code """ ordering = ['country'] @@ -475,7 +475,7 @@ def check_country_access(cls, course_key: CourseKey, country: str) -> bool: return country == '' or country in allowed_countries @classmethod - def _get_country_access_list(cls, course_key: CourseKey) -> List[str]: + def _get_country_access_list(cls, course_key: CourseKey) -> List[str]: # noqa: UP006 """ if a course is blacklist for two countries then course can be accessible from any where except these two countries. @@ -510,7 +510,7 @@ def _get_country_access_list(cls, course_key: CourseKey) -> List[str]: # that have access to the course. return list(whitelist_countries - blacklist_countries) - def __str__(self): + def __str__(self): # noqa: DJ012 if self.rule_type == self.WHITELIST_RULE: return _("Whitelist {country} for {course}").format( course=str(self.restricted_course.course_key), @@ -529,7 +529,7 @@ def invalidate_cache_for_course(cls, course_key: CourseKey) -> None: cache.delete(cache_key) log.info("Invalidated country access list for course %s", course_key) - class Meta: + class Meta: # noqa: DJ012 """a course can be added with either black or white list. """ unique_together = ( # This restriction ensures that a country is on @@ -580,7 +580,7 @@ def invalidate_country_rule_cache(sender, instance, **kwargs): # pylint: disabl post_delete.connect(invalidate_country_rule_cache, sender=RestrictedCourse) -class CourseAccessRuleHistory(models.Model): +class CourseAccessRuleHistory(models.Model): # noqa: DJ008 """ History of course access rule changes. @@ -590,7 +590,7 @@ class CourseAccessRuleHistory(models.Model): timestamp = models.DateTimeField(db_index=True, auto_now_add=True) course_key = CourseKeyField(max_length=255, db_index=True) - snapshot = models.TextField(null=True, blank=True) + snapshot = models.TextField(null=True, blank=True) # noqa: DJ001 DELETED_PLACEHOLDER = "DELETED" @@ -658,13 +658,15 @@ def snapshot_post_delete_receiver(sender, instance, **kwargs): # pylint: disabl else: CourseAccessRuleHistory.save_snapshot(restricted_course) - class Meta: + class Meta: # noqa: DJ012 get_latest_by = 'timestamp' class GlobalRestrictedCountry(models.Model): """ Model to restrict access to specific countries globally. + + .. no_pii: """ country = models.ForeignKey( "Country", @@ -715,7 +717,7 @@ def update_cache(cls): """ cache.set(cls.CACHE_KEY, cls._fetch_restricted_countries()) - def save(self, *args, **kwargs): + def save(self, *args, **kwargs): # noqa: DJ012 """ Override save method to update cache on insert/update. """ @@ -729,10 +731,10 @@ def delete(self, *args, **kwargs): super().delete(*args, **kwargs) self.update_cache() - def __str__(self): + def __str__(self): # noqa: DJ012 return f"{self.country.country.name} ({self.country.country})" - class Meta: + class Meta: # noqa: DJ012 verbose_name = "Global Restricted Country" verbose_name_plural = "Global Restricted Countries" diff --git a/openedx/core/djangoapps/embargo/test_utils.py b/openedx/core/djangoapps/embargo/test_utils.py index 86ef3c8e7968..ac8924094088 100644 --- a/openedx/core/djangoapps/embargo/test_utils.py +++ b/openedx/core/djangoapps/embargo/test_utils.py @@ -3,12 +3,11 @@ import contextlib from unittest.mock import MagicMock, patch +import geoip2.database import maxminddb from django.core.cache import cache from django.urls import reverse -import geoip2.database - from .models import Country, CountryAccessRule, RestrictedCourse diff --git a/openedx/core/djangoapps/embargo/tests/factories.py b/openedx/core/djangoapps/embargo/tests/factories.py index ad8c486a3f85..ecbf2a89fe64 100644 --- a/openedx/core/djangoapps/embargo/tests/factories.py +++ b/openedx/core/djangoapps/embargo/tests/factories.py @@ -2,6 +2,7 @@ import factory from factory.django import DjangoModelFactory + from xmodule.modulestore.tests.factories import CourseFactory from ..models import Country, CountryAccessRule, RestrictedCourse @@ -14,16 +15,16 @@ class Meta: country = 'US' -class RestrictedCourseFactory(DjangoModelFactory): # lint-amnesty, pylint: disable=missing-class-docstring +class RestrictedCourseFactory(DjangoModelFactory): # pylint: disable=missing-class-docstring class Meta: model = RestrictedCourse @factory.lazy_attribute def course_key(self): - return CourseFactory().id # lint-amnesty, pylint: disable=no-member + return CourseFactory().id # pylint: disable=no-member -class CountryAccessRuleFactory(DjangoModelFactory): # lint-amnesty, pylint: disable=missing-class-docstring +class CountryAccessRuleFactory(DjangoModelFactory): # pylint: disable=missing-class-docstring class Meta: model = CountryAccessRule diff --git a/openedx/core/djangoapps/embargo/tests/test_api.py b/openedx/core/djangoapps/embargo/tests/test_api.py index 4ebb3999f925..10010a732d39 100644 --- a/openedx/core/djangoapps/embargo/tests/test_api.py +++ b/openedx/core/djangoapps/embargo/tests/test_api.py @@ -4,37 +4,39 @@ from contextlib import contextmanager from unittest import mock -from unittest.mock import patch, MagicMock +from unittest.mock import MagicMock, patch +import ddt import geoip2.database import maxminddb -import ddt import pytest - from django.conf import settings from django.core.cache import cache from django.db import connection from django.test.client import RequestFactory from django.test.utils import override_settings -from xmodule.modulestore.tests.factories import CourseFactory -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase, mixed_store_config -from openedx.core.djangolib.testing.utils import skip_unless_lms -from common.djangoapps.student.tests.factories import UserFactory from common.djangoapps.student.roles import ( - GlobalStaff, CourseRole, OrgRole, - CourseStaffRole, CourseInstructorRole, - OrgStaffRole, OrgInstructorRole + CourseInstructorRole, + CourseRole, + CourseStaffRole, + GlobalStaff, + OrgInstructorRole, + OrgRole, + OrgStaffRole, ) +from common.djangoapps.student.tests.factories import UserFactory from common.djangoapps.util.testing import UrlResetMixin - -from ..models import ( - RestrictedCourse, Country, CountryAccessRule, -) +from openedx.core.djangoapps.waffle_utils.testutils import WAFFLE_TABLES +from openedx.core.djangolib.testing.utils import AUTHZ_TABLES, skip_unless_lms +from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase, mixed_store_config +from xmodule.modulestore.tests.factories import CourseFactory from .. import api as embargo_api from ..exceptions import InvalidAccessPoint +from ..models import Country, CountryAccessRule, RestrictedCourse +QUERY_COUNT_TABLE_IGNORELIST = WAFFLE_TABLES + AUTHZ_TABLES MODULESTORE_CONFIG = mixed_store_config(settings.COMMON_TEST_DATA_ROOT, {}) @@ -175,10 +177,10 @@ def test_caching(self): # (restricted course, but pass all the checks) # This is the worst case, so it will hit all of the # caching code. - with self.assertNumQueries(3): + with self.assertNumQueries(5, table_ignorelist=QUERY_COUNT_TABLE_IGNORELIST): embargo_api.check_course_access(self.course.id, user=self.user, ip_addresses=['0.0.0.0']) - with self.assertNumQueries(0): + with self.assertNumQueries(0, table_ignorelist=QUERY_COUNT_TABLE_IGNORELIST): embargo_api.check_course_access(self.course.id, user=self.user, ip_addresses=['0.0.0.0']) def test_caching_no_restricted_courses(self): @@ -263,7 +265,7 @@ def test_redirect_if_blocked_ips(self, ips, allow_access, mock_country): ) @ddt.unpack @mock.patch('openedx.core.djangoapps.embargo.api.check_course_access', return_value=False) - def test_redirect_if_blocked_courseware(self, access_point, check_disabled, allow_access, _mock_access): + def test_redirect_if_blocked_courseware(self, access_point, check_disabled, allow_access, _mock_access): # noqa: PT019 # pylint: disable=line-too-long self.restricted_course.disable_access_check = check_disabled self.restricted_course.save() @@ -359,7 +361,7 @@ def test_message_url_stale_cache(self): RestrictedCourse.objects.get(course_key=self.course.id).delete() # Clear the message URL cache - message_cache_key = ( + message_cache_key = ( # noqa: UP032 'embargo.message_url_path.courseware.{course_key}' ).format(course_key=self.course.id) cache.delete(message_cache_key) diff --git a/openedx/core/djangoapps/embargo/tests/test_forms.py b/openedx/core/djangoapps/embargo/tests/test_forms.py index b6b169f65fcc..1fe0418758b7 100644 --- a/openedx/core/djangoapps/embargo/tests/test_forms.py +++ b/openedx/core/djangoapps/embargo/tests/test_forms.py @@ -47,7 +47,7 @@ def _assert_course_field_error(self, form): msg = 'COURSE NOT FOUND' assert msg in form._errors['course_key'][0] # pylint: disable=protected-access - with self.assertRaisesRegex( + with self.assertRaisesRegex( # noqa: PT027 ValueError, "The RestrictedCourse could not be created because the data didn't validate." ): form.save() @@ -122,5 +122,5 @@ def test_add_invalid_ips(self): " Please fix the error(s) and try again." assert bmsg == form._errors['blacklist'][0] # pylint: disable=protected-access - with self.assertRaisesRegex(ValueError, "The IPFilter could not be created because the data didn't validate."): + with self.assertRaisesRegex(ValueError, "The IPFilter could not be created because the data didn't validate."): # noqa: PT027 # pylint: disable=line-too-long form.save() diff --git a/openedx/core/djangoapps/embargo/tests/test_middleware.py b/openedx/core/djangoapps/embargo/tests/test_middleware.py index 9fa1f5b87c5f..eaa2ef1bbd88 100644 --- a/openedx/core/djangoapps/embargo/tests/test_middleware.py +++ b/openedx/core/djangoapps/embargo/tests/test_middleware.py @@ -4,17 +4,18 @@ from unittest.mock import patch + import ddt from config_models.models import cache as config_cache from django.conf import settings from django.core.cache import cache as django_cache from django.urls import reverse -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase -from xmodule.modulestore.tests.factories import CourseFactory from common.djangoapps.student.tests.factories import UserFactory from common.djangoapps.util.testing import UrlResetMixin from openedx.core.djangolib.testing.utils import skip_unless_lms +from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase +from xmodule.modulestore.tests.factories import CourseFactory from ..models import IPFilter, RestrictedCourse from ..test_utils import restrict_course diff --git a/openedx/core/djangoapps/embargo/tests/test_models.py b/openedx/core/djangoapps/embargo/tests/test_models.py index afe8da2423ba..5f65a854eee9 100644 --- a/openedx/core/djangoapps/embargo/tests/test_models.py +++ b/openedx/core/djangoapps/embargo/tests/test_models.py @@ -2,6 +2,7 @@ import json + import pytest from django.db.utils import IntegrityError from django.test import TestCase @@ -16,7 +17,7 @@ EmbargoedCourse, EmbargoedState, IPFilter, - RestrictedCourse + RestrictedCourse, ) diff --git a/openedx/core/djangoapps/embargo/tests/test_views.py b/openedx/core/djangoapps/embargo/tests/test_views.py index 1c8ea7268406..8098ecb7157e 100644 --- a/openedx/core/djangoapps/embargo/tests/test_views.py +++ b/openedx/core/djangoapps/embargo/tests/test_views.py @@ -1,24 +1,33 @@ """Tests for embargo app views. """ -from unittest.mock import patch, MagicMock +from unittest.mock import MagicMock, patch import ddt -import maxminddb import geoip2.database - -from django.urls import reverse +import maxminddb from django.conf import settings +from django.urls import reverse + +from common.djangoapps.student.tests.factories import UserFactory # pylint: disable=wrong-import-order +from common.djangoapps.util.testing import UrlResetMixin # pylint: disable=wrong-import-order +from lms.djangoapps.course_api.tests.mixins import ( + CourseApiFactoryMixin, # pylint: disable=wrong-import-order +) +from openedx.core.djangoapps.theming.tests.test_util import ( + with_comprehensive_theme, # pylint: disable=wrong-import-order +) +from openedx.core.djangolib.testing.utils import ( # pylint: disable=wrong-import-order + CacheIsolationTestCase, + skip_unless_lms, +) +from xmodule.modulestore.tests.django_utils import ( + ModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order -from .factories import CountryAccessRuleFactory, RestrictedCourseFactory from .. import messages -from lms.djangoapps.course_api.tests.mixins import CourseApiFactoryMixin # lint-amnesty, pylint: disable=wrong-import-order -from openedx.core.djangolib.testing.utils import CacheIsolationTestCase, skip_unless_lms # lint-amnesty, pylint: disable=wrong-import-order -from openedx.core.djangoapps.theming.tests.test_util import with_comprehensive_theme # lint-amnesty, pylint: disable=wrong-import-order -from common.djangoapps.student.tests.factories import UserFactory # lint-amnesty, pylint: disable=wrong-import-order -from common.djangoapps.util.testing import UrlResetMixin # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order +from .factories import CountryAccessRuleFactory, RestrictedCourseFactory @skip_unless_lms @@ -98,8 +107,8 @@ def setUp(self): super().setUp() self.url = reverse('api_embargo:v1_course_access') user = UserFactory(is_staff=True) - self.client.login(username=user.username, password=UserFactory._DEFAULT_PASSWORD) # lint-amnesty, pylint: disable=protected-access - self.course_id = str(CourseFactory().id) # lint-amnesty, pylint: disable=no-member + self.client.login(username=user.username, password=UserFactory._DEFAULT_PASSWORD) # pylint: disable=protected-access + self.course_id = str(CourseFactory().id) # pylint: disable=no-member self.request_data = { 'course_ids': [self.course_id], 'ip_address': '0.0.0.0', @@ -152,7 +161,7 @@ def test_course_access_endpoint_with_logged_out_user(self): def test_course_access_endpoint_with_non_staff_user(self): user = UserFactory(is_staff=False) - self.client.login(username=user.username, password=UserFactory._DEFAULT_PASSWORD) # lint-amnesty, pylint: disable=protected-access + self.client.login(username=user.username, password=UserFactory._DEFAULT_PASSWORD) # pylint: disable=protected-access response = self.client.get(self.url, data=self.request_data) assert response.status_code == 403 diff --git a/openedx/core/djangoapps/embargo/urls.py b/openedx/core/djangoapps/embargo/urls.py index d7e7c345c0cb..2372efffe204 100644 --- a/openedx/core/djangoapps/embargo/urls.py +++ b/openedx/core/djangoapps/embargo/urls.py @@ -1,6 +1,7 @@ """URLs served by the embargo app. """ from django.urls import path, re_path + from .views import CheckCourseAccessView, CourseAccessMessageView app_name = 'embargo' diff --git a/openedx/core/djangoapps/embargo/views.py b/openedx/core/djangoapps/embargo/views.py index d0cb56e06d27..ee7d02c67c3a 100644 --- a/openedx/core/djangoapps/embargo/views.py +++ b/openedx/core/djangoapps/embargo/views.py @@ -1,7 +1,7 @@ """Views served by the embargo app. """ -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.http import Http404 from django.views.generic.base import View from opaque_keys import InvalidKeyError @@ -17,7 +17,7 @@ from .api import check_course_access -class CheckCourseAccessView(APIView): # lint-amnesty, pylint: disable=missing-class-docstring +class CheckCourseAccessView(APIView): # pylint: disable=missing-class-docstring permission_classes = (permissions.IsAuthenticated, permissions.IsAdminUser) def get(self, request): diff --git a/openedx/core/djangoapps/enrollments/api.py b/openedx/core/djangoapps/enrollments/api.py index e0aefc44d43e..75b1ffa0da86 100644 --- a/openedx/core/djangoapps/enrollments/api.py +++ b/openedx/core/djangoapps/enrollments/api.py @@ -14,7 +14,7 @@ from common.djangoapps.course_modes.models import CourseMode from openedx.core.djangoapps.enrollments import errors -from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order log = logging.getLogger(__name__) @@ -324,7 +324,7 @@ def update_enrollment( } """ - log.info('Starting Update Enrollment process for user {user} in course {course} to mode {mode}'.format( + log.info('Starting Update Enrollment process for user {user} in course {course} to mode {mode}'.format( # noqa: UP032 # pylint: disable=line-too-long user=username, course=course_id, mode=mode, @@ -332,14 +332,14 @@ def update_enrollment( if mode is not None: validate_course_mode(course_id, mode, is_active=is_active, include_expired=include_expired) enrollment = _data_api().update_course_enrollment(username, course_id, mode=mode, is_active=is_active) - if enrollment is None: # lint-amnesty, pylint: disable=no-else-raise + if enrollment is None: # pylint: disable=no-else-raise msg = f"Course Enrollment not found for user {username} in course {course_id}" log.warning(msg) raise errors.EnrollmentNotFoundError(msg) else: if enrollment_attributes is not None: set_enrollment_attributes(username, course_id, enrollment_attributes) - log.info('Course Enrollment updated for user {user} in course {course} to mode {mode}'.format( + log.info('Course Enrollment updated for user {user} in course {course} to mode {mode}'.format( # noqa: UP032 user=username, course=course_id, mode=mode @@ -406,7 +406,7 @@ def get_course_enrollment_details(course_id, include_expired=False): except Exception: # Catch any unexpected errors during caching. log.exception("Error occurred while caching course enrollment details for course %s", course_id) - raise errors.CourseEnrollmentError("An unexpected error occurred while retrieving course enrollment details.") # lint-amnesty, pylint: disable=raise-missing-from + raise errors.CourseEnrollmentError("An unexpected error occurred while retrieving course enrollment details.") # pylint: disable=raise-missing-from,line-too-long # noqa: B904 return course_enrollment_details @@ -615,4 +615,4 @@ def _data_api(): return importlib.import_module(api_path) except (ImportError, ValueError): log.exception(f"Could not load module at '{api_path}'") - raise errors.EnrollmentApiLoadError(api_path) # lint-amnesty, pylint: disable=raise-missing-from + raise errors.EnrollmentApiLoadError(api_path) # pylint: disable=raise-missing-from # noqa: B904 diff --git a/openedx/core/djangoapps/enrollments/data.py b/openedx/core/djangoapps/enrollments/data.py index b76042f72c9d..44e7660f7f15 100644 --- a/openedx/core/djangoapps/enrollments/data.py +++ b/openedx/core/djangoapps/enrollments/data.py @@ -6,29 +6,29 @@ import logging -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.db import transaction from opaque_keys.edx.keys import CourseKey +from common.djangoapps.student.models import ( + AlreadyEnrolledError, + CourseEnrollment, + CourseEnrollmentAttribute, + CourseFullError, + EnrollmentClosedError, + NonExistentCourseError, +) +from common.djangoapps.student.role_helpers import get_course_roles from openedx.core.djangoapps.content.course_overviews.models import CourseOverview from openedx.core.djangoapps.enrollments.errors import ( CourseEnrollmentClosedError, CourseEnrollmentExistsError, CourseEnrollmentFullError, InvalidEnrollmentAttribute, - UserNotFoundError + UserNotFoundError, ) from openedx.core.djangoapps.enrollments.serializers import CourseEnrollmentSerializer, CourseSerializer from openedx.core.lib.exceptions import CourseNotFoundError -from common.djangoapps.student.models import ( - AlreadyEnrolledError, - CourseEnrollment, - CourseEnrollmentAttribute, - CourseFullError, - EnrollmentClosedError, - NonExistentCourseError -) -from common.djangoapps.student.role_helpers import get_course_roles log = logging.getLogger(__name__) @@ -145,7 +145,7 @@ def create_course_enrollment(username, course_id, mode, is_active, enterprise_uu except User.DoesNotExist: msg = f"Not user with username '{username}' found." log.warning(msg) - raise UserNotFoundError(msg) # lint-amnesty, pylint: disable=raise-missing-from + raise UserNotFoundError(msg) # pylint: disable=raise-missing-from # noqa: B904 try: enrollment = CourseEnrollment.enroll( @@ -153,14 +153,14 @@ def create_course_enrollment(username, course_id, mode, is_active, enterprise_uu ) return _update_enrollment(enrollment, is_active=is_active, mode=mode) except NonExistentCourseError as err: - raise CourseNotFoundError(str(err)) # lint-amnesty, pylint: disable=raise-missing-from + raise CourseNotFoundError(str(err)) # pylint: disable=raise-missing-from # noqa: B904 except EnrollmentClosedError as err: - raise CourseEnrollmentClosedError(str(err)) # lint-amnesty, pylint: disable=raise-missing-from + raise CourseEnrollmentClosedError(str(err)) # pylint: disable=raise-missing-from # noqa: B904 except CourseFullError as err: - raise CourseEnrollmentFullError(str(err)) # lint-amnesty, pylint: disable=raise-missing-from + raise CourseEnrollmentFullError(str(err)) # pylint: disable=raise-missing-from # noqa: B904 except AlreadyEnrolledError as err: enrollment = get_course_enrollment(username, course_id) - raise CourseEnrollmentExistsError(str(err), enrollment) # lint-amnesty, pylint: disable=raise-missing-from + raise CourseEnrollmentExistsError(str(err), enrollment) # pylint: disable=raise-missing-from # noqa: B904 def update_course_enrollment(username, course_id, mode=None, is_active=None): @@ -185,7 +185,7 @@ def update_course_enrollment(username, course_id, mode=None, is_active=None): except User.DoesNotExist: msg = f"Not user with username '{username}' found." log.warning(msg) - raise UserNotFoundError(msg) # lint-amnesty, pylint: disable=raise-missing-from + raise UserNotFoundError(msg) # pylint: disable=raise-missing-from # noqa: B904 try: enrollment = CourseEnrollment.objects.get(user=user, course_id=course_key) @@ -260,7 +260,7 @@ def unenroll_user_from_all_courses(username): for enrollment in enrollments: _update_enrollment(enrollment, is_active=False) - return {str(enrollment.course_id.org) for enrollment in enrollments} # lint-amnesty, pylint: disable=consider-using-set-comprehension + return {str(enrollment.course_id.org) for enrollment in enrollments} # pylint: disable=consider-using-set-comprehension def _get_user(username): @@ -276,7 +276,7 @@ def _get_user(username): except User.DoesNotExist: msg = f"Not user with username '{username}' found." log.warning(msg) - raise UserNotFoundError(msg) # lint-amnesty, pylint: disable=raise-missing-from + raise UserNotFoundError(msg) # pylint: disable=raise-missing-from # noqa: B904 def _update_enrollment(enrollment, is_active=None, mode=None): @@ -340,7 +340,7 @@ def get_course_enrollment_info(course_id, include_expired=False): except CourseOverview.DoesNotExist: msg = f"Requested enrollment information for unknown course {course_id}" log.warning(msg) - raise CourseNotFoundError(msg) # lint-amnesty, pylint: disable=raise-missing-from + raise CourseNotFoundError(msg) # pylint: disable=raise-missing-from # noqa: B904 return CourseSerializer(course, include_expired=include_expired).data diff --git a/openedx/core/djangoapps/enrollments/enrollments_notifications.py b/openedx/core/djangoapps/enrollments/enrollments_notifications.py index e1f92efeecf4..3a0559d2ce4a 100644 --- a/openedx/core/djangoapps/enrollments/enrollments_notifications.py +++ b/openedx/core/djangoapps/enrollments/enrollments_notifications.py @@ -2,9 +2,9 @@ Enrollment notifications sender util. """ from django.conf import settings - from openedx_events.learning.data import UserNotificationData from openedx_events.learning.signals import USER_NOTIFICATION_REQUESTED + from openedx.core.djangoapps.site_configuration import helpers as configuration_helpers diff --git a/openedx/core/djangoapps/enrollments/errors.py b/openedx/core/djangoapps/enrollments/errors.py index 167b17612925..ded3b5235b36 100644 --- a/openedx/core/djangoapps/enrollments/errors.py +++ b/openedx/core/djangoapps/enrollments/errors.py @@ -26,7 +26,7 @@ class CourseEnrollmentFullError(CourseEnrollmentError): pass -class CourseEnrollmentExistsError(CourseEnrollmentError): # lint-amnesty, pylint: disable=missing-class-docstring +class CourseEnrollmentExistsError(CourseEnrollmentError): # pylint: disable=missing-class-docstring enrollment = None def __init__(self, message, enrollment): @@ -36,22 +36,22 @@ def __init__(self, message, enrollment): class CourseModeNotFoundError(CourseEnrollmentError): """The requested course mode could not be found.""" - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass class EnrollmentNotFoundError(CourseEnrollmentError): """The requested enrollment could not be found.""" - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass class EnrollmentApiLoadError(CourseEnrollmentError): """The data API could not be loaded.""" - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass class InvalidEnrollmentAttribute(CourseEnrollmentError): """Enrollment Attributes could not be validated""" - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass class CourseEnrollmentNotUpdatableError(CourseEnrollmentError): diff --git a/openedx/core/djangoapps/enrollments/forms.py b/openedx/core/djangoapps/enrollments/forms.py index e87210b3fee4..e2bda0f4cc22 100644 --- a/openedx/core/djangoapps/enrollments/forms.py +++ b/openedx/core/djangoapps/enrollments/forms.py @@ -30,7 +30,7 @@ def clean_course_id(self): try: return CourseKey.from_string(course_id) except InvalidKeyError: - raise ValidationError(f"'{course_id}' is not a valid course id.") # lint-amnesty, pylint: disable=raise-missing-from + raise ValidationError(f"'{course_id}' is not a valid course id.") # pylint: disable=raise-missing-from # noqa: B904 return course_id def clean_username(self): @@ -42,7 +42,7 @@ def clean_username(self): usernames = usernames_csv_string.split(',') if len(usernames) > self.MAX_INPUT_COUNT: raise ValidationError( - "Too many usernames in a single request - {}. A maximum of {} is allowed".format( + "Too many usernames in a single request - {}. A maximum of {} is allowed".format( # noqa: UP032 len(usernames), self.MAX_INPUT_COUNT, ) @@ -61,7 +61,7 @@ def clean_course_ids(self): course_ids = course_ids_csv_string.split(',') if len(course_ids) > self.MAX_INPUT_COUNT: raise ValidationError( - "Too many course_ids in a single request - {}. A maximum of {} is allowed".format( + "Too many course_ids in a single request - {}. A maximum of {} is allowed".format( # noqa: UP032 len(course_ids), self.MAX_INPUT_COUNT, ) @@ -79,7 +79,7 @@ def clean_email(self): emails = emails_csv_string.split(',') if len(emails) > self.MAX_INPUT_COUNT: raise ValidationError( - "Too many emails in a single request - {}. A maximum of {} is allowed".format( + "Too many emails in a single request - {}. A maximum of {} is allowed".format( # noqa: UP032 len(emails), self.MAX_INPUT_COUNT, ) diff --git a/openedx/core/djangoapps/enrollments/management/commands/enroll_user_in_course.py b/openedx/core/djangoapps/enrollments/management/commands/enroll_user_in_course.py index 03a3e0884e11..4d1550cfc36c 100644 --- a/openedx/core/djangoapps/enrollments/management/commands/enroll_user_in_course.py +++ b/openedx/core/djangoapps/enrollments/management/commands/enroll_user_in_course.py @@ -2,10 +2,11 @@ Management command for enrolling a user into a course via the enrollment api """ -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.core.management.base import BaseCommand -from openedx.core.djangoapps.enrollments.data import CourseEnrollmentExistsError + from openedx.core.djangoapps.enrollments.api import add_enrollment +from openedx.core.djangoapps.enrollments.data import CourseEnrollmentExistsError class Command(BaseCommand): diff --git a/openedx/core/djangoapps/enrollments/management/tests/test_enroll_user_in_course.py b/openedx/core/djangoapps/enrollments/management/tests/test_enroll_user_in_course.py index 3d4b6f6e5c22..c4fc378352ed 100644 --- a/openedx/core/djangoapps/enrollments/management/tests/test_enroll_user_in_course.py +++ b/openedx/core/djangoapps/enrollments/management/tests/test_enroll_user_in_course.py @@ -10,9 +10,10 @@ from common.djangoapps.student.tests.factories import UserFactory from openedx.core.djangoapps.enrollments.api import get_enrollment from openedx.core.djangolib.testing.utils import skip_unless_lms - -from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + SharedModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order @ddt.ddt diff --git a/openedx/core/djangoapps/enrollments/permissions.py b/openedx/core/djangoapps/enrollments/permissions.py index b4a6754ecc78..e142ac298dc8 100644 --- a/openedx/core/djangoapps/enrollments/permissions.py +++ b/openedx/core/djangoapps/enrollments/permissions.py @@ -3,6 +3,7 @@ """ from bridgekeeper import perms + from lms.djangoapps.courseware.rules import HasAccessRule ENROLL_IN_COURSE = 'enrollment.enroll_in_course' diff --git a/openedx/core/djangoapps/enrollments/services.py b/openedx/core/djangoapps/enrollments/services.py index 34bdad9d2107..b62f9e98a8ae 100644 --- a/openedx/core/djangoapps/enrollments/services.py +++ b/openedx/core/djangoapps/enrollments/services.py @@ -7,8 +7,8 @@ from django.conf import settings from django.contrib.auth import get_user_model from django.db.models import Q - from opaque_keys.edx.keys import CourseKey + from common.djangoapps.course_modes.models import CourseMode from common.djangoapps.student.models import CourseEnrollment from openedx.core.djangoapps.content.course_overviews.api import get_course_overview_or_none diff --git a/openedx/core/djangoapps/enrollments/tests/test_api.py b/openedx/core/djangoapps/enrollments/tests/test_api.py index 0b9dc60d1059..54369ea6ed39 100644 --- a/openedx/core/djangoapps/enrollments/tests/test_api.py +++ b/openedx/core/djangoapps/enrollments/tests/test_api.py @@ -11,7 +11,9 @@ from common.djangoapps.course_modes.models import CourseMode from openedx.core.djangoapps.enrollments import api from openedx.core.djangoapps.enrollments.errors import ( - CourseModeNotFoundError, EnrollmentApiLoadError, EnrollmentNotFoundError, + CourseModeNotFoundError, + EnrollmentApiLoadError, + EnrollmentNotFoundError, ) from openedx.core.djangoapps.enrollments.tests import fake_data_api from openedx.core.djangolib.testing.utils import CacheIsolationTestCase, skip_unless_lms diff --git a/openedx/core/djangoapps/enrollments/tests/test_data.py b/openedx/core/djangoapps/enrollments/tests/test_data.py index 491be2cc8cdc..88d74490cdf3 100644 --- a/openedx/core/djangoapps/enrollments/tests/test_data.py +++ b/openedx/core/djangoapps/enrollments/tests/test_data.py @@ -5,27 +5,35 @@ import datetime from unittest.mock import patch +from zoneinfo import ZoneInfo import ddt import pytest -from zoneinfo import ZoneInfo from common.djangoapps.course_modes.models import CourseMode from common.djangoapps.course_modes.tests.factories import CourseModeFactory +from common.djangoapps.student.models import ( # pylint: disable=line-too-long + AlreadyEnrolledError, + CourseEnrollment, + CourseFullError, + EnrollmentClosedError, +) +from common.djangoapps.student.roles import AuthzCompatCourseAccessRole +from common.djangoapps.student.tests.factories import CourseAccessRoleFactory, CourseEnrollmentFactory, UserFactory from openedx.core.djangoapps.enrollments import data from openedx.core.djangoapps.enrollments.errors import ( CourseEnrollmentClosedError, CourseEnrollmentExistsError, CourseEnrollmentFullError, - UserNotFoundError + UserNotFoundError, ) from openedx.core.djangoapps.enrollments.serializers import CourseEnrollmentSerializer from openedx.core.djangolib.testing.utils import skip_unless_lms from openedx.core.lib.exceptions import CourseNotFoundError -from common.djangoapps.student.models import AlreadyEnrolledError, CourseEnrollment, CourseFullError, EnrollmentClosedError # lint-amnesty, pylint: disable=line-too-long -from common.djangoapps.student.tests.factories import CourseAccessRoleFactory, UserFactory, CourseEnrollmentFactory -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + ModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order @ddt.ddt @@ -387,8 +395,15 @@ def test_get_roles(self): expected_role = CourseAccessRoleFactory.create( course_id=self.course.id, user=self.user, role="SuperCoolTestRole", ) + expected_role_compat = AuthzCompatCourseAccessRole( + user_id=expected_role.user.id, + username=expected_role.user.username, + org=expected_role.org, + course_id=expected_role.course_id, + role=expected_role.role, + ) roles = data.get_user_roles(self.user.username) - assert roles == {expected_role} + assert roles == {expected_role_compat} def test_get_roles_no_roles(self): """Get roles for a user who has no roles""" diff --git a/openedx/core/djangoapps/enrollments/tests/test_enrollments_notifications.py b/openedx/core/djangoapps/enrollments/tests/test_enrollments_notifications.py index aebbd9670890..0808e52c53ac 100644 --- a/openedx/core/djangoapps/enrollments/tests/test_enrollments_notifications.py +++ b/openedx/core/djangoapps/enrollments/tests/test_enrollments_notifications.py @@ -1,15 +1,15 @@ """ Unit tests for the EnrollmentsNotificationSender class """ -import unittest import datetime +import unittest from unittest.mock import MagicMock, patch -from django.test.utils import override_settings import pytest +from django.test.utils import override_settings +from openedx_events.learning.data import UserNotificationData from openedx.core.djangoapps.enrollments.enrollments_notifications import EnrollmentNotificationSender -from openedx_events.learning.data import UserNotificationData DEFAULT_MFE_URL = "https://learning.default" SITE_CONF_MFE_URL = "https://learning.siteconf" diff --git a/openedx/core/djangoapps/enrollments/tests/test_services.py b/openedx/core/djangoapps/enrollments/tests/test_services.py index 14107ee5163a..9840317b22e8 100644 --- a/openedx/core/djangoapps/enrollments/tests/test_services.py +++ b/openedx/core/djangoapps/enrollments/tests/test_services.py @@ -9,7 +9,9 @@ from common.djangoapps.student.tests.factories import UserFactory from openedx.core.djangoapps.content.course_overviews.tests.factories import CourseOverviewFactory from openedx.core.djangoapps.enrollments.services import EnrollmentsService -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + ModuleStoreTestCase, # pylint: disable=wrong-import-order +) @ddt.ddt @@ -51,7 +53,7 @@ def test_get_active_enrollments_by_course(self): Test that it returns a list of active enrollments for a course """ enrollments = self.service.get_active_enrollments_by_course(course_id=str(self.course.id)) - self.assertEqual(len(self.course_modes), len(enrollments)) + self.assertEqual(len(self.course_modes), len(enrollments)) # noqa: PT009 def test_get_active_enrollments_by_course_and_user(self): """ @@ -62,7 +64,7 @@ def test_get_active_enrollments_by_course_and_user(self): self.users[0].id, ) expected_values = {'username': 'user0', 'mode': 'audit'} - self.assertDictEqual(self.enrollment_to_dict(enrollment), expected_values) + self.assertDictEqual(self.enrollment_to_dict(enrollment), expected_values) # noqa: PT009 def test_get_active_enrollments_by_course_and_user_none_course(self): """ @@ -73,13 +75,13 @@ def test_get_active_enrollments_by_course_and_user_none_course(self): 'course-v1:testx+none+123', self.users[0].id, ) - self.assertIsNone(enrollments) + self.assertIsNone(enrollments) # noqa: PT009 def test_get_active_enrollments_by_course_and_user_none_user(self): """ Test getting enrollments for a course and non existing user raise error """ - with self.assertRaises(AssertionError): + with self.assertRaises(AssertionError): # noqa: PT027 self.service.get_active_enrollments_by_course_and_user( str(self.course.id), 0000, @@ -98,7 +100,7 @@ def test_get_enrollments_can_take_proctored_exams_by_course(self): {'username': 'user5', 'mode': 'verified'} ] actual_values = [self.enrollment_to_dict(e) for e in enrollments] - self.assertEqual(actual_values, expected_values) + self.assertEqual(actual_values, expected_values) # noqa: PT009 def test_get_enrollments_can_take_proctored_exams_by_course_ignore_inactive(self): """ @@ -143,7 +145,7 @@ def test_get_enrollments_can_take_proctored_exams_allow_honor(self): ] actual_values = [self.enrollment_to_dict(e) for e in enrollments] - self.assertEqual(actual_values, expected_values) + self.assertEqual(actual_values, expected_values) # noqa: PT009 def test_get_enrollments_can_take_proctored_exams_not_enable_proctored_exams(self): self.course.enable_proctored_exams = False @@ -172,7 +174,7 @@ def test_text_search_partial_return_all(self, text_search): {'username': 'user5', 'mode': 'verified'} ] actual_values = [self.enrollment_to_dict(e) for e in enrollments] - self.assertEqual(actual_values, expected_values) + self.assertEqual(actual_values, expected_values) # noqa: PT009 def test_text_search_partial_return_some(self): enrollments = self.service.get_enrollments_can_take_proctored_exams( @@ -184,7 +186,7 @@ def test_text_search_partial_return_some(self): {'username': 'user3', 'mode': 'masters'} ] actual_values = [self.enrollment_to_dict(e) for e in enrollments] - self.assertEqual(actual_values, expected_values) + self.assertEqual(actual_values, expected_values) # noqa: PT009 @ddt.data('user1', 'USER1', 'LEARNER1@example.com', 'lEarNer1@eXAMPLE.com') def test_text_search_exact_return_one(self, text_search): @@ -197,7 +199,7 @@ def test_text_search_exact_return_one(self, text_search): {'username': 'user1', 'mode': 'executive-education'} ] actual_values = [self.enrollment_to_dict(e) for e in enrollments] - self.assertEqual(actual_values, expected_values) + self.assertEqual(actual_values, expected_values) # noqa: PT009 def test_text_search_return_none(self): enrollments = self.service.get_enrollments_can_take_proctored_exams( diff --git a/openedx/core/djangoapps/enrollments/tests/test_views.py b/openedx/core/djangoapps/enrollments/tests/test_views.py index 41c5a9624c24..3f2c30bada4b 100644 --- a/openedx/core/djangoapps/enrollments/tests/test_views.py +++ b/openedx/core/djangoapps/enrollments/tests/test_views.py @@ -8,11 +8,11 @@ import json from unittest.mock import patch from urllib.parse import quote +from zoneinfo import ZoneInfo import ddt import httpretty import pytest -from zoneinfo import ZoneInfo from django.conf import settings from django.core.cache import cache from django.core.exceptions import ImproperlyConfigured @@ -20,7 +20,6 @@ from django.test import Client from django.test.utils import override_settings from django.urls import reverse -from edx_toggles.toggles.testutils import override_waffle_flag from freezegun import freeze_time from rest_framework import status from rest_framework.test import APITestCase @@ -39,7 +38,6 @@ from openedx.core.djangoapps.enrollments import api, data from openedx.core.djangoapps.enrollments.errors import CourseEnrollmentError from openedx.core.djangoapps.enrollments.views import EnrollmentUserThrottle -from openedx.core.djangoapps.notifications.config.waffle import ENABLE_NOTIFICATIONS from openedx.core.djangoapps.oauth_dispatch.jwt import create_jwt_for_user from openedx.core.djangoapps.user_api.models import RetirementState, UserOrgTag, UserRetirementStatus from openedx.core.djangolib.testing.utils import skip_unless_lms @@ -155,7 +153,6 @@ def _get_enrollments(self): @override_settings(EDX_API_KEY="i am a key") -@override_waffle_flag(ENABLE_NOTIFICATIONS, True) @ddt.ddt @skip_unless_lms class EnrollmentTest(EnrollmentTestMixin, ModuleStoreTestCase, APITestCase, EnterpriseServiceMockMixin): @@ -541,7 +538,7 @@ def _assert_enrollments_visible_in_list(self, courses, use_server_key=False): response = self.client.get(reverse('courseenrollments'), {'user': self.user.username}, **kwargs) assert response.status_code == status.HTTP_200_OK data = json.loads(response.content.decode('utf-8')) - self.assertCountEqual( + self.assertCountEqual( # noqa: PT009 [(datum['course_details']['course_id'], datum['course_details']['course_name']) for datum in data], [(str(course.id), course.display_name_with_default) for course in courses] ) @@ -1150,7 +1147,7 @@ def test_change_mode_from_server(self, old_mode, new_mode, old_is_active, new_is assert is_active == old_is_active assert course_mode == old_mode # error message should contain specific text. Otto checks for this text in the message. - self.assertRegex( + self.assertRegex( # noqa: PT009 json.loads(response.content.decode('utf-8'))['message'], 'Enrollment mode mismatch' ) @@ -1765,7 +1762,7 @@ def test_roles_exception(self): response = self.client.get(reverse('roles')) assert response.status_code == status.HTTP_400_BAD_REQUEST expected_response = { - "message": ( + "message": ( # noqa: UP032 "An error occurred while retrieving roles for user '{username}" ).format(username=self.user.username) } @@ -1928,7 +1925,7 @@ def test_response_valid_queries(self, args): content = self._assert_list_of_enrollments(query_params, status.HTTP_200_OK) results = content['results'] - self.assertCountEqual(results, expected_results) + self.assertCountEqual(results, expected_results) # noqa: PT009 @ddt.ddt diff --git a/openedx/core/djangoapps/enrollments/urls.py b/openedx/core/djangoapps/enrollments/urls.py index 828d4b61798b..d908b2f1ef2b 100644 --- a/openedx/core/djangoapps/enrollments/urls.py +++ b/openedx/core/djangoapps/enrollments/urls.py @@ -18,7 +18,7 @@ urlpatterns = [ re_path( - r"^enrollment/{username},{course_key}$".format( + r"^enrollment/{username},{course_key}$".format( # noqa: UP032 username=settings.USERNAME_PATTERN, course_key=settings.COURSE_ID_PATTERN ), EnrollmentView.as_view(), diff --git a/openedx/core/djangoapps/enrollments/views.py b/openedx/core/djangoapps/enrollments/views.py index dc3423245e9b..0781e2e2d3a0 100644 --- a/openedx/core/djangoapps/enrollments/views.py +++ b/openedx/core/djangoapps/enrollments/views.py @@ -6,26 +6,26 @@ import logging -from django.core.exceptions import ( # lint-amnesty, pylint: disable=wrong-import-order +from django.core.exceptions import ( # pylint: disable=wrong-import-order ObjectDoesNotExist, ValidationError, ) -from django.db import IntegrityError # lint-amnesty, pylint: disable=wrong-import-order -from django.db.models import Q # lint-amnesty, pylint: disable=wrong-import-order -from django.utils.decorators import method_decorator # lint-amnesty, pylint: disable=wrong-import-order -from edx_rest_framework_extensions.auth.jwt.authentication import ( +from django.db import IntegrityError # pylint: disable=wrong-import-order +from django.db.models import Q # pylint: disable=wrong-import-order +from django.utils.decorators import method_decorator # pylint: disable=wrong-import-order +from edx_rest_framework_extensions.auth.jwt.authentication import ( # pylint: disable=wrong-import-order JwtAuthentication, -) # lint-amnesty, pylint: disable=wrong-import-order -from edx_rest_framework_extensions.auth.session.authentication import ( +) +from edx_rest_framework_extensions.auth.session.authentication import ( # pylint: disable=wrong-import-order SessionAuthenticationAllowInactiveUser, -) # lint-amnesty, pylint: disable=wrong-import-order -from opaque_keys import InvalidKeyError # lint-amnesty, pylint: disable=wrong-import-order -from opaque_keys.edx.keys import CourseKey # lint-amnesty, pylint: disable=wrong-import-order -from rest_framework import permissions, status # lint-amnesty, pylint: disable=wrong-import-order -from rest_framework.generics import ListAPIView # lint-amnesty, pylint: disable=wrong-import-order -from rest_framework.response import Response # lint-amnesty, pylint: disable=wrong-import-order -from rest_framework.throttling import UserRateThrottle # lint-amnesty, pylint: disable=wrong-import-order -from rest_framework.views import APIView # lint-amnesty, pylint: disable=wrong-import-order +) +from opaque_keys import InvalidKeyError # pylint: disable=wrong-import-order +from opaque_keys.edx.keys import CourseKey # pylint: disable=wrong-import-order +from rest_framework import permissions, status # pylint: disable=wrong-import-order +from rest_framework.generics import ListAPIView # pylint: disable=wrong-import-order +from rest_framework.response import Response # pylint: disable=wrong-import-order +from rest_framework.throttling import UserRateThrottle # pylint: disable=wrong-import-order +from rest_framework.views import APIView # pylint: disable=wrong-import-order from common.djangoapps.course_modes.models import CourseMode from common.djangoapps.student.auth import user_has_role @@ -73,7 +73,7 @@ class EnrollmentCrossDomainSessionAuth(SessionAuthenticationAllowInactiveUser, SessionAuthenticationCrossDomainCsrf): """Session authentication that allows inactive users and cross-domain requests.""" - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass class ApiKeyPermissionMixIn: @@ -226,7 +226,7 @@ def get(self, request, course_id=None, username=None): return Response( status=status.HTTP_400_BAD_REQUEST, data={ - "message": ( + "message": ( # noqa: UP032 "An error occurred while retrieving enrollments for user " "'{username}' in course '{course_id}'" ).format(username=username, course_id=course_id) @@ -281,7 +281,7 @@ def get(self, request): return Response( status=status.HTTP_400_BAD_REQUEST, data={ - "message": ("An error occurred while retrieving roles for user '{username}").format( + "message": ("An error occurred while retrieving roles for user '{username}").format( # noqa: UP032 username=request.user.username ) }, @@ -384,7 +384,7 @@ def get(self, request, course_id=None): except CourseNotFoundError: return Response( status=status.HTTP_400_BAD_REQUEST, - data={"message": ("No course found for course ID '{course_id}'").format(course_id=course_id)}, + data={"message": ("No course found for course ID '{course_id}'").format(course_id=course_id)}, # noqa: UP032 # pylint: disable=line-too-long ) @@ -662,7 +662,7 @@ def get(self, request): return Response( status=status.HTTP_400_BAD_REQUEST, data={ - "message": ("An error occurred while retrieving enrollments for user '{username}'").format( + "message": ("An error occurred while retrieving enrollments for user '{username}'").format( # noqa: UP032 # pylint: disable=line-too-long username=username ) }, @@ -746,7 +746,7 @@ def post(self, request): return Response( status=status.HTTP_403_FORBIDDEN, data={ - "message": "User does not have permission to create enrollment with mode [{mode}].".format( + "message": "User does not have permission to create enrollment with mode [{mode}].".format( # noqa: UP032 # pylint: disable=line-too-long mode=mode ) }, @@ -771,7 +771,7 @@ def post(self, request): if is_active is not None and not isinstance(is_active, bool): return Response( status=status.HTTP_400_BAD_REQUEST, - data={"message": ("'{value}' is an invalid enrollment activation status.").format(value=is_active)}, + data={"message": ("'{value}' is an invalid enrollment activation status.").format(value=is_active)}, # noqa: UP032 # pylint: disable=line-too-long ) explicit_linked_enterprise = request.data.get("linked_enterprise_customer") @@ -787,7 +787,7 @@ def post(self, request): username, course_id, ) - raise CourseEnrollmentError(str(error)) # lint-amnesty, pylint: disable=raise-missing-from + raise CourseEnrollmentError(str(error)) # pylint: disable=raise-missing-from # noqa: B904 kwargs = { "username": username, "course_id": str(course_id), @@ -802,7 +802,7 @@ def post(self, request): return Response( status=status.HTTP_400_BAD_REQUEST, data={ - "message": ("'{value}' is an invalid force enrollment status.").format(value=force_enrollment) + "message": ("'{value}' is an invalid force enrollment status.").format(value=force_enrollment) # noqa: UP032 # pylint: disable=line-too-long }, ) # Only a staff user role can enroll a user forcefully @@ -826,7 +826,7 @@ def post(self, request): return Response(status=status.HTTP_400_BAD_REQUEST, data={"message": msg}) if missing_attrs: - msg = "Missing enrollment attributes: requested mode={} required attributes={}".format( + msg = "Missing enrollment attributes: requested mode={} required attributes={}".format( # noqa: UP032 # pylint: disable=line-too-long mode, REQUIRED_ATTRIBUTES.get(mode) ) log.warning(msg) @@ -891,7 +891,7 @@ def post(self, request): return Response( status=status.HTTP_400_BAD_REQUEST, data={ - "message": ( + "message": ( # noqa: UP032 "The [{mode}] course mode is expired or otherwise unavailable for course run [{course_id}]." ).format(mode=mode, course_id=course_id), "course_details": error.data, @@ -913,7 +913,7 @@ def post(self, request): return Response( status=status.HTTP_400_BAD_REQUEST, data={ - "message": ( + "message": ( # noqa: UP032 "An error occurred while creating the new course enrollment for user " "'{username}' in course '{course_id}'" ).format(username=username, course_id=course_id) @@ -924,7 +924,7 @@ def post(self, request): log.exception("Missing cohort [%s] in course run [%s]", cohort_name, course_id) return Response( status=status.HTTP_400_BAD_REQUEST, - data={"message": "An error occured while adding to cohort [%s]" % cohort_name}, + data={"message": "An error occured while adding to cohort [%s]" % cohort_name}, # noqa: UP031 ) finally: # Assumes that the ecommerce service uses an API key to authenticate. diff --git a/openedx/core/djangoapps/external_user_ids/admin.py b/openedx/core/djangoapps/external_user_ids/admin.py index 86be19a9db96..aa998e567d48 100644 --- a/openedx/core/djangoapps/external_user_ids/admin.py +++ b/openedx/core/djangoapps/external_user_ids/admin.py @@ -1,4 +1,4 @@ -# lint-amnesty, pylint: disable=missing-module-docstring +# pylint: disable=missing-module-docstring import csv from logging import getLogger @@ -25,7 +25,7 @@ class CsvImportForm(forms.Form): @admin.register(ExternalId) -class ExternalIdAdmin(admin.ModelAdmin): # lint-amnesty, pylint: disable=missing-class-docstring +class ExternalIdAdmin(admin.ModelAdmin): # pylint: disable=missing-class-docstring change_list_template = 'admin/external_user_ids/generate_external_user_ids.html' list_display = ('user', 'external_user_id', 'external_id_type') template = 'openedx/core/djangoapps/external_user_ids/templates/admin/generate_external_ids_template.html' @@ -47,7 +47,7 @@ def _generate_results_msg(self, user_id_list, unknown_users, created_id_list, ex f'External IDs already exist for: {existing_id}\n' ) - def process_generate_ids_request(self, user_id_list, id_type, request, redirect_url): # lint-amnesty, pylint: disable=missing-function-docstring + def process_generate_ids_request(self, user_id_list, id_type, request, redirect_url): # pylint: disable=missing-function-docstring created_id_list = [] existing_id = [] @@ -55,7 +55,7 @@ def process_generate_ids_request(self, user_id_list, id_type, request, redirect_ id__in=user_id_list ) for user in user_list: - new_external_id, created = ExternalId.objects.get_or_create( # lint-amnesty, pylint: disable=unused-variable + new_external_id, created = ExternalId.objects.get_or_create( # pylint: disable=unused-variable user=user, external_id_type=id_type, ) @@ -83,7 +83,7 @@ def _render_form(self, request, form): context ) - def generate_ids_form(self, request): # lint-amnesty, pylint: disable=missing-function-docstring + def generate_ids_form(self, request): # pylint: disable=missing-function-docstring if request.method == 'POST': redirect_url = reverse( 'admin:external_user_ids_externalid_changelist', diff --git a/openedx/core/djangoapps/external_user_ids/models.py b/openedx/core/djangoapps/external_user_ids/models.py index 09fe47c4f317..6c7caf6a92db 100644 --- a/openedx/core/djangoapps/external_user_ids/models.py +++ b/openedx/core/djangoapps/external_user_ids/models.py @@ -5,7 +5,7 @@ import uuid as uuid_tools from logging import getLogger -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.db import models from model_utils.models import TimeStampedModel from simple_history.models import HistoricalRecords @@ -87,7 +87,7 @@ def add_new_user_id(cls, user, type_name): type_obj = ExternalIdType.objects.get(name=type_name) except ExternalIdType.DoesNotExist: LOGGER.info( - 'External ID Creation failed for user {user}, no external id type of {type}'.format( + 'External ID Creation failed for user {user}, no external id type of {type}'.format( # noqa: UP032 user=user.id, type=type_name ) @@ -99,7 +99,7 @@ def add_new_user_id(cls, user, type_name): ) if created: LOGGER.info( - 'External ID Created for user {user}, of type {type}'.format( + 'External ID Created for user {user}, of type {type}'.format( # noqa: UP032 user=user.id, type=type_name ) @@ -128,7 +128,7 @@ def batch_get_or_create_user_ids(cls, users, type_name): type_obj = ExternalIdType.objects.get(name=type_name) except ExternalIdType.DoesNotExist: LOGGER.info( - 'Batch ID Creation failed, no external id type of {type!r}'.format( + 'Batch ID Creation failed, no external id type of {type!r}'.format( # noqa: UP032 type=type_name ) ) diff --git a/openedx/core/djangoapps/external_user_ids/tests/factories.py b/openedx/core/djangoapps/external_user_ids/tests/factories.py index aaafe27959a9..e8e7af73d360 100644 --- a/openedx/core/djangoapps/external_user_ids/tests/factories.py +++ b/openedx/core/djangoapps/external_user_ids/tests/factories.py @@ -10,7 +10,7 @@ from openedx.core.djangoapps.external_user_ids.models import ExternalId, ExternalIdType -class ExternalIDTypeFactory(factory.django.DjangoModelFactory): # lint-amnesty, pylint: disable=missing-class-docstring +class ExternalIDTypeFactory(factory.django.DjangoModelFactory): # pylint: disable=missing-class-docstring class Meta: model = ExternalIdType @@ -18,7 +18,7 @@ class Meta: description = FuzzyText() -class ExternalIdFactory(factory.django.DjangoModelFactory): # lint-amnesty, pylint: disable=missing-class-docstring +class ExternalIdFactory(factory.django.DjangoModelFactory): # pylint: disable=missing-class-docstring class Meta: model = ExternalId diff --git a/openedx/core/djangoapps/external_user_ids/tests/test_admin_generate_id.py b/openedx/core/djangoapps/external_user_ids/tests/test_admin_generate_id.py index f629581e7892..5ec0c711c7d1 100644 --- a/openedx/core/djangoapps/external_user_ids/tests/test_admin_generate_id.py +++ b/openedx/core/djangoapps/external_user_ids/tests/test_admin_generate_id.py @@ -2,15 +2,14 @@ Test the logic behind the Generate External IDs tools in Admin """ from unittest import mock + from django.contrib.admin.sites import AdminSite from django.test import TestCase -from common.djangoapps.student.tests.factories import UserFactory -from openedx.core.djangoapps.external_user_ids.models import ( - ExternalId, -) -from openedx.core.djangoapps.external_user_ids.tests.factories import ExternalIDTypeFactory +from common.djangoapps.student.tests.factories import UserFactory from openedx.core.djangoapps.external_user_ids.admin import ExternalIdAdmin +from openedx.core.djangoapps.external_user_ids.models import ExternalId +from openedx.core.djangoapps.external_user_ids.tests.factories import ExternalIDTypeFactory class TestGenerateExternalIds(TestCase): diff --git a/openedx/core/djangoapps/external_user_ids/tests/test_batch_generate_id.py b/openedx/core/djangoapps/external_user_ids/tests/test_batch_generate_id.py index 899554599f12..5313aecb82a0 100644 --- a/openedx/core/djangoapps/external_user_ids/tests/test_batch_generate_id.py +++ b/openedx/core/djangoapps/external_user_ids/tests/test_batch_generate_id.py @@ -4,6 +4,7 @@ import django from django.test import TransactionTestCase + from common.djangoapps.student.tests.factories import UserFactory from openedx.core.djangoapps.external_user_ids.models import ExternalId from openedx.core.djangoapps.external_user_ids.tests.factories import ExternalIDTypeFactory diff --git a/openedx/core/djangoapps/geoinfo/tests/test_middleware.py b/openedx/core/djangoapps/geoinfo/tests/test_middleware.py index 45b3ab2f99fd..d309ead4732a 100644 --- a/openedx/core/djangoapps/geoinfo/tests/test_middleware.py +++ b/openedx/core/djangoapps/geoinfo/tests/test_middleware.py @@ -11,8 +11,8 @@ from django.test import TestCase from django.test.client import RequestFactory -from openedx.core.djangoapps.geoinfo.middleware import CountryMiddleware from common.djangoapps.student.tests.factories import AnonymousUserFactory, UserFactory +from openedx.core.djangoapps.geoinfo.middleware import CountryMiddleware class CountryMiddlewareTests(TestCase): diff --git a/openedx/core/djangoapps/heartbeat/default_checks.py b/openedx/core/djangoapps/heartbeat/default_checks.py index e976231fdb25..a220397e0f7a 100644 --- a/openedx/core/djangoapps/heartbeat/default_checks.py +++ b/openedx/core/djangoapps/heartbeat/default_checks.py @@ -76,7 +76,7 @@ def check_cache_set(): try: cache.set(CACHE_KEY, CACHE_VALUE, 30) return 'cache_set', True, 'OK' - except Exception as fail: # lint-amnesty, pylint: disable=broad-except + except Exception as fail: # pylint: disable=broad-except return 'cache_set', False, str(fail) @@ -94,7 +94,7 @@ def check_cache_get(): return 'cache_get', True, 'OK' else: return 'cache_get', False, 'value check failed' - except Exception as fail: # lint-amnesty, pylint: disable=broad-except + except Exception as fail: # pylint: disable=broad-except return 'cache_get', False, str(fail) @@ -119,5 +119,5 @@ def check_celery(): return 'celery', True, str({'time': finished}) sleep(0.25) return 'celery', False, "expired" - except Exception as fail: # lint-amnesty, pylint: disable=broad-except + except Exception as fail: # pylint: disable=broad-except return 'celery', False, str(fail) diff --git a/openedx/core/djangoapps/heartbeat/runchecks.py b/openedx/core/djangoapps/heartbeat/runchecks.py index 0bf0c2563b14..288ff2fb1838 100644 --- a/openedx/core/djangoapps/heartbeat/runchecks.py +++ b/openedx/core/djangoapps/heartbeat/runchecks.py @@ -35,7 +35,7 @@ def runchecks(include_extended=False): 'message': message } except ImportError as e: - raise ImproperlyConfigured(f'Error importing module {module}: "{e}"') # lint-amnesty, pylint: disable=raise-missing-from + raise ImproperlyConfigured(f'Error importing module {module}: "{e}"') # pylint: disable=raise-missing-from # noqa: B904 except AttributeError: - raise ImproperlyConfigured(f'Module "{module}" does not define a "{attr}" callable') # lint-amnesty, pylint: disable=raise-missing-from + raise ImproperlyConfigured(f'Module "{module}" does not define a "{attr}" callable') # pylint: disable=raise-missing-from # noqa: B904 return response_dict diff --git a/openedx/core/djangoapps/heartbeat/urls.py b/openedx/core/djangoapps/heartbeat/urls.py index 074eab73be9c..5547202dedf4 100644 --- a/openedx/core/djangoapps/heartbeat/urls.py +++ b/openedx/core/djangoapps/heartbeat/urls.py @@ -3,6 +3,7 @@ """ from django.urls import path + from openedx.core.djangoapps.heartbeat.views import heartbeat urlpatterns = [ diff --git a/openedx/core/djangoapps/heartbeat/views.py b/openedx/core/djangoapps/heartbeat/views.py index a3615a269e4f..5d7a0ce69c48 100644 --- a/openedx/core/djangoapps/heartbeat/views.py +++ b/openedx/core/djangoapps/heartbeat/views.py @@ -9,7 +9,6 @@ from .runchecks import runchecks - log = logging.getLogger(__name__) @@ -27,7 +26,7 @@ def heartbeat(request): for check in check_results: if not check_results[check]['status']: status_code = 503 # 503 on any failure - except Exception as e: # lint-amnesty, pylint: disable=broad-except + except Exception as e: # pylint: disable=broad-except status_code = 503 check_results = {'error': str(e)} diff --git a/openedx/core/djangoapps/lang_pref/api.py b/openedx/core/djangoapps/lang_pref/api.py index a937e81f8ee6..e3ca48b4a5a0 100644 --- a/openedx/core/djangoapps/lang_pref/api.py +++ b/openedx/core/djangoapps/lang_pref/api.py @@ -5,6 +5,7 @@ from django.conf import settings from django.utils.translation import gettext as _ + from openedx.core.djangoapps.dark_lang.models import DarkLangConfig from openedx.core.djangoapps.site_configuration.helpers import get_value @@ -78,7 +79,7 @@ def all_languages(): alphabetically. """ - languages = [(lang[0], _(lang[1])) for lang in settings.ALL_LANGUAGES] # lint-amnesty, pylint: disable=translation-of-non-string + languages = [(lang[0], _(lang[1])) for lang in settings.ALL_LANGUAGES] # pylint: disable=translation-of-non-string return sorted(languages, key=lambda lang: lang[1]) diff --git a/openedx/core/djangoapps/lang_pref/middleware.py b/openedx/core/djangoapps/lang_pref/middleware.py index 90b0535ec081..4d8e40e45161 100644 --- a/openedx/core/djangoapps/lang_pref/middleware.py +++ b/openedx/core/djangoapps/lang_pref/middleware.py @@ -39,7 +39,7 @@ def process_request(self, request): return set_user_preference(request.user, LANGUAGE_KEY, cookie_lang) else: - request._anonymous_user_cookie_lang = cookie_lang # lint-amnesty, pylint: disable=protected-access + request._anonymous_user_cookie_lang = cookie_lang # pylint: disable=protected-access accept_header = request.META.get(LANGUAGE_HEADER, None) if accept_header: @@ -56,7 +56,7 @@ def process_request(self, request): if language := get_value('LANGUAGE_CODE'): request.COOKIES[settings.LANGUAGE_COOKIE_NAME] = language - def process_response(self, request, response): # lint-amnesty, pylint: disable=missing-function-docstring + def process_response(self, request, response): # pylint: disable=missing-function-docstring # If the user is logged in, check for their language preference. Also check for real user # if current user is a masquerading user, user_pref = None diff --git a/openedx/core/djangoapps/lang_pref/tests/test_api.py b/openedx/core/djangoapps/lang_pref/tests/test_api.py index 67f2a8f52dfb..da766cb10b19 100644 --- a/openedx/core/djangoapps/lang_pref/tests/test_api.py +++ b/openedx/core/djangoapps/lang_pref/tests/test_api.py @@ -2,9 +2,10 @@ from unittest.mock import patch import ddt -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.test.utils import override_settings from django.utils import translation + from openedx.core.djangoapps.dark_lang.models import DarkLangConfig from openedx.core.djangoapps.lang_pref import api as language_api from openedx.core.djangoapps.site_configuration.tests.test_util import with_site_configuration_context diff --git a/openedx/core/djangoapps/lang_pref/tests/test_middleware.py b/openedx/core/djangoapps/lang_pref/tests/test_middleware.py index c7e2897b0c4d..eba0467fdb6c 100644 --- a/openedx/core/djangoapps/lang_pref/tests/test_middleware.py +++ b/openedx/core/djangoapps/lang_pref/tests/test_middleware.py @@ -11,10 +11,10 @@ from django.contrib.sessions.middleware import SessionMiddleware from django.http import HttpResponse from django.test.client import Client, RequestFactory -from openedx.core.lib.api.test_utils import override_settings from django.urls import reverse from django.utils.translation.trans_real import parse_accept_lang_header +from common.djangoapps.student.tests.factories import AnonymousUserFactory, UserFactory from openedx.core.djangoapps.lang_pref import COOKIE_DURATION, LANGUAGE_KEY from openedx.core.djangoapps.lang_pref.middleware import LanguagePreferenceMiddleware from openedx.core.djangoapps.site_configuration.tests.test_util import ( @@ -24,10 +24,10 @@ from openedx.core.djangoapps.user_api.preferences.api import ( delete_user_preference, get_user_preference, - set_user_preference + set_user_preference, ) from openedx.core.djangolib.testing.utils import CacheIsolationTestCase -from common.djangoapps.student.tests.factories import AnonymousUserFactory, UserFactory +from openedx.core.lib.api.test_utils import override_settings @ddt.ddt @@ -155,7 +155,7 @@ def test_preference_cookie_overrides_browser(self, logged_in, lang_cookie, accep accept_lang_out = parse_accept_lang_header(accept_lang_out) if accept_lang_out and accept_lang_result: - self.assertCountEqual(accept_lang_result, accept_lang_out) + self.assertCountEqual(accept_lang_result, accept_lang_out) # noqa: PT009 else: assert accept_lang_result == accept_lang_out diff --git a/openedx/core/djangoapps/models/course_details.py b/openedx/core/djangoapps/models/course_details.py index c90081f30a03..757eb5d7c0f9 100644 --- a/openedx/core/djangoapps/models/course_details.py +++ b/openedx/core/djangoapps/models/course_details.py @@ -11,16 +11,15 @@ from openedx.core.djangolib.markup import HTML from openedx.core.lib.courses import course_image_url -from xmodule.data import CertificatesDisplayBehaviors # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.exceptions import ItemNotFoundError # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.data import CertificatesDisplayBehaviors # pylint: disable=wrong-import-order +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order +from xmodule.modulestore.exceptions import ItemNotFoundError # pylint: disable=wrong-import-order # This list represents the attribute keys for a course's 'about' info. # Note: The 'video' attribute is intentionally excluded as it must be # handled separately; its value maps to an alternate key name. ABOUT_ATTRIBUTES = [ 'syllabus', - 'title', 'subtitle', 'duration', 'description', @@ -77,6 +76,7 @@ def __init__(self, org, course_id, run): self.self_paced = None self.learning_info = [] self.instructor_info = [] + self.has_changes = None @classmethod def fetch_about_attribute(cls, course_key, attribute): @@ -127,6 +127,7 @@ def populate(cls, block): course_details.video_thumbnail_image_asset_path = course_image_url(block, 'video_thumbnail_image') course_details.language = block.language course_details.self_paced = block.self_paced + course_details.has_changes = modulestore().has_changes(block) course_details.learning_info = block.learning_info course_details.instructor_info = block.instructor_info course_details.title = block.display_name @@ -194,126 +195,136 @@ def update_about_video(cls, course, video_id, user_id): @classmethod def update_from_json(cls, course_key, jsondict, user): # pylint: disable=too-many-statements """ - Decode the json into CourseDetails and save any changed attrs to the db + Decode the json into CourseDetails and save any changed attrs to the db. + + All writes are batched inside a single ``bulk_operations`` context so that + only one ``course_published`` signal is emitted per call, regardless of how + many individual fields were updated. Without this, every ``update_item`` / + ``delete_item`` call inside ``update_about_item`` (and the top-level block + update) each fire their own signal, causing downstream tasks to run + multiple times for a single user action. """ module_store = modulestore() - block = module_store.get_course(course_key) - dirty = False - - # In the block's setter, the date is converted to JSON - # using Date's to_json method. Calling to_json on something that - # is already JSON doesn't work. Since reaching directly into the - # model is nasty, convert the JSON Date to a Python date, which - # is what the setter expects as input. - date = Date() - - if jsondict['overview'] == '': - jsondict['overview'] = '

           

          ' - - if 'start_date' in jsondict: - converted = date.from_json(jsondict['start_date']) - else: - converted = None - if converted != block.start: - dirty = True - block.start = converted - - if 'end_date' in jsondict: - converted = date.from_json(jsondict['end_date']) - else: - converted = None - - if converted != block.end: - dirty = True - block.end = converted - - if 'enrollment_start' in jsondict: - converted = date.from_json(jsondict['enrollment_start']) - else: - converted = None - - if converted != block.enrollment_start: - dirty = True - block.enrollment_start = converted - - if 'enrollment_end' in jsondict: - converted = date.from_json(jsondict['enrollment_end']) - else: - converted = None - - if converted != block.enrollment_end: - dirty = True - block.enrollment_end = converted - - if 'certificate_available_date' in jsondict: - converted = date.from_json(jsondict['certificate_available_date']) - else: - converted = None - - if converted != block.certificate_available_date: - dirty = True - block.certificate_available_date = converted - - if ( - 'certificates_display_behavior' in jsondict - and jsondict['certificates_display_behavior'] != block.certificates_display_behavior - ): - block.certificates_display_behavior = jsondict['certificates_display_behavior'] - dirty = True - - if 'course_image_name' in jsondict and jsondict['course_image_name'] != block.course_image: - block.course_image = jsondict['course_image_name'] - dirty = True - - if 'banner_image_name' in jsondict and jsondict['banner_image_name'] != block.banner_image: - block.banner_image = jsondict['banner_image_name'] - dirty = True - - if 'video_thumbnail_image_name' in jsondict \ - and jsondict['video_thumbnail_image_name'] != block.video_thumbnail_image: - block.video_thumbnail_image = jsondict['video_thumbnail_image_name'] - dirty = True - - if 'pre_requisite_courses' in jsondict \ - and sorted(jsondict['pre_requisite_courses']) != sorted(block.pre_requisite_courses): - block.pre_requisite_courses = jsondict['pre_requisite_courses'] - dirty = True - - if 'license' in jsondict: - block.license = jsondict['license'] - dirty = True - - if 'learning_info' in jsondict: - block.learning_info = jsondict['learning_info'] - dirty = True - - if 'instructor_info' in jsondict: - block.instructor_info = jsondict['instructor_info'] - dirty = True - - if 'language' in jsondict and jsondict['language'] != block.language: - block.language = jsondict['language'] - dirty = True - - if (block.can_toggle_course_pacing - and 'self_paced' in jsondict - and jsondict['self_paced'] != block.self_paced): - block.self_paced = jsondict['self_paced'] - dirty = True - - if dirty: - module_store.update_item(block, user.id) - - # NOTE: below auto writes to the db w/o verifying that any of - # the fields actually changed to make faster, could compare - # against db or could have client send over a list of which - # fields changed. - for attribute in ABOUT_ATTRIBUTES: - if attribute in jsondict: - cls.update_about_item(block, attribute, jsondict[attribute], user.id) - - cls.update_about_video(block, jsondict['intro_video'], user.id) + with module_store.bulk_operations(course_key): + block = module_store.get_course(course_key) + + dirty = False + + # In the block's setter, the date is converted to JSON + # using Date's to_json method. Calling to_json on something that + # is already JSON doesn't work. Since reaching directly into the + # model is nasty, convert the JSON Date to a Python date, which + # is what the setter expects as input. + date = Date() + + if jsondict.get('overview') == '': + jsondict['overview'] = '

           

          ' + + if 'start_date' in jsondict: + converted = date.from_json(jsondict['start_date']) + else: + converted = None + if converted != block.start: + dirty = True + block.start = converted + + if 'end_date' in jsondict: + converted = date.from_json(jsondict['end_date']) + else: + converted = None + + if converted != block.end: + dirty = True + block.end = converted + + if 'enrollment_start' in jsondict: + converted = date.from_json(jsondict['enrollment_start']) + else: + converted = None + + if converted != block.enrollment_start: + dirty = True + block.enrollment_start = converted + + if 'enrollment_end' in jsondict: + converted = date.from_json(jsondict['enrollment_end']) + else: + converted = None + + if converted != block.enrollment_end: + dirty = True + block.enrollment_end = converted + + if 'certificate_available_date' in jsondict: + converted = date.from_json(jsondict['certificate_available_date']) + else: + converted = None + + if converted != block.certificate_available_date: + dirty = True + block.certificate_available_date = converted + + if ( + 'certificates_display_behavior' in jsondict + and jsondict['certificates_display_behavior'] != block.certificates_display_behavior + ): + block.certificates_display_behavior = jsondict['certificates_display_behavior'] + dirty = True + + if 'course_image_name' in jsondict and jsondict['course_image_name'] != block.course_image: + block.course_image = jsondict['course_image_name'] + dirty = True + + if 'banner_image_name' in jsondict and jsondict['banner_image_name'] != block.banner_image: + block.banner_image = jsondict['banner_image_name'] + dirty = True + + if 'video_thumbnail_image_name' in jsondict \ + and jsondict['video_thumbnail_image_name'] != block.video_thumbnail_image: + block.video_thumbnail_image = jsondict['video_thumbnail_image_name'] + dirty = True + + if 'pre_requisite_courses' in jsondict \ + and sorted(jsondict['pre_requisite_courses']) != sorted(block.pre_requisite_courses): + block.pre_requisite_courses = jsondict['pre_requisite_courses'] + dirty = True + + if 'license' in jsondict: + block.license = jsondict['license'] + dirty = True + + if 'learning_info' in jsondict: + block.learning_info = jsondict['learning_info'] + dirty = True + + if 'instructor_info' in jsondict: + block.instructor_info = jsondict['instructor_info'] + dirty = True + + if 'language' in jsondict and jsondict['language'] != block.language: + block.language = jsondict['language'] + dirty = True + + if (block.can_toggle_course_pacing + and 'self_paced' in jsondict + and jsondict['self_paced'] != block.self_paced): + block.self_paced = jsondict['self_paced'] + dirty = True + + if dirty: + module_store.update_item(block, user.id) + + # NOTE: below auto writes to the db w/o verifying that any of + # the fields actually changed to make faster, could compare + # against db or could have client send over a list of which + # fields changed. + for attribute in ABOUT_ATTRIBUTES: + if attribute in jsondict: + cls.update_about_item(block, attribute, jsondict[attribute], user.id) + + if 'intro_video' in jsondict: + cls.update_about_video(block, jsondict['intro_video'], user.id) # Could just return jsondict w/o doing any db reads, but I put # the reads in as a means to confirm it persisted correctly @@ -338,7 +349,7 @@ def parse_video_tag(raw_video): if keystring_matcher: return keystring_matcher.group(0) else: - logging.warn("ignoring the content because it doesn't not conform to expected pattern: " + raw_video) # lint-amnesty, pylint: disable=deprecated-method, logging-not-lazy + logging.warn("ignoring the content because it doesn't not conform to expected pattern: " + raw_video) # pylint: disable=deprecated-method, logging-not-lazy return None @staticmethod diff --git a/openedx/core/djangoapps/models/tests/test_course_details.py b/openedx/core/djangoapps/models/tests/test_course_details.py index 769499bf2353..82780e59a606 100644 --- a/openedx/core/djangoapps/models/tests/test_course_details.py +++ b/openedx/core/djangoapps/models/tests/test_course_details.py @@ -4,18 +4,20 @@ import datetime -from django.test import override_settings -import pytest -import ddt +from unittest.mock import MagicMock from zoneinfo import ZoneInfo -from xmodule.modulestore import ModuleStoreEnum +import ddt +import pytest +from django.test import override_settings + +from openedx.core.djangoapps.models.course_details import ABOUT_ATTRIBUTES, CourseDetails from xmodule.data import CertificatesDisplayBehaviors +from xmodule.modulestore import ModuleStoreEnum +from xmodule.modulestore.django import SignalHandler from xmodule.modulestore.tests.django_utils import TEST_DATA_SPLIT_MODULESTORE, ModuleStoreTestCase from xmodule.modulestore.tests.factories import CourseFactory -from openedx.core.djangoapps.models.course_details import ABOUT_ATTRIBUTES, CourseDetails - EXAMPLE_CERTIFICATE_AVAILABLE_DATE = datetime.date(2020, 1, 1) @@ -145,7 +147,7 @@ def test_fetch_about_attribute_error(self): attribute_name = 'not_an_about_attribute' with self.store.branch_setting(ModuleStoreEnum.Branch.draft_preferred, self.course.id): CourseDetails.update_about_item(self.course, attribute_name, 'test_value', self.user.id) - with pytest.raises(ValueError): + with pytest.raises(ValueError): # noqa: PT011 CourseDetails.fetch_about_attribute(self.course.id, attribute_name) def test_fetch_video(self): @@ -154,7 +156,7 @@ def test_fetch_video(self): CourseDetails.update_about_video(self.course, video_value, self.user.id) assert CourseDetails.fetch_youtube_video_id(self.course.id) == video_value video_url = CourseDetails.fetch_video_url(self.course.id) - self.assertRegex(video_url, fr'http://.*{video_value}') + self.assertRegex(video_url, fr'http://.*{video_value}') # noqa: PT009 @ddt.data( ( @@ -211,3 +213,32 @@ def test_validate_certificate_settings(self, stored_date, stored_behavior, expec assert CourseDetails.validate_certificate_settings( stored_date, stored_behavior ) == (expected_date, expected_behavior) + + def test_update_from_json_emits_course_published_signal_once(self): + """ + Verify that update_from_json emits the course_published signal exactly + once per call. + + The bulk_operations context wrapping all writes inside update_from_json + coalesces every update_item / delete_item call into a single + course_published signal emission. + """ + signal_handler = MagicMock() + SignalHandler.course_published.connect(signal_handler) + try: + jsondetails = CourseDetails.fetch(self.course.id) + jsondetails.overview = "

          Updated overview

          " + jsondetails.short_description = "Updated short description" + jsondetails.effort = "2 hours/week" + jsondetails.language = "en" + jsondetails.intro_video = None + + # ModuleStoreTestCase disables all signals by default; re-enable + # course_published for this test so we can assert on its emission. + with SignalHandler.course_published.for_state(is_enabled=True): + with self.store.branch_setting(ModuleStoreEnum.Branch.draft_preferred, self.course.id): + CourseDetails.update_from_json(self.course.id, jsondetails.__dict__, self.user) + + signal_handler.assert_called_once() + finally: + SignalHandler.course_published.disconnect(signal_handler) diff --git a/openedx/core/djangoapps/notifications/apps.py b/openedx/core/djangoapps/notifications/apps.py index ffad68eccde6..9d2ce2bf05bb 100644 --- a/openedx/core/djangoapps/notifications/apps.py +++ b/openedx/core/djangoapps/notifications/apps.py @@ -17,5 +17,5 @@ def ready(self): Import signals """ # pylint: disable=unused-import - from . import handlers - from .email import tasks + from . import handlers # noqa: F401 + from .email import tasks # noqa: F401 diff --git a/openedx/core/djangoapps/notifications/audience_filters.py b/openedx/core/djangoapps/notifications/audience_filters.py index a4be0070e7be..555b87ad0944 100644 --- a/openedx/core/djangoapps/notifications/audience_filters.py +++ b/openedx/core/djangoapps/notifications/audience_filters.py @@ -2,29 +2,27 @@ Audience based filters for notifications and Notification filters """ -from abc import abstractmethod - -from opaque_keys.edx.keys import CourseKey - import logging -from typing import List +from abc import abstractmethod +from typing import List # noqa: UP035 from django.utils import timezone +from opaque_keys.edx.keys import CourseKey from common.djangoapps.course_modes.models import CourseMode from common.djangoapps.student.models import CourseAccessRole, CourseEnrollment -from openedx.core.djangoapps.course_date_signals.utils import get_expected_duration -from common.djangoapps.student.roles import CourseStaffRole, CourseInstructorRole +from common.djangoapps.student.roles import CourseInstructorRole, CourseStaffRole from lms.djangoapps.discussion.django_comment_client.utils import get_users_with_roles from lms.djangoapps.teams.models import CourseTeam +from openedx.core.djangoapps.course_date_signals.utils import get_expected_duration from openedx.core.djangoapps.course_groups.models import CourseUserGroup from openedx.core.djangoapps.django_comment_common.models import ( FORUM_ROLE_ADMINISTRATOR, - FORUM_ROLE_MODERATOR, - FORUM_ROLE_GROUP_MODERATOR, FORUM_ROLE_COMMUNITY_TA, + FORUM_ROLE_GROUP_MODERATOR, + FORUM_ROLE_MODERATOR, FORUM_ROLE_STUDENT, - Role + Role, ) from openedx.core.djangoapps.notifications.base_notification import COURSE_NOTIFICATION_TYPES from openedx.features.course_duration_limits.models import CourseDurationLimitConfig @@ -162,7 +160,7 @@ class NotificationFilter: """ @staticmethod - def get_users_with_course_role(user_ids: List[int], course_id: str) -> List[int]: + def get_users_with_course_role(user_ids: List[int], course_id: str) -> List[int]: # noqa: UP006 """ Get users with a course role for the given course. """ @@ -172,7 +170,7 @@ def get_users_with_course_role(user_ids: List[int], course_id: str) -> List[int] ).values_list('user_id', flat=True) @staticmethod - def get_users_with_forum_roles(user_ids: List[int], course_id: str) -> List[int]: + def get_users_with_forum_roles(user_ids: List[int], course_id: str) -> List[int]: # noqa: UP006 """ Get users with forum roles for the given course. """ diff --git a/openedx/core/djangoapps/notifications/base_notification.py b/openedx/core/djangoapps/notifications/base_notification.py index de39b609a9e9..5cbee0f460b9 100644 --- a/openedx/core/djangoapps/notifications/base_notification.py +++ b/openedx/core/djangoapps/notifications/base_notification.py @@ -1,17 +1,16 @@ """ Base setup for Notification Apps and Types. """ -from typing import Any, Literal, TypedDict, NotRequired +from typing import Any, Literal, NotRequired, TypedDict from django.utils.translation import gettext_lazy as _ -from .email_notifications import EmailCadence from common.djangoapps.student.roles import CourseInstructorRole, CourseStaffRole -from .settings_override import get_notification_types_config, get_notification_apps_config - -from ..django_comment_common.models import FORUM_ROLE_ADMINISTRATOR, FORUM_ROLE_MODERATOR, FORUM_ROLE_COMMUNITY_TA +from ..django_comment_common.models import FORUM_ROLE_ADMINISTRATOR, FORUM_ROLE_COMMUNITY_TA, FORUM_ROLE_MODERATOR +from .email_notifications import EmailCadence from .notification_content import get_notification_type_context_function +from .settings_override import get_notification_apps_config, get_notification_types_config FILTER_AUDIT_EXPIRED_USERS_WITH_NO_ROLE = 'filter_audit_expired_users_with_no_role' @@ -25,11 +24,11 @@ class NotificationType(TypedDict): notification_app: str # Unique identifier for this notification type. name: str - # Mark this as a core notification. + # Whether this notification type uses the notification app's default settings. # When True, user preferences are taken from the notification app's configuration, # overriding the `web`, `email`, `push`, `email_cadence`, and `non_editable` attributes set here. use_app_defaults: bool - # Template string for notification content (see ./docs/templates.md). + # Template string for notification content. # Wrap in gettext_lazy (_) for translation support. content_template: str # A map of variable names that can be used in the template, along with their descriptions. @@ -38,8 +37,7 @@ class NotificationType(TypedDict): content_context: dict[str, Any] filters: list[str] - # All fields below are required unless `is_core` is True. - # Core notifications take this config from the associated notification app instead (and ignore anything set here). + # All fields below are required unless `use_app_defaults` is True. # Set to True to enable delivery on web. web: NotRequired[bool] @@ -60,7 +58,8 @@ class NotificationType(TypedDict): info: NotRequired[str] -# For help defining new notifications, see ./docs/creating_a_new_notification_guide.md +# For help defining new notifications, see +# https://docs.openedx.org/en/latest/site_ops/how-tos/enable_notifications.html#creating-a-new-notification _COURSE_NOTIFICATION_TYPES = { 'new_comment_on_response': { 'notification_app': 'discussion', @@ -306,9 +305,7 @@ class NotificationApp(TypedDict): Each notification type defined in COURSE_NOTIFICATION_TYPES also references an app. - Each notification type can also be optionally defined as a core notification. In this case, the delivery preferences for that notification are taken - from the `core_*` fields of the associated notification app. """ # Set to True to enable this app and linked notification types. enabled: bool @@ -366,106 +363,6 @@ class NotificationApp(TypedDict): COURSE_NOTIFICATION_APPS = get_notification_apps_config() -class NotificationTypeManager: - """ - Manager for notification types - """ - - def __init__(self): - self.notification_types = COURSE_NOTIFICATION_TYPES - - def get_notification_types_by_app(self, notification_app: str): - """ - Returns notification types for the given notification app name. - """ - return [ - notification_type.copy() for _, notification_type in self.notification_types.items() - if notification_type.get('notification_app', None) == notification_app - ] - - def get_core_and_non_core_notification_types( - self, notification_app: str - ) -> tuple[NotificationType, NotificationType]: - """ - Returns notification types for the given app name, split by core and non core. - - Return type is a tuple of (core_notification_types, non_core_notification_types). - """ - notification_types = self.get_notification_types_by_app(notification_app) - core_notification_types = [] - non_core_notification_types = [] - for notification_type in notification_types: - if notification_type.get('use_app_defaults', None): - core_notification_types.append(notification_type) - else: - non_core_notification_types.append(notification_type) - return core_notification_types, non_core_notification_types - - @staticmethod - def get_non_core_notification_type_preferences(non_core_notification_types, email_opt_out=False): - """ - Returns non-core notification type preferences for the given notification types. - """ - non_core_notification_type_preferences = {} - for notification_type in non_core_notification_types: - non_core_notification_type_preferences[notification_type.get('name')] = { - 'web': notification_type.get('web', False), - 'email': False if email_opt_out else notification_type.get('email', False), - 'push': notification_type.get('push', False), - 'email_cadence': notification_type.get('email_cadence', 'Daily'), - } - return non_core_notification_type_preferences - - def get_notification_app_preference(self, notification_app, email_opt_out=False): - """ - Returns notification app preferences for the given notification app. - """ - core_notification_types, non_core_notification_types = self.get_core_and_non_core_notification_types( - notification_app, - ) - non_core_notification_types_preferences = self.get_non_core_notification_type_preferences( - non_core_notification_types, email_opt_out - ) - core_notification_types_name = [notification_type.get('name') for notification_type in core_notification_types] - return non_core_notification_types_preferences, core_notification_types_name - - -class NotificationAppManager: - """ - Notification app manager - """ - - def add_core_notification_preference(self, notification_app_attrs, notification_types, email_opt_out=False): - """ - Adds core notification preference for the given notification app. - """ - notification_types['core'] = { - 'web': notification_app_attrs.get('web', False), - 'email': False if email_opt_out else notification_app_attrs.get('email', False), - 'push': notification_app_attrs.get('push', False), - 'email_cadence': notification_app_attrs.get('email_cadence', 'Daily'), - } - - def get_notification_app_preferences(self, email_opt_out=False): - """ - Returns notification app preferences for the given name. - """ - course_notification_preference_config = {} - for notification_app_key, notification_app_attrs in COURSE_NOTIFICATION_APPS.items(): - notification_app_preferences = {} - notification_types, core_notifications = NotificationTypeManager().get_notification_app_preference( - notification_app_key, - email_opt_out - ) - self.add_core_notification_preference(notification_app_attrs, notification_types, email_opt_out) - - notification_app_preferences['enabled'] = notification_app_attrs.get('enabled', False) - notification_app_preferences['core_notification_types'] = core_notifications - notification_app_preferences['notification_types'] = notification_types - course_notification_preference_config[notification_app_key] = notification_app_preferences - return course_notification_preference_config - - def get_notification_content(notification_type: str, context: dict[str, Any]): """ Returns notification content for the given notification type with provided context. @@ -489,8 +386,8 @@ def get_notification_content(notification_type: str, context: dict[str, Any]): if notification_type == 'course_update': notification_type = 'course_updates' - # Retrieve the notification type object from NotificationTypeManager. - notification_type = NotificationTypeManager().notification_types.get(notification_type, None) + # Retrieve the notification type object from the default preferences (derived from COURSE_NOTIFICATION_TYPES). + notification_type = get_default_values_of_preferences().get(notification_type, None) if notification_type: # Check if the notification is grouped. @@ -512,19 +409,6 @@ def get_notification_content(notification_type: str, context: dict[str, Any]): return '' -def get_default_values_of_preference(notification_app, notification_type): - """ - Returns default preference for notification_type - """ - default_prefs = NotificationAppManager().get_notification_app_preferences() - app_prefs = default_prefs.get(notification_app, {}) - core_notification_types = app_prefs.get('core_notification_types', []) - notification_types = app_prefs.get('notification_types', {}) - if notification_type in core_notification_types: - return notification_types.get('core', {}) - return notification_types.get(notification_type, {}) - - def get_default_values_of_preferences() -> dict[str, dict[str, Any]]: """ Returns default preferences for all notification apps diff --git a/openedx/core/djangoapps/notifications/config/waffle.py b/openedx/core/djangoapps/notifications/config/waffle.py index 8ea010c1717c..a17835c5f857 100644 --- a/openedx/core/djangoapps/notifications/config/waffle.py +++ b/openedx/core/djangoapps/notifications/config/waffle.py @@ -7,27 +7,27 @@ WAFFLE_NAMESPACE = 'notifications' -# .. toggle_name: notifications.enable_notifications -# .. toggle_implementation: CourseWaffleFlag +# .. toggle_name: notifications.disable_notifications +# .. toggle_implementation: WaffleFlag # .. toggle_default: False -# .. toggle_description: Waffle flag to enable the Notifications feature -# .. toggle_use_cases: temporary, open_edx -# .. toggle_creation_date: 2023-05-05 +# .. toggle_description: Waffle flag to disable the Notifications feature +# .. toggle_use_cases: open_edx +# .. toggle_creation_date: 2026-02-03 # .. toggle_target_removal_date: None -# .. toggle_warning: When the flag is ON, Notifications feature is enabled. -# .. toggle_tickets: INF-866 -ENABLE_NOTIFICATIONS = WaffleFlag(f'{WAFFLE_NAMESPACE}.enable_notifications', __name__) +# .. toggle_warning: When the flag is ON, Notifications feature is disabled. +# .. toggle_tickets: None +DISABLE_NOTIFICATIONS = WaffleFlag(f'{WAFFLE_NAMESPACE}.disable_notifications', __name__) -# .. toggle_name: notifications.enable_email_notifications +# .. toggle_name: notifications.disable_email_notifications # .. toggle_implementation: WaffleFlag # .. toggle_default: False -# .. toggle_description: Waffle flag to enable the Email Notifications feature -# .. toggle_use_cases: temporary, open_edx -# .. toggle_creation_date: 2024-03-25 -# .. toggle_target_removal_date: 2025-06-01 -# .. toggle_warning: When the flag is ON, Email Notifications feature is enabled. +# .. toggle_description: Waffle flag to disable the Email Notifications feature +# .. toggle_use_cases: open_edx +# .. toggle_creation_date: 2026-02-03 +# .. toggle_target_removal_date: None +# .. toggle_warning: When the flag is ON, Email Notifications feature will be disabled. # .. toggle_tickets: INF-1259 -ENABLE_EMAIL_NOTIFICATIONS = WaffleFlag(f'{WAFFLE_NAMESPACE}.enable_email_notifications', __name__) +DISABLE_EMAIL_NOTIFICATIONS = WaffleFlag(f'{WAFFLE_NAMESPACE}.disable_email_notifications', __name__) # .. toggle_name: notifications.enable_push_notifications # .. toggle_implementation: CourseWaffleFlag diff --git a/openedx/core/djangoapps/notifications/docs/README.rst b/openedx/core/djangoapps/notifications/docs/README.rst new file mode 100644 index 000000000000..8bf39ddbbd68 --- /dev/null +++ b/openedx/core/djangoapps/notifications/docs/README.rst @@ -0,0 +1,4 @@ +Notifications +============= + +See `docs.openedx.org `_ for more information on notifications. diff --git a/openedx/core/djangoapps/notifications/docs/creating_a_new_notification_guide.md b/openedx/core/djangoapps/notifications/docs/creating_a_new_notification_guide.md deleted file mode 100644 index 2edc5ab7ad68..000000000000 --- a/openedx/core/djangoapps/notifications/docs/creating_a_new_notification_guide.md +++ /dev/null @@ -1,132 +0,0 @@ -# Creating a new notification - -This documentation provides instructions to developers on how to add new notifications to the existing notification system. - -## Overview of terms - -* Type: every notification a user sees has a defined type. This type describes the notification's behaviour and template text. -* App: each notification type is associated with a notification app. A notification app is simply a way to group notifications, and to provide a mechanism for shared behaviour. -* Core notification: a notification type can be labelled as a core notification. In this case, the behaviour is managed at the app level, not at the level of the individual notification type. - -## Defining a notification - -The configuration consists of notification types and notification apps. Follow the steps below to define a new notification type. - -### Step 1: Define the Notification App - -The first step to defining a new notification is deciding on an app to associate it with. Either choose an existing one or create a new one in `COURSE_NOTIFICATION_APPS` in [base_notification.py](../base_notification.py). For example, here is an app named "discussion": - -```python -COURSE_NOTIFICATION_APPS = { - 'discussion': { - 'enabled': True, - 'core_info': '', - 'core_web': True, - 'core_email': True, - 'core_push': True, - 'non_editable': [], - 'core_email_cadence': 'weekly' - } -} -``` - -The app name (the key) can be any name you wish to add but ideally it should represent existing Django apps in the project. -For an explanation of the available fields, see `NotificationApp` in [base_notification.py](../base_notification.py). - -### **Step 2: Define the Notification Type** - -Now you can define the notification type itself. -To do this, add a new entry to `COURSE_NOTIFICATION_TYPES` in [base_notification.py](../base_notification.py). -For example, here is a notification defined for a new response to a discussion forum post, associated with the "discussion" app example from the previous step: - -```python -COURSE_NOTIFICATION_TYPES = { - 'new_response': { - 'notification_app': 'discussion', - 'name': 'new_response', - 'is_core': False, - 'web': True, - 'email': True, - 'push': True, - 'info': 'Response on post', - 'non_editable': [], - 'content_template': _('<{p}><{strong}>{replier_name} responded to your post <{strong}>{post_title}'), - 'content_context': { - 'post_title': 'Post title', - 'replier_name': 'replier name', - }, - 'email_template': '', - }, -} -``` - -For an explanation of the available fields, see `NotificationType` in [base_notification.py](../base_notification.py). - -### Step 3: Update the version in the model file - -Newly added types are only usable once you have updated the value of `COURSE_NOTIFICATION_CONFIG_VERSION` in [notifications/models.py](../models.py). -This constant is used to track changes in notification configuration, and whenever this version is updated preferences of users are also updated with newly available types. -To update it, increment the value by 1. - -Adding new notification types without this step will have no effect. -You don't need to update the constant for changes that are not stored in database (eg. templates). - -Now the notification type is defined and ready to use! -The next section details how to use this notification type to create and send a notification. - -## Sending a notification - -To send a notification, you need to send the `USER_NOTIFICATION_REQUESTED` signal with an instance of `UserNotificationData` containing information about the notification to send. - -Below is an example function to build and send the `new_response` notification type from earlier. - -from openedx_events.learning.signals import USER_NOTIFICATION_REQUESTED -from openedx_events.learning.data import UserNotificationData - -```python -def send_new_response_notification(user_ids, course, thread, replier_user): - notification_data = UserNotificationData( - user_ids=user_ids, - notification_type="new_response", - content_url=f"/{course.id}/posts/{thread.id}", - app_name='discussion', - course_key=course.id, - context={ - 'post_title': thread.title, - 'replier_name': replier_user.username, - }, - ) - USER_NOTIFICATION_REQUESTED.send_event(notification_data=notification_data) -``` - -Explanation of the parameters for `UserNotificationData`: - -| Name | Type | Description | -| :---- | :---- | :---- | -| `user_ids` | `list[int]` | List of user IDs to send the notification to. | -| `notification_type` | `str` | The type of notification to send. This must be a key of `COURSE_NOTIFICATION_TYPES`. | -| `content_url` | `str` | Url the user will navigate to if they click on the notification. | -| `app_name` | `str` | The app this notification is associated with. This must be a key of `COURSE_NOTIFICATION_APPS`. | -| `course_key` | `CourseKey` | The course that this notification will be associated with. | -| `context` | `dict[str, str]` | Context variables and values to pass to the notification content template. Keys are the variable names defined in the notification type. | - -That's it! You have implemented the code to send a new user notification using the `USER_NOTIFICATION_REQUESTED` signal. - -## Grouping notifications - -For some notification types, the volume for a learner can be huge and can cause annoyance. -For example, if a learner creates a post, and other learners and staff members start adding responses to his post, if for each comment, we add a response, it could result in dozens of notifications. -To avoid these scenarios, we have implemented a feature that allows grouping more than one similar notifications into a single notification. -Steps to group a notification: - -1. Enable grouping waffle flag `notifications.enable_notification_grouping`. -2. Add `group_by_id` in context before sending the `USER_NOTIFICATION_REQUESTED` event (see [discussions_notifications.py](../../../../../lms/djangoapps/discussion/rest_api/discussions_notifications.py), and search for `group_by_id` for an example). -3. Implement a grouper class to modify content_context (see [grouping_notifications.py](../grouping_notifications.py) for an example). - -## Legal - -When adding a new notification type, you will need a Privacy threshold assessment done by legal. - -## Troubleshooting - -If you have followed the above steps and notifications are still not working, check if the `notifications.enable_notifications` waffle flag is enabled. diff --git a/openedx/core/djangoapps/notifications/docs/getting-started.md b/openedx/core/djangoapps/notifications/docs/getting-started.md deleted file mode 100644 index 18a93c5b80d4..000000000000 --- a/openedx/core/djangoapps/notifications/docs/getting-started.md +++ /dev/null @@ -1,13 +0,0 @@ -# Getting started with notifications - -1. You will need to configure `NOTIFICATIONS_DEFAULT_FROM_EMAIL` to send email notifications. -2. Daily and weekly digest emails require the respective management commands to be run on a daily and weekly basis: - - daily: `manage.py lms send_email_digest Daily` - - weekly: `manage.py lms send_email_digest Weekly` - - Example crontab entries: - - ``` - 0 22 * * * ./manage.py lms send_email_digest Daily - 0 22 * * SUN ./manage.py lms send_email_digest Weekly - ``` diff --git a/openedx/core/djangoapps/notifications/docs/settings.md b/openedx/core/djangoapps/notifications/docs/settings.md deleted file mode 100644 index de39446680bd..000000000000 --- a/openedx/core/djangoapps/notifications/docs/settings.md +++ /dev/null @@ -1,85 +0,0 @@ -### How to override default notification preferences - -This document explains how to override notification preferences defaults for new users who sign up on the platform. Learn more about notification, preferences and defaults here: https://docs.openedx.org/en/latest/learners/sfd_notifications/index.html - -**Note:** These overrides will only apply to new users who sign up after the override has been configured. - -### Definitions - -**Notification:** An alert that goes out to the user as a result of some activity e.g. "Mark responded to your post" etc. - -**Notification Preference:** A per-user setting for each notification type (web, email etc.). This is explained in the table below. - -**Notification apps:** For organization purposes, notification preferences are grouped by apps/platform workflows that they are related to. As of now, we have 3 apps: discussions, grading, and updates. Note that there is no app-level on/off switch for notifications types in it. - -**App-level defaults / Bundled preferences:** Each app discussed above has a set of app-level defaults (bundled preferences). A notification type marked `use_app_defaults: True` inherits its preferences from the app's app-level defaults instead of using its own default preferences. This enables grouping several notification types under one row of preferences visible to the user. For example, in case of discussions, 7 notification types are controlled by the app-level defaults of the discussions app, which appears on the Account Settings page as a single row labeled "Activity Notifications". This reduces clutter on the settings page. - -### What you can override - -The table below lists all the preferences that you can override for each notification along with possible values. You can override defaults for both using the following dictionaries in your `lms.yml`, `cms.yml`, or `settings.py`: - -- Use `NOTIFICATION_TYPES_OVERRIDE` to override defaults for individual notification types. -- Use `NOTIFICATION_APPS_OVERRIDE` to override app-level defaults for notification types marked as `use_app_defaults: True`. Use the internal keys listed below (`web`, `email`, `push`, `email_cadence`, `non_editable`). - -| Key | Type | Possible values | What it does | -|-----|------|-----------------|--------------| -| web | bool | True OR False | Determines if the user gets notifications in the tray. | -| email | bool | True OR False | Determines if the user gets notification in email. | -| push | bool | True OR False | Determines if user gets push notification in mobile apps (not implemented) | -| email_cadence | string | 'Immediately' OR 'Daily' OR 'Weekly' OR 'Never' | Determines when a user receives email notification. | -| non_editable | list of strings | Any subset of ['web','email','push'] e.g. ['email', 'web'] | Determines toggles of which of the 3 channels will not be editable by the user. | - -Notification keys are listed in the table below. More notifications may be added in the future. You can find notification keys in this code: https://github.com/openedx/edx-platform/blob/2aeac459945e3e11c153fdb5203ea020514548d5/openedx/core/djangoapps/notifications/base_notification.py#L66 - -| # | Notification app | Notification key | uses app defaults | Appears on Account Settings page as | -|---|------------------|------------------|-------------------|-------------------------------------| -| 1 | discussion | new_response | True | Activity Notifications | -| 2 | discussion | new_comment | True | Activity Notifications | -| 3 | discussion | new_comment_on_response | True | Activity Notifications | -| 4 | discussion | response_on_followed_post | True | Activity Notifications | -| 5 | discussion | comment_on_followed_post | True | Activity Notifications | -| 6 | discussion | response_endorsed_on_thread | True | Activity Notifications | -| 7 | discussion | response_endorsed | True | Activity Notifications | -| 8 | discussion | content_reported | False | Reported content | -| 9 | discussion | new_question_post | False | New question posts | -| 10 | discussion | new_discussion_post | False | New discussion posts | -| 11 | discussion | new_instructor_all_learners_post | False | New posts from instructors | -| 12 | updates | course_updates | False | Course updates | -| 13 | grading | ora_staff_notifications | False | New ORA submission for staff | -| 14 | grading | ora_grade_assigned | False | ORA grade received | - -### Example configuration for overriding notification preferences: - -```python -NOTIFICATION_TYPES_OVERRIDE = { - # Turn off tray and turn on email notifications for new discussion posts and set daily cadence. - 'new_discussion_post': { - 'email': True, - 'web': False, - 'email_cadence': 'Daily', - }, - # Turn off email notifications for "Course Updates" and prevent users from changing it. - 'course_updates': { - 'email': False, - 'non_editable': ['email'], - } -} -``` - -### Example configuration for overriding app-level defaults for notifications marked as use_app_defaults: True - -```python -NOTIFICATION_APPS_OVERRIDE = { - # For the 'discussion' app, set tray on and email off for all app-default notifications. - 'discussion': { - 'email': False, - 'web': True, - 'email_cadence': 'Immediately', - } -} -``` - -### Why isn't my override working? - -- See if you are using the exact key name (e.g. `new_discussion_post` and not `New_discussion_post`). -- If a notification is marked as `use_app_defaults: True` in the code, it will ignore overrides in `NOTIFICATION_TYPES_OVERRIDE`. You must override using `NOTIFICATION_APPS_OVERRIDE` instead. diff --git a/openedx/core/djangoapps/notifications/docs/templates.md b/openedx/core/djangoapps/notifications/docs/templates.md deleted file mode 100644 index ffb7524afc17..000000000000 --- a/openedx/core/djangoapps/notifications/docs/templates.md +++ /dev/null @@ -1,14 +0,0 @@ - -# Notification template spec - -TODO: this needs expanding - -- Use `_(...)` to mark the template as translatable. -- Be sure to add content in `

          ...

          ` tags. Use `` to make words bold. -- Note that only `

          ` and `` are supported. - -TODO: show an example - -# Notification grouped content template spec - -TODO diff --git a/openedx/core/djangoapps/notifications/email/__init__.py b/openedx/core/djangoapps/notifications/email/__init__.py index 221a7d3426a1..f04f6a23b8c3 100644 --- a/openedx/core/djangoapps/notifications/email/__init__.py +++ b/openedx/core/djangoapps/notifications/email/__init__.py @@ -1,2 +1,2 @@ -# lint-amnesty, pylint: disable=missing-module-docstring +# pylint: disable=missing-module-docstring ONE_CLICK_EMAIL_UNSUB_KEY = "one_click_email_unsubscribe" diff --git a/openedx/core/djangoapps/notifications/email/events.py b/openedx/core/djangoapps/notifications/email/events.py index c5da45b5b6c1..fe8fa9af1ff5 100644 --- a/openedx/core/djangoapps/notifications/email/events.py +++ b/openedx/core/djangoapps/notifications/email/events.py @@ -8,7 +8,6 @@ from common.djangoapps.track import segment from openedx.core.djangoapps.notifications.base_notification import COURSE_NOTIFICATION_APPS - EMAIL_DIGEST_SENT = "edx.notifications.email_digest" diff --git a/openedx/core/djangoapps/notifications/email/tasks.py b/openedx/core/djangoapps/notifications/email/tasks.py index 2e7c802e5140..9e9367153365 100644 --- a/openedx/core/djangoapps/notifications/email/tasks.py +++ b/openedx/core/djangoapps/notifications/email/tasks.py @@ -9,7 +9,9 @@ from django.conf import settings from django.contrib.auth import get_user_model from django.db import transaction -from django.utils.translation import gettext as _, override as translation_override +from django.utils import timezone as django_timezone +from django.utils.translation import gettext as _ +from django.utils.translation import override as translation_override from edx_ace import ace from edx_ace.recipient import Recipient from edx_django_utils.monitoring import set_code_owner_attribute @@ -17,9 +19,13 @@ from openedx.core.djangoapps.notifications.email_notifications import EmailCadence from openedx.core.djangoapps.notifications.models import ( + DigestSchedule, Notification, NotificationPreference, ) + +from ..base_notification import COURSE_NOTIFICATION_APPS +from ..config.waffle import DISABLE_EMAIL_NOTIFICATIONS from .events import send_immediate_email_digest_sent_event, send_user_email_digest_sent_event from .message_type import EmailNotificationMessageType from .utils import ( @@ -32,10 +38,7 @@ get_language_preference_for_users, get_start_end_date, get_text_for_notification_type, - is_email_notification_flag_enabled, ) -from ..base_notification import COURSE_NOTIFICATION_APPS -from ..config.waffle import ENABLE_EMAIL_NOTIFICATIONS User = get_user_model() logger = get_task_logger(__name__) @@ -76,6 +79,8 @@ def send_digest_email_to_user( start_date: Datetime object end_date: Datetime object """ + if DISABLE_EMAIL_NOTIFICATIONS.is_enabled(): + return if cadence_type not in [EmailCadence.IMMEDIATELY, EmailCadence.DAILY, EmailCadence.WEEKLY]: raise ValueError('Invalid cadence_type') @@ -83,11 +88,14 @@ def send_digest_email_to_user( if not user.has_usable_password(): logger.info(f' User is disabled {user.username} ==Temp Log==') return - if not is_email_notification_flag_enabled(user): - logger.info(f' Flag disabled for {user.username} ==Temp Log==') - return - notifications = Notification.objects.filter(user=user, email=True, - created__gte=start_date, created__lte=end_date) + + notifications = Notification.objects.filter( + user=user, + email=True, + created__gte=start_date, + created__lte=end_date, + email_sent_on__isnull=True, + ) if not notifications: logger.info(f' No notification for {user.username} ==Temp Log==') return @@ -114,27 +122,340 @@ def send_digest_email_to_user( message = add_headers_to_email_message(message, message_context) message.options['skip_disable_user_policy'] = True ace.send(message) - notifications.update(email_sent_on=datetime.now()) + notifications.update(email_sent_on=django_timezone.now()) send_user_email_digest_sent_event(user, cadence_type, notifications_list, message_context) logger.info(f' Email sent to {user.username} ==Temp Log==') -@shared_task(ignore_result=True) +def get_next_digest_delivery_time(cadence_type): + """ + Calculate the next delivery time for a digest email based on cadence type. + + Uses Django settings for configurable delivery time/day: + - NOTIFICATION_DAILY_DIGEST_DELIVERY_HOUR (default: 17) + - NOTIFICATION_DAILY_DIGEST_DELIVERY_MINUTE (default: 0) + - NOTIFICATION_WEEKLY_DIGEST_DELIVERY_DAY (default: 0 = Monday) + - NOTIFICATION_WEEKLY_DIGEST_DELIVERY_HOUR (default: 17) + - NOTIFICATION_WEEKLY_DIGEST_DELIVERY_MINUTE (default: 0) + + Returns: + datetime: The next scheduled delivery time in UTC. + """ + now = django_timezone.now() + + if cadence_type == EmailCadence.DAILY: + delivery_hour = max(0, min(23, getattr(settings, 'NOTIFICATION_DAILY_DIGEST_DELIVERY_HOUR', 17))) + delivery_minute = max(0, min(59, getattr(settings, 'NOTIFICATION_DAILY_DIGEST_DELIVERY_MINUTE', 0))) + + # Calculate next delivery time + delivery_time = now.replace( + hour=delivery_hour, + minute=delivery_minute, + second=0, + microsecond=0 + ) + # If the delivery time has already passed today, schedule for tomorrow + if delivery_time <= now: + delivery_time += timedelta(days=1) + + return delivery_time + + elif cadence_type == EmailCadence.WEEKLY: + delivery_day = max(0, min(6, getattr(settings, 'NOTIFICATION_WEEKLY_DIGEST_DELIVERY_DAY', 0))) # 0=Monday + delivery_hour = max(0, min(23, getattr(settings, 'NOTIFICATION_WEEKLY_DIGEST_DELIVERY_HOUR', 17))) + delivery_minute = max(0, min(59, getattr(settings, 'NOTIFICATION_WEEKLY_DIGEST_DELIVERY_MINUTE', 0))) + + # Calculate next delivery day + days_ahead = delivery_day - now.weekday() + if days_ahead < 0: + days_ahead += 7 + + delivery_time = now.replace( + hour=delivery_hour, + minute=delivery_minute, + second=0, + microsecond=0 + ) + timedelta(days=days_ahead) + + # If the delivery time is today but has already passed, schedule for next week + if delivery_time <= now: + delivery_time += timedelta(days=7) + + return delivery_time + + raise ValueError(f"Invalid cadence_type for digest scheduling: {cadence_type}") + + +def get_digest_dedupe_key(user_id, cadence_type, delivery_time): + """ + Generate a deduplication key for a digest email task. + + This key ensures that only one digest task is scheduled per user per cadence period. + + Returns: + str: A unique key based on user_id, cadence_type, and delivery window. + """ + window_key = delivery_time.strftime('%Y-%m-%d-%H-%M') + return f"digest:{user_id}:{cadence_type}:{window_key}" + + +def is_digest_already_scheduled(user_id, cadence_type, delivery_time): + """ + Check if a digest email is already scheduled for this user in the current cadence window. + + This prevents duplicate scheduling when multiple notifications arrive + in the same digest window. + + Uses DigestSchedule model for an exact (user, cadence_type, delivery_time) lookup — + one record represents one pending Celery task. This is intentionally separate from + Notification.email_scheduled, which tracks the immediate/buffer cadence flow and + operates at the notification row level rather than the task level. + """ + if cadence_type not in [EmailCadence.DAILY, EmailCadence.WEEKLY]: + return False + + return DigestSchedule.objects.filter( + user_id=user_id, + cadence_type=cadence_type, + delivery_time=delivery_time, + ).exists() + + +def is_digest_already_sent_in_window(user_id, cadence_type, delivery_time): + """ + Check if a digest email has already been sent for this user in the current cadence window. + + This prevents duplicate emails when both cron jobs and delayed tasks co-exist. + """ + if cadence_type == EmailCadence.DAILY: + window_start = delivery_time - timedelta(days=1, minutes=15) + elif cadence_type == EmailCadence.WEEKLY: + window_start = delivery_time - timedelta(days=7, minutes=15) + else: + return False + + return Notification.objects.filter( + user_id=user_id, + email=True, + email_sent_on__gte=window_start, + email_sent_on__lte=delivery_time, + ).exists() + + +def schedule_bulk_digest_emails(user_cadence_map): + """ + Bulk-schedule delayed Celery tasks for digest emails for multiple users. + + This avoids N+1 query issues when scheduling digests for many users at once + (e.g. during send_notifications) by batching DB operations. + + Runs ~3 queries per cadence type regardless of user count: + 1. SELECT existing DigestSchedule records (1 query) + 2. Bulk INSERT new DigestSchedule records (1 query) + 3. Bulk UPDATE Notification.email_scheduled (1 query) + + Args: + user_cadence_map: dict mapping user_id -> cadence_type + (EmailCadence.DAILY or EmailCadence.WEEKLY) + """ + if not user_cadence_map: + return + + # Group users by cadence type + cadence_groups = {} + for uid, cadence in user_cadence_map.items(): + if cadence not in (EmailCadence.DAILY, EmailCadence.WEEKLY): + logger.warning(f' Invalid cadence_type {cadence} for user {uid}') + continue + cadence_groups.setdefault(cadence, []).append(uid) + + def _enqueue_bulk_digest_tasks(uids, ctype, dtime): + for uid in uids: + task_id = get_digest_dedupe_key(uid, ctype, dtime) + send_user_digest_email_task.apply_async( + kwargs={ + 'user_id': uid, + 'cadence_type': ctype, + }, + eta=dtime, + task_id=task_id, + ) + logger.info( + f' Scheduled {ctype} digest for {len(uids)} users ' + f'at {dtime}' + ) + + for cadence_type, user_ids in cadence_groups.items(): + delivery_time = get_next_digest_delivery_time(cadence_type) + + # 1. Find users who already have a DigestSchedule for this window (1 query) + already_scheduled_user_ids = set( + DigestSchedule.objects.filter( + user_id__in=user_ids, + cadence_type=cadence_type, + delivery_time=delivery_time, + ).values_list('user_id', flat=True) + ) + + new_user_ids = [uid for uid in user_ids if uid not in already_scheduled_user_ids] + if not new_user_ids: + logger.info( + f' All {len(user_ids)} users already scheduled ' + f'for cadence={cadence_type}, delivery_time={delivery_time}' + ) + continue + + # 2. Bulk create DigestSchedule records for new users (1 query) + new_schedules = [ + DigestSchedule( + user_id=uid, + cadence_type=cadence_type, + delivery_time=delivery_time, + task_id=get_digest_dedupe_key(uid, cadence_type, delivery_time), + ) + for uid in new_user_ids + ] + DigestSchedule.objects.bulk_create(new_schedules, ignore_conflicts=True) + + # 3. Bulk mark unscheduled notifications as scheduled (1 query) + if cadence_type == EmailCadence.DAILY: + window_start = delivery_time - timedelta(days=1) + else: + window_start = delivery_time - timedelta(days=7) + + Notification.objects.filter( + user_id__in=new_user_ids, + email=True, + email_scheduled=False, + email_sent_on__isnull=True, + created__gte=window_start, + ).update(email_scheduled=True) + + # 4. Enqueue Celery tasks for each new user (no DB queries) + transaction.on_commit( + lambda uids=new_user_ids, ctype=cadence_type, dtime=delivery_time: + _enqueue_bulk_digest_tasks(uids, ctype, dtime) + ) + + +@shared_task(bind=True, ignore_result=True, max_retries=3, default_retry_delay=300) @set_code_owner_attribute -def send_digest_email_to_all_users(cadence_type): +def send_user_digest_email_task(self, user_id, cadence_type): """ - Send email digest to all eligible users + Delayed Celery task to send a digest email to a single user. + + This task is scheduled with apply_async(eta=...) for the configured + delivery time. When it fires: + 1. Atomically claims the DigestSchedule record (prevents duplicate + execution from Redis visibility-timeout redeliveries) + 2. Checks if email was already sent (by cron job) to avoid duplicates + 3. Gathers all unsent notifications for the cadence window + 4. Sends the digest email + 5. Marks notifications as sent """ - logger.info(f' Sending cadence email of type {cadence_type}') - users = get_audience_for_cadence_email(cadence_type) - language_prefs = get_language_preference_for_users([user.id for user in users]) - courses_data = {} - start_date, end_date = get_start_end_date(cadence_type) - logger.info(f' Email Cadence Audience {len(users)}') - for user in users: - user_language = language_prefs.get(user.id, 'en') - send_digest_email_to_user(user, cadence_type, start_date, end_date, user_language=user_language, - courses_data=courses_data) + try: + claimed = _claim_digest_schedule(user_id, cadence_type) + if not claimed: + logger.info( + f' Duplicate task for user {user_id}, ' + f'cadence {cadence_type} — DigestSchedule already ' + f'claimed by another task. Skipping.' + ) + return + + user = User.objects.get(id=user_id) + + if not user.has_usable_password(): + logger.info(f' User {user.username} is disabled, skipping') + return + start_date, end_date = get_start_end_date(cadence_type) + + already_sent = Notification.objects.filter( + user_id=user_id, + email=True, + email_sent_on__gte=start_date, + email_sent_on__lte=end_date, + ).exists() + + if already_sent: + logger.info( + f' Digest already sent for user {user.username} ' + f'in window {start_date} to {end_date}. Clearing scheduled flags.' + ) + # Clear scheduled flags so they're not picked up again + Notification.objects.filter( + user_id=user_id, + email=True, + email_scheduled=True, + created__gte=start_date, + created__lte=end_date, + ).update(email_scheduled=False) + return + + language_prefs = get_language_preference_for_users([user_id]) + user_language = language_prefs.get(user_id, 'en') + courses_data = {} + + send_digest_email_to_user( + user, cadence_type, start_date, end_date, + user_language=user_language, + courses_data=courses_data + ) + + # Clear scheduled flags after successful send + Notification.objects.filter( + user_id=user_id, + email=True, + email_scheduled=True, + created__gte=start_date, + created__lte=end_date, + ).update(email_scheduled=False) + + logger.info(f' Successfully sent {cadence_type} digest to user {user.username}') + + except User.DoesNotExist: + logger.error(f' User {user_id} not found') + + except Exception as exc: + current_retries = getattr(self.request, "retries", 0) + max_retries = getattr(self, "max_retries", None) + if max_retries and current_retries >= max_retries - 1: + logger.error( + f' Giving up sending {cadence_type} digest to user {user_id} ' + f'after {current_retries} retries.' + ) + return + retry_countdown = 300 * (2 ** current_retries) + raise self.retry(exc=exc, countdown=retry_countdown) from exc + + +def _claim_digest_schedule(user_id, cadence_type): + """ + Atomically claim (delete) the DigestSchedule record for the current + delivery window. + + Returns ``True`` if this call deleted the row (we are the rightful + owner). Returns ``False`` if the row was already gone (another copy + of the redelivered task got there first). + """ + now = django_timezone.now() + + if cadence_type == EmailCadence.DAILY: + window_cutoff = now - timedelta(days=1, hours=1) + elif cadence_type == EmailCadence.WEEKLY: + window_cutoff = now - timedelta(days=7, hours=1) + else: + return True # non-digest cadences don't use DigestSchedule + + with transaction.atomic(): + rows_deleted, _ = DigestSchedule.objects.filter( + user_id=user_id, + cadence_type=cadence_type, + delivery_time__lte=now, + delivery_time__gte=window_cutoff, + ).delete() + + return rows_deleted > 0 def send_immediate_cadence_email(email_notification_mapping, course_key): @@ -147,19 +468,21 @@ def send_immediate_cadence_email(email_notification_mapping, course_key): 2. Second notification → Schedule buffer job (15 min) 3. Third+ notifications → Just mark as scheduled (no new job) """ + if DISABLE_EMAIL_NOTIFICATIONS.is_enabled(): + return + if not email_notification_mapping: return user_list = email_notification_mapping.keys() users = list(User.objects.filter(id__in=user_list)) language_prefs = get_language_preference_for_users(user_list) course_name = get_course_info(course_key).get("name", course_key) + for user in users: if not user.has_usable_password(): logger.info(f' User is disabled {user.username}') continue - if not is_email_notification_flag_enabled(user): - logger.info(f' Flag disabled for {user.username}') - continue + notification = email_notification_mapping.get(user.id, None) if not notification: logger.info(f' No notification for {user.username}') @@ -394,7 +717,7 @@ def send_buffered_digest( """ try: # Re-check feature flags - if not ENABLE_EMAIL_NOTIFICATIONS.is_enabled(): + if DISABLE_EMAIL_NOTIFICATIONS.is_enabled(): logger.info('Email notifications disabled, cancelling digest') return @@ -497,4 +820,4 @@ def send_buffered_digest( except Exception as exc: logger.exception(f'Email Buffered Digest: Failed to send buffered digest: {exc}') retry_countdown = 60 * (2 ** self.request.retries) - raise self.retry(exc=exc, countdown=retry_countdown) + raise self.retry(exc=exc, countdown=retry_countdown) # noqa: B904 diff --git a/openedx/core/djangoapps/notifications/email/tests/test_tasks.py b/openedx/core/djangoapps/notifications/email/tests/test_tasks.py index 4fdcf1aaf04e..f97f63f64ac1 100644 --- a/openedx/core/djangoapps/notifications/email/tests/test_tasks.py +++ b/openedx/core/djangoapps/notifications/email/tests/test_tasks.py @@ -1,11 +1,12 @@ """ Test cases for notifications/email/tasks.py """ -import datetime -from datetime import datetime, timedelta + +from datetime import UTC, datetime, timedelta from unittest.mock import Mock, patch import ddt +import pytest from django.contrib.auth import get_user_model from django.test import override_settings from django.utils import timezone @@ -13,28 +14,33 @@ from freezegun import freeze_time from common.djangoapps.student.tests.factories import UserFactory -from openedx.core.djangoapps.notifications.config.waffle import ENABLE_EMAIL_NOTIFICATIONS, ENABLE_NOTIFICATIONS from openedx.core.djangoapps.notifications.email.tasks import ( + _claim_digest_schedule, add_to_existing_buffer, decide_email_action, - get_audience_for_cadence_email, + get_next_digest_delivery_time, + is_digest_already_scheduled, + is_digest_already_sent_in_window, + schedule_bulk_digest_emails, schedule_digest_buffer, send_buffered_digest, - send_digest_email_to_all_users, send_digest_email_to_user, send_immediate_cadence_email, - send_immediate_email + send_immediate_email, + send_user_digest_email_task, ) from openedx.core.djangoapps.notifications.email.utils import get_start_end_date from openedx.core.djangoapps.notifications.email_notifications import EmailCadence from openedx.core.djangoapps.notifications.models import ( + DigestSchedule, Notification, - NotificationPreference + NotificationPreference, ) from openedx.core.djangoapps.notifications.tasks import send_notifications from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase from xmodule.modulestore.tests.factories import CourseFactory +from ...config.waffle import DISABLE_EMAIL_NOTIFICATIONS from .utils import create_notification User = get_user_model() @@ -57,25 +63,24 @@ def setUp(self): @patch('edx_ace.ace.send') def test_email_is_not_sent_if_no_notifications(self, mock_func): """ - Tests email is sent iff waffle flag is enabled + Tests that no email is sent when there are no notifications for the user """ start_date, end_date = get_start_end_date(EmailCadence.DAILY) - with override_waffle_flag(ENABLE_EMAIL_NOTIFICATIONS, True): - send_digest_email_to_user(self.user, EmailCadence.DAILY, start_date, end_date) + send_digest_email_to_user(self.user, EmailCadence.DAILY, start_date, end_date) assert not mock_func.called @ddt.data(True, False) @patch('edx_ace.ace.send') - def test_email_is_sent_iff_flag_enabled(self, flag_value, mock_func): + def test_email_is_sent_if_flag_disabled(self, flag_value, mock_func): """ - Tests email is sent iff waffle flag is enabled + Tests email is sent if waffle flag is disabled """ created_date = datetime.now() - timedelta(days=1) create_notification(self.user, self.course.id, created=created_date) start_date, end_date = get_start_end_date(EmailCadence.DAILY) - with override_waffle_flag(ENABLE_EMAIL_NOTIFICATIONS, flag_value): + with override_waffle_flag(DISABLE_EMAIL_NOTIFICATIONS, flag_value): send_digest_email_to_user(self.user, EmailCadence.DAILY, start_date, end_date) - assert mock_func.called is flag_value + assert mock_func.called is not flag_value @patch('edx_ace.ace.send') def test_notification_not_send_if_created_on_next_day(self, mock_func): @@ -84,8 +89,7 @@ def test_notification_not_send_if_created_on_next_day(self, mock_func): """ start_date, end_date = get_start_end_date(EmailCadence.DAILY) create_notification(self.user, self.course.id, created=end_date + timedelta(minutes=2)) - with override_waffle_flag(ENABLE_EMAIL_NOTIFICATIONS, True): - send_digest_email_to_user(self.user, EmailCadence.DAILY, start_date, end_date) + send_digest_email_to_user(self.user, EmailCadence.DAILY, start_date, end_date) assert not mock_func.called @ddt.data(True, False) @@ -101,8 +105,7 @@ def test_email_not_send_to_disable_user(self, value, mock_func): self.user.set_password("12345678") else: self.user.set_unusable_password() - with override_waffle_flag(ENABLE_EMAIL_NOTIFICATIONS, True): - send_digest_email_to_user(self.user, EmailCadence.DAILY, start_date, end_date) + send_digest_email_to_user(self.user, EmailCadence.DAILY, start_date, end_date) assert mock_func.called is value @patch('edx_ace.ace.send') @@ -113,8 +116,7 @@ def test_notification_not_send_if_created_day_before_yesterday(self, mock_func): start_date, end_date = get_start_end_date(EmailCadence.DAILY) created_date = datetime.now() - timedelta(days=1, minutes=18) create_notification(self.user, self.course.id, created=created_date) - with override_waffle_flag(ENABLE_EMAIL_NOTIFICATIONS, True): - send_digest_email_to_user(self.user, EmailCadence.DAILY, start_date, end_date) + send_digest_email_to_user(self.user, EmailCadence.DAILY, start_date, end_date) assert not mock_func.called @ddt.data( @@ -135,8 +137,7 @@ def test_notification_content(self, cadence_type, created_time, notification_cre """ start_date, end_date = get_start_end_date(cadence_type) create_notification(self.user, self.course.id, created=created_time) - with override_waffle_flag(ENABLE_EMAIL_NOTIFICATIONS, True): - send_digest_email_to_user(self.user, EmailCadence.DAILY, start_date, end_date) + send_digest_email_to_user(self.user, EmailCadence.DAILY, start_date, end_date) assert mock_func.called is notification_created @@ -160,22 +161,21 @@ def test_email_is_not_sent_if_no_notifications(self, mock_func): Tests email is sent iff waffle flag is enabled """ start_date, end_date = get_start_end_date(EmailCadence.DAILY) - with override_waffle_flag(ENABLE_EMAIL_NOTIFICATIONS, True): - send_digest_email_to_user(self.user, EmailCadence.DAILY, start_date, end_date) + send_digest_email_to_user(self.user, EmailCadence.DAILY, start_date, end_date) assert not mock_func.called @ddt.data(True, False) @patch('edx_ace.ace.send') - def test_email_is_sent_iff_flag_enabled(self, flag_value, mock_func): + def test_email_is_sent_if_flag_disabled(self, flag_value, mock_func): """ - Tests email is sent iff waffle flag is enabled + Tests email is sent iff waffle flag is disabled """ created_date = datetime.now() - timedelta(days=1) create_notification(self.user, self.course.id, created=created_date) start_date, end_date = get_start_end_date(EmailCadence.DAILY) - with override_waffle_flag(ENABLE_EMAIL_NOTIFICATIONS, flag_value): + with override_waffle_flag(DISABLE_EMAIL_NOTIFICATIONS, flag_value): send_digest_email_to_user(self.user, EmailCadence.DAILY, start_date, end_date) - assert mock_func.called is flag_value + assert mock_func.called is not flag_value @patch('edx_ace.ace.send') def test_notification_not_send_if_created_on_next_day(self, mock_func): @@ -184,8 +184,7 @@ def test_notification_not_send_if_created_on_next_day(self, mock_func): """ start_date, end_date = get_start_end_date(EmailCadence.DAILY) create_notification(self.user, self.course.id, created=end_date + timedelta(minutes=2)) - with override_waffle_flag(ENABLE_EMAIL_NOTIFICATIONS, True): - send_digest_email_to_user(self.user, EmailCadence.DAILY, start_date, end_date) + send_digest_email_to_user(self.user, EmailCadence.DAILY, start_date, end_date) assert not mock_func.called @ddt.data(True, False) @@ -201,8 +200,7 @@ def test_email_not_send_to_disable_user(self, value, mock_func): self.user.set_password("12345678") else: self.user.set_unusable_password() - with override_waffle_flag(ENABLE_EMAIL_NOTIFICATIONS, True): - send_digest_email_to_user(self.user, EmailCadence.DAILY, start_date, end_date) + send_digest_email_to_user(self.user, EmailCadence.DAILY, start_date, end_date) assert mock_func.called is value @patch('edx_ace.ace.send') @@ -213,8 +211,7 @@ def test_notification_not_send_if_created_day_before_yesterday(self, mock_func): start_date, end_date = get_start_end_date(EmailCadence.DAILY) created_date = datetime.now() - timedelta(days=1, minutes=18) create_notification(self.user, self.course.id, created=created_date) - with override_waffle_flag(ENABLE_EMAIL_NOTIFICATIONS, True): - send_digest_email_to_user(self.user, EmailCadence.DAILY, start_date, end_date) + send_digest_email_to_user(self.user, EmailCadence.DAILY, start_date, end_date) assert not mock_func.called @ddt.data( @@ -235,85 +232,10 @@ def test_notification_content(self, cadence_type, created_time, notification_cre """ start_date, end_date = get_start_end_date(cadence_type) create_notification(self.user, self.course.id, created=created_time) - with override_waffle_flag(ENABLE_EMAIL_NOTIFICATIONS, True): - send_digest_email_to_user(self.user, EmailCadence.DAILY, start_date, end_date) + send_digest_email_to_user(self.user, EmailCadence.DAILY, start_date, end_date) assert mock_func.called is notification_created -@ddt.ddt -class TestEmailDigestAudience(ModuleStoreTestCase): - """ - Tests audience for notification digest email - """ - - def setUp(self): - """ - Setup - """ - super().setUp() - self.user = UserFactory() - self.course = CourseFactory.create(display_name='test course', run="Testing_course") - - @patch('openedx.core.djangoapps.notifications.email.tasks.send_digest_email_to_user') - def test_email_func_not_called_if_no_notification(self, mock_func): - """ - Tests email sending function is not called if user has no notifications - """ - with override_waffle_flag(ENABLE_EMAIL_NOTIFICATIONS, True): - send_digest_email_to_all_users(EmailCadence.DAILY) - assert not mock_func.called - - @patch('openedx.core.djangoapps.notifications.email.tasks.send_digest_email_to_user') - def test_email_func_called_if_user_has_notification(self, mock_func): - """ - Tests email sending function is called if user has notification - """ - created_date = datetime.now() - timedelta(days=1) - create_notification(self.user, self.course.id, created=created_date) - with override_waffle_flag(ENABLE_EMAIL_NOTIFICATIONS, True): - send_digest_email_to_all_users(EmailCadence.DAILY) - assert mock_func.called - - @patch('openedx.core.djangoapps.notifications.email.tasks.send_digest_email_to_user') - def test_email_func_not_called_if_user_notification_is_not_duration(self, mock_func): - """ - Tests email sending function is not called if user has notification - which is not in duration - """ - created_date = datetime.now() - timedelta(days=10) - create_notification(self.user, self.course.id, created=created_date) - with override_waffle_flag(ENABLE_EMAIL_NOTIFICATIONS, True): - send_digest_email_to_all_users(EmailCadence.DAILY) - assert not mock_func.called - - @patch('edx_ace.ace.send') - def test_email_is_sent_to_user_when_task_is_called(self, mock_func): - created_date = datetime.now() - timedelta(days=1) - create_notification(self.user, self.course.id, created=created_date) - with override_waffle_flag(ENABLE_EMAIL_NOTIFICATIONS, True): - send_digest_email_to_all_users(EmailCadence.DAILY) - assert mock_func.called - assert mock_func.call_count == 1 - - def test_audience_query_count(self): - with self.assertNumQueries(1): - audience = get_audience_for_cadence_email(EmailCadence.DAILY) - list(audience) # evaluating queryset - - @ddt.data(True, False) - @patch('edx_ace.ace.send') - def test_digest_should_contain_email_enabled_notifications(self, email_value, mock_func): - """ - Tests email is sent only when notifications with email=True exists - """ - start_date, end_date = get_start_end_date(EmailCadence.DAILY) - created_date = datetime.now() - timedelta(hours=23, minutes=59) - create_notification(self.user, self.course.id, created=created_date, email=email_value) - with override_waffle_flag(ENABLE_EMAIL_NOTIFICATIONS, True): - send_digest_email_to_user(self.user, EmailCadence.DAILY, start_date, end_date) - assert mock_func.called is email_value - - @ddt.ddt class TestAccountPreferences(ModuleStoreTestCase): """ @@ -341,8 +263,7 @@ def test_email_send_for_digest_preference(self, mock_func): self.preference.email = True self.preference.email_cadence = EmailCadence.DAILY self.preference.save() - with override_waffle_flag(ENABLE_EMAIL_NOTIFICATIONS, True): - send_digest_email_to_user(self.user, EmailCadence.DAILY, start_date, end_date) + send_digest_email_to_user(self.user, EmailCadence.DAILY, start_date, end_date) assert mock_func.called @ddt.data(True, False) @@ -355,8 +276,7 @@ def test_email_send_for_email_preference_value(self, pref_value, mock_func): self.preference.email = pref_value self.preference.email_cadence = EmailCadence.DAILY self.preference.save() - with override_waffle_flag(ENABLE_EMAIL_NOTIFICATIONS, True): - send_digest_email_to_user(self.user, EmailCadence.DAILY, start_date, end_date) + send_digest_email_to_user(self.user, EmailCadence.DAILY, start_date, end_date) assert mock_func.called is pref_value @patch('edx_ace.ace.send') @@ -368,8 +288,7 @@ def test_email_not_send_if_different_digest_preference(self, mock_func): self.preference.email = True self.preference.email_cadence = EmailCadence.WEEKLY self.preference.save() - with override_waffle_flag(ENABLE_EMAIL_NOTIFICATIONS, True): - send_digest_email_to_user(self.user, EmailCadence.DAILY, start_date, end_date) + send_digest_email_to_user(self.user, EmailCadence.DAILY, start_date, end_date) assert not mock_func.called @@ -418,25 +337,23 @@ def test_email_sent_when_cadence_is_immediate(self, mock_ace_send): 'post_title': 'title' } - with ( - override_waffle_flag(ENABLE_NOTIFICATIONS, True), - override_waffle_flag(ENABLE_EMAIL_NOTIFICATIONS, True) - ): - send_notifications( - [self.user.id], - str(self.course.id), - 'discussion', - 'new_discussion_post', - context, - 'http://test.url' - ) + send_notifications( + [self.user.id], + str(self.course.id), + 'discussion', + 'new_discussion_post', + context, + 'http://test.url' + ) assert mock_ace_send.call_count == 1 + @patch('openedx.core.djangoapps.notifications.email.tasks.send_user_digest_email_task.apply_async') @patch('edx_ace.ace.send') - def test_email_not_sent_when_cadence_is_not_immediate(self, mock_ace_send): + def test_email_not_sent_when_cadence_is_not_immediate(self, mock_ace_send, mock_apply_async): """ Tests that an email is NOT sent via send_notifications when cadence is DAILY. + The digest is scheduled for later delivery — ace.send must not be called immediately. """ # Modify preference for this test case self.preference.email = True @@ -447,19 +364,14 @@ def test_email_not_sent_when_cadence_is_not_immediate(self, mock_ace_send): 'replier_name': 'User', 'post_title': 'title' } - - with ( - override_waffle_flag(ENABLE_NOTIFICATIONS, True), - override_waffle_flag(ENABLE_EMAIL_NOTIFICATIONS, True) - ): - send_notifications( - [self.user.id], - str(self.course.id), - 'discussion', - 'new_response', - context, - 'http://test.url' - ) + send_notifications( + [self.user.id], + str(self.course.id), + 'discussion', + 'new_response', + context, + 'http://test.url' + ) assert mock_ace_send.call_count == 0 @@ -530,7 +442,7 @@ def test_third_notification_adds_to_buffer(self): assert decision == 'add_to_buffer' @freeze_time("2025-12-15 10:00:00") - @override_settings(NOTIFICATION_EMAIL_BUFFER_MINUTES=15) + @override_settings(NOTIFICATION_IMMEDIATE_EMAIL_BUFFER_MINUTES=15) def test_old_email_triggers_new_immediate_send(self): """Test that email sent outside buffer period triggers new immediate send.""" # Email sent 20 minutes ago (outside 15-minute buffer) @@ -570,7 +482,7 @@ def test_race_condition_protection(self): notification2 = self._create_notification() # Both should see no recent email initially - with patch('openedx.core.djangoapps.notifications.email.tasks.logger') as mock_logger: + with patch('openedx.core.djangoapps.notifications.email.tasks.logger') as mock_logger: # noqa: F841 decision1 = decide_email_action(self.user, self.course_key, notification1) # Mark first as sent to simulate race @@ -655,7 +567,7 @@ def setUp(self): @freeze_time("2025-12-15 10:00:00", tz_offset=0) @patch('openedx.core.djangoapps.notifications.email.tasks.send_buffered_digest.apply_async') - @override_settings(NOTIFICATION_EMAIL_BUFFER_MINUTES=15) + @override_settings(NOTIFICATION_IMMEDIATE_EMAIL_BUFFER_MINUTES=15) def test_buffer_scheduled_with_correct_delay(self, mock_apply_async): """Test that buffer task is scheduled with correct countdown.""" # Create notification that was sent 5 minutes ago @@ -766,7 +678,7 @@ def test_notification_marked_as_scheduled(self): assert notification.email_scheduled is True def test_only_scheduled_field_updated(self): - """Test that only email_scheduled field is updated.""" + """Test that only email_scheduled field is updated, other fields remain unchanged.""" notification = Notification.objects.create( user=self.user, course_id=str(self.course.id), @@ -776,12 +688,16 @@ def test_only_scheduled_field_updated(self): email=True, content_context=get_new_post_notification_content_context() ) + original_content_url = notification.content_url + original_email_sent_on = notification.email_sent_on add_to_existing_buffer(notification) notification.refresh_from_db() - assert 'Hello world' in notification.content assert notification.email_scheduled is True + assert notification.content_url == original_content_url + assert notification.email_sent_on == original_email_sent_on + assert notification.email is True @ddt.ddt @@ -824,14 +740,12 @@ def test_digest_collects_all_scheduled_notifications(self, mock_ace_send): created=start_time + timedelta(minutes=i * 5) ) - with override_waffle_flag(ENABLE_NOTIFICATIONS, True): - with override_waffle_flag(ENABLE_EMAIL_NOTIFICATIONS, True): - send_buffered_digest( # pylint: disable=no-value-for-parameter - user_id=self.user.id, - course_key=self.course_key, - start_date=start_time, - user_language='en' - ) + send_buffered_digest( # pylint: disable=no-value-for-parameter + user_id=self.user.id, + course_key=self.course_key, + start_date=start_time, + user_language='en' + ) # Verify email was sent assert mock_ace_send.called @@ -877,14 +791,12 @@ def test_digest_skips_non_scheduled_notifications(self, mock_ace_send): created=start_time + timedelta(minutes=10) ) - with override_waffle_flag(ENABLE_NOTIFICATIONS, True): - with override_waffle_flag(ENABLE_EMAIL_NOTIFICATIONS, True): - send_buffered_digest( # pylint: disable=no-value-for-parameter - user_id=self.user.id, - course_key=self.course_key, - start_date=start_time, - user_language='en' - ) + send_buffered_digest( # pylint: disable=no-value-for-parameter + user_id=self.user.id, + course_key=self.course_key, + start_date=start_time, + user_language='en' + ) # Only 1 notification should be marked as sent sent_count = Notification.objects.filter( @@ -921,14 +833,12 @@ def test_digest_respects_user_preferences(self, mock_ace_send): created=start_time + timedelta(minutes=5) ) - with override_waffle_flag(ENABLE_NOTIFICATIONS, True): - with override_waffle_flag(ENABLE_EMAIL_NOTIFICATIONS, True): - send_buffered_digest( # pylint: disable=no-value-for-parameter - user_id=self.user.id, - course_key=self.course_key, - start_date=start_time, - user_language='en' - ) + send_buffered_digest( # pylint: disable=no-value-for-parameter + user_id=self.user.id, + course_key=self.course_key, + start_date=start_time, + user_language='en' + ) # Email should not be sent assert not mock_ace_send.called @@ -944,15 +854,13 @@ def test_digest_handles_missing_user(self): """Test that digest handles non-existent user gracefully.""" start_time = timezone.now() - timedelta(minutes=15) - with override_waffle_flag(ENABLE_NOTIFICATIONS, True): - with override_waffle_flag(ENABLE_EMAIL_NOTIFICATIONS, True): - # Should not raise exception - send_buffered_digest( # pylint: disable=no-value-for-parameter - user_id=99999, # Non-existent - course_key=self.course_key, - start_date=start_time, - user_language='en' - ) + # Should not raise exception + send_buffered_digest( # pylint: disable=no-value-for-parameter + user_id=99999, # Non-existent + course_key=self.course_key, + start_date=start_time, + user_language='en' + ) @patch('openedx.core.djangoapps.notifications.email.tasks.ace.send', side_effect=Exception('Email failed')) def test_digest_retries_on_failure(self, mock_ace_send): @@ -971,19 +879,17 @@ def test_digest_retries_on_failure(self, mock_ace_send): created=start_time + timedelta(minutes=5) ) - with override_waffle_flag(ENABLE_NOTIFICATIONS, True): - with override_waffle_flag(ENABLE_EMAIL_NOTIFICATIONS, True): - # Create a mock task instance - mock_task = Mock() - mock_task.request.retries = 0 + # Create a mock task instance + mock_task = Mock() + mock_task.request.retries = 0 - with self.assertRaises(Exception): - send_buffered_digest.bind(mock_task)( - user_id=self.user.id, - course_key=self.course_key, - start_date=start_time, - user_language='en' - ) + with self.assertRaises(Exception): # noqa: B017, PT027 + send_buffered_digest.bind(mock_task)( + user_id=self.user.id, + course_key=self.course_key, + start_date=start_time, + user_language='en' + ) @ddt.ddt @@ -1007,7 +913,7 @@ def setUp(self): @freeze_time("2025-12-15 10:00:00") @patch('openedx.core.djangoapps.notifications.email.tasks.ace.send') @patch('openedx.core.djangoapps.notifications.email.tasks.send_buffered_digest.apply_async') - @override_settings(NOTIFICATION_EMAIL_BUFFER_MINUTES=15) + @override_settings(NOTIFICATION_IMMEDIATE_EMAIL_BUFFER_MINUTES=15) def test_complete_three_notification_flow(self, mock_digest_async, mock_ace_send): """Test complete flow: immediate → buffer → add to buffer.""" email_mapping = {} @@ -1024,9 +930,7 @@ def test_complete_three_notification_flow(self, mock_digest_async, mock_ace_send ) email_mapping[self.user.id] = notif1 - with override_waffle_flag(ENABLE_NOTIFICATIONS, True): - with override_waffle_flag(ENABLE_EMAIL_NOTIFICATIONS, True): - send_immediate_cadence_email(email_mapping, self.course.id) + send_immediate_cadence_email(email_mapping, self.course.id) # Verify immediate email sent assert mock_ace_send.call_count == 1 @@ -1049,9 +953,7 @@ def test_complete_three_notification_flow(self, mock_digest_async, mock_ace_send ) email_mapping = {self.user.id: notif2} - with override_waffle_flag(ENABLE_NOTIFICATIONS, True): - with override_waffle_flag(ENABLE_EMAIL_NOTIFICATIONS, True): - send_immediate_cadence_email(email_mapping, self.course.id) + send_immediate_cadence_email(email_mapping, self.course.id) # Verify buffer scheduled assert mock_ace_send.call_count == 1 # Still just 1 immediate email @@ -1074,9 +976,7 @@ def test_complete_three_notification_flow(self, mock_digest_async, mock_ace_send ) email_mapping = {self.user.id: notif3} - with override_waffle_flag(ENABLE_NOTIFICATIONS, True): - with override_waffle_flag(ENABLE_EMAIL_NOTIFICATIONS, True): - send_immediate_cadence_email(email_mapping, self.course.id) + send_immediate_cadence_email(email_mapping, self.course.id) # Verify no new tasks scheduled assert mock_ace_send.call_count == 1 @@ -1088,30 +988,28 @@ def test_complete_three_notification_flow(self, mock_digest_async, mock_ace_send # BUFFER FIRES - should send digest with notif2 and notif3 with freeze_time("2025-12-15 10:15:00"): - with override_waffle_flag(ENABLE_NOTIFICATIONS, True): - with override_waffle_flag(ENABLE_EMAIL_NOTIFICATIONS, True): - send_buffered_digest( # pylint: disable=no-value-for-parameter - user_id=self.user.id, - course_key=str(self.course.id), - start_date=notif1.email_sent_on, - user_language='en' - ) - - # Verify digest email sent - assert mock_ace_send.call_count == 2 # 1 immediate + 1 digest - - # Verify both buffered notifications marked as sent - notif2.refresh_from_db() - notif3.refresh_from_db() - - assert notif2.email_sent_on is not None - assert notif2.email_scheduled is False - assert notif3.email_sent_on is not None - assert notif3.email_scheduled is False + send_buffered_digest( # pylint: disable=no-value-for-parameter + user_id=self.user.id, + course_key=str(self.course.id), + start_date=notif1.email_sent_on, + user_language='en' + ) + + # Verify digest email sent + assert mock_ace_send.call_count == 2 # 1 immediate + 1 digest + + # Verify both buffered notifications marked as sent + notif2.refresh_from_db() + notif3.refresh_from_db() + + assert notif2.email_sent_on is not None + assert notif2.email_scheduled is False + assert notif3.email_sent_on is not None + assert notif3.email_scheduled is False @freeze_time("2025-12-15 10:00:00") @patch('openedx.core.djangoapps.notifications.email.tasks.ace.send') - @override_settings(NOTIFICATION_EMAIL_BUFFER_MINUTES=15) + @override_settings(NOTIFICATION_IMMEDIATE_EMAIL_BUFFER_MINUTES=15) def test_notification_after_buffer_expires_sends_immediate(self, mock_ace_send): """Test that notification after buffer period sends immediately again.""" # First notification @@ -1126,9 +1024,7 @@ def test_notification_after_buffer_expires_sends_immediate(self, mock_ace_send): ) email_mapping = {self.user.id: notif1} - with override_waffle_flag(ENABLE_NOTIFICATIONS, True): - with override_waffle_flag(ENABLE_EMAIL_NOTIFICATIONS, True): - send_immediate_cadence_email(email_mapping, self.course.id) + send_immediate_cadence_email(email_mapping, self.course.id) assert mock_ace_send.call_count == 1 @@ -1145,9 +1041,7 @@ def test_notification_after_buffer_expires_sends_immediate(self, mock_ace_send): ) email_mapping = {self.user.id: notif2} - with override_waffle_flag(ENABLE_NOTIFICATIONS, True): - with override_waffle_flag(ENABLE_EMAIL_NOTIFICATIONS, True): - send_immediate_cadence_email(email_mapping, self.course.id) + send_immediate_cadence_email(email_mapping, self.course.id) # Should send immediate again (buffer expired) assert mock_ace_send.call_count == 2 @@ -1161,7 +1055,7 @@ def test_multiple_courses_independent_buffers(self): course2 = CourseFactory.create() # Notifications in course 1 - notif1 = Notification.objects.create( + notif1 = Notification.objects.create( # noqa: F841 user=self.user, course_id=self.course.id, app_name='discussion', @@ -1199,3 +1093,780 @@ def get_new_post_notification_content_context(**kwargs): "email_content": "

          Email content

          ", **kwargs } + + +@ddt.ddt +class TestGetNextDigestDeliveryTime(ModuleStoreTestCase): + """Tests for get_next_digest_delivery_time function.""" + + @freeze_time("2026-03-06 10:00:00", tz_offset=0) # Friday 10 AM UTC + @override_settings(NOTIFICATION_DAILY_DIGEST_DELIVERY_HOUR=17, NOTIFICATION_DAILY_DIGEST_DELIVERY_MINUTE=0) + def test_daily_delivery_time_later_today(self): + """Test daily delivery is scheduled for later today if time hasn't passed.""" + delivery_time = get_next_digest_delivery_time(EmailCadence.DAILY) + assert delivery_time.hour == 17 + assert delivery_time.minute == 0 + assert delivery_time.day == 6 # Today + + @freeze_time("2026-03-06 18:00:00", tz_offset=0) # Friday 6 PM UTC + @override_settings(NOTIFICATION_DAILY_DIGEST_DELIVERY_HOUR=17, NOTIFICATION_DAILY_DIGEST_DELIVERY_MINUTE=0) + def test_daily_delivery_time_tomorrow_if_passed(self): + """Test daily delivery is scheduled for tomorrow if today's time has passed.""" + delivery_time = get_next_digest_delivery_time(EmailCadence.DAILY) + assert delivery_time.hour == 17 + assert delivery_time.day == 7 # Tomorrow + + @freeze_time("2026-03-06 10:00:00", tz_offset=0) # Friday + @override_settings( + NOTIFICATION_WEEKLY_DIGEST_DELIVERY_DAY=0, # Monday + NOTIFICATION_WEEKLY_DIGEST_DELIVERY_HOUR=17, + NOTIFICATION_WEEKLY_DIGEST_DELIVERY_MINUTE=0 + ) + def test_weekly_delivery_time_next_monday(self): + """Test weekly delivery scheduled for next Monday.""" + delivery_time = get_next_digest_delivery_time(EmailCadence.WEEKLY) + assert delivery_time.weekday() == 0 # Monday + assert delivery_time.hour == 17 + assert delivery_time.day == 9 # Next Monday (March 9) + + @freeze_time("2026-03-09 10:00:00", tz_offset=0) # Monday 10 AM UTC + @override_settings( + NOTIFICATION_WEEKLY_DIGEST_DELIVERY_DAY=0, # Monday + NOTIFICATION_WEEKLY_DIGEST_DELIVERY_HOUR=17, + NOTIFICATION_WEEKLY_DIGEST_DELIVERY_MINUTE=0 + ) + def test_weekly_delivery_time_today_if_not_passed(self): + """Test weekly delivery scheduled for today if it's the right day and time hasn't passed.""" + delivery_time = get_next_digest_delivery_time(EmailCadence.WEEKLY) + assert delivery_time.weekday() == 0 # Monday + assert delivery_time.day == 9 # Today + assert delivery_time.hour == 17 + + @freeze_time("2026-03-09 18:00:00", tz_offset=0) # Monday 6 PM UTC + @override_settings( + NOTIFICATION_WEEKLY_DIGEST_DELIVERY_DAY=0, # Monday + NOTIFICATION_WEEKLY_DIGEST_DELIVERY_HOUR=17, + NOTIFICATION_WEEKLY_DIGEST_DELIVERY_MINUTE=0 + ) + def test_weekly_delivery_time_next_week_if_passed(self): + """Test weekly delivery scheduled for next week if today's time has passed.""" + delivery_time = get_next_digest_delivery_time(EmailCadence.WEEKLY) + assert delivery_time.weekday() == 0 # Monday + assert delivery_time.day == 16 # Next Monday + + @freeze_time("2026-03-06 10:00:00", tz_offset=0) + @override_settings( + NOTIFICATION_DAILY_DIGEST_DELIVERY_HOUR=9, + NOTIFICATION_DAILY_DIGEST_DELIVERY_MINUTE=30 + ) + def test_daily_custom_delivery_time(self): + """Test custom delivery hour and minute from settings.""" + delivery_time = get_next_digest_delivery_time(EmailCadence.DAILY) + # 9:30 has passed (it's 10:00), so should be tomorrow + assert delivery_time.day == 7 + assert delivery_time.hour == 9 + assert delivery_time.minute == 30 + + def test_invalid_cadence_raises_error(self): + """Test that invalid cadence type raises ValueError.""" + with pytest.raises(ValueError, match="Invalid cadence_type for digest scheduling"): + get_next_digest_delivery_time(EmailCadence.IMMEDIATELY) + + @freeze_time("2026-03-06 10:00:00", tz_offset=0) + @override_settings( + NOTIFICATION_WEEKLY_DIGEST_DELIVERY_DAY=4, # Friday + NOTIFICATION_WEEKLY_DIGEST_DELIVERY_HOUR=17, + NOTIFICATION_WEEKLY_DIGEST_DELIVERY_MINUTE=0 + ) + def test_weekly_delivery_same_day_future_time(self): + """Test weekly delivery on same weekday but later time.""" + delivery_time = get_next_digest_delivery_time(EmailCadence.WEEKLY) + assert delivery_time.weekday() == 4 # Friday + assert delivery_time.day == 6 # Today (Friday) + assert delivery_time.hour == 17 + + +@ddt.ddt +class TestIsDigestAlreadyScheduled(ModuleStoreTestCase): + """Tests for is_digest_already_scheduled function.""" + + def setUp(self): + super().setUp() + self.user = UserFactory() + self.course = CourseFactory.create() + + @freeze_time("2026-03-06 10:00:00", tz_offset=0) + def test_no_scheduled_notifications(self): + """Test returns False when no DigestSchedule record exists.""" + delivery_time = datetime(2026, 3, 6, 17, 0, tzinfo=UTC) + assert is_digest_already_scheduled(self.user.id, EmailCadence.DAILY, delivery_time) is False + + @freeze_time("2026-03-06 10:00:00", tz_offset=0) + def test_has_scheduled_notification(self): + """Test returns True when a DigestSchedule record exists for the exact delivery_time.""" + delivery_time = datetime(2026, 3, 6, 17, 0, tzinfo=UTC) + DigestSchedule.objects.create( + user=self.user, + cadence_type=EmailCadence.DAILY, + delivery_time=delivery_time, + task_id='test-task-id', + ) + assert is_digest_already_scheduled(self.user.id, EmailCadence.DAILY, delivery_time) is True + + @freeze_time("2026-03-06 10:00:00", tz_offset=0) + def test_scheduled_notification_outside_window(self): + """Test returns False when DigestSchedule record has a different delivery_time.""" + delivery_time = datetime(2026, 3, 6, 17, 0, tzinfo=UTC) + different_delivery_time = datetime(2026, 3, 5, 17, 0, tzinfo=UTC) # Yesterday + DigestSchedule.objects.create( + user=self.user, + cadence_type=EmailCadence.DAILY, + delivery_time=different_delivery_time, + task_id='test-task-id', + ) + assert is_digest_already_scheduled(self.user.id, EmailCadence.DAILY, delivery_time) is False + + +@ddt.ddt +class TestIsDigestAlreadySentInWindow(ModuleStoreTestCase): + """Tests for is_digest_already_sent_in_window function.""" + + def setUp(self): + super().setUp() + self.user = UserFactory() + self.course = CourseFactory.create() + + def test_no_sent_notifications(self): + """Test returns False when no digest has been sent.""" + delivery_time = datetime(2026, 3, 6, 17, 0, tzinfo=UTC) + assert is_digest_already_sent_in_window(self.user.id, EmailCadence.DAILY, delivery_time) is False + + def test_has_sent_notification_in_window(self): + """Test returns True when digest was already sent in window.""" + delivery_time = datetime(2026, 3, 6, 17, 0, tzinfo=UTC) + Notification.objects.create( + user=self.user, + course_id=str(self.course.id), + app_name='discussion', + notification_type='new_discussion_post', + content_url='http://example.com', + email=True, + email_sent_on=datetime(2026, 3, 6, 10, 0, tzinfo=UTC), + ) + assert is_digest_already_sent_in_window(self.user.id, EmailCadence.DAILY, delivery_time) is True + + +@ddt.ddt +class TestScheduleBulkDigestEmails(ModuleStoreTestCase): + """Tests for schedule_bulk_digest_emails function.""" + + def setUp(self): + super().setUp() + self.user = UserFactory() + self.course = CourseFactory.create() + # Patch transaction.on_commit to execute callbacks immediately in tests + self.on_commit_patcher = patch('django.db.transaction.on_commit', side_effect=lambda func: func()) + self.on_commit_patcher.start() + + def tearDown(self): + self.on_commit_patcher.stop() + super().tearDown() + + @freeze_time("2026-03-06 10:00:00", tz_offset=0) + @override_settings(NOTIFICATION_DAILY_DIGEST_DELIVERY_HOUR=17, NOTIFICATION_DAILY_DIGEST_DELIVERY_MINUTE=0) + @patch('openedx.core.djangoapps.notifications.email.tasks.send_user_digest_email_task.apply_async') + def test_schedules_daily_digest_task(self, mock_apply_async): + """Test that a daily digest task is scheduled when notification exists.""" + Notification.objects.create( + user=self.user, + course_id=str(self.course.id), + app_name='discussion', + notification_type='new_discussion_post', + content_url='http://example.com', + email=True, + email_scheduled=False, + email_sent_on=None, + ) + + schedule_bulk_digest_emails({self.user.id: EmailCadence.DAILY}) + + assert mock_apply_async.called + call_kwargs = mock_apply_async.call_args[1] + assert call_kwargs['kwargs']['user_id'] == self.user.id + assert call_kwargs['kwargs']['cadence_type'] == EmailCadence.DAILY + # Should be scheduled for 5 PM UTC today + assert call_kwargs['eta'].hour == 17 + assert call_kwargs['eta'].day == 6 + + @freeze_time("2026-03-06 10:00:00", tz_offset=0) + @override_settings(NOTIFICATION_DAILY_DIGEST_DELIVERY_HOUR=17, NOTIFICATION_DAILY_DIGEST_DELIVERY_MINUTE=0) + @patch('openedx.core.djangoapps.notifications.email.tasks.send_user_digest_email_task.apply_async') + def test_does_not_schedule_if_already_scheduled(self, mock_apply_async): + """Test that no duplicate task is scheduled when a DigestSchedule record already exists.""" + delivery_time = datetime(2026, 3, 6, 17, 0, tzinfo=UTC) + DigestSchedule.objects.create( + user=self.user, + cadence_type=EmailCadence.DAILY, + delivery_time=delivery_time, + task_id='existing-task-id', + ) + + schedule_bulk_digest_emails({self.user.id: EmailCadence.DAILY}) + + assert not mock_apply_async.called + + @freeze_time("2026-03-06 10:00:00", tz_offset=0) + @patch('openedx.core.djangoapps.notifications.email.tasks.send_user_digest_email_task.apply_async') + def test_invalid_cadence_does_not_schedule(self, mock_apply_async): + """Test that IMMEDIATELY cadence does not schedule a digest.""" + schedule_bulk_digest_emails({self.user.id: EmailCadence.IMMEDIATELY}) + assert not mock_apply_async.called + + @freeze_time("2026-03-06 10:00:00", tz_offset=0) + @override_settings( + NOTIFICATION_WEEKLY_DIGEST_DELIVERY_DAY=0, + NOTIFICATION_WEEKLY_DIGEST_DELIVERY_HOUR=17, + NOTIFICATION_WEEKLY_DIGEST_DELIVERY_MINUTE=0 + ) + @patch('openedx.core.djangoapps.notifications.email.tasks.send_user_digest_email_task.apply_async') + def test_schedules_weekly_digest_task(self, mock_apply_async): + """Test that a weekly digest task is scheduled correctly.""" + Notification.objects.create( + user=self.user, + course_id=str(self.course.id), + app_name='discussion', + notification_type='new_discussion_post', + content_url='http://example.com', + email=True, + email_scheduled=False, + email_sent_on=None, + ) + + schedule_bulk_digest_emails({self.user.id: EmailCadence.WEEKLY}) + + assert mock_apply_async.called + call_kwargs = mock_apply_async.call_args[1] + assert call_kwargs['kwargs']['cadence_type'] == EmailCadence.WEEKLY + # Should be scheduled for next Monday 5 PM + assert call_kwargs['eta'].weekday() == 0 + assert call_kwargs['eta'].hour == 17 + + @freeze_time("2026-03-06 10:00:00", tz_offset=0) + @override_settings(NOTIFICATION_DAILY_DIGEST_DELIVERY_HOUR=17, NOTIFICATION_DAILY_DIGEST_DELIVERY_MINUTE=0) + @patch('openedx.core.djangoapps.notifications.email.tasks.send_user_digest_email_task.apply_async') + def test_marks_notifications_as_scheduled(self, mock_apply_async): + """Test that notifications are marked as email_scheduled=True.""" + notif = Notification.objects.create( + user=self.user, + course_id=str(self.course.id), + app_name='discussion', + notification_type='new_discussion_post', + content_url='http://example.com', + email=True, + email_scheduled=False, + email_sent_on=None, + ) + + schedule_bulk_digest_emails({self.user.id: EmailCadence.DAILY}) + + notif.refresh_from_db() + assert notif.email_scheduled is True + + @freeze_time("2026-03-06 10:00:00", tz_offset=0) + @override_settings(NOTIFICATION_DAILY_DIGEST_DELIVERY_HOUR=17, NOTIFICATION_DAILY_DIGEST_DELIVERY_MINUTE=0) + @patch('openedx.core.djangoapps.notifications.email.tasks.send_user_digest_email_task.apply_async') + def test_creates_digest_schedule_record(self, mock_apply_async): + """Test that a DigestSchedule record is created after scheduling.""" + Notification.objects.create( + user=self.user, + course_id=str(self.course.id), + app_name='discussion', + notification_type='new_discussion_post', + content_url='http://example.com', + email=True, + email_scheduled=False, + email_sent_on=None, + ) + + schedule_bulk_digest_emails({self.user.id: EmailCadence.DAILY}) + + delivery_time = datetime(2026, 3, 6, 17, 0, tzinfo=UTC) + assert DigestSchedule.objects.filter( + user=self.user, + cadence_type=EmailCadence.DAILY, + delivery_time=delivery_time, + ).exists() + + @freeze_time("2026-03-06 10:00:00", tz_offset=0) + @override_settings(NOTIFICATION_DAILY_DIGEST_DELIVERY_HOUR=17, NOTIFICATION_DAILY_DIGEST_DELIVERY_MINUTE=0) + @patch('openedx.core.djangoapps.notifications.email.tasks.send_user_digest_email_task.apply_async') + def test_empty_map_does_nothing(self, mock_apply_async): + """Test that an empty user_cadence_map does nothing.""" + schedule_bulk_digest_emails({}) + assert not mock_apply_async.called + + @freeze_time("2026-03-06 10:00:00", tz_offset=0) + @override_settings(NOTIFICATION_DAILY_DIGEST_DELIVERY_HOUR=17, NOTIFICATION_DAILY_DIGEST_DELIVERY_MINUTE=0) + @patch('openedx.core.djangoapps.notifications.email.tasks.send_user_digest_email_task.apply_async') + def test_schedules_for_multiple_users(self, mock_apply_async): + """Test that digest tasks are scheduled for multiple users in one call.""" + user2 = UserFactory() + for user in [self.user, user2]: + Notification.objects.create( + user=user, + course_id=str(self.course.id), + app_name='discussion', + notification_type='new_discussion_post', + content_url='http://example.com', + email=True, + email_scheduled=False, + email_sent_on=None, + ) + + schedule_bulk_digest_emails({ + self.user.id: EmailCadence.DAILY, + user2.id: EmailCadence.DAILY, + }) + + assert mock_apply_async.call_count == 2 + assert DigestSchedule.objects.count() == 2 + + +@ddt.ddt +class TestSendUserDigestEmailTask(ModuleStoreTestCase): + """Tests for the send_user_digest_email_task celery task.""" + + def setUp(self): + super().setUp() + self.user = UserFactory() + self.course = CourseFactory.create(display_name='Test Course') + + NotificationPreference.objects.filter(user=self.user).delete() + NotificationPreference.objects.create( + user=self.user, + app='discussion', + type='new_discussion_post', + email=True, + email_cadence=EmailCadence.DAILY, + ) + + @freeze_time("2026-03-06 17:00:00", tz_offset=0) + @patch('openedx.core.djangoapps.notifications.email.tasks.ace.send') + def test_sends_digest_email(self, mock_ace_send): + """Test that digest email is sent successfully.""" + created_time = datetime(2026, 3, 6, 10, 0, tzinfo=UTC) + Notification.objects.create( + user=self.user, + course_id=str(self.course.id), + app_name='discussion', + notification_type='new_discussion_post', + content_url='http://example.com', + content_context=get_new_post_notification_content_context(), + email=True, + email_scheduled=True, + created=created_time, + ) + DigestSchedule.objects.create( + user=self.user, + cadence_type=EmailCadence.DAILY, + delivery_time=datetime(2026, 3, 6, 17, 0, tzinfo=UTC), + task_id='test-task-id', + ) + + send_user_digest_email_task( # pylint: disable=no-value-for-parameter + user_id=self.user.id, + cadence_type=EmailCadence.DAILY, + ) + + assert mock_ace_send.called + + @freeze_time("2026-03-06 17:00:00", tz_offset=0) + @patch('openedx.core.djangoapps.notifications.email.tasks.ace.send') + def test_skips_if_already_sent_by_cron(self, mock_ace_send): + """Test that digest is skipped if cron already sent it.""" + created_time = datetime(2026, 3, 6, 10, 0, tzinfo=UTC) + Notification.objects.create( + user=self.user, + course_id=str(self.course.id), + app_name='discussion', + notification_type='new_discussion_post', + content_url='http://example.com', + content_context=get_new_post_notification_content_context(), + email=True, + email_scheduled=True, + email_sent_on=datetime(2026, 3, 6, 15, 0, tzinfo=UTC), # Already sent by cron + created=created_time, + ) + DigestSchedule.objects.create( + user=self.user, + cadence_type=EmailCadence.DAILY, + delivery_time=datetime(2026, 3, 6, 17, 0, tzinfo=UTC), + task_id='test-task-id', + ) + + send_user_digest_email_task( # pylint: disable=no-value-for-parameter + user_id=self.user.id, + cadence_type=EmailCadence.DAILY, + ) + + assert not mock_ace_send.called + + @freeze_time("2026-03-06 17:00:00", tz_offset=0) + @patch('openedx.core.djangoapps.notifications.email.tasks.ace.send') + def test_clears_scheduled_flags_after_send(self, mock_ace_send): + """Test that email_scheduled flags are cleared after successful send.""" + created_time = datetime(2026, 3, 6, 10, 0, tzinfo=UTC) + notif = Notification.objects.create( + user=self.user, + course_id=str(self.course.id), + app_name='discussion', + notification_type='new_discussion_post', + content_url='http://example.com', + content_context=get_new_post_notification_content_context(), + email=True, + email_scheduled=True, + created=created_time, + ) + DigestSchedule.objects.create( + user=self.user, + cadence_type=EmailCadence.DAILY, + delivery_time=datetime(2026, 3, 6, 17, 0, tzinfo=UTC), + task_id='test-task-id', + ) + + send_user_digest_email_task( # pylint: disable=no-value-for-parameter + user_id=self.user.id, + cadence_type=EmailCadence.DAILY, + ) + + notif.refresh_from_db() + assert notif.email_scheduled is False + assert not DigestSchedule.objects.filter(user=self.user, cadence_type=EmailCadence.DAILY).exists() + + @freeze_time("2026-03-06 17:00:00", tz_offset=0) + @patch('openedx.core.djangoapps.notifications.email.tasks.ace.send') + def test_skips_disabled_user(self, mock_ace_send): + """Test that digest is not sent to disabled user and DigestSchedule is cleaned up.""" + self.user.set_unusable_password() + self.user.save() + + created_time = datetime(2026, 3, 6, 10, 0, tzinfo=UTC) + Notification.objects.create( + user=self.user, + course_id=str(self.course.id), + app_name='discussion', + notification_type='new_discussion_post', + content_url='http://example.com', + content_context=get_new_post_notification_content_context(), + email=True, + email_scheduled=True, + created=created_time, + ) + DigestSchedule.objects.create( + user=self.user, + cadence_type=EmailCadence.DAILY, + delivery_time=datetime(2026, 3, 6, 17, 0, tzinfo=UTC), + task_id='test-task-id', + ) + send_user_digest_email_task( # pylint: disable=no-value-for-parameter + user_id=self.user.id, + cadence_type=EmailCadence.DAILY, + ) + + assert not mock_ace_send.called + # Verify DigestSchedule was cleaned up even though user is disabled + assert not DigestSchedule.objects.filter( + user=self.user, + cadence_type=EmailCadence.DAILY, + delivery_time=datetime(2026, 3, 6, 17, 0, tzinfo=UTC), + ).exists() + + @freeze_time("2026-03-06 17:00:00", tz_offset=0) + def test_handles_missing_user(self): + """Test that task handles non-existent user gracefully and cleans up DigestSchedule.""" + # Create a DigestSchedule record for the non-existent user + DigestSchedule.objects.create( + user_id=99999, + cadence_type=EmailCadence.DAILY, + delivery_time=datetime(2026, 3, 6, 17, 0, tzinfo=UTC), + task_id='orphan-task-id', + ) + # Should not raise + send_user_digest_email_task( # pylint: disable=no-value-for-parameter + user_id=99999, + cadence_type=EmailCadence.DAILY, + ) + + # Verify orphaned DigestSchedule was cleaned up + assert not DigestSchedule.objects.filter(user_id=99999).exists() + + @freeze_time("2026-03-06 17:00:00", tz_offset=0) + @patch('openedx.core.djangoapps.notifications.email.tasks.ace.send') + def test_clears_scheduled_flags_even_when_cron_sent(self, mock_ace_send): + """Test that scheduled flags and DigestSchedule record are cleared even when cron already sent.""" + created_time = datetime(2026, 3, 6, 10, 0, tzinfo=UTC) + notif = Notification.objects.create( + user=self.user, + course_id=str(self.course.id), + app_name='discussion', + notification_type='new_discussion_post', + content_url='http://example.com', + content_context=get_new_post_notification_content_context(), + email=True, + email_scheduled=True, + email_sent_on=datetime(2026, 3, 6, 15, 0, tzinfo=UTC), # Sent by cron + created=created_time, + ) + DigestSchedule.objects.create( + user=self.user, + cadence_type=EmailCadence.DAILY, + delivery_time=datetime(2026, 3, 6, 17, 0, tzinfo=UTC), + task_id='test-task-id', + ) + send_user_digest_email_task( # pylint: disable=no-value-for-parameter + user_id=self.user.id, + cadence_type=EmailCadence.DAILY, + ) + + notif.refresh_from_db() + assert notif.email_scheduled is False + assert not mock_ace_send.called + assert not DigestSchedule.objects.filter(user=self.user, cadence_type=EmailCadence.DAILY).exists() + + +@ddt.ddt +class TestDigestSchedulingIntegration(ModuleStoreTestCase): + """Integration tests for the full digest scheduling flow.""" + + def setUp(self): + super().setUp() + self.user = UserFactory() + self.course = CourseFactory.create(display_name='Test Course') + + NotificationPreference.objects.filter(user=self.user).delete() + NotificationPreference.objects.create( + user=self.user, + app='discussion', + type='new_discussion_post', + email=True, + email_cadence=EmailCadence.DAILY, + ) + # Patch transaction.on_commit to execute callbacks immediately in tests + self.on_commit_patcher = patch('django.db.transaction.on_commit', side_effect=lambda func: func()) + self.on_commit_patcher.start() + + def tearDown(self): + self.on_commit_patcher.stop() + super().tearDown() + + @freeze_time("2026-03-06 10:00:00", tz_offset=0) + @override_settings(NOTIFICATION_DAILY_DIGEST_DELIVERY_HOUR=17, NOTIFICATION_DAILY_DIGEST_DELIVERY_MINUTE=0) + @patch('openedx.core.djangoapps.notifications.email.tasks.send_user_digest_email_task.apply_async') + def test_notification_triggers_digest_scheduling(self, mock_apply_async): + """Test that creating a notification triggers digest scheduling via send_notifications.""" + context = { + 'username': 'User', + 'post_title': 'Test Post' + } + send_notifications( + [self.user.id], + str(self.course.id), + 'discussion', + 'new_discussion_post', + context, + 'http://test.url' + ) + + # A digest task should have been scheduled + assert mock_apply_async.called + + @freeze_time("2026-03-06 10:00:00", tz_offset=0) + @override_settings(NOTIFICATION_DAILY_DIGEST_DELIVERY_HOUR=17, NOTIFICATION_DAILY_DIGEST_DELIVERY_MINUTE=0) + @patch('openedx.core.djangoapps.notifications.email.tasks.send_user_digest_email_task.apply_async') + def test_multiple_notifications_schedule_only_once(self, mock_apply_async): + """Test that multiple notifications in same window only schedule one task.""" + context = { + 'username': 'User', + 'post_title': 'Test Post' + } + + send_notifications( + [self.user.id], + str(self.course.id), + 'discussion', + 'new_discussion_post', + context.copy(), + 'http://test.url' + ) + send_notifications( + [self.user.id], + str(self.course.id), + 'discussion', + 'new_discussion_post', + context.copy(), + 'http://test.url' + ) + + # Should be called only once because second time notifications are already scheduled + assert mock_apply_async.call_count == 1 + + @freeze_time("2026-03-06 10:00:00", tz_offset=0) + @override_settings(NOTIFICATION_DAILY_DIGEST_DELIVERY_HOUR=17, NOTIFICATION_DAILY_DIGEST_DELIVERY_MINUTE=0) + @patch('openedx.core.djangoapps.notifications.email.tasks.ace.send') + @patch('openedx.core.djangoapps.notifications.email.tasks.send_user_digest_email_task.apply_async') + def test_immediate_cadence_does_not_trigger_digest(self, mock_digest_async, mock_ace_send): + """Test that immediate cadence users don't get digest scheduled.""" + NotificationPreference.objects.filter(user=self.user).delete() + NotificationPreference.objects.create( + user=self.user, + app='discussion', + type='new_discussion_post', + email=True, + email_cadence=EmailCadence.IMMEDIATELY, + ) + + context = { + 'username': 'User', + 'post_title': 'Test Post' + } + + send_notifications( + [self.user.id], + str(self.course.id), + 'discussion', + 'new_discussion_post', + context, + 'http://test.url' + ) + + # Immediate email should be sent, NOT a digest scheduled + assert mock_ace_send.called + assert not mock_digest_async.called + + +@ddt.ddt +class TestGetNextDigestDeliveryTimeSettingsValidation(ModuleStoreTestCase): + """Tests for settings validation in get_next_digest_delivery_time.""" + + @freeze_time("2026-03-06 10:00:00", tz_offset=0) + @override_settings(NOTIFICATION_DAILY_DIGEST_DELIVERY_HOUR=25, NOTIFICATION_DAILY_DIGEST_DELIVERY_MINUTE=99) + def test_daily_invalid_settings_clamped(self): + """Test that invalid hour/minute values are clamped to valid ranges.""" + delivery_time = get_next_digest_delivery_time(EmailCadence.DAILY) + assert delivery_time.hour == 23 # clamped from 25 + assert delivery_time.minute == 59 # clamped from 99 + + @freeze_time("2026-03-06 10:00:00", tz_offset=0) + @override_settings( + NOTIFICATION_WEEKLY_DIGEST_DELIVERY_DAY=10, + NOTIFICATION_WEEKLY_DIGEST_DELIVERY_HOUR=-1, + NOTIFICATION_WEEKLY_DIGEST_DELIVERY_MINUTE=-5, + ) + def test_weekly_invalid_settings_clamped(self): + """Test that invalid day/hour/minute values are clamped to valid ranges.""" + delivery_time = get_next_digest_delivery_time(EmailCadence.WEEKLY) + assert delivery_time.weekday() == 6 # clamped from 10 → min(6, max(0, 10)) = 6 (Sunday) + assert delivery_time.hour == 0 # clamped from -1 + assert delivery_time.minute == 0 # clamped from -5 + + +@ddt.ddt +class TestClaimDigestSchedule(ModuleStoreTestCase): + """Tests for _claim_digest_schedule.""" + + def setUp(self): + super().setUp() + self.user = UserFactory() + + @freeze_time("2026-03-06 17:00:00", tz_offset=0) + def test_claims_current_window_record(self): + """Test that the current window's DigestSchedule record is deleted and returns True.""" + DigestSchedule.objects.create( + user=self.user, + cadence_type=EmailCadence.DAILY, + delivery_time=datetime(2026, 3, 6, 17, 0, tzinfo=UTC), + task_id='current-task-id', + ) + + result = _claim_digest_schedule(self.user.id, EmailCadence.DAILY) + + assert result is True + assert not DigestSchedule.objects.filter( + user=self.user, + cadence_type=EmailCadence.DAILY, + delivery_time=datetime(2026, 3, 6, 17, 0, tzinfo=UTC), + ).exists() + + @freeze_time("2026-03-06 17:00:00", tz_offset=0) + def test_second_claim_returns_false(self): + """Test that a second claim attempt returns False (dedup).""" + DigestSchedule.objects.create( + user=self.user, + cadence_type=EmailCadence.DAILY, + delivery_time=datetime(2026, 3, 6, 17, 0, tzinfo=UTC), + task_id='current-task-id', + ) + + first = _claim_digest_schedule(self.user.id, EmailCadence.DAILY) + second = _claim_digest_schedule(self.user.id, EmailCadence.DAILY) + + assert first is True + assert second is False + + @freeze_time("2026-03-06 17:00:00", tz_offset=0) + def test_preserves_future_window_record(self): + """Test that a future window's DigestSchedule record is NOT deleted.""" + DigestSchedule.objects.create( + user=self.user, + cadence_type=EmailCadence.DAILY, + delivery_time=datetime(2026, 3, 6, 17, 0, tzinfo=UTC), + task_id='current-task-id', + ) + DigestSchedule.objects.create( + user=self.user, + cadence_type=EmailCadence.DAILY, + delivery_time=datetime(2026, 3, 7, 17, 0, tzinfo=UTC), + task_id='future-task-id', + ) + + result = _claim_digest_schedule(self.user.id, EmailCadence.DAILY) + + assert result is True + assert not DigestSchedule.objects.filter( + user=self.user, + cadence_type=EmailCadence.DAILY, + delivery_time=datetime(2026, 3, 6, 17, 0, tzinfo=UTC), + ).exists() + assert DigestSchedule.objects.filter( + user=self.user, + cadence_type=EmailCadence.DAILY, + delivery_time=datetime(2026, 3, 7, 17, 0, tzinfo=UTC), + ).exists() + + @freeze_time("2026-03-09 17:00:00", tz_offset=0) + def test_weekly_preserves_future_record(self): + """Test that weekly cleanup preserves next week's record.""" + DigestSchedule.objects.create( + user=self.user, + cadence_type=EmailCadence.WEEKLY, + delivery_time=datetime(2026, 3, 9, 17, 0, tzinfo=UTC), + task_id='current-task-id', + ) + DigestSchedule.objects.create( + user=self.user, + cadence_type=EmailCadence.WEEKLY, + delivery_time=datetime(2026, 3, 16, 17, 0, tzinfo=UTC), + task_id='next-week-task-id', + ) + + result = _claim_digest_schedule(self.user.id, EmailCadence.WEEKLY) + + assert result is True + assert not DigestSchedule.objects.filter( + user=self.user, + delivery_time=datetime(2026, 3, 9, 17, 0, tzinfo=UTC), + ).exists() + assert DigestSchedule.objects.filter( + user=self.user, + delivery_time=datetime(2026, 3, 16, 17, 0, tzinfo=UTC), + ).exists() diff --git a/openedx/core/djangoapps/notifications/email/tests/test_utils.py b/openedx/core/djangoapps/notifications/email/tests/test_utils.py index bc2d54da6eb9..a1bdffe7f0bf 100644 --- a/openedx/core/djangoapps/notifications/email/tests/test_utils.py +++ b/openedx/core/djangoapps/notifications/email/tests/test_utils.py @@ -2,21 +2,17 @@ Test utils.py """ import datetime +from unittest.mock import patch + import ddt import pytest - -from django.http.response import Http404 from django.conf import settings +from django.http.response import Http404 from django.test.utils import override_settings -from unittest.mock import patch from pytz import utc -from waffle import get_waffle_flag_model # pylint: disable=invalid-django-waffle-import from common.djangoapps.student.tests.factories import UserFactory - -from openedx.core.djangoapps.notifications.config.waffle import ENABLE_EMAIL_NOTIFICATIONS from openedx.core.djangoapps.notifications.email import ONE_CLICK_EMAIL_UNSUB_KEY -from openedx.core.djangoapps.notifications.models import Notification from openedx.core.djangoapps.notifications.email.utils import ( add_additional_attributes_to_notifications, create_app_notifications_dict, @@ -28,9 +24,9 @@ get_course_info, get_time_ago, get_unsubscribe_link, - is_email_notification_flag_enabled, update_user_preferences_from_patch, ) +from openedx.core.djangoapps.notifications.models import Notification from openedx.core.djangoapps.user_api.models import UserPreference from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase from xmodule.modulestore.tests.factories import CourseFactory @@ -102,8 +98,8 @@ def test_get_unsubscribe_link_uses_site_config(self): """Test unsubscribe link uses site-configured MFE URL and encrypted username.""" with patch('openedx.core.djangoapps.notifications.email.utils.configuration_helpers.get_value', return_value='https://learning.siteconf') as mock_get_value, \ - patch('openedx.core.djangoapps.notifications.email.utils.encrypt_string', - return_value='ENC') as mock_encrypt: + patch('openedx.core.djangoapps.notifications.email.utils.encrypt_string', + return_value='ENC') as mock_encrypt: url = get_unsubscribe_link(self.user.username) assert url == 'https://learning.siteconf/preferences-unsubscribe/ENC/' @@ -117,8 +113,8 @@ def test_get_unsubscribe_link_falls_back_to_settings(self): with override_settings(LEARNING_MICROFRONTEND_URL=default_url): with patch('openedx.core.djangoapps.notifications.email.utils.configuration_helpers.get_value', side_effect=lambda k, d: d) as mock_get_value, \ - patch('openedx.core.djangoapps.notifications.email.utils.encrypt_string', - return_value='ENC') as mock_encrypt: + patch('openedx.core.djangoapps.notifications.email.utils.encrypt_string', + return_value='ENC') as mock_encrypt: url = get_unsubscribe_link(self.user.username) assert url == f'{default_url}/preferences-unsubscribe/ENC/' @@ -199,58 +195,37 @@ def test_email_digest_context(self, digest_frequency): assert_list_equal(context['email_digest_updates'], expected_digest_updates) assert_list_equal(context['email_content'], expected_email_content) - -class TestWaffleFlag(ModuleStoreTestCase): - """ - Test user level email notifications waffle flag - """ - - def setUp(self): + def test_email_template_context_notification_settings_url_uses_site_config(self): """ - Setup + When site configuration defines ACCOUNT_MICROFRONTEND_URL (with a trailing slash), + the context should build notification_settings_url from it and strip the slash. """ - super().setUp() - self.user_1 = UserFactory() - self.user_2 = UserFactory() - self.course_1 = CourseFactory.create(display_name='test course 1', run="Testing_course_1") - self.course_1 = CourseFactory.create(display_name='test course 2', run="Testing_course_2") + siteconf_url = "https://accounts.siteconf.example/" - def test_waffle_flag_for_everyone(self): - """ - Tests if waffle flag is enabled for everyone - """ - assert is_email_notification_flag_enabled() is False - waffle_model = get_waffle_flag_model() - flag, _ = waffle_model.objects.get_or_create(name=ENABLE_EMAIL_NOTIFICATIONS.name) - flag.everyone = True - flag.save() - assert is_email_notification_flag_enabled() is True - - def test_waffle_flag_for_user(self): - """ - Tests user level waffle flag - """ - assert is_email_notification_flag_enabled() is False - waffle_model = get_waffle_flag_model() - flag, _ = waffle_model.objects.get_or_create(name=ENABLE_EMAIL_NOTIFICATIONS.name) - flag.users.add(self.user_1) - flag.save() - assert is_email_notification_flag_enabled(self.user_1) is True - assert is_email_notification_flag_enabled(self.user_2) is False - - def test_waffle_flag_everyone_priority(self): + with patch( + "openedx.core.djangoapps.notifications.email.utils.configuration_helpers.get_value", + side_effect=lambda key, default=None, *a, **k: + siteconf_url if key == "ACCOUNT_MICROFRONTEND_URL" else default, + ): + ctx = create_email_template_context(self.user.username) + + assert ctx["notification_settings_url"] == "https://accounts.siteconf.example/#notifications" + + def test_email_template_context_notification_settings_url_falls_back_to_settings(self): """ - Tests if everyone field has more priority over user field + If site config doesn't override, the context should fall back to + settings.ACCOUNT_MICROFRONTEND_URL (also stripping any trailing slash). """ - assert is_email_notification_flag_enabled() is False - waffle_model = get_waffle_flag_model() - flag, _ = waffle_model.objects.get_or_create(name=ENABLE_EMAIL_NOTIFICATIONS.name) - flag.everyone = False - flag.users.add(self.user_1) - flag.save() - assert is_email_notification_flag_enabled() is False - assert is_email_notification_flag_enabled(self.user_1) is False - assert is_email_notification_flag_enabled(self.user_2) is False + fallback = "https://accounts.settings.example/" + + with override_settings(ACCOUNT_MICROFRONTEND_URL=fallback): + with patch( + "openedx.core.djangoapps.notifications.email.utils.configuration_helpers.get_value", + side_effect=lambda key, default=None, *a, **k: default, + ): + ctx = create_email_template_context(self.user.username) + + assert ctx["notification_settings_url"] == "https://accounts.settings.example/#notifications" class TestEncryption(ModuleStoreTestCase): @@ -299,6 +274,6 @@ def test_user_preference_created_on_email_unsubscribe(self): """ encrypted_username = encrypt_string(self.user.username) update_user_preferences_from_patch(encrypted_username) - self.assertTrue( + self.assertTrue( # noqa: PT009 UserPreference.objects.filter(user=self.user, key=ONE_CLICK_EMAIL_UNSUB_KEY).exists() ) diff --git a/openedx/core/djangoapps/notifications/email/utils.py b/openedx/core/djangoapps/notifications/email/utils.py index a3fb93330457..ef4cc9df4280 100644 --- a/openedx/core/djangoapps/notifications/email/utils.py +++ b/openedx/core/djangoapps/notifications/email/utils.py @@ -8,54 +8,31 @@ from django.contrib.auth import get_user_model from django.core.exceptions import BadRequest from django.shortcuts import get_object_or_404 +from django.utils import timezone as django_timezone from django.utils.translation import gettext as _ from pytz import utc -from waffle import get_waffle_flag_model # pylint: disable=invalid-django-waffle-import from lms.djangoapps.branding.api import get_logo_url_for_email from lms.djangoapps.discussion.notification_prefs.views import UsernameCipher, UsernameDecryptionException from openedx.core.djangoapps.lang_pref import LANGUAGE_KEY from openedx.core.djangoapps.notifications.base_notification import ( COURSE_NOTIFICATION_TYPES, - get_default_values_of_preferences + get_default_values_of_preferences, ) -from openedx.core.djangoapps.notifications.config.waffle import ENABLE_EMAIL_NOTIFICATIONS from openedx.core.djangoapps.notifications.email import ONE_CLICK_EMAIL_UNSUB_KEY from openedx.core.djangoapps.notifications.email_notifications import EmailCadence from openedx.core.djangoapps.notifications.events import notification_preference_unsubscribe_event from openedx.core.djangoapps.notifications.models import NotificationPreference -from openedx.core.djangoapps.user_api.models import UserPreference from openedx.core.djangoapps.site_configuration import helpers as configuration_helpers +from openedx.core.djangoapps.user_api.models import UserPreference from xmodule.modulestore.django import modulestore -from .notification_icons import NotificationTypeIcons from ..utils import create_account_notification_pref_if_not_exists +from .notification_icons import NotificationTypeIcons User = get_user_model() -def is_email_notification_flag_enabled(user=None): - """ - Returns if waffle flag is enabled for user or not - """ - flag_model = get_waffle_flag_model() - try: - flag = flag_model.objects.get(name=ENABLE_EMAIL_NOTIFICATIONS.name) - except flag_model.DoesNotExist: - return False - if flag.everyone is not None: - return flag.everyone - if user: - role_value = flag.is_active_for_user(user) - if role_value is not None: - return role_value - try: - return flag.users.contains(user) - except ValueError: - pass - return False - - def create_datetime_string(datetime_instance): """ Returns string for datetime object @@ -97,11 +74,17 @@ def create_email_template_context(username): for social_platform in social_media_urls.keys() if social_media_icons.get(social_platform) } - patch = { + patch = { # noqa: F841 'channel': 'email', 'value': False } - account_base_url = (settings.ACCOUNT_MICROFRONTEND_URL or "").rstrip('/') + account_base_url = ( + configuration_helpers.get_value( + 'ACCOUNT_MICROFRONTEND_URL', + settings.ACCOUNT_MICROFRONTEND_URL, + ) or + "" + ).rstrip('/') return { "platform_name": settings.PLATFORM_NAME, "mailing_address": settings.CONTACT_MAILING_ADDRESS, @@ -195,11 +178,11 @@ def get_start_end_date(cadence_type): """ if cadence_type not in [EmailCadence.DAILY, EmailCadence.WEEKLY]: raise ValueError('Invalid cadence_type') - end_date = datetime.datetime.now() + end_date = django_timezone.now() start_date = end_date - datetime.timedelta(days=1, minutes=15) if cadence_type == EmailCadence.WEEKLY: start_date = start_date - datetime.timedelta(days=6) - return utc.localize(start_date), utc.localize(end_date) + return start_date, end_date def get_course_info(course_key): diff --git a/openedx/core/djangoapps/notifications/exceptions.py b/openedx/core/djangoapps/notifications/exceptions.py index 2eb8bb794253..cc2b74b1038f 100644 --- a/openedx/core/djangoapps/notifications/exceptions.py +++ b/openedx/core/djangoapps/notifications/exceptions.py @@ -3,4 +3,4 @@ class InvalidNotificationTypeError(Exception): """ Exception raised when an invalid notification type is passed. """ - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass diff --git a/openedx/core/djangoapps/notifications/grouping_notifications.py b/openedx/core/djangoapps/notifications/grouping_notifications.py index 19abed761ce6..cb38ddc002bf 100644 --- a/openedx/core/djangoapps/notifications/grouping_notifications.py +++ b/openedx/core/djangoapps/notifications/grouping_notifications.py @@ -3,7 +3,7 @@ """ import datetime from abc import ABC, abstractmethod -from typing import Dict, Type, Union +from typing import Dict, Type, Union # noqa: UP035 from pytz import utc @@ -27,7 +27,7 @@ class NotificationRegistry: """ Registry for notification groupers. """ - _groupers: Dict[str, Type[BaseNotificationGrouper]] = {} + _groupers: Dict[str, Type[BaseNotificationGrouper]] = {} # noqa: UP006 @classmethod def register(cls, notification_type: str): @@ -40,7 +40,7 @@ def register(cls, notification_type: str): A decorator that registers the grouper class for the given notification type. """ - def decorator(grouper_class: Type[BaseNotificationGrouper]) -> Type[BaseNotificationGrouper]: + def decorator(grouper_class: Type[BaseNotificationGrouper]) -> Type[BaseNotificationGrouper]: # noqa: UP006 """ Registers the grouper class for the given notification type. """ @@ -54,7 +54,7 @@ def decorator(grouper_class: Type[BaseNotificationGrouper]) -> Type[BaseNotifica return decorator @classmethod - def get_grouper(cls, notification_type: str) -> Union[BaseNotificationGrouper, None]: + def get_grouper(cls, notification_type: str) -> Union[BaseNotificationGrouper, None]: # noqa: UP007 """Retrieves the appropriate notification grouper based on the given notification type. Args: diff --git a/openedx/core/djangoapps/notifications/handlers.py b/openedx/core/djangoapps/notifications/handlers.py index f9989caddf6c..373e1f4bf1ba 100644 --- a/openedx/core/djangoapps/notifications/handlers.py +++ b/openedx/core/djangoapps/notifications/handlers.py @@ -4,13 +4,10 @@ import logging from django.contrib.auth import get_user_model -from django.db import IntegrityError, transaction, ProgrammingError +from django.db import IntegrityError, ProgrammingError, transaction from django.db.models.signals import post_save from django.dispatch import receiver -from openedx_events.learning.signals import ( - COURSE_NOTIFICATION_REQUESTED, - USER_NOTIFICATION_REQUESTED -) +from openedx_events.learning.signals import COURSE_NOTIFICATION_REQUESTED, USER_NOTIFICATION_REQUESTED from common.djangoapps.student.models import CourseEnrollment from openedx.core.djangoapps.notifications.audience_filters import ( @@ -18,7 +15,7 @@ CourseRoleAudienceFilter, EnrollmentAudienceFilter, ForumRoleAudienceFilter, - TeamAudienceFilter + TeamAudienceFilter, ) from openedx.core.djangoapps.notifications.base_notification import COURSE_NOTIFICATION_TYPES from openedx.core.djangoapps.notifications.models import NotificationPreference @@ -82,7 +79,7 @@ def calculate_course_wide_notification_audience(course_key, audience_filters): audience_user_ids = [] for filter_type, filter_values in audience_filters.items(): - if filter_type in AUDIENCE_FILTER_CLASSES.keys(): # lint-amnesty, pylint: disable=consider-iterating-dictionary + if filter_type in AUDIENCE_FILTER_CLASSES.keys(): # pylint: disable=consider-iterating-dictionary filter_class = AUDIENCE_FILTER_CLASSES.get(filter_type) if filter_class: filter_instance = filter_class(course_key) diff --git a/openedx/core/djangoapps/notifications/management/commands/delete_notifications.py b/openedx/core/djangoapps/notifications/management/commands/delete_notifications.py index 62f2069100c9..62520010e61d 100644 --- a/openedx/core/djangoapps/notifications/management/commands/delete_notifications.py +++ b/openedx/core/djangoapps/notifications/management/commands/delete_notifications.py @@ -6,13 +6,9 @@ from django.core.management.base import BaseCommand -from openedx.core.djangoapps.notifications.base_notification import ( - COURSE_NOTIFICATION_APPS, - COURSE_NOTIFICATION_TYPES -) +from openedx.core.djangoapps.notifications.base_notification import COURSE_NOTIFICATION_APPS, COURSE_NOTIFICATION_TYPES from openedx.core.djangoapps.notifications.tasks import delete_notifications - logger = logging.getLogger(__name__) diff --git a/openedx/core/djangoapps/notifications/management/commands/fix_mixed_email_cadence.py b/openedx/core/djangoapps/notifications/management/commands/fix_mixed_email_cadence.py index cf1c5c0c5a7a..3d03c7775266 100644 --- a/openedx/core/djangoapps/notifications/management/commands/fix_mixed_email_cadence.py +++ b/openedx/core/djangoapps/notifications/management/commands/fix_mixed_email_cadence.py @@ -4,6 +4,7 @@ """ import logging + from django.core.management.base import BaseCommand from openedx.core.djangoapps.notifications.models import NotificationPreference diff --git a/openedx/core/djangoapps/notifications/management/commands/send_email_digest.py b/openedx/core/djangoapps/notifications/management/commands/send_email_digest.py index 79857c18cf8a..27a3895a5ee9 100644 --- a/openedx/core/djangoapps/notifications/management/commands/send_email_digest.py +++ b/openedx/core/djangoapps/notifications/management/commands/send_email_digest.py @@ -1,10 +1,15 @@ """ -Management command for sending email digest +Management command for sending email digest. + +DEPRECATED: This command is retained for backward compatibility. +Digest emails are now scheduled automatically via delayed Celery tasks +when notifications are created. Remove any cron jobs calling this command. """ +import warnings + from django.core.management.base import BaseCommand from openedx.core.djangoapps.notifications.email_notifications import EmailCadence -from openedx.core.djangoapps.notifications.email.tasks import send_digest_email_to_all_users class Command(BaseCommand): @@ -13,9 +18,14 @@ class Command(BaseCommand): python manage.py lms send_email_digest [cadence_type] cadence_type: Daily or Weekly + + DEPRECATED: Digest emails are now automatically scheduled via delayed + Celery tasks when notifications are created. """ help = ( - "Send email digest to user." + "DEPRECATED: Send email digest to users. " + "Digest emails are now scheduled automatically. " + "Remove cron jobs using this command." ) def add_arguments(self, parser): @@ -29,4 +39,16 @@ def handle(self, *args, **kwargs): """ Start task to send email digest to users """ - send_digest_email_to_all_users.delay(kwargs['cadence_type']) + warnings.warn( + "The send_email_digest management command is deprecated. " + "Digest emails are now scheduled automatically via delayed Celery tasks " + "when notifications are created. Remove any cron jobs calling this command.", + DeprecationWarning, + stacklevel=2 + ) + self.stderr.write( + self.style.WARNING( + "WARNING: This command is deprecated. Digest emails are now scheduled " + "automatically. Please remove cron jobs using this command." + ) + ) diff --git a/openedx/core/djangoapps/notifications/management/commands/update_notification_preferences.py b/openedx/core/djangoapps/notifications/management/commands/update_notification_preferences.py index 2653e8b1cdad..623427a42f74 100644 --- a/openedx/core/djangoapps/notifications/management/commands/update_notification_preferences.py +++ b/openedx/core/djangoapps/notifications/management/commands/update_notification_preferences.py @@ -6,11 +6,8 @@ from django.core.management.base import BaseCommand, CommandError from django.db import transaction +from openedx.core.djangoapps.notifications.base_notification import COURSE_NOTIFICATION_APPS, COURSE_NOTIFICATION_TYPES from openedx.core.djangoapps.notifications.models import NotificationPreference -from openedx.core.djangoapps.notifications.base_notification import ( - COURSE_NOTIFICATION_APPS, - COURSE_NOTIFICATION_TYPES -) logger = logging.getLogger(__name__) diff --git a/openedx/core/djangoapps/notifications/management/tests/test_delete_notifications.py b/openedx/core/djangoapps/notifications/management/tests/test_delete_notifications.py index d4b65fa565c6..f8d3acd25dbb 100644 --- a/openedx/core/djangoapps/notifications/management/tests/test_delete_notifications.py +++ b/openedx/core/djangoapps/notifications/management/tests/test_delete_notifications.py @@ -1,10 +1,9 @@ """ Tests delete_notifications management command """ -import ddt - from unittest import mock +import ddt from django.core.management import call_command from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase @@ -29,7 +28,7 @@ def test_management_command_fails_if_required_param_is_missing(self, param): default_dict.pop(param) try: call_command('delete_notifications', **default_dict) - assert False + assert False # noqa: B011, PT015 except Exception: # pylint: disable=broad-except pass diff --git a/openedx/core/djangoapps/notifications/migrations/0001_initial.py b/openedx/core/djangoapps/notifications/migrations/0001_initial.py index 510e4b877bf6..812335a26d0a 100644 --- a/openedx/core/djangoapps/notifications/migrations/0001_initial.py +++ b/openedx/core/djangoapps/notifications/migrations/0001_initial.py @@ -1,10 +1,10 @@ # Generated by Django 3.2.18 on 2023-04-12 23:07 -from django.conf import settings -from django.db import migrations, models import django.db.models.deletion import django.utils.timezone import model_utils.fields +from django.conf import settings +from django.db import migrations, models class Migration(migrations.Migration): diff --git a/openedx/core/djangoapps/notifications/migrations/0002_notificationpreference.py b/openedx/core/djangoapps/notifications/migrations/0002_notificationpreference.py index e1b409c17491..06a2f703261b 100644 --- a/openedx/core/djangoapps/notifications/migrations/0002_notificationpreference.py +++ b/openedx/core/djangoapps/notifications/migrations/0002_notificationpreference.py @@ -1,11 +1,11 @@ # Generated by Django 3.2.18 on 2023-05-03 09:05 -from django.conf import settings -from django.db import migrations, models import django.db.models.deletion import django.utils.timezone import model_utils.fields import opaque_keys.edx.django.models +from django.conf import settings +from django.db import migrations, models class Migration(migrations.Migration): diff --git a/openedx/core/djangoapps/notifications/migrations/0004_auto_20230607_0757.py b/openedx/core/djangoapps/notifications/migrations/0004_auto_20230607_0757.py index ba9ebfb796c3..f894d2fcaea5 100644 --- a/openedx/core/djangoapps/notifications/migrations/0004_auto_20230607_0757.py +++ b/openedx/core/djangoapps/notifications/migrations/0004_auto_20230607_0757.py @@ -1,10 +1,10 @@ # Generated by Django 3.2.19 on 2023-06-07 07:57 -from django.conf import settings -from django.db import migrations, models import django.utils.timezone import model_utils.fields import opaque_keys.edx.django.models +from django.conf import settings +from django.db import migrations, models class Migration(migrations.Migration): diff --git a/openedx/core/djangoapps/notifications/migrations/0008_notificationpreference.py b/openedx/core/djangoapps/notifications/migrations/0008_notificationpreference.py index 4427906ca4b5..652215d50685 100644 --- a/openedx/core/djangoapps/notifications/migrations/0008_notificationpreference.py +++ b/openedx/core/djangoapps/notifications/migrations/0008_notificationpreference.py @@ -1,10 +1,10 @@ # Generated by Django 4.2.21 on 2025-05-29 08:27 -from django.conf import settings -from django.db import migrations, models import django.db.models.deletion import django.utils.timezone import model_utils.fields +from django.conf import settings +from django.db import migrations, models class Migration(migrations.Migration): diff --git a/openedx/core/djangoapps/notifications/migrations/0012_digestschedule.py b/openedx/core/djangoapps/notifications/migrations/0012_digestschedule.py new file mode 100644 index 000000000000..70b935700203 --- /dev/null +++ b/openedx/core/djangoapps/notifications/migrations/0012_digestschedule.py @@ -0,0 +1,33 @@ +# Generated by Django 5.2.12 on 2026-03-16 08:19 + +import django.db.models.deletion +import django.utils.timezone +import model_utils.fields +from django.conf import settings +from django.db import migrations, models + + +class Migration(migrations.Migration): + + dependencies = [ + ('notifications', '0011_notification_email_scheduled_and_more'), + migrations.swappable_dependency(settings.AUTH_USER_MODEL), + ] + + operations = [ + migrations.CreateModel( + name='DigestSchedule', + fields=[ + ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), + ('created', model_utils.fields.AutoCreatedField(default=django.utils.timezone.now, editable=False, verbose_name='created')), + ('modified', model_utils.fields.AutoLastModifiedField(default=django.utils.timezone.now, editable=False, verbose_name='modified')), + ('cadence_type', models.CharField(max_length=20)), + ('delivery_time', models.DateTimeField()), + ('task_id', models.CharField(max_length=255)), + ('user', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='digest_schedules', to=settings.AUTH_USER_MODEL)), + ], + options={ + 'unique_together': {('user', 'cadence_type', 'delivery_time')}, + }, + ), + ] diff --git a/openedx/core/djangoapps/notifications/models.py b/openedx/core/djangoapps/notifications/models.py index 5cd76a01d24c..3ea59d94be43 100644 --- a/openedx/core/djangoapps/notifications/models.py +++ b/openedx/core/djangoapps/notifications/models.py @@ -9,8 +9,9 @@ from opaque_keys.edx.django.models import CourseKeyField from openedx.core.djangoapps.notifications.base_notification import ( + COURSE_NOTIFICATION_TYPES, + get_default_values_of_preferences, get_notification_content, - COURSE_NOTIFICATION_TYPES, get_default_values_of_preferences ) User = get_user_model() @@ -46,7 +47,7 @@ class Notification(TimeStampedModel): app_name = models.CharField(max_length=64, db_index=True) notification_type = models.CharField(max_length=64) content_context = models.JSONField(default=dict) - content_url = models.URLField(null=True, blank=True) + content_url = models.URLField(null=True, blank=True) # noqa: DJ001 web = models.BooleanField(default=True, null=False, blank=False) email = models.BooleanField(default=False, null=False, blank=False) push = models.BooleanField(default=False, null=False, blank=False) @@ -81,7 +82,9 @@ def content(self): class NotificationPreference(TimeStampedModel): """ - Model to store notification preferences for users at account level + Model to store notification preferences for users at account level. + + .. no_pii: """ class EmailCadenceChoices(models.TextChoices): @@ -176,6 +179,34 @@ def get_email_cadence_for_notification_type(self, *args, **kwargs) -> str: return self.email_cadence +class DigestSchedule(TimeStampedModel): + """ + Tracks scheduled Celery digest tasks for daily/weekly email digests. + + One record exists per (user, cadence_type, delivery_time) combination, + representing a single pending Celery task. This is the source of truth for + deduplication of digest scheduling. + + NOTE: This is intentionally separate from Notification.email_scheduled. + Notification.email_scheduled serves the immediate/buffer cadence flow + (decide_email_action → schedule_digest_buffer → send_buffered_digest) and + operates at the notification row level. DigestSchedule operates at the + task level — one record per scheduled Celery job — for daily/weekly digests only. + + .. no_pii: + """ + user = models.ForeignKey(User, related_name="digest_schedules", on_delete=models.CASCADE) + cadence_type = models.CharField(max_length=20) + delivery_time = models.DateTimeField() + task_id = models.CharField(max_length=255) + + class Meta: + unique_together = ('user', 'cadence_type', 'delivery_time') + + def __str__(self): + return f'{self.user.username} - {self.cadence_type} - {self.delivery_time} (task={self.task_id})' + + def create_notification_preference(user_id: int, notification_type: str) -> NotificationPreference: """ Create a single notification preference with appropriate defaults. diff --git a/openedx/core/djangoapps/notifications/notification_content.py b/openedx/core/djangoapps/notifications/notification_content.py index aa1e87d00254..f7ead44235ae 100644 --- a/openedx/core/djangoapps/notifications/notification_content.py +++ b/openedx/core/djangoapps/notifications/notification_content.py @@ -1,7 +1,7 @@ """ Helper functions for overriding notification content for given notification type. """ -from typing import Dict +from typing import Dict # noqa: UP035 def get_notification_type_context_function(notification_type) -> callable: @@ -15,7 +15,7 @@ def get_notification_type_context_function(notification_type) -> callable: return lambda context: context -def get_notification_context_with_author_pronoun(context: Dict) -> Dict: +def get_notification_context_with_author_pronoun(context: Dict) -> Dict: # noqa: UP006 """ Returns the context for the given notification type with the author pronoun. diff --git a/openedx/core/djangoapps/notifications/serializers.py b/openedx/core/djangoapps/notifications/serializers.py index ce2fccb926b4..d50b180115ac 100644 --- a/openedx/core/djangoapps/notifications/serializers.py +++ b/openedx/core/djangoapps/notifications/serializers.py @@ -8,7 +8,7 @@ from openedx.core.djangoapps.notifications.models import ( Notification, get_additional_notification_channel_settings, - get_notification_channels + get_notification_channels, ) from .base_notification import COURSE_NOTIFICATION_APPS, COURSE_NOTIFICATION_TYPES, EmailCadence @@ -138,17 +138,6 @@ def validate_notification_channel(notification_channel: str) -> str: return notification_channel -def get_non_editable_channels(app_name): - """ - Returns a dict of notification: [non-editable channels] for the given app name. - """ - non_editable = {"core": COURSE_NOTIFICATION_APPS[app_name].get("non_editable", [])} - for type_name, type_dict in COURSE_NOTIFICATION_TYPES.items(): - if type_dict.get("non_editable") and not type_dict["is_core"]: - non_editable[type_name] = type_dict["non_editable"] - return non_editable - - def add_non_editable_in_preference(preference): """ Add non_editable preferences to the preference dict @@ -191,7 +180,7 @@ def validate(self, attrs): """ Cross-field validation for notification preference update. """ - notification_app = attrs.get('notification_app') + notification_app = attrs.get('notification_app') # noqa: F841 notification_type = attrs.get('notification_type') notification_channel = attrs.get('notification_channel') email_cadence = attrs.get('email_cadence') @@ -211,7 +200,6 @@ def validate(self, attrs): # Validate notification type if all([ not COURSE_NOTIFICATION_TYPES.get(notification_type), - notification_type != "core", notification_type != "grouped_notification", ]): raise ValidationError(f'{notification_type} is not a valid notification type.') diff --git a/openedx/core/djangoapps/notifications/settings_override.py b/openedx/core/djangoapps/notifications/settings_override.py index 9e20dfff5e68..760c870546f4 100644 --- a/openedx/core/djangoapps/notifications/settings_override.py +++ b/openedx/core/djangoapps/notifications/settings_override.py @@ -5,15 +5,16 @@ via Django settings. """ from copy import deepcopy -from typing import Dict, Set, Any +from typing import Any, Dict, Set # noqa: UP035 + from django.conf import settings def _apply_overrides( - default_config: Dict[str, Any], + default_config: Dict[str, Any], # noqa: UP006 setting_name: str, - allowed_keys: Set[str] -) -> Dict[str, Any]: + allowed_keys: Set[str] # noqa: UP006 +) -> Dict[str, Any]: # noqa: UP006 """ Internal helper to apply settings overrides to a default configuration dictionary. @@ -36,7 +37,7 @@ def _apply_overrides( return config -def get_notification_types_config() -> Dict[str, Any]: +def get_notification_types_config() -> Dict[str, Any]: # noqa: UP006 """ Get COURSE_NOTIFICATION_TYPES configuration with settings overrides applied. """ @@ -49,7 +50,7 @@ def get_notification_types_config() -> Dict[str, Any]: ) -def get_notification_apps_config() -> Dict[str, Any]: +def get_notification_apps_config() -> Dict[str, Any]: # noqa: UP006 """ Get COURSE_NOTIFICATION_APPS configuration with settings overrides applied. """ diff --git a/openedx/core/djangoapps/notifications/tasks.py b/openedx/core/djangoapps/notifications/tasks.py index f44e4ce19729..4dc8c76b1f6a 100644 --- a/openedx/core/djangoapps/notifications/tasks.py +++ b/openedx/core/djangoapps/notifications/tasks.py @@ -3,6 +3,7 @@ """ import uuid from datetime import datetime, timedelta +from zoneinfo import ZoneInfo from celery import shared_task from celery.utils.log import get_task_logger @@ -10,36 +11,35 @@ from django.core.exceptions import ValidationError from edx_django_utils.monitoring import set_code_owner_attribute from opaque_keys.edx.keys import CourseKey -from zoneinfo import ZoneInfo from openedx.core.djangoapps.notifications.audience_filters import NotificationFilter from openedx.core.djangoapps.notifications.base_notification import ( COURSE_NOTIFICATION_TYPES, - get_default_values_of_preference, - get_notification_content + get_default_values_of_preferences, + get_notification_content, ) - -from openedx.core.djangoapps.notifications.email.tasks import send_immediate_cadence_email -from openedx.core.djangoapps.notifications.config.waffle import ( - ENABLE_NOTIFICATIONS, - ENABLE_PUSH_NOTIFICATIONS +from openedx.core.djangoapps.notifications.config.waffle import DISABLE_NOTIFICATIONS, ENABLE_PUSH_NOTIFICATIONS +from openedx.core.djangoapps.notifications.email.tasks import ( + schedule_bulk_digest_emails, + send_immediate_cadence_email, ) from openedx.core.djangoapps.notifications.email_notifications import EmailCadence from openedx.core.djangoapps.notifications.events import notification_generated_event from openedx.core.djangoapps.notifications.grouping_notifications import ( NotificationRegistry, get_user_existing_notifications, - group_user_notifications + group_user_notifications, ) from openedx.core.djangoapps.notifications.models import ( Notification, - NotificationPreference, create_notification_preference, + NotificationPreference, + create_notification_preference, ) from openedx.core.djangoapps.notifications.push.tasks import send_ace_msg_to_push_channel from openedx.core.djangoapps.notifications.utils import ( clean_arguments, + create_account_notification_pref_if_not_exists, get_list_in_batches, - create_account_notification_pref_if_not_exists ) logger = get_task_logger(__name__) @@ -105,11 +105,10 @@ def send_notifications(user_ids, course_key: str, app_name, notification_type, c """ Send notifications to the users. """ - # pylint: disable=too-many-statements - course_key = CourseKey.from_string(course_key) - if not ENABLE_NOTIFICATIONS.is_enabled(): + if DISABLE_NOTIFICATIONS.is_enabled(): return + course_key = CourseKey.from_string(course_key) if not is_notification_valid(notification_type, context): raise ValidationError(f"Notification is not valid {app_name} {notification_type} {context}") @@ -120,9 +119,10 @@ def send_notifications(user_ids, course_key: str, app_name, notification_type, c grouping_enabled = group_by_id and grouping_function is not None generated_notification = None sender_id = context.pop('sender_id', None) - default_web_config = get_default_values_of_preference(app_name, notification_type).get('web', False) + default_web_config = get_default_values_of_preferences().get(notification_type, {}).get('web', False) generated_notification_audience = [] email_notification_mapping = {} + digest_schedule_users = {} # {user_id: cadence_type} for daily/weekly digest scheduling push_notification_audience = [] is_push_notification_enabled = ENABLE_PUSH_NOTIFICATIONS.is_enabled(course_key) task_id = str(uuid.uuid4()) @@ -182,6 +182,9 @@ def send_notifications(user_ids, course_key: str, app_name, notification_type, c if email_enabled and (email_cadence == EmailCadence.IMMEDIATELY): email_notification_user_ids.append(user_id) + if email_enabled and email_cadence in (EmailCadence.DAILY, EmailCadence.WEEKLY): + digest_schedule_users[user_id] = email_cadence + if push_notification: push_notification_audience.append(user_id) @@ -216,6 +219,19 @@ def send_notifications(user_ids, course_key: str, app_name, notification_type, c ) send_immediate_cadence_email(email_notification_mapping, course_key) + # Schedule delayed digest emails for users with Daily/Weekly cadence + if digest_schedule_users: + logger.info( + f"Scheduling digest emails for {len(digest_schedule_users)} users " + f"for notification {notification_type}", + ) + try: + schedule_bulk_digest_emails(digest_schedule_users) + except Exception: # pylint: disable=broad-except + logger.exception( + f"Failed to bulk schedule digest emails for {len(digest_schedule_users)} users" + ) + if generated_notification: notification_generated_event( generated_notification_audience, app_name, notification_type, course_key, content_url, diff --git a/openedx/core/djangoapps/notifications/tests/test_filters.py b/openedx/core/djangoapps/notifications/tests/test_filters.py index c8e0bdfccfb7..faad699ae440 100644 --- a/openedx/core/djangoapps/notifications/tests/test_filters.py +++ b/openedx/core/djangoapps/notifications/tests/test_filters.py @@ -3,6 +3,7 @@ """ from datetime import timedelta from unittest import mock +from unittest.mock import patch import ddt from django.utils.timezone import now @@ -10,25 +11,25 @@ from common.djangoapps.course_modes.models import CourseMode from common.djangoapps.student.models import CourseEnrollment from common.djangoapps.student.roles import CourseInstructorRole, CourseStaffRole -from common.djangoapps.student.tests.factories import UserFactory, CourseEnrollmentFactory +from common.djangoapps.student.tests.factories import CourseEnrollmentFactory, UserFactory from lms.djangoapps.teams.tests.factories import CourseTeamFactory, CourseTeamMembershipFactory from openedx.core.djangoapps.content.course_overviews.models import CourseOverview from openedx.core.djangoapps.course_groups.tests.helpers import CohortFactory from openedx.core.djangoapps.django_comment_common.models import ( FORUM_ROLE_ADMINISTRATOR, FORUM_ROLE_COMMUNITY_TA, - FORUM_ROLE_STUDENT, FORUM_ROLE_GROUP_MODERATOR, FORUM_ROLE_MODERATOR, + FORUM_ROLE_STUDENT, Role, ) from openedx.core.djangoapps.notifications.audience_filters import ( + CohortAudienceFilter, + CourseRoleAudienceFilter, EnrollmentAudienceFilter, ForumRoleAudienceFilter, - CourseRoleAudienceFilter, - CohortAudienceFilter, - TeamAudienceFilter, NotificationFilter, + TeamAudienceFilter, ) from openedx.core.djangoapps.notifications.handlers import calculate_course_wide_notification_audience from openedx.features.course_duration_limits.models import CourseDurationLimitConfig @@ -42,7 +43,13 @@ class CourseExpirationTestCase(ModuleStoreTestCase): """Tests to verify the get_user_course_expiration_date function is working correctly""" def setUp(self): - super().setUp() # lint-amnesty, pylint: disable=super-with-arguments + super().setUp() # pylint: disable=super-with-arguments + self.catalog_patch = patch( + 'openedx.core.djangoapps.catalog.models.CatalogIntegration.is_enabled', + return_value=True + ) + self.catalog_patch.start() + self.course = CourseFactory( start=now() - timedelta(weeks=10), ) @@ -58,6 +65,10 @@ def setUp(self): expired_audit.created = now() - timedelta(weeks=6) expired_audit.save() + def tearDown(self): + self.catalog_patch.stop() + super().tearDown() + @mock.patch("openedx.core.djangoapps.course_date_signals.utils.get_course_run_details") def test_audit_expired_filter_with_no_role( self, @@ -72,14 +83,14 @@ def test_audit_expired_filter_with_no_role( [self.user.id, self.user_1.id], self.course, ) - self.assertEqual([self.user_1.id], result) + self.assertEqual([self.user_1.id], result) # noqa: PT009 mock_get_course_run_details.return_value = {'weeks_to_complete': 7} result = NotificationFilter().filter_audit_expired_users_with_no_role( [self.user.id, self.user_1.id], self.course, ) - self.assertEqual([self.user.id, self.user_1.id], result) + self.assertEqual([self.user.id, self.user_1.id], result) # noqa: PT009 CourseDurationLimitConfig.objects.create( enabled=True, @@ -92,7 +103,7 @@ def test_audit_expired_filter_with_no_role( [self.user.id, self.user_1.id], self.course, ) - self.assertEqual([self.user.id, self.user_1.id], result) + self.assertEqual([self.user.id, self.user_1.id], result) # noqa: PT009 @mock.patch("openedx.core.djangoapps.course_date_signals.utils.get_course_run_details") @mock.patch( @@ -113,7 +124,7 @@ def test_apply_filter( self.course.id, 'new_comment_on_response' ) - self.assertEqual([self.user.id, self.user_1.id], result) + self.assertEqual([self.user.id, self.user_1.id], result) # noqa: PT009 mock_filter_audit_expired.assert_called_once() @mock.patch("openedx.core.djangoapps.course_date_signals.utils.get_course_run_details") @@ -130,13 +141,13 @@ def test_audit_expired_for_course_staff( [self.user.id, self.user_1.id], self.course, ) - self.assertEqual([self.user_1.id], result) + self.assertEqual([self.user_1.id], result) # noqa: PT009 CourseInstructorRole(self.course.id).add_users(self.user) result = NotificationFilter().filter_audit_expired_users_with_no_role( [self.user.id, self.user_1.id], self.course, ) - self.assertEqual([self.user.id, self.user_1.id], result) + self.assertEqual([self.user.id, self.user_1.id], result) # noqa: PT009 @mock.patch("openedx.core.djangoapps.course_date_signals.utils.get_course_run_details") @ddt.data( @@ -160,14 +171,14 @@ def test_audit_expired_for_forum_roles( [self.user.id, self.user_1.id], self.course, ) - self.assertEqual([self.user_1.id], result) + self.assertEqual([self.user_1.id], result) # noqa: PT009 role = Role.objects.get_or_create(course_id=self.course.id, name=role_name)[0] role.users.add(self.user.id) result = NotificationFilter().filter_audit_expired_users_with_no_role( [self.user.id, self.user_1.id], self.course, ) - self.assertEqual([self.user.id, self.user_1.id], result) + self.assertEqual([self.user.id, self.user_1.id], result) # noqa: PT009 def assign_enrollment_mode_to_users(course_id, users, mode): @@ -195,7 +206,7 @@ class TestEnrollmentAudienceFilter(ModuleStoreTestCase): Tests for the EnrollmentAudienceFilter. """ def setUp(self): - super().setUp() # lint-amnesty, pylint: disable=super-with-arguments + super().setUp() # pylint: disable=super-with-arguments self.course = CourseFactory() self.students = [UserFactory() for _ in range(30)] @@ -220,12 +231,12 @@ def setUp(self): def test_valid_enrollment_filter(self, enrollment_modes, expected_count): enrollment_filter = EnrollmentAudienceFilter(self.course.id) filtered_users = enrollment_filter.filter(enrollment_modes) - self.assertEqual(len(filtered_users), expected_count) + self.assertEqual(len(filtered_users), expected_count) # noqa: PT009 def test_invalid_enrollment_filter(self): enrollment_filter = EnrollmentAudienceFilter(self.course.id) enrollment_modes = ["INVALID_MODE"] - with self.assertRaises(ValueError): + with self.assertRaises(ValueError): # noqa: PT027 enrollment_filter.filter(enrollment_modes) @@ -235,7 +246,7 @@ class TestForumRoleAudienceFilter(ModuleStoreTestCase): Tests for the ForumRoleAudienceFilter. """ def setUp(self): - super().setUp() # lint-amnesty, pylint: disable=super-with-arguments + super().setUp() # pylint: disable=super-with-arguments self.course = CourseFactory() self.students = [UserFactory() for _ in range(25)] @@ -271,12 +282,12 @@ def setUp(self): def test_valid_role_filter(self, role_names, expected_count): role_filter = ForumRoleAudienceFilter(self.course.id) filtered_users = role_filter.filter(role_names) - self.assertEqual(len(filtered_users), expected_count) + self.assertEqual(len(filtered_users), expected_count) # noqa: PT009 def test_invalid_role_filter(self): role_filter = ForumRoleAudienceFilter(self.course.id) role_names = ["INVALID_MODE"] - with self.assertRaises(ValueError): + with self.assertRaises(ValueError): # noqa: PT027 role_filter.filter(role_names) @@ -287,7 +298,7 @@ class TestCourseRoleAudienceFilter(ModuleStoreTestCase): Tests for the CourseRoleAudienceFilter. """ def setUp(self): - super().setUp() # lint-amnesty, pylint: disable=super-with-arguments + super().setUp() # pylint: disable=super-with-arguments self.course = CourseFactory() self.students = [UserFactory() for _ in range(10)] @@ -308,12 +319,12 @@ def setUp(self): def test_valid_role_filter(self, role_names, expected_count): course_role_filter = CourseRoleAudienceFilter(self.course.id) filtered_users = course_role_filter.filter(role_names) - self.assertEqual(len(filtered_users), expected_count) + self.assertEqual(len(filtered_users), expected_count) # noqa: PT009 def test_invalid_role_filter(self): course_role_filter = CourseRoleAudienceFilter(self.course.id) role_names = ["INVALID_MODE"] - with self.assertRaises(ValueError): + with self.assertRaises(ValueError): # noqa: PT027 course_role_filter.filter(role_names) @@ -323,7 +334,7 @@ class TestCohortAudienceFilter(ModuleStoreTestCase): Tests for the CohortAudienceFilter. """ def setUp(self): - super().setUp() # lint-amnesty, pylint: disable=super-with-arguments + super().setUp() # pylint: disable=super-with-arguments self.course = CourseFactory() self.cohort1_users = [UserFactory() for _ in range(3)] @@ -346,12 +357,12 @@ def setUp(self): def test_valid_cohort_filter(self, cohort_ids, expected_count): cohort_filter = CohortAudienceFilter(self.course.id) filtered_users = cohort_filter.filter(cohort_ids) - self.assertEqual(len(filtered_users), expected_count) + self.assertEqual(len(filtered_users), expected_count) # noqa: PT009 def test_invalid_cohort_filter(self): cohort_filter = CohortAudienceFilter(self.course.id) cohort_ids = ["INVALID_MODE"] - with self.assertRaises(ValueError): + with self.assertRaises(ValueError): # noqa: PT027 cohort_filter.filter(cohort_ids) @@ -361,7 +372,7 @@ class TestTeamAudienceFilter(ModuleStoreTestCase): Tests for the TeamAudienceFilter. """ def setUp(self): - super().setUp() # lint-amnesty, pylint: disable=super-with-arguments + super().setUp() # pylint: disable=super-with-arguments self.course = CourseFactory() self.teams = [CourseTeamFactory(course_id=self.course.id, team_id=f"team-{i}") for i in range(2)] @@ -388,12 +399,12 @@ def setUp(self): def test_valid_team_filter(self, team_ids, expected_count): team_filter = TeamAudienceFilter(self.course.id) filtered_users = team_filter.filter(team_ids) - self.assertEqual(len(filtered_users), expected_count) + self.assertEqual(len(filtered_users), expected_count) # noqa: PT009 def test_invalid_team_filter(self): team_filter = TeamAudienceFilter(self.course.id) team_ids = ["INVALID_MODE"] - with self.assertRaises(ValueError): + with self.assertRaises(ValueError): # noqa: PT027 team_filter.filter(team_ids) @@ -403,7 +414,7 @@ class TestAudienceFilter(ModuleStoreTestCase): Tests for audience filtration based on different filters. """ def setUp(self): - super().setUp() # lint-amnesty, pylint: disable=super-with-arguments + super().setUp() # pylint: disable=super-with-arguments self.course = CourseFactory() self.students = [UserFactory() for _ in range(30)] @@ -448,11 +459,11 @@ def setUp(self): @ddt.unpack def test_combination_of_audience_filters(self, audience_filters, expected_count): user_ids = calculate_course_wide_notification_audience(self.course.id, audience_filters) - self.assertEqual(len(user_ids), expected_count) + self.assertEqual(len(user_ids), expected_count) # noqa: PT009 def test_invalid_audience_filter(self): audience_filters = { "invalid_filter": ["invalid_filter_type"], } - with self.assertRaises(ValueError): + with self.assertRaises(ValueError): # noqa: PT027 calculate_course_wide_notification_audience(self.course.id, audience_filters) diff --git a/openedx/core/djangoapps/notifications/tests/test_handlers.py b/openedx/core/djangoapps/notifications/tests/test_handlers.py index d349c7a16e1a..1714a7577e1c 100644 --- a/openedx/core/djangoapps/notifications/tests/test_handlers.py +++ b/openedx/core/djangoapps/notifications/tests/test_handlers.py @@ -1,10 +1,11 @@ """ Tests for the notifications handlers. """ -from django.test import TestCase from unittest.mock import patch -from openedx_events.learning.signals import COURSE_NOTIFICATION_REQUESTED + +from django.test import TestCase from openedx_events.learning.data import CourseNotificationData +from openedx_events.learning.signals import COURSE_NOTIFICATION_REQUESTED class CourseNotificationsTest(TestCase): @@ -35,4 +36,4 @@ def test_generate_course_notifications(self, mock_send_notifications, mock_calcu # Check if the sender_id was removed from the user_ids expected_user_ids = [1, 2, 4] # 3 should be removed notification_data = mock_send_notifications.delay.call_args[1] - self.assertEqual(notification_data['user_ids'], expected_user_ids) + self.assertEqual(notification_data['user_ids'], expected_user_ids) # noqa: PT009 diff --git a/openedx/core/djangoapps/notifications/tests/test_notification_grouping.py b/openedx/core/djangoapps/notifications/tests/test_notification_grouping.py index 7c0def059d7b..7501f6a16ea0 100644 --- a/openedx/core/djangoapps/notifications/tests/test_notification_grouping.py +++ b/openedx/core/djangoapps/notifications/tests/test_notification_grouping.py @@ -2,18 +2,22 @@ Tests for notification grouping module """ -import ddt import unittest -from unittest.mock import MagicMock, patch from datetime import datetime +from unittest.mock import MagicMock, patch from zoneinfo import ZoneInfo +import ddt + from common.djangoapps.student.tests.factories import UserFactory from openedx.core.djangoapps.notifications.grouping_notifications import ( BaseNotificationGrouper, + NewPostGrouper, + NewResponseGrouper, + NewResponseOnFollowedPostGrouper, NotificationRegistry, + get_user_existing_notifications, group_user_notifications, - get_user_existing_notifications, NewPostGrouper, NewResponseGrouper, NewResponseOnFollowedPostGrouper ) from openedx.core.djangoapps.notifications.models import Notification from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase @@ -40,14 +44,14 @@ def group(self, new_notification, old_notification): NotificationRegistry.register('test_notification')(TestGrouper) grouper = NotificationRegistry.get_grouper('test_notification') - self.assertIsInstance(grouper, TestGrouper) + self.assertIsInstance(grouper, TestGrouper) # noqa: PT009 def test_get_grouper_returns_none_for_unregistered_type(self): """ Test that get_grouper returns None for an unregistered notification type """ grouper = NotificationRegistry.get_grouper('non_existent') - self.assertIsNone(grouper) + self.assertIsNone(grouper) # noqa: PT009 class TestNewPostGrouper(unittest.TestCase): @@ -68,8 +72,8 @@ def test_group(self): updated_context = NewPostGrouper().group(new_notification, old_notification) - self.assertTrue(updated_context['grouped']) - self.assertEqual(updated_context['replier_name'], new_notification.content_context['replier_name']) + self.assertTrue(updated_context['grouped']) # noqa: PT009 + self.assertEqual(updated_context['replier_name'], new_notification.content_context['replier_name']) # noqa: PT009 # pylint: disable=line-too-long def test_new_post_with_same_user(self): """ @@ -88,7 +92,7 @@ def test_new_post_with_same_user(self): updated_context = NewPostGrouper().group(new_notification, old_notification) - self.assertFalse(updated_context.get('grouped', False)) + self.assertFalse(updated_context.get('grouped', False)) # noqa: PT009 @ddt.ddt @@ -113,10 +117,10 @@ def test_group_user_notifications(self, grouper_class, mock_get_grouper): group_user_notifications(new_notification, old_notification) mock_grouper.group.assert_called_once_with(new_notification, old_notification) - self.assertTrue(old_notification.save.called) - self.assertIsNone(old_notification.last_read) - self.assertIsNone(old_notification.last_seen) - self.assertIsNotNone(old_notification.created) + self.assertTrue(old_notification.save.called) # noqa: PT009 + self.assertIsNone(old_notification.last_read) # noqa: PT009 + self.assertIsNone(old_notification.last_seen) # noqa: PT009 + self.assertIsNotNone(old_notification.created) # noqa: PT009 def test_group_user_notifications_no_grouper(self): """ @@ -127,7 +131,7 @@ def test_group_user_notifications_no_grouper(self): group_user_notifications(new_notification, old_notification) - self.assertFalse(old_notification.save.called) + self.assertFalse(old_notification.save.called) # noqa: PT009 @ddt.data(datetime(2023, 1, 1, tzinfo=ZoneInfo("UTC")), None) def test_not_grouped_when_notification_is_seen(self, last_seen): @@ -189,5 +193,5 @@ def test_get_user_existing_notifications(self, mock_filter): result = get_user_existing_notifications(user_ids, notification_type, group_by_id, course_id) # Verify the results - self.assertEqual(result[1], mock_notification2) - self.assertIsNone(result[2]) # user 2 has no notifications + self.assertEqual(result[1], mock_notification2) # noqa: PT009 + self.assertIsNone(result[2]) # user 2 has no notifications # noqa: PT009 diff --git a/openedx/core/djangoapps/notifications/tests/test_settings_override.py b/openedx/core/djangoapps/notifications/tests/test_settings_override.py index 86776ac69065..f06de829e2ec 100644 --- a/openedx/core/djangoapps/notifications/tests/test_settings_override.py +++ b/openedx/core/djangoapps/notifications/tests/test_settings_override.py @@ -5,11 +5,11 @@ from openedx.core.djangoapps.notifications.base_notification import ( _COURSE_NOTIFICATION_APPS, - _COURSE_NOTIFICATION_TYPES + _COURSE_NOTIFICATION_TYPES, ) from openedx.core.djangoapps.notifications.settings_override import ( get_notification_apps_config, - get_notification_types_config + get_notification_types_config, ) @@ -34,17 +34,17 @@ def test_override_notification_types_real_config(self): target_notification = config['new_comment_on_response'] - self.assertTrue( + self.assertTrue( # noqa: PT009 target_notification['email'], "The 'email' setting should be overridden to True." ) - self.assertTrue( + self.assertTrue( # noqa: PT009 target_notification['use_app_defaults'], "The 'use_app_defaults' field should not be overridable via settings." ) # IMMUTABILITY CHECK: Ensure the global module variable wasn't touched - self.assertFalse( + self.assertFalse( # noqa: PT009 _COURSE_NOTIFICATION_TYPES['new_discussion_post']['email'], "The original global _COURSE_NOTIFICATION_TYPES must remain immutable." ) @@ -58,7 +58,7 @@ def test_override_types_ignores_unknown_keys(self): is safely ignored. """ config = get_notification_types_config() - self.assertNotIn('non_existent_notification', config) + self.assertNotIn('non_existent_notification', config) # noqa: PT009 @override_settings(NOTIFICATION_APPS_OVERRIDE={ 'discussion': { @@ -74,17 +74,17 @@ def test_override_notification_apps_real_config(self): target_app = config['discussion'] - self.assertFalse( + self.assertFalse( # noqa: PT009 target_app['email'], "The 'email' setting should be overridden to False." ) - self.assertTrue( + self.assertTrue( # noqa: PT009 target_app['enabled'], "The 'enabled' field should not be overridable via settings." ) - self.assertTrue( + self.assertTrue( # noqa: PT009 _COURSE_NOTIFICATION_APPS['discussion']['email'], "The original global _COURSE_NOTIFICATION_APPS must remain immutable." ) @@ -99,9 +99,9 @@ def test_partial_update_preserves_other_fields(self): config = get_notification_types_config() target = config['course_updates'] - self.assertFalse(target['web']) + self.assertFalse(target['web']) # noqa: PT009 - self.assertTrue( + self.assertTrue( # noqa: PT009 target['email'], "The 'email' field should be preserved from the default config." ) @@ -119,7 +119,7 @@ def test_override_notification_types_email_cadence(self): config = get_notification_types_config() target = config['new_discussion_post'] - self.assertEqual( + self.assertEqual( # noqa: PT009 target.get('email_cadence'), 'Weekly', "The 'email_cadence' setting should be overridden to 'Weekly'." @@ -138,7 +138,7 @@ def test_override_notification_apps_email_cadence(self): config = get_notification_apps_config() target_app = config['discussion'] - self.assertEqual( + self.assertEqual( # noqa: PT009 target_app.get('email_cadence'), 'Immediately', "The 'email_cadence' setting should be overridden to 'Immediately'." diff --git a/openedx/core/djangoapps/notifications/tests/test_tasks_with_account_level_pref.py b/openedx/core/djangoapps/notifications/tests/test_tasks_with_account_level_pref.py index 3407b42c4b8c..8ba8646a1b06 100644 --- a/openedx/core/djangoapps/notifications/tests/test_tasks_with_account_level_pref.py +++ b/openedx/core/djangoapps/notifications/tests/test_tasks_with_account_level_pref.py @@ -15,12 +15,9 @@ from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase from xmodule.modulestore.tests.factories import CourseFactory -from ..config.waffle import ENABLE_NOTIFICATIONS +from ..config.waffle import DISABLE_NOTIFICATIONS from ..models import Notification, NotificationPreference -from ..tasks import ( - delete_notifications, - send_notifications, -) +from ..tasks import delete_notifications, send_notifications from .utils import create_notification @@ -43,7 +40,6 @@ def setUp(self): run='testrun' ) - @override_waffle_flag(ENABLE_NOTIFICATIONS, active=True) @ddt.data( ('discussion', 'new_comment_on_response'), # core notification ('discussion', 'new_response'), # non core notification @@ -73,18 +69,18 @@ def test_send_notifications(self, app_name, notification_type): if 'uuid' in notification.content_context: notification.content_context.pop('uuid') # Assert that the `Notification` objects have the correct properties. - self.assertEqual(notification.user_id, self.user.id) - self.assertEqual(notification.app_name, app_name) - self.assertEqual(notification.notification_type, notification_type) - self.assertEqual(notification.content_context, context) - self.assertEqual(notification.content_url, content_url) - self.assertEqual(notification.course_id, self.course_1.id) + self.assertEqual(notification.user_id, self.user.id) # noqa: PT009 + self.assertEqual(notification.app_name, app_name) # noqa: PT009 + self.assertEqual(notification.notification_type, notification_type) # noqa: PT009 + self.assertEqual(notification.content_context, context) # noqa: PT009 + self.assertEqual(notification.content_url, content_url) # noqa: PT009 + self.assertEqual(notification.course_id, self.course_1.id) # noqa: PT009 @ddt.data(True, False) def test_enable_notification_flag(self, flag_value): """ - Tests if notification is sent when flag is enabled and notification - is not sent when flag is disabled + Tests that notification is NOT sent when DISABLE_NOTIFICATIONS flag is enabled, + and IS sent when the flag is disabled. """ app_name = "discussion" notification_type = "new_response" @@ -93,12 +89,11 @@ def test_enable_notification_flag(self, flag_value): 'replier_name': 'replier name', } content_url = 'https://example.com/' - with override_waffle_flag(ENABLE_NOTIFICATIONS, active=flag_value): + with override_waffle_flag(DISABLE_NOTIFICATIONS, active=flag_value): send_notifications([self.user.id], str(self.course_1.id), app_name, notification_type, context, content_url) - created_notifications_count = 1 if flag_value else 0 - self.assertEqual(len(Notification.objects.all()), created_notifications_count) + created_notifications_count = 0 if flag_value else 1 + self.assertEqual(len(Notification.objects.all()), created_notifications_count) # noqa: PT009 - @override_waffle_flag(ENABLE_NOTIFICATIONS, active=True) def test_notification_not_send_with_preference_disabled(self): """ Tests notification not send if preference is disabled @@ -122,9 +117,8 @@ def test_notification_not_send_with_preference_disabled(self): account_preferences.save() send_notifications([self.user.id], str(self.course_1.id), app_name, notification_type, context, content_url) - self.assertEqual(len(Notification.objects.all()), 0) + self.assertEqual(len(Notification.objects.all()), 0) # noqa: PT009 - @override_waffle_flag(ENABLE_NOTIFICATIONS, active=True) def test_send_notification_with_grouping_enabled(self): """ Test send_notifications with grouping enabled. @@ -160,15 +154,14 @@ def test_send_notification_with_grouping_enabled(self): {**context}, content_url ) - self.assertEqual(Notification.objects.filter(user_id=self.user.id).count(), 1) + self.assertEqual(Notification.objects.filter(user_id=self.user.id).count(), 1) # noqa: PT009 user_notifications_mock.assert_called_once() - @override_waffle_flag(ENABLE_NOTIFICATIONS, active=True) def test_notification_not_created_when_context_is_incomplete(self): try: send_notifications([self.user.id], str(self.course_1.id), "discussion", "new_comment", {}, "") except Exception as exc: # pylint: disable=broad-except - assert isinstance(exc, ValidationError) + assert isinstance(exc, ValidationError) # noqa: PT017 @ddt.ddt @@ -200,11 +193,10 @@ def _create_users(self, num_of_users): CourseEnrollment.enroll(user=user, course_key=self.course.id) return users - @override_waffle_flag(ENABLE_NOTIFICATIONS, active=True) @ddt.data( - (settings.NOTIFICATION_CREATION_BATCH_SIZE, 10, 3), - (settings.NOTIFICATION_CREATION_BATCH_SIZE + 10, 12, 5), - (settings.NOTIFICATION_CREATION_BATCH_SIZE - 10, 10, 3), + (settings.NOTIFICATION_CREATION_BATCH_SIZE, 11, 4), + (settings.NOTIFICATION_CREATION_BATCH_SIZE + 10, 13, 6), + (settings.NOTIFICATION_CREATION_BATCH_SIZE - 10, 11, 4), ) @ddt.unpack def test_notification_is_send_in_batch(self, creation_size, prefs_query_count, notifications_query_count): @@ -243,10 +235,9 @@ def test_preference_not_created_for_default_off_preference(self): "post_title": "Test Post", "username": "Test Author" } - with override_waffle_flag(ENABLE_NOTIFICATIONS, active=True): - with self.assertNumQueries(10): - send_notifications(user_ids, str(self.course.id), notification_app, notification_type, - context, "http://test.url") + with self.assertNumQueries(11): + send_notifications(user_ids, str(self.course.id), notification_app, notification_type, + context, "http://test.url") def test_preference_created_for_default_on_preference(self): """ @@ -263,12 +254,10 @@ def test_preference_created_for_default_on_preference(self): "author_name": "Test Author", "replier_name": "Replier Name" } - with override_waffle_flag(ENABLE_NOTIFICATIONS, active=True): - with self.assertNumQueries(12): - send_notifications(user_ids, str(self.course.id), notification_app, notification_type, - context, "http://test.url") + with self.assertNumQueries(16): + send_notifications(user_ids, str(self.course.id), notification_app, notification_type, + context, "http://test.url") - @override_waffle_flag(ENABLE_NOTIFICATIONS, active=True) @ddt.data( ("new_response", 2), ("new_response", 2), @@ -294,7 +283,7 @@ def test_preference_enabled_in_batch_audience(self, notification_type, generated } content_url = 'https://example.com/' send_notifications(user_ids, str(self.course.id), app_name, notification_type, context, content_url) - self.assertEqual(len(Notification.objects.all()), generated_count) + self.assertEqual(len(Notification.objects.all()), generated_count) # noqa: PT009 class TestDeleteNotificationTask(ModuleStoreTestCase): @@ -348,7 +337,7 @@ def test_created_param(self): } } delete_notifications(kwargs) - self.assertEqual(Notification.objects.all().count(), 1) + self.assertEqual(Notification.objects.all().count(), 1) # noqa: PT009 def test_course_id_param(self): """ @@ -389,7 +378,6 @@ def setUp(self): email=False, ) - @override_waffle_flag(ENABLE_NOTIFICATIONS, active=True) @ddt.data( (False, False, 0), (False, True, 1), @@ -417,7 +405,7 @@ def test_notification_is_created_when_any_channel_is_account_level(self, web_val 'username': 'user name', }, } - with patch('openedx.core.djangoapps.notifications.tasks.notification_generated_event') as event_mock: + with patch('openedx.core.djangoapps.notifications.tasks.notification_generated_event') as event_mock: # noqa: F841 # pylint: disable=line-too-long send_notifications(**kwargs) notifications = Notification.objects.all() assert len(notifications) == generated_count diff --git a/openedx/core/djangoapps/notifications/tests/test_views.py b/openedx/core/djangoapps/notifications/tests/test_views.py index edb72a629e90..4622d3aec037 100644 --- a/openedx/core/djangoapps/notifications/tests/test_views.py +++ b/openedx/core/djangoapps/notifications/tests/test_views.py @@ -3,6 +3,7 @@ """ from datetime import datetime, timedelta from unittest import mock +from zoneinfo import ZoneInfo import ddt from django.conf import settings @@ -10,37 +11,27 @@ from django.core.cache import cache from django.test.utils import override_settings from django.urls import reverse -from edx_toggles.toggles.testutils import override_waffle_flag -from zoneinfo import ZoneInfo from rest_framework import status from rest_framework.test import APIClient, APITestCase from common.djangoapps.student.models import CourseEnrollment -from common.djangoapps.student.roles import CourseStaffRole, CourseInstructorRole +from common.djangoapps.student.roles import CourseInstructorRole, CourseStaffRole from common.djangoapps.student.tests.factories import UserFactory from lms.djangoapps.discussion.django_comment_client.tests.factories import RoleFactory from openedx.core.djangoapps.content.course_overviews.tests.factories import CourseOverviewFactory from openedx.core.djangoapps.django_comment_common.models import ( FORUM_ROLE_ADMINISTRATOR, FORUM_ROLE_COMMUNITY_TA, - FORUM_ROLE_MODERATOR + FORUM_ROLE_MODERATOR, ) -from openedx.core.djangoapps.notifications.config.waffle import ENABLE_NOTIFICATIONS from openedx.core.djangoapps.notifications.email.utils import encrypt_string -from openedx.core.djangoapps.notifications.models import ( - Notification, - NotificationPreference -) -from openedx.core.djangoapps.notifications.serializers import ( - add_info_to_notification_config, - add_non_editable_in_preference -) +from openedx.core.djangoapps.notifications.models import Notification, NotificationPreference +from openedx.core.djangoapps.notifications.serializers import add_non_editable_in_preference from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase from xmodule.modulestore.tests.factories import CourseFactory -from ..base_notification import COURSE_NOTIFICATION_APPS, NotificationTypeManager, COURSE_NOTIFICATION_TYPES, \ - get_default_values_of_preferences -from ..utils import get_notification_types_with_visibility_settings, exclude_inaccessible_preferences +from ..base_notification import COURSE_NOTIFICATION_APPS, COURSE_NOTIFICATION_TYPES, get_default_values_of_preferences +from ..utils import exclude_inaccessible_preferences, get_notification_types_with_visibility_settings User = get_user_model() @@ -77,13 +68,13 @@ def test_list_notifications(self): # Assert that the response is successful. - self.assertEqual(response.status_code, 200) + self.assertEqual(response.status_code, 200) # noqa: PT009 data = response.data['results'] # Assert that the response contains the notification. - self.assertEqual(len(data), 1) - self.assertEqual(data[0]['app_name'], 'discussion') - self.assertEqual(data[0]['notification_type'], 'new_response') - self.assertEqual( + self.assertEqual(len(data), 1) # noqa: PT009 + self.assertEqual(data[0]['app_name'], 'discussion') # noqa: PT009 + self.assertEqual(data[0]['notification_type'], 'new_response') # noqa: PT009 + self.assertEqual( # noqa: PT009 data[0]['content'], '

          test_user responded to your post This is a test post.

          ' ) @@ -113,14 +104,14 @@ def test_list_notifications_with_app_name_filter(self): response = self.client.get(self.url + "?app_name=discussion") # Assert that the response is successful. - self.assertEqual(response.status_code, 200) + self.assertEqual(response.status_code, 200) # noqa: PT009 # Assert that the response contains only the notification for app1. data = response.data['results'] - self.assertEqual(len(data), 1) - self.assertEqual(data[0]['app_name'], 'discussion') - self.assertEqual(data[0]['notification_type'], 'new_response') - self.assertEqual( + self.assertEqual(len(data), 1) # noqa: PT009 + self.assertEqual(data[0]['app_name'], 'discussion') # noqa: PT009 + self.assertEqual(data[0]['notification_type'], 'new_response') # noqa: PT009 + self.assertEqual( # noqa: PT009 data[0]['content'], '

          test_user responded to your post This is a test post.

          ' ) @@ -156,11 +147,11 @@ def test_list_notifications_with_channels(self, channels, expected_count): response = self.client.get(self.url + "?app_name=discussion") # Assert that the response is successful. - self.assertEqual(response.status_code, 200) + self.assertEqual(response.status_code, 200) # noqa: PT009 # Assert that the response contains expected results i.e. channels contains web or is null. data = response.data['results'] - self.assertEqual(len(data), expected_count) + self.assertEqual(len(data), expected_count) # noqa: PT009 @mock.patch("eventtracking.tracker.emit") def test_list_notifications_with_tray_opened_param(self, mock_emit): @@ -173,12 +164,12 @@ def test_list_notifications_with_tray_opened_param(self, mock_emit): response = self.client.get(self.url + "?tray_opened=True") # Assert that the response is successful. - self.assertEqual(response.status_code, 200) + self.assertEqual(response.status_code, 200) # noqa: PT009 event_name, event_data = mock_emit.call_args[0] - self.assertEqual(event_name, 'edx.notifications.tray_opened') - self.assertEqual(event_data['user_id'], self.user.id) - self.assertEqual(event_data['unseen_notifications_count'], 0) + self.assertEqual(event_name, 'edx.notifications.tray_opened') # noqa: PT009 + self.assertEqual(event_data['user_id'], self.user.id) # noqa: PT009 + self.assertEqual(event_data['unseen_notifications_count'], 0) # noqa: PT009 def test_list_notifications_without_authentication(self): """ @@ -188,7 +179,7 @@ def test_list_notifications_without_authentication(self): response = self.client.get(self.url) # Assert that the response is unauthorized. - self.assertEqual(response.status_code, status.HTTP_401_UNAUTHORIZED) + self.assertEqual(response.status_code, status.HTTP_401_UNAUTHORIZED) # noqa: PT009 def test_list_notifications_with_expiry_date(self): """ @@ -213,12 +204,12 @@ def test_list_notifications_with_expiry_date(self): response = self.client.get(self.url) # Assert that the response is successful. - self.assertEqual(response.status_code, 200) + self.assertEqual(response.status_code, 200) # noqa: PT009 # Assert that the response contains only the notification for current date. data = response.data['results'] - self.assertEqual(len(data), 1) - self.assertEqual(data[0]['created'], today.strftime('%Y-%m-%dT%H:%M:%S.%fZ')) + self.assertEqual(len(data), 1) # noqa: PT009 + self.assertEqual(data[0]['created'], today.strftime('%Y-%m-%dT%H:%M:%S.%fZ')) # noqa: PT009 def test_list_notifications_with_order_by_reverse_id(self): """ @@ -240,12 +231,12 @@ def test_list_notifications_with_order_by_reverse_id(self): response = self.client.get(self.url) # Assert that the response is successful. - self.assertEqual(response.status_code, 200) + self.assertEqual(response.status_code, 200) # noqa: PT009 # Assert that the response id list is in reverse order. data = response.data['results'] - self.assertEqual(len(data), 2) - self.assertEqual([data[0]['id'], data[1]['id']], [notification2.id, notification1.id]) + self.assertEqual(len(data), 2) # noqa: PT009 + self.assertEqual([data[0]['id'], data[1]['id']], [notification2.id, notification1.id]) # noqa: PT009 @ddt.ddt @@ -283,7 +274,6 @@ def setUp(self): Notification.objects.create(user=self.user, app_name='App Name 3', notification_type='Type C') Notification.objects.create(user=self.user, app_name='App Name 4', notification_type='Type D', web=False) - @override_waffle_flag(ENABLE_NOTIFICATIONS, active=True) @ddt.unpack def test_get_unseen_notifications_count_with_show_notifications_tray(self): """ @@ -293,19 +283,19 @@ def test_get_unseen_notifications_count_with_show_notifications_tray(self): # Make a request to the view response = self.client.get(self.url) - self.assertEqual(response.status_code, 200) - self.assertEqual(response.data['count'], 4) - self.assertEqual(response.data['count_by_app_name'], { + self.assertEqual(response.status_code, 200) # noqa: PT009 + self.assertEqual(response.data['count'], 4) # noqa: PT009 + self.assertEqual(response.data['count_by_app_name'], { # noqa: PT009 'App Name 1': 2, 'App Name 2': 1, 'App Name 3': 1, 'discussion': 0, 'updates': 0, 'grading': 0}) - self.assertEqual(response.data['show_notifications_tray'], True) + self.assertEqual(response.data['show_notifications_tray'], True) # noqa: PT009 def test_get_unseen_notifications_count_for_unauthenticated_user(self): """ Test that the endpoint returns 401 for an unauthenticated user. """ response = self.client.get(self.url) - self.assertEqual(response.status_code, status.HTTP_401_UNAUTHORIZED) + self.assertEqual(response.status_code, status.HTTP_401_UNAUTHORIZED) # noqa: PT009 def test_get_unseen_notifications_count_for_user_with_no_notifications(self): """ @@ -316,9 +306,9 @@ def test_get_unseen_notifications_count_for_user_with_no_notifications(self): self.client.login(username=user.username, password=self.TEST_PASSWORD) response = self.client.get(self.url) - self.assertEqual(response.status_code, 200) - self.assertEqual(response.data['count'], 0) - self.assertEqual(response.data['count_by_app_name'], {'discussion': 0, 'updates': 0, + self.assertEqual(response.status_code, 200) # noqa: PT009 + self.assertEqual(response.data['count'], 0) # noqa: PT009 + self.assertEqual(response.data['count_by_app_name'], {'discussion': 0, 'updates': 0, # noqa: PT009 'grading': 0}) def test_get_expiry_days_in_count_view(self): @@ -328,8 +318,8 @@ def test_get_expiry_days_in_count_view(self): user = UserFactory() self.client.login(username=user.username, password=self.TEST_PASSWORD) response = self.client.get(self.url) - self.assertEqual(response.status_code, 200) - self.assertEqual(response.data['notification_expiry_days'], 60) + self.assertEqual(response.status_code, 200) # noqa: PT009 + self.assertEqual(response.data['notification_expiry_days'], 60) # noqa: PT009 class MarkNotificationsSeenAPIViewTestCase(APITestCase): @@ -354,15 +344,15 @@ def test_mark_notifications_seen(self): self.client.login(username=self.user.username, password=self.TEST_PASSWORD) response = self.client.put(url) # Assert the response status code is 200 (OK) - self.assertEqual(response.status_code, status.HTTP_200_OK) + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 # Assert the response data contains the expected message expected_data = {'message': 'Notifications marked as seen.'} - self.assertEqual(response.data, expected_data) + self.assertEqual(response.data, expected_data) # noqa: PT009 # Assert the notifications for 'App Name 1' are marked as seen for the user notifications = Notification.objects.filter(user=self.user, app_name=app_name, last_seen__isnull=False) - self.assertEqual(notifications.count(), 2) + self.assertEqual(notifications.count(), 2) # noqa: PT009 class NotificationReadAPIViewTestCase(APITestCase): @@ -390,13 +380,13 @@ def test_mark_all_notifications_read_with_app_name(self, mock_emit): response = self.client.patch(self.url, data) - self.assertEqual(response.status_code, status.HTTP_200_OK) - self.assertEqual(response.data, {'message': 'Notifications marked read.'}) + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 + self.assertEqual(response.data, {'message': 'Notifications marked read.'}) # noqa: PT009 notifications = Notification.objects.filter(user=self.user, app_name=app_name, last_read__isnull=False) - self.assertEqual(notifications.count(), 2) + self.assertEqual(notifications.count(), 2) # noqa: PT009 event_name, event_data = mock_emit.call_args[0] - self.assertEqual(event_name, 'edx.notifications.app_all_read') - self.assertEqual(event_data['notification_app'], 'discussion') + self.assertEqual(event_name, 'edx.notifications.app_all_read') # noqa: PT009 + self.assertEqual(event_data['notification_app'], 'discussion') # noqa: PT009 def test_mark_all_notifications_read_with_invalid_app_name(self): # Create a PATCH request to mark all notifications as read for 'app_name_1' @@ -405,8 +395,8 @@ def test_mark_all_notifications_read_with_invalid_app_name(self): response = self.client.patch(self.url, data) - self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST) - self.assertEqual(response.data, {'error': 'Invalid app_name or notification_id.'}) + self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST) # noqa: PT009 + self.assertEqual(response.data, {'error': 'Invalid app_name or notification_id.'}) # noqa: PT009 @mock.patch("eventtracking.tracker.emit") def test_mark_notification_read_with_notification_id(self, mock_emit): @@ -416,16 +406,16 @@ def test_mark_notification_read_with_notification_id(self, mock_emit): response = self.client.patch(self.url, data) - self.assertEqual(response.status_code, status.HTTP_200_OK) - self.assertEqual(response.data, {'message': 'Notification marked read.'}) + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 + self.assertEqual(response.data, {'message': 'Notification marked read.'}) # noqa: PT009 notifications = Notification.objects.filter(user=self.user, id=notification_id, last_read__isnull=False) - self.assertEqual(notifications.count(), 1) + self.assertEqual(notifications.count(), 1) # noqa: PT009 event_name, event_data = mock_emit.call_args[0] - self.assertEqual(event_name, 'edx.notifications.read') - self.assertEqual(event_data.get('notification_metadata').get('notification_id'), notification_id) - self.assertEqual(event_data['notification_app'], 'discussion') - self.assertEqual(event_data['notification_type'], 'Type A') - self.assertEqual(event_data['first_read'], True) + self.assertEqual(event_name, 'edx.notifications.read') # noqa: PT009 + self.assertEqual(event_data.get('notification_metadata').get('notification_id'), notification_id) # noqa: PT009 + self.assertEqual(event_data['notification_app'], 'discussion') # noqa: PT009 + self.assertEqual(event_data['notification_type'], 'Type A') # noqa: PT009 + self.assertEqual(event_data['first_read'], True) # noqa: PT009 def test_mark_notification_read_with_other_user_notification_id(self): # Create a PATCH request to mark notification as read for notification_id: 2 through a different user @@ -437,9 +427,9 @@ def test_mark_notification_read_with_other_user_notification_id(self): data = {'notification_id': notification_id} response = self.client.patch(self.url, data) - self.assertEqual(response.status_code, status.HTTP_404_NOT_FOUND) + self.assertEqual(response.status_code, status.HTTP_404_NOT_FOUND) # noqa: PT009 notifications = Notification.objects.filter(user=self.user, id=notification_id, last_read__isnull=False) - self.assertEqual(notifications.count(), 0) + self.assertEqual(notifications.count(), 0) # noqa: PT009 def test_mark_notification_read_with_invalid_notification_id(self): # Create a PATCH request to mark notification as read for notification_id: 23345 @@ -448,8 +438,8 @@ def test_mark_notification_read_with_invalid_notification_id(self): response = self.client.patch(self.url, data) - self.assertEqual(response.status_code, status.HTTP_404_NOT_FOUND) - self.assertEqual(response.data["detail"].code, 'not_found') + self.assertEqual(response.status_code, status.HTTP_404_NOT_FOUND) # noqa: PT009 + self.assertEqual(response.data["detail"].code, 'not_found') # noqa: PT009 def test_mark_notification_read_with_app_name_and_notification_id(self): # Create a PATCH request to mark notification as read for existing app e.g 'discussion' and notification_id: 2 @@ -460,21 +450,21 @@ def test_mark_notification_read_with_app_name_and_notification_id(self): response = self.client.patch(self.url, data) - self.assertEqual(response.status_code, status.HTTP_200_OK) - self.assertEqual(response.data, {'message': 'Notification marked read.'}) + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 + self.assertEqual(response.data, {'message': 'Notification marked read.'}) # noqa: PT009 notifications = Notification.objects.filter( user=self.user, id=notification_id, last_read__isnull=False ) - self.assertEqual(notifications.count(), 1) + self.assertEqual(notifications.count(), 1) # noqa: PT009 def test_mark_notification_read_without_app_name_and_notification_id(self): # Create a PATCH request to mark notification as read without app_name and notification_id response = self.client.patch(self.url, {}) - self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST) - self.assertEqual(response.data, {'error': 'Invalid app_name or notification_id.'}) + self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST) # noqa: PT009 + self.assertEqual(response.data, {'error': 'Invalid app_name or notification_id.'}) # noqa: PT009 @ddt.ddt @@ -551,7 +541,7 @@ def remove_notifications_with_visibility_settings(expected_response): """ not_visible = get_notification_types_with_visibility_settings() for expected_response_app in expected_response['notification_preference_config']: - for notification_type, visibility_settings in not_visible.items(): + for notification_type, visibility_settings in not_visible.items(): # noqa: B007 types = expected_response['notification_preference_config'][expected_response_app]['notification_types'] if notification_type in types: expected_response['notification_preference_config'][expected_response_app]['notification_types'].pop( @@ -560,377 +550,6 @@ def remove_notifications_with_visibility_settings(expected_response): return expected_response -@ddt.ddt -class TestNotificationPreferencesView(ModuleStoreTestCase): - """ - Tests for the NotificationPreferencesView API view. - """ - - def setUp(self): - # Set up a user and API client - super().setUp() - self.default_data = { - "status": "success", - "message": "Notification preferences retrieved successfully.", - "data": { - "discussion": { - "enabled": True, - "core_notification_types": [ - "new_comment_on_response", - "new_comment", - "new_response", - "response_on_followed_post", - "comment_on_followed_post", - "response_endorsed_on_thread", - "response_endorsed" - ], - "notification_types": { - "new_discussion_post": { - "web": False, - "email": False, - "push": False, - "email_cadence": "Daily" - }, - "new_question_post": { - "web": False, - "email": False, - "push": False, - "email_cadence": "Daily" - }, - "content_reported": { - "web": True, - "email": True, - "push": False, - "email_cadence": "Daily" - }, - "new_instructor_all_learners_post": { - "web": True, - "email": True, - "push": False, - "email_cadence": "Daily" - }, - "core": { - "web": True, - "email": True, - "push": True, - "email_cadence": "Daily" - } - }, - "non_editable": { - "new_discussion_post": ["push"], - "new_question_post": ["push"], - "content_reported": ["push"], - "new_instructor_all_learners_post": ["push"] - } - }, - "updates": { - "enabled": True, - "core_notification_types": [], - "notification_types": { - "course_updates": { - "web": True, - "email": True, - "push": False, - "email_cadence": "Daily" - }, - "core": { - "web": True, - "email": True, - "push": True, - "email_cadence": "Daily" - } - }, - "non_editable": { - "course_updates": ["push"], - } - }, - "grading": { - "enabled": True, - "core_notification_types": [], - "notification_types": { - "ora_staff_notifications": { - "web": True, - "email": False, - "push": False, - "email_cadence": "Daily" - }, - "ora_grade_assigned": { - "web": True, - "email": True, - "push": False, - "email_cadence": "Daily" - }, - "core": { - "web": True, - "email": True, - "push": True, - "email_cadence": "Daily" - } - }, - "non_editable": { - "ora_grade_assigned": ["push"], - "ora_staff_notifications": ["push"] - } - }, - } - } - self.TEST_PASSWORD = 'testpass' - self.user = UserFactory(password=self.TEST_PASSWORD) - self.client = APIClient() - self.client.force_authenticate(user=self.user) - self.url = reverse('notification-preferences-aggregated-v2') # Adjust with the actual name - self.course = CourseFactory.create(display_name='test course 1', run="Testing_course_1") - - @ddt.data( - ("forum", FORUM_ROLE_ADMINISTRATOR, ['content_reported'], ['ora_staff_notifications']), - ("forum", FORUM_ROLE_MODERATOR, ['content_reported'], ['ora_staff_notifications']), - ("forum", FORUM_ROLE_COMMUNITY_TA, ['content_reported'], ['ora_staff_notifications']), - ("course", CourseStaffRole.ROLE, ['ora_staff_notifications'], ['content_reported']), - ("course", CourseInstructorRole.ROLE, ['ora_staff_notifications'], ['content_reported']), - (None, None, [], ['ora_staff_notifications', 'content_reported']), - ) - @ddt.unpack - def test_get_notification_preferences(self, role_type, role, visible_apps, hidden_apps): - """ - Test: Notification preferences visibility for users with forum, course, or no role. - """ - role_instance = None - - if role_type == "course": - if role == CourseInstructorRole.ROLE: - CourseStaffRole(self.course.id).add_users(self.user) - else: - CourseInstructorRole(self.course.id).add_users(self.user) - self.client.login(username=self.user.username, password='testpass') - - elif role_type == "forum": - role_instance = RoleFactory(name=role, course_id=self.course.id) - role_instance.users.add(self.user) - - response = self.client.get(self.url) - - self.assertEqual(response.status_code, status.HTTP_200_OK) - self.assertEqual(response.data['status'], 'success') - self.assertIn('data', response.data) - - expected_data = exclude_inaccessible_preferences(self.default_data['data'], self.user) - expected_data = add_non_editable_in_preference(expected_data) - expected_data = add_info_to_notification_config(expected_data) - - self.assertEqual(response.data['data'], expected_data) - - notification_apps = {} - for app in ['discussion', 'grading']: - notification_apps.update(response.data['data'][app]['notification_types']) - - for app in visible_apps: - self.assertIn(app, notification_apps, msg=f"{app} should be visible for role: {role_type}") - - for app in hidden_apps: - self.assertNotIn(app, notification_apps, msg=f"{app} should NOT be visible for role: {role_type}") - - if role_type == "forum": - role_instance.users.clear() - elif role_type == "course": - if role == CourseInstructorRole.ROLE: - CourseStaffRole(self.course.id).remove_users(self.user) - else: - CourseInstructorRole(self.course.id).remove_users(self.user) - - def test_if_data_is_correctly_aggregated(self): - """ - Test case: Check if the data is correctly formatted - """ - - self.client.get(self.url) - NotificationPreference.objects.all().update( - web=False, - push=False, - email=False, - ) - response = self.client.get(self.url) - self.assertEqual(response.status_code, status.HTTP_200_OK) - self.assertEqual(response.data['status'], 'success') - self.assertIn('data', response.data) - data = { - "status": "success", - "show_preferences": False, - "message": "Notification preferences retrieved successfully.", - "data": { - "discussion": { - "enabled": True, - "core_notification_types": [ - "new_comment_on_response", - "new_comment", - "new_response", - "response_on_followed_post", - "comment_on_followed_post", - "response_endorsed_on_thread", - "response_endorsed" - ], - "notification_types": { - "new_discussion_post": { - "web": False, - "email": False, - "push": False, - "email_cadence": "Daily", - "info": "" - }, - "new_question_post": { - "web": False, - "email": False, - "push": False, - "email_cadence": "Daily", - "info": "" - }, - "new_instructor_all_learners_post": { - "web": False, - "email": False, - "push": False, - "email_cadence": "Daily", - "info": "" - }, - "core": { - "web": False, - "email": False, - "push": False, - "email_cadence": "Daily", - "info": "Notifications for responses and comments on your posts, and the ones you’re " - "following, including endorsements to your responses and on your posts." - } - }, - "non_editable": { - "new_discussion_post": ["push"], - "new_question_post": ["push"], - "new_instructor_all_learners_post": ["push"] - } - }, - "updates": { - "enabled": True, - "core_notification_types": [], - "notification_types": { - "course_updates": { - "web": False, - "email": False, - "push": False, - "email_cadence": "Daily", - "info": "" - }, - "core": { - "web": True, - "email": True, - "push": True, - "email_cadence": "Daily", - "info": "Notifications for new announcements and updates from the course team." - } - }, - "non_editable": { - "course_updates": ["push"], - } - }, - "grading": { - "enabled": True, - "core_notification_types": [], - "notification_types": { - "ora_grade_assigned": { - "web": False, - "email": False, - "push": False, - "email_cadence": "Daily", - "info": "" - }, - "core": { - "web": True, - "email": True, - "push": True, - "email_cadence": "Daily", - "info": "Notifications for submission grading." - } - }, - "non_editable": { - "ora_grade_assigned": ["push"] - } - }, - } - } - self.assertEqual(response.data, data) - - def test_api_view_permissions(self): - """ - Test case: Ensure the API view has the correct permissions - """ - # Check if the view requires authentication - self.client.logout() - response = self.client.get(self.url) - self.assertEqual(response.status_code, status.HTTP_401_UNAUTHORIZED) - - # Re-authenticate and check again - self.client.force_authenticate(user=self.user) - response = self.client.get(self.url) - self.assertEqual(response.status_code, status.HTTP_200_OK) - - def test_update_preferences_core(self): - """ - Test case: Update notification preferences for the authenticated user - """ - update_data = { - "notification_app": "discussion", - "notification_type": "core", - "notification_channel": "email_cadence", - "email_cadence": "Weekly" - } - __, core_types = NotificationTypeManager().get_notification_app_preference('discussion') - self.client.get(self.url) - response = self.client.put(self.url, update_data, format='json') - self.assertEqual(response.status_code, status.HTTP_200_OK) - self.assertEqual(response.data['status'], 'success') - cadence_set = NotificationPreference.objects.filter(user=self.user, type__in=core_types).values_list( - 'email_cadence', flat=True - ) - self.assertEqual(len(set(cadence_set)), 1) - self.assertIn('Weekly', set(cadence_set)) - - def test_update_preferences(self): - """ - Test case: Update notification preferences for the authenticated user - """ - update_data = { - "notification_app": "discussion", - "notification_type": "new_discussion_post", - "notification_channel": "web", - "value": True - } - self.client.get(self.url) - response = self.client.put(self.url, update_data, format='json') - self.assertEqual(response.status_code, status.HTTP_200_OK) - self.assertEqual(response.data['status'], 'success') - preference = NotificationPreference.objects.get( - type='new_discussion_post', - user__id=self.user.id - ) - self.assertEqual(preference.web, True) - - def test_update_preferences_non_core_email(self): - """ - Test case: Update notification preferences for the authenticated user - """ - update_data = { - "notification_app": "discussion", - "notification_type": "new_discussion_post", - "notification_channel": "email_cadence", - "email_cadence": 'Weekly' - } - self.client.get(self.url) - response = self.client.put(self.url, update_data, format='json') - self.assertEqual(response.status_code, status.HTTP_200_OK) - self.assertEqual(response.data['status'], 'success') - preference = NotificationPreference.objects.get( - type='new_discussion_post', - user__id=self.user.id - ) - self.assertEqual(preference.email_cadence, 'Weekly') - - @ddt.ddt class TestNotificationPreferencesViewV3(ModuleStoreTestCase): """ @@ -1069,24 +688,24 @@ def test_get_notification_preferences(self, role_type, role, visible_apps, hidde response = self.client.get(self.url) - self.assertEqual(response.status_code, status.HTTP_200_OK) - self.assertEqual(response.data['status'], 'success') - self.assertIn('data', response.data) + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 + self.assertEqual(response.data['status'], 'success') # noqa: PT009 + self.assertIn('data', response.data) # noqa: PT009 expected_data = exclude_inaccessible_preferences(self.default_data['data'], self.user) expected_data = add_non_editable_in_preference(expected_data) - self.assertEqual(response.data['data'], expected_data) + self.assertEqual(response.data['data'], expected_data) # noqa: PT009 notification_apps = {} for app in ['discussion', 'grading']: notification_apps.update(response.data['data'][app]['notification_types']) for app in visible_apps: - self.assertIn(app, notification_apps, msg=f"{app} should be visible for role: {role_type}") + self.assertIn(app, notification_apps, msg=f"{app} should be visible for role: {role_type}") # noqa: PT009 for app in hidden_apps: - self.assertNotIn(app, notification_apps, msg=f"{app} should NOT be visible for role: {role_type}") + self.assertNotIn(app, notification_apps, msg=f"{app} should NOT be visible for role: {role_type}") # noqa: PT009 # pylint: disable=line-too-long if role_type == "forum": role_instance.users.clear() @@ -1108,12 +727,12 @@ def test_if_data_is_correctly_aggregated(self): email=False, ) response = self.client.get(self.url) - self.assertEqual(response.status_code, status.HTTP_200_OK) - self.assertEqual(response.data['status'], 'success') - self.assertIn('data', response.data) + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 + self.assertEqual(response.data['status'], 'success') # noqa: PT009 + self.assertIn('data', response.data) # noqa: PT009 data = { "status": "success", - "show_preferences": False, + "show_preferences": True, "message": "Notification preferences retrieved successfully.", "data": { "discussion": { @@ -1190,7 +809,7 @@ def test_if_data_is_correctly_aggregated(self): }, } } - self.assertEqual(response.data, data) + self.assertEqual(response.data, data) # noqa: PT009 def test_api_view_permissions(self): """ @@ -1199,12 +818,12 @@ def test_api_view_permissions(self): # Check if the view requires authentication self.client.logout() response = self.client.get(self.url) - self.assertEqual(response.status_code, status.HTTP_401_UNAUTHORIZED) + self.assertEqual(response.status_code, status.HTTP_401_UNAUTHORIZED) # noqa: PT009 # Re-authenticate and check again self.client.force_authenticate(user=self.user) response = self.client.get(self.url) - self.assertEqual(response.status_code, status.HTTP_200_OK) + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 def test_update_preferences_grouped(self): """ @@ -1223,13 +842,13 @@ def test_update_preferences_grouped(self): ] self.client.get(self.url) response = self.client.put(self.url, update_data, format='json') - self.assertEqual(response.status_code, status.HTTP_200_OK) - self.assertEqual(response.data['status'], 'success') + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 + self.assertEqual(response.data['status'], 'success') # noqa: PT009 cadence_set = NotificationPreference.objects.filter(user=self.user, type__in=grouped_types).values_list( 'email_cadence', flat=True ) - self.assertEqual(len(set(cadence_set)), 1) - self.assertIn('Weekly', set(cadence_set)) + self.assertEqual(len(set(cadence_set)), 1) # noqa: PT009 + self.assertIn('Weekly', set(cadence_set)) # noqa: PT009 def test_update_preferences(self): """ @@ -1243,13 +862,13 @@ def test_update_preferences(self): } self.client.get(self.url) response = self.client.put(self.url, update_data, format='json') - self.assertEqual(response.status_code, status.HTTP_200_OK) - self.assertEqual(response.data['status'], 'success') + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 + self.assertEqual(response.data['status'], 'success') # noqa: PT009 preference = NotificationPreference.objects.get( type='new_discussion_post', user__id=self.user.id ) - self.assertEqual(preference.web, True) + self.assertEqual(preference.web, True) # noqa: PT009 def test_update_preferences_non_grouped_email(self): """ @@ -1263,10 +882,10 @@ def test_update_preferences_non_grouped_email(self): } self.client.get(self.url) response = self.client.put(self.url, update_data, format='json') - self.assertEqual(response.status_code, status.HTTP_200_OK) - self.assertEqual(response.data['status'], 'success') + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 + self.assertEqual(response.data['status'], 'success') # noqa: PT009 preference = NotificationPreference.objects.get( type='new_discussion_post', user__id=self.user.id ) - self.assertEqual(preference.email_cadence, 'Weekly') + self.assertEqual(preference.email_cadence, 'Weekly') # noqa: PT009 diff --git a/openedx/core/djangoapps/notifications/urls.py b/openedx/core/djangoapps/notifications/urls.py index 279f02a97b60..760e46db6e79 100644 --- a/openedx/core/djangoapps/notifications/urls.py +++ b/openedx/core/djangoapps/notifications/urls.py @@ -8,20 +8,14 @@ MarkNotificationsSeenAPIView, NotificationCountView, NotificationListAPIView, + NotificationPreferencesViewV3, NotificationReadAPIView, preference_update_from_encrypted_username_view, - NotificationPreferencesView, - NotificationPreferencesViewV3, ) router = routers.DefaultRouter() urlpatterns = [ - path( - 'v2/configurations/', - NotificationPreferencesView.as_view(), - name='notification-preferences-aggregated-v2' - ), path( 'v3/configurations/', NotificationPreferencesViewV3.as_view(), diff --git a/openedx/core/djangoapps/notifications/utils.py b/openedx/core/djangoapps/notifications/utils.py index de0d5997a6c5..75996d904749 100644 --- a/openedx/core/djangoapps/notifications/utils.py +++ b/openedx/core/djangoapps/notifications/utils.py @@ -1,12 +1,12 @@ """ Utils function for notifications app """ -from typing import Dict, List +from typing import Dict, List # noqa: UP035 from common.djangoapps.student.models import CourseAccessRole from openedx.core.djangoapps.django_comment_common.models import Role -from openedx.core.djangoapps.notifications.config.waffle import ENABLE_NOTIFICATIONS -from openedx.core.djangoapps.notifications.models import create_notification_preference, NotificationPreference +from openedx.core.djangoapps.notifications.config.waffle import DISABLE_NOTIFICATIONS +from openedx.core.djangoapps.notifications.models import NotificationPreference, create_notification_preference from openedx.core.lib.cache_utils import request_cached @@ -14,7 +14,7 @@ def get_show_notifications_tray(): """ Returns whether notifications tray is enabled via waffle flag """ - return ENABLE_NOTIFICATIONS.is_enabled() + return not DISABLE_NOTIFICATIONS.is_enabled() def get_list_in_batches(input_list, batch_size): @@ -27,7 +27,7 @@ def get_list_in_batches(input_list, batch_size): @request_cached() -def get_notification_types_with_visibility_settings() -> Dict[str, List[str]]: +def get_notification_types_with_visibility_settings() -> Dict[str, List[str]]: # noqa: UP006 """ Get notification types with their visibility settings. @@ -45,9 +45,9 @@ def get_notification_types_with_visibility_settings() -> Dict[str, List[str]]: def filter_out_visible_notifications( user_preferences: dict, - notifications_with_visibility: Dict[str, List[str]], - user_forum_roles: List[str], - user_course_roles: List[str] + notifications_with_visibility: Dict[str, List[str]], # noqa: UP006 + user_forum_roles: List[str], # noqa: UP006 + user_course_roles: List[str] # noqa: UP006 ) -> dict: """ Filter out notifications visible to forum roles from user preferences. @@ -88,7 +88,7 @@ def clean_arguments(kwargs): return clean_kwargs -def get_user_forum_access_roles(user_id: int) -> List[str]: +def get_user_forum_access_roles(user_id: int) -> List[str]: # noqa: UP006 """ Get forum roles for the given user in all course. diff --git a/openedx/core/djangoapps/notifications/views.py b/openedx/core/djangoapps/notifications/views.py index 57d720e30124..4901b42c9931 100644 --- a/openedx/core/djangoapps/notifications/views.py +++ b/openedx/core/djangoapps/notifications/views.py @@ -2,13 +2,13 @@ Views for the notifications API. """ from datetime import datetime, timedelta +from zoneinfo import ZoneInfo from django.conf import settings from django.db.models import Count -from django_ratelimit.core import is_ratelimited from django.shortcuts import get_object_or_404 from django.utils.translation import gettext as _ -from zoneinfo import ZoneInfo +from django_ratelimit.core import is_ratelimited from rest_framework import generics, status from rest_framework.decorators import api_view from rest_framework.generics import UpdateAPIView @@ -19,25 +19,23 @@ from openedx.core.djangoapps.notifications.models import NotificationPreference from openedx.core.djangoapps.notifications.permissions import allow_any_authenticated_user -from .base_notification import COURSE_NOTIFICATION_APPS, NotificationAppManager, COURSE_NOTIFICATION_TYPES, \ - NotificationTypeManager, filter_notification_types_by_app +from .base_notification import COURSE_NOTIFICATION_APPS, COURSE_NOTIFICATION_TYPES, filter_notification_types_by_app from .events import ( notification_preference_update_event, notification_read_event, notification_tray_opened_event, - notifications_app_all_read_event + notifications_app_all_read_event, ) from .models import Notification from .serializers import ( NotificationSerializer, UserNotificationPreferenceUpdateAllSerializer, - add_info_to_notification_config, - add_non_editable_in_preference + add_non_editable_in_preference, ) -from .tasks import create_notification_preference from .utils import ( + create_account_notification_pref_if_not_exists, + exclude_inaccessible_preferences, get_show_notifications_tray, - exclude_inaccessible_preferences, create_account_notification_pref_if_not_exists ) @@ -252,202 +250,6 @@ def preference_update_from_encrypted_username_view(request, username, patch=""): return Response({"result": "success"}, status=status.HTTP_200_OK) -@allow_any_authenticated_user() -class NotificationPreferencesView(APIView): - """ - API view to retrieve and structure the notification preferences for the - authenticated user. - """ - - def get(self, request): - """ - Handles GET requests to retrieve notification preferences. - - This method fetches the user's active notification preferences and - merges them with a default structure provided by NotificationAppManager. - This provides a complete view of all possible notifications and the - user's current settings for them. - - Returns: - Response: A DRF Response object containing the structured - notification preferences or an error message. - """ - user_preferences_qs = NotificationPreference.objects.filter(user=request.user) - user_preferences_map = {pref.type: pref for pref in user_preferences_qs} - - # Ensure all notification types are present in the user's preferences. - # If any are missing, create them with default values. - diff = set(COURSE_NOTIFICATION_TYPES.keys()) - set(user_preferences_map.keys()) - missing_types = [] - for missing_type in diff: - new_pref = create_notification_preference( - user_id=request.user.id, - notification_type=missing_type, - - ) - missing_types.append(new_pref) - user_preferences_map[missing_type] = new_pref - if missing_types: - NotificationPreference.objects.bulk_create(missing_types) - - # If no user preferences are found, return an error response. - if not user_preferences_map: - return Response({ - 'status': 'error', - 'message': 'No active notification preferences found for this user.' - }, status=status.HTTP_404_NOT_FOUND) - - # Get the structured preferences from the NotificationAppManager. - # This will include all apps and their notification types. - structured_preferences = NotificationAppManager().get_notification_app_preferences() - - for app_name, app_settings in structured_preferences.items(): - notification_types = app_settings.get('notification_types', {}) - - # Process all notification types (core and non-core) in a single loop. - for type_name, type_details in notification_types.items(): - if type_name == 'core': - if structured_preferences[app_name]['core_notification_types']: - # If the app has core notification types, use the first one as the type name. - # This assumes that the first core notification type is representative of the core settings. - notification_type = structured_preferences[app_name]['core_notification_types'][0] - else: - notification_type = 'core' - user_pref = user_preferences_map.get(notification_type) - else: - user_pref = user_preferences_map.get(type_name) - if user_pref: - # If a preference exists, update the dictionary for this type. - # This directly modifies the 'type_details' dictionary. - type_details['web'] = user_pref.web - type_details['email'] = user_pref.email - type_details['push'] = user_pref.push - type_details['email_cadence'] = user_pref.email_cadence - exclude_inaccessible_preferences(structured_preferences, request.user) - structured_preferences = add_non_editable_in_preference( - add_info_to_notification_config(structured_preferences) - ) - return Response({ - 'status': 'success', - 'message': 'Notification preferences retrieved successfully.', - 'show_preferences': get_show_notifications_tray(), - 'data': structured_preferences - }, status=status.HTTP_200_OK) - - def put(self, request): - """ - Handles PUT requests to update notification preferences. - - This method updates the user's notification preferences based on the - provided data in the request body. It expects a dictionary with - notification types and their settings. - - Returns: - Response: A DRF Response object indicating success or failure. - """ - # Validate incoming data - serializer = UserNotificationPreferenceUpdateAllSerializer(data=request.data) - if not serializer.is_valid(): - return Response({ - 'status': 'error', - 'message': serializer.errors - }, status=status.HTTP_400_BAD_REQUEST) - - # Get validated data for easier access - validated_data = serializer.validated_data - - # Build query set based on notification type - query_set = NotificationPreference.objects.filter(user_id=request.user.id) - - if validated_data['notification_type'] == 'core': - # Get core notification types for the app - __, core_types = NotificationTypeManager().get_notification_app_preference( - notification_app=validated_data['notification_app'] - ) - query_set = query_set.filter(type__in=core_types) - else: - # Filter by single notification type - query_set = query_set.filter(type=validated_data['notification_type']) - - # Prepare update data based on channel type - updated_data = self._prepare_update_data(validated_data) - - # Update preferences - query_set.update(**updated_data) - - # Log the event - self._log_preference_update_event(request.user, validated_data) - - # Prepare and return response - response_data = self._prepare_response_data(validated_data) - return Response(response_data, status=status.HTTP_200_OK) - - def _prepare_update_data(self, validated_data): - """ - Prepare the data dictionary for updating notification preferences. - - Args: - validated_data (dict): Validated serializer data - - Returns: - dict: Dictionary with update data - """ - channel = validated_data['notification_channel'] - - if channel == 'email_cadence': - return {channel: validated_data['email_cadence']} - else: - return {channel: validated_data['value']} - - def _log_preference_update_event(self, user, validated_data): - """ - Log the notification preference update event. - - Args: - user: The user making the update - validated_data (dict): Validated serializer data - """ - event_data = { - 'notification_app': validated_data['notification_app'], - 'notification_type': validated_data['notification_type'], - 'notification_channel': validated_data['notification_channel'], - 'value': validated_data.get('value'), - 'email_cadence': validated_data.get('email_cadence'), - } - notification_preference_update_event(user, [], event_data) - - def _prepare_response_data(self, validated_data): - """ - Prepare the response data dictionary. - - Args: - validated_data (dict): Validated serializer data - - Returns: - dict: Response data dictionary - """ - email_cadence = validated_data.get('email_cadence', None) - # Determine the updated value - updated_value = validated_data.get('value', email_cadence if email_cadence else None) - - # Determine the channel - channel = validated_data.get('notification_channel') - if not channel and validated_data.get('email_cadence'): - channel = 'email_cadence' - - return { - 'status': 'success', - 'message': 'Notification preferences update completed', - 'show_preferences': get_show_notifications_tray(), - 'data': { - 'updated_value': updated_value, - 'notification_type': validated_data['notification_type'], - 'channel': channel, - 'app': validated_data['notification_app'], - } - } - - @allow_any_authenticated_user() class NotificationPreferencesViewV3(APIView): """ @@ -460,7 +262,7 @@ def get(self, request): Handles GET requests to retrieve notification preferences. This method fetches the user's active notification preferences and - merges them with a default structure provided by NotificationAppManager. + merges them with a default structure provided. This provides a complete view of all possible notifications and the user's current settings for them. @@ -532,7 +334,6 @@ def put(self, request): query_set = NotificationPreference.objects.filter(user_id=request.user.id) if validated_data['notification_type'] == 'grouped_notification': - # Get core notification types for the app grouped_types = filter_notification_types_by_app(validated_data['notification_app'], use_app_defaults=True) query_set = query_set.filter(type__in=grouped_types.keys()) else: diff --git a/openedx/core/djangoapps/oauth_dispatch/adapters/__init__.py b/openedx/core/djangoapps/oauth_dispatch/adapters/__init__.py index e41e9ca3ed0e..645f0ac25fee 100644 --- a/openedx/core/djangoapps/oauth_dispatch/adapters/__init__.py +++ b/openedx/core/djangoapps/oauth_dispatch/adapters/__init__.py @@ -3,4 +3,4 @@ django-oauth-toolkit (DOT). """ -from .dot import DOTAdapter +from .dot import DOTAdapter # noqa: F401 diff --git a/openedx/core/djangoapps/oauth_dispatch/dot_overrides/validators.py b/openedx/core/djangoapps/oauth_dispatch/dot_overrides/validators.py index 773c344db0af..75921f2f158b 100644 --- a/openedx/core/djangoapps/oauth_dispatch/dot_overrides/validators.py +++ b/openedx/core/djangoapps/oauth_dispatch/dot_overrides/validators.py @@ -4,6 +4,7 @@ from datetime import datetime, timedelta +from zoneinfo import ZoneInfo from django.contrib.auth import authenticate, get_user_model from django.db.models.signals import pre_save @@ -11,9 +12,9 @@ from oauth2_provider.models import AccessToken from oauth2_provider.oauth2_validators import OAuth2Validator from oauth2_provider.scopes import get_scopes_backend -from zoneinfo import ZoneInfo from ..models import RestrictedApplication + # pylint: disable=W0223 diff --git a/openedx/core/djangoapps/oauth_dispatch/dot_overrides/views.py b/openedx/core/djangoapps/oauth_dispatch/dot_overrides/views.py index 9720240fc605..6ba85425f8e9 100644 --- a/openedx/core/djangoapps/oauth_dispatch/dot_overrides/views.py +++ b/openedx/core/djangoapps/oauth_dispatch/dot_overrides/views.py @@ -59,7 +59,7 @@ def get(self, request, *args, **kwargs): kwargs['response_type'] = credentials['response_type'] kwargs['state'] = credentials['state'] - self.oauth2_data = kwargs # lint-amnesty, pylint: disable=attribute-defined-outside-init + self.oauth2_data = kwargs # pylint: disable=attribute-defined-outside-init # following two loc are here only because of https://code.djangoproject.com/ticket/17795 form = self.get_form(self.get_form_class()) kwargs['form'] = form @@ -69,7 +69,7 @@ def get(self, request, *args, **kwargs): # This is useful for in-house applications-> assume an in-house applications # are already approved. if application.skip_authorization: - uri, headers, body, status = self.create_authorization_response( # lint-amnesty, pylint: disable=unused-variable + uri, headers, body, status = self.create_authorization_response( # pylint: disable=unused-variable request=self.request, scopes=" ".join(scopes), credentials=credentials, allow=True) return OAuth2ResponseRedirect(uri, application.get_allowed_schemes()) diff --git a/openedx/core/djangoapps/oauth_dispatch/management/commands/create_dot_application.py b/openedx/core/djangoapps/oauth_dispatch/management/commands/create_dot_application.py index 4041b00e15ad..d2e0062c558f 100644 --- a/openedx/core/djangoapps/oauth_dispatch/management/commands/create_dot_application.py +++ b/openedx/core/djangoapps/oauth_dispatch/management/commands/create_dot_application.py @@ -7,7 +7,7 @@ import logging -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.core.management.base import BaseCommand from oauth2_provider.models import get_application_model @@ -79,7 +79,7 @@ def _create_application(self, user, app_name, application_kwargs): application = Application.objects.create( user=user, name=app_name, **application_kwargs ) - logger.info('Created {} application with id: {}, client_id: {}, and client_secret: {}'.format( + logger.info('Created {} application with id: {}, client_id: {}, and client_secret: {}'.format( # noqa: UP032 app_name, application.id, application.client_id, @@ -94,7 +94,7 @@ def _update_application(self, application, application_kwargs): for key, value in application_kwargs.items(): setattr(application, key, value) application.save() - logger.info('Updated {} application with id: {}, client_id: {}, and client_secret: {}'.format( + logger.info('Updated {} application with id: {}, client_id: {}, and client_secret: {}'.format( # noqa: UP032 application.name, application.id, application.client_id, @@ -114,12 +114,12 @@ def _create_or_update_access(self, application, scopes, update): if access and update: access.scopes = scopes access.save() - logger.info('Updated application access for {} with scopes: {}'.format( + logger.info('Updated application access for {} with scopes: {}'.format( # noqa: UP032 application.name, scopes, )) elif access: - logger.info('Application access for application {} already exists.'.format( + logger.info('Application access for application {} already exists.'.format( # noqa: UP032 application.name, )) else: @@ -127,7 +127,7 @@ def _create_or_update_access(self, application, scopes, update): application_id=application.id, scopes=scopes, ) - logger.info('Created application access for {} with scopes: {}'.format( + logger.info('Created application access for {} with scopes: {}'.format( # noqa: UP032 application.name, application_access.scopes, )) @@ -160,7 +160,7 @@ def handle(self, *args, **options): if application and update: self._update_application(application, application_kwargs) elif application: - logger.info('Application with name {} and user {} already exists.'.format( + logger.info('Application with name {} and user {} already exists.'.format( # noqa: UP032 app_name, username )) diff --git a/openedx/core/djangoapps/oauth_dispatch/management/commands/edx_clear_expired_tokens.py b/openedx/core/djangoapps/oauth_dispatch/management/commands/edx_clear_expired_tokens.py index de587a89deac..fe4d0e9f6afe 100644 --- a/openedx/core/djangoapps/oauth_dispatch/management/commands/edx_clear_expired_tokens.py +++ b/openedx/core/djangoapps/oauth_dispatch/management/commands/edx_clear_expired_tokens.py @@ -17,7 +17,7 @@ logger = logging.getLogger(__name__) -class Command(BaseCommand): # lint-amnesty, pylint: disable=missing-class-docstring +class Command(BaseCommand): # pylint: disable=missing-class-docstring help = "Clear expired access tokens and refresh tokens for Django OAuth Toolkit" def _add_boolean_flag(self, parser, name, default=False): @@ -50,7 +50,7 @@ def add_arguments(self, parser): self._add_boolean_flag(parser, 'grants', True) self._add_boolean_flag(parser, 'revoked-tokens', True) - def clear_table_data(self, query_set, batch_size, model, sleep_time): # lint-amnesty, pylint: disable=missing-function-docstring + def clear_table_data(self, query_set, batch_size, model, sleep_time): # pylint: disable=missing-function-docstring total_deletions = 0 deletion_count = 1 # we expect to delete at least one row to start out with while deletion_count: @@ -70,14 +70,14 @@ def clear_table_data(self, query_set, batch_size, model, sleep_time): # lint-am message = f'Final deletion count: Cleaned {total_deletions} rows from {model.__name__} table' logger.info(message) - def get_expiration_time(self, now): # lint-amnesty, pylint: disable=missing-function-docstring + def get_expiration_time(self, now): # pylint: disable=missing-function-docstring refresh_token_expire_seconds = oauth2_settings.REFRESH_TOKEN_EXPIRE_SECONDS if not isinstance(refresh_token_expire_seconds, timedelta): try: refresh_token_expire_seconds = timedelta(seconds=refresh_token_expire_seconds) except TypeError: e = "REFRESH_TOKEN_EXPIRE_SECONDS must be either a timedelta or seconds" - raise ImproperlyConfigured(e) # lint-amnesty, pylint: disable=raise-missing-from + raise ImproperlyConfigured(e) # pylint: disable=raise-missing-from # noqa: B904 return now - refresh_token_expire_seconds def handle(self, *args, **options): diff --git a/openedx/core/djangoapps/oauth_dispatch/management/commands/generate_jwt_signing_key.py b/openedx/core/djangoapps/oauth_dispatch/management/commands/generate_jwt_signing_key.py index a139cebca161..db18bc59792a 100644 --- a/openedx/core/djangoapps/oauth_dispatch/management/commands/generate_jwt_signing_key.py +++ b/openedx/core/djangoapps/oauth_dispatch/management/commands/generate_jwt_signing_key.py @@ -114,7 +114,7 @@ def handle(self, *args, **options): 'JWT_AUTH': public_keys, } jwt_auth_data['JWT_AUTH'].update(private_keys) - with open(options['output_file'], 'w') as f_out: # lint-amnesty, pylint: disable=bad-option-value, open-builtin + with open(options['output_file'], 'w') as f_out: # pylint: disable=bad-option-value, open-builtin yaml.safe_dump(jwt_auth_data, stream=f_out) def _generate_key_id(self, size, chars=string.ascii_uppercase + string.digits): diff --git a/openedx/core/djangoapps/oauth_dispatch/management/commands/tests/test_clear_expired_tokens.py b/openedx/core/djangoapps/oauth_dispatch/management/commands/tests/test_clear_expired_tokens.py index 5e428947b5de..ae7a10a9bf8e 100644 --- a/openedx/core/djangoapps/oauth_dispatch/management/commands/tests/test_clear_expired_tokens.py +++ b/openedx/core/djangoapps/oauth_dispatch/management/commands/tests/test_clear_expired_tokens.py @@ -2,12 +2,12 @@ Tests the ``edx_clear_expired_tokens`` management command. """ +import math from datetime import timedelta from unittest.mock import patch -import math -import pytest import ddt +import pytest from django.conf import settings from django.core.exceptions import ImproperlyConfigured from django.core.management import call_command @@ -15,12 +15,12 @@ from django.test import TestCase from django.test.utils import override_settings from django.utils import timezone -from oauth2_provider.models import AccessToken, RefreshToken, Grant +from oauth2_provider.models import AccessToken, Grant, RefreshToken from testfixtures import LogCapture +from common.djangoapps.student.tests.factories import UserFactory from openedx.core.djangoapps.oauth_dispatch.tests import factories from openedx.core.djangolib.testing.utils import skip_unless_lms -from common.djangoapps.student.tests.factories import UserFactory LOGGER_NAME = 'openedx.core.djangoapps.oauth_dispatch.management.commands.edx_clear_expired_tokens' @@ -47,13 +47,13 @@ def create_factory_refresh_token_for_user(user, expires, revoked=None): @ddt.ddt @skip_unless_lms -class EdxClearExpiredTokensTests(TestCase): # lint-amnesty, pylint: disable=missing-class-docstring +class EdxClearExpiredTokensTests(TestCase): # pylint: disable=missing-class-docstring # patching REFRESH_TOKEN_EXPIRE_SECONDS because override_settings not working. @patch('oauth2_provider.settings.oauth2_settings.REFRESH_TOKEN_EXPIRE_SECONDS', 'xyz') def test_invalid_expiration_time(self): with LogCapture(LOGGER_NAME) as log: - with pytest.raises(ImproperlyConfigured): + with pytest.raises(ImproperlyConfigured): # noqa: PT012 call_command('edx_clear_expired_tokens') log.check( ( @@ -141,7 +141,7 @@ def test_clear_revoked_refresh_tokens(self): assert QuerySet.delete.invocations == 2 assert RefreshToken.objects.filter(revoked__lt=refresh_expires).count() == 0 # revoked token has been deleted - with self.assertRaises(RefreshToken.DoesNotExist): + with self.assertRaises(RefreshToken.DoesNotExist): # noqa: PT027 RefreshToken.objects.get(token=revoke_token.token) # normal token is still there assert RefreshToken.objects.get(token=keep_token.token) == keep_token diff --git a/openedx/core/djangoapps/oauth_dispatch/management/commands/tests/test_create_dot_application.py b/openedx/core/djangoapps/oauth_dispatch/management/commands/tests/test_create_dot_application.py index f30e8bb61498..779d3ead8b12 100644 --- a/openedx/core/djangoapps/oauth_dispatch/management/commands/tests/test_create_dot_application.py +++ b/openedx/core/djangoapps/oauth_dispatch/management/commands/tests/test_create_dot_application.py @@ -1,14 +1,14 @@ """ Tests the ``create_dot_application`` management command. """ -import pytest import ddt +import pytest from django.core.management import call_command from django.test import TestCase from oauth2_provider.models import get_application_model -from openedx.core.djangoapps.oauth_dispatch.models import ApplicationAccess from common.djangoapps.student.tests.factories import UserFactory +from openedx.core.djangoapps.oauth_dispatch.models import ApplicationAccess from ..create_dot_application import Command diff --git a/openedx/core/djangoapps/oauth_dispatch/management/commands/tests/test_generate_jwt_signing_key.py b/openedx/core/djangoapps/oauth_dispatch/management/commands/tests/test_generate_jwt_signing_key.py index 75d45fe883b2..f5516eb49cbe 100644 --- a/openedx/core/djangoapps/oauth_dispatch/management/commands/tests/test_generate_jwt_signing_key.py +++ b/openedx/core/djangoapps/oauth_dispatch/management/commands/tests/test_generate_jwt_signing_key.py @@ -55,7 +55,7 @@ def _assert_key_output(self, output_stream, filename, strip_key_prefix): for expected in expected_in_output: assert expected in output_stream.getvalue() - with open(filename) as file_obj: # lint-amnesty, pylint: disable=bad-option-value, open-builtin + with open(filename) as file_obj: # pylint: disable=bad-option-value, open-builtin output_from_yaml = yaml.safe_load(file_obj) for expected in expected_in_output: assert expected in output_from_yaml['JWT_AUTH'] diff --git a/openedx/core/djangoapps/oauth_dispatch/migrations/0010_noop_migration_to_test_rollback.py b/openedx/core/djangoapps/oauth_dispatch/migrations/0010_noop_migration_to_test_rollback.py index d809c47c82db..da5a7a4f2f67 100644 --- a/openedx/core/djangoapps/oauth_dispatch/migrations/0010_noop_migration_to_test_rollback.py +++ b/openedx/core/djangoapps/oauth_dispatch/migrations/0010_noop_migration_to_test_rollback.py @@ -4,6 +4,7 @@ from django.db import migrations + class Migration(migrations.Migration): dependencies = [ diff --git a/openedx/core/djangoapps/oauth_dispatch/migrations/0011_noop_migration_to_test_rollback.py b/openedx/core/djangoapps/oauth_dispatch/migrations/0011_noop_migration_to_test_rollback.py index 698708b79ff0..8321a7c5fa6e 100644 --- a/openedx/core/djangoapps/oauth_dispatch/migrations/0011_noop_migration_to_test_rollback.py +++ b/openedx/core/djangoapps/oauth_dispatch/migrations/0011_noop_migration_to_test_rollback.py @@ -4,6 +4,7 @@ from django.db import migrations + class Migration(migrations.Migration): dependencies = [ diff --git a/openedx/core/djangoapps/oauth_dispatch/migrations/0012_noop_migration_to_test_rollback.py b/openedx/core/djangoapps/oauth_dispatch/migrations/0012_noop_migration_to_test_rollback.py index 10d6c918214b..0baa8299e120 100644 --- a/openedx/core/djangoapps/oauth_dispatch/migrations/0012_noop_migration_to_test_rollback.py +++ b/openedx/core/djangoapps/oauth_dispatch/migrations/0012_noop_migration_to_test_rollback.py @@ -4,6 +4,7 @@ from django.db import migrations + class Migration(migrations.Migration): dependencies = [ diff --git a/openedx/core/djangoapps/oauth_dispatch/models.py b/openedx/core/djangoapps/oauth_dispatch/models.py index 3869698af4cb..22cf1e8cb810 100644 --- a/openedx/core/djangoapps/oauth_dispatch/models.py +++ b/openedx/core/djangoapps/oauth_dispatch/models.py @@ -4,14 +4,13 @@ from datetime import datetime +from zoneinfo import ZoneInfo from django.db import models - from django.utils.translation import gettext_lazy as _ from django_mysql.models import ListCharField from oauth2_provider.settings import oauth2_settings from organizations.models import Organization -from zoneinfo import ZoneInfo from openedx.core.djangolib.markup import HTML from openedx.core.lib.request_utils import get_request_or_stub @@ -33,7 +32,7 @@ class RestrictedApplication(models.Model): class Meta: app_label = 'oauth_dispatch' - def __str__(self): # lint-amnesty, pylint: disable=invalid-str-returned + def __str__(self): # pylint: disable=invalid-str-returned """ Return a unicode representation of this object """ @@ -102,7 +101,7 @@ def get_filters(cls, application): return cls.objects.get(application=application).filters @classmethod - def get_filter_values(cls, application, filter_name): # lint-amnesty, pylint: disable=missing-function-docstring + def get_filter_values(cls, application, filter_name): # pylint: disable=missing-function-docstring filters = cls.get_filters(application=application) if filters: for filter_constraint in filters: @@ -110,18 +109,18 @@ def get_filter_values(cls, application, filter_name): # lint-amnesty, pylint: d if name == filter_name: yield filter_value - def __str__(self): + def __str__(self): # noqa: DJ012 """ Return a unicode representation of this object. """ - return "{application_name}:{scopes}:{filters}".format( + return "{application_name}:{scopes}:{filters}".format( # noqa: UP032 application_name=self.application.name, scopes=self.scopes, filters=self.filters, ) -class ApplicationOrganization(models.Model): +class ApplicationOrganization(models.Model): # noqa: DJ008 """ DEPRECATED: Associates a DOT Application to an Organization. diff --git a/openedx/core/djangoapps/oauth_dispatch/scopes.py b/openedx/core/djangoapps/oauth_dispatch/scopes.py index bcaf6df91f7e..27c2eec58cc4 100644 --- a/openedx/core/djangoapps/oauth_dispatch/scopes.py +++ b/openedx/core/djangoapps/oauth_dispatch/scopes.py @@ -12,7 +12,7 @@ class ApplicationModelScopes(SettingsScopes): """ Scopes backend that determines available scopes using the ApplicationAccess model. """ - def get_available_scopes(self, application=None, request=None, *args, **kwargs): # lint-amnesty, pylint: disable=keyword-arg-before-vararg + def get_available_scopes(self, application=None, request=None, *args, **kwargs): # pylint: disable=keyword-arg-before-vararg """ Returns valid scopes configured for the given application. """ try: application_scopes = ApplicationAccess.get_scopes(application) diff --git a/openedx/core/djangoapps/oauth_dispatch/tests/factories.py b/openedx/core/djangoapps/oauth_dispatch/tests/factories.py index 7d7be8dd7fa6..09209eb280f8 100644 --- a/openedx/core/djangoapps/oauth_dispatch/tests/factories.py +++ b/openedx/core/djangoapps/oauth_dispatch/tests/factories.py @@ -2,15 +2,15 @@ from datetime import datetime, timedelta +from zoneinfo import ZoneInfo import factory -from zoneinfo import ZoneInfo from factory.django import DjangoModelFactory from factory.fuzzy import FuzzyText from oauth2_provider.models import AccessToken, Application, RefreshToken -from openedx.core.djangoapps.oauth_dispatch.models import ApplicationAccess from common.djangoapps.student.tests.factories import UserFactory +from openedx.core.djangoapps.oauth_dispatch.models import ApplicationAccess class ApplicationFactory(DjangoModelFactory): diff --git a/openedx/core/djangoapps/oauth_dispatch/tests/mixins.py b/openedx/core/djangoapps/oauth_dispatch/tests/mixins.py index 407a9aac2b84..84580ed9d66e 100644 --- a/openedx/core/djangoapps/oauth_dispatch/tests/mixins.py +++ b/openedx/core/djangoapps/oauth_dispatch/tests/mixins.py @@ -6,7 +6,7 @@ from django.conf import settings from edx_rest_framework_extensions.auth.jwt.decoder import ( get_verification_jwk_key_set, - verify_jwk_signature_using_keyset + verify_jwk_signature_using_keyset, ) from jwt.exceptions import ExpiredSignatureError diff --git a/openedx/core/djangoapps/oauth_dispatch/tests/test_api.py b/openedx/core/djangoapps/oauth_dispatch/tests/test_api.py index dd1e3e2cf2c7..501bfd70cea7 100644 --- a/openedx/core/djangoapps/oauth_dispatch/tests/test_api.py +++ b/openedx/core/djangoapps/oauth_dispatch/tests/test_api.py @@ -7,7 +7,6 @@ from common.djangoapps.student.tests.factories import UserFactory from common.test.utils import assert_dict_contains_subset - from openedx.core.djangoapps.oauth_dispatch import api from openedx.core.djangoapps.oauth_dispatch.adapters import DOTAdapter from openedx.core.djangoapps.oauth_dispatch.tests.constants import DUMMY_REDIRECT_URL diff --git a/openedx/core/djangoapps/oauth_dispatch/tests/test_dot_adapter.py b/openedx/core/djangoapps/oauth_dispatch/tests/test_dot_adapter.py index 556c089072cc..ddb054ec7c9c 100644 --- a/openedx/core/djangoapps/oauth_dispatch/tests/test_dot_adapter.py +++ b/openedx/core/djangoapps/oauth_dispatch/tests/test_dot_adapter.py @@ -3,9 +3,9 @@ """ from datetime import timedelta -import pytest import ddt +import pytest from django.test import TestCase from django.urls import reverse from django.utils.timezone import now @@ -16,8 +16,8 @@ # oauth_dispatch is not in CMS' INSTALLED_APPS so these imports will error during test collection from ..adapters import DOTAdapter -from .constants import DUMMY_REDIRECT_URL, DUMMY_REDIRECT_URL2 from ..models import RestrictedApplication +from .constants import DUMMY_REDIRECT_URL, DUMMY_REDIRECT_URL2 @ddt.ddt @@ -55,7 +55,7 @@ def test_restricted_app_unicode(self): Make sure unicode representation of RestrictedApplication is correct """ assert str(self.restricted_app) == ""\ - .format(name=self.restricted_client.name) + .format(name=self.restricted_client.name) # noqa: UP032 @ddt.data( ('confidential', models.Application.CLIENT_CONFIDENTIAL), diff --git a/openedx/core/djangoapps/oauth_dispatch/tests/test_dot_overrides.py b/openedx/core/djangoapps/oauth_dispatch/tests/test_dot_overrides.py index 52a79615c29d..5f84d32b5106 100644 --- a/openedx/core/djangoapps/oauth_dispatch/tests/test_dot_overrides.py +++ b/openedx/core/djangoapps/oauth_dispatch/tests/test_dot_overrides.py @@ -12,15 +12,14 @@ from django.utils import timezone from common.djangoapps.student.tests.factories import UserFactory -from openedx.core.djangolib.testing.utils import skip_unless_lms from openedx.core.djangoapps.oauth_dispatch.tests.factories import ApplicationAccessFactory +from openedx.core.djangolib.testing.utils import skip_unless_lms # oauth_dispatch is not in CMS' INSTALLED_APPS so these imports will error during test collection if settings.ROOT_URLCONF == 'lms.urls': from oauth2_provider import models as dot_models - from .. import adapters - from .. import models + from .. import adapters, models from ..dot_overrides.validators import EdxOAuth2Validator from .constants import DUMMY_REDIRECT_URL @@ -90,7 +89,7 @@ def test_get_default_scopes_with_user_id(self): request = mock.Mock(grant_type='client_credentials', client=application_access.application, scopes=None) overriden_default_scopes = self.validator.get_default_scopes(request=request, client_id='client_id') - self.assertEqual(overriden_default_scopes, self.default_scopes + ['user_id']) + self.assertEqual(overriden_default_scopes, self.default_scopes + ['user_id']) # noqa: PT009 def test_get_default_scopes(self): """ @@ -99,7 +98,7 @@ def test_get_default_scopes(self): request = mock.Mock(grant_type='client_credentials', client=None, scopes=None) overriden_default_scopes = self.validator.get_default_scopes(request=request, client_id='client_id') - self.assertEqual(overriden_default_scopes, self.default_scopes) + self.assertEqual(overriden_default_scopes, self.default_scopes) # noqa: PT009 @skip_unless_lms @@ -122,7 +121,7 @@ def setUp(self): self.restricted_dot_app = self._create_restricted_app() self._create_expired_token(self.restricted_dot_app) - def _create_restricted_app(self): # lint-amnesty, pylint: disable=missing-function-docstring + def _create_restricted_app(self): # pylint: disable=missing-function-docstring restricted_app = self.dot_adapter.create_confidential_client( name='test restricted dot application', user=self.user, diff --git a/openedx/core/djangoapps/oauth_dispatch/tests/test_factories.py b/openedx/core/djangoapps/oauth_dispatch/tests/test_factories.py index bb4918c8ff79..874ef5e1822a 100644 --- a/openedx/core/djangoapps/oauth_dispatch/tests/test_factories.py +++ b/openedx/core/djangoapps/oauth_dispatch/tests/test_factories.py @@ -4,8 +4,8 @@ from django.test import TestCase from oauth2_provider.models import AccessToken, Application, RefreshToken -from openedx.core.djangoapps.oauth_dispatch.tests import factories from common.djangoapps.student.tests.factories import UserFactory +from openedx.core.djangoapps.oauth_dispatch.tests import factories class TestClientFactory(TestCase): diff --git a/openedx/core/djangoapps/oauth_dispatch/tests/test_jwt.py b/openedx/core/djangoapps/oauth_dispatch/tests/test_jwt.py index 647da14f6edd..7e756cf0df40 100644 --- a/openedx/core/djangoapps/oauth_dispatch/tests/test_jwt.py +++ b/openedx/core/djangoapps/oauth_dispatch/tests/test_jwt.py @@ -7,12 +7,12 @@ from django.test.utils import override_settings from django.utils.timezone import now +from common.djangoapps.student.tests.factories import UserFactory +from common.test.utils import assert_dict_contains_subset from openedx.core.djangoapps.oauth_dispatch import jwt as jwt_api from openedx.core.djangoapps.oauth_dispatch.adapters import DOTAdapter from openedx.core.djangoapps.oauth_dispatch.models import RestrictedApplication from openedx.core.djangoapps.oauth_dispatch.tests.mixins import AccessTokenMixin -from common.djangoapps.student.tests.factories import UserFactory -from common.test.utils import assert_dict_contains_subset @ddt.ddt diff --git a/openedx/core/djangoapps/oauth_dispatch/tests/test_views.py b/openedx/core/djangoapps/oauth_dispatch/tests/test_views.py index 776920781719..b8e056f4064e 100644 --- a/openedx/core/djangoapps/oauth_dispatch/tests/test_views.py +++ b/openedx/core/djangoapps/oauth_dispatch/tests/test_views.py @@ -18,7 +18,10 @@ from common.djangoapps.third_party_auth.tests.utils import ThirdPartyOAuthTestMixin, ThirdPartyOAuthTestMixinGoogle from openedx.core.djangoapps.oauth_dispatch.toggles import DISABLE_JWT_FOR_MOBILE from openedx.core.djangolib.testing.utils import skip_unless_lms + +from .. import adapters, models, views from . import mixins +from .constants import DUMMY_REDIRECT_URL # NOTE (CCB): We use this feature flag in a roundabout way to determine if the oauth_dispatch app is installed # in the current service--LMS or Studio. Normally we would check if settings.ROOT_URLCONF == 'lms.urls'; however, @@ -29,10 +32,6 @@ # these imports conditional except mixins, which doesn't currently import forbidden models, and is needed at test # discovery time. -from .constants import DUMMY_REDIRECT_URL -from .. import adapters -from .. import models -from .. import views class AccessTokenLoginMixin: @@ -56,7 +55,7 @@ def login_with_access_token(self, access_token=None): return self.client.post( self.login_with_access_token_url, - HTTP_AUTHORIZATION=f"Bearer {access_token if access_token else self.access_token}".encode('utf-8') + HTTP_AUTHORIZATION=f"Bearer {access_token if access_token else self.access_token}".encode('utf-8') # noqa: UP012 # pylint: disable=line-too-long ) def _assert_access_token_is_valid(self, access_token=None): @@ -710,7 +709,7 @@ def assert_is_view(self, view_candidate): _msg_base = '{view} is not a view: {reason}' msg_not_callable = _msg_base.format(view=view_candidate, reason='it is not callable') msg_no_request = _msg_base.format(view=view_candidate, reason='it has no request argument') - assert hasattr(view_candidate, '__call__'), msg_not_callable + assert hasattr(view_candidate, '__call__'), msg_not_callable # noqa: B004 args = view_candidate.__code__.co_varnames assert args, msg_no_request assert args[0] == 'request' @@ -749,7 +748,7 @@ def test_get_view_for_dot(self): def test_get_view_for_no_backend(self): view_object = views.AccessTokenView() - self.assertRaises(KeyError, view_object.get_view_for_backend, None) + self.assertRaises(KeyError, view_object.get_view_for_backend, None) # noqa: PT027 class TestRevokeTokenView(AccessTokenLoginMixin, _DispatchingViewTestCase): # pylint: disable=abstract-method diff --git a/openedx/core/djangoapps/oauth_dispatch/views.py b/openedx/core/djangoapps/oauth_dispatch/views.py index e430f9d48c70..5b626044bdb2 100644 --- a/openedx/core/djangoapps/oauth_dispatch/views.py +++ b/openedx/core/djangoapps/oauth_dispatch/views.py @@ -63,7 +63,7 @@ def get_view_for_backend(self, backend): Return the appropriate view from the requested backend. """ if backend == self.dot_adapter.backend: - return self.dot_view.as_view() # lint-amnesty, pylint: disable=no-member + return self.dot_view.as_view() # pylint: disable=no-member else: raise KeyError(f'Failed to dispatch view. Invalid backend {backend}') diff --git a/openedx/core/djangoapps/olx_rest_api/test_views.py b/openedx/core/djangoapps/olx_rest_api/test_views.py index bde877a457ae..b4f715df00e1 100644 --- a/openedx/core/djangoapps/olx_rest_api/test_views.py +++ b/openedx/core/djangoapps/olx_rest_api/test_views.py @@ -3,9 +3,9 @@ """ from xml.etree import ElementTree -from openedx.core.djangolib.testing.utils import skip_unless_cms from common.djangoapps.student.roles import CourseStaffRole from common.djangoapps.student.tests.factories import CourseEnrollmentFactory, UserFactory +from openedx.core.djangolib.testing.utils import skip_unless_cms from xmodule.modulestore import ModuleStoreEnum from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase from xmodule.modulestore.tests.factories import ToyCourseFactory @@ -41,7 +41,7 @@ def setUp(self): def assertXmlEqual(self, xml_str_a: str, xml_str_b: str) -> bool: """ Assert that the given XML strings are equal, ignoring attribute order and some whitespace variations. """ - self.assertEqual( + self.assertEqual( # noqa: PT009 ElementTree.canonicalize(xml_str_a, strip_text=True), ElementTree.canonicalize(xml_str_b, strip_text=True), ) diff --git a/openedx/core/djangoapps/olx_rest_api/urls.py b/openedx/core/djangoapps/olx_rest_api/urls.py index d25f412bd716..300c70a6795b 100644 --- a/openedx/core/djangoapps/olx_rest_api/urls.py +++ b/openedx/core/djangoapps/olx_rest_api/urls.py @@ -1,7 +1,7 @@ """ Studio URL configuration for openedx-olx-rest-api. """ -from django.urls import path, include +from django.urls import include, path from . import views diff --git a/openedx/core/djangoapps/olx_rest_api/views.py b/openedx/core/djangoapps/olx_rest_api/views.py index 1083ee06f68d..1bb859e518f0 100644 --- a/openedx/core/djangoapps/olx_rest_api/views.py +++ b/openedx/core/djangoapps/olx_rest_api/views.py @@ -11,10 +11,9 @@ from common.djangoapps.student.auth import has_studio_read_access from openedx.core.lib.api.view_utils import view_auth_classes +from openedx.core.lib.xblock_serializer.api import serialize_modulestore_block_for_openedx_content from xmodule.modulestore.django import modulestore -from openedx.core.lib.xblock_serializer.api import serialize_modulestore_block_for_learning_core - @api_view(['GET']) @view_auth_classes() @@ -22,13 +21,13 @@ def get_block_olx(request, usage_key_str): """ Given a modulestore XBlock usage ID (block-v1:...), get its OLX and a list of any static asset files it uses. - (There are other APIs for getting the OLX of Learning Core XBlocks.) + (There are other APIs for getting the OLX of openedx_content XBlocks.) """ # Parse the usage key: try: usage_key = UsageKey.from_string(usage_key_str) except (ValueError, InvalidKeyError): - raise ValidationError('Invalid usage key') # lint-amnesty, pylint: disable=raise-missing-from + raise ValidationError('Invalid usage key') # pylint: disable=raise-missing-from # noqa: B904 if usage_key.block_type in ('course', 'chapter', 'sequential'): raise ValidationError('Requested XBlock tree is too large - export verticals or their children only') course_key = usage_key.context_key @@ -48,7 +47,7 @@ def serialize_block(block_key): return block = modulestore().get_item(block_key) - serialized_blocks[block_key] = serialize_modulestore_block_for_learning_core(block) + serialized_blocks[block_key] = serialize_modulestore_block_for_openedx_content(block) if block.has_children: for child_id in block.children: @@ -92,7 +91,7 @@ def get_block_exportfs_file(request, usage_key_str, path): try: usage_key = UsageKey.from_string(usage_key_str) except (ValueError, InvalidKeyError): - raise ValidationError('Invalid usage key') # lint-amnesty, pylint: disable=raise-missing-from + raise ValidationError('Invalid usage key') # pylint: disable=raise-missing-from # noqa: B904 if usage_key.block_type in ('course', 'chapter', 'sequential'): raise ValidationError('Requested XBlock tree is too large - export verticals or their children only') course_key = usage_key.context_key @@ -103,7 +102,7 @@ def get_block_exportfs_file(request, usage_key_str, path): raise PermissionDenied("You must be a member of the course team in Studio to export OLX using this API.") block = modulestore().get_item(usage_key) - serialized = serialize_modulestore_block_for_learning_core(block) + serialized = serialize_modulestore_block_for_openedx_content(block) static_file = None for f in serialized.static_files: if f.name == path: diff --git a/openedx/core/djangoapps/password_policy/apps.py b/openedx/core/djangoapps/password_policy/apps.py index ffc8145b0fed..4df895c9efaa 100644 --- a/openedx/core/djangoapps/password_policy/apps.py +++ b/openedx/core/djangoapps/password_policy/apps.py @@ -3,6 +3,7 @@ """ import logging + from dateutil.parser import parse as parse_date from django.apps import AppConfig from django.conf import settings diff --git a/openedx/core/djangoapps/password_policy/compliance.py b/openedx/core/djangoapps/password_policy/compliance.py index 8601a55d658f..68a622cede65 100644 --- a/openedx/core/djangoapps/password_policy/compliance.py +++ b/openedx/core/djangoapps/password_policy/compliance.py @@ -3,14 +3,15 @@ """ from datetime import datetime - from zoneinfo import ZoneInfo + from django.conf import settings from django.utils.translation import gettext as _ -from openedx.core.djangolib.markup import HTML from common.djangoapps.util.date_utils import DEFAULT_SHORT_DATE_FORMAT, strftime_localized from common.djangoapps.util.password_policy_validators import validate_password +from openedx.core.djangoapps.site_configuration import helpers as configuration_helpers +from openedx.core.djangolib.markup import HTML class NonCompliantPasswordException(Exception): @@ -18,7 +19,7 @@ class NonCompliantPasswordException(Exception): Exception that should be raised when a user who is required to be compliant with password policy requirements is found to have a non-compliant password. """ - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass class NonCompliantPasswordWarning(Exception): @@ -26,7 +27,7 @@ class NonCompliantPasswordWarning(Exception): Exception that should be raised when a user who will soon be required to be compliant with password policy requirements is found to have a non-compliant password. """ - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass def should_enforce_compliance_on_login(): @@ -70,7 +71,7 @@ def enforce_compliance_on_login(user, password): return now = datetime.now(ZoneInfo("UTC")) - if now >= deadline: # lint-amnesty, pylint: disable=no-else-raise + if now >= deadline: # pylint: disable=no-else-raise raise NonCompliantPasswordException( HTML(_( '{strong_tag_open}We recently changed our password requirements{strong_tag_close}{break_line_tag}' @@ -97,7 +98,10 @@ def enforce_compliance_on_login(user, password): platform_name=settings.PLATFORM_NAME, deadline=strftime_localized(deadline, DEFAULT_SHORT_DATE_FORMAT), anchor_tag_open=HTML('          ').format( - account_settings_url=settings.ACCOUNT_MICROFRONTEND_URL + account_settings_url=configuration_helpers.get_value( + 'ACCOUNT_MICROFRONTEND_URL', + settings.ACCOUNT_MICROFRONTEND_URL, + ), ), anchor_tag_close=HTML('') ) diff --git a/openedx/core/djangoapps/password_policy/forms.py b/openedx/core/djangoapps/password_policy/forms.py index 7651583053b7..134e74ee66e2 100644 --- a/openedx/core/djangoapps/password_policy/forms.py +++ b/openedx/core/djangoapps/password_policy/forms.py @@ -28,6 +28,6 @@ def clean(self): messages.warning(self.request, HTML(str(e))) except password_policy_compliance.NonCompliantPasswordException as e: # Prevent the login attempt. - raise ValidationError(HTML(str(e))) # lint-amnesty, pylint: disable=raise-missing-from + raise ValidationError(HTML(str(e))) # pylint: disable=raise-missing-from # noqa: B904 return cleaned_data diff --git a/openedx/core/djangoapps/password_policy/hibp.py b/openedx/core/djangoapps/password_policy/hibp.py index 5821df9816b1..5ee049701bd2 100644 --- a/openedx/core/djangoapps/password_policy/hibp.py +++ b/openedx/core/djangoapps/password_policy/hibp.py @@ -55,7 +55,7 @@ def range(password): if not is_encrypted: password = hashlib.sha1(password.encode('utf-8')).hexdigest().upper() - range_url = PwnedPasswordsAPI.API_URL + '/range/{}'.format(password[:5]) + range_url = PwnedPasswordsAPI.API_URL + '/range/{}'.format(password[:5]) # noqa: UP032 if ENABLE_PWNED_PASSWORD_API.is_enabled(): try: @@ -65,7 +65,7 @@ def range(password): return entries except ReadTimeout: - log.warning('Request timed out for {}'.format(password)) + log.warning('Request timed out for {}'.format(password)) # noqa: UP032 return HTTP_408_REQUEST_TIMEOUT except Exception as exc: # pylint: disable=W0703 @@ -80,7 +80,7 @@ def is_sha1(maybe_sha): return False try: - sha_int = int(maybe_sha, HEX_BASE) + sha_int = int(maybe_sha, HEX_BASE) # noqa: F841 except ValueError: return False diff --git a/openedx/core/djangoapps/password_policy/settings/devstack.py b/openedx/core/djangoapps/password_policy/settings/devstack.py index fd56bbb63cf8..f83354bc19ea 100644 --- a/openedx/core/djangoapps/password_policy/settings/devstack.py +++ b/openedx/core/djangoapps/password_policy/settings/devstack.py @@ -7,4 +7,4 @@ def plugin_settings(settings): # pylint: disable=unused-argument """ Override the default password_policy app settings with development settings. """ - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass diff --git a/openedx/core/djangoapps/password_policy/tests/test_compliance.py b/openedx/core/djangoapps/password_policy/tests/test_compliance.py index 5d8a56d60c80..f46122973bc1 100644 --- a/openedx/core/djangoapps/password_policy/tests/test_compliance.py +++ b/openedx/core/djangoapps/password_policy/tests/test_compliance.py @@ -4,22 +4,22 @@ from datetime import datetime, timedelta from unittest.mock import patch +from zoneinfo import ZoneInfo import pytest -from zoneinfo import ZoneInfo from dateutil.parser import parse as parse_date from django.test import TestCase, override_settings -from openedx.core.djangoapps.password_policy.compliance import (NonCompliantPasswordException, - NonCompliantPasswordWarning, - _check_user_compliance, - _get_compliance_deadline_for_user, - enforce_compliance_on_login, - should_enforce_compliance_on_login) -from common.djangoapps.student.tests.factories import (CourseAccessRoleFactory, - UserFactory) +from common.djangoapps.student.tests.factories import CourseAccessRoleFactory, UserFactory from common.djangoapps.util.password_policy_validators import ValidationError - +from openedx.core.djangoapps.password_policy.compliance import ( + NonCompliantPasswordException, + NonCompliantPasswordWarning, + _check_user_compliance, + _get_compliance_deadline_for_user, + enforce_compliance_on_login, + should_enforce_compliance_on_login, +) date1 = parse_date('2018-01-01 00:00:00+00:00') date2 = parse_date('2018-02-02 00:00:00+00:00') @@ -199,3 +199,56 @@ def test_get_compliance_deadline_for_user_fallbacks(self): assert date1 == _get_compliance_deadline_for_user(staff) assert date1 == _get_compliance_deadline_for_user(privileged) assert date1 == _get_compliance_deadline_for_user(user) + + def test_warning_link_uses_site_config_account_mfe_url(self): + """ + When site config defines ACCOUNT_MICROFRONTEND_URL, the warning text should + use that value for the Account Settings anchor href. + """ + user = UserFactory() + password = "irrelevant" + siteconf_url = "https://accounts.siteconf.example" + + with patch( + "openedx.core.djangoapps.password_policy.compliance._check_user_compliance", + return_value=False, + ), patch( + "openedx.core.djangoapps.password_policy.compliance._get_compliance_deadline_for_user", + return_value=datetime.now(ZoneInfo("UTC")) + timedelta(days=1), + ), patch( + "openedx.core.djangoapps.password_policy.compliance.configuration_helpers.get_value", + side_effect=lambda key, default=None, *a, **k: + siteconf_url if key == "ACCOUNT_MICROFRONTEND_URL" else default, + ): + with pytest.raises(NonCompliantPasswordWarning) as excinfo: + enforce_compliance_on_login(user, password) + + msg = str(excinfo.value) + assert f'Account Settings' in msg + + def test_warning_link_falls_back_to_settings_account_mfe_url(self): + """ + If site config doesn't override, the warning text should fall back to + settings.ACCOUNT_MICROFRONTEND_URL for the anchor href. + """ + user = UserFactory() + password = "irrelevant" + fallback = "https://accounts.settings.example" + + with override_settings(ACCOUNT_MICROFRONTEND_URL=fallback): + with patch( + "openedx.core.djangoapps.password_policy.compliance._check_user_compliance", + return_value=False, + ), patch( + "openedx.core.djangoapps.password_policy.compliance._get_compliance_deadline_for_user", + return_value=datetime.now(ZoneInfo("UTC")) + timedelta(days=1), + ), patch( + "openedx.core.djangoapps.password_policy.compliance.configuration_helpers.get_value", + # Simulate "no override": return default argument + side_effect=lambda key, default=None, *a, **k: default, + ): + with pytest.raises(NonCompliantPasswordWarning) as excinfo: + enforce_compliance_on_login(user, password) + + msg = str(excinfo.value) + assert f'Account Settings' in msg diff --git a/openedx/core/djangoapps/password_policy/tests/test_forms.py b/openedx/core/djangoapps/password_policy/tests/test_forms.py index 4a0e04d39560..8ca574e899c1 100644 --- a/openedx/core/djangoapps/password_policy/tests/test_forms.py +++ b/openedx/core/djangoapps/password_policy/tests/test_forms.py @@ -8,11 +8,12 @@ from django.test import TestCase from django.test.utils import override_settings +from common.djangoapps.student.tests.factories import UserFactory from openedx.core.djangoapps.password_policy.compliance import ( - NonCompliantPasswordException, NonCompliantPasswordWarning + NonCompliantPasswordException, + NonCompliantPasswordWarning, ) from openedx.core.djangoapps.password_policy.forms import PasswordPolicyAwareAdminAuthForm -from common.djangoapps.student.tests.factories import UserFactory class PasswordPolicyAwareAdminAuthFormTests(TestCase): diff --git a/openedx/core/djangoapps/password_policy/tests/test_hibp.py b/openedx/core/djangoapps/password_policy/tests/test_hibp.py index 7913b4b54d8d..06daaa09c9f7 100644 --- a/openedx/core/djangoapps/password_policy/tests/test_hibp.py +++ b/openedx/core/djangoapps/password_policy/tests/test_hibp.py @@ -34,7 +34,7 @@ def test_matched_pwned_passwords(self, mock_get): mock_get.return_value = response response = PwnedPasswordsAPI.range('7ecd7') - self.assertEqual(response, pwned_password) + self.assertEqual(response, pwned_password) # noqa: PT009 @override_waffle_switch(ENABLE_PWNED_PASSWORD_API, True) @patch('requests.get', side_effect=ReadTimeout) @@ -50,14 +50,14 @@ def test_warning_log_on_timeout(self, mock_get): # pylint: disable=unused-argum ( log.name, 'WARNING', - 'Request timed out for {}'.format(password_hash_hex) + 'Request timed out for {}'.format(password_hash_hex) # noqa: UP032 ) ) - assert 'Request timed out for {}'.format(password_hash_hex) in log_capture.records[0].getMessage() + assert 'Request timed out for {}'.format(password_hash_hex) in log_capture.records[0].getMessage() # noqa: UP032 # pylint: disable=line-too-long def test_provided_string_is_sha1_or_not(self): hashed_password = '8BB6118F8FD6935AD0876A3BE34A717D32708FFD' - self.assertTrue(PwnedPasswordsAPI.is_sha1(hashed_password)) + self.assertTrue(PwnedPasswordsAPI.is_sha1(hashed_password)) # noqa: PT009 raw_password = 'testpassword' - self.assertFalse(PwnedPasswordsAPI.is_sha1(raw_password)) + self.assertFalse(PwnedPasswordsAPI.is_sha1(raw_password)) # noqa: PT009 diff --git a/openedx/core/djangoapps/plugin_api/views.py b/openedx/core/djangoapps/plugin_api/views.py index 68610d3c3a94..2ee6b3b0008a 100644 --- a/openedx/core/djangoapps/plugin_api/views.py +++ b/openedx/core/djangoapps/plugin_api/views.py @@ -16,7 +16,7 @@ log = logging.getLogger('plugin_api') -class EdxFragmentView(FragmentView): # lint-amnesty, pylint: disable=abstract-method +class EdxFragmentView(FragmentView): # pylint: disable=abstract-method """ The base class of all Open edX fragment views. """ @@ -79,7 +79,7 @@ def add_fragment_resource_urls(self, fragment): for js_file in self.js_dependencies(): fragment.add_javascript_url(staticfiles_storage.url(js_file)) - def create_base_standalone_context(self, request, fragment, **kwargs): # lint-amnesty, pylint: disable=unused-argument + def create_base_standalone_context(self, request, fragment, **kwargs): # pylint: disable=unused-argument """ Creates the base context for rendering a fragment as a standalone page. """ @@ -111,7 +111,7 @@ def _add_studio_standalone_context_variables(self, request, context): 'is_marketing_link_set': is_marketing_link_set, }) - def standalone_page_title(self, request, fragment, **kwargs): # lint-amnesty, pylint: disable=unused-argument + def standalone_page_title(self, request, fragment, **kwargs): # pylint: disable=unused-argument """ Returns the page title for the standalone page, or None if there is no title. """ diff --git a/openedx/core/djangoapps/plugins/apps.py b/openedx/core/djangoapps/plugins/apps.py index 625a82966bd3..a10359e60373 100644 --- a/openedx/core/djangoapps/plugins/apps.py +++ b/openedx/core/djangoapps/plugins/apps.py @@ -7,10 +7,9 @@ from django.apps import AppConfig from django.conf import settings -from edx_django_utils.plugins import connect_plugin_receivers +from edx_django_utils.plugins import PluginSettings, connect_plugin_receivers from openedx.core.djangoapps.plugins.constants import ProjectType, SettingsType -from edx_django_utils.plugins import PluginSettings class PluginsConfig(AppConfig): diff --git a/openedx/core/djangoapps/plugins/constants.py b/openedx/core/djangoapps/plugins/constants.py index a4dceee83fe5..8d2b12c8c151 100644 --- a/openedx/core/djangoapps/plugins/constants.py +++ b/openedx/core/djangoapps/plugins/constants.py @@ -3,15 +3,15 @@ """ # expose constants from edx-django-utils so plugins using these continue to work -from edx_django_utils.plugins import ( # lint-amnesty, pylint: disable=unused-import - PluginSettings, # pylint: disable=unused-import - PluginURLs, # pylint: disable=unused-import - PluginSignals, # pylint: disable=unused-import - PluginContexts, # pylint: disable=unused-import +from edx_django_utils.plugins import ( # pylint: disable=unused-import + PluginContexts, # noqa: F401 + PluginSettings, # noqa: F401 + PluginSignals, # noqa: F401 + PluginURLs, # noqa: F401 ) -class ProjectType(): +class ProjectType(): # noqa: UP039 """ The ProjectType enum defines the possible values for the Django Projects that are available in the edx-platform. Plugin apps use these values to @@ -22,7 +22,7 @@ class ProjectType(): CMS = 'cms.djangoapp' -class SettingsType(): +class SettingsType(): # noqa: UP039 """ The SettingsType enum defines the possible values for the settings files that are available for extension in the edx-platform. Plugin apps use these diff --git a/openedx/core/djangoapps/plugins/i18n_api.py b/openedx/core/djangoapps/plugins/i18n_api.py index ae8bb5628628..eb70fccd0caf 100644 --- a/openedx/core/djangoapps/plugins/i18n_api.py +++ b/openedx/core/djangoapps/plugins/i18n_api.py @@ -2,11 +2,11 @@ edx-platform specific i18n helpers for edx-django-utils plugins. """ -from dataclasses import dataclass, asdict -from collections import defaultdict import os -from pathlib import Path import subprocess +from collections import defaultdict +from dataclasses import asdict, dataclass +from pathlib import Path from django.core.management import BaseCommand, CommandError from importlib_metadata import entry_points diff --git a/openedx/core/djangoapps/plugins/management/commands/compile_plugin_translations.py b/openedx/core/djangoapps/plugins/management/commands/compile_plugin_translations.py index 56322f104b1c..4ee9d13127eb 100644 --- a/openedx/core/djangoapps/plugins/management/commands/compile_plugin_translations.py +++ b/openedx/core/djangoapps/plugins/management/commands/compile_plugin_translations.py @@ -2,13 +2,11 @@ Compile the translation files for the edx_django_utils.plugins. """ -from django.core.management.base import BaseCommand from django.conf import settings - - -from ...constants import plugins_locale_root +from django.core.management.base import BaseCommand from ... import i18n_api +from ...constants import plugins_locale_root class Command(BaseCommand): diff --git a/openedx/core/djangoapps/plugins/management/commands/pull_plugin_translations.py b/openedx/core/djangoapps/plugins/management/commands/pull_plugin_translations.py index 7ca4f443d079..26753aab26f6 100644 --- a/openedx/core/djangoapps/plugins/management/commands/pull_plugin_translations.py +++ b/openedx/core/djangoapps/plugins/management/commands/pull_plugin_translations.py @@ -9,10 +9,7 @@ from openedx.core.djangoapps.plugins.i18n_api import BaseAtlasPullCommand from ...constants import plugins_locale_root - -from ...i18n_api import ( - plugin_translations_atlas_pull, -) +from ...i18n_api import plugin_translations_atlas_pull class Command(BaseAtlasPullCommand): diff --git a/openedx/core/djangoapps/plugins/tests/test_i18n_api.py b/openedx/core/djangoapps/plugins/tests/test_i18n_api.py index 0bbf77b600bb..f1b0e87b1148 100644 --- a/openedx/core/djangoapps/plugins/tests/test_i18n_api.py +++ b/openedx/core/djangoapps/plugins/tests/test_i18n_api.py @@ -88,7 +88,7 @@ def test_base_atlas_pull_command(tmp_path): command = BaseAtlasPullCommand() assert command.ensure_empty_directory(tmp_path) is None, 'Should not raise an exception if the directory is empty' - with pytest.raises(CommandError): + with pytest.raises(CommandError): # noqa: PT012 with open(tmp_path / 'test.txt', 'w'): # Directory is not empty anymore pass diff --git a/openedx/core/djangoapps/profile_images/images.py b/openedx/core/djangoapps/profile_images/images.py index ca114c3569fb..99360a5b898b 100644 --- a/openedx/core/djangoapps/profile_images/images.py +++ b/openedx/core/djangoapps/profile_images/images.py @@ -93,7 +93,7 @@ def validate_uploaded_image(uploaded_file): # adapted from https://github.com/pmitros/ProfileXBlock # see also: http://en.wikipedia.org/wiki/Magic_number_%28programming%29 - if uploaded_file.size > settings.PROFILE_IMAGE_MAX_BYTES: # lint-amnesty, pylint: disable=no-else-raise + if uploaded_file.size > settings.PROFILE_IMAGE_MAX_BYTES: # pylint: disable=no-else-raise file_upload_too_large = _( 'The file must be smaller than {image_max_size} in size.' ).format( @@ -226,7 +226,7 @@ def _get_valid_file_types(): """ Return comma separated string of valid file types. """ - return ', '.join([', '.join(IMAGE_TYPES[ft].extensions) for ft in IMAGE_TYPES.keys()]) # lint-amnesty, pylint: disable=consider-iterating-dictionary + return ', '.join([', '.join(IMAGE_TYPES[ft].extensions) for ft in IMAGE_TYPES.keys()]) # pylint: disable=consider-iterating-dictionary def _user_friendly_size(size): diff --git a/openedx/core/djangoapps/profile_images/tests/helpers.py b/openedx/core/djangoapps/profile_images/tests/helpers.py index cbb6e76ac957..34296896138f 100644 --- a/openedx/core/djangoapps/profile_images/tests/helpers.py +++ b/openedx/core/djangoapps/profile_images/tests/helpers.py @@ -2,12 +2,12 @@ Helper methods for use in profile image tests. """ -from contextlib import contextmanager import os +from contextlib import contextmanager from tempfile import NamedTemporaryFile -from django.core.files.uploadedfile import UploadedFile import piexif +from django.core.files.uploadedfile import UploadedFile from PIL import Image @@ -28,7 +28,7 @@ def make_image_file(dimensions=(320, 240), prefix='tmp', extension='.jpeg', forc """ image = Image.new('RGB', dimensions, "green") - image_file = NamedTemporaryFile(prefix=prefix, suffix=extension) # lint-amnesty, pylint: disable=consider-using-with + image_file = NamedTemporaryFile(prefix=prefix, suffix=extension) # pylint: disable=consider-using-with try: if orientation and orientation in range(1, 9): exif_bytes = piexif.dump({'0th': {piexif.ImageIFD.Orientation: orientation}}) diff --git a/openedx/core/djangoapps/profile_images/tests/test_images.py b/openedx/core/djangoapps/profile_images/tests/test_images.py index d46a89175a83..49a8dfa528f5 100644 --- a/openedx/core/djangoapps/profile_images/tests/test_images.py +++ b/openedx/core/djangoapps/profile_images/tests/test_images.py @@ -1,30 +1,30 @@ """ Test cases for image processing functions in the profile image package. """ +import os # pylint: disable=wrong-import-order from contextlib import closing +from itertools import product # pylint: disable=wrong-import-order +from tempfile import NamedTemporaryFile # pylint: disable=wrong-import-order from unittest import mock +import ddt +import piexif import pytest -from itertools import product # lint-amnesty, pylint: disable=wrong-import-order -import os # lint-amnesty, pylint: disable=wrong-import-order -from tempfile import NamedTemporaryFile # lint-amnesty, pylint: disable=wrong-import-order - from django.core.files.uploadedfile import UploadedFile from django.test import TestCase from django.test.utils import override_settings -import ddt -import piexif from PIL import Image from openedx.core.djangolib.testing.utils import skip_unless_lms + from ..exceptions import ImageValidationError from ..images import ( + _get_exif_orientation, + _get_valid_file_types, + _update_exif_orientation, create_profile_images, remove_profile_images, validate_uploaded_image, - _get_exif_orientation, - _get_valid_file_types, - _update_exif_orientation ) from .helpers import make_image_file, make_uploaded_file @@ -36,7 +36,7 @@ class TestValidateUploadedImage(TestCase): Test validate_uploaded_image """ FILE_UPLOAD_BAD_TYPE = ( - 'The file must be one of the following types: {valid_file_types}.'.format( + 'The file must be one of the following types: {valid_file_types}.'.format( # noqa: UP032 valid_file_types=_get_valid_file_types() ) ) @@ -61,7 +61,7 @@ def check_validation_result(self, uploaded_file, expected_failure_message): ) @ddt.unpack @override_settings(PROFILE_IMAGE_MIN_BYTES=100, PROFILE_IMAGE_MAX_BYTES=1024) - def test_file_size(self, upload_size, expected_failure_message=None): + def test_file_size(self, upload_size, expected_failure_message=None): # noqa: PT028 """ Ensure that files outside the accepted size range fail validation. """ @@ -79,7 +79,7 @@ def test_file_size(self, upload_size, expected_failure_message=None): (".tif", "image/tiff", FILE_UPLOAD_BAD_TYPE), ) @ddt.unpack - def test_extension(self, extension, content_type, expected_failure_message=None): + def test_extension(self, extension, content_type, expected_failure_message=None): # noqa: PT028 """ Ensure that files whose extension is not supported fail validation. """ diff --git a/openedx/core/djangoapps/profile_images/tests/test_views.py b/openedx/core/djangoapps/profile_images/tests/test_views.py index 963c0956c28a..21648f992846 100644 --- a/openedx/core/djangoapps/profile_images/tests/test_views.py +++ b/openedx/core/djangoapps/profile_images/tests/test_views.py @@ -1,31 +1,29 @@ """ Test cases for the HTTP endpoints of the profile image api. """ +import datetime # pylint: disable=wrong-import-order from contextlib import closing from unittest import mock from unittest.mock import patch - -import pytest -import datetime # lint-amnesty, pylint: disable=wrong-import-order from zoneinfo import ZoneInfo -from django.urls import reverse -from django.http import HttpResponse - import ddt +import pytest +from django.http import HttpResponse +from django.urls import reverse from PIL import Image -from rest_framework.test import APITestCase, APIClient +from rest_framework.test import APIClient, APITestCase from common.djangoapps.student.tests.factories import UserFactory from common.djangoapps.student.tests.tests import UserSettingsEventTestMixin from openedx.core.djangoapps.user_api.accounts.image_helpers import ( - set_has_profile_image, get_profile_image_names, get_profile_image_storage, + set_has_profile_image, ) from openedx.core.djangolib.testing.utils import skip_unless_lms -from ..images import create_profile_images, ImageValidationError +from ..images import ImageValidationError, create_profile_images from ..views import LOG_MESSAGE_CREATE, LOG_MESSAGE_DELETE from .helpers import make_image_file @@ -169,7 +167,7 @@ def test_anonymous_access(self, mock_log): 'openedx.core.djangoapps.profile_images.views._make_upload_dt', side_effect=[TEST_UPLOAD_DT, TEST_UPLOAD_DT2], ) - def test_upload_self(self, extension, _mock_make_image_version, mock_log): + def test_upload_self(self, extension, _mock_make_image_version, mock_log): # noqa: PT019 """ Test that an authenticated user can POST to their own upload endpoint. """ @@ -202,7 +200,7 @@ def test_upload_self(self, extension, _mock_make_image_version, mock_log): ) @ddt.unpack @patch('openedx.core.djangoapps.profile_images.views._make_upload_dt', return_value=TEST_UPLOAD_DT) - def test_upload_by_mimetype(self, content_type, extension, _mock_make_image_version, mock_log): + def test_upload_by_mimetype(self, content_type, extension, _mock_make_image_version, mock_log): # noqa: PT019 """ Test that a user can upload raw content with the appropriate mimetype """ @@ -350,7 +348,7 @@ def test_upload_failure(self, image_open, mock_log): """ image_open.side_effect = [Exception("whoops"), None] with make_image_file() as image_file: - with pytest.raises(Exception): + with pytest.raises(Exception): # noqa: B017, PT011 self.client.post(self.url, {'file': image_file}, format='multipart') self.check_images(False) self.check_has_profile_image(False) @@ -448,7 +446,7 @@ def test_remove_failure(self, user_profile_save, mock_log): messages are returned. """ user_profile_save.side_effect = [Exception("whoops"), None] - with pytest.raises(Exception): + with pytest.raises(Exception): # noqa: B017, PT011 self.client.delete(self.url) self.check_images(True) # thumbnails should remain intact. self.check_has_profile_image(True) diff --git a/openedx/core/djangoapps/profile_images/urls.py b/openedx/core/djangoapps/profile_images/urls.py index afb64a89e353..f0f142d7a001 100644 --- a/openedx/core/djangoapps/profile_images/urls.py +++ b/openedx/core/djangoapps/profile_images/urls.py @@ -5,7 +5,7 @@ ``/api/user/v1/accounts/{username}/image``, found in ``openedx.core.djangoapps.user_api.urls``. """ -# pylint: enable=unicode-format-string # lint-amnesty, pylint: disable=bad-option-value +# pylint: enable=unicode-format-string # pylint: disable=bad-option-value from django.conf import settings diff --git a/openedx/core/djangoapps/profile_images/views.py b/openedx/core/djangoapps/profile_images/views.py index 1c9d4fcf3bf7..72fef1da9fc7 100644 --- a/openedx/core/djangoapps/profile_images/views.py +++ b/openedx/core/djangoapps/profile_images/views.py @@ -7,11 +7,11 @@ import itertools import logging from contextlib import closing +from zoneinfo import ZoneInfo from django.utils.translation import gettext as _ from edx_rest_framework_extensions.auth.jwt.authentication import JwtAuthentication from edx_rest_framework_extensions.auth.session.authentication import SessionAuthenticationAllowInactiveUser -from zoneinfo import ZoneInfo from rest_framework import permissions, status from rest_framework.parsers import FormParser, MultiPartParser from rest_framework.response import Response diff --git a/openedx/core/djangoapps/programs/__init__.py b/openedx/core/djangoapps/programs/__init__.py index 8fc52e05f14e..04db422469a6 100644 --- a/openedx/core/djangoapps/programs/__init__.py +++ b/openedx/core/djangoapps/programs/__init__.py @@ -13,7 +13,7 @@ PROGRAMS_WAFFLE_SWITCH_NAMESPACE = 'programs' # This is meant to be enabled until https://openedx.atlassian.net/browse/LEARNER-5573 needs to be resolved -ALWAYS_CALCULATE_PROGRAM_PRICE_AS_ANONYMOUS_USER = WaffleSwitch( # lint-amnesty, pylint: disable=toggle-missing-annotation +ALWAYS_CALCULATE_PROGRAM_PRICE_AS_ANONYMOUS_USER = WaffleSwitch( # pylint: disable=toggle-missing-annotation f'{PROGRAMS_WAFFLE_SWITCH_NAMESPACE}.always_calculate_program_price_as_anonymous_user', __name__ ) diff --git a/openedx/core/djangoapps/programs/admin.py b/openedx/core/djangoapps/programs/admin.py index 6f0949b424a0..ef003ae2c540 100644 --- a/openedx/core/djangoapps/programs/admin.py +++ b/openedx/core/djangoapps/programs/admin.py @@ -8,8 +8,11 @@ from simple_history.admin import SimpleHistoryAdmin from openedx.core.djangoapps.programs.forms import ProgramDiscussionsConfigurationForm, ProgramLiveConfigurationForm -from openedx.core.djangoapps.programs.models import ProgramsApiConfig, ProgramDiscussionsConfiguration, \ - ProgramLiveConfiguration +from openedx.core.djangoapps.programs.models import ( + ProgramDiscussionsConfiguration, + ProgramLiveConfiguration, + ProgramsApiConfig, +) class ProgramsApiConfigAdmin(ConfigurationModelAdmin): diff --git a/openedx/core/djangoapps/programs/api.py b/openedx/core/djangoapps/programs/api.py index bf852c9c5c8c..5db2463e991f 100644 --- a/openedx/core/djangoapps/programs/api.py +++ b/openedx/core/djangoapps/programs/api.py @@ -5,7 +5,7 @@ from .utils import is_user_enrolled_in_program_type as _is_user_enrolled_in_program_type -def is_user_enrolled_in_program_type(user, program_type_slug, paid_modes_only=False, enrollments=None, entitlements=None): # lint-amnesty, pylint: disable=line-too-long +def is_user_enrolled_in_program_type(user, program_type_slug, paid_modes_only=False, enrollments=None, entitlements=None): # pylint: disable=line-too-long """ This method will look at the learners Enrollments and Entitlements to determine if a learner is enrolled in a Program of the given type. diff --git a/openedx/core/djangoapps/programs/apps.py b/openedx/core/djangoapps/programs/apps.py index 7136834e9a0e..baa172f90e1b 100644 --- a/openedx/core/djangoapps/programs/apps.py +++ b/openedx/core/djangoapps/programs/apps.py @@ -14,4 +14,4 @@ class ProgramsConfig(AppConfig): def ready(self): # noinspection PyUnresolvedReferences - from . import signals, tasks # lint-amnesty, pylint: disable=unused-import, unused-variable + from . import signals, tasks # pylint: disable=unused-import, unused-variable # noqa: F401 diff --git a/openedx/core/djangoapps/programs/forms.py b/openedx/core/djangoapps/programs/forms.py index ac4bff5b7212..a7853e95a687 100644 --- a/openedx/core/djangoapps/programs/forms.py +++ b/openedx/core/djangoapps/programs/forms.py @@ -31,7 +31,7 @@ def save(self, commit=True): class Meta: model = ProgramDiscussionsConfiguration - fields = '__all__' + fields = '__all__' # noqa: DJ007 class ProgramLiveConfigurationForm(forms.ModelForm): @@ -59,4 +59,4 @@ def save(self, commit=True): class Meta: model = ProgramLiveConfiguration - fields = '__all__' + fields = '__all__' # noqa: DJ007 diff --git a/openedx/core/djangoapps/programs/migrations/0013_customprogramsconfig.py b/openedx/core/djangoapps/programs/migrations/0013_customprogramsconfig.py index e162f5339316..cd66bcbe2f4d 100644 --- a/openedx/core/djangoapps/programs/migrations/0013_customprogramsconfig.py +++ b/openedx/core/djangoapps/programs/migrations/0013_customprogramsconfig.py @@ -1,9 +1,9 @@ # Generated by Django 1.11.26 on 2019-12-13 07:44 +import django.db.models.deletion from django.conf import settings from django.db import migrations, models -import django.db.models.deletion class Migration(migrations.Migration): diff --git a/openedx/core/djangoapps/programs/migrations/0015_historicalprogramdiscussionsconfiguration_historicalprogramliveconfiguration_programdiscussionsconfi.py b/openedx/core/djangoapps/programs/migrations/0015_historicalprogramdiscussionsconfiguration_historicalprogramliveconfiguration_programdiscussionsconfi.py index 59ad6186f9fb..37f7b0a1b2f4 100644 --- a/openedx/core/djangoapps/programs/migrations/0015_historicalprogramdiscussionsconfiguration_historicalprogramliveconfiguration_programdiscussionsconfi.py +++ b/openedx/core/djangoapps/programs/migrations/0015_historicalprogramdiscussionsconfiguration_historicalprogramliveconfiguration_programdiscussionsconfi.py @@ -1,11 +1,11 @@ # Generated by Django 3.2.11 on 2022-02-03 21:34 -from django.conf import settings -from django.db import migrations, models import django.db.models.deletion import django.utils.timezone import model_utils.fields import simple_history.models +from django.conf import settings +from django.db import migrations, models class Migration(migrations.Migration): diff --git a/openedx/core/djangoapps/programs/models.py b/openedx/core/djangoapps/programs/models.py index e708066813b8..7a997ced2cfb 100644 --- a/openedx/core/djangoapps/programs/models.py +++ b/openedx/core/djangoapps/programs/models.py @@ -2,9 +2,9 @@ from config_models.models import ConfigurationModel from django.db import models from django.utils.translation import gettext_lazy as _ -from simple_history.models import HistoricalRecords from lti_consumer.models import LtiConfiguration from model_utils.models import TimeStampedModel +from simple_history.models import HistoricalRecords class ProgramsApiConfig(ConfigurationModel): diff --git a/openedx/core/djangoapps/programs/rest_api/urls.py b/openedx/core/djangoapps/programs/rest_api/urls.py index 6533f709b85d..11b7ef431be1 100644 --- a/openedx/core/djangoapps/programs/rest_api/urls.py +++ b/openedx/core/djangoapps/programs/rest_api/urls.py @@ -10,9 +10,7 @@ from django.urls import include, path -from openedx.core.djangoapps.programs.rest_api.v1 import ( - urls as v1_programs_rest_api_urls, -) +from openedx.core.djangoapps.programs.rest_api.v1 import urls as v1_programs_rest_api_urls app_name = "openedx.core.djangoapps.programs" diff --git a/openedx/core/djangoapps/programs/rest_api/v1/tests/test_views.py b/openedx/core/djangoapps/programs/rest_api/v1/tests/test_views.py index 11428591db74..2fbdfd14b6d0 100644 --- a/openedx/core/djangoapps/programs/rest_api/v1/tests/test_views.py +++ b/openedx/core/djangoapps/programs/rest_api/v1/tests/test_views.py @@ -11,13 +11,8 @@ from enterprise.models import EnterpriseCourseEnrollment from common.djangoapps.student.models import CourseEnrollment -from common.djangoapps.student.tests.factories import ( - CourseEnrollmentFactory, - UserFactory, -) -from lms.djangoapps.program_enrollments.rest_api.v1.tests.test_views import ( - ProgramCacheMixin, -) +from common.djangoapps.student.tests.factories import CourseEnrollmentFactory, UserFactory +from lms.djangoapps.program_enrollments.rest_api.v1.tests.test_views import ProgramCacheMixin from lms.djangoapps.program_enrollments.tests.factories import ProgramEnrollmentFactory from openedx.core.djangoapps.catalog.cache import SITE_PROGRAM_UUIDS_CACHE_KEY_TPL from openedx.core.djangoapps.catalog.constants import PathwayType @@ -29,9 +24,7 @@ ) from openedx.core.djangoapps.programs.tests.mixins import ProgramsApiConfigMixin from openedx.core.djangoapps.site_configuration.tests.factories import SiteFactory -from openedx.core.djangoapps.site_configuration.tests.test_util import ( - with_site_configuration, -) +from openedx.core.djangoapps.site_configuration.tests.test_util import with_site_configuration from openedx.core.djangolib.testing.utils import skip_unless_lms from openedx.features.enterprise_support.api import enterprise_is_enabled from openedx.features.enterprise_support.tests.factories import ( @@ -40,9 +33,7 @@ EnterpriseCustomerUserFactory, ) from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase -from xmodule.modulestore.tests.factories import ( - CourseFactory as ModuleStoreCourseFactory, -) +from xmodule.modulestore.tests.factories import CourseFactory as ModuleStoreCourseFactory PROGRAMS_UTILS_MODULE = "openedx.core.djangoapps.programs.utils" @@ -63,14 +54,14 @@ def setUpClass(cls): super().setUpClass() modulestore_course = ModuleStoreCourseFactory() - course_run = CourseRunFactory(key=str(modulestore_course.id)) # lint-amnesty, pylint: disable=no-member + course_run = CourseRunFactory(key=str(modulestore_course.id)) # pylint: disable=no-member course = CourseFactory(course_runs=[course_run]) cls.program_data = ProgramFactory(uuid=cls.program_uuid, courses=[course]) cls.pathway_data = PathwayFactory() cls.program_data["pathway_ids"] = [cls.pathway_data["id"]] cls.pathway_data["program_uuids"] = [cls.program_data["uuid"]] - del cls.pathway_data["programs"] # lint-amnesty, pylint: disable=unsupported-delete-operation + del cls.pathway_data["programs"] # pylint: disable=unsupported-delete-operation def setUp(self): super().setUp() @@ -114,7 +105,7 @@ def test_api_returns_correct_program_data(self, mock_get_programs, mock_get_path certs.return_value = [{"type": "program", "url": "/"}] response = self.client.get(self.url) - self.assertEqual(200, response.status_code) + self.assertEqual(200, response.status_code) # noqa: PT009 self.assert_program_data_present(response) self.assert_pathway_data_present(response) @@ -131,7 +122,7 @@ def test_login_required(self, mock_get_programs, mock_get_pathways): response = self.client.get(self.url) assert response.status_code == 401 - def test_404_if_no_program_data(self, mock_get_programs, _mock_get_pathways): + def test_404_if_no_program_data(self, mock_get_programs, _mock_get_pathways): # noqa: PT019 """ Verify that the API returns 404 if program data is not available. """ @@ -208,7 +199,7 @@ def test_program_list_enterprise(self): ) response = self.client.get(self.url) - self.assertEqual(response.status_code, 200) + self.assertEqual(response.status_code, 200) # noqa: PT009 program = response.data[0] assert len(program) @@ -242,8 +233,8 @@ def test_program_empty_list_if_no_enterprise_enrollments(self): ) response = self.client.get(self.url) - self.assertEqual(response.status_code, 200) - self.assertEqual(response.data, []) + self.assertEqual(response.status_code, 200) # noqa: PT009 + self.assertEqual(response.data, []) # noqa: PT009 @skip_unless_lms @@ -300,7 +291,7 @@ def test_program_list_b2c(self): ) response = self.client.get(self.url) - self.assertEqual(response.status_code, 200) + self.assertEqual(response.status_code, 200) # noqa: PT009 program = response.data[0] assert len(program) @@ -331,5 +322,5 @@ def test_program_empty_list_if_no_enrollments(self): ) response = self.client.get(self.url) - self.assertEqual(response.status_code, 200) - self.assertEqual(response.data, []) + self.assertEqual(response.status_code, 200) # noqa: PT009 + self.assertEqual(response.data, []) # noqa: PT009 diff --git a/openedx/core/djangoapps/programs/rest_api/v1/urls.py b/openedx/core/djangoapps/programs/rest_api/v1/urls.py index f6ee9628cfb4..88c299a9acce 100644 --- a/openedx/core/djangoapps/programs/rest_api/v1/urls.py +++ b/openedx/core/djangoapps/programs/rest_api/v1/urls.py @@ -4,10 +4,7 @@ from django.urls import re_path -from openedx.core.djangoapps.programs.rest_api.v1.views import ( - ProgramProgressDetailView, - Programs, -) +from openedx.core.djangoapps.programs.rest_api.v1.views import ProgramProgressDetailView, Programs ENTERPRISE_UUID_PATTERN = r"[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?4[0-9a-fA-F]{3}-?[89abAB][0-9a-fA-F]{3}-?[0-9a-fA-F]{12}" PROGRAM_UUID_PATTERN = r"[0-9a-f-]+" diff --git a/openedx/core/djangoapps/programs/rest_api/v1/views.py b/openedx/core/djangoapps/programs/rest_api/v1/views.py index 77c5a171fd7f..005aa9e546cd 100644 --- a/openedx/core/djangoapps/programs/rest_api/v1/views.py +++ b/openedx/core/djangoapps/programs/rest_api/v1/views.py @@ -1,7 +1,7 @@ """Views for the Programs REST API v1.""" -from typing import Any, TYPE_CHECKING import logging +from typing import TYPE_CHECKING, Any from django.db.models.query import EmptyQuerySet from rest_framework.permissions import IsAuthenticated @@ -16,13 +16,14 @@ get_program_and_course_data, get_program_urls, ) -from openedx.features.enterprise_support.api import get_enterprise_course_enrollments, enterprise_is_enabled +from openedx.features.enterprise_support.api import enterprise_is_enabled, get_enterprise_course_enrollments if TYPE_CHECKING: - from django.http import HttpRequest, HttpResponse from django.contrib.auth.models import AnonymousUser, User # pylint: disable=imported-auth-user from django.contrib.sites.models import Site from django.db.models.query import QuerySet + from django.http import HttpRequest, HttpResponse + from common.djangoapps.student.models import CourseEnrollment logger = logging.getLogger(__name__) @@ -88,7 +89,7 @@ def get(self, request: "HttpRequest", enterprise_uuid: str = "") -> "HttpRespons } ] """ - user: "AnonymousUser | User" = request.user + user: "AnonymousUser | User" = request.user # noqa: UP037 if enterprise_uuid: enrollments = list(self._get_enterprise_course_enrollments(enterprise_uuid, user)) @@ -315,8 +316,8 @@ def get(self, request: "HttpRequest", program_uuid: str) -> "HttpResponse": ] } """ - user: "AnonymousUser | User" = request.user - site: "Site" = request.site + user: "AnonymousUser | User" = request.user # noqa: UP037 + site: "Site" = request.site # noqa: UP037 program_data, course_data = get_program_and_course_data(site, user, program_uuid) if not program_data: return Response(status=404, data={"error_code": "No program data available."}) diff --git a/openedx/core/djangoapps/programs/tasks.py b/openedx/core/djangoapps/programs/tasks.py index 2829cf20752e..43dce6f392a3 100644 --- a/openedx/core/djangoapps/programs/tasks.py +++ b/openedx/core/djangoapps/programs/tasks.py @@ -3,7 +3,7 @@ between the monolith and the Credentials IDA. """ -from typing import TYPE_CHECKING, Dict, List, Optional +from typing import TYPE_CHECKING, Dict, List, Optional # noqa: UP035 from urllib.parse import urljoin from celery import shared_task @@ -19,8 +19,8 @@ from requests.exceptions import HTTPError from common.djangoapps.course_modes.models import CourseMode -from lms.djangoapps.certificates.data import GeneratedCertificateData from lms.djangoapps.certificates.api import get_eligible_certificate +from lms.djangoapps.certificates.data import GeneratedCertificateData from openedx.core.djangoapps.content.course_overviews.api import get_course_overview_or_none from openedx.core.djangoapps.credentials.api import is_credentials_enabled from openedx.core.djangoapps.credentials.utils import ( @@ -50,7 +50,7 @@ DATE_FORMAT = "%Y-%m-%dT%H:%M:%SZ" -def get_completed_programs(site: Site, student: "UserType") -> Dict: +def get_completed_programs(site: Site, student: "UserType") -> Dict: # noqa: UP006 """ Given a set of completed courses, determine which programs are completed. @@ -85,7 +85,7 @@ def get_inverted_programs(student: "UserType"): return inverted_programs -def get_certified_programs(student: "UserType", raise_on_error: bool = False) -> List[str]: +def get_certified_programs(student: "UserType", raise_on_error: bool = False) -> List[str]: # noqa: UP006 """ Find the UUIDs of all the programs for which the student has already been awarded a certificate. @@ -110,7 +110,7 @@ def get_certified_programs(student: "UserType", raise_on_error: bool = False) -> return certified_programs -def get_revokable_program_uuids(course_specific_programs: List[Dict], student: "UserType") -> List[str]: +def get_revokable_program_uuids(course_specific_programs: List[Dict], student: "UserType") -> List[str]: # noqa: UP006 """ Get program uuids for which certificate to be revoked. @@ -198,7 +198,7 @@ def post_course_certificate( username: str, certificate: GeneratedCertificateData, date_override: Optional["datetime"] = None, - org: Optional[str] = None, + org: Optional[str] = None, # noqa: UP045 ): """ POST a certificate that has been updated to Credentials @@ -272,7 +272,7 @@ def post_course_certificate_configuration(client, cert_config, certificate_avail retry_jitter=True, ) @set_code_owner_attribute -def award_program_certificates(self, username): # lint-amnesty, pylint: disable=too-many-statements +def award_program_certificates(self, username): # pylint: disable=too-many-statements """ This task is designed to be called whenever a student's completion status changes with respect to one or more courses (primarily, when a course certificate is awarded). @@ -510,7 +510,7 @@ def award_course_certificate(self, username, course_run_key): LOGGER.info(f"Running task award_course_certificate for user {user.id}") try: course_key = CourseKey.from_string(course_run_key) - except InvalidKeyError as exc: + except InvalidKeyError as exc: # noqa: F841 error_msg = "Failed to determine course key" LOGGER.warning( f"Failed to award course certificate for user {user.id} for course {course_run_key}. Reason: {error_msg}" @@ -593,7 +593,7 @@ def award_course_certificate(self, username, course_run_key): retry_jitter=True, ) @set_code_owner_attribute -def revoke_program_certificates(self, username, course_key): # lint-amnesty, pylint: disable=too-many-statements +def revoke_program_certificates(self, username, course_key): # pylint: disable=too-many-statements """ This task is designed to be called whenever a student's course certificate is revoked. diff --git a/openedx/core/djangoapps/programs/tests/test_tasks.py b/openedx/core/djangoapps/programs/tests/test_tasks.py index 943c8c0dd444..881f9e657fa7 100644 --- a/openedx/core/djangoapps/programs/tests/test_tasks.py +++ b/openedx/core/djangoapps/programs/tests/test_tasks.py @@ -6,11 +6,11 @@ import logging from datetime import datetime, timedelta from unittest import mock +from zoneinfo import ZoneInfo import ddt import httpretty import pytest -from zoneinfo import ZoneInfo import requests from celery.exceptions import MaxRetriesExceededError from django.conf import settings @@ -461,7 +461,7 @@ class PostCourseCertificateTestCase(TestCase): Test the award_program_certificate function """ - def setUp(self): # lint-amnesty, pylint: disable=super-method-not-called + def setUp(self): # pylint: disable=super-method-not-called self.student = UserFactory.create(username="test-student") self.course = CourseOverviewFactory.create( self_paced=True # Any option to allow the certificate to be viewable for the course diff --git a/openedx/core/djangoapps/programs/tests/test_utils.py b/openedx/core/djangoapps/programs/tests/test_utils.py index 18058c827a52..cf81a40820cd 100644 --- a/openedx/core/djangoapps/programs/tests/test_utils.py +++ b/openedx/core/djangoapps/programs/tests/test_utils.py @@ -6,6 +6,7 @@ from collections import namedtuple from copy import deepcopy from unittest import mock +from zoneinfo import ZoneInfo import ddt import httpretty @@ -14,8 +15,7 @@ from django.test.utils import override_settings from django.urls import reverse from edx_toggles.toggles.testutils import override_waffle_switch -from opaque_keys.edx.keys import CourseKey # lint-amnesty, pylint: disable=wrong-import-order -from zoneinfo import ZoneInfo +from opaque_keys.edx.keys import CourseKey # pylint: disable=wrong-import-order from testfixtures import LogCapture from common.djangoapps.course_modes.models import CourseMode @@ -33,7 +33,7 @@ EntitlementFactory, ProgramFactory, SeatFactory, - generate_course_run_key + generate_course_run_key, ) from openedx.core.djangoapps.content.course_overviews.models import CourseOverview from openedx.core.djangoapps.programs import ALWAYS_CALCULATE_PROGRAM_PRICE_AS_ANONYMOUS_USER @@ -45,7 +45,7 @@ ProgramProgressMeter, get_certificates, get_logged_in_program_certificate_url, - is_user_enrolled_in_program_type + is_user_enrolled_in_program_type, ) from openedx.core.djangoapps.site_configuration.tests.factories import SiteFactory from openedx.core.djangolib.testing.utils import skip_unless_lms @@ -486,7 +486,7 @@ def test_shared_entitlement_engagement(self, mock_get_programs): programs = data[:3] assert meter.engaged_programs == programs - def test_simulate_progress(self, mock_get_programs): # lint-amnesty, pylint: disable=too-many-statements + def test_simulate_progress(self, mock_get_programs): # pylint: disable=too-many-statements """Simulate the entirety of a user's progress through a program.""" today = datetime.datetime.now(ZoneInfo("UTC")) two_days_ago = today - datetime.timedelta(days=2) @@ -744,7 +744,7 @@ def available_date_fake(_course, cert): meter = ProgramProgressMeter(self.site, self.user) available_dates = meter.completed_programs_with_available_dates - self.assertDictEqual(available_dates, { + self.assertDictEqual(available_dates, { # noqa: PT009 program_complete['uuid']: datetime.datetime(2017, 1, 1) }) @@ -773,7 +773,7 @@ def test_completed_course_runs(self, mock_get_programs): self._create_certificates(unknown['key'], status='unknown') meter = ProgramProgressMeter(self.site, self.user) - self.assertCountEqual( + self.assertCountEqual( # noqa: PT009 meter.completed_course_runs, [ {'course_run_id': str(downloadable['key']), 'type': CourseMode.VERIFIED}, @@ -821,7 +821,7 @@ def test_credit_course_counted_complete_for_verified(self, mock_completed_course self._create_enrollments(course_run_key) meter = ProgramProgressMeter(self.site, self.user) mock_completed_course_runs.return_value = [{'course_run_id': course_run_key, 'type': CourseMode.VERIFIED}] - assert meter._is_course_complete(course) is True # lint-amnesty, pylint: disable=protected-access + assert meter._is_course_complete(course) is True # pylint: disable=protected-access def test_detail_url_for_mobile_only(self, mock_get_programs): """ @@ -1158,11 +1158,11 @@ def test_multiple_published_course_runs(self): - program has a course with more than one published course run """ course_run_1 = CourseRunFactory( - key=str(ModuleStoreCourseFactory().id), # lint-amnesty, pylint: disable=no-member + key=str(ModuleStoreCourseFactory().id), # pylint: disable=no-member status='published' ) course_run_2 = CourseRunFactory( - key=str(ModuleStoreCourseFactory().id), # lint-amnesty, pylint: disable=no-member + key=str(ModuleStoreCourseFactory().id), # pylint: disable=no-member status='published' ) course = CourseFactory(course_runs=[course_run_1, course_run_2], entitlements=[]) @@ -1170,14 +1170,14 @@ def test_multiple_published_course_runs(self): courses=[ CourseFactory(course_runs=[ CourseRunFactory( - key=str(ModuleStoreCourseFactory().id), # lint-amnesty, pylint: disable=no-member + key=str(ModuleStoreCourseFactory().id), # pylint: disable=no-member status='published' ) ]), course, CourseFactory(course_runs=[ CourseRunFactory( - key=str(ModuleStoreCourseFactory().id), # lint-amnesty, pylint: disable=no-member + key=str(ModuleStoreCourseFactory().id), # pylint: disable=no-member status='published' ) ]) @@ -1380,7 +1380,7 @@ def setUp(self): # Give all course runs a certificate URL, but only expect one to come # back. This verifies the break in the function under test that ensures # only one certificate per course comes back. - for index, course_run in enumerate(course['course_runs']): # lint-amnesty, pylint: disable=unused-variable + for index, course_run in enumerate(course['course_runs']): # pylint: disable=unused-variable # noqa: B007 course_run['certificate_url'] = self.course_certificate_url course_run['may_certify'] = True @@ -1423,7 +1423,7 @@ def test_course_run_certificates_missing(self, mock_get_credentials): """ # make the first course have no certification, the second have no url... for course_index, course in enumerate(self.program['courses']): - for index, course_run in enumerate(course['course_runs']): # lint-amnesty, pylint: disable=unused-variable + for index, course_run in enumerate(course['course_runs']): # pylint: disable=unused-variable # noqa: B007 if course_index == 0: course_run['may_certify'] = False elif course_index == 1: @@ -1508,7 +1508,7 @@ def _prepare_program_for_discounted_price_calculation_endpoint(self): Returns: seat: seat for which the discount is applicable """ - self.ecommerce_service = EcommerceService() # lint-amnesty, pylint: disable=attribute-defined-outside-init + self.ecommerce_service = EcommerceService() # pylint: disable=attribute-defined-outside-init seat = self.program['courses'][0]['course_runs'][0]['seats'][0] self.program['applicable_seat_types'] = [seat['type']] return seat @@ -1529,7 +1529,7 @@ def _update_discount_data(self, mock_discount_data): def test_instructors(self): data = ProgramMarketingDataExtender(self.program, self.user).extend() - self.program.update(self.instructors['instructors']) # lint-amnesty, pylint: disable=no-member + self.program.update(self.instructors['instructors']) # pylint: disable=no-member assert data == self.program def test_course_pricing(self): @@ -1590,7 +1590,7 @@ def test_fetching_program_discounted_price(self): data = ProgramMarketingDataExtender(self.program, self.user).extend() self._update_discount_data(mock_discount_data) - assert httpretty.last_request().querystring.get('username')[0] == self.user.username # lint-amnesty, pylint: disable=no-member, line-too-long + assert httpretty.last_request().querystring.get('username')[0] == self.user.username # pylint: disable=no-member, line-too-long assert data['skus'] == [course['course_runs'][0]['seats'][0]['sku'] for course in self.program['courses']] assert data['discount_data'] == mock_discount_data @@ -1614,7 +1614,7 @@ def test_fetching_program_price_when_forced_as_anonymous_user(self): content_type='application/json' ) ProgramMarketingDataExtender(self.program, self.user).extend() - assert httpretty.last_request().querystring.get('is_anonymous')[0] == 'True' # lint-amnesty, pylint: disable=no-member, line-too-long + assert httpretty.last_request().querystring.get('is_anonymous')[0] == 'True' # pylint: disable=no-member, line-too-long @httpretty.activate def test_fetching_program_discounted_price_as_anonymous_user(self): @@ -1639,7 +1639,7 @@ def test_fetching_program_discounted_price_as_anonymous_user(self): data = ProgramMarketingDataExtender(self.program, user).extend() self._update_discount_data(mock_discount_data) - assert httpretty.last_request().querystring.get('is_anonymous', None) is not None # lint-amnesty, pylint: disable=no-member, line-too-long + assert httpretty.last_request().querystring.get('is_anonymous', None) is not None # pylint: disable=no-member, line-too-long assert data['skus'] == [course['course_runs'][0]['seats'][0]['sku'] for course in self.program['courses']] assert data['discount_data'] == mock_discount_data @@ -1737,14 +1737,14 @@ def test_user_enrolled_in_paid_only_with_no_matching_paid_course_modes(self, moc mock_get_programs_by_type.return_value = [self.program, second_program] # While most of a programs courses would likely come with a paid mode, if the course in question is now expired, - # then get_paid_modes_for_course would return an empty list. Even with no paid modes, if we request paid modes only # lint-amnesty, pylint: disable=line-too-long + # then get_paid_modes_for_course would return an empty list. Even with no paid modes, if we request paid modes only # pylint: disable=line-too-long # we should return False mock_get_paid_modes_for_course.return_value = [] # raise Exception((mock_get_programs_by_type, mock_get_paid_modes_for_course)) assert not is_user_enrolled_in_program_type(user=self.user, program_type_slug=self.MICROBACHELORS, paid_modes_only=True) # We should continue to return false even if they do contain paid modes - Mode = namedtuple('Mode', ['slug']) # lint-amnesty, pylint: disable=unused-variable + Mode = namedtuple('Mode', ['slug']) # pylint: disable=unused-variable # noqa: F841 # mock_get_paid_modes_for_course.return_value = [Mode(CourseMode.VERIFIED)] assert not is_user_enrolled_in_program_type(user=self.user, program_type_slug=self.MICROBACHELORS, paid_modes_only=True) diff --git a/openedx/core/djangoapps/programs/utils.py b/openedx/core/djangoapps/programs/utils.py index b385d8284c36..9b080ef475a4 100644 --- a/openedx/core/djangoapps/programs/utils.py +++ b/openedx/core/djangoapps/programs/utils.py @@ -6,6 +6,7 @@ from copy import deepcopy from itertools import chain from urllib.parse import urljoin, urlparse, urlunparse +from zoneinfo import ZoneInfo from dateutil.parser import parse from django.conf import settings @@ -14,7 +15,6 @@ from django.urls import reverse from django.utils.functional import cached_property from opaque_keys.edx.keys import CourseKey -from zoneinfo import ZoneInfo from requests.exceptions import RequestException from common.djangoapps.course_modes.api import get_paid_modes_for_course @@ -690,7 +690,7 @@ def _filter_out_courses_with_enrollments(self, courses): return courses_without_enrollments - def _collect_one_click_purchase_eligibility_data(self): # lint-amnesty, pylint: disable=too-many-statements + def _collect_one_click_purchase_eligibility_data(self): # pylint: disable=too-many-statements """ Extend the program data with data about learner's eligibility for one click purchase, discount data of the program and SKUs of seats that should be added to basket. @@ -705,7 +705,7 @@ def _collect_one_click_purchase_eligibility_data(self): # lint-amnesty, pylint: course_keys = [] bundle_variant = "full" - if is_learner_eligible_for_one_click_purchase: # lint-amnesty, pylint: disable=too-many-nested-blocks + if is_learner_eligible_for_one_click_purchase: # pylint: disable=too-many-nested-blocks courses = self.data["courses"] if not self.user.is_anonymous: courses = self._filter_out_courses_with_enrollments(courses) @@ -923,7 +923,7 @@ def _attach_course_run_certificate_url(self, run_mode): pages. The certificate URL is not needed when rendering the program marketing page. """ - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass def _attach_course_run_upgrade_url(self, run_mode): if not self.user.is_anonymous: @@ -962,7 +962,7 @@ def _collect_instructors(self, course_run): def is_user_enrolled_in_program_type( user, program_type_slug, paid_modes_only=False, enrollments=None, entitlements=None -): # lint-amnesty, pylint: disable=line-too-long +): # pylint: disable=line-too-long """ This method will look at the learners Enrollments and Entitlements to determine if a learner is enrolled in a Program of the given type. diff --git a/openedx/core/djangoapps/safe_sessions/middleware.py b/openedx/core/djangoapps/safe_sessions/middleware.py index 60de38284a6d..0aeaf86b7a4c 100644 --- a/openedx/core/djangoapps/safe_sessions/middleware.py +++ b/openedx/core/djangoapps/safe_sessions/middleware.py @@ -241,12 +241,12 @@ def parse(cls, safe_cookie_string): raw_cookie_components = str(safe_cookie_string).split(cls.SEPARATOR) safe_cookie_data = SafeCookieData(*raw_cookie_components) except TypeError: - raise SafeCookieError( # lint-amnesty, pylint: disable=raise-missing-from + raise SafeCookieError( # pylint: disable=raise-missing-from # noqa: B904 f"SafeCookieData BWC parse error: {safe_cookie_string!r}." ) if safe_cookie_data.version != cls.CURRENT_VERSION: raise SafeCookieError( - "SafeCookieData version {!r} is not supported. Current version is {}.".format( + "SafeCookieData version {!r} is not supported. Current version is {}.".format( # noqa: UP032 safe_cookie_data.version, cls.CURRENT_VERSION, )) @@ -281,7 +281,7 @@ def verify(self, user_id): log.error("SafeCookieData '%r' is not bound to user '%s'.", str(self), user_id) except signing.BadSignature as sig_error: log.error( - "SafeCookieData signature error for cookie data {!r}: {}".format( # pylint: disable=logging-format-interpolation + "SafeCookieData signature error for cookie data {!r}: {}".format( # pylint: disable=logging-format-interpolation # noqa: UP032 str(self), str(sig_error), ) @@ -311,7 +311,7 @@ def _validate_cookie_params(session_id, user_id): if not session_id or session_id == str(None): # The session ID should always be valid in the cookie. raise SafeCookieError( - "SafeCookieData not created due to invalid value for session_id '{}' for user_id '{}'.".format( + "SafeCookieData not created due to invalid value for session_id '{}' for user_id '{}'.".format( # noqa: UP032 # pylint: disable=line-too-long session_id, user_id, )) @@ -391,7 +391,7 @@ def process_request(self, request): # Save off for debugging and logging in _verify_user_and_log_mismatch request.cookie_session_field = safe_cookie_data.session_id - process_request_response = super().process_request(request) # Step 3 # lint-amnesty, pylint: disable=assignment-from-no-return, super-with-arguments + process_request_response = super().process_request(request) # Step 3 # pylint: disable=assignment-from-no-return, super-with-arguments if process_request_response: # The process_request pipeline has been short circuited so # return the response. @@ -539,7 +539,7 @@ def _verify_user_and_log_mismatch(request, response, userid_in_session): ) set_custom_attribute('safe_sessions.headers_logged', True) - except BaseException as e: + except BaseException as e: # noqa: F841 log.exception("SafeCookieData error while logging request headers.") return True @@ -607,7 +607,7 @@ def _verify_user_and_log_mismatch(request, response, userid_in_session): f'Safe session request headers: {SafeSessionMiddleware._get_encrypted_request_headers(request)}' ) - except BaseException as e: + except BaseException as e: # noqa: F841 log.exception("SafeCookieData error while computing additional logs.") if request_user_object_mismatch and not session_user_mismatch: @@ -853,7 +853,7 @@ def _set_session_email_match_custom_attributes(are_emails_mismatched): set_custom_attribute('is_enforce_session_email_match_enabled', settings.ENFORCE_SESSION_EMAIL_MATCH) -def obscure_token(value: Union[str, None]) -> Union[str, None]: +def obscure_token(value: Union[str, None]) -> Union[str, None]: # noqa: UP007 """ Return a short string that can be used to detect other occurrences of this string without revealing the original. Return None if value @@ -947,7 +947,7 @@ def __setattr__(self, name, value): if name == 'user': stack = inspect.stack() # Written this way in case you need more of the stack for debugging. - location = "\n".join("%30s : %s:%d" % (t[3], t[1], t[2]) for t in stack[0:12]) + location = "\n".join("%30s : %s:%d" % (t[3], t[1], t[2]) for t in stack[0:12]) # noqa: UP031 if not hasattr(self, 'debug_user_changes'): # list of string debugging info for each user change (e.g. user id, stack trace, etc.) diff --git a/openedx/core/djangoapps/safe_sessions/testing.py b/openedx/core/djangoapps/safe_sessions/testing.py index 1c56c9f07f3c..98a0bf0f6b0a 100644 --- a/openedx/core/djangoapps/safe_sessions/testing.py +++ b/openedx/core/djangoapps/safe_sessions/testing.py @@ -37,6 +37,7 @@ def login_with_safe_session(self, **credentials): """ from django.conf import settings from django.contrib.auth import SESSION_KEY + from .middleware import SafeSessionMiddleware if not patched_client_login(self, **credentials): @@ -58,9 +59,11 @@ def get_safe_session(self): access the session_id before it's actually converted, we use a try-except clause here to check both cases. """ + from importlib import import_module + from django.apps import apps from django.conf import settings - from importlib import import_module + from .middleware import SafeCookieData, SafeCookieError, SafeSessionMiddleware if apps.is_installed('django.contrib.sessions'): diff --git a/openedx/core/djangoapps/safe_sessions/tests/test_middleware.py b/openedx/core/djangoapps/safe_sessions/tests/test_middleware.py index ad5629fab167..4a9432af0d28 100644 --- a/openedx/core/djangoapps/safe_sessions/tests/test_middleware.py +++ b/openedx/core/djangoapps/safe_sessions/tests/test_middleware.py @@ -2,13 +2,13 @@ Unit tests for SafeSessionMiddleware """ import uuid -from unittest.mock import call, patch, MagicMock +from unittest.mock import MagicMock, call, patch import ddt from crum import set_current_request from django.conf import settings from django.contrib.auth import SESSION_KEY -from django.contrib.auth.models import AnonymousUser, User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import AnonymousUser, User # pylint: disable=imported-auth-user from django.http import HttpResponse, HttpResponseRedirect, SimpleCookie from django.test import TestCase from django.test.utils import override_settings @@ -17,10 +17,10 @@ from edx_rest_framework_extensions.auth.jwt import cookies as jwt_cookies from common.djangoapps.student.models import PendingEmailChange -from openedx.core.djangolib.testing.utils import get_mock_request, CacheIsolationTestCase, skip_unless_lms -from openedx.core.djangoapps.user_authn.tests.utils import setup_login_oauth_client -from openedx.core.djangoapps.user_authn.cookies import ALL_LOGGED_IN_COOKIE_NAMES from common.djangoapps.student.tests.factories import UserFactory +from openedx.core.djangoapps.user_authn.cookies import ALL_LOGGED_IN_COOKIE_NAMES +from openedx.core.djangoapps.user_authn.tests.utils import setup_login_oauth_client +from openedx.core.djangolib.testing.utils import CacheIsolationTestCase, get_mock_request, skip_unless_lms from ..middleware import ( EmailChangeMiddleware, @@ -28,7 +28,7 @@ SafeSessionMiddleware, mark_user_change_as_expected, obscure_token, - track_request_user_changes + track_request_user_changes, ) from .test_utils import TestSafeSessionsLogMixin @@ -702,9 +702,9 @@ def test_process_request_emails_match_with_toggle_enabled( EmailChangeMiddleware.register_email_change(request=self.request, email=self.user.email) # Ensure email is set in the session - self.assertEqual(self.request.session.get('email'), self.user.email) + self.assertEqual(self.request.session.get('email'), self.user.email) # noqa: PT009 # Ensure session cookie exist - self.assertEqual(len(self.client.response.cookies), 1) + self.assertEqual(len(self.client.response.cookies), 1) # noqa: PT009 # No email change occurred in any browser @@ -717,9 +717,9 @@ def test_process_request_emails_match_with_toggle_enabled( mock_set_custom_attribute.assert_has_calls([call('is_enforce_session_email_match_enabled', True)]) # Assert that the session and cookies are not affected - self.assertEqual(self.request.session.get('email'), self.user.email) - self.assertEqual(len(self.client.response.cookies), 1) - self.assertEqual(self.client.response.cookies[settings.SESSION_COOKIE_NAME].value, 'authenticated') + self.assertEqual(self.request.session.get('email'), self.user.email) # noqa: PT009 + self.assertEqual(len(self.client.response.cookies), 1) # noqa: PT009 + self.assertEqual(self.client.response.cookies[settings.SESSION_COOKIE_NAME].value, 'authenticated') # noqa: PT009 # pylint: disable=line-too-long # Assert that _mark_cookie_for_deletion not called mock_mark_cookie_for_deletion.assert_not_called() @@ -745,9 +745,9 @@ def test_process_request_emails_match_with_toggle_disabled( EmailChangeMiddleware.register_email_change(request=self.request, email=self.user.email) # Ensure email is set in the session - self.assertEqual(self.request.session.get('email'), self.user.email) + self.assertEqual(self.request.session.get('email'), self.user.email) # noqa: PT009 # Ensure session cookie exist - self.assertEqual(len(self.client.response.cookies), 1) + self.assertEqual(len(self.client.response.cookies), 1) # noqa: PT009 # No email change occurred in any browser @@ -760,9 +760,9 @@ def test_process_request_emails_match_with_toggle_disabled( mock_set_custom_attribute.assert_has_calls([call('is_enforce_session_email_match_enabled', False)]) # Assert that the session and cookies are not affected - self.assertEqual(self.request.session.get('email'), self.user.email) - self.assertEqual(len(self.client.response.cookies), 1) - self.assertEqual(self.client.response.cookies[settings.SESSION_COOKIE_NAME].value, 'authenticated') + self.assertEqual(self.request.session.get('email'), self.user.email) # noqa: PT009 + self.assertEqual(len(self.client.response.cookies), 1) # noqa: PT009 + self.assertEqual(self.client.response.cookies[settings.SESSION_COOKIE_NAME].value, 'authenticated') # noqa: PT009 # pylint: disable=line-too-long # Assert that _mark_cookie_for_deletion not called mock_mark_cookie_for_deletion.assert_not_called() @@ -789,9 +789,9 @@ def test_process_request_emails_mismatch_with_toggle_enabled( EmailChangeMiddleware.register_email_change(request=self.request, email=self.user.email) # Ensure email is set in the session - self.assertEqual(self.request.session.get('email'), self.user.email) + self.assertEqual(self.request.session.get('email'), self.user.email) # noqa: PT009 # Ensure session cookie exist - self.assertEqual(len(self.client.response.cookies), 1) + self.assertEqual(len(self.client.response.cookies), 1) # noqa: PT009 # simulating email changed in some other browser self.user.email = 'new_email@test.com' @@ -832,9 +832,9 @@ def test_process_request_emails_mismatch_with_toggle_disabled( EmailChangeMiddleware.register_email_change(request=self.request, email=self.user.email) # Ensure email is set in the session - self.assertEqual(self.request.session.get('email'), self.user.email) + self.assertEqual(self.request.session.get('email'), self.user.email) # noqa: PT009 # Ensure session cookie exist - self.assertEqual(len(self.client.response.cookies), 1) + self.assertEqual(len(self.client.response.cookies), 1) # noqa: PT009 # simulating email changed in some other browser self.user.email = 'new_email@test.com' @@ -849,9 +849,9 @@ def test_process_request_emails_mismatch_with_toggle_disabled( mock_set_custom_attribute.assert_has_calls([call('is_enforce_session_email_match_enabled', False)]) # Assert that the session and cookies are not affected - self.assertNotEqual(self.request.session.get('email'), self.user.email) - self.assertEqual(len(self.client.response.cookies), 1) - self.assertEqual(self.client.response.cookies[settings.SESSION_COOKIE_NAME].value, 'authenticated') + self.assertNotEqual(self.request.session.get('email'), self.user.email) # noqa: PT009 + self.assertEqual(len(self.client.response.cookies), 1) # noqa: PT009 + self.assertEqual(self.client.response.cookies[settings.SESSION_COOKIE_NAME].value, 'authenticated') # noqa: PT009 # pylint: disable=line-too-long # Assert that _mark_cookie_for_deletion not called mock_mark_cookie_for_deletion.assert_not_called() @@ -873,10 +873,10 @@ def test_process_request_no_email_change_history_with_toggle_enabled( self.client.response.set_cookie(settings.SESSION_COOKIE_NAME, 'authenticated') # Add some logged-in cookie # Ensure there is no email in the session denoting no previous history of email change - self.assertEqual(self.request.session.get('email'), None) + self.assertEqual(self.request.session.get('email'), None) # noqa: PT009 # Ensure session cookie exist - self.assertEqual(len(self.client.response.cookies), 1) + self.assertEqual(len(self.client.response.cookies), 1) # noqa: PT009 # simulating email changed in some other browser self.user.email = 'new_email@test.com' @@ -886,8 +886,8 @@ def test_process_request_no_email_change_history_with_toggle_enabled( EmailChangeMiddleware(get_response=lambda request: None).process_request(self.request) # Assert that the session and cookies are not affected - self.assertEqual(len(self.client.response.cookies), 1) - self.assertEqual(self.client.response.cookies[settings.SESSION_COOKIE_NAME].value, 'authenticated') + self.assertEqual(len(self.client.response.cookies), 1) # noqa: PT009 + self.assertEqual(self.client.response.cookies[settings.SESSION_COOKIE_NAME].value, 'authenticated') # noqa: PT009 # pylint: disable=line-too-long # Assert that _mark_cookie_for_deletion not called mock_mark_cookie_for_deletion.assert_not_called() @@ -909,10 +909,10 @@ def test_process_request_no_email_change_history_with_toggle_disabled( self.client.response.set_cookie(settings.SESSION_COOKIE_NAME, 'authenticated') # Add some logged-in cookie # Ensure there is no email in the session denoting no previous history of email change - self.assertEqual(self.request.session.get('email'), None) + self.assertEqual(self.request.session.get('email'), None) # noqa: PT009 # Ensure session cookie exist - self.assertEqual(len(self.client.response.cookies), 1) + self.assertEqual(len(self.client.response.cookies), 1) # noqa: PT009 # simulating email changed in some other browser self.user.email = 'new_email@test.com' @@ -922,8 +922,8 @@ def test_process_request_no_email_change_history_with_toggle_disabled( EmailChangeMiddleware(get_response=lambda request: None).process_request(self.request) # Assert that the session and cookies are not affected - self.assertEqual(len(self.client.response.cookies), 1) - self.assertEqual(self.client.response.cookies[settings.SESSION_COOKIE_NAME].value, 'authenticated') + self.assertEqual(len(self.client.response.cookies), 1) # noqa: PT009 + self.assertEqual(self.client.response.cookies[settings.SESSION_COOKIE_NAME].value, 'authenticated') # noqa: PT009 # pylint: disable=line-too-long # Assert that _mark_cookie_for_deletion not called mock_mark_cookie_for_deletion.assert_not_called() @@ -1018,7 +1018,7 @@ def test_process_response_no_email_in_session(self): self.client.response.set_cookie(settings.SESSION_COOKIE_NAME, 'authenticated') # Add some logged-in cookie # Ensure there is no email in the session - self.assertEqual(self.request.session.get('email'), None) + self.assertEqual(self.request.session.get('email'), None) # noqa: PT009 # Call process_response response = EmailChangeMiddleware(get_response=lambda request: None).process_response( @@ -1027,7 +1027,7 @@ def test_process_response_no_email_in_session(self): assert response.status_code == 200 # Verify that email is set in the session - self.assertEqual(self.request.session.get('email'), self.user.email) + self.assertEqual(self.request.session.get('email'), self.user.email) # noqa: PT009 @patch.dict("django.conf.settings.FEATURES", {"DISABLE_SET_JWT_COOKIES_FOR_TESTS": False}) def test_user_remain_authenticated_on_email_change_in_other_browser_with_toggle_disabled(self): @@ -1105,11 +1105,11 @@ def test_cookies_are_updated_with_new_email_on_email_change_with_toggle_enabled( # Verify that jwt cookies are updated with new email and # not equal to old logged-in cookies in current browser - self.assertNotEqual( + self.assertNotEqual( # noqa: PT009 login_response.cookies[jwt_cookies.jwt_cookie_header_payload_name()].value, email_change_response.cookies[jwt_cookies.jwt_cookie_header_payload_name()].value ) - self.assertNotEqual( + self.assertNotEqual( # noqa: PT009 login_response.cookies[jwt_cookies.jwt_cookie_signature_name()].value, email_change_response.cookies[jwt_cookies.jwt_cookie_signature_name()].value ) @@ -1158,11 +1158,11 @@ def test_cookies_are_updated_with_new_email_on_email_change_with_toggle_disabled # Verify that jwt cookies are updated with new email and # not equal to old logged-in cookies in current browser - self.assertNotEqual( + self.assertNotEqual( # noqa: PT009 login_response.cookies[jwt_cookies.jwt_cookie_header_payload_name()].value, email_change_response.cookies[jwt_cookies.jwt_cookie_header_payload_name()].value ) - self.assertNotEqual( + self.assertNotEqual( # noqa: PT009 login_response.cookies[jwt_cookies.jwt_cookie_signature_name()].value, email_change_response.cookies[jwt_cookies.jwt_cookie_signature_name()].value ) @@ -1348,10 +1348,10 @@ def _assert_logged_in_cookies_present(self, response): for cookie in all_cookies: # Check if the cookie is present in response.cookies.keys() - self.assertIn(cookie, response.cookies.keys()) + self.assertIn(cookie, response.cookies.keys()) # noqa: PT009 # Assert that the value is not an empty string - self.assertNotEqual(response.cookies[cookie].value, "") + self.assertNotEqual(response.cookies[cookie].value, "") # noqa: PT009 def _assert_logged_in_cookies_not_present(self, response): """ @@ -1362,7 +1362,7 @@ def _assert_logged_in_cookies_not_present(self, response): for cookie in all_cookies: # Check if the cookie is present in response.cookies.keys() - self.assertIn(cookie, response.cookies.keys()) + self.assertIn(cookie, response.cookies.keys()) # noqa: PT009 # Assert that the value is not an empty string - self.assertEqual(response.cookies[cookie].value, "") + self.assertEqual(response.cookies[cookie].value, "") # noqa: PT009 diff --git a/openedx/core/djangoapps/safe_sessions/tests/test_safe_cookie_data.py b/openedx/core/djangoapps/safe_sessions/tests/test_safe_cookie_data.py index 650a8d157baf..0cbd9e9d024b 100644 --- a/openedx/core/djangoapps/safe_sessions/tests/test_safe_cookie_data.py +++ b/openedx/core/djangoapps/safe_sessions/tests/test_safe_cookie_data.py @@ -8,9 +8,9 @@ from time import time from unittest.mock import patch -import pytest import ddt import django +import pytest from django.test import TestCase from ..middleware import SafeCookieData, SafeCookieError @@ -34,7 +34,7 @@ def assert_cookie_data_equal(self, cookie_data1, cookie_data2): Asserts equivalency of the given cookie datas by comparing their member variables. """ - self.assertDictEqual(cookie_data1.__dict__, cookie_data2.__dict__) + self.assertDictEqual(cookie_data1.__dict__, cookie_data2.__dict__) # noqa: PT009 #---- Test Success ----# diff --git a/openedx/core/djangoapps/safe_sessions/tests/test_utils.py b/openedx/core/djangoapps/safe_sessions/tests/test_utils.py index 9fc32555cb83..45bf98d633ad 100644 --- a/openedx/core/djangoapps/safe_sessions/tests/test_utils.py +++ b/openedx/core/djangoapps/safe_sessions/tests/test_utils.py @@ -1,9 +1,10 @@ """ Shared test utilities for Safe Sessions tests """ +from contextlib import contextmanager # pylint: disable=wrong-import-order +from unittest.mock import patch # pylint: disable=wrong-import-order + import pytest -from contextlib import contextmanager # lint-amnesty, pylint: disable=wrong-import-order -from unittest.mock import patch # lint-amnesty, pylint: disable=wrong-import-order class TestSafeSessionsLogMixin: @@ -20,7 +21,7 @@ def assert_logged(self, log_string, log_level='error'): with patch('openedx.core.djangoapps.safe_sessions.middleware.log.' + log_level) as mock_log: yield assert mock_log.called - self.assertRegex(mock_log.call_args_list[0][0][0], log_string) + self.assertRegex(mock_log.call_args_list[0][0][0], log_string) # noqa: PT009 @contextmanager def assert_regex_not_logged(self, log_string, log_level): @@ -134,7 +135,7 @@ def assert_logged_for_request_user_mismatch(self, user_at_request, user_at_respo """ session_suffix = 'Session changed.' if session_changed else 'Session did not change.' with self.assert_logged_with_message( - ( + ( # noqa: UP032 "SafeCookieData user at initial request '{}' does not match user at response time: '{}' " "for request path '{}'.\n{}" ).format( @@ -153,7 +154,7 @@ def assert_logged_for_session_user_mismatch(self, user_at_request, user_in_sessi session_suffix = 'Session changed.' if session_changed else 'Session did not change.' with self.assert_logged_with_message( - ( + ( # noqa: UP032 "SafeCookieData user at initial request '{}' does not match user in session: '{}' " "for request path '{}'.\n{}" ).format( @@ -173,7 +174,7 @@ def assert_logged_for_both_mismatch(self, user_at_request, user_in_session, user session_suffix = 'Session changed.' if session_changed else 'Session did not change.' with self.assert_logged_with_message( - ( + ( # noqa: UP032 "SafeCookieData user at initial request '{}' matches neither user in session: '{}' " "nor user at response time: '{}' for request path '{}'.\n{}" ).format( diff --git a/openedx/core/djangoapps/schedules/admin.py b/openedx/core/djangoapps/schedules/admin.py index 4f5a9cad7b83..2a19d5b29e13 100644 --- a/openedx/core/djangoapps/schedules/admin.py +++ b/openedx/core/djangoapps/schedules/admin.py @@ -1,4 +1,4 @@ -# lint-amnesty, pylint: disable=missing-module-docstring +# pylint: disable=missing-module-docstring import functools @@ -19,7 +19,7 @@ class ScheduleExperienceAdminInline(admin.StackedInline): model = models.ScheduleExperience -def _set_experience(db_name, human_name, modeladmin, request, queryset): # lint-amnesty, pylint: disable=redefined-outer-name +def _set_experience(db_name, human_name, modeladmin, request, queryset): # pylint: disable=redefined-outer-name """ A django action which will set all selected schedules to the supplied experience. The intended usage is with functools.partial to generate the action for each experience type @@ -39,7 +39,7 @@ def _set_experience(db_name, human_name, modeladmin, request, queryset): # lint ) modeladmin.message_user( request, - "{} schedule(s) were changed to use the {} experience".format( + "{} schedule(s) were changed to use the {} experience".format( # noqa: UP032 rows_updated, human_name, ) @@ -120,7 +120,7 @@ def choices(self, changelist): @admin.register(models.Schedule) -class ScheduleAdmin(admin.ModelAdmin): # lint-amnesty, pylint: disable=missing-class-docstring +class ScheduleAdmin(admin.ModelAdmin): # pylint: disable=missing-class-docstring list_display = ('username', 'course_id', 'start_date', 'upgrade_deadline', 'experience_display') list_display_links = ('start_date', 'upgrade_deadline', 'experience_display') list_filter = ( @@ -164,12 +164,12 @@ def get_queryset(self, request): return qs -class ScheduleConfigAdminForm(forms.ModelForm): # lint-amnesty, pylint: disable=missing-class-docstring +class ScheduleConfigAdminForm(forms.ModelForm): # pylint: disable=missing-class-docstring pass @admin.register(models.ScheduleConfig) -class ScheduleConfigAdmin(admin.ModelAdmin): # lint-amnesty, pylint: disable=missing-class-docstring +class ScheduleConfigAdmin(admin.ModelAdmin): # pylint: disable=missing-class-docstring search_fields = ('site',) list_display = ( 'site', diff --git a/openedx/core/djangoapps/schedules/apps.py b/openedx/core/djangoapps/schedules/apps.py index 69216097b06f..9dd3f98ce95c 100644 --- a/openedx/core/djangoapps/schedules/apps.py +++ b/openedx/core/djangoapps/schedules/apps.py @@ -1,16 +1,19 @@ -# lint-amnesty, pylint: disable=missing-module-docstring +# pylint: disable=missing-module-docstring from django.apps import AppConfig from django.utils.translation import gettext_lazy as _ -from edx_django_utils.plugins import PluginSignals # lint-amnesty, pylint: disable=unused-import +from edx_django_utils.plugins import PluginSignals # pylint: disable=unused-import # noqa: F401 -from openedx.core.djangoapps.plugins.constants import ProjectType # lint-amnesty, pylint: disable=unused-import +# pylint: disable-next=unused-import +from openedx.core.djangoapps.plugins.constants import ( + ProjectType, # noqa: F401 +) -class SchedulesConfig(AppConfig): # lint-amnesty, pylint: disable=missing-class-docstring +class SchedulesConfig(AppConfig): # pylint: disable=missing-class-docstring name = 'openedx.core.djangoapps.schedules' verbose_name = _('Schedules') def ready(self): # noinspection PyUnresolvedReferences - from . import signals, tasks # lint-amnesty, pylint: disable=unused-import, unused-variable + from . import signals, tasks # pylint: disable=unused-import, unused-variable # noqa: F401 diff --git a/openedx/core/djangoapps/schedules/config.py b/openedx/core/djangoapps/schedules/config.py index 802559ebcf46..2f5bf53e3263 100644 --- a/openedx/core/djangoapps/schedules/config.py +++ b/openedx/core/djangoapps/schedules/config.py @@ -18,7 +18,7 @@ # .. toggle_creation_date: 2017-09-17 DEBUG_MESSAGE_WAFFLE_FLAG = WaffleFlag(f'{WAFFLE_NAMESPACE}.enable_debugging', __name__) -COURSE_UPDATE_SHOW_UNSUBSCRIBE_WAFFLE_SWITCH = WaffleSwitch( # lint-amnesty, pylint: disable=toggle-missing-annotation +COURSE_UPDATE_SHOW_UNSUBSCRIBE_WAFFLE_SWITCH = WaffleSwitch( # pylint: disable=toggle-missing-annotation f'{WAFFLE_NAMESPACE}.course_update_show_unsubscribe', __name__ ) @@ -28,7 +28,7 @@ # methods below. We save this flag decision at enrollment time and don't change it even if the flag changes. So you # can't just directly look at flag result. _EXTERNAL_COURSE_UPDATES_EXPERIMENT_ID = 18 -_EXTERNAL_COURSE_UPDATES_FLAG = ExperimentWaffleFlag( # lint-amnesty, pylint: disable=toggle-missing-annotation +_EXTERNAL_COURSE_UPDATES_FLAG = ExperimentWaffleFlag( # pylint: disable=toggle-missing-annotation f'{WAFFLE_NAMESPACE}.external_updates', __name__, experiment_id=_EXTERNAL_COURSE_UPDATES_EXPERIMENT_ID, use_course_aware_bucketing=False diff --git a/openedx/core/djangoapps/schedules/content_highlights.py b/openedx/core/djangoapps/schedules/content_highlights.py index d0104bd23e04..a2c04b7e637a 100644 --- a/openedx/core/djangoapps/schedules/content_highlights.py +++ b/openedx/core/djangoapps/schedules/content_highlights.py @@ -9,7 +9,7 @@ from openedx.core.djangoapps.course_date_signals.utils import spaced_out_sections from openedx.core.djangoapps.schedules.exceptions import CourseUpdateDoesNotExist from openedx.core.lib.request_utils import get_request_or_stub -from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order log = logging.getLogger(__name__) @@ -131,8 +131,8 @@ def _get_course_block(course_descriptor, user): # Adding courseware imports here to insulate other apps (e.g. schedules) to # avoid import errors. # TODO remove the LMS dependency https://github.com/openedx/edx-platform/issues/37659 - from lms.djangoapps.courseware.model_data import FieldDataCache from lms.djangoapps.courseware.block_render import get_block_for_descriptor + from lms.djangoapps.courseware.model_data import FieldDataCache # Fake a request to fool parts of the courseware that want to inspect it. request = get_request_or_stub() @@ -167,7 +167,7 @@ def _get_highlights_for_week(sections, week_num, course_key): num_sections = len(sections) if not 1 <= week_num <= num_sections: raise CourseUpdateDoesNotExist( - 'Requested week {} but {} has only {} sections.'.format( + 'Requested week {} but {} has only {} sections.'.format( # noqa: UP032 week_num, course_key, num_sections ) ) diff --git a/openedx/core/djangoapps/schedules/exceptions.py b/openedx/core/djangoapps/schedules/exceptions.py index 46061ef6e20c..387bcb8ee42a 100644 --- a/openedx/core/djangoapps/schedules/exceptions.py +++ b/openedx/core/djangoapps/schedules/exceptions.py @@ -1,3 +1,3 @@ -# lint-amnesty, pylint: disable=missing-module-docstring +# pylint: disable=missing-module-docstring class CourseUpdateDoesNotExist(Exception): pass diff --git a/openedx/core/djangoapps/schedules/management/commands/__init__.py b/openedx/core/djangoapps/schedules/management/commands/__init__.py index 16484ef367ea..7baefb53e8c4 100644 --- a/openedx/core/djangoapps/schedules/management/commands/__init__.py +++ b/openedx/core/djangoapps/schedules/management/commands/__init__.py @@ -4,15 +4,15 @@ import datetime - from zoneinfo import ZoneInfo + from django.contrib.sites.models import Site from django.core.management.base import BaseCommand from openedx.core.djangoapps.schedules.utils import PrefixedDebugLoggerMixin -class SendEmailBaseCommand(PrefixedDebugLoggerMixin, BaseCommand): # lint-amnesty, pylint: disable=missing-class-docstring +class SendEmailBaseCommand(PrefixedDebugLoggerMixin, BaseCommand): # pylint: disable=missing-class-docstring async_send_task = None # define in subclass # An iterable of day offsets (e.g. -7, -14, -21, -28, ...) that defines the days for diff --git a/openedx/core/djangoapps/schedules/management/commands/schedules_data_migration.py b/openedx/core/djangoapps/schedules/management/commands/schedules_data_migration.py index 84dd5cd10023..79f6bc1e278f 100644 --- a/openedx/core/djangoapps/schedules/management/commands/schedules_data_migration.py +++ b/openedx/core/djangoapps/schedules/management/commands/schedules_data_migration.py @@ -5,6 +5,7 @@ from django.core.management.base import BaseCommand from django.db import transaction + from openedx.core.djangoapps.schedules.models import Schedule diff --git a/openedx/core/djangoapps/schedules/management/commands/send_course_next_section_update.py b/openedx/core/djangoapps/schedules/management/commands/send_course_next_section_update.py index 6faa92308840..5a63d2b2794d 100644 --- a/openedx/core/djangoapps/schedules/management/commands/send_course_next_section_update.py +++ b/openedx/core/djangoapps/schedules/management/commands/send_course_next_section_update.py @@ -3,8 +3,8 @@ """ import datetime +from textwrap import dedent # pylint: disable=wrong-import-order from zoneinfo import ZoneInfo -from textwrap import dedent # lint-amnesty, pylint: disable=wrong-import-order from django.contrib.sites.models import Site diff --git a/openedx/core/djangoapps/schedules/management/commands/send_course_update.py b/openedx/core/djangoapps/schedules/management/commands/send_course_update.py index e15f53178755..25ed0efbf8e3 100644 --- a/openedx/core/djangoapps/schedules/management/commands/send_course_update.py +++ b/openedx/core/djangoapps/schedules/management/commands/send_course_update.py @@ -5,7 +5,6 @@ from textwrap import dedent - from openedx.core.djangoapps.schedules.management.commands import SendEmailBaseCommand from openedx.core.djangoapps.schedules.tasks import ScheduleCourseUpdate diff --git a/openedx/core/djangoapps/schedules/management/commands/setup_models_to_send_test_emails.py b/openedx/core/djangoapps/schedules/management/commands/setup_models_to_send_test_emails.py index 587271fc599c..46251ff66e9e 100644 --- a/openedx/core/djangoapps/schedules/management/commands/setup_models_to_send_test_emails.py +++ b/openedx/core/djangoapps/schedules/management/commands/setup_models_to_send_test_emails.py @@ -5,9 +5,9 @@ import datetime from textwrap import dedent +from zoneinfo import ZoneInfo import factory -from zoneinfo import ZoneInfo from django.contrib.sites.models import Site from django.core.management.base import BaseCommand @@ -16,10 +16,13 @@ from openedx.core.djangoapps.schedules.tests.factories import ( ScheduleConfigFactory, ScheduleExperienceFactory, - ScheduleFactory + ScheduleFactory, +) +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order +from xmodule.modulestore.tests.factories import ( # pylint: disable=wrong-import-order + XMODULE_FACTORY_LOCK, + CourseFactory, ) -from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import XMODULE_FACTORY_LOCK, CourseFactory # lint-amnesty, pylint: disable=wrong-import-order class ThreeDayNudgeSchedule(ScheduleFactory): @@ -49,7 +52,7 @@ class ContentHighlightSchedule(ScheduleFactory): A ScheduleFactory that creates a Schedule set up for a course highlights email. """ start_date = factory.Faker('date_time_between', start_date='-7d', end_date='-7d', tzinfo=ZoneInfo("UTC")) - experience = factory.RelatedFactory(ScheduleExperienceFactory, 'schedule', experience_type=ScheduleExperience.EXPERIENCES.course_updates) # lint-amnesty, pylint: disable=line-too-long + experience = factory.RelatedFactory(ScheduleExperienceFactory, 'schedule', experience_type=ScheduleExperience.EXPERIENCES.course_updates) # pylint: disable=line-too-long class Command(BaseCommand): diff --git a/openedx/core/djangoapps/schedules/management/commands/tests/send_email_base.py b/openedx/core/djangoapps/schedules/management/commands/tests/send_email_base.py index c0a63954644d..77b337e50773 100644 --- a/openedx/core/djangoapps/schedules/management/commands/tests/send_email_base.py +++ b/openedx/core/djangoapps/schedules/management/commands/tests/send_email_base.py @@ -8,12 +8,12 @@ from collections import namedtuple from copy import deepcopy from unittest.mock import Mock, patch +from zoneinfo import ZoneInfo import attr import ddt -from zoneinfo import ZoneInfo from django.conf import settings -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.db.models import Max from edx_ace.channel import ChannelMap, ChannelType from edx_ace.test_utils import StubPolicy, patch_policies @@ -23,8 +23,10 @@ from common.djangoapps.course_modes.models import CourseMode from common.djangoapps.course_modes.tests.factories import CourseModeFactory -from lms.djangoapps.courseware.models import DynamicUpgradeDeadlineConfiguration +from common.djangoapps.student.models import CourseEnrollment +from common.djangoapps.student.tests.factories import UserFactory from lms.djangoapps.commerce.models import CommerceConfiguration +from lms.djangoapps.courseware.models import DynamicUpgradeDeadlineConfiguration from openedx.core.djangoapps.schedules import resolvers, tasks from openedx.core.djangoapps.schedules.resolvers import _get_datetime_beginning_of_day from openedx.core.djangoapps.schedules.tests.factories import ScheduleConfigFactory, ScheduleFactory @@ -32,8 +34,6 @@ from openedx.core.djangoapps.theming.tests.test_util import with_comprehensive_theme from openedx.core.djangoapps.waffle_utils.testutils import WAFFLE_TABLES from openedx.core.djangolib.testing.utils import FilteredQueryCountMixin -from common.djangoapps.student.models import CourseEnrollment -from common.djangoapps.student.tests.factories import UserFactory SITE_QUERY = 1 # django_site SITE_CONFIG_QUERY = 1 # site_configuration_siteconfiguration @@ -82,7 +82,7 @@ @ddt.ddt @freeze_time('2017-08-01 00:00:00', tz_offset=0, tick=True) -class ScheduleSendEmailTestMixin(FilteredQueryCountMixin): # lint-amnesty, pylint: disable=missing-class-docstring +class ScheduleSendEmailTestMixin(FilteredQueryCountMixin): # pylint: disable=missing-class-docstring __test__ = False @@ -118,7 +118,7 @@ def _next_user_id(self): num_bins = self.task.num_bins return max_user_id + num_bins - (max_user_id % num_bins) - def _get_dates(self, offset=None): # lint-amnesty, pylint: disable=missing-function-docstring + def _get_dates(self, offset=None): # pylint: disable=missing-function-docstring current_day = _get_datetime_beginning_of_day(datetime.datetime.now(ZoneInfo("UTC"))) offset = offset or self.expected_offsets[0] target_day = current_day + datetime.timedelta(days=offset) @@ -133,7 +133,7 @@ def _get_template_overrides(self): templates_override[0]['OPTIONS']['string_if_invalid'] = "TEMPLATE WARNING - MISSING VARIABLE [%s]" return templates_override - def _schedule_factory(self, offset=None, **factory_kwargs): # lint-amnesty, pylint: disable=missing-function-docstring + def _schedule_factory(self, offset=None, **factory_kwargs): # pylint: disable=missing-function-docstring _, _, target_day, upgrade_deadline = self._get_dates(offset=offset) factory_kwargs.setdefault('start_date', target_day) factory_kwargs.setdefault('upgrade_deadline', upgrade_deadline) @@ -198,7 +198,7 @@ def test_resolver_send(self, mock_ace): @patch.object(resolvers, 'set_custom_attribute') def test_schedule_bin(self, schedule_count, mock_attribute, mock_ace): with patch.object(self.task, 'async_send_task') as mock_schedule_send: - current_day, offset, target_day, upgrade_deadline = self._get_dates() # lint-amnesty, pylint: disable=unused-variable + current_day, offset, target_day, upgrade_deadline = self._get_dates() # pylint: disable=unused-variable schedules = [ self._schedule_factory() for _ in range(schedule_count) ] @@ -235,7 +235,7 @@ def test_schedule_bin(self, schedule_count, mock_attribute, mock_ace): assert not mock_ace.send.called def test_no_course_overview(self): - current_day, offset, target_day, upgrade_deadline = self._get_dates() # lint-amnesty, pylint: disable=unused-variable + current_day, offset, target_day, upgrade_deadline = self._get_dates() # pylint: disable=unused-variable # Don't use CourseEnrollmentFactory since it creates a course overview enrollment = CourseEnrollment.objects.create( course_id=CourseKey.from_string('edX/toy/Not_2012_Fall'), @@ -317,7 +317,7 @@ def test_site_config(self, this_org_list, other_org_list, expected_message_count user1 = UserFactory.create(id=self._next_user_id()) user2 = UserFactory.create(id=user1.id + self.task.num_bins) - current_day, offset, target_day, upgrade_deadline = self._get_dates() # lint-amnesty, pylint: disable=unused-variable + current_day, offset, target_day, upgrade_deadline = self._get_dates() # pylint: disable=unused-variable self._schedule_factory( enrollment__course__org=filtered_org, @@ -343,7 +343,7 @@ def test_site_config(self, this_org_list, other_org_list, expected_message_count @ddt.data(True, False) def test_course_end(self, has_course_ended): user1 = UserFactory.create(id=self._next_user_id()) - current_day, offset, target_day, upgrade_deadline = self._get_dates() # lint-amnesty, pylint: disable=unused-variable + current_day, offset, target_day, upgrade_deadline = self._get_dates() # pylint: disable=unused-variable end_date_offset = -2 if has_course_ended else 2 self._schedule_factory( @@ -365,7 +365,7 @@ def test_course_end(self, has_course_ended): @patch.object(tasks, 'ace') def test_multiple_target_schedules(self, mock_ace): user = UserFactory.create() - current_day, offset, target_day, upgrade_deadline = self._get_dates() # lint-amnesty, pylint: disable=unused-variable + current_day, offset, target_day, upgrade_deadline = self._get_dates() # pylint: disable=unused-variable num_courses = 3 for course_index in range(num_courses): self._schedule_factory( @@ -396,8 +396,8 @@ def test_templates(self, message_count): self._assert_template_for_offset(offset, message_count) self.clear_caches() - def _assert_template_for_offset(self, offset, message_count): # lint-amnesty, pylint: disable=missing-function-docstring - current_day, offset, target_day, upgrade_deadline = self._get_dates(offset) # lint-amnesty, pylint: disable=unused-variable + def _assert_template_for_offset(self, offset, message_count): # pylint: disable=missing-function-docstring + current_day, offset, target_day, upgrade_deadline = self._get_dates(offset) # pylint: disable=unused-variable user = UserFactory.create() for course_index in range(message_count): @@ -454,8 +454,8 @@ def _assert_template_for_offset(self, offset, message_count): # lint-amnesty, p return mock_channel.deliver.mock_calls - def _check_if_email_sent_for_experience(self, test_config): # lint-amnesty, pylint: disable=missing-function-docstring - current_day, offset, target_day, _ = self._get_dates(offset=test_config.offset) # lint-amnesty, pylint: disable=unused-variable + def _check_if_email_sent_for_experience(self, test_config): # pylint: disable=missing-function-docstring + current_day, offset, target_day, _ = self._get_dates(offset=test_config.offset) # pylint: disable=unused-variable kwargs = { 'offset': offset diff --git a/openedx/core/djangoapps/schedules/management/commands/tests/test_send_course_update.py b/openedx/core/djangoapps/schedules/management/commands/tests/test_send_course_update.py index 72e68b042012..c172a1229245 100644 --- a/openedx/core/djangoapps/schedules/management/commands/tests/test_send_course_update.py +++ b/openedx/core/djangoapps/schedules/management/commands/tests/test_send_course_update.py @@ -11,18 +11,23 @@ from django.core import mail from edx_ace.utils.date import serialize +from common.djangoapps.student.tests.factories import CourseEnrollmentFactory from openedx.core.djangoapps.schedules import resolvers, tasks from openedx.core.djangoapps.schedules.management.commands import send_course_update as nudge from openedx.core.djangoapps.schedules.management.commands.tests.send_email_base import ( ExperienceTest, - ScheduleSendEmailTestMixin + ScheduleSendEmailTestMixin, ) from openedx.core.djangoapps.schedules.management.commands.tests.upsell_base import ScheduleUpsellTestMixin from openedx.core.djangoapps.schedules.models import ScheduleExperience from openedx.core.djangolib.testing.utils import skip_unless_lms -from common.djangoapps.student.tests.factories import CourseEnrollmentFactory -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory, BlockFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + ModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import ( # pylint: disable=wrong-import-order + BlockFactory, + CourseFactory, +) @ddt.ddt @@ -86,7 +91,7 @@ def stop_highlights_patcher(self): @ddt.data( ExperienceTest(experience=ScheduleExperience.EXPERIENCES.default, offset=expected_offsets[0], email_sent=False), - ExperienceTest(experience=ScheduleExperience.EXPERIENCES.course_updates, offset=expected_offsets[0], email_sent=True), # lint-amnesty, pylint: disable=line-too-long + ExperienceTest(experience=ScheduleExperience.EXPERIENCES.course_updates, offset=expected_offsets[0], email_sent=True), # pylint: disable=line-too-long ExperienceTest(experience=None, offset=expected_offsets[0], email_sent=False), ) def test_schedule_in_different_experience(self, test_config): diff --git a/openedx/core/djangoapps/schedules/management/commands/tests/test_send_email_base_command.py b/openedx/core/djangoapps/schedules/management/commands/tests/test_send_email_base_command.py index eb1f7fe40f71..9bdd29510210 100644 --- a/openedx/core/djangoapps/schedules/management/commands/tests/test_send_email_base_command.py +++ b/openedx/core/djangoapps/schedules/management/commands/tests/test_send_email_base_command.py @@ -6,9 +6,9 @@ import datetime from unittest import skipUnless from unittest.mock import DEFAULT, Mock, patch +from zoneinfo import ZoneInfo import ddt -from zoneinfo import ZoneInfo from django.conf import settings from django.contrib.sites.models import Site @@ -21,9 +21,9 @@ @skip_unless_lms @skipUnless('openedx.core.djangoapps.schedules.apps.SchedulesConfig' in settings.INSTALLED_APPS, "Can't test schedules if the app isn't installed") -class TestSendEmailBaseCommand(CacheIsolationTestCase): # lint-amnesty, pylint: disable=missing-class-docstring +class TestSendEmailBaseCommand(CacheIsolationTestCase): # pylint: disable=missing-class-docstring - def setUp(self): # lint-amnesty, pylint: disable=super-method-not-called + def setUp(self): # pylint: disable=super-method-not-called self.command = SendEmailBaseCommand() self.site = SiteFactory() self.site_config = SiteConfigurationFactory.create(site=self.site) @@ -69,4 +69,4 @@ def test_send_emails(self): assert not kwarg.called for offset in self.command.offsets: - self.command.enqueue.assert_any_call(offset, arg, kwarg=kwarg) # lint-amnesty, pylint: disable=no-member + self.command.enqueue.assert_any_call(offset, arg, kwarg=kwarg) # pylint: disable=no-member diff --git a/openedx/core/djangoapps/schedules/management/commands/tests/test_send_recurring_nudge.py b/openedx/core/djangoapps/schedules/management/commands/tests/test_send_recurring_nudge.py index 2f6edea486d6..d28cef49a8ab 100644 --- a/openedx/core/djangoapps/schedules/management/commands/tests/test_send_recurring_nudge.py +++ b/openedx/core/djangoapps/schedules/management/commands/tests/test_send_recurring_nudge.py @@ -12,7 +12,7 @@ from openedx.core.djangoapps.schedules.management.commands import send_recurring_nudge as nudge from openedx.core.djangoapps.schedules.management.commands.tests.send_email_base import ( ExperienceTest, - ScheduleSendEmailTestMixin + ScheduleSendEmailTestMixin, ) from openedx.core.djangoapps.schedules.management.commands.tests.upsell_base import ScheduleUpsellTestMixin from openedx.core.djangoapps.schedules.models import ScheduleExperience @@ -25,7 +25,7 @@ 'openedx.core.djangoapps.schedules.apps.SchedulesConfig' in settings.INSTALLED_APPS, "Can't test schedules if the app isn't installed", ) -class TestSendRecurringNudge(ScheduleUpsellTestMixin, ScheduleSendEmailTestMixin, CacheIsolationTestCase): # lint-amnesty, pylint: disable=missing-class-docstring +class TestSendRecurringNudge(ScheduleUpsellTestMixin, ScheduleSendEmailTestMixin, CacheIsolationTestCase): # pylint: disable=missing-class-docstring __test__ = True # pylint: disable=protected-access diff --git a/openedx/core/djangoapps/schedules/management/commands/tests/test_send_upgrade_reminder.py b/openedx/core/djangoapps/schedules/management/commands/tests/test_send_upgrade_reminder.py index 86e782a13283..a3a36a04f01d 100644 --- a/openedx/core/djangoapps/schedules/management/commands/tests/test_send_upgrade_reminder.py +++ b/openedx/core/djangoapps/schedules/management/commands/tests/test_send_upgrade_reminder.py @@ -14,15 +14,15 @@ from opaque_keys.edx.locator import CourseLocator from common.djangoapps.course_modes.models import CourseMode +from common.djangoapps.student.tests.factories import UserFactory from openedx.core.djangoapps.schedules import resolvers, tasks from openedx.core.djangoapps.schedules.management.commands import send_upgrade_reminder as reminder from openedx.core.djangoapps.schedules.management.commands.tests.send_email_base import ( ExperienceTest, - ScheduleSendEmailTestMixin + ScheduleSendEmailTestMixin, ) from openedx.core.djangoapps.schedules.models import ScheduleExperience from openedx.core.djangolib.testing.utils import CacheIsolationTestCase, skip_unless_lms -from common.djangoapps.student.tests.factories import UserFactory LOG = logging.getLogger(__name__) @@ -31,12 +31,12 @@ @skip_unless_lms @skipUnless('openedx.core.djangoapps.schedules.apps.SchedulesConfig' in settings.INSTALLED_APPS, "Can't test schedules if the app isn't installed") -class TestUpgradeReminder(ScheduleSendEmailTestMixin, CacheIsolationTestCase): # lint-amnesty, pylint: disable=missing-class-docstring +class TestUpgradeReminder(ScheduleSendEmailTestMixin, CacheIsolationTestCase): # pylint: disable=missing-class-docstring __test__ = True resolver = resolvers.UpgradeReminderResolver task = tasks.ScheduleUpgradeReminder - deliver_task = tasks._upgrade_reminder_schedule_send # lint-amnesty, pylint: disable=protected-access + deliver_task = tasks._upgrade_reminder_schedule_send # pylint: disable=protected-access command = reminder.Command deliver_config = 'deliver_upgrade_reminder' enqueue_config = 'enqueue_upgrade_reminder' @@ -48,7 +48,7 @@ class TestUpgradeReminder(ScheduleSendEmailTestMixin, CacheIsolationTestCase): @ddt.data(True, False) @patch.object(tasks, 'ace') def test_verified_learner(self, is_verified, mock_ace): - current_day, offset, target_day, upgrade_deadline = self._get_dates() # lint-amnesty, pylint: disable=unused-variable + current_day, offset, target_day, upgrade_deadline = self._get_dates() # pylint: disable=unused-variable schedule = self._schedule_factory( enrollment__mode=CourseMode.VERIFIED if is_verified else CourseMode.AUDIT, ) @@ -61,7 +61,7 @@ def test_verified_learner(self, is_verified, mock_ace): assert mock_ace.send.called == (not is_verified) def test_filter_out_verified_schedules(self): - current_day, offset, target_day, upgrade_deadline = self._get_dates() # lint-amnesty, pylint: disable=unused-variable + current_day, offset, target_day, upgrade_deadline = self._get_dates() # pylint: disable=unused-variable user = UserFactory.create() schedules = [ @@ -85,14 +85,14 @@ def test_filter_out_verified_schedules(self): messages = [Message.from_string(m) for m in sent_messages] assert len(messages) == 1 message = messages[0] - self.assertCountEqual( + self.assertCountEqual( # noqa: PT009 message.context['course_ids'], [str(schedules[i].enrollment.course.id) for i in (1, 2, 4)] ) @patch.object(tasks, 'ace') def test_course_without_verified_mode(self, mock_ace): - current_day, offset, target_day, upgrade_deadline = self._get_dates() # lint-amnesty, pylint: disable=unused-variable + current_day, offset, target_day, upgrade_deadline = self._get_dates() # pylint: disable=unused-variable schedule = self._schedule_factory() schedule.enrollment.course.modes.filter(mode_slug=CourseMode.VERIFIED).delete() @@ -104,7 +104,7 @@ def test_course_without_verified_mode(self, mock_ace): @ddt.data( ExperienceTest(experience=ScheduleExperience.EXPERIENCES.default, offset=expected_offsets[0], email_sent=True), - ExperienceTest(experience=ScheduleExperience.EXPERIENCES.course_updates, offset=expected_offsets[0], email_sent=False), # lint-amnesty, pylint: disable=line-too-long + ExperienceTest(experience=ScheduleExperience.EXPERIENCES.course_updates, offset=expected_offsets[0], email_sent=False), # pylint: disable=line-too-long ExperienceTest(experience=None, offset=expected_offsets[0], email_sent=True), ) def test_upgrade_reminder_experience(self, test_config): diff --git a/openedx/core/djangoapps/schedules/management/commands/tests/upsell_base.py b/openedx/core/djangoapps/schedules/management/commands/tests/upsell_base.py index 9b199e5ed189..88d34746d40b 100644 --- a/openedx/core/djangoapps/schedules/management/commands/tests/upsell_base.py +++ b/openedx/core/djangoapps/schedules/management/commands/tests/upsell_base.py @@ -18,7 +18,7 @@ @ddt.ddt @freeze_time('2017-08-01 00:00:00', tz_offset=0, tick=True) -class ScheduleUpsellTestMixin: # lint-amnesty, pylint: disable=missing-class-docstring +class ScheduleUpsellTestMixin: # pylint: disable=missing-class-docstring UpsellTestCase = namedtuple('UpsellTestCase', 'set_deadline, deadline_offset, expect_upsell') def _setup_schedule_and_dates(self, set_deadline=True, deadline_offset=7): diff --git a/openedx/core/djangoapps/schedules/models.py b/openedx/core/djangoapps/schedules/models.py index 2db574cf0e6c..00912102603f 100644 --- a/openedx/core/djangoapps/schedules/models.py +++ b/openedx/core/djangoapps/schedules/models.py @@ -1,4 +1,4 @@ -# lint-amnesty, pylint: disable=missing-module-docstring +# pylint: disable=missing-module-docstring from config_models.models import ConfigurationModel from django.contrib.sites.models import Site @@ -38,7 +38,7 @@ class Schedule(TimeStampedModel): def get_experience_type(self): try: - return self.experience.experience_type # lint-amnesty, pylint: disable=no-member + return self.experience.experience_type # pylint: disable=no-member except ScheduleExperience.DoesNotExist: return ScheduleExperience.EXPERIENCES.default @@ -62,7 +62,7 @@ class ScheduleConfig(ConfigurationModel): deliver_course_update = models.BooleanField(default=False) -class ScheduleExperience(models.Model): +class ScheduleExperience(models.Model): # noqa: DJ008 """ .. no_pii: """ diff --git a/openedx/core/djangoapps/schedules/resolvers.py b/openedx/core/djangoapps/schedules/resolvers.py index b3dce6f054a7..4c62ca1e118c 100644 --- a/openedx/core/djangoapps/schedules/resolvers.py +++ b/openedx/core/djangoapps/schedules/resolvers.py @@ -1,4 +1,4 @@ -# lint-amnesty, pylint: disable=missing-module-docstring +# pylint: disable=missing-module-docstring import datetime import logging @@ -7,23 +7,24 @@ import attr from django.conf import settings -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user -from django.templatetags.static import static +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.db.models import Exists, F, OuterRef, Q +from django.templatetags.static import static from django.urls import reverse from edx_ace.recipient import Recipient from edx_ace.recipient_resolver import RecipientResolver from edx_django_utils.monitoring import function_trace, set_custom_attribute from openedx_filters.learning.filters import ScheduleQuerySetRequested -from lms.djangoapps.courseware.utils import verified_upgrade_deadline_link, can_show_verified_upgrade +from lms.djangoapps.courseware.utils import can_show_verified_upgrade, verified_upgrade_deadline_link from lms.djangoapps.discussion.notification_prefs.views import UsernameCipher from openedx.core.djangoapps.ace_common.template_context import get_base_template_context from openedx.core.djangoapps.course_date_signals.utils import get_expected_duration from openedx.core.djangoapps.schedules.config import ( - COURSE_UPDATE_SHOW_UNSUBSCRIBE_WAFFLE_SWITCH, query_external_updates + COURSE_UPDATE_SHOW_UNSUBSCRIBE_WAFFLE_SWITCH, + query_external_updates, ) -from openedx.core.djangoapps.schedules.content_highlights import get_week_highlights, get_next_section_highlights +from openedx.core.djangoapps.schedules.content_highlights import get_next_section_highlights, get_week_highlights from openedx.core.djangoapps.schedules.exceptions import CourseUpdateDoesNotExist from openedx.core.djangoapps.schedules.message_types import CourseUpdate, InstructorLedCourseUpdate from openedx.core.djangoapps.schedules.models import Schedule, ScheduleExperience @@ -84,9 +85,9 @@ class BinnedSchedulesBaseResolver(PrefixedDebugLoggerMixin, RecipientResolver): def __attrs_post_init__(self): # TODO: in the next refactor of this task, pass in current_datetime instead of reproducing it here - self.current_datetime = self.target_datetime - datetime.timedelta(days=self.day_offset) # lint-amnesty, pylint: disable=attribute-defined-outside-init + self.current_datetime = self.target_datetime - datetime.timedelta(days=self.day_offset) # pylint: disable=attribute-defined-outside-init - def send(self, msg_type): # lint-amnesty, pylint: disable=arguments-differ + def send(self, msg_type): # pylint: disable=arguments-differ for (user, language, context) in self.schedules_for_bin(): msg = msg_type.personalize( Recipient( @@ -118,7 +119,7 @@ def get_schedules_with_target_date_by_bin_and_orgs( target_day = _get_datetime_beginning_of_day(self.target_datetime) schedule_day_equals_target_day_filter = { f'courseenrollment__schedule__{self.schedule_date_field}__gte': target_day, - f'courseenrollment__schedule__{self.schedule_date_field}__lt': target_day + datetime.timedelta(days=1), # lint-amnesty, pylint: disable=line-too-long + f'courseenrollment__schedule__{self.schedule_date_field}__lt': target_day + datetime.timedelta(days=1), # pylint: disable=line-too-long } users = User.objects.filter( courseenrollment__is_active=True, @@ -204,7 +205,7 @@ def filter_by_org(self, schedules): return schedules.filter(enrollment__course__org__in=org_list) - def schedules_for_bin(self): # lint-amnesty, pylint: disable=missing-function-docstring + def schedules_for_bin(self): # pylint: disable=missing-function-docstring schedules = self.get_schedules_with_target_date_by_bin_and_orgs() template_context = get_base_template_context(self.site) @@ -223,7 +224,7 @@ def schedules_for_bin(self): # lint-amnesty, pylint: disable=missing-function-d yield (user, first_schedule.enrollment.course.closest_released_language, template_context) - def get_template_context(self, user, user_schedules): # lint-amnesty, pylint: disable=unused-argument + def get_template_context(self, user, user_schedules): # pylint: disable=unused-argument """ Given a user and their schedules, build the context needed to render the template for this message. @@ -260,7 +261,7 @@ class RecurringNudgeResolver(BinnedSchedulesBaseResolver): num_bins = RECURRING_NUDGE_NUM_BINS @property - def experience_filter(self): # lint-amnesty, pylint: disable=missing-function-docstring + def experience_filter(self): # pylint: disable=missing-function-docstring if self.day_offset == -3: experiences = [ScheduleExperience.EXPERIENCES.default, ScheduleExperience.EXPERIENCES.course_updates] return Q(experience__experience_type__in=experiences) | Q(experience__isnull=True) @@ -335,7 +336,7 @@ def get_template_context(self, user, user_schedules): return context -def _get_upsell_information_for_schedule(user, schedule): # lint-amnesty, pylint: disable=missing-function-docstring +def _get_upsell_information_for_schedule(user, schedule): # pylint: disable=missing-function-docstring template_context = {} enrollment = schedule.enrollment course = enrollment.course @@ -383,7 +384,7 @@ def send(self, msg_type): context, ) LOG.info( - 'Sending email to user: {} for Instructor-paced course with course-key: {} and language: {}'.format( + 'Sending email to user: {} for Instructor-paced course with course-key: {} and language: {}'.format( # noqa: UP032 # pylint: disable=line-too-long user.username, self.course_id, language @@ -413,7 +414,7 @@ def schedules_for_bin(self): week_highlights = get_week_highlights(user, enrollment.course_id, week_num) except CourseUpdateDoesNotExist: LOG.warning( - 'Weekly highlights for user {} in week {} of course {} does not exist or is disabled'.format( + 'Weekly highlights for user {} in week {} of course {} does not exist or is disabled'.format( # noqa: UP032 # pylint: disable=line-too-long user, week_num, enrollment.course_id ) ) @@ -459,7 +460,7 @@ class CourseNextSectionUpdate(PrefixedDebugLoggerMixin, RecipientResolver): log_prefix = 'Next Section Course Update' experience_filter = Q(experience__experience_type=ScheduleExperience.EXPERIENCES.course_updates) - def send(self): # lint-amnesty, pylint: disable=arguments-differ + def send(self): # pylint: disable=arguments-differ schedules = self.get_schedules() for (user, language, context) in schedules: msg = CourseUpdate().personalize( @@ -471,13 +472,13 @@ def send(self): # lint-amnesty, pylint: disable=arguments-differ context, ) LOG.info( - 'Sending email to user: {} for course-key: {}'.format( + 'Sending email to user: {} for course-key: {}'.format( # noqa: UP032 user.username, self.course_id ) ) LOG.info( - 'Sending email to user: {} for Self-paced course with course-key: {} and language: {}'.format( + 'Sending email to user: {} for Self-paced course with course-key: {} and language: {}'.format( # noqa: UP032 # pylint: disable=line-too-long user.username, self.course_id, language @@ -517,7 +518,7 @@ def get_schedules(self): user = schedule.enrollment.user start_date = max(filter(None, (schedule.start_date, course.start))) - LOG.info('Received a schedule for user {} in course {} for date {}'.format( + LOG.info('Received a schedule for user {} in course {} for date {}'.format( # noqa: UP032 user.username, self.course_id, target_date, )) diff --git a/openedx/core/djangoapps/schedules/signals.py b/openedx/core/djangoapps/schedules/signals.py index c88119d83f34..48548bb6eb53 100644 --- a/openedx/core/djangoapps/schedules/signals.py +++ b/openedx/core/djangoapps/schedules/signals.py @@ -10,17 +10,18 @@ from edx_ace.utils import date from common.djangoapps.course_modes.models import CourseMode +from common.djangoapps.student.models import CourseEnrollment +from common.djangoapps.student.signals import ENROLLMENT_TRACK_UPDATED # pylint: disable=unused-import from lms.djangoapps.courseware.models import ( CourseDynamicUpgradeDeadlineConfiguration, DynamicUpgradeDeadlineConfiguration, - OrgDynamicUpgradeDeadlineConfiguration + OrgDynamicUpgradeDeadlineConfiguration, ) from openedx.core.djangoapps.content.course_overviews.signals import COURSE_START_DATE_CHANGED from openedx.core.djangoapps.schedules.content_highlights import course_has_highlights_from_store from openedx.core.djangoapps.schedules.models import ScheduleExperience from openedx.core.djangoapps.schedules.utils import reset_self_paced_schedule -from common.djangoapps.student.models import CourseEnrollment -from common.djangoapps.student.signals import ENROLLMENT_TRACK_UPDATED # lint-amnesty, pylint: disable=unused-import + from .models import Schedule from .tasks import update_course_schedules @@ -39,7 +40,7 @@ def create_schedule(sender, **kwargs): # pylint: disable=unused-argument schedule_details = _create_schedule(enrollment, enrollment_created) if schedule_details: - log.debug( # lint-amnesty, pylint: disable=logging-not-lazy + log.debug( # pylint: disable=logging-not-lazy 'Schedules: created a new schedule starting at ' + '%s with an upgrade deadline of %s and experience type: %s', schedule_details['content_availability_date'], @@ -49,7 +50,7 @@ def create_schedule(sender, **kwargs): # pylint: disable=unused-argument except Exception: # pylint: disable=broad-except # We do not want to block the creation of a CourseEnrollment because of an error in creating a Schedule. # No Schedule is acceptable, but no CourseEnrollment is not. - log.exception('Encountered error in creating a Schedule for CourseEnrollment for user {} in course {}'.format( + log.exception('Encountered error in creating a Schedule for CourseEnrollment for user {} in course {}'.format( # noqa: UP032 # pylint: disable=line-too-long enrollment.user.id if (enrollment and enrollment.user) else None, enrollment.course_id if enrollment else None )) @@ -86,7 +87,7 @@ def reset_schedule_on_mode_change(sender, user, course_key, mode, **kwargs): # reset_self_paced_schedule(user, course_key, use_enrollment_date=use_enrollment_date) -def _calculate_upgrade_deadline(course_id, content_availability_date): # lint-amnesty, pylint: disable=missing-function-docstring +def _calculate_upgrade_deadline(course_id, content_availability_date): # pylint: disable=missing-function-docstring upgrade_deadline = None delta = _get_upgrade_deadline_delta_setting(course_id) @@ -108,7 +109,7 @@ def _calculate_upgrade_deadline(course_id, content_availability_date): # lint-a return upgrade_deadline -def _get_upgrade_deadline_delta_setting(course_id): # lint-amnesty, pylint: disable=missing-function-docstring +def _get_upgrade_deadline_delta_setting(course_id): # pylint: disable=missing-function-docstring delta = None global_config = DynamicUpgradeDeadlineConfiguration.current() diff --git a/openedx/core/djangoapps/schedules/tasks.py b/openedx/core/djangoapps/schedules/tasks.py index d4685a1e46b5..a7d92055fa37 100644 --- a/openedx/core/djangoapps/schedules/tasks.py +++ b/openedx/core/djangoapps/schedules/tasks.py @@ -1,13 +1,14 @@ -# lint-amnesty, pylint: disable=missing-module-docstring +# pylint: disable=missing-module-docstring import datetime import logging +from importlib import import_module -from celery import shared_task, current_app +from celery import current_app, shared_task from celery_utils.logged_task import LoggedTask from celery_utils.persist_on_failure import LoggedPersistOnFailureTask from django.conf import settings -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.contrib.sites.models import Site from django.core.exceptions import ValidationError from django.db.utils import DatabaseError @@ -17,17 +18,16 @@ from edx_django_utils.monitoring import ( set_code_owner_attribute, set_code_owner_attribute_from_module, - set_custom_attribute + set_custom_attribute, ) from eventtracking import tracker -from importlib import import_module from opaque_keys.edx.keys import CourseKey +from common.djangoapps.track import segment from openedx.core.djangoapps.content.course_overviews.models import CourseOverview from openedx.core.djangoapps.schedules import message_types, resolvers from openedx.core.djangoapps.schedules.models import Schedule, ScheduleConfig from openedx.core.lib.celery.task_utils import emulate_http_request -from common.djangoapps.track import segment LOG = logging.getLogger(__name__) @@ -47,7 +47,7 @@ @shared_task(base=LoggedPersistOnFailureTask, bind=True, default_retry_delay=30) @set_code_owner_attribute -def update_course_schedules(self, **kwargs): # lint-amnesty, pylint: disable=missing-function-docstring +def update_course_schedules(self, **kwargs): # pylint: disable=missing-function-docstring course_key = CourseKey.from_string(kwargs['course_id']) new_start_date = deserialize(kwargs['new_start_date_str']) new_upgrade_deadline = deserialize(kwargs['new_upgrade_deadline_str']) @@ -60,10 +60,10 @@ def update_course_schedules(self, **kwargs): # lint-amnesty, pylint: disable=mi except Exception as exc: if not isinstance(exc, KNOWN_RETRY_ERRORS): LOG.exception(f"Unexpected failure: task id: {self.request.id}, kwargs={kwargs}") - raise self.retry(kwargs=kwargs, exc=exc) + raise self.retry(kwargs=kwargs, exc=exc) # noqa: B904 -class ScheduleMessageBaseTask(LoggedTask): # lint-amnesty, pylint: disable=abstract-method +class ScheduleMessageBaseTask(LoggedTask): # pylint: disable=abstract-method """ Base class for top-level Schedule tasks that create subtasks. """ @@ -104,9 +104,9 @@ class BinnedScheduleMessageBaseTask(ScheduleMessageBaseTask): task_instance = None @classmethod - def enqueue(cls, site, current_date, day_offset, override_recipient_email=None, override_middlewares=None): # lint-amnesty, pylint: disable=missing-function-docstring + def enqueue(cls, site, current_date, day_offset, override_recipient_email=None, override_middlewares=None): # pylint: disable=missing-function-docstring set_code_owner_attribute_from_module(__name__) - current_date = resolvers._get_datetime_beginning_of_day(current_date) # lint-amnesty, pylint: disable=protected-access + current_date = resolvers._get_datetime_beginning_of_day(current_date) # pylint: disable=protected-access if not cls.is_enqueue_enabled(site): cls.log_info('Message queuing disabled for site %s', site.domain) @@ -114,7 +114,7 @@ def enqueue(cls, site, current_date, day_offset, override_recipient_email=None, target_date = current_date + datetime.timedelta(days=day_offset) cls.log_info('Target date = %s', target_date.isoformat()) - for bin in range(cls.num_bins): # lint-amnesty, pylint: disable=redefined-builtin + for bin in range(cls.num_bins): # pylint: disable=redefined-builtin task_args = ( site.id, serialize(target_date), @@ -129,7 +129,7 @@ def enqueue(cls, site, current_date, day_offset, override_recipient_email=None, retry=False, ) - def run( # lint-amnesty, pylint: disable=arguments-differ + def run( # pylint: disable=arguments-differ self, site_id, target_day_str, day_offset, bin_num, override_recipient_email=None, override_middlewares=None, ): set_code_owner_attribute_from_module(__name__) @@ -138,7 +138,7 @@ def run( # lint-amnesty, pylint: disable=arguments-differ with emulate_http_request(site=site, middleware_classes=middlewares) as request: msg_type = self.make_message_type(day_offset) _annotate_for_monitoring(msg_type, request.site, bin_num, target_day_str, day_offset) - return self.resolver( # lint-amnesty, pylint: disable=not-callable + return self.resolver( # pylint: disable=not-callable self.async_send_task, request.site, deserialize(target_day_str), @@ -189,7 +189,7 @@ def _course_update_schedule_send(site_id, msg_str): ) -class ScheduleRecurringNudge(BinnedScheduleMessageBaseTask): # lint-amnesty, pylint: disable=missing-class-docstring +class ScheduleRecurringNudge(BinnedScheduleMessageBaseTask): # pylint: disable=missing-class-docstring num_bins = resolvers.RECURRING_NUDGE_NUM_BINS enqueue_config_var = 'enqueue_recurring_nudge' log_prefix = RECURRING_NUDGE_LOG_PREFIX @@ -203,7 +203,7 @@ def make_message_type(self, day_offset): ScheduleRecurringNudge = ScheduleRecurringNudge.task_instance -class ScheduleUpgradeReminder(BinnedScheduleMessageBaseTask): # lint-amnesty, pylint: disable=missing-class-docstring +class ScheduleUpgradeReminder(BinnedScheduleMessageBaseTask): # pylint: disable=missing-class-docstring num_bins = resolvers.UPGRADE_REMINDER_NUM_BINS enqueue_config_var = 'enqueue_upgrade_reminder' log_prefix = UPGRADE_REMINDER_LOG_PREFIX @@ -217,7 +217,7 @@ def make_message_type(self, day_offset): ScheduleUpgradeReminder = ScheduleUpgradeReminder.task_instance -class ScheduleCourseUpdate(BinnedScheduleMessageBaseTask): # lint-amnesty, pylint: disable=missing-class-docstring +class ScheduleCourseUpdate(BinnedScheduleMessageBaseTask): # pylint: disable=missing-class-docstring num_bins = resolvers.COURSE_UPDATE_NUM_BINS enqueue_config_var = 'enqueue_course_update' log_prefix = COURSE_UPDATE_LOG_PREFIX @@ -231,7 +231,7 @@ def make_message_type(self, day_offset): ScheduleCourseUpdate = ScheduleCourseUpdate.task_instance -class ScheduleCourseNextSectionUpdate(ScheduleMessageBaseTask): # lint-amnesty, pylint: disable=missing-class-docstring +class ScheduleCourseNextSectionUpdate(ScheduleMessageBaseTask): # pylint: disable=missing-class-docstring enqueue_config_var = 'enqueue_course_update' log_prefix = COURSE_NEXT_SECTION_UPDATE_LOG_PREFIX resolver = resolvers.CourseNextSectionUpdate @@ -239,7 +239,7 @@ class ScheduleCourseNextSectionUpdate(ScheduleMessageBaseTask): # lint-amnesty, task_instance = None @classmethod - def enqueue(cls, site, current_date, day_offset, override_recipient_email=None): # lint-amnesty, pylint: disable=missing-function-docstring + def enqueue(cls, site, current_date, day_offset, override_recipient_email=None): # pylint: disable=missing-function-docstring set_code_owner_attribute_from_module(__name__) target_datetime = (current_date - datetime.timedelta(days=day_offset)) @@ -261,7 +261,7 @@ def enqueue(cls, site, current_date, day_offset, override_recipient_email=None): retry=False, ) - def run(self, site_id, target_day_str, course_key, override_recipient_email=None): # lint-amnesty, pylint: disable=arguments-differ + def run(self, site_id, target_day_str, course_key, override_recipient_email=None): # pylint: disable=arguments-differ set_code_owner_attribute_from_module(__name__) site = Site.objects.select_related('configuration').get(id=site_id) with emulate_http_request(site=site): @@ -278,7 +278,7 @@ def run(self, site_id, target_day_str, course_key, override_recipient_email=None ScheduleCourseNextSectionUpdate = ScheduleCourseNextSectionUpdate.task_instance -def _schedule_send(msg_str, site_id, delivery_config_var, log_prefix): # lint-amnesty, pylint: disable=missing-function-docstring +def _schedule_send(msg_str, site_id, delivery_config_var, log_prefix): # pylint: disable=missing-function-docstring site = Site.objects.select_related('configuration').get(pk=site_id) if _is_delivery_enabled(site, delivery_config_var, log_prefix): msg = Message.from_string(msg_str) @@ -295,7 +295,7 @@ def _schedule_send(msg_str, site_id, delivery_config_var, log_prefix): # lint-a _track_message_sent(site, user, msg) -def _track_message_sent(site, user, msg): # lint-amnesty, pylint: disable=missing-function-docstring +def _track_message_sent(site, user, msg): # pylint: disable=missing-function-docstring properties = { 'site': site.domain, 'app_label': msg.app_label, @@ -338,7 +338,7 @@ def _is_delivery_enabled(site, delivery_config_var, log_prefix): LOG.info('%s: Message delivery disabled for site %s', log_prefix, site.domain) -def _annotate_for_monitoring(message_type, site, bin_num=None, target_day_str=None, day_offset=None, course_key=None): # lint-amnesty, pylint: disable=missing-function-docstring +def _annotate_for_monitoring(message_type, site, bin_num=None, target_day_str=None, day_offset=None, course_key=None): # pylint: disable=missing-function-docstring # This identifies the type of message being sent, for example: schedules.recurring_nudge3. set_custom_attribute('message_name', f'{message_type.app_label}.{message_type.name}') # The domain name of the site we are sending the message for. diff --git a/openedx/core/djangoapps/schedules/tests/factories.py b/openedx/core/djangoapps/schedules/tests/factories.py index c3ffcad246ed..618af53fff26 100644 --- a/openedx/core/djangoapps/schedules/tests/factories.py +++ b/openedx/core/djangoapps/schedules/tests/factories.py @@ -3,12 +3,13 @@ """ -import factory from zoneinfo import ZoneInfo +import factory + +from common.djangoapps.student.tests.factories import CourseEnrollmentFactory from openedx.core.djangoapps.schedules import models from openedx.core.djangoapps.site_configuration.tests.factories import SiteFactory -from common.djangoapps.student.tests.factories import CourseEnrollmentFactory class ScheduleExperienceFactory(factory.django.DjangoModelFactory): @@ -18,7 +19,7 @@ class Meta: experience_type = models.ScheduleExperience.EXPERIENCES.default -class ScheduleFactory(factory.django.DjangoModelFactory): # lint-amnesty, pylint: disable=missing-class-docstring +class ScheduleFactory(factory.django.DjangoModelFactory): # pylint: disable=missing-class-docstring class Meta: model = models.Schedule @@ -28,7 +29,7 @@ class Meta: experience = factory.RelatedFactory(ScheduleExperienceFactory, 'schedule') -class ScheduleConfigFactory(factory.django.DjangoModelFactory): # lint-amnesty, pylint: disable=missing-class-docstring +class ScheduleConfigFactory(factory.django.DjangoModelFactory): # pylint: disable=missing-class-docstring class Meta: model = models.ScheduleConfig diff --git a/openedx/core/djangoapps/schedules/tests/test_config.py b/openedx/core/djangoapps/schedules/tests/test_config.py index 03d507312cc3..9bd83e49a861 100644 --- a/openedx/core/djangoapps/schedules/tests/test_config.py +++ b/openedx/core/djangoapps/schedules/tests/test_config.py @@ -12,7 +12,9 @@ from lms.djangoapps.experiments.models import ExperimentData from lms.djangoapps.experiments.testutils import override_experiment_waffle_flag from openedx.core.djangoapps.schedules.config import ( - _EXTERNAL_COURSE_UPDATES_FLAG, query_external_updates, set_up_external_updates_for_enrollment + _EXTERNAL_COURSE_UPDATES_FLAG, + query_external_updates, + set_up_external_updates_for_enrollment, ) from openedx.core.djangolib.testing.utils import skip_unless_lms diff --git a/openedx/core/djangoapps/schedules/tests/test_content_highlights.py b/openedx/core/djangoapps/schedules/tests/test_content_highlights.py index ece49fc50f0d..9aaa791c8ca7 100644 --- a/openedx/core/djangoapps/schedules/tests/test_content_highlights.py +++ b/openedx/core/djangoapps/schedules/tests/test_content_highlights.py @@ -1,25 +1,25 @@ -# lint-amnesty, pylint: disable=missing-module-docstring +# pylint: disable=missing-module-docstring import datetime from unittest.mock import patch import pytest -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase -from xmodule.modulestore.tests.factories import CourseFactory, BlockFactory +from common.djangoapps.student.models import CourseEnrollment +from common.djangoapps.student.tests.factories import UserFactory from openedx.core.djangoapps.schedules.content_highlights import ( course_has_highlights_from_store, get_all_course_highlights, get_next_section_highlights, - get_week_highlights + get_week_highlights, ) from openedx.core.djangoapps.schedules.exceptions import CourseUpdateDoesNotExist from openedx.core.djangolib.testing.utils import skip_unless_lms -from common.djangoapps.student.models import CourseEnrollment -from common.djangoapps.student.tests.factories import UserFactory +from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase +from xmodule.modulestore.tests.factories import BlockFactory, CourseFactory @skip_unless_lms -class TestContentHighlights(ModuleStoreTestCase): # lint-amnesty, pylint: disable=missing-class-docstring +class TestContentHighlights(ModuleStoreTestCase): # pylint: disable=missing-class-docstring def setUp(self): super().setUp() self._setup_course() @@ -87,7 +87,7 @@ def test_course_with_no_highlights(self): self._create_chapter(display_name="Week 1") self._create_chapter(display_name="Week 2") - self.course = self.store.get_course(self.course_key) # lint-amnesty, pylint: disable=attribute-defined-outside-init + self.course = self.store.get_course(self.course_key) # pylint: disable=attribute-defined-outside-init assert len(self.course.get_children()) == 2 assert not course_has_highlights_from_store(self.course_key) @@ -157,7 +157,7 @@ def test_get_next_section_highlights(self, mock_duration): assert get_next_section_highlights(self.user, self.course_key, two_days_ago, three_days.date()) == (None, None) assert get_next_section_highlights(self.user, self.course_key, two_days_ago, four_days.date()) ==\ (['final week!'], 4) - exception_message = f'Last section was reached. There are no more highlights for {self.course_key}' + exception_message = f'Last section was reached. There are no more highlights for {self.course_key}' # noqa: F841 # pylint: disable=line-too-long with pytest.raises(CourseUpdateDoesNotExist): get_next_section_highlights(self.user, self.course_key, two_days_ago, six_days.date()) @@ -168,10 +168,10 @@ def test_get_highlights_without_block(self, mock_get_block): with self.store.bulk_operations(self.course_key): self._create_chapter(highlights=['Test highlight']) - with self.assertRaisesRegex(CourseUpdateDoesNotExist, 'Course block .* not found'): + with self.assertRaisesRegex(CourseUpdateDoesNotExist, 'Course block .* not found'): # noqa: PT027 get_week_highlights(self.user, self.course_key, 1) yesterday = datetime.datetime.utcnow() - datetime.timedelta(days=1) today = datetime.datetime.utcnow() - with self.assertRaisesRegex(CourseUpdateDoesNotExist, 'Course block .* not found'): + with self.assertRaisesRegex(CourseUpdateDoesNotExist, 'Course block .* not found'): # noqa: PT027 get_next_section_highlights(self.user, self.course_key, yesterday, today.date()) diff --git a/openedx/core/djangoapps/schedules/tests/test_filters.py b/openedx/core/djangoapps/schedules/tests/test_filters.py index 9f7efa050447..44a27a665de1 100644 --- a/openedx/core/djangoapps/schedules/tests/test_filters.py +++ b/openedx/core/djangoapps/schedules/tests/test_filters.py @@ -61,11 +61,11 @@ def test_schedule_with_queryset_requested_filter_enabled(self) -> None: """Test to verify the schedule queryset was modified by the pipeline step.""" schedules = self.resolver.get_schedules_with_target_date_by_bin_and_orgs() - self.assertEqual(TestScheduleQuerySetRequestedPipelineStep.filtered_schedules, schedules) + self.assertEqual(TestScheduleQuerySetRequestedPipelineStep.filtered_schedules, schedules) # noqa: PT009 @override_settings(OPEN_EDX_FILTERS_CONFIG={}) def test_schedule_with_queryset_requested_filter_disabled(self) -> None: """Test to verify the schedule queryset was not modified when the pipeline step is not configured.""" schedules = self.resolver.get_schedules_with_target_date_by_bin_and_orgs() - self.assertNotEqual(TestScheduleQuerySetRequestedPipelineStep.filtered_schedules, schedules) + self.assertNotEqual(TestScheduleQuerySetRequestedPipelineStep.filtered_schedules, schedules) # noqa: PT009 diff --git a/openedx/core/djangoapps/schedules/tests/test_resolvers.py b/openedx/core/djangoapps/schedules/tests/test_resolvers.py index 20536abcbd6f..3d3ea4293b3f 100644 --- a/openedx/core/djangoapps/schedules/tests/test_resolvers.py +++ b/openedx/core/djangoapps/schedules/tests/test_resolvers.py @@ -5,17 +5,15 @@ import datetime from unittest.mock import Mock +from zoneinfo import ZoneInfo import crum import ddt -from zoneinfo import ZoneInfo from django.test import TestCase from django.test.client import RequestFactory from django.test.utils import override_settings from edx_toggles.toggles.testutils import override_waffle_switch from testfixtures import LogCapture -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase -from xmodule.modulestore.tests.factories import CourseFactory, BlockFactory from common.djangoapps.student.models import CourseEnrollment from common.djangoapps.student.tests.factories import CourseEnrollmentFactory, UserFactory @@ -34,7 +32,12 @@ ) from openedx.core.djangoapps.schedules.tests.factories import ScheduleConfigFactory from openedx.core.djangoapps.site_configuration.tests.factories import SiteConfigurationFactory, SiteFactory +from openedx.core.djangoapps.waffle_utils.testutils import WAFFLE_TABLES from openedx.core.djangolib.testing.utils import CacheIsolationMixin, skip_unless_lms +from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase +from xmodule.modulestore.tests.factories import BlockFactory, CourseFactory + +QUERY_COUNT_TABLE_IGNORELIST = WAFFLE_TABLES class SchedulesResolverTestMixin(CacheIsolationMixin): @@ -276,7 +279,7 @@ def create_resolver(self, user_start_date_offset=8): def test_schedule_context(self): resolver = self.create_resolver() # using this to make sure the select_related stays intact - with self.assertNumQueries(26): + with self.assertNumQueries(22, table_ignorelist=QUERY_COUNT_TABLE_IGNORELIST): sc = resolver.get_schedules() schedules = list(sc) apple_logo_url = 'http://email-media.s3.amazonaws.com/edX/2021/store_apple_229x78.jpg' @@ -335,7 +338,7 @@ def test_schedule_context_error(self): resolver = self.create_resolver(user_start_date_offset=29) with LogCapture(LOG.name) as log_capture: list(resolver.get_schedules()) - log_message = ('Next Section Course Update: Last section was reached. ' + log_message = ('Next Section Course Update: Last section was reached. ' # noqa: UP032 'There are no more highlights for {}'.format(self.course.id)) log_capture.check_present((LOG.name, 'WARNING', log_message)) @@ -344,4 +347,4 @@ def test_no_updates_if_course_ended(self): self.course = self.update_course(self.course, self.user.id) resolver = self.create_resolver() schedules = list(resolver.get_schedules()) - self.assertListEqual(schedules, []) + self.assertListEqual(schedules, []) # noqa: PT009 diff --git a/openedx/core/djangoapps/schedules/tests/test_signals.py b/openedx/core/djangoapps/schedules/tests/test_signals.py index b862f8e00e26..0e8fb80ec656 100644 --- a/openedx/core/djangoapps/schedules/tests/test_signals.py +++ b/openedx/core/djangoapps/schedules/tests/test_signals.py @@ -5,23 +5,26 @@ import datetime from unittest.mock import patch +from zoneinfo import ZoneInfo import ddt import pytest -from zoneinfo import ZoneInfo from common.djangoapps.course_modes.models import CourseMode from common.djangoapps.course_modes.tests.factories import CourseModeFactory +from common.djangoapps.student.models import CourseEnrollment +from common.djangoapps.student.tests.factories import CourseEnrollmentFactory from lms.djangoapps.courseware.models import DynamicUpgradeDeadlineConfiguration from openedx.core.djangoapps.content.course_overviews.models import CourseOverview from openedx.core.djangoapps.schedules.models import ScheduleExperience from openedx.core.djangoapps.site_configuration.tests.factories import SiteFactory from openedx.core.djangolib.testing.utils import skip_unless_lms -from common.djangoapps.student.models import CourseEnrollment -from common.djangoapps.student.tests.factories import CourseEnrollmentFactory -from xmodule.modulestore import ModuleStoreEnum # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase, SharedModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore import ModuleStoreEnum # pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( # pylint: disable=wrong-import-order + ModuleStoreTestCase, + SharedModuleStoreTestCase, +) +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order from ..models import Schedule from ..tests.factories import ScheduleConfigFactory @@ -29,7 +32,7 @@ @ddt.ddt @skip_unless_lms -class CreateScheduleTests(SharedModuleStoreTestCase): # lint-amnesty, pylint: disable=missing-class-docstring +class CreateScheduleTests(SharedModuleStoreTestCase): # pylint: disable=missing-class-docstring def assert_schedule_created(self, is_self_paced=True, experience_type=ScheduleExperience.EXPERIENCES.default): """ @@ -45,24 +48,24 @@ def assert_schedule_created(self, is_self_paced=True, experience_type=ScheduleEx assert enrollment.schedule.upgrade_deadline is None assert enrollment.schedule.experience.experience_type == experience_type - def assert_schedule_not_created(self): # lint-amnesty, pylint: disable=missing-function-docstring + def assert_schedule_not_created(self): # pylint: disable=missing-function-docstring course = _create_course_run(self_paced=True) enrollment = CourseEnrollmentFactory( course_id=course.id, mode=CourseMode.AUDIT, ) with pytest.raises(Schedule.DoesNotExist): - enrollment.schedule # lint-amnesty, pylint: disable=pointless-statement + enrollment.schedule # pylint: disable=pointless-statement # noqa: B018 def test_create_schedule(self): self.assert_schedule_created() @patch.object(CourseOverview, '_get_course_has_highlights', return_value=True) - def test_schedule_config_creation_enabled_instructor_paced(self, _mock_highlights): + def test_schedule_config_creation_enabled_instructor_paced(self, _mock_highlights): # noqa: PT019 self.assert_schedule_created(is_self_paced=False, experience_type=ScheduleExperience.EXPERIENCES.course_updates) @patch.object(CourseOverview, '_get_course_has_highlights', return_value=True) - def test_create_schedule_course_updates_experience(self, _mock_highlights): + def test_create_schedule_course_updates_experience(self, _mock_highlights): # noqa: PT019 self.assert_schedule_created(experience_type=ScheduleExperience.EXPERIENCES.course_updates) @patch('openedx.core.djangoapps.schedules.signals.log.exception') @@ -94,7 +97,7 @@ def test_course_already_started(self): @ddt.ddt @skip_unless_lms -class UpdateScheduleTests(ModuleStoreTestCase): # lint-amnesty, pylint: disable=missing-class-docstring +class UpdateScheduleTests(ModuleStoreTestCase): # pylint: disable=missing-class-docstring ENABLED_SIGNALS = ['course_published'] VERIFICATION_DEADLINE_DAYS = 14 @@ -142,7 +145,7 @@ def test_updated_when_new_start_in_past(self): @skip_unless_lms -class ResetScheduleTests(SharedModuleStoreTestCase): # lint-amnesty, pylint: disable=missing-class-docstring +class ResetScheduleTests(SharedModuleStoreTestCase): # pylint: disable=missing-class-docstring def setUp(self): super().setUp() diff --git a/openedx/core/djangoapps/schedules/tests/test_tasks.py b/openedx/core/djangoapps/schedules/tests/test_tasks.py index 99f790e35b01..f88729e5bdc1 100644 --- a/openedx/core/djangoapps/schedules/tests/test_tasks.py +++ b/openedx/core/djangoapps/schedules/tests/test_tasks.py @@ -25,7 +25,7 @@ @skip_unless_lms @skipUnless('openedx.core.djangoapps.schedules.apps.SchedulesConfig' in settings.INSTALLED_APPS, "Can't test schedules if the app isn't installed") -class TestBinnedScheduleMessageBaseTask(CacheIsolationTestCase): # lint-amnesty, pylint: disable=missing-class-docstring +class TestBinnedScheduleMessageBaseTask(CacheIsolationTestCase): # pylint: disable=missing-class-docstring def setUp(self): super().setUp() diff --git a/openedx/core/djangoapps/schedules/tests/test_utils.py b/openedx/core/djangoapps/schedules/tests/test_utils.py index 2b48550b421d..2e0ee0b441c4 100644 --- a/openedx/core/djangoapps/schedules/tests/test_utils.py +++ b/openedx/core/djangoapps/schedules/tests/test_utils.py @@ -3,18 +3,18 @@ """ import datetime +from zoneinfo import ZoneInfo import ddt -from zoneinfo import ZoneInfo -from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase -from xmodule.modulestore.tests.factories import CourseFactory from common.djangoapps.course_modes.models import CourseMode +from common.djangoapps.student.tests.factories import CourseEnrollmentFactory from openedx.core.djangoapps.schedules.models import Schedule from openedx.core.djangoapps.schedules.tests.factories import ScheduleConfigFactory from openedx.core.djangoapps.schedules.utils import reset_self_paced_schedule from openedx.core.djangolib.testing.utils import skip_unless_lms -from common.djangoapps.student.tests.factories import CourseEnrollmentFactory +from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase +from xmodule.modulestore.tests.factories import CourseFactory @ddt.ddt diff --git a/openedx/core/djangoapps/schedules/utils.py b/openedx/core/djangoapps/schedules/utils.py index 344e7566b1e3..d2c35bedaf2f 100644 --- a/openedx/core/djangoapps/schedules/utils.py +++ b/openedx/core/djangoapps/schedules/utils.py @@ -1,9 +1,9 @@ -# lint-amnesty, pylint: disable=missing-module-docstring +# pylint: disable=missing-module-docstring import datetime import logging - from zoneinfo import ZoneInfo + from django.db import transaction from openedx.core.djangoapps.schedules.models import Schedule @@ -13,7 +13,7 @@ # TODO: consider using a LoggerAdapter instead of this mixin: # https://docs.python.org/2/library/logging.html#logging.LoggerAdapter -class PrefixedDebugLoggerMixin: # lint-amnesty, pylint: disable=missing-class-docstring +class PrefixedDebugLoggerMixin: # pylint: disable=missing-class-docstring log_prefix = None def __init__(self, *args, **kwargs): diff --git a/openedx/core/djangoapps/service_status/urls.py b/openedx/core/djangoapps/service_status/urls.py index ccbed2c22af4..ad3cff8104a6 100644 --- a/openedx/core/djangoapps/service_status/urls.py +++ b/openedx/core/djangoapps/service_status/urls.py @@ -2,6 +2,7 @@ Django URLs for service status app """ from django.urls import path + from openedx.core.djangoapps.service_status.views import celery_ping, celery_status, index urlpatterns = [ diff --git a/openedx/core/djangoapps/service_status/views.py b/openedx/core/djangoapps/service_status/views.py index fa14d32226d2..ef3a2dff3fb7 100644 --- a/openedx/core/djangoapps/service_status/views.py +++ b/openedx/core/djangoapps/service_status/views.py @@ -6,9 +6,10 @@ import json import time -from celery.exceptions import TimeoutError # lint-amnesty, pylint: disable=redefined-builtin -from django.http import HttpResponse from celery import current_app as celery +from celery.exceptions import TimeoutError # pylint: disable=redefined-builtin +from django.http import HttpResponse + from openedx.core.djangoapps.service_status.tasks import delayed_ping @@ -24,7 +25,7 @@ def celery_status(_): A view that returns Celery stats """ stats = celery.control.inspect().stats() or {} - return HttpResponse(json.dumps(stats, indent=4), # lint-amnesty, pylint: disable=http-response-with-content-type-json, http-response-with-json-dumps + return HttpResponse(json.dumps(stats, indent=4), # pylint: disable=http-response-with-content-type-json, http-response-with-json-dumps content_type="application/json") @@ -51,5 +52,5 @@ def celery_ping(_): 'time': time.time() - start, } - return HttpResponse(json.dumps(output, indent=4), # lint-amnesty, pylint: disable=http-response-with-content-type-json, http-response-with-json-dumps + return HttpResponse(json.dumps(output, indent=4), # pylint: disable=http-response-with-content-type-json, http-response-with-json-dumps content_type="application/json") diff --git a/openedx/core/djangoapps/session_inactivity_timeout/middleware.py b/openedx/core/djangoapps/session_inactivity_timeout/middleware.py index a84abc9e8ab3..9e02892378fd 100644 --- a/openedx/core/djangoapps/session_inactivity_timeout/middleware.py +++ b/openedx/core/djangoapps/session_inactivity_timeout/middleware.py @@ -13,15 +13,14 @@ """ -from datetime import datetime, timedelta import logging +from datetime import datetime, timedelta from django.conf import settings from django.contrib import auth from django.utils.deprecation import MiddlewareMixin from edx_django_utils import monitoring as monitoring_utils - log = logging.getLogger(__name__) LAST_TOUCH_KEYNAME = 'SessionInactivityTimeout:last_touch_str' diff --git a/openedx/core/djangoapps/session_inactivity_timeout/tests/test_middleware.py b/openedx/core/djangoapps/session_inactivity_timeout/tests/test_middleware.py index c47505a9836a..5152a46c51ca 100644 --- a/openedx/core/djangoapps/session_inactivity_timeout/tests/test_middleware.py +++ b/openedx/core/djangoapps/session_inactivity_timeout/tests/test_middleware.py @@ -3,7 +3,7 @@ """ from datetime import datetime, timedelta -from unittest.mock import patch, call, ANY +from unittest.mock import ANY, call, patch import ddt from django.contrib.auth.models import AnonymousUser @@ -11,13 +11,9 @@ from django.test import TestCase, override_settings from common.djangoapps.student.tests.factories import UserFactory +from openedx.core.djangoapps.session_inactivity_timeout.middleware import LAST_TOUCH_KEYNAME, SessionInactivityTimeout from openedx.core.djangolib.testing.utils import get_mock_request -from openedx.core.djangoapps.session_inactivity_timeout.middleware import ( - SessionInactivityTimeout, - LAST_TOUCH_KEYNAME, -) - @ddt.ddt class SessionInactivityTimeoutTestCase(TestCase): @@ -36,7 +32,7 @@ def setUp(self): def test_process_request_unauthenticated_user_does_nothing(self): self.request.user = AnonymousUser() - response = self.middleware.process_request(self.request) # lint-amnesty, pylint: disable=assignment-from-none + response = self.middleware.process_request(self.request) # pylint: disable=assignment-from-none assert response is None assert LAST_TOUCH_KEYNAME not in self.request.session @@ -60,7 +56,7 @@ def test_process_request_first_visit_sets_timestamp( mock_now = datetime(2025, 6, 16, 12, 0, 0) mock_datetime.utcnow.return_value = mock_now - response = self.middleware.process_request(self.request) # lint-amnesty, pylint: disable=assignment-from-none + response = self.middleware.process_request(self.request) # pylint: disable=assignment-from-none assert response is None assert self.request.session[LAST_TOUCH_KEYNAME] == mock_now.isoformat() @@ -85,7 +81,7 @@ def test_process_request_invalid_timestamp_handling( # The middleware should raise an exception when it tries to parse the invalid timestamp # in the save delay logic (after already catching it once in the timeout logic) - with self.assertRaises(ValueError): + with self.assertRaises(ValueError): # noqa: PT027 self.middleware.process_request(self.request) mock_log.warning.assert_called_once() @@ -115,7 +111,7 @@ def test_process_request_timeout_behavior( mock_datetime.utcnow.return_value = current_time mock_datetime.fromisoformat = datetime.fromisoformat - response = self.middleware.process_request(self.request) # lint-amnesty, pylint: disable=assignment-from-none + response = self.middleware.process_request(self.request) # pylint: disable=assignment-from-none assert response is None @@ -158,7 +154,7 @@ def test_process_request_save_behavior( mock_datetime.utcnow.return_value = current_time mock_datetime.fromisoformat = datetime.fromisoformat - response = self.middleware.process_request(self.request) # lint-amnesty, pylint: disable=assignment-from-none + response = self.middleware.process_request(self.request) # pylint: disable=assignment-from-none assert response is None assert self.request.user.is_authenticated @@ -198,7 +194,7 @@ def test_process_request_uses_default_save_frequency( mock_datetime.utcnow.return_value = current_time mock_datetime.fromisoformat = datetime.fromisoformat - response = self.middleware.process_request(self.request) # lint-amnesty, pylint: disable=assignment-from-none + response = self.middleware.process_request(self.request) # pylint: disable=assignment-from-none assert response is None diff --git a/openedx/core/djangoapps/site_configuration/context_processors.py b/openedx/core/djangoapps/site_configuration/context_processors.py index bbd9e4ee365b..9b222a965b6b 100644 --- a/openedx/core/djangoapps/site_configuration/context_processors.py +++ b/openedx/core/djangoapps/site_configuration/context_processors.py @@ -3,8 +3,9 @@ """ +from urllib.parse import quote_plus # pylint: disable=wrong-import-order + from django.conf import settings -from urllib.parse import quote_plus # lint-amnesty, pylint: disable=wrong-import-order from openedx.core.djangoapps.site_configuration import helpers as configuration_helpers diff --git a/openedx/core/djangoapps/site_configuration/helpers.py b/openedx/core/djangoapps/site_configuration/helpers.py index bee1d825ca32..4362f4002730 100644 --- a/openedx/core/djangoapps/site_configuration/helpers.py +++ b/openedx/core/djangoapps/site_configuration/helpers.py @@ -4,6 +4,7 @@ from django.conf import settings + from openedx.core.lib.cache_utils import request_cached @@ -116,7 +117,7 @@ def get_configuration_dict(name, default=None): return output -def get_value(val_name, default=None, **kwargs): # lint-amnesty, pylint: disable=unused-argument +def get_value(val_name, default=None, **kwargs): # pylint: disable=unused-argument """ Return configuration value for the key specified as name argument. diff --git a/openedx/core/djangoapps/site_configuration/management/commands/create_or_update_site_configuration.py b/openedx/core/djangoapps/site_configuration/management/commands/create_or_update_site_configuration.py index c97944b91012..b924f15fded6 100644 --- a/openedx/core/djangoapps/site_configuration/management/commands/create_or_update_site_configuration.py +++ b/openedx/core/djangoapps/site_configuration/management/commands/create_or_update_site_configuration.py @@ -100,7 +100,7 @@ def handle(self, *args, **options): site_configuration, created = SiteConfiguration.objects.get_or_create(site=site) if created: LOG.info( - "Site configuration does not exist. Created new instance for '{site_name}'".format( + "Site configuration does not exist. Created new instance for '{site_name}'".format( # noqa: UP032 site_name=site.domain ) ) diff --git a/openedx/core/djangoapps/site_configuration/management/commands/tests/test_create_or_update_site_configuration.py b/openedx/core/djangoapps/site_configuration/management/commands/tests/test_create_or_update_site_configuration.py index e572c3631f70..c33d706ceb7a 100644 --- a/openedx/core/djangoapps/site_configuration/management/commands/tests/test_create_or_update_site_configuration.py +++ b/openedx/core/djangoapps/site_configuration/management/commands/tests/test_create_or_update_site_configuration.py @@ -4,10 +4,11 @@ import codecs import json -import pytest + import ddt +import pytest from django.contrib.sites.models import Site -from django.core.management import call_command, CommandError +from django.core.management import CommandError, call_command from django.test import TestCase from path import Path @@ -148,7 +149,7 @@ def test_site_configuration_created_with_parameters(self): self.assert_site_configuration_does_not_exist() call_command(self.command, '--configuration', json.dumps(self.input_configuration), *self.site_id_arg) site_configuration = self.get_site_configuration() - self.assertDictEqual(site_configuration.site_values, self.input_configuration) + self.assertDictEqual(site_configuration.site_values, self.input_configuration) # noqa: PT009 def test_site_configuration_created_with_json_file_parameters(self): """ diff --git a/openedx/core/djangoapps/site_configuration/migrations/0001_initial.py b/openedx/core/djangoapps/site_configuration/migrations/0001_initial.py index f6b14a25ec10..e5e1b4a205ce 100644 --- a/openedx/core/djangoapps/site_configuration/migrations/0001_initial.py +++ b/openedx/core/djangoapps/site_configuration/migrations/0001_initial.py @@ -1,7 +1,7 @@ -from django.db import migrations, models import django.utils.timezone import jsonfield.fields import model_utils.fields +from django.db import migrations, models class Migration(migrations.Migration): diff --git a/openedx/core/djangoapps/site_configuration/migrations/0008_auto_20210910_0940.py b/openedx/core/djangoapps/site_configuration/migrations/0008_auto_20210910_0940.py index efcc616d8f24..4dc4ff9b32a4 100644 --- a/openedx/core/djangoapps/site_configuration/migrations/0008_auto_20210910_0940.py +++ b/openedx/core/djangoapps/site_configuration/migrations/0008_auto_20210910_0940.py @@ -1,8 +1,9 @@ # Generated by Django 2.2.24 on 2021-09-10 09:40 import collections -from django.db import migrations + import jsonfield.fields +from django.db import migrations class Migration(migrations.Migration): diff --git a/openedx/core/djangoapps/site_configuration/models.py b/openedx/core/djangoapps/site_configuration/models.py index c084b8ce4839..3bf23e851f73 100644 --- a/openedx/core/djangoapps/site_configuration/models.py +++ b/openedx/core/djangoapps/site_configuration/models.py @@ -10,7 +10,6 @@ from django.db import models from django.db.models.signals import post_save from django.dispatch import receiver - from jsonfield.fields import JSONField from model_utils.models import TimeStampedModel @@ -182,7 +181,7 @@ class Meta: def __str__(self): # pylint: disable=line-too-long - return "".format( # xss-lint: disable=python-wrap-html + return "".format( # xss-lint: disable=python-wrap-html # noqa: UP032 modified=self.modified, site=self.site, ) diff --git a/openedx/core/djangoapps/site_configuration/templatetags/configuration.py b/openedx/core/djangoapps/site_configuration/templatetags/configuration.py index 9de10d3bb07b..1d6a444d2ce2 100644 --- a/openedx/core/djangoapps/site_configuration/templatetags/configuration.py +++ b/openedx/core/djangoapps/site_configuration/templatetags/configuration.py @@ -9,8 +9,8 @@ from django.templatetags.static import static from lms.djangoapps.branding.api import get_favicon_url -from openedx.core.djangoapps.theming import helpers as theming_helpers from openedx.core.djangoapps.site_configuration import helpers as configuration_helpers +from openedx.core.djangoapps.theming import helpers as theming_helpers from openedx.core.djangolib.markup import HTML register = template.Library() # pylint: disable=invalid-name diff --git a/openedx/core/djangoapps/site_configuration/tests/factories.py b/openedx/core/djangoapps/site_configuration/tests/factories.py index df7d1eef706a..88c74cd49962 100644 --- a/openedx/core/djangoapps/site_configuration/tests/factories.py +++ b/openedx/core/djangoapps/site_configuration/tests/factories.py @@ -4,8 +4,8 @@ from django.contrib.sites.models import Site +from factory import SelfAttribute, Sequence, SubFactory, lazy_attribute from factory.django import DjangoModelFactory -from factory import SubFactory, Sequence, SelfAttribute, lazy_attribute from openedx.core.djangoapps.site_configuration.models import SiteConfiguration diff --git a/openedx/core/djangoapps/site_configuration/tests/test_context_processors.py b/openedx/core/djangoapps/site_configuration/tests/test_context_processors.py index 6c451d12c434..6e016b3ea47b 100644 --- a/openedx/core/djangoapps/site_configuration/tests/test_context_processors.py +++ b/openedx/core/djangoapps/site_configuration/tests/test_context_processors.py @@ -8,9 +8,8 @@ from django.test.utils import override_settings from openedx.core.djangoapps.site_configuration.context_processors import configuration_context -from openedx.core.djangoapps.site_configuration.tests.test_util import ( - with_site_configuration, -) +from openedx.core.djangoapps.site_configuration.tests.test_util import with_site_configuration + PLATFORM_NAME = 'Test Platform' diff --git a/openedx/core/djangoapps/site_configuration/tests/test_helpers.py b/openedx/core/djangoapps/site_configuration/tests/test_helpers.py index 1eaa5a1000b3..f957f770eab0 100644 --- a/openedx/core/djangoapps/site_configuration/tests/test_helpers.py +++ b/openedx/core/djangoapps/site_configuration/tests/test_helpers.py @@ -77,7 +77,7 @@ def test_get_dict(self): Test that get_dict returns correct value for any given key. """ # Make sure entry is saved and retrieved correctly - self.assertCountEqual( + self.assertCountEqual( # noqa: PT009 configuration_helpers.get_dict("REGISTRATION_EXTRA_FIELDS"), test_config['REGISTRATION_EXTRA_FIELDS'], ) @@ -87,7 +87,7 @@ def test_get_dict(self): expected.update(test_config['REGISTRATION_EXTRA_FIELDS']) # Test that the default value is returned if the value for the given key is not found in the configuration - self.assertCountEqual( + self.assertCountEqual( # noqa: PT009 configuration_helpers.get_dict("REGISTRATION_EXTRA_FIELDS", default), expected, ) @@ -125,7 +125,7 @@ def test_get_value_for_org(self): assert configuration_helpers.get_value_for_org(test_org, 'css_overrides_file') ==\ test_config['css_overrides_file'] - self.assertCountEqual( + self.assertCountEqual( # noqa: PT009 configuration_helpers.get_value_for_org(test_org, "REGISTRATION_EXTRA_FIELDS"), test_config['REGISTRATION_EXTRA_FIELDS'] ) @@ -155,7 +155,7 @@ def test_get_all_orgs(self): """ test_orgs = [test_config['course_org_filter']] with with_site_configuration_context(configuration=test_config): - self.assertCountEqual( + self.assertCountEqual( # noqa: PT009 list(configuration_helpers.get_all_orgs()), test_orgs, ) @@ -163,7 +163,7 @@ def test_get_all_orgs(self): @with_site_configuration(configuration=test_config_multi_org) def test_get_current_site_orgs(self): test_orgs = test_config_multi_org['course_org_filter'] - self.assertCountEqual( + self.assertCountEqual( # noqa: PT009 list(configuration_helpers.get_current_site_orgs()), test_orgs ) @@ -173,11 +173,11 @@ def test_get_current_site_configuration_values(self): Test get_current_site_configuration_values helper function """ site_values = configuration_helpers.get_current_site_configuration_values() - self.assertTrue(isinstance(site_values, dict)) + self.assertTrue(isinstance(site_values, dict)) # noqa: PT009 # without any site configuration it should return empty dict - self.assertEqual(site_values, {}) + self.assertEqual(site_values, {}) # noqa: PT009 with with_site_configuration_context(configuration=test_config): site_values = configuration_helpers.get_current_site_configuration_values() - self.assertEqual(site_values, test_config) + self.assertEqual(site_values, test_config) # noqa: PT009 diff --git a/openedx/core/djangoapps/site_configuration/tests/test_models.py b/openedx/core/djangoapps/site_configuration/tests/test_models.py index 22b82b63f578..a05a977c362c 100644 --- a/openedx/core/djangoapps/site_configuration/tests/test_models.py +++ b/openedx/core/djangoapps/site_configuration/tests/test_models.py @@ -2,14 +2,16 @@ Tests for site configuration's django models. """ from unittest.mock import patch + import pytest from django.contrib.sites.models import Site from django.db import IntegrityError, transaction from django.test import TestCase + from openedx.core.djangoapps.site_configuration.models import ( SiteConfiguration, SiteConfigurationHistory, - save_siteconfig_without_historical_record + save_siteconfig_without_historical_record, ) from openedx.core.djangoapps.site_configuration.tests.factories import SiteConfigurationFactory @@ -299,7 +301,7 @@ def test_get_all_orgs(self): ) # Test that the default value is returned if the value for the given key is not found in the configuration - self.assertCountEqual(SiteConfiguration.get_all_orgs(), expected_orgs) + self.assertCountEqual(SiteConfiguration.get_all_orgs(), expected_orgs) # noqa: PT009 def test_get_all_orgs_returns_only_enabled(self): """ @@ -318,4 +320,4 @@ def test_get_all_orgs_returns_only_enabled(self): ) # Test that the default value is returned if the value for the given key is not found in the configuration - self.assertCountEqual(SiteConfiguration.get_all_orgs(), expected_orgs) + self.assertCountEqual(SiteConfiguration.get_all_orgs(), expected_orgs) # noqa: PT009 diff --git a/openedx/core/djangoapps/site_configuration/tests/test_util.py b/openedx/core/djangoapps/site_configuration/tests/test_util.py index 489beca82a88..ba595f3669f9 100644 --- a/openedx/core/djangoapps/site_configuration/tests/test_util.py +++ b/openedx/core/djangoapps/site_configuration/tests/test_util.py @@ -3,9 +3,8 @@ """ -from functools import wraps import contextlib - +from functools import wraps from unittest.mock import patch from django.contrib.sites.models import Site diff --git a/openedx/core/djangoapps/system_wide_roles/migrations/0001_SystemWideRole_SystemWideRoleAssignment.py b/openedx/core/djangoapps/system_wide_roles/migrations/0001_SystemWideRole_SystemWideRoleAssignment.py index 3d051a624c75..e1fcfab2b658 100644 --- a/openedx/core/djangoapps/system_wide_roles/migrations/0001_SystemWideRole_SystemWideRoleAssignment.py +++ b/openedx/core/djangoapps/system_wide_roles/migrations/0001_SystemWideRole_SystemWideRoleAssignment.py @@ -1,11 +1,11 @@ # Generated by Django 1.11.22 on 2019-07-02 09:33 -from django.conf import settings -from django.db import migrations, models import django.db.models.deletion import django.utils.timezone import model_utils.fields +from django.conf import settings +from django.db import migrations, models class Migration(migrations.Migration): diff --git a/openedx/core/djangoapps/system_wide_roles/models.py b/openedx/core/djangoapps/system_wide_roles/models.py index 8ffff36d0121..4de05fec58d1 100644 --- a/openedx/core/djangoapps/system_wide_roles/models.py +++ b/openedx/core/djangoapps/system_wide_roles/models.py @@ -41,7 +41,7 @@ def __str__(self): str_representation = "" return str_representation.format( user=self.user.id, - role=self.role.name # lint-amnesty, pylint: disable=no-member + role=self.role.name # pylint: disable=no-member ) def __repr__(self): diff --git a/openedx/core/djangoapps/system_wide_roles/tests/test_models.py b/openedx/core/djangoapps/system_wide_roles/tests/test_models.py index eb77325fa99b..fd74d4ff2121 100644 --- a/openedx/core/djangoapps/system_wide_roles/tests/test_models.py +++ b/openedx/core/djangoapps/system_wide_roles/tests/test_models.py @@ -4,8 +4,8 @@ from django.test import TestCase -from common.djangoapps.student.tests.factories import UserFactory +from common.djangoapps.student.tests.factories import UserFactory from openedx.core.djangoapps.system_wide_roles.models import SystemWideRole, SystemWideRoleAssignment diff --git a/openedx/core/djangoapps/theming/apps.py b/openedx/core/djangoapps/theming/apps.py index 39301e23f3db..7750b938f8cd 100644 --- a/openedx/core/djangoapps/theming/apps.py +++ b/openedx/core/djangoapps/theming/apps.py @@ -1,4 +1,4 @@ -# lint-amnesty, pylint: disable=missing-module-docstring +# pylint: disable=missing-module-docstring from django.apps import AppConfig from edx_django_utils.plugins import PluginURLs @@ -8,7 +8,7 @@ plugin_urls_config = {PluginURLs.NAMESPACE: 'theming', PluginURLs.REGEX: r'^theming/'} -class ThemingConfig(AppConfig): # lint-amnesty, pylint: disable=missing-class-docstring +class ThemingConfig(AppConfig): # pylint: disable=missing-class-docstring name = 'openedx.core.djangoapps.theming' plugin_app = { PluginURLs.CONFIG: { @@ -20,4 +20,4 @@ class ThemingConfig(AppConfig): # lint-amnesty, pylint: disable=missing-class-d def ready(self): # settings validations related to theming. - from . import checks # lint-amnesty, pylint: disable=unused-import + from . import checks # pylint: disable=unused-import # noqa: F401 diff --git a/openedx/core/djangoapps/theming/checks.py b/openedx/core/djangoapps/theming/checks.py index 51cb5e92d1ef..c51ffb1c7ec7 100644 --- a/openedx/core/djangoapps/theming/checks.py +++ b/openedx/core/djangoapps/theming/checks.py @@ -11,7 +11,7 @@ @register(Tags.compatibility) -def check_comprehensive_theme_settings(app_configs, **kwargs): # lint-amnesty, pylint: disable=unused-argument +def check_comprehensive_theme_settings(app_configs, **kwargs): # pylint: disable=unused-argument """ Checks the comprehensive theming theme directory settings. diff --git a/openedx/core/djangoapps/theming/finders.py b/openedx/core/djangoapps/theming/finders.py index f75124efb177..d0a67c6ff048 100644 --- a/openedx/core/djangoapps/theming/finders.py +++ b/openedx/core/djangoapps/theming/finders.py @@ -29,7 +29,7 @@ from openedx.core.djangoapps.theming.storage import ThemeStorage -class ThemeFilesFinder(BaseFinder): # lint-amnesty, pylint: disable=abstract-method +class ThemeFilesFinder(BaseFinder): # pylint: disable=abstract-method """ A static files finder that looks in the directory of each theme as specified in the source_dir attribute. diff --git a/openedx/core/djangoapps/theming/helpers.py b/openedx/core/djangoapps/theming/helpers.py index b88bbdca4382..e38772a7458c 100644 --- a/openedx/core/djangoapps/theming/helpers.py +++ b/openedx/core/djangoapps/theming/helpers.py @@ -8,28 +8,28 @@ import os import re +from functools import lru_cache from logging import getLogger import crum from django.conf import settings - from edx_toggles.toggles import SettingToggle + from openedx.core.djangoapps.site_configuration import helpers as configuration_helpers from openedx.core.djangoapps.theming.helpers_dirs import ( Theme, get_project_root_name_from_settings, get_theme_base_dirs_from_settings, get_theme_dirs, - get_themes_unchecked + get_themes_unchecked, ) from openedx.core.lib.cache_utils import request_cached -from functools import lru_cache logger = getLogger(__name__) # pylint: disable=invalid-name @request_cached() -def get_template_path(relative_path, **kwargs): # lint-amnesty, pylint: disable=unused-argument +def get_template_path(relative_path, **kwargs): # pylint: disable=unused-argument """ The calculated value is cached for the lifetime of the current request. """ @@ -240,7 +240,7 @@ def get_theme_base_dir(theme_dir_name, suppress_error=False): return None raise ValueError( - "Theme '{theme}' not found in any of the following themes dirs, \nTheme dirs: \n{dir}".format( + "Theme '{theme}' not found in any of the following themes dirs, \nTheme dirs: \n{dir}".format( # noqa: UP032 theme=theme_dir_name, dir=get_theme_base_dirs(), )) diff --git a/openedx/core/djangoapps/theming/helpers_dirs.py b/openedx/core/djangoapps/theming/helpers_dirs.py index 9e40749e50c0..3f7fc22c185d 100644 --- a/openedx/core/djangoapps/theming/helpers_dirs.py +++ b/openedx/core/djangoapps/theming/helpers_dirs.py @@ -5,9 +5,9 @@ import os +from functools import lru_cache from path import Path -from functools import lru_cache def get_theme_base_dirs_from_settings(theme_base_dirs=None): diff --git a/openedx/core/djangoapps/theming/helpers_static.py b/openedx/core/djangoapps/theming/helpers_static.py index 5cdb6ffc600e..6db795a6e526 100644 --- a/openedx/core/djangoapps/theming/helpers_static.py +++ b/openedx/core/djangoapps/theming/helpers_static.py @@ -1,4 +1,4 @@ -# lint-amnesty, pylint: disable=missing-module-docstring +# pylint: disable=missing-module-docstring from django.contrib.staticfiles.storage import staticfiles_storage diff --git a/openedx/core/djangoapps/theming/management/commands/create_sites_and_configurations.py b/openedx/core/djangoapps/theming/management/commands/create_sites_and_configurations.py index 9f9e7661395b..a1cc8cb1b948 100644 --- a/openedx/core/djangoapps/theming/management/commands/create_sites_and_configurations.py +++ b/openedx/core/djangoapps/theming/management/commands/create_sites_and_configurations.py @@ -9,16 +9,16 @@ import os from textwrap import dedent -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.contrib.sites.models import Site from django.core.management.base import BaseCommand from oauth2_provider.models import Application +from common.djangoapps.student.models import UserProfile from lms.djangoapps.commerce.models import CommerceConfiguration from openedx.core.djangoapps.oauth_dispatch.models import ApplicationAccess from openedx.core.djangoapps.site_configuration.models import SiteConfiguration from openedx.core.djangoapps.theming.models import SiteTheme -from common.djangoapps.student.models import UserProfile LOG = logging.getLogger(__name__) @@ -78,11 +78,11 @@ def _create_oauth2_client(self, url, site_name, service_name, service_user): client_id=client_id, defaults={ "user": service_user, - "name": "{service_name}-sso-{site_name}".format( + "name": "{service_name}-sso-{site_name}".format( # noqa: UP032 site_name=site_name, service_name=service_name, ), - "client_secret": "{service_name}-secret".format( + "client_secret": "{service_name}-secret".format( # noqa: UP032 service_name=service_name ), "client_type": Application.CLIENT_CONFIDENTIAL, @@ -126,7 +126,7 @@ def find(self, pattern, path): Matched the given pattern in given path and returns the list of matching files """ result = [] - for root, dirs, files in os.walk(path): # pylint: disable=unused-variable + for root, dirs, files in os.walk(path): # pylint: disable=unused-variable # noqa: B007 for name in files: if fnmatch.fnmatch(name, pattern): result.append(os.path.join(root, name)) @@ -213,21 +213,21 @@ def handle(self, *args, **options): if options['devstack']: configuration_prefix = "devstack" - self.discovery_oauth_complete_url = "http://discovery-{}.e2e.devstack:18381/complete/edx-oauth2/".format( + self.discovery_oauth_complete_url = "http://discovery-{}.e2e.devstack:18381/complete/edx-oauth2/".format( # noqa: UP032 # pylint: disable=line-too-long self.dns_name ) self.discovery_base_url_fmt = "http://discovery-{site_domain}:18381/" - self.ecommerce_oauth_complete_url = "http://ecommerce-{}.e2e.devstack:18130/complete/edx-oauth2/".format( + self.ecommerce_oauth_complete_url = "http://ecommerce-{}.e2e.devstack:18130/complete/edx-oauth2/".format( # noqa: UP032 # pylint: disable=line-too-long self.dns_name ) self.ecommerce_base_url_fmt = "http://ecommerce-{site_domain}:18130/" else: configuration_prefix = "sandbox" - self.discovery_oauth_complete_url = "https://discovery-{}.sandbox.edx.org/complete/edx-oauth2/".format( + self.discovery_oauth_complete_url = "https://discovery-{}.sandbox.edx.org/complete/edx-oauth2/".format( # noqa: UP032 # pylint: disable=line-too-long self.dns_name ) self.discovery_base_url_fmt = "https://discovery-{site_domain}/" - self.ecommerce_oauth_complete_url = "https://ecommerce-{}.sandbox.edx.org/complete/edx-oauth2/".format( + self.ecommerce_oauth_complete_url = "https://ecommerce-{}.sandbox.edx.org/complete/edx-oauth2/".format( # noqa: UP032 # pylint: disable=line-too-long self.dns_name ) self.ecommerce_base_url_fmt = "https://ecommerce-{site_domain}/" diff --git a/openedx/core/djangoapps/theming/management/commands/tests/test_create_sites_and_configurations.py b/openedx/core/djangoapps/theming/management/commands/tests/test_create_sites_and_configurations.py index 601aa6cc0c0f..56215d1de150 100644 --- a/openedx/core/djangoapps/theming/management/commands/tests/test_create_sites_and_configurations.py +++ b/openedx/core/djangoapps/theming/management/commands/tests/test_create_sites_and_configurations.py @@ -3,16 +3,17 @@ """ from unittest import mock + import pytest -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.contrib.sites.models import Site from django.core.management import CommandError, call_command from django.test import TestCase - from oauth2_provider.models import Application + +from common.djangoapps.student.models import UserProfile from openedx.core.djangoapps.oauth_dispatch.models import ApplicationAccess from openedx.core.djangoapps.theming.models import SiteTheme -from common.djangoapps.student.models import UserProfile SITES = ["site_a", "site_b"] MANAGEMENT_COMMAND_PATH = "openedx.core.djangoapps.theming.management.commands.create_sites_and_configurations." @@ -71,12 +72,12 @@ def _assert_sites_are_valid(self): assert site_theme.theme_dir_name == f'{site.name}_dir_name' - self.assertDictEqual( + self.assertDictEqual( # noqa: PT009 dict(site.configuration.values), _generate_site_config(self.dns_name, site.name) ) - def _assert_service_user_is_valid(self, username): # lint-amnesty, pylint: disable=missing-function-docstring + def _assert_service_user_is_valid(self, username): # pylint: disable=missing-function-docstring service_user = User.objects.filter(username=username) assert len(service_user) == 1 assert service_user[0].is_active diff --git a/openedx/core/djangoapps/theming/storage.py b/openedx/core/djangoapps/theming/storage.py index 4a48cbb6e0a5..1f92066d21d5 100644 --- a/openedx/core/djangoapps/theming/storage.py +++ b/openedx/core/djangoapps/theming/storage.py @@ -7,8 +7,8 @@ import os.path import posixpath import re - from urllib.parse import unquote, urldefrag, urlsplit # pylint: disable=import-error + from django.conf import settings from django.contrib.staticfiles.finders import find from django.contrib.staticfiles.storage import ManifestFilesMixin, StaticFilesStorage @@ -20,7 +20,7 @@ get_project_root_name, get_theme_base_dir, get_themes, - is_comprehensive_theming_enabled + is_comprehensive_theming_enabled, ) diff --git a/openedx/core/djangoapps/theming/template_loaders.py b/openedx/core/djangoapps/theming/template_loaders.py index 760f1dd1adb8..07960567cb41 100644 --- a/openedx/core/djangoapps/theming/template_loaders.py +++ b/openedx/core/djangoapps/theming/template_loaders.py @@ -17,7 +17,7 @@ class ThemeTemplateLoader(MakoLoader): _accepts_engine_in_init = True def __init__(self, *args): - MakoLoader.__init__(self, ThemeFilesystemLoader(*args)) # lint-amnesty, pylint: disable=no-value-for-parameter + MakoLoader.__init__(self, ThemeFilesystemLoader(*args)) # pylint: disable=no-value-for-parameter class ThemeFilesystemLoader(FilesystemLoader): diff --git a/openedx/core/djangoapps/theming/templatetags/optional_include.py b/openedx/core/djangoapps/theming/templatetags/optional_include.py index e559568dc8ef..fb09041c517f 100644 --- a/openedx/core/djangoapps/theming/templatetags/optional_include.py +++ b/openedx/core/djangoapps/theming/templatetags/optional_include.py @@ -46,7 +46,7 @@ def do_include(parser, token): """ bits = token.split_contents() if len(bits) < 2: - msg = ( + msg = ( # noqa: UP031 "%r tag takes at least one argument: the name of the template " "to be optionally included." ) % bits[0] @@ -56,17 +56,17 @@ def do_include(parser, token): while remaining_bits: option = remaining_bits.pop(0) if option in options: - raise TemplateSyntaxError('The %r option was specified more ' + raise TemplateSyntaxError('The %r option was specified more ' # noqa: UP031 'than once.' % option) if option == 'with': value = token_kwargs(remaining_bits, parser, support_legacy=False) if not value: - raise TemplateSyntaxError('"with" in %r tag needs at least ' + raise TemplateSyntaxError('"with" in %r tag needs at least ' # noqa: UP031 'one keyword argument.' % bits[0]) elif option == 'only': value = True else: - raise TemplateSyntaxError('Unknown argument for %r tag: %r.' % + raise TemplateSyntaxError('Unknown argument for %r tag: %r.' % # noqa: UP031 (bits[0], option)) options[option] = value isolated_context = options.get('only', False) diff --git a/openedx/core/djangoapps/theming/templatetags/theme_pipeline.py b/openedx/core/djangoapps/theming/templatetags/theme_pipeline.py index 804a7a857b87..97ede06d8e31 100644 --- a/openedx/core/djangoapps/theming/templatetags/theme_pipeline.py +++ b/openedx/core/djangoapps/theming/templatetags/theme_pipeline.py @@ -56,8 +56,8 @@ def stylesheet(parser, token): # pylint: disable=unused-argument try: _, name = token.split_contents() except ValueError: - raise template.TemplateSyntaxError( # lint-amnesty, pylint: disable=raise-missing-from - '%r requires exactly one argument: the name of a group in the PIPELINE["STYLESHEETS"] setting' % + raise template.TemplateSyntaxError( # pylint: disable=raise-missing-from # noqa: B904 + '%r requires exactly one argument: the name of a group in the PIPELINE["STYLESHEETS"] setting' % # noqa: UP031 # pylint: disable=line-too-long token.split_contents()[0] ) return ThemeStylesheetNode(name) @@ -71,8 +71,8 @@ def javascript(parser, token): # pylint: disable=unused-argument try: _, name = token.split_contents() except ValueError: - raise template.TemplateSyntaxError( # lint-amnesty, pylint: disable=raise-missing-from - '%r requires exactly one argument: the name of a group in the PIPELINE["JAVASCRIPT"] setting' % + raise template.TemplateSyntaxError( # pylint: disable=raise-missing-from # noqa: B904 + '%r requires exactly one argument: the name of a group in the PIPELINE["JAVASCRIPT"] setting' % # noqa: UP031 # pylint: disable=line-too-long token.split_contents()[0] ) return ThemeJavascriptNode(name) diff --git a/openedx/core/djangoapps/theming/tests/test_helpers.py b/openedx/core/djangoapps/theming/tests/test_helpers.py index 95829a16b416..1db0b76a6a4e 100644 --- a/openedx/core/djangoapps/theming/tests/test_helpers.py +++ b/openedx/core/djangoapps/theming/tests/test_helpers.py @@ -4,6 +4,7 @@ from unittest.mock import Mock, patch + from django.conf import settings from django.test import TestCase, override_settings @@ -14,7 +15,7 @@ get_template_path_with_theme, get_theme_base_dir, get_themes, - strip_site_theme_templates_path + strip_site_theme_templates_path, ) from openedx.core.djangoapps.theming.helpers_dirs import get_theme_dirs from openedx.core.djangoapps.theming.tests.test_util import with_comprehensive_theme @@ -47,7 +48,7 @@ def test_get_themes(self): Theme('empty-theme', 'empty-theme', get_theme_base_dir('empty-theme'), settings.PROJECT_ROOT), ] actual_themes = get_themes() - self.assertCountEqual(expected_themes, actual_themes) + self.assertCountEqual(expected_themes, actual_themes) # noqa: PT009 @override_settings(COMPREHENSIVE_THEME_DIRS=[settings.TEST_THEME.dirname()]) def test_get_themes_2(self): @@ -58,7 +59,7 @@ def test_get_themes_2(self): Theme('test-theme', 'test-theme', get_theme_base_dir('test-theme'), settings.PROJECT_ROOT), ] actual_themes = get_themes() - self.assertCountEqual(expected_themes, actual_themes) + self.assertCountEqual(expected_themes, actual_themes) # noqa: PT009 def test_get_value_returns_override(self): """ diff --git a/openedx/core/djangoapps/theming/tests/test_middleware.py b/openedx/core/djangoapps/theming/tests/test_middleware.py index 2f69a6cc72be..14bee0682534 100644 --- a/openedx/core/djangoapps/theming/tests/test_middleware.py +++ b/openedx/core/djangoapps/theming/tests/test_middleware.py @@ -7,8 +7,8 @@ from django.contrib.sites.models import Site from django.test import RequestFactory, TestCase, override_settings -from openedx.core.djangoapps.theming.middleware import CurrentSiteThemeMiddleware from common.djangoapps.student.tests.factories import UserFactory +from openedx.core.djangoapps.theming.middleware import CurrentSiteThemeMiddleware from ..views import set_user_preview_site_theme @@ -59,8 +59,8 @@ def test_default_site_theme(self): """ request = self.create_mock_get_request() assert self.site_theme_middleware.process_request(request) is None - assert request.site_theme is not None # lint-amnesty, pylint: disable=no-member - assert request.site_theme.theme_dir_name == TEST_THEME_NAME # lint-amnesty, pylint: disable=no-member + assert request.site_theme is not None # pylint: disable=no-member + assert request.site_theme.theme_dir_name == TEST_THEME_NAME # pylint: disable=no-member @override_settings(DEFAULT_SITE_THEME=None) def test_default_site_theme_2(self): @@ -70,7 +70,7 @@ def test_default_site_theme_2(self): """ request = self.create_mock_get_request() assert self.site_theme_middleware.process_request(request) is None - assert request.site_theme is None # lint-amnesty, pylint: disable=no-member + assert request.site_theme is None # pylint: disable=no-member def test_preview_theme(self): """ @@ -84,7 +84,7 @@ def test_preview_theme(self): # Next request a page and verify that the theme is returned get_request = self.create_mock_get_request() assert self.site_theme_middleware.process_request(get_request) is None - assert get_request.site_theme.theme_dir_name == TEST_THEME_NAME # lint-amnesty, pylint: disable=no-member + assert get_request.site_theme.theme_dir_name == TEST_THEME_NAME # pylint: disable=no-member # Request to reset the theme post_request = RequestFactory().post('/test') @@ -94,9 +94,9 @@ def test_preview_theme(self): # Verify that no theme is returned now get_request = self.create_mock_get_request() assert self.site_theme_middleware.process_request(get_request) is None - assert get_request.site_theme is None # lint-amnesty, pylint: disable=no-member + assert get_request.site_theme is None # pylint: disable=no-member # Verify that we can still force the theme with a querystring arg get_request = self.create_mock_get_request(qs_theme=TEST_THEME_NAME) assert self.site_theme_middleware.process_request(get_request) is None - assert get_request.site_theme.theme_dir_name == TEST_THEME_NAME # lint-amnesty, pylint: disable=no-member + assert get_request.site_theme.theme_dir_name == TEST_THEME_NAME # pylint: disable=no-member diff --git a/openedx/core/djangoapps/theming/tests/test_theme_style_overrides.py b/openedx/core/djangoapps/theming/tests/test_theme_style_overrides.py index 41f91c7d1eb5..c6945726ad06 100644 --- a/openedx/core/djangoapps/theming/tests/test_theme_style_overrides.py +++ b/openedx/core/djangoapps/theming/tests/test_theme_style_overrides.py @@ -8,9 +8,9 @@ from django.test import TestCase from django.urls import reverse -from openedx.core.djangoapps.theming.tests.test_util import with_comprehensive_theme -from openedx.core.djangolib.testing.utils import skip_unless_lms # lint-amnesty, pylint: disable=unused-import from common.djangoapps.student.tests.factories import UserFactory +from openedx.core.djangoapps.theming.tests.test_util import with_comprehensive_theme +from openedx.core.djangolib.testing.utils import skip_unless_lms # pylint: disable=unused-import @skip_unless_lms diff --git a/openedx/core/djangoapps/theming/tests/test_util.py b/openedx/core/djangoapps/theming/tests/test_util.py index 2591c661ac9e..809c14465487 100644 --- a/openedx/core/djangoapps/theming/tests/test_util.py +++ b/openedx/core/djangoapps/theming/tests/test_util.py @@ -77,4 +77,4 @@ def dump_theming_info(): continue with open(os.path.join(dirname, filename)) as f: content = len(f.read()) - print(" %s: %d" % (filename, content)) + print(" %s: %d" % (filename, content)) # noqa: UP031 diff --git a/openedx/core/djangoapps/theming/tests/test_views.py b/openedx/core/djangoapps/theming/tests/test_views.py index d4a990d11f54..992bf92db249 100644 --- a/openedx/core/djangoapps/theming/tests/test_views.py +++ b/openedx/core/djangoapps/theming/tests/test_views.py @@ -31,7 +31,7 @@ def test_preview_theme_access(self): expected_target_status_code = 200 if settings.ROOT_URLCONF == 'lms.urls' else 302 self.assertRedirects( response, - '{login_url}?next={url}'.format( + '{login_url}?next={url}'.format( # noqa: UP032 login_url=settings.LOGIN_URL, url=THEMING_ADMIN_URL, ), diff --git a/openedx/core/djangoapps/theming/urls.py b/openedx/core/djangoapps/theming/urls.py index 375c3621e534..d9a45a5fb4aa 100644 --- a/openedx/core/djangoapps/theming/urls.py +++ b/openedx/core/djangoapps/theming/urls.py @@ -3,8 +3,7 @@ """ from django.urls import path -from . import helpers -from . import views +from . import helpers, views app_name = "openedx.core.djangoapps.theming" diff --git a/openedx/core/djangoapps/theming/views.py b/openedx/core/djangoapps/theming/views.py index 966f37eca0db..e93825211449 100644 --- a/openedx/core/djangoapps/theming/views.py +++ b/openedx/core/djangoapps/theming/views.py @@ -12,14 +12,14 @@ from django.utils.translation import gettext as _ from web_fragments.fragment import Fragment +from common.djangoapps.student.roles import GlobalStaff from openedx.core.djangoapps.plugin_api.views import EdxFragmentView from openedx.core.djangoapps.user_api.preferences.api import ( delete_user_preference, get_user_preference, - set_user_preference + set_user_preference, ) from openedx.core.djangoapps.util.user_messages import PageLevelMessages -from common.djangoapps.student.roles import GlobalStaff from .helpers import theme_exists from .helpers_static import get_static_file_url @@ -92,7 +92,7 @@ class ThemingAdministrationFragmentView(EdxFragmentView): Fragment view to allow a user to administer theming. """ - def render_to_fragment(self, request, course_id=None, **kwargs): # lint-amnesty, pylint: disable=arguments-differ, unused-argument + def render_to_fragment(self, request, course_id=None, **kwargs): # pylint: disable=arguments-differ, unused-argument """ Renders the theming administration view as a fragment. """ @@ -109,7 +109,7 @@ def get(self, request, *args, **kwargs): return super().get(request, *args, **kwargs) @method_decorator(login_required) - def post(self, request, **kwargs): # lint-amnesty, pylint: disable=unused-argument + def post(self, request, **kwargs): # pylint: disable=unused-argument """ Accept requests to update the theme preview. """ diff --git a/openedx/core/djangoapps/user_api/accounts/__init__.py b/openedx/core/djangoapps/user_api/accounts/__init__.py index faed01a6bb8d..e80aabe4169d 100644 --- a/openedx/core/djangoapps/user_api/accounts/__init__.py +++ b/openedx/core/djangoapps/user_api/accounts/__init__.py @@ -6,6 +6,9 @@ from django.utils.text import format_lazy from django.utils.translation import gettext_lazy as _ +# Import signals to ensure they are registered +from . import signals # noqa: F401, pylint: disable=unused-import + # The maximum length for the bio ("about me") account field BIO_MAX_LENGTH = 300 diff --git a/openedx/core/djangoapps/user_api/accounts/api.py b/openedx/core/djangoapps/user_api/accounts/api.py index c3fd805a3166..49f0085e6192 100644 --- a/openedx/core/djangoapps/user_api/accounts/api.py +++ b/openedx/core/djangoapps/user_api/accounts/api.py @@ -4,15 +4,19 @@ """ import datetime +import logging import re +from zoneinfo import ZoneInfo +from django import forms from django.conf import settings from django.core.exceptions import ObjectDoesNotExist from django.core.validators import ValidationError, validate_email +from django.db import DatabaseError, IntegrityError, transaction from django.utils.translation import gettext as _ from django.utils.translation import override as override_language from eventtracking import tracker -from zoneinfo import ZoneInfo +from openedx_filters.learning.filters import AccountSettingsReadOnlyFieldsRequested from common.djangoapps.student import views as student_views from common.djangoapps.student.models import ( @@ -20,7 +24,7 @@ User, UserProfile, email_exists_or_retired, - username_exists_or_retired + username_exists_or_retired, ) from common.djangoapps.util.model_utils import emit_settings_changed_event from common.djangoapps.util.password_policy_validators import validate_password @@ -32,15 +36,15 @@ from openedx.core.djangoapps.user_api.errors import ( AccountUpdateError, AccountValidationError, - PreferenceValidationError + PreferenceValidationError, ) from openedx.core.djangoapps.user_api.preferences.api import update_user_preferences from openedx.core.djangoapps.user_authn.utils import check_pwned_password from openedx.core.djangoapps.user_authn.views.registration_form import validate_name, validate_username from openedx.core.lib.api.view_utils import add_serializer_errors -from openedx.features.enterprise_support.utils import get_enterprise_readonly_account_fields from openedx.features.name_affirmation_api.utils import is_name_affirmation_installed +from .forms import validate_and_get_extended_profile_form from .serializers import AccountLegacyProfileSerializer, AccountUserSerializer, UserReadOnlySerializer, _visible_fields name_affirmation_installed = is_name_affirmation_installed() @@ -48,6 +52,8 @@ # pylint: disable=import-error from edx_name_affirmation.name_change_validator import NameChangeValidator +logger = logging.getLogger(__name__) + # Public access point for this function. visible_fields = _visible_fields @@ -165,6 +171,12 @@ def update_account_settings(requesting_user, update, username=None): old_name = _validate_name_change(user_profile, update, field_errors) old_language_proficiencies = _get_old_language_proficiencies_if_updating(user_profile, update) + extended_profile_data = update.get("extended_profile") if "extended_profile" in update else None + extended_profile_form = None + if extended_profile_data is not None: + extended_profile_form, ext_profile_errors = validate_and_get_extended_profile_form(extended_profile_data, user) + field_errors.update(ext_profile_errors) + if field_errors: raise errors.AccountValidationError(field_errors) @@ -176,15 +188,15 @@ def update_account_settings(requesting_user, update, username=None): _update_preferences_if_needed(update, requesting_user, user) _notify_language_proficiencies_update_if_needed(update, user, user_profile, old_language_proficiencies) _store_old_name_if_needed(old_name, user_profile, requesting_user) - _update_extended_profile_if_needed(update, user_profile) + _update_extended_profile_if_needed(update, user_profile, extended_profile_form) _update_state_if_needed(update, user_profile) except PreferenceValidationError as err: - raise AccountValidationError(err.preference_errors) # lint-amnesty, pylint: disable=raise-missing-from + raise AccountValidationError(err.preference_errors) # pylint: disable=raise-missing-from # noqa: B904 except (AccountUpdateError, AccountValidationError) as err: raise err except Exception as err: - raise AccountUpdateError( # lint-amnesty, pylint: disable=raise-missing-from + raise AccountUpdateError( # pylint: disable=raise-missing-from # noqa: B904 f"Error thrown when saving account updates: '{str(err)}'" ) @@ -193,11 +205,17 @@ def update_account_settings(requesting_user, update, username=None): def _validate_read_only_fields(user, data, field_errors): # Check for fields that are not editable. Marking them read-only causes them to be ignored, but we wish to 400. + plugin_readonly_fields, __ = AccountSettingsReadOnlyFieldsRequested.run_filter( + readonly_fields=set(), + user=user, + ) + plugin_readonly_fields = plugin_readonly_fields or set() + read_only_fields = set(data.keys()).intersection( # Remove email since it is handled separately below when checking for changing_email. (set(AccountUserSerializer.get_read_only_fields()) - {"email"}) | set(AccountLegacyProfileSerializer.get_read_only_fields() or set()) | - get_enterprise_readonly_account_fields(user) + plugin_readonly_fields ) for read_only_field in read_only_fields: @@ -346,17 +364,81 @@ def _notify_language_proficiencies_update_if_needed(data, user, user_profile, ol ) -def _update_extended_profile_if_needed(data, user_profile): - if 'extended_profile' in data: - meta = user_profile.get_meta() - new_extended_profile = data['extended_profile'] - for field in new_extended_profile: - field_name = field['field_name'] - new_value = field['field_value'] - meta[field_name] = new_value - user_profile.set_meta(meta) - user_profile.save() +def _update_extended_profile_if_needed( + data: dict, user_profile: UserProfile, extended_profile_form: forms.Form | None +) -> None: + """ + Update the extended profile information if present in the data. + + This function handles two types of extended profile updates: + 1. Updates the user profile meta fields with extended_profile data + 2. Saves the extended profile form data to the extended profile model if a validated form is provided + Args: + data (dict): Dictionary containing the update data, may include 'extended_profile' key + user_profile (UserProfile): The UserProfile instance to update + extended_profile_form (forms.Form | None): The validated extended profile form + containing extended profile data, or None if no extended profile form is provided + + Note: + If `extended_profile` is present in data, the function will: + - Extract `field_name` and `field_value` pairs from extended_profile list + - Update the `user_profile.meta` dictionary with new values and save the profile + + If `extended_profile_form` is provided and valid, the function will: + - Save the form data to the extended profile model + - Associate the model instance with the user if it's a new instance + + Both the meta update and the extended profile model save (when present) are performed + within a single database transaction. If either operation fails, the transaction is + rolled back so that no partial updates are persisted. The error is logged and an + AccountUpdateError is raised to the caller. + """ + has_extended_profile_data = "extended_profile" in data + has_extended_profile_form = extended_profile_form is not None + + if not has_extended_profile_data and not has_extended_profile_form: + return + + try: + with transaction.atomic(): + if has_extended_profile_data: + meta = user_profile.get_meta() + new_extended_profile = data["extended_profile"] + for field in new_extended_profile: + field_name = field["field_name"] + new_value = field["field_value"] + meta[field_name] = new_value + user_profile.set_meta(meta) + user_profile.save() + + if has_extended_profile_form: + # Use commit=False to create the model instance in memory without saving to DB yet. + # This allows us to set the user field before persisting, which is necessary because: + # 1. The form validates and creates the instance with form data + # 2. For new profiles, the user field isn't in the form data + # 3. We need to assign the user programmatically before the database save + # 4. If we called save() directly, it would fail with integrity errors for new profiles + extended_profile = extended_profile_form.save(commit=False) + if not hasattr(extended_profile, "user") or extended_profile.user is None: + extended_profile.user = user_profile.user + # Now persist the instance with the user field properly set + extended_profile.save() + except ValidationError as exc: + raise AccountUpdateError( + developer_message=f"Extended profile validation failed: {str(exc)}", + user_message=_("The extended profile information could not be saved due to validation errors."), + ) from exc + except IntegrityError as exc: + raise AccountUpdateError( + developer_message=f"Extended profile integrity error: {str(exc)}", + user_message=_("The extended profile information could not be saved. Please check for duplicate values."), + ) from exc + except DatabaseError as exc: + raise AccountUpdateError( + developer_message=f"Database error saving extended profile: {str(exc)}", + user_message=_("The extended profile information could not be saved due to a system error."), + ) from exc def _update_state_if_needed(data, user_profile): # If the country was changed to something other than US, remove the state. @@ -387,7 +469,7 @@ def _send_email_change_requests_if_needed(data, user): try: student_views.do_email_change_request(user, new_email) except ValueError as err: - raise AccountUpdateError( # lint-amnesty, pylint: disable=raise-missing-from + raise AccountUpdateError( # pylint: disable=raise-missing-from # noqa: B904 f"Error thrown from do_email_change_request: '{str(err)}'", user_message=str(err) ) @@ -401,7 +483,7 @@ def _send_email_change_requests_if_needed(data, user): secondary_email_change_request=True, ) except ValueError as err: - raise AccountUpdateError( # lint-amnesty, pylint: disable=raise-missing-from + raise AccountUpdateError( # pylint: disable=raise-missing-from # noqa: B904 f"Error thrown from do_email_change_request: '{str(err)}'", user_message=str(err) ) @@ -563,7 +645,7 @@ def _get_user_and_profile(username): try: existing_user = User.objects.get(username=username) except ObjectDoesNotExist: - raise errors.UserNotFound() # lint-amnesty, pylint: disable=raise-missing-from + raise errors.UserNotFound() # pylint: disable=raise-missing-from # noqa: B904 existing_user_profile, _ = UserProfile.objects.get_or_create(user=existing_user) @@ -615,9 +697,9 @@ def _validate_username(username): # message by convention. validate_username(username) except (UnicodeError, errors.AccountDataBadType, errors.AccountDataBadLength) as username_err: - raise errors.AccountUsernameInvalid(str(username_err)) + raise errors.AccountUsernameInvalid(str(username_err)) # noqa: B904 except ValidationError as validation_err: - raise errors.AccountUsernameInvalid(validation_err.message) + raise errors.AccountUsernameInvalid(validation_err.message) # noqa: B904 def _validate_email(email): @@ -640,9 +722,9 @@ def _validate_email(email): validate_email.message = accounts.AUTHN_EMAIL_INVALID_MSG validate_email(email) except (UnicodeError, errors.AccountDataBadType, errors.AccountDataBadLength) as invalid_email_err: - raise errors.AccountEmailInvalid(str(invalid_email_err)) + raise errors.AccountEmailInvalid(str(invalid_email_err)) # noqa: B904 except ValidationError as validation_err: - raise errors.AccountEmailInvalid(validation_err.message) + raise errors.AccountEmailInvalid(validation_err.message) # noqa: B904 def _validate_confirm_email(confirm_email, email): @@ -682,9 +764,9 @@ def _validate_password(password, username=None, email=None, reset_password_page= temp_user = User(username=username, email=email) if username else None validate_password(password, user=temp_user) except errors.AccountDataBadType as invalid_password_err: - raise errors.AccountPasswordInvalid(str(invalid_password_err)) + raise errors.AccountPasswordInvalid(str(invalid_password_err)) # noqa: B904 except ValidationError as validation_err: - raise errors.AccountPasswordInvalid(' '.join(validation_err.messages)) + raise errors.AccountPasswordInvalid(' '.join(validation_err.messages)) # noqa: B904 if ( (settings.ENABLE_AUTHN_RESET_PASSWORD_HIBP_POLICY and reset_password_page) or @@ -709,7 +791,7 @@ def _validate_country(country): :return: None """ - if country == '' or country == '--': # lint-amnesty, pylint: disable=consider-using-in + if country == '' or country == '--': # pylint: disable=consider-using-in raise errors.AccountCountryInvalid(accounts.REQUIRED_FIELD_COUNTRY_MSG) @@ -721,7 +803,7 @@ def _validate_username_doesnt_exist(username): :raises: errors.AccountUsernameAlreadyExists """ if username is not None and username_exists_or_retired(username): - # lint-amnesty, pylint: disable=translation-of-non-string + # pylint: disable=translation-of-non-string raise errors.AccountUsernameAlreadyExists(_(accounts.AUTHN_USERNAME_CONFLICT_MSG)) @@ -735,7 +817,7 @@ def _validate_email_doesnt_exist(email): error_message = accounts.AUTHN_EMAIL_CONFLICT_MSG if email is not None and email_exists_or_retired(email): - raise errors.AccountEmailAlreadyExists(_(error_message)) # lint-amnesty, pylint: disable=translation-of-non-string + raise errors.AccountEmailAlreadyExists(_(error_message)) # pylint: disable=translation-of-non-string def _validate_secondary_email_doesnt_exist(email): @@ -769,10 +851,10 @@ def _validate_password_works_with_username(password, username=None): :raises: errors.AccountPasswordInvalid """ if password == username: - raise errors.AccountPasswordInvalid(accounts.PASSWORD_CANT_EQUAL_USERNAME_MSG) # lint-amnesty, pylint: disable=no-member + raise errors.AccountPasswordInvalid(accounts.PASSWORD_CANT_EQUAL_USERNAME_MSG) # pylint: disable=no-member -def _validate_type(data, type, err): # lint-amnesty, pylint: disable=redefined-builtin +def _validate_type(data, type, err): # pylint: disable=redefined-builtin """Checks whether the input data is of type. If not, throws a generic error message. @@ -787,7 +869,7 @@ def _validate_type(data, type, err): # lint-amnesty, pylint: disable=redefined- raise errors.AccountDataBadType(err) -def _validate_length(data, min, max, err): # lint-amnesty, pylint: disable=redefined-builtin +def _validate_length(data, min, max, err): # pylint: disable=redefined-builtin """Validate that the data's length is less than or equal to max, and greater than or equal to min. @@ -818,4 +900,4 @@ def _validate_unicode(data, err="Input not valid unicode"): # In some cases we pass the above, but it's still inappropriate utf-8. str(data) except UnicodeError: - raise UnicodeError(err) # lint-amnesty, pylint: disable=raise-missing-from + raise UnicodeError(err) # pylint: disable=raise-missing-from # noqa: B904 diff --git a/openedx/core/djangoapps/user_api/accounts/forms.py b/openedx/core/djangoapps/user_api/accounts/forms.py index 771b6a7ccf39..336eb85f9cf9 100644 --- a/openedx/core/djangoapps/user_api/accounts/forms.py +++ b/openedx/core/djangoapps/user_api/accounts/forms.py @@ -2,11 +2,20 @@ Django forms for accounts """ +import logging from django import forms -from django.core.exceptions import ValidationError +from django.core.exceptions import ObjectDoesNotExist, ValidationError +from django.utils.translation import gettext as _ +from common.djangoapps.student.models import User from openedx.core.djangoapps.user_api.accounts.utils import handle_retirement_cancellation +from openedx.core.djangoapps.user_authn.views.registration_form import ( + get_extended_profile_model, + get_registration_extension_form, +) + +logger = logging.getLogger(__name__) class RetirementQueueDeletionForm(forms.Form): @@ -26,7 +35,7 @@ def save(self, retirement): None, # Translators: 'current_state' is a string from an enumerated list indicating the learner's retirement # state. Example: FORUMS_COMPLETE - "Retirement requests can only be cancelled for users in the PENDING state." + "Retirement requests can only be cancelled for users in the PENDING state." # noqa: UP032 " Current request state for '{original_username}': {current_state}".format( original_username=retirement.original_username, current_state=retirement.current_state.state_name @@ -35,3 +44,136 @@ def save(self, retirement): raise ValidationError('Retirement is in the wrong state!') handle_retirement_cancellation(retirement) + + +def extract_extended_profile_fields_data(extended_profile: list[dict] | None) -> tuple[dict, dict]: + """ + Extract extended profile fields data from extended_profile structure. + + Args: + extended_profile (list[dict] | None): List of field data dictionaries with keys + `field_name` and `field_value` + + Returns: + tuple: A tuple containing (extended_profile_fields_data, field_errors) + - extended_profile_fields_data (dict): Extracted custom fields data + - field_errors (dict): Dictionary of validation errors, if any + """ + field_errors = {} + + if not isinstance(extended_profile, list): + field_errors["extended_profile"] = { + "developer_message": "extended_profile must be a list", + "user_message": _("Invalid extended profile format"), + } + return {}, field_errors + + extended_profile_fields_data = {} + + for field_data in extended_profile: + if not isinstance(field_data, dict): + logger.warning("Invalid field_data structure in extended_profile: %s", field_data) + continue + + field_name = field_data.get("field_name") + field_value = field_data.get("field_value") + + if not field_name: + logger.warning("Missing field_name in extended_profile field_data: %s", field_data) + continue + + extended_profile_fields_data[field_name] = field_value + + return extended_profile_fields_data, field_errors + + +def get_extended_profile_form( + extended_profile_fields_data: dict, + user: User, +) -> tuple[forms.Form | None, dict]: + """ + Get and validate an extended profile form instance. + + Args: + extended_profile_fields_data (dict): Extended profile field data to + populate the form + user (User): User instance to associate with the + extended profile + + Returns: + tuple: A tuple containing (extended_profile_form, field_errors) + - extended_profile_form (forms.Form | None): The validated form instance, + or None if no extended profile form is configured, creation fails, + or form validation fails. + - field_errors (dict): Dictionary of validation errors, if any + """ + field_errors, kwargs = {}, {} + extended_profile_model = get_extended_profile_model() + + try: + kwargs["instance"] = extended_profile_model.objects.get(user=user) + except AttributeError: + logger.info("No extended profile model configured") + except ObjectDoesNotExist: + logger.info("No existing extended profile found for user %s, creating new instance", user.username) + + try: + extended_profile_form = get_registration_extension_form(data=extended_profile_fields_data, **kwargs) + except Exception as e: # pylint: disable=broad-exception-caught + logger.error("Unexpected error creating custom form for user %s: %s", user.username, str(e)) + field_errors["extended_profile"] = { + "developer_message": f"Error creating custom form: {str(e)}", + "user_message": _("There was an error processing the extended profile information"), + } + return None, field_errors + + if extended_profile_form is None: + return None, field_errors + + if not extended_profile_form.is_valid(): + logger.info("Extended profile form validation failed with errors: %s", extended_profile_form.errors) + + for field_name, field_errors_list in extended_profile_form.errors.items(): + first_error = field_errors_list[0] if field_errors_list else "Unknown error" + field_errors[field_name] = { + "developer_message": f"Error in extended profile field [{field_name}]: {first_error}", + "user_message": str(first_error), + } + + return None, field_errors + + return extended_profile_form, field_errors + + +def validate_and_get_extended_profile_form( + extended_profile_data: list, user: User +) -> tuple[forms.Form | None, dict]: + """ + Validate and return an extended profile form instance. + + This function orchestrates the extraction and validation of extended profile data. + + Args: + extended_profile_data (list): The raw extended_profile data from the API request + user (User): The user instance for whom the extended profile is being validated + + Returns: + tuple: A tuple containing (validated_form, field_errors) + - validated_form (forms.Form | None): The validated form instance, or None if + validation fails or no extended profile is configured + - field_errors (dict): Dictionary of validation errors, if any + """ + extended_profile_fields_data, field_errors = extract_extended_profile_fields_data(extended_profile_data) + + if field_errors: + return None, field_errors + + if not extended_profile_fields_data: + return None, {} + + extended_profile_form, form_errors = get_extended_profile_form(extended_profile_fields_data, user) + + if form_errors: + field_errors.update(form_errors) + + return extended_profile_form, field_errors diff --git a/openedx/core/djangoapps/user_api/accounts/image_helpers.py b/openedx/core/djangoapps/user_api/accounts/image_helpers.py index eff2ad272b28..bb2ff19321cb 100644 --- a/openedx/core/djangoapps/user_api/accounts/image_helpers.py +++ b/openedx/core/djangoapps/user_api/accounts/image_helpers.py @@ -180,14 +180,14 @@ def set_has_profile_image(username, is_uploaded, upload_dt=None): ValueError: is_uploaded was True, but no upload datetime was supplied. UserNotFound: no user with username `username` exists. """ - if is_uploaded and upload_dt is None: # lint-amnesty, pylint: disable=no-else-raise + if is_uploaded and upload_dt is None: # pylint: disable=no-else-raise raise ValueError("No upload datetime was supplied.") elif not is_uploaded: upload_dt = None try: profile = UserProfile.objects.get(user__username=username) except ObjectDoesNotExist: - raise UserNotFound() # lint-amnesty, pylint: disable=raise-missing-from + raise UserNotFound() # pylint: disable=raise-missing-from # noqa: B904 profile.profile_image_uploaded_at = upload_dt profile.save() diff --git a/openedx/core/djangoapps/user_api/accounts/serializers.py b/openedx/core/djangoapps/user_api/accounts/serializers.py index 87db1e65de2d..6ad83c2a56f6 100644 --- a/openedx/core/djangoapps/user_api/accounts/serializers.py +++ b/openedx/core/djangoapps/user_api/accounts/serializers.py @@ -8,25 +8,29 @@ import re from django.conf import settings -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.core.exceptions import ObjectDoesNotExist +from django.forms.models import model_to_dict from django.urls import reverse from rest_framework import serializers - from common.djangoapps.student.models import ( LanguageProficiency, PendingNameChange, SocialLink, UserPasswordToggleHistory, - UserProfile + UserProfile, ) from openedx.core.djangoapps.site_configuration import helpers as configuration_helpers from openedx.core.djangoapps.user_api import errors from openedx.core.djangoapps.user_api.accounts.utils import is_secondary_email_feature_enabled from openedx.core.djangoapps.user_api.models import RetirementState, UserPreference, UserRetirementStatus from openedx.core.djangoapps.user_api.serializers import ReadOnlyFieldsSerializerMixin -from openedx.core.djangoapps.user_authn.views.registration_form import contains_html, contains_url +from openedx.core.djangoapps.user_authn.views.registration_form import ( + contains_html, + contains_url, + get_extended_profile_model, +) from openedx.features.name_affirmation_api.utils import get_name_affirmation_service from . import ( @@ -36,7 +40,7 @@ CUSTOM_VISIBILITY, NAME_MIN_LENGTH, PRIVATE_VISIBILITY, - VISIBILITY_PREFIX + VISIBILITY_PREFIX, ) from .image_helpers import get_profile_image_urls_for_user from .utils import format_social_link, validate_social_link @@ -45,7 +49,7 @@ LOGGER = logging.getLogger(__name__) -class PhoneNumberSerializer(serializers.BaseSerializer): # lint-amnesty, pylint: disable=abstract-method +class PhoneNumberSerializer(serializers.BaseSerializer): # pylint: disable=abstract-method """ Class to serialize phone number into a digit only representation. @@ -109,7 +113,7 @@ def validate_platform(self, platform): return platform -class UserReadOnlySerializer(serializers.Serializer): # lint-amnesty, pylint: disable=abstract-method +class UserReadOnlySerializer(serializers.Serializer): # pylint: disable=abstract-method """ Class that serializes the User model and UserProfile model together. """ @@ -125,7 +129,7 @@ def __init__(self, *args, **kwargs): super().__init__(*args, **kwargs) - def to_representation(self, user): # lint-amnesty, pylint: disable=arguments-differ + def to_representation(self, user): # pylint: disable=arguments-differ """ Overwrite to_native to handle custom logic since we are serializing three models as one here :param user: User object @@ -142,11 +146,6 @@ def to_representation(self, user): # lint-amnesty, pylint: disable=arguments-di except ObjectDoesNotExist: account_recovery = None - try: - activation_key = user.registration.activation_key - except ObjectDoesNotExist: - activation_key = None - data = { "username": user.username, "url": self.context.get('request').build_absolute_uri( @@ -161,7 +160,6 @@ def to_representation(self, user): # lint-amnesty, pylint: disable=arguments-di "date_joined": user.date_joined.replace(microsecond=0), "last_login": user.last_login, "is_active": user.is_active, - "activation_key": activation_key, "bio": None, "country": None, "state": None, @@ -186,7 +184,9 @@ def to_representation(self, user): # lint-amnesty, pylint: disable=arguments-di data.update( { "bio": AccountLegacyProfileSerializer.convert_empty_to_None(user_profile.bio), - "country": AccountLegacyProfileSerializer.convert_empty_to_None(user_profile.country.code), + "country": AccountLegacyProfileSerializer.convert_empty_to_None( + user_profile.country.code if user_profile.country else "" + ), "state": AccountLegacyProfileSerializer.convert_empty_to_None(user_profile.state), "profile_image": AccountLegacyProfileSerializer.get_profile_image( user_profile, user, self.context.get('request') @@ -442,7 +442,7 @@ def _update_social_links(self, instance, requested_social_links): except ValueError as err: # If we have encountered any validation errors, return them to the user. - raise errors.AccountValidationError({ + raise errors.AccountValidationError({ # noqa: B904 'social_links': { "developer_message": f"Error when adding new social link: '{str(err)}'", "user_message": str(err) @@ -476,7 +476,7 @@ def update(self, instance, validated_data): ]) # Update the user's social links - requested_social_links = self._kwargs['data'].get('social_links') # lint-amnesty, pylint: disable=no-member + requested_social_links = self._kwargs['data'].get('social_links') # pylint: disable=no-member if requested_social_links: self._update_social_links(instance, requested_social_links) @@ -556,7 +556,7 @@ def update(self, instance, validated_data): pass -class PendingNameChangeSerializer(serializers.Serializer): # lint-amnesty, pylint: disable=abstract-method +class PendingNameChangeSerializer(serializers.Serializer): # pylint: disable=abstract-method """ Serialize the PendingNameChange model """ @@ -573,26 +573,52 @@ def validate_new_name(self, new_name): raise serializers.ValidationError('Name cannot contain a URL') -def get_extended_profile(user_profile): +def get_extended_profile(user_profile: UserProfile) -> list[dict[str, str]]: """ - Returns the extended user profile fields stored in user_profile.meta + Retrieve extended user profile fields for API serialization. + + This function extracts custom profile fields that extend beyond the standard + UserProfile model. It prefers data from a custom extended profile model + (when configured), and only uses the `user_profile.meta` JSON field when + no such model is configured. The returned data is filtered to include only + fields specified in the `extended_profile_fields` site configuration. + + The function supports two data sources: + 1. Custom model: If the `PROFILE_EXTENSION_FORM` setting points to a form with a + `Meta.model`, data is retrieved from that model using `model_to_dict()`. If a + model is configured but the user does not yet have a corresponding record, + this function returns an empty mapping for extended profile fields (it does + not fall back to `user_profile.meta` in that case). + 2. Fallback: JSON data stored in `UserProfile.meta` field, used only when no + custom extended profile model is configured. + + Args: + user_profile (UserProfile): The user profile instance to get extended fields from. + + Returns: + list[dict[str, str]]: A list of dictionaries, each containing: + - field_name: The name of the extended profile field + - field_value: The value of the field (converted to string) """ - # pick the keys from the site configuration - extended_profile_field_names = configuration_helpers.get_value('extended_profile_fields', []) + def get_extended_profile_data(): + extended_profile_model = get_extended_profile_model() - try: - extended_profile_fields_data = json.loads(user_profile.meta) - except ValueError: - extended_profile_fields_data = {} + if extended_profile_model: + try: + profile_obj = extended_profile_model.objects.get(user=user_profile.user) + return model_to_dict(profile_obj) + except extended_profile_model.DoesNotExist: + return {} - extended_profile = [] - for field_name in extended_profile_field_names: - extended_profile.append({ - "field_name": field_name, - "field_value": extended_profile_fields_data.get(field_name, "") - }) - return extended_profile + try: + return json.loads(user_profile.meta or "{}") + except (ValueError, TypeError, AttributeError): + return {} + + data = get_extended_profile_data() + field_names = configuration_helpers.get_value("extended_profile_fields", []) + return [{"field_name": name, "field_value": data.get(name, "")} for name in field_names] def get_profile_visibility(user_profile, user, configuration): diff --git a/openedx/core/djangoapps/user_api/accounts/signals.py b/openedx/core/djangoapps/user_api/accounts/signals.py index a51a8160c93c..d0f2df3a03fc 100644 --- a/openedx/core/djangoapps/user_api/accounts/signals.py +++ b/openedx/core/djangoapps/user_api/accounts/signals.py @@ -2,17 +2,54 @@ Django Signal related functionality for user_api accounts """ +import logging -from django.dispatch import Signal +from django.db.models.signals import pre_delete +from django.dispatch import Signal, receiver +from social_django.models import UserSocialAuth + +from .utils import REDACTED_SOCIAL_AUTH_UID_PREFIX, REDACTED_SOCIAL_AUTH_UID_SUFFIX, redact_and_delete_social_auth + +logger = logging.getLogger(__name__) + + +def get_redacted_social_auth_uid(pk): + """ + Return the redacted uid for a UserSocialAuth record. + + This must match the format used in redact_and_delete_social_auth. + """ + return f'{REDACTED_SOCIAL_AUTH_UID_PREFIX}{pk}{REDACTED_SOCIAL_AUTH_UID_SUFFIX}' # Signal to retire a user from LMS-initiated mailings (course mailings, etc) # providing_args=["user"] USER_RETIRE_MAILINGS = Signal() # Signal to retire LMS critical information -# providing_args=["user"] +# providing_args=["user", "retired_username", "retired_email"] USER_RETIRE_LMS_CRITICAL = Signal() # Signal to retire LMS misc information # providing_args=["user"] USER_RETIRE_LMS_MISC = Signal() + + +@receiver(pre_delete, sender=UserSocialAuth) +def redact_social_auth_pii_before_deletion(sender, instance, **kwargs): # pylint: disable=unused-argument + """ + Safety-net signal handler that redacts PII on any UserSocialAuth before deletion. + + Records deleted via ``redact_and_delete_social_auth`` will already be redacted; + this handler is a fallback for any missed deletion path. + """ + redacted_uid = get_redacted_social_auth_uid(instance.pk) + + # Safety-net in case the record wasn't redacted before delete. + if instance.extra_data or instance.uid != redacted_uid: + logger.warning( + 'Social auth link for user_id=%s, provider=%s was deleted without first being redacted.' + ' Redacting in pre_delete.', + instance.user_id, + instance.provider, + ) + redact_and_delete_social_auth(instance.user_id, skip_delete=True) diff --git a/openedx/core/djangoapps/user_api/accounts/tests/factories.py b/openedx/core/djangoapps/user_api/accounts/tests/factories.py index a3a3bad92b12..4cb96587700e 100644 --- a/openedx/core/djangoapps/user_api/accounts/tests/factories.py +++ b/openedx/core/djangoapps/user_api/accounts/tests/factories.py @@ -3,8 +3,9 @@ """ from factory import SubFactory from factory.django import DjangoModelFactory -from openedx.core.djangoapps.user_api.models import UserRetirementStatus, RetirementState + from common.djangoapps.student.tests.factories import UserFactory +from openedx.core.djangoapps.user_api.models import RetirementState, UserRetirementStatus class RetirementStateFactory(DjangoModelFactory): diff --git a/openedx/core/djangoapps/user_api/accounts/tests/retirement_helpers.py b/openedx/core/djangoapps/user_api/accounts/tests/retirement_helpers.py index d91ba37399d4..6c6581c5a2e2 100644 --- a/openedx/core/djangoapps/user_api/accounts/tests/retirement_helpers.py +++ b/openedx/core/djangoapps/user_api/accounts/tests/retirement_helpers.py @@ -4,16 +4,16 @@ import datetime +from zoneinfo import ZoneInfo import pytest -from zoneinfo import ZoneInfo from django.test import TestCase from social_django.models import UserSocialAuth -from openedx.core.djangoapps.enrollments import api -from openedx.core.djangoapps.user_api.models import RetirementState, UserRetirementStatus from common.djangoapps.student.models import get_retired_email_by_email, get_retired_username_by_username from common.djangoapps.student.tests.factories import UserFactory +from openedx.core.djangoapps.enrollments import api +from openedx.core.djangoapps.user_api.models import RetirementState, UserRetirementStatus from ..views import AccountRetirementView diff --git a/openedx/core/djangoapps/user_api/accounts/tests/test_api.py b/openedx/core/djangoapps/user_api/accounts/tests/test_api.py index 11b2f800f996..9c8762d8dbc8 100644 --- a/openedx/core/djangoapps/user_api/accounts/tests/test_api.py +++ b/openedx/core/djangoapps/user_api/accounts/tests/test_api.py @@ -4,27 +4,27 @@ """ import datetime -import itertools import unicodedata from unittest.mock import Mock, patch +from zoneinfo import ZoneInfo import ddt import pytest from django.conf import settings from django.contrib.auth.hashers import make_password -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user +from django.core.exceptions import ValidationError +from django.db import DatabaseError, IntegrityError from django.http import HttpResponse from django.test import TestCase from django.test.client import RequestFactory from django.urls import reverse -from zoneinfo import ZoneInfo -from social_django.models import UserSocialAuth from common.djangoapps.student.models import ( AccountRecovery, PendingEmailChange, PendingSecondaryEmailChange, - UserProfile + UserProfile, ) from common.djangoapps.student.tests.factories import UserFactory from common.djangoapps.student.tests.tests import UserSettingsEventTestMixin @@ -32,22 +32,23 @@ from lms.djangoapps.certificates.data import CertificateStatuses from openedx.core.djangoapps.ace_common.tests.mixins import EmailTemplateTagMixin from openedx.core.djangoapps.embargo.models import Country, GlobalRestrictedCountry +from openedx.core.djangoapps.site_configuration.tests.test_util import with_site_configuration from openedx.core.djangoapps.user_api.accounts import PRIVATE_VISIBILITY from openedx.core.djangoapps.user_api.accounts.api import ( get_account_settings, get_name_validation_error, - update_account_settings + update_account_settings, ) from openedx.core.djangoapps.user_api.accounts.tests.retirement_helpers import ( # pylint: disable=unused-import RetirementTestCase, fake_requested_retirement, - setup_retirement_states + setup_retirement_states, # noqa: F401 ) from openedx.core.djangoapps.user_api.errors import ( AccountUpdateError, AccountValidationError, UserNotAuthorized, - UserNotFound + UserNotFound, ) from openedx.core.djangolib.testing.utils import skip_unless_lms from openedx.features.enterprise_support.tests.factories import EnterpriseCustomerUserFactory @@ -67,7 +68,7 @@ def mock_render_to_response(template_name): return HttpResponse(template_name) -class CreateAccountMixin: # lint-amnesty, pylint: disable=missing-class-docstring +class CreateAccountMixin: # pylint: disable=missing-class-docstring def create_account(self, username, password, email): # pylint: disable=missing-docstring registration_url = reverse('user_api_registration') @@ -84,7 +85,7 @@ def create_account(self, username, password, email): @skip_unless_lms @ddt.ddt @patch('common.djangoapps.student.views.management.render_to_response', - Mock(side_effect=mock_render_to_response, autospec=True)) # lint-amnesty, pylint: disable=line-too-long + Mock(side_effect=mock_render_to_response, autospec=True)) # pylint: disable=line-too-long class TestAccountApi(UserSettingsEventTestMixin, EmailTemplateTagMixin, CreateAccountMixin, RetirementTestCase): """ These tests specifically cover the parts of the API methods that are not covered by test_views.py. @@ -104,10 +105,12 @@ def setUp(self): self.staff_user = UserFactory(is_staff=True, password=self.password) self.reset_tracker() - enterprise_patcher = patch('openedx.features.enterprise_support.api.enterprise_customer_for_request') - enterprise_learner_patcher = enterprise_patcher.start() - enterprise_learner_patcher.return_value = {} - self.addCleanup(enterprise_learner_patcher.stop) + filter_patcher = patch( + 'openedx.core.djangoapps.user_api.accounts.api.AccountSettingsReadOnlyFieldsRequested.run_filter', + return_value=(set(), None), + ) + filter_patcher.start() + self.addCleanup(filter_patcher.stop) def test_get_username_provided(self): """Test the difference in behavior when a username is supplied to get_account_settings.""" @@ -164,6 +167,30 @@ def test_update_username_provided(self): with pytest.raises(UserNotAuthorized): update_account_settings(self.different_user, {"name": "Pluto"}, username=self.user.username) + @with_site_configuration(configuration={"extended_profile_fields": ["department"]}) + def test_update_username_provided_with_extended_profile(self): + """Test that extended profile is saved when username is provided to update_account_settings.""" + extended_profile_data = [{"field_name": "department", "field_value": "Engineering"}] + + update_account_settings(self.user, {"extended_profile": extended_profile_data, "name": "Donald Duck"}) + account_settings = get_account_settings(self.default_request)[0] + self.assertEqual(extended_profile_data, account_settings["extended_profile"]) # noqa: PT009 + self.assertEqual("Donald Duck", account_settings["name"]) # noqa: PT009 + + update_account_settings( + self.user, {"extended_profile": extended_profile_data, "name": "Mickey Mouse"}, username=self.user.username + ) + account_settings = get_account_settings(self.default_request)[0] + self.assertEqual(extended_profile_data, account_settings["extended_profile"]) # noqa: PT009 + self.assertEqual("Mickey Mouse", account_settings["name"]) # noqa: PT009 + + with pytest.raises(UserNotAuthorized): + update_account_settings( + self.different_user, + {"extended_profile": extended_profile_data, "name": "Pluto"}, + username=self.user.username, + ) + def test_update_non_existent_user(self): with pytest.raises(UserNotAuthorized): update_account_settings(self.user, {}, username="does_not_exist") @@ -248,73 +275,19 @@ def test_update_success_for_enterprise(self): account_settings = get_account_settings(self.default_request)[0] assert level_of_education == account_settings['level_of_education'] - @patch('openedx.features.enterprise_support.api.enterprise_customer_for_request') - @patch('openedx.features.enterprise_support.utils.third_party_auth.provider.Registry.get') - @ddt.data( - *itertools.product( - # field_name_value values - (("email", "new_email@example.com"), ("name", "new name"), ("country", "IN")), - # is_enterprise_user - (True, False), - # is_synch_learner_profile_data - (True, False), - # has `UserSocialAuth` record - (True, False), - ) + @patch( + 'openedx.core.djangoapps.user_api.accounts.api.AccountSettingsReadOnlyFieldsRequested.run_filter', + return_value=({'country'}, None), ) - @ddt.unpack - def test_update_validation_error_for_enterprise( - self, - field_name_value, - is_enterprise_user, - is_synch_learner_profile_data, - has_user_social_auth_record, - mock_auth_provider, - mock_customer, - ): - idp_backend_name = 'tpa-saml' - mock_customer.return_value = {} - if is_enterprise_user: - mock_customer.return_value.update({ - 'uuid': 'real-ent-uuid', - 'name': 'Dummy Enterprise', - 'identity_provider': 'saml-ubc', - 'identity_providers': [ - { - "provider_id": "saml-ubc", - } - ], - }) - mock_auth_provider.return_value.sync_learner_profile_data = is_synch_learner_profile_data - mock_auth_provider.return_value.backend_name = idp_backend_name - - update_data = {field_name_value[0]: field_name_value[1]} - - user_fullname_editable = False - if has_user_social_auth_record: - UserSocialAuth.objects.create( - provider=idp_backend_name, - user=self.user - ) - else: - UserSocialAuth.objects.all().delete() - # user's fullname is editable if no `UserSocialAuth` record exists - user_fullname_editable = field_name_value[0] == 'name' - - # prevent actual email change requests - with patch('openedx.core.djangoapps.user_api.accounts.api.student_views.do_email_change_request'): - # expect field un-editability only when all of the following conditions are met - if is_enterprise_user and is_synch_learner_profile_data and not user_fullname_editable: - with pytest.raises(AccountValidationError) as validation_error: - update_account_settings(self.user, update_data) - field_errors = validation_error.value.field_errors - assert 'This field is not editable via this API' == \ - field_errors[field_name_value[0]]['developer_message'] - else: - update_account_settings(self.user, update_data) - account_settings = get_account_settings(self.default_request)[0] - if field_name_value[0] != "email": - assert field_name_value[1] == account_settings[field_name_value[0]] + def test_readonly_field_from_filter_is_rejected(self, mock_run_filter): # pylint: disable=unused-argument + """ + When AccountSettingsReadOnlyFieldsRequested.run_filter returns a field as read-only, + update_account_settings should raise AccountValidationError for that field. + """ + with pytest.raises(AccountValidationError) as exc_info: + update_account_settings(self.user, {"country": "IN"}) + field_errors = exc_info.value.field_errors + assert 'This field is not editable via this API' == field_errors['country']['developer_message'] def test_update_error_validating(self): """Test that AccountValidationError is thrown if incorrect values are supplied.""" @@ -393,7 +366,7 @@ def test_validate_name_change_same_name(self): update_account_settings(self.user, {'name': account_settings['name']}) # The name should not be added to profile metadata updated_meta = user_profile.get_meta() - self.assertEqual(meta, updated_meta) + self.assertEqual(meta, updated_meta) # noqa: PT009 @patch('openedx.core.djangoapps.user_api.accounts.api._does_name_change_require_verification', Mock(return_value=True)) @@ -558,10 +531,10 @@ def test_add_account_recovery(self): assert account_recovery.secondary_email == test_email def test_change_country_removes_state(self): - ''' + """ Test that changing the country (to something other than a country with states) removes the state - ''' + """ # First set the country and state update_account_settings(self.user, {"country": UserProfile.COUNTRY_WITH_STATES, "state": "MA"}) account_settings = get_account_settings(self.default_request)[0] @@ -587,7 +560,7 @@ def test_change_to_disabled_country(self): assert account_settings['country'] == UserProfile.COUNTRY_WITH_STATES assert account_settings['state'] == 'MA' - with self.assertRaises(AccountValidationError): + with self.assertRaises(AccountValidationError): # noqa: PT027 update_account_settings(self.user, {"country": "KP"}) def test_get_name_validation_error_too_long(self): @@ -597,6 +570,101 @@ def test_get_name_validation_error_too_long(self): result = get_name_validation_error("A" * 256) assert result == "Full name can't be longer than 255 symbols" + def test_update_extended_profile_with_meta_only(self): + """ + Test updating extended profile using only the meta field (legacy behavior) + """ + update_data = { + "extended_profile": [ + {"field_name": "department", "field_value": "Engineering"}, + {"field_name": "title", "field_value": "Software Engineer"}, + ], + "bio": "Updated bio", + } + + update_account_settings(self.user, update_data) + + user_profile = UserProfile.objects.get(user=self.user) + meta = user_profile.get_meta() + self.assertEqual(meta["department"], "Engineering") # noqa: PT009 + self.assertEqual(meta["title"], "Software Engineer") # noqa: PT009 + self.assertEqual(user_profile.bio, "Updated bio") # noqa: PT009 + + @patch("openedx.core.djangoapps.user_api.accounts.api.validate_and_get_extended_profile_form") + def test_update_extended_profile_with_form(self, mock_validate_and_get_form): + """ + Test updating extended profile with a validated form + """ + extended_profile_data = [{"field_name": "department", "field_value": "Engineering"}] + mock_form = Mock(save=Mock(return_value=Mock(user=self.user))) + mock_validate_and_get_form.return_value = (mock_form, {}) + + update_account_settings(self.user, {"extended_profile": extended_profile_data}) + + mock_validate_and_get_form.assert_called_once_with(extended_profile_data, self.user) + mock_form.save.assert_called_once_with(commit=False) + mock_form.save.return_value.save.assert_called_once() + meta = UserProfile.objects.get(user=self.user).get_meta() + self.assertEqual(meta["department"], "Engineering") # noqa: PT009 + + @patch("openedx.core.djangoapps.user_api.accounts.api.validate_and_get_extended_profile_form") + def test_update_extended_profile_with_form_new_instance(self, mock_validate_and_get_form): + """ + Test updating extended profile with a form for a new instance + """ + extended_profile_data = [{"field_name": "department", "field_value": "Engineering"}] + mock_instance = Mock(user=None) + mock_form = Mock(save=Mock(return_value=mock_instance)) + mock_validate_and_get_form.return_value = (mock_form, {}) + + update_account_settings(self.user, {"extended_profile": extended_profile_data}) + + mock_validate_and_get_form.assert_called_once_with(extended_profile_data, self.user) + mock_form.save.assert_called_once_with(commit=False) + self.assertEqual(mock_instance.user, self.user) # noqa: PT009 + mock_instance.save.assert_called_once() + + @patch("openedx.core.djangoapps.user_api.accounts.api.validate_and_get_extended_profile_form") + @ddt.data( + (ValidationError("Invalid field value"), "Extended profile validation failed"), + (IntegrityError("Duplicate entry"), "Extended profile integrity error"), + (DatabaseError("Connection lost"), "Database error saving extended profile"), + ) + @ddt.unpack + def test_update_extended_profile_form_save_error(self, exception, expected_dev_msg, mock_validate_and_get_form): + """ + Test that errors during form save cause an AccountUpdateError with appropriate messages, + and do not leave partial updates. + """ + extended_profile_data = [{"field_name": "department", "field_value": "Engineering"}] + mock_form = Mock() + mock_form.save.side_effect = exception + mock_validate_and_get_form.return_value = (mock_form, {}) + + with pytest.raises(AccountUpdateError) as context_manager: + update_account_settings(self.user, {"extended_profile": extended_profile_data}) + + self.assertIn(expected_dev_msg, context_manager.value.developer_message) # noqa: PT009 + self.assertIsNotNone(context_manager.value.user_message) # noqa: PT009 + + mock_validate_and_get_form.assert_called_once_with(extended_profile_data, self.user) + mock_form.save.assert_called_once_with(commit=False) + + # The meta update is in the same transaction, it should be rolled back. + meta = UserProfile.objects.get(user=self.user).get_meta() + self.assertNotIn("department", meta) # noqa: PT009 + + def test_update_extended_profile_without_extended_profile_data(self): + """ + Test that update_account_settings works when no extended_profile is provided + """ + update_data = {"bio": "Updated bio"} + + update_account_settings(self.user, update_data) + + user_profile = UserProfile.objects.get(user=self.user) + self.assertEqual(user_profile.bio, "Updated bio") # noqa: PT009 + @patch('openedx.core.djangoapps.user_api.accounts.image_helpers._PROFILE_IMAGE_SIZES', [50, 10]) @patch.dict( @@ -634,7 +702,6 @@ def test_create_account(self): 'id': user.id, 'name': self.USERNAME, 'verified_name': None, - 'activation_key': user.registration.activation_key, 'gender': None, 'goals': '', 'is_active': False, 'level_of_education': None, diff --git a/openedx/core/djangoapps/user_api/accounts/tests/test_forms.py b/openedx/core/djangoapps/user_api/accounts/tests/test_forms.py new file mode 100644 index 000000000000..bc2c4c0acd1a --- /dev/null +++ b/openedx/core/djangoapps/user_api/accounts/tests/test_forms.py @@ -0,0 +1,323 @@ +""" +Unit tests for forms in the accounts API +""" + +from unittest.mock import Mock, patch + +from django.core.exceptions import ObjectDoesNotExist +from django.test import TestCase + +from common.djangoapps.student.tests.factories import UserFactory +from openedx.core.djangoapps.user_api.accounts.forms import ( + extract_extended_profile_fields_data, + get_extended_profile_form, + validate_and_get_extended_profile_form, +) + + +class TestExtractExtendedProfileFieldsData(TestCase): + """ + Tests for extract_extended_profile_fields_data function + """ + + def test_extract_valid_extended_profile_data(self): + """ + Test extraction of valid extended profile data + """ + extended_profile = [ + {"field_name": "department", "field_value": "Engineering"}, + {"field_name": "title", "field_value": "Software Engineer"}, + ] + + extracted_data, errors = extract_extended_profile_fields_data(extended_profile) + + self.assertEqual(errors, {}) # noqa: PT009 + self.assertEqual(extracted_data, {"department": "Engineering", "title": "Software Engineer"}) # noqa: PT009 + + def test_extract_extended_profile_with_empty_string(self): + """ + Test that empty strings are included + """ + extended_profile = [ + {"field_name": "department", "field_value": ""}, + {"field_name": "title", "field_value": "Engineer"}, + ] + + extracted_data, errors = extract_extended_profile_fields_data(extended_profile) + + self.assertEqual(errors, {}) # noqa: PT009 + self.assertEqual(extracted_data, {"department": "", "title": "Engineer"}) # noqa: PT009 + + def test_extract_extended_profile_not_a_list(self): + """ + Test error when extended_profile is not a list + """ + extended_profile = "not a list" + + extracted_data, errors = extract_extended_profile_fields_data(extended_profile) + + self.assertEqual(extracted_data, {}) # noqa: PT009 + self.assertIn("extended_profile", errors) # noqa: PT009 + self.assertEqual( # noqa: PT009 + errors["extended_profile"]["developer_message"], "extended_profile must be a list" + ) + + def test_extract_extended_profile_with_invalid_field_data(self): + """ + Test that invalid field data entries are skipped (logged but not errored) + """ + extended_profile = [ + {"field_name": "department", "field_value": "Engineering"}, + "invalid entry", # Not a dict + {"field_name": "title", "field_value": "Engineer"}, + ] + + extracted_data, errors = extract_extended_profile_fields_data(extended_profile) + + # Invalid entry should be skipped, but valid ones should be extracted + self.assertEqual(errors, {}) # noqa: PT009 + self.assertEqual(extracted_data, {"department": "Engineering", "title": "Engineer"}) # noqa: PT009 + + def test_extract_extended_profile_missing_field_name(self): + """ + Test that entries without field_name are skipped + """ + extended_profile = [ + {"field_name": "department", "field_value": "Engineering"}, + {"field_value": "Engineer"}, # Missing field_name + ] + + extracted_data, errors = extract_extended_profile_fields_data(extended_profile) + + self.assertEqual(errors, {}) # noqa: PT009 + self.assertEqual(extracted_data, {"department": "Engineering"}) # noqa: PT009 + + def test_extract_extended_profile_empty_list(self): + """ + Test that an empty list returns empty data + """ + extended_profile = [] + + extracted_data, errors = extract_extended_profile_fields_data(extended_profile) + + self.assertEqual(errors, {}) # noqa: PT009 + self.assertEqual(extracted_data, {}) # noqa: PT009 + + +class TestGetExtendedProfileForm(TestCase): + """ + Tests for get_extended_profile_form function + """ + + def setUp(self): + super().setUp() + self.user = UserFactory.create() + + @patch("openedx.core.djangoapps.user_api.accounts.forms.get_extended_profile_model") + def test_get_extended_profile_form_no_model_configured(self, mock_get_model: Mock): + """ + Test when no extended profile model is configured + """ + mock_get_model.return_value = None + extended_profile_fields_data = {"department": "Engineering"} + + form, errors = get_extended_profile_form(extended_profile_fields_data, self.user) + + self.assertIsNone(form) # noqa: PT009 + self.assertEqual(errors, {}) # noqa: PT009 + + @patch("openedx.core.djangoapps.user_api.accounts.forms.get_extended_profile_model") + def test_get_extended_profile_form_model_has_no_objects(self, mock_get_model: Mock): + """ + Test when model doesn't have objects attribute (AttributeError) + """ + mock_model = Mock(spec=[]) + mock_get_model.return_value = mock_model + extended_profile_fields_data = {"department": "Engineering"} + + form, errors = get_extended_profile_form(extended_profile_fields_data, self.user) + + self.assertIsNone(form) # noqa: PT009 + self.assertEqual(errors, {}) # noqa: PT009 + + @patch("openedx.core.djangoapps.user_api.accounts.forms.get_registration_extension_form") + @patch("openedx.core.djangoapps.user_api.accounts.forms.get_extended_profile_model") + def test_get_extended_profile_form_with_existing_instance(self, mock_get_model: Mock, mock_get_form: Mock): + """ + Test form creation with an existing profile instance + """ + mock_model = Mock() + mock_instance = Mock() + mock_model.objects.get.return_value = mock_instance + mock_get_model.return_value = mock_model + mock_form_instance = Mock() + mock_form_instance.is_valid.return_value = True + mock_get_form.return_value = mock_form_instance + extended_profile_fields_data = {"department": "Engineering"} + + form, errors = get_extended_profile_form(extended_profile_fields_data, self.user) + + self.assertEqual(form, mock_form_instance) # noqa: PT009 + self.assertEqual(errors, {}) # noqa: PT009 + mock_model.objects.get.assert_called_once_with(user=self.user) + mock_get_form.assert_called_once_with(data=extended_profile_fields_data, instance=mock_instance) + + @patch("openedx.core.djangoapps.user_api.accounts.forms.get_registration_extension_form") + @patch("openedx.core.djangoapps.user_api.accounts.forms.get_extended_profile_model") + def test_get_extended_profile_form_without_existing_instance(self, mock_get_model: Mock, mock_get_form: Mock): + """ + Test form creation for a new profile (no existing instance) + """ + mock_model = Mock() + mock_model.DoesNotExist = ObjectDoesNotExist + mock_model.objects.get.side_effect = ObjectDoesNotExist("Profile not found") + mock_get_model.return_value = mock_model + mock_form_instance = Mock() + mock_form_instance.is_valid.return_value = True + mock_get_form.return_value = mock_form_instance + extended_profile_fields_data = {"department": "Engineering"} + + form, errors = get_extended_profile_form(extended_profile_fields_data, self.user) + + self.assertEqual(form, mock_form_instance) # noqa: PT009 + self.assertEqual(errors, {}) # noqa: PT009 + mock_model.objects.get.assert_called_once_with(user=self.user) + mock_get_form.assert_called_once_with(data=extended_profile_fields_data) + + @patch("openedx.core.djangoapps.user_api.accounts.forms.get_registration_extension_form") + @patch("openedx.core.djangoapps.user_api.accounts.forms.get_extended_profile_model") + def test_get_extended_profile_form_validation_errors(self, mock_get_model: Mock, mock_get_form: Mock): + """ + Test when form validation fails + """ + mock_form_instance = Mock() + mock_form_instance.is_valid.return_value = False + mock_form_instance.errors = {"department": ["This field is required"], "title": ["Invalid value"]} + mock_get_form.return_value = mock_form_instance + extended_profile_fields_data = {} + + form, errors = get_extended_profile_form(extended_profile_fields_data, self.user) + + mock_get_model.assert_called_once() + self.assertIsNone(form) # noqa: PT009 + self.assertIn("department", errors) # noqa: PT009 + self.assertIn("title", errors) # noqa: PT009 + self.assertEqual(errors["department"]["user_message"], "This field is required") # noqa: PT009 + self.assertEqual(errors["title"]["user_message"], "Invalid value") # noqa: PT009 + + @patch("openedx.core.djangoapps.user_api.accounts.forms.get_registration_extension_form") + def test_get_extended_profile_form_returns_none(self, mock_get_form: Mock): + """ + Test when get_registration_extension_form returns None + """ + mock_get_form.return_value = None + extended_profile_fields_data = {"department": "Engineering"} + + with patch("openedx.core.djangoapps.user_api.accounts.forms.get_extended_profile_model"): + form, errors = get_extended_profile_form(extended_profile_fields_data, self.user) + + self.assertIsNone(form) # noqa: PT009 + self.assertEqual(errors, {}) # noqa: PT009 + + @patch("openedx.core.djangoapps.user_api.accounts.forms.get_registration_extension_form") + def test_get_extended_profile_form_exception_during_creation(self, mock_get_form: Mock): + """ + Test when an unexpected exception occurs during form creation + """ + mock_get_form.side_effect = Exception("Unexpected error") + extended_profile_fields_data = {"department": "Engineering"} + + with patch("openedx.core.djangoapps.user_api.accounts.forms.get_extended_profile_model"): + form, errors = get_extended_profile_form(extended_profile_fields_data, self.user) + + self.assertIsNone(form) # noqa: PT009 + self.assertIn("extended_profile", errors) # noqa: PT009 + self.assertIn("Error creating custom form", errors["extended_profile"]["developer_message"]) # noqa: PT009 + + +class TestValidateAndGetExtendedProfileForm(TestCase): + """ + Tests for validate_and_get_extended_profile_form function + """ + + def setUp(self): + super().setUp() + self.user = UserFactory.create() + + @patch("openedx.core.djangoapps.user_api.accounts.forms.get_extended_profile_form") + @patch("openedx.core.djangoapps.user_api.accounts.forms.extract_extended_profile_fields_data") + def test_validate_with_valid_data(self, mock_extract: Mock, mock_get_form: Mock): + """ + Test successful validation with valid data + """ + extended_profile_data = [{"field_name": "department", "field_value": "Engineering"}] + mock_extract.return_value = ({"department": "Engineering"}, {}) + mock_form = Mock() + mock_get_form.return_value = (mock_form, {}) + + form, errors = validate_and_get_extended_profile_form(extended_profile_data, self.user) + + self.assertEqual(form, mock_form) # noqa: PT009 + self.assertEqual(errors, {}) # noqa: PT009 + mock_extract.assert_called_once_with(extended_profile_data) + mock_get_form.assert_called_once_with({"department": "Engineering"}, self.user) + + @patch("openedx.core.djangoapps.user_api.accounts.forms.extract_extended_profile_fields_data") + def test_validate_with_extraction_errors(self, mock_extract: Mock): + """ + Test when extraction fails + """ + extended_profile_data = "invalid data" + mock_extract.return_value = ({}, {"extended_profile": {"developer_message": "Invalid format"}}) + + form, errors = validate_and_get_extended_profile_form(extended_profile_data, self.user) + + self.assertIsNone(form) # noqa: PT009 + self.assertIn("extended_profile", errors) # noqa: PT009 + + @patch("openedx.core.djangoapps.user_api.accounts.forms.extract_extended_profile_fields_data") + def test_validate_with_empty_data(self, mock_extract: Mock): + """ + Test when extracted data is empty + """ + extended_profile_data = [] + mock_extract.return_value = ({}, {}) + + form, errors = validate_and_get_extended_profile_form(extended_profile_data, self.user) + + self.assertIsNone(form) # noqa: PT009 + self.assertEqual(errors, {}) # noqa: PT009 + + @patch("openedx.core.djangoapps.user_api.accounts.forms.get_extended_profile_form") + @patch("openedx.core.djangoapps.user_api.accounts.forms.extract_extended_profile_fields_data") + def test_validate_with_form_errors(self, mock_extract: Mock, mock_get_form: Mock): + """ + Test when form validation fails + """ + extended_profile_data = [{"field_name": "department", "field_value": ""}] + mock_extract.return_value = ({"department": ""}, {}) + mock_form = Mock() + form_errors = {"department": {"developer_message": "Required field"}} + mock_get_form.return_value = (mock_form, form_errors) + + form, errors = validate_and_get_extended_profile_form(extended_profile_data, self.user) + + self.assertEqual(form, mock_form) # noqa: PT009 + self.assertIn("department", errors) # noqa: PT009 + + @patch("openedx.core.djangoapps.user_api.accounts.forms.get_extended_profile_form") + @patch("openedx.core.djangoapps.user_api.accounts.forms.extract_extended_profile_fields_data") + def test_validate_merges_errors(self, mock_extract: Mock, mock_get_form: Mock): + """ + Test that extraction and form errors are merged + """ + extended_profile_data = [{"field_name": "department", "field_value": "Engineering"}] + mock_extract.return_value = ({"department": "Engineering"}, {}) + mock_form = Mock() + form_errors = {"title": {"developer_message": "Required field"}} + mock_get_form.return_value = (mock_form, form_errors) + + form, errors = validate_and_get_extended_profile_form(extended_profile_data, self.user) + + self.assertEqual(form, mock_form) # noqa: PT009 + self.assertIn("title", errors) # noqa: PT009 diff --git a/openedx/core/djangoapps/user_api/accounts/tests/test_image_helpers.py b/openedx/core/djangoapps/user_api/accounts/tests/test_image_helpers.py index c02069ab7b16..d2714d5116f9 100644 --- a/openedx/core/djangoapps/user_api/accounts/tests/test_image_helpers.py +++ b/openedx/core/djangoapps/user_api/accounts/tests/test_image_helpers.py @@ -6,12 +6,12 @@ import datetime import hashlib from unittest.mock import patch +from zoneinfo import ZoneInfo from django.test import TestCase -from zoneinfo import ZoneInfo -from openedx.core.djangolib.testing.utils import skip_unless_lms from common.djangoapps.student.tests.factories import UserFactory +from openedx.core.djangolib.testing.utils import skip_unless_lms from ..image_helpers import get_profile_image_urls_for_user @@ -32,14 +32,14 @@ def setUp(self): # Ensure that parental controls don't apply to this user self.user.profile.year_of_birth = 1980 self.user.profile.profile_image_uploaded_at = TEST_PROFILE_IMAGE_UPLOAD_DT - self.user.profile.save() # lint-amnesty, pylint: disable=no-member + self.user.profile.save() # pylint: disable=no-member def verify_url(self, actual_url, expected_name, expected_pixels, expected_version): """ Verify correct url structure. """ assert actual_url == 'http://example-storage.com/profile-images/{name}_{size}.jpg?v={version}'\ - .format(name=expected_name, size=expected_pixels, version=expected_version) + .format(name=expected_name, size=expected_pixels, version=expected_version) # noqa: UP032 def verify_default_url(self, actual_url, expected_pixels): """ @@ -65,12 +65,12 @@ def test_get_profile_image_urls(self): Tests `get_profile_image_urls_for_user` """ self.user.profile.profile_image_uploaded_at = TEST_PROFILE_IMAGE_UPLOAD_DT - self.user.profile.save() # lint-amnesty, pylint: disable=no-member + self.user.profile.save() # pylint: disable=no-member expected_name = hashlib.md5(( 'secret' + str(self.user.username)).encode('utf-8')).hexdigest() actual_urls = get_profile_image_urls_for_user(self.user) self.verify_urls(actual_urls, expected_name, is_default=False) self.user.profile.profile_image_uploaded_at = None - self.user.profile.save() # lint-amnesty, pylint: disable=no-member + self.user.profile.save() # pylint: disable=no-member self.verify_urls(get_profile_image_urls_for_user(self.user), 'default', is_default=True) diff --git a/openedx/core/djangoapps/user_api/accounts/tests/test_models.py b/openedx/core/djangoapps/user_api/accounts/tests/test_models.py index c216a0ac55ae..a181ea73db35 100644 --- a/openedx/core/djangoapps/user_api/accounts/tests/test_models.py +++ b/openedx/core/djangoapps/user_api/accounts/tests/test_models.py @@ -5,16 +5,16 @@ import pytest +from common.djangoapps.student.models import get_retired_email_by_email, get_retired_username_by_username +from common.djangoapps.student.tests.factories import UserFactory from openedx.core.djangoapps.user_api.models import ( RetirementState, RetirementStateError, UserRetirementRequest, - UserRetirementStatus + UserRetirementStatus, ) -from common.djangoapps.student.models import get_retired_email_by_email, get_retired_username_by_username -from common.djangoapps.student.tests.factories import UserFactory -from .retirement_helpers import setup_retirement_states # pylint: disable=unused-import +from .retirement_helpers import setup_retirement_states # pylint: disable=unused-import # noqa: F401 # Tell pytest it's ok to use the database pytestmark = pytest.mark.django_db @@ -40,7 +40,7 @@ def _assert_retirementstatus_is_user(retirement, user): assert pending.state_name in retirement.responses -def test_retirement_create_success(setup_retirement_states): # pylint: disable=unused-argument, redefined-outer-name +def test_retirement_create_success(setup_retirement_states): # pylint: disable=unused-argument, redefined-outer-name # noqa: F811 """ Basic test to make sure default creation succeeds """ @@ -59,7 +59,7 @@ def test_retirement_create_no_default_state(): UserRetirementStatus.create_retirement(user) -def test_retirement_create_already_retired(setup_retirement_states): # pylint: disable=unused-argument, redefined-outer-name +def test_retirement_create_already_retired(setup_retirement_states): # pylint: disable=unused-argument, redefined-outer-name # noqa: F811 """ Confirm the correct error bubbles up if the user already has a retirement row """ @@ -80,7 +80,7 @@ def test_retirement_request_create_success(): assert UserRetirementRequest.has_user_requested_retirement(user) -def test_retirement_request_created_upon_status(setup_retirement_states): # pylint: disable=unused-argument, redefined-outer-name +def test_retirement_request_created_upon_status(setup_retirement_states): # pylint: disable=unused-argument, redefined-outer-name # noqa: F811 """ Ensure that retirement request record is created upon retirement status creation. """ @@ -89,7 +89,7 @@ def test_retirement_request_created_upon_status(setup_retirement_states): # pyl assert UserRetirementRequest.has_user_requested_retirement(user) -def test_retirement_request_deleted_upon_pending_status_delete(setup_retirement_states): # pylint: disable=unused-argument, redefined-outer-name +def test_retirement_request_deleted_upon_pending_status_delete(setup_retirement_states): # pylint: disable=unused-argument, redefined-outer-name # noqa: F811 """ Ensure that retirement request record is deleted upon deletion of a PENDING retirement status. """ @@ -102,7 +102,7 @@ def test_retirement_request_deleted_upon_pending_status_delete(setup_retirement_ assert not UserRetirementRequest.has_user_requested_retirement(user) -def test_retirement_request_preserved_upon_non_pending_status_delete(setup_retirement_states): # pylint: disable=unused-argument, redefined-outer-name +def test_retirement_request_preserved_upon_non_pending_status_delete(setup_retirement_states): # pylint: disable=unused-argument, redefined-outer-name # noqa: F811 """ Ensure that retirement request record is not deleted upon deletion of a non-PENDING retirement status. """ diff --git a/openedx/core/djangoapps/user_api/accounts/tests/test_permissions.py b/openedx/core/djangoapps/user_api/accounts/tests/test_permissions.py index 017255b74d59..adf4e14f88ba 100644 --- a/openedx/core/djangoapps/user_api/accounts/tests/test_permissions.py +++ b/openedx/core/djangoapps/user_api/accounts/tests/test_permissions.py @@ -5,17 +5,17 @@ from django.test import RequestFactory, TestCase -from common.djangoapps.student.tests.factories import ( # lint-amnesty, pylint: disable=line-too-long +from common.djangoapps.student.tests.factories import ( # pylint: disable=line-too-long AdminFactory, ContentTypeFactory, PermissionFactory, SuperuserFactory, - UserFactory + UserFactory, ) from openedx.core.djangoapps.user_api.accounts.permissions import ( CanCancelUserRetirement, CanDeactivateUser, - CanRetireUser + CanRetireUser, ) diff --git a/openedx/core/djangoapps/user_api/accounts/tests/test_retirement_views.py b/openedx/core/djangoapps/user_api/accounts/tests/test_retirement_views.py index 4f942417ae0e..44128bddfe4b 100644 --- a/openedx/core/djangoapps/user_api/accounts/tests/test_retirement_views.py +++ b/openedx/core/djangoapps/user_api/accounts/tests/test_retirement_views.py @@ -5,23 +5,17 @@ import datetime import json from unittest import mock +from zoneinfo import ZoneInfo import ddt -from zoneinfo import ZoneInfo -from consent.models import DataSharingConsent -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.contrib.sites.models import Site from django.core import mail from django.core.cache import cache +from django.db import connection from django.test import TestCase +from django.test.utils import CaptureQueriesContext from django.urls import reverse -from enterprise.models import ( - EnterpriseCourseEnrollment, - EnterpriseCustomer, - EnterpriseCustomerUser, - PendingEnterpriseCustomerUser -) -from integrated_channels.sap_success_factors.models import SapSuccessFactorsLearnerDataTransmissionAudit from opaque_keys.edx.keys import CourseKey from rest_framework import status from social_django.models import UserSocialAuth @@ -37,11 +31,12 @@ ManualEnrollmentAudit, PendingEmailChange, PendingNameChange, + PendingSecondaryEmailChange, Registration, SocialLink, UserProfile, get_retired_email_by_email, - get_retired_username_by_username + get_retired_username_by_username, ) from common.djangoapps.student.tests.factories import ( AccountRecoveryFactory, @@ -50,7 +45,7 @@ PendingEmailChangeFactory, PermissionFactory, SuperuserFactory, - UserFactory + UserFactory, ) from lms.djangoapps.certificates.api import get_certificate_for_user_id from lms.djangoapps.certificates.tests.factories import GeneratedCertificateFactory @@ -61,20 +56,19 @@ CreditProvider, CreditRequest, CreditRequirement, - CreditRequirementStatus + CreditRequirementStatus, ) from openedx.core.djangoapps.external_user_ids.models import ExternalIdType from openedx.core.djangoapps.oauth_dispatch.jwt import create_jwt_for_user -from openedx.core.djangoapps.site_configuration.tests.factories import SiteFactory +from openedx.core.djangoapps.oauth_dispatch.tests.factories import AccessTokenFactory, ApplicationFactory from openedx.core.djangoapps.user_api.accounts.views import AccountRetirementPartnerReportView from openedx.core.djangoapps.user_api.models import ( RetirementState, UserOrgTag, UserRetirementPartnerReportingStatus, - UserRetirementStatus + UserRetirementStatus, ) -from openedx.core.djangolib.testing.utils import skip_unless_lms -from openedx.core.djangoapps.oauth_dispatch.tests.factories import ApplicationFactory, AccessTokenFactory +from openedx.core.djangolib.testing.utils import assert_redact_before_delete, skip_unless_lms from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase from xmodule.modulestore.tests.factories import CourseFactory @@ -84,7 +78,7 @@ RetirementTestCase, create_retirement_status, fake_completed_retirement, - setup_retirement_states + setup_retirement_states, # noqa: F401 ) @@ -201,8 +195,8 @@ def build_post(self, password): @mock.patch('openedx.core.djangoapps.user_api.accounts.utils.retire_dot_oauth2_models') def test_user_can_deactivate_self(self, mock_retire_dot): """ - Verify a user calling the deactivation endpoint logs out the user, deletes all their SSO tokens, - and creates a user retirement row. + Verify a user calling the deactivation endpoint logs out the user, + redacts user account record, and creates a user retirement row. """ self.client.login(username=self.test_user.username, password=self.test_password) headers = build_jwt_headers(self.test_user) @@ -212,7 +206,7 @@ def test_user_can_deactivate_self(self, mock_retire_dot): updated_user = User.objects.get(id=self.test_user.id) assert get_retired_email_by_email(self.test_user.email) == updated_user.email assert not updated_user.has_usable_password() - assert not list(UserSocialAuth.objects.filter(user=self.test_user)) + assert list(UserSocialAuth.objects.filter(user=self.test_user)) assert not list(Registration.objects.filter(user=self.test_user)) assert len(UserRetirementStatus.objects.filter(user_id=self.test_user.id)) == 1 # these retirement utils are tested elsewhere; just make sure we called them @@ -602,14 +596,14 @@ def assert_status_and_user_list(self, expected_users, expected_status=status.HTT for config in orgs_config: config[AccountRetirementPartnerReportView.ORGS_CONFIG_FIELD_HEADINGS_KEY].sort() - self.assertCountEqual(returned_users, expected_users) + self.assertCountEqual(returned_users, expected_users) # noqa: PT009 def test_success(self): """ Basic test to make sure that users in two different orgs are returned. """ - user_dicts, users = self.create_partner_reporting_statuses() # lint-amnesty, pylint: disable=unused-variable - additional_dicts, additional_users = self.create_partner_reporting_statuses(courses=(self.course_awesome_org,)) # lint-amnesty, pylint: disable=unused-variable + user_dicts, users = self.create_partner_reporting_statuses() # pylint: disable=unused-variable + additional_dicts, additional_users = self.create_partner_reporting_statuses(courses=(self.course_awesome_org,)) # pylint: disable=unused-variable user_dicts += additional_dicts self.assert_status_and_user_list(user_dicts) @@ -618,7 +612,7 @@ def test_success_multiple_statuses(self): """ Checks that only users in the correct is_being_processed state (False) are returned. """ - user_dicts, users = self.create_partner_reporting_statuses() # lint-amnesty, pylint: disable=unused-variable + user_dicts, users = self.create_partner_reporting_statuses() # pylint: disable=unused-variable # These should not come back self.create_partner_reporting_statuses(courses=(self.course_awesome_org,), is_being_processed=True) @@ -644,7 +638,7 @@ def test_state_update(self): Checks that users are progressed to "is_being_processed" True upon being returned from this call. """ - user_dicts, users = self.create_partner_reporting_statuses() # lint-amnesty, pylint: disable=unused-variable + user_dicts, users = self.create_partner_reporting_statuses() # pylint: disable=unused-variable # First time through we should get the users self.assert_status_and_user_list(user_dicts) @@ -685,7 +679,7 @@ def assert_status_and_user_list( try: states_to_request = [s.state_name for s in states_to_request] except AttributeError: - states_to_request = states_to_request # lint-amnesty, pylint: disable=self-assigning-variable + states_to_request = states_to_request # pylint: disable=self-assigning-variable data = {'cool_off_days': cool_off_days, 'states': states_to_request} response = self.client.get(self.url, data, **self.headers) @@ -699,7 +693,7 @@ def assert_status_and_user_list( del retirement['created'] del retirement['modified'] - self.assertCountEqual(response_data, expected_data) + self.assertCountEqual(response_data, expected_data) # noqa: PT009 def test_empty(self): """ @@ -884,7 +878,7 @@ def assert_status_and_user_list( except KeyError: pass - self.assertCountEqual(response_data, expected_data) + self.assertCountEqual(response_data, expected_data) # noqa: PT009 def test_empty(self): """ @@ -926,7 +920,7 @@ def test_date_filter(self): complete_state = RetirementState.objects.get(state_name='COMPLETE') # Create retirements for the last 10 days - for days_back in range(0, 10): # lint-amnesty, pylint: disable=simplifiable-range + for days_back in range(0, 10): # pylint: disable=simplifiable-range create_datetime = datetime.datetime.now(ZoneInfo("UTC")) - datetime.timedelta(days=days_back) ret = create_retirement_status(UserFactory(), state=complete_state, create_datetime=create_datetime) retirements.append(self._retirement_to_dict(ret)) @@ -1005,7 +999,7 @@ def assert_status_and_user_data(self, expected_data, expected_status=status.HTTP del data['created'] del data['modified'] - self.assertDictEqual(response_data, expected_data) + self.assertDictEqual(response_data, expected_data) # noqa: PT009 return response_data def test_no_retirement(self): @@ -1078,9 +1072,109 @@ def cleanup_and_assert_status(self, data=None, expected_status=status.HTTP_204_N assert response.status_code == expected_status return response - def test_simple_success(self): + def _assert_redacted_update_delete_queries(self, queries, redacted_username, redacted_email, redacted_name): + """ + Helper method to verify UPDATE and DELETE queries use ID-based filtering and correct field-value assignments. + Args: + queries: List of captured query dicts from CaptureQueriesContext + redacted_username: Expected redacted username value + redacted_email: Expected redacted email value + redacted_name: Expected redacted name value + """ + update_queries = [q for q in queries if 'UPDATE' in q['sql'] and 'user_api_userretirementstatus' in q['sql']] + delete_queries = [q for q in queries if 'DELETE' in q['sql'] and 'user_api_userretirementstatus' in q['sql']] + # Should have exactly 1 bulk UPDATE and 1 bulk DELETE query (not individual per-record queries) + assert len(update_queries) == 1, f"Expected 1 UPDATE query, found {len(update_queries)}" + assert len(delete_queries) == 1, f"Expected 1 DELETE query, found {len(delete_queries)}" + # Verify UPDATE query redacts records with the correct field-value assignments and uses ID-based filtering + update_query = update_queries[0] + sql_lower = update_query['sql'] + # Ensure original_username, original_email, and original_name are set to redacted values + assert f'"original_username" = \'{redacted_username}\'' in sql_lower, ( + f"UPDATE query missing '\"original_username\" = {redacted_username}': {sql_lower}" + ) + assert f'"original_email" = \'{redacted_email}\'' in sql_lower, ( + f"UPDATE query missing '\"original_email\" = {redacted_email}': {sql_lower}" + ) + assert f'"original_name" = \'{redacted_name}\'' in sql_lower, ( + f"UPDATE query missing '\"original_name\" = {redacted_name}': {sql_lower}" + ) + # Ensure UPDATE uses ID-based filtering + assert '"id" IN' in sql_lower or 'WHERE "id"' in sql_lower, ( + f"UPDATE query should use ID filtering to prevent over-update, but got: {sql_lower}" + ) + # Verify DELETE is from the correct table and uses ID-based filtering + delete_query = delete_queries[0] + sql_lower = delete_query['sql'] + assert 'user_api_userretirementstatus' in sql_lower, ( + f"DELETE query against unexpected table: {sql_lower}" + ) + assert '"id" IN' in sql_lower or 'WHERE "id"' in sql_lower, ( + f"DELETE query should use ID filtering to prevent over-deletion, but got: {sql_lower}" + ) + + def test_default_redacted_values(self): + """ + Test basic cleanup with default redacted values. + Verify that redaction (UPDATE) happens before deletion (DELETE). + Captures actual SQL queries to ensure UPDATE queries contain correct field-value assignments. + """ + with CaptureQueriesContext(connection) as context: + self.cleanup_and_assert_status() + + # Verify records are deleted after redaction + retirements = UserRetirementStatus.objects.all() + assert retirements.count() == 0 + + # Verify UPDATE and DELETE queries with default 'redacted' value + self._assert_redacted_update_delete_queries(context.captured_queries, 'redacted', 'redacted', 'redacted') + + def test_custom_redacted_values(self): + """Test that custom redacted values are applied before deletion.""" + custom_username = 'username-redacted-12345' + custom_email = 'email-redacted-67890' + custom_name = 'name-redacted-abcde' + + data = { + 'usernames': self.usernames, + 'redacted_username': custom_username, + 'redacted_email': custom_email, + 'redacted_name': custom_name + } + + with CaptureQueriesContext(connection) as context: + self.cleanup_and_assert_status(data=data) + + # Verify records are deleted after redaction + retirements = UserRetirementStatus.objects.all() + assert retirements.count() == 0 + + # Verify UPDATE and DELETE queries with custom redacted values + self._assert_redacted_update_delete_queries( + context.captured_queries, custom_username, custom_email, custom_name + ) + + def test_does_not_delete_unrelated_redacted_records(self): + """ + Verify cleanup doesn't delete unrelated records with coincidental redacted values. + Regression test for over-deletion bug where deletion was filtered by field values + (original_username='redacted') instead of by primary key. + """ + # Create an unrelated record that already has redacted field values + other_user = UserFactory() + other_retirement = create_retirement_status(other_user, state=self.complete_state) + other_retirement.original_username = 'redacted' + other_retirement.original_email = 'redacted' + other_retirement.original_name = 'redacted' + other_retirement.save() + other_id = other_retirement.id + # Clean up only self.usernames records self.cleanup_and_assert_status() - assert not UserRetirementStatus.objects.all() + # Verify target records were deleted + target_count = UserRetirementStatus.objects.filter(user__username__in=self.usernames).count() + assert target_count == 0, f"Expected 0 target records, found {target_count}" + # Verify unrelated record was NOT deleted (not a target of cleanup) + assert UserRetirementStatus.objects.filter(id=other_id).exists() def test_leaves_other_users(self): remaining_usernames = [] @@ -1289,33 +1383,6 @@ def setUp(self): self.cache_key = UserProfile.country_cache_key_name(self.test_user.id) cache.set(self.cache_key, 'Timor-leste') - # Enterprise model setup - self.course_id = 'course-v1:edX+DemoX.1+2T2017' - self.enterprise_customer = EnterpriseCustomer.objects.create( - name='test_enterprise_customer', - site=SiteFactory.create() - ) - self.enterprise_user = EnterpriseCustomerUser.objects.create( - enterprise_customer=self.enterprise_customer, - user_id=self.test_user.id, - ) - self.enterprise_enrollment = EnterpriseCourseEnrollment.objects.create( - enterprise_customer_user=self.enterprise_user, - course_id=self.course_id - ) - self.pending_enterprise_user = PendingEnterpriseCustomerUser.objects.create( - enterprise_customer_id=self.enterprise_user.enterprise_customer_id, - user_email=self.test_user.email - ) - self.sapsf_audit = SapSuccessFactorsLearnerDataTransmissionAudit.objects.create( - sapsf_user_id=self.test_user.id, - enterprise_course_enrollment_id=self.enterprise_enrollment.id, - ) - self.consent = DataSharingConsent.objects.create( - username=self.test_user.username, - enterprise_customer=self.enterprise_customer, - ) - # Entitlement model setup self.entitlement = CourseEntitlementFactory.create(user=self.test_user) self.entitlement_support_detail = CourseEntitlementSupportDetail.objects.create( @@ -1329,6 +1396,18 @@ def setUp(self): UserOrgTagFactory.create(user=self.test_user, key='foo', value='bar') UserOrgTagFactory.create(user=self.test_user, key='cat', value='dog') + # Secondary email setup + PendingSecondaryEmailChange.objects.create( + user=self.test_user, + new_secondary_email='pending_secondary@example.com', + activation_key='test_activation_key_123' + ) + AccountRecovery.objects.create( + user=self.test_user, + secondary_email='confirmed_secondary@example.com', + is_active=True + ) + CourseEnrollmentAllowedFactory.create(email=self.original_email) self.course_key = CourseKey.from_string('course-v1:edX+DemoX+Demo_Course') @@ -1348,17 +1427,6 @@ def setUp(self): self.headers['content_type'] = "application/json" self.url = reverse('accounts_retire') - def _data_sharing_consent_assertions(self): - """ - Helper method for asserting that ``DataSharingConsent`` objects are retired. - """ - self.consent.refresh_from_db() - assert self.retired_username == self.consent.username - test_users_data_sharing_consent = DataSharingConsent.objects.filter( - username=self.original_username - ) - assert not test_users_data_sharing_consent.exists() - def _entitlement_support_detail_assertions(self): """ Helper method for asserting that ``CourseEntitleSupportDetail`` objects are retired. @@ -1366,28 +1434,6 @@ def _entitlement_support_detail_assertions(self): self.entitlement_support_detail.refresh_from_db() assert '' == self.entitlement_support_detail.comments - def _pending_enterprise_customer_user_assertions(self): - """ - Helper method for asserting that ``PendingEnterpriseCustomerUser`` objects are retired. - """ - self.pending_enterprise_user.refresh_from_db() - assert self.retired_email == self.pending_enterprise_user.user_email - pending_enterprise_users = PendingEnterpriseCustomerUser.objects.filter( - user_email=self.original_email - ) - assert not pending_enterprise_users.exists() - - def _sapsf_audit_assertions(self): - """ - Helper method for asserting that ``SapSuccessFactorsLearnerDataTransmissionAudit`` objects are retired. - """ - self.sapsf_audit.refresh_from_db() - assert '' == self.sapsf_audit.sapsf_user_id - audits_for_original_user_id = SapSuccessFactorsLearnerDataTransmissionAudit.objects.filter( - sapsf_user_id=self.test_user.id, - ) - assert not audits_for_original_user_id.exists() - def post_and_assert_status(self, data, expected_status=status.HTTP_204_NO_CONTENT): """ Helper function for making a request to the retire subscriptions endpoint, and asserting the status. @@ -1436,7 +1482,14 @@ def test_retire_user_where_username_not_provided(self): @mock.patch('openedx.core.djangoapps.user_api.accounts.views.remove_profile_images') def test_retire_user(self, mock_remove_profile_images, mock_get_profile_image_names): data = {'username': self.original_username} - self.post_and_assert_status(data) + with CaptureQueriesContext(connection) as ctx: + self.post_and_assert_status(data) + + assert_redact_before_delete( + [q['sql'] for q in ctx], + table=PendingEmailChange._meta.db_table, + expected_redacted_value_list=['redacted-before-delete@safe.com'], + ) self.test_user.refresh_from_db() self.test_user.profile.refresh_from_db() # pylint: disable=no-member @@ -1446,6 +1499,7 @@ def test_retire_user(self, mock_remove_profile_images, mock_get_profile_image_na 'last_name': '', 'is_active': False, 'username': self.retired_username, + 'email': self.retired_email, } for field, expected_value in expected_user_values.items(): assert expected_value == getattr(self.test_user, field) @@ -1463,14 +1517,15 @@ def test_retire_user(self, mock_remove_profile_images, mock_get_profile_image_na assert cache.get(self.cache_key) is None - self._data_sharing_consent_assertions() - self._sapsf_audit_assertions() - self._pending_enterprise_customer_user_assertions() self._entitlement_support_detail_assertions() assert not PendingEmailChange.objects.filter(user=self.test_user).exists() assert not UserOrgTag.objects.filter(user=self.test_user).exists() + # Verify secondary email models were cleaned + assert not PendingSecondaryEmailChange.objects.filter(user=self.test_user).exists() + assert not AccountRecovery.objects.filter(user=self.test_user).exists() + assert not CourseEnrollmentAllowed.objects.filter(email=self.original_email).exists() assert not UnregisteredLearnerCohortAssignments.objects.filter(email=self.original_email).exists() @@ -1480,6 +1535,21 @@ def test_retire_user_twice_idempotent(self): fake_completed_retirement(self.test_user) self.post_and_assert_status(data) + @mock.patch('openedx.core.djangoapps.user_api.accounts.views.USER_RETIRE_LMS_CRITICAL') + def test_retirement_sends_critical_signal_with_retirement_data(self, mock_signal): + """ + USER_RETIRE_LMS_CRITICAL is sent with retired_username and retired_email kwargs. + """ + data = {'username': self.original_username} + self.post_and_assert_status(data) + + mock_signal.send.assert_called_once_with( + sender=mock_signal.send.call_args[1]['sender'], + user=mock_signal.send.call_args[1]['user'], + retired_username=self.retired_username, + retired_email=self.retired_email, + ) + def test_deletes_pii_from_user_profile(self): for model_field, value_to_assign in USER_PROFILE_PII.items(): if value_to_assign == '': @@ -1520,18 +1590,6 @@ def test_can_delete_user_profiles_country_cache(self): AccountRetirementView.delete_users_country_cache(self.test_user) assert cache.get(self.cache_key) is None - def test_can_retire_users_datasharingconsent(self): - AccountRetirementView.retire_users_data_sharing_consent(self.test_user.username, self.retired_username) - self._data_sharing_consent_assertions() - - def test_can_retire_users_sap_success_factors_audits(self): - AccountRetirementView.retire_sapsf_data_transmission(self.test_user) - self._sapsf_audit_assertions() - - def test_can_retire_user_from_pendingenterprisecustomeruser(self): - AccountRetirementView.retire_user_from_pending_enterprise_customer_user(self.test_user, self.retired_email) - self._pending_enterprise_customer_user_assertions() - def test_course_entitlement_support_detail_comments_are_retired(self): AccountRetirementView.retire_entitlement_support_detail(self.test_user) self._entitlement_support_detail_assertions() @@ -1584,14 +1642,14 @@ def setUp(self): ArticleRevision.objects.create(ip_address="ipaddresss", user=self.test_user, article=article) # ManualEnrollmentAudit setup - course_enrollment = CourseEnrollment.enroll(user=self.test_user, course_key=self.course.id) # lint-amnesty, pylint: disable=no-member + course_enrollment = CourseEnrollment.enroll(user=self.test_user, course_key=self.course.id) # pylint: disable=no-member ManualEnrollmentAudit.objects.create( enrollment=course_enrollment, reason=self.pii_standin, enrolled_email=self.pii_standin ) # CreditRequest and CreditRequirementStatus setup provider = CreditProvider.objects.create(provider_id="Hogwarts") - credit_course = CreditCourse.objects.create(course_key=self.course.id) # lint-amnesty, pylint: disable=no-member + credit_course = CreditCourse.objects.create(course_key=self.course.id) # pylint: disable=no-member CreditRequest.objects.create( username=self.test_user.username, course=credit_course, @@ -1667,3 +1725,42 @@ def test_retire_user_twice_idempotent(self): self.post_and_assert_status(data) fake_completed_retirement(self.test_user) self.post_and_assert_status(data) + + @mock.patch('openedx.core.djangoapps.user_api.accounts.views.USER_RETIRE_MAILINGS') + @mock.patch('openedx.core.djangoapps.user_api.accounts.views.USER_RETIRE_LMS_MISC') + @mock.patch('openedx.core.djangoapps.user_api.accounts.views.redact_and_delete_historical_social_auth') + @mock.patch('openedx.core.djangoapps.user_api.accounts.views.CreditRequirementStatus.retire_user') + @mock.patch('openedx.core.djangoapps.user_api.accounts.views.ApiAccessRequest.retire_user') + @mock.patch('openedx.core.djangoapps.user_api.accounts.views.CreditRequest.retire_user') + @mock.patch('openedx.core.djangoapps.user_api.accounts.views.ManualEnrollmentAudit.retire_manual_enrollments') + @mock.patch('openedx.core.djangoapps.user_api.accounts.views.PendingNameChange.delete_by_user_value') + @mock.patch('openedx.core.djangoapps.user_api.accounts.views.ArticleRevision.retire_user') + @mock.patch('openedx.core.djangoapps.user_api.accounts.views.RevisionPluginRevision.retire_user') + def test_retire_misc_calls_all_retirement_steps( + self, + mock_revision_plugin, + mock_article_revision, + mock_pending_name, + mock_manual_enroll, + mock_credit_request, + mock_api_access, + mock_credit_req_status, + mock_redact_historical, + mock_lms_misc_signal, + mock_mailings_signal, + ): + """ + Ensure that all retirement steps in the retire_misc view are invoked. + """ + self.post_and_assert_status({'username': self.original_username}) + + mock_revision_plugin.assert_called_once() + mock_article_revision.assert_called_once() + mock_pending_name.assert_called_once() + mock_manual_enroll.assert_called_once() + mock_credit_request.assert_called_once() + mock_api_access.assert_called_once() + mock_credit_req_status.assert_called_once() + mock_redact_historical.assert_called_once() + mock_lms_misc_signal.send.assert_called_once() + mock_mailings_signal.send.assert_called_once() diff --git a/openedx/core/djangoapps/user_api/accounts/tests/test_serializers.py b/openedx/core/djangoapps/user_api/accounts/tests/test_serializers.py index 34b4cb0b0e0a..6fac6196aa14 100644 --- a/openedx/core/djangoapps/user_api/accounts/tests/test_serializers.py +++ b/openedx/core/djangoapps/user_api/accounts/tests/test_serializers.py @@ -2,21 +2,22 @@ Test cases to cover Accounts-related serializers of the User API application """ - import logging +from unittest.mock import Mock, patch from django.test import TestCase from django.test.client import RequestFactory +from django.test.utils import override_settings from testfixtures import LogCapture -from openedx.core.djangoapps.user_api.accounts.serializers import UserReadOnlySerializer from common.djangoapps.student.models import UserProfile from common.djangoapps.student.tests.factories import UserFactory +from openedx.core.djangoapps.user_api.accounts.serializers import UserReadOnlySerializer, get_extended_profile LOGGER_NAME = "openedx.core.djangoapps.user_api.accounts.serializers" -class UserReadOnlySerializerTest(TestCase): # lint-amnesty, pylint: disable=missing-class-docstring +class UserReadOnlySerializerTest(TestCase): # pylint: disable=missing-class-docstring def setUp(self): super().setUp() request_factory = RequestFactory() @@ -52,3 +53,148 @@ def test_user_no_profile(self): assert data['username'] == self.user.username assert data['name'] is None + + +class GetExtendedProfileTest(TestCase): + """ + Tests for get_extended_profile function + """ + + def setUp(self): + super().setUp() + self.user = UserFactory.create() + self.user_profile = UserProfile.objects.get(user=self.user) + + @patch("openedx.core.djangoapps.user_api.accounts.serializers.configuration_helpers") + @patch("openedx.core.djangoapps.user_api.accounts.serializers.get_extended_profile_model") + def test_get_extended_profile_from_model(self, mock_get_model: Mock, mock_config_helpers: Mock): + """ + Test getting extended profile from a custom model + """ + mock_config_helpers.get_value.return_value = ["department", "title", "company"] + mock_model = Mock() + mock_instance = Mock() + mock_instance.department = "Engineering" + mock_instance.title = "Software Engineer" + mock_instance.company = "EdX" + mock_instance.user = self.user + mock_model.objects.get.return_value = mock_instance + mock_get_model.return_value = mock_model + + with patch("openedx.core.djangoapps.user_api.accounts.serializers.model_to_dict") as mock_model_to_dict: + mock_model_to_dict.return_value = { + "department": "Engineering", + "title": "Software Engineer", + "company": "EdX", + "user": self.user.id, + } + + result = get_extended_profile(self.user_profile) + + self.assertEqual(len(result), 3) # noqa: PT009 + self.assertIn({"field_name": "department", "field_value": "Engineering"}, result) # noqa: PT009 + self.assertIn({"field_name": "title", "field_value": "Software Engineer"}, result) # noqa: PT009 + self.assertIn({"field_name": "company", "field_value": "EdX"}, result) # noqa: PT009 + + @override_settings(REGISTRATION_EXTENSION_FORM=None) + @patch("openedx.core.djangoapps.user_api.accounts.serializers.configuration_helpers") + def test_get_extended_profile_model_does_not_exist(self, mock_config_helpers: Mock): + """ + Test fallback to meta field when model instance doesn't exist + """ + mock_config_helpers.get_value.return_value = ["department", "title"] + self.user_profile.set_meta({"department": "Sales", "title": "Manager"}) + self.user_profile.save() + + result = get_extended_profile(self.user_profile) + + self.assertEqual(len(result), 2) # noqa: PT009 + self.assertIn({"field_name": "department", "field_value": "Sales"}, result) # noqa: PT009 + self.assertIn({"field_name": "title", "field_value": "Manager"}, result) # noqa: PT009 + + @patch("openedx.core.djangoapps.user_api.accounts.serializers.configuration_helpers") + @patch("openedx.core.djangoapps.user_api.accounts.serializers.get_extended_profile_model") + def test_get_extended_profile_no_model_configured(self, mock_get_model: Mock, mock_config_helpers: Mock): + """ + Test fallback to meta field when no model is configured + """ + mock_config_helpers.get_value.return_value = ["department", "title"] + mock_get_model.return_value = None + meta_data = {"department": "Marketing", "title": "Director"} + self.user_profile.set_meta(meta_data) + self.user_profile.save() + + result = get_extended_profile(self.user_profile) + + self.assertEqual(len(result), 2) # noqa: PT009 + self.assertIn({"field_name": "department", "field_value": "Marketing"}, result) # noqa: PT009 + self.assertIn({"field_name": "title", "field_value": "Director"}, result) # noqa: PT009 + + @patch("openedx.core.djangoapps.user_api.accounts.serializers.configuration_helpers") + @patch("openedx.core.djangoapps.user_api.accounts.serializers.get_extended_profile_model") + def test_get_extended_profile_empty_meta(self, mock_get_model: Mock, mock_config_helpers: Mock): + """ + Test getting extended profile with empty meta field + """ + mock_config_helpers.get_value.return_value = ["department", "title"] + mock_get_model.return_value = None + self.user_profile.meta = "" + self.user_profile.save() + + result = get_extended_profile(self.user_profile) + + self.assertEqual(len(result), 2) # noqa: PT009 + self.assertIn({"field_name": "department", "field_value": ""}, result) # noqa: PT009 + self.assertIn({"field_name": "title", "field_value": ""}, result) # noqa: PT009 + + @patch("openedx.core.djangoapps.user_api.accounts.serializers.configuration_helpers") + @patch("openedx.core.djangoapps.user_api.accounts.serializers.get_extended_profile_model") + def test_get_extended_profile_invalid_json_in_meta(self, mock_get_model: Mock, mock_config_helpers: Mock): + """ + Test getting extended profile with invalid JSON in meta field + """ + mock_config_helpers.get_value.return_value = ["department", "title"] + mock_get_model.return_value = None + self.user_profile.meta = "invalid json {" + self.user_profile.save() + + result = get_extended_profile(self.user_profile) + + self.assertEqual(len(result), 2) # noqa: PT009 + self.assertIn({"field_name": "department", "field_value": ""}, result) # noqa: PT009 + self.assertIn({"field_name": "title", "field_value": ""}, result) # noqa: PT009 + + @patch("openedx.core.djangoapps.user_api.accounts.serializers.configuration_helpers") + @patch("openedx.core.djangoapps.user_api.accounts.serializers.get_extended_profile_model") + def test_get_extended_profile_missing_fields(self, mock_get_model: Mock, mock_config_helpers: Mock): + """ + Test getting extended profile when some configured fields are missing + """ + mock_config_helpers.get_value.return_value = ["department", "title", "location"] + mock_get_model.return_value = None + meta_data = {"department": "HR", "title": "Recruiter"} + self.user_profile.set_meta(meta_data) + self.user_profile.save() + + result = get_extended_profile(self.user_profile) + + self.assertEqual(len(result), 3) # noqa: PT009 + self.assertIn({"field_name": "department", "field_value": "HR"}, result) # noqa: PT009 + self.assertIn({"field_name": "title", "field_value": "Recruiter"}, result) # noqa: PT009 + self.assertIn({"field_name": "location", "field_value": ""}, result) # noqa: PT009 + + @patch("openedx.core.djangoapps.user_api.accounts.serializers.configuration_helpers") + @patch("openedx.core.djangoapps.user_api.accounts.serializers.get_extended_profile_model") + def test_get_extended_profile_no_configured_fields(self, mock_get_model: Mock, mock_config_helpers: Mock): + """ + Test getting extended profile when no fields are configured + """ + mock_config_helpers.get_value.return_value = [] + mock_get_model.return_value = None + meta_data = {"department": "Finance", "title": "Analyst"} + self.user_profile.set_meta(meta_data) + self.user_profile.save() + + result = get_extended_profile(self.user_profile) + + self.assertEqual(len(result), 0) # noqa: PT009 diff --git a/openedx/core/djangoapps/user_api/accounts/tests/test_signals.py b/openedx/core/djangoapps/user_api/accounts/tests/test_signals.py new file mode 100644 index 000000000000..7a6d6bd87fd5 --- /dev/null +++ b/openedx/core/djangoapps/user_api/accounts/tests/test_signals.py @@ -0,0 +1,76 @@ +""" +Tests for user_api accounts signals. +""" + +import logging +from unittest.mock import patch + +from django.test import TestCase +from social_django.models import UserSocialAuth + +from common.djangoapps.student.tests.factories import UserFactory +from openedx.core.djangoapps.user_api.accounts.signals import get_redacted_social_auth_uid +from openedx.core.djangolib.testing.utils import skip_unless_lms + + +@skip_unless_lms +class RedactSocialAuthPIIOnDeleteSignalTest(TestCase): + """ + Tests for the redact_social_auth_pii_before_deletion pre_delete signal handler. + """ + + def setUp(self): + super().setUp() + self.user = UserFactory.create(username='testuser', email='testuser@example.com') + + def _create_social_auth(self, uid='user@example.com', extra_data=None): + if extra_data is None: + extra_data = {'email': 'user@example.com', 'name': 'Test User'} + return UserSocialAuth.objects.create( + user=self.user, + provider='google-oauth2', + uid=uid, + extra_data=extra_data, + ) + + def test_get_redacted_social_auth_uid_format(self): + """ + Test that get_redacted_social_auth_uid returns the expected string format. + + This is the single source of truth for the redacted uid format. + """ + assert get_redacted_social_auth_uid(42) == 'redacted-before-delete-42@safe.com' + assert get_redacted_social_auth_uid(1) == 'redacted-before-delete-1@safe.com' + + @patch('openedx.core.djangoapps.user_api.accounts.signals.redact_and_delete_social_auth') + def test_signal_warns_and_redacts_when_not_already_redacted(self, mock_redact): + """ + When a UserSocialAuth is deleted without prior redaction, the signal handler + should log a warning and call redact_and_delete_social_auth with skip_delete=True. + """ + social_auth = self._create_social_auth() + + with self.assertLogs( + 'openedx.core.djangoapps.user_api.accounts.signals', level=logging.WARNING + ) as log_ctx: + social_auth.delete() + + mock_redact.assert_called_once_with(self.user.id, skip_delete=True) + assert any('was deleted without first being redacted' in msg for msg in log_ctx.output) + + @patch('openedx.core.djangoapps.user_api.accounts.signals.redact_and_delete_social_auth') + def test_signal_skips_warning_and_redaction_when_already_redacted(self, mock_redact): + """ + When a UserSocialAuth is already redacted before deletion, the signal handler + should not log a warning and should not call redact_and_delete_social_auth. + """ + social_auth = self._create_social_auth() + social_auth.uid = get_redacted_social_auth_uid(social_auth.pk) + social_auth.extra_data = {} + social_auth.save(update_fields=['uid', 'extra_data']) + social_auth_id = social_auth.id + + social_auth.delete() + + mock_redact.assert_not_called() + assert not UserSocialAuth.objects.filter(id=social_auth_id).exists() diff --git a/openedx/core/djangoapps/user_api/accounts/tests/test_utils.py b/openedx/core/djangoapps/user_api/accounts/tests/test_utils.py index 9593dda0569a..e8cac9c524ff 100644 --- a/openedx/core/djangoapps/user_api/accounts/tests/test_utils.py +++ b/openedx/core/djangoapps/user_api/accounts/tests/test_utils.py @@ -1,27 +1,60 @@ -""" Unit tests for custom UserProfile properties. """ +""" +Unit tests for user account utility functions. +Includes tests for social links, social-auth PII redaction, completion, etc. +""" + +from contextlib import contextmanager import ddt from completion import models from completion.test_utils import CompletionWaffleTestMixin +from django.db import connection +from django.db.models.signals import pre_delete from django.test import TestCase -from django.test.utils import override_settings +from django.test.utils import CaptureQueriesContext, override_settings +from django.utils import timezone +from social_django.models import UserSocialAuth -from openedx.core.djangoapps.user_api.accounts.utils import retrieve_last_sitewide_block_completed -from openedx.core.djangolib.testing.utils import skip_unless_lms from common.djangoapps.student.models import CourseEnrollment from common.djangoapps.student.tests.factories import UserFactory -from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory, BlockFactory # lint-amnesty, pylint: disable=wrong-import-order +from openedx.core.djangoapps.user_api.accounts.signals import redact_social_auth_pii_before_deletion +from openedx.core.djangoapps.user_api.accounts.utils import ( + REDACTED_SOCIAL_AUTH_UID_PREFIX, + redact_and_delete_historical_social_auth, + redact_and_delete_social_auth, + retrieve_last_sitewide_block_completed, +) +from openedx.core.djangolib.testing.utils import assert_redact_before_delete, skip_unless_lms +from xmodule.modulestore.tests.django_utils import ( + SharedModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import ( # pylint: disable=wrong-import-order + BlockFactory, + CourseFactory, +) from ..utils import format_social_link, validate_social_link +# Use a context manager to guarantee signal reconnection between tests. +@contextmanager +def disconnected_social_auth_redaction_signal(): + """ + Temporarily disconnect the fallback signal so tests exercise the helper path. + """ + pre_delete.disconnect(redact_social_auth_pii_before_deletion, sender=UserSocialAuth) + try: + yield + finally: + pre_delete.connect(redact_social_auth_pii_before_deletion, sender=UserSocialAuth) + + @ddt.ddt class UserAccountSettingsTest(TestCase): """Unit tests for setting Social Media Links.""" - def setUp(self): # lint-amnesty, pylint: disable=useless-super-delegation + def setUp(self): # pylint: disable=useless-super-delegation super().setUp() def validate_social_link(self, social_platform, link): @@ -120,7 +153,7 @@ def test_retrieve_last_sitewide_block_completed(self): ) assert block_url ==\ 'test_url:9999/courses/course-v1:{org}+{course}+{run}/jump_to/'\ - 'block-v1:{org}+{course}+{run}+type@vertical+block@{vertical_id}'.format( + 'block-v1:{org}+{course}+{run}+type@vertical+block@{vertical_id}'.format( # noqa: UP032 org=self.course.location.course_key.org, course=self.course.location.course_key.course, run=self.course.location.course_key.run, @@ -128,3 +161,138 @@ def test_retrieve_last_sitewide_block_completed(self): ) assert empty_block_url is None + + +@ddt.ddt +@skip_unless_lms +class RedactAndDeleteSocialAuthTest(TestCase): + """ + Tests for the redact_and_delete_social_auth utility function. + """ + + def setUp(self): + super().setUp() + self.user = UserFactory.create(username='testuser', email='testuser@example.com') + + def create_social_auth(self, provider='google-oauth2', uid='user@example.com', extra_data=None): + """ + Helper method to create UserSocialAuth instances for testing. + """ + extra_data = extra_data or { + 'email': f'{provider}@example.com', + 'name': f'{provider.capitalize()} User', + 'id': '123456789', + } + return UserSocialAuth.objects.create( + user=self.user, + provider=provider, + uid=uid, + extra_data=extra_data, + ) + + @ddt.data( + [ + ( + 'google-oauth2', + 'google@example.com', + {'email': 'google@example.com', 'name': 'Google User'}, + ), + ], + [ + ( + 'google-oauth2', + 'google@example.com', + {'email': 'google@example.com', 'name': 'Google User'}, + ), + ( + 'tpa-saml', + 'saml@example.com', + {'email': 'saml@example.com', 'name': 'SAML User', 'uid': 'saml-uid'}, + ), + ], + ) + def test_redact_and_delete_redacts_sso_records(self, social_auth_records): + """ + Test that redact_and_delete_social_auth redacts and deletes all SSO records for a user. + """ + social_auth_ids = [ + self.create_social_auth(provider=provider, uid=uid, extra_data=extra_data).pk + for provider, uid, extra_data in social_auth_records + ] + + with disconnected_social_auth_redaction_signal(), CaptureQueriesContext(connection) as ctx: + redact_and_delete_social_auth(self.user.id) + + assert_redact_before_delete( + [query['sql'] for query in ctx], + table=UserSocialAuth._meta.db_table, + expected_redacted_value_list=[REDACTED_SOCIAL_AUTH_UID_PREFIX], + ) + assert not UserSocialAuth.objects.filter(id__in=social_auth_ids).exists() + + +@skip_unless_lms +class RedactAndDeleteHistoricalSocialAuthTest(TestCase): + """ + Tests for the redact_and_delete_historical_social_auth utility function. + """ + + def setUp(self): + super().setUp() + self.user = UserFactory.create(username='testuser', email='testuser@example.com') + self.historical_social_auth_model = UserSocialAuth.history.model + + def _create_historical_record( + self, + provider='google-oauth2', + uid='user@example.com', + extra_data=None, + source_id=1, + user=None, + ): + """ + Create a HistoricalUserSocialAuth record directly for test setup. + """ + if extra_data is None: + extra_data = {'email': uid, 'name': 'Test User'} + user = user or self.user + self.historical_social_auth_model.objects.create( + user=user, + id=source_id, + provider=provider, + uid=uid, + extra_data=extra_data, + created=timezone.now(), + modified=timezone.now(), + history_date=timezone.now(), + history_type='+', + ) + + def test_historical_social_auth_redact_before_delete(self): + """ + Ensure HistoricalUserSocialAuth records are properly redacted and deleted for retirement. + + The fields uid (email format) and extra_data must be redacted before delete. + """ + self._create_historical_record(provider='google-oauth2', uid='google@example.com', source_id=1) + self._create_historical_record(provider='tpa-saml', uid='saml@example.com', source_id=2) + + other_user = UserFactory.create(username='otheruser', email='other@example.com') + self._create_historical_record( + provider='google-oauth2', + uid='other@example.com', + extra_data={}, + source_id=3, + user=other_user, + ) + + with CaptureQueriesContext(connection) as ctx: + redact_and_delete_historical_social_auth(self.user.id) + + assert_redact_before_delete( + [query['sql'] for query in ctx], + table=self.historical_social_auth_model._meta.db_table, + expected_redacted_value_list=[REDACTED_SOCIAL_AUTH_UID_PREFIX], + ) + assert not self.historical_social_auth_model.objects.filter(user=self.user).exists() + assert self.historical_social_auth_model.objects.filter(user=other_user).exists() diff --git a/openedx/core/djangoapps/user_api/accounts/tests/test_views.py b/openedx/core/djangoapps/user_api/accounts/tests/test_views.py index 45b1773e4f02..f3f37c2f1469 100644 --- a/openedx/core/djangoapps/user_api/accounts/tests/test_views.py +++ b/openedx/core/djangoapps/user_api/accounts/tests/test_views.py @@ -8,9 +8,9 @@ from copy import deepcopy from unittest import mock from urllib.parse import quote +from zoneinfo import ZoneInfo import ddt -from zoneinfo import ZoneInfo from django.conf import settings from django.core.files.storage import FileSystemStorage from django.test.testcases import TransactionTestCase @@ -27,15 +27,15 @@ ContentTypeFactory, PermissionFactory, RegistrationFactory, - UserFactory + UserFactory, ) from openedx.core.djangoapps.oauth_dispatch.jwt import create_jwt_for_user from openedx.core.djangoapps.user_api.accounts import ACCOUNT_VISIBILITY_PREF_KEY +from openedx.core.djangoapps.user_api.accounts.image_helpers import get_profile_image_storage from openedx.core.djangoapps.user_api.accounts.tests.factories import ( RetirementStateFactory, - UserRetirementStatusFactory + UserRetirementStatusFactory, ) -from openedx.core.djangoapps.user_api.accounts.image_helpers import get_profile_image_storage from openedx.core.djangoapps.user_api.models import UserPreference, UserRetirementStatus from openedx.core.djangoapps.user_api.preferences.api import set_user_preference from openedx.core.djangoapps.waffle_utils.testutils import WAFFLE_TABLES @@ -361,8 +361,8 @@ class TestAccountsAPI(FilteredQueryCountMixin, CacheIsolationTestCase, UserAPITe """ ENABLED_CACHES = ['default'] - TOTAL_QUERY_COUNT = 26 - FULL_RESPONSE_FIELD_COUNT = 29 + TOTAL_QUERY_COUNT = 25 + FULL_RESPONSE_FIELD_COUNT = 28 def setUp(self): super().setUp() @@ -492,19 +492,19 @@ def test_get_account_unknown_user(self, api_client, user): ("client", "user"), ) @ddt.unpack - def test_regsitration_activation_key(self, api_client, user): + def test_regsitration_activation_key_not_exposed(self, api_client, user): """ - Test that registration activation key has a value. + Test that activation_key is NOT returned in the account API response. - UserFactory does not auto-generate registration object for the test users. - It is created only for users that signup via email/API. Therefore, activation key has to be tested manually. + The activation_key is a secret used for email verification and must not be + exposed via the API, as doing so allows bypassing email verification. """ self.create_user_registration(self.user) client = self.login_client(api_client, user) response = self.send_get(client) - assert response.data["activation_key"] is not None + assert "activation_key" not in response.data def test_successful_get_account_by_email(self): """ @@ -815,12 +815,12 @@ def verify_get_own_information(queries): assert data['time_zone'] is None self.client.login(username=self.user.username, password=TEST_PASSWORD) - verify_get_own_information(self._get_num_queries(24)) + verify_get_own_information(self._get_num_queries(23)) # Now make sure that the user can get the same information, even if not active self.user.is_active = False self.user.save() - verify_get_own_information(self._get_num_queries(16)) + verify_get_own_information(self._get_num_queries(15)) def test_get_account_empty_string(self): """ @@ -835,7 +835,7 @@ def test_get_account_empty_string(self): legacy_profile.save() self.client.login(username=self.user.username, password=TEST_PASSWORD) - with self.assertNumQueries(self._get_num_queries(24), table_ignorelist=WAFFLE_TABLES): + with self.assertNumQueries(self._get_num_queries(23), table_ignorelist=WAFFLE_TABLES): response = self.send_get(self.client) for empty_field in ("level_of_education", "gender", "country", "state", "bio",): assert response.data[empty_field] is None @@ -890,7 +890,7 @@ def test_patch_account_unknown_user(self, api_client, user): # Note that language_proficiencies is tested below as there are multiple error and success conditions. ) @ddt.unpack - def test_patch_account(self, field, value, fails_validation_value=None, developer_validation_message=None): + def test_patch_account(self, field, value, fails_validation_value=None, developer_validation_message=None): # noqa: PT028 # pylint: disable=line-too-long """ Test the behavior of patch, when using the correct content_type. """ @@ -914,7 +914,7 @@ def test_patch_account(self, field, value, fails_validation_value=None, develope assert expected_user_message == error_response.data['field_errors'][field]['user_message'] - assert "Value '{value}' is not valid for field '{field}': {messages}".format( + assert "Value '{value}' is not valid for field '{field}': {messages}".format( # noqa: UP032 value=fails_validation_value, field=field, messages=[developer_validation_message] @@ -946,7 +946,7 @@ def verify_error_response(field_name, data): Internal helper to check the error messages returned """ assert 'This field is not editable via this API' == data['field_errors'][field_name]['developer_message'] - assert "The '{}' field cannot be edited.".format( + assert "The '{}' field cannot be edited.".format( # noqa: UP032 field_name ) == data['field_errors'][field_name]['user_message'] @@ -1171,7 +1171,7 @@ def test_patch_language_proficiencies(self): # than django model id. for proficiencies in ([{"code": "en"}, {"code": "fr"}, {"code": "es"}], [{"code": "fr"}], [{"code": "aa"}], []): response = self.send_patch(client, {"language_proficiencies": proficiencies}) - self.assertCountEqual(response.data["language_proficiencies"], proficiencies) + self.assertCountEqual(response.data["language_proficiencies"], proficiencies) # noqa: PT009 @ddt.data( ( @@ -1224,11 +1224,11 @@ def test_profile_image_backend(self): # so it returns the default storage. storage = get_profile_image_storage() storage_class = storage.__class__ - self.assertEqual( + self.assertEqual( # noqa: PT009 settings.PROFILE_IMAGE_BACKEND['class'], f"{storage_class.__module__}.{storage_class.__name__}", ) - self.assertEqual(storage.base_url, settings.PROFILE_IMAGE_BACKEND['options']['base_url']) + self.assertEqual(storage.base_url, settings.PROFILE_IMAGE_BACKEND['options']['base_url']) # noqa: PT009 @override_settings(PROFILE_IMAGE_BACKEND={ 'class': 'storages.backends.s3boto3.S3Boto3Storage', @@ -1240,15 +1240,15 @@ def test_profile_image_backend(self): }) def test_profile_backend_with_params(self): storage = get_profile_image_storage() - self.assertIsInstance(storage, S3Boto3Storage) - self.assertEqual(storage.bucket_name, "test") - self.assertEqual(storage.default_acl, 'public') - self.assertEqual(storage.location, "abc/def") + self.assertIsInstance(storage, S3Boto3Storage) # noqa: PT009 + self.assertEqual(storage.bucket_name, "test") # noqa: PT009 + self.assertEqual(storage.default_acl, 'public') # noqa: PT009 + self.assertEqual(storage.location, "abc/def") # noqa: PT009 @override_settings(PROFILE_IMAGE_BACKEND={'class': None, 'options': {}}) def test_profile_backend_without_backend(self): storage = get_profile_image_storage() - self.assertIsInstance(storage, FileSystemStorage) + self.assertIsInstance(storage, FileSystemStorage) # noqa: PT009 @override_settings(PROFILE_IMAGE_BACKEND=TEST_PROFILE_IMAGE_BACKEND) def test_convert_relative_profile_url(self): @@ -1280,10 +1280,10 @@ def test_convert_relative_profile_url(self): def test_profile_backend_with_profile_image_settings(self): """ It will use the storages dict with profile_images backend""" storage = get_profile_image_storage() - self.assertIsInstance(storage, S3Boto3Storage) - self.assertEqual(storage.bucket_name, "profiles") - self.assertEqual(storage.default_acl, 'public') - self.assertEqual(storage.location, "profile/images") + self.assertIsInstance(storage, S3Boto3Storage) # noqa: PT009 + self.assertEqual(storage.bucket_name, "profiles") # noqa: PT009 + self.assertEqual(storage.default_acl, 'public') # noqa: PT009 + self.assertEqual(storage.location, "profile/images") # noqa: PT009 @override_settings( PROFILE_IMAGE_BACKEND={}, @@ -1292,7 +1292,7 @@ def test_profile_backend_with_default_hardcoded_backend(self): """ In case of empty storages scenario uses the hardcoded backend.""" del settings.STORAGES storage = get_profile_image_storage() - self.assertIsInstance(storage, FileSystemStorage) + self.assertIsInstance(storage, FileSystemStorage) # noqa: PT009 @ddt.data( ("client", "user", True), @@ -1372,6 +1372,130 @@ def test_update_account_settings_rollback(self, mock_email_change): assert 'm' == data['gender'] +@skip_unless_lms +class TestAccountsAPIExtendedProfile(UserAPITestCase): + """ + Tests for extended profile validation in the Accounts API + """ + + def setUp(self): + super().setUp() + self.url = reverse("accounts_api", kwargs={"username": self.user.username}) + self.client.login(username=self.user.username, password=TEST_PASSWORD) + + @mock.patch("openedx.core.djangoapps.user_api.accounts.api.validate_and_get_extended_profile_form") + def test_patch_account_with_valid_extended_profile(self, mock_validate_form: mock.Mock): + """ + Test that PATCH with valid extended_profile data succeeds + """ + mock_form = mock.Mock() + mock_validate_form.return_value = (mock_form, {}) + extended_profile_data = [ + {"field_name": "department", "field_value": "Engineering"}, + {"field_name": "title", "field_value": "Software Engineer"}, + ] + json_data = {"extended_profile": extended_profile_data, "bio": "Test bio"} + + response = self.client.patch(self.url, data=json.dumps(json_data), content_type="application/merge-patch+json") + + self.assertEqual(response.status_code, 200) # noqa: PT009 + mock_validate_form.assert_called_once_with(extended_profile_data, self.user) + + @mock.patch("openedx.core.djangoapps.user_api.accounts.api.validate_and_get_extended_profile_form") + def test_patch_account_with_invalid_extended_profile(self, mock_validate_form: mock.Mock): + """ + Test that PATCH with invalid extended_profile data returns 400 + """ + field_errors = { + "department": {"developer_message": "This field is required", "user_message": "This field is required"} + } + mock_validate_form.return_value = (None, field_errors) + extended_profile_data = [{"field_name": "department", "field_value": ""}] + json_data = {"extended_profile": extended_profile_data} + + response = self.client.patch(self.url, data=json.dumps(json_data), content_type="application/merge-patch+json") + + self.assertEqual(response.status_code, 400) # noqa: PT009 + self.assertIn("field_errors", response.data) # noqa: PT009 + self.assertIn("department", response.data["field_errors"]) # noqa: PT009 + mock_validate_form.assert_called_once_with(extended_profile_data, self.user) + + def test_patch_account_without_extended_profile(self: UserAPITestCase): + """ + Test that PATCH without extended_profile data works normally + """ + json_data = {"bio": "Test bio without extended profile"} + + response = self.client.patch(self.url, data=json.dumps(json_data), content_type="application/merge-patch+json") + + self.assertEqual(response.status_code, 200) # noqa: PT009 + self.assertEqual(response.data["bio"], "Test bio without extended profile") # noqa: PT009 + + @mock.patch("openedx.core.djangoapps.user_api.accounts.api.validate_and_get_extended_profile_form") + def test_patch_account_extended_profile_with_empty_list(self, mock_validate_form: mock.Mock): + """ + Test that PATCH with empty extended_profile list works + """ + mock_validate_form.return_value = (None, {}) + json_data = {"extended_profile": [], "bio": "Test bio"} + + response = self.client.patch(self.url, data=json.dumps(json_data), content_type="application/merge-patch+json") + + self.assertEqual(response.status_code, 200) # noqa: PT009 + mock_validate_form.assert_called_once_with([], self.user) # noqa: PT009 + + @mock.patch("openedx.core.djangoapps.user_api.accounts.api.validate_and_get_extended_profile_form") + def test_patch_account_extended_profile_form_exception(self, mock_validate_form: mock.Mock): + """ + Test that exceptions in form validation return appropriate errors + """ + field_errors = { + "extended_profile": {"developer_message": "Unexpected error", "user_message": "An error occurred"} + } + mock_validate_form.return_value = (None, field_errors) + extended_profile_data = [{"field_name": "department", "field_value": "Engineering"}] + json_data = {"extended_profile": extended_profile_data} + + response = self.client.patch(self.url, data=json.dumps(json_data), content_type="application/merge-patch+json") + + self.assertEqual(response.status_code, 400) # noqa: PT009 + self.assertIn("field_errors", response.data) # noqa: PT009 + + @mock.patch("openedx.core.djangoapps.user_api.accounts.api.validate_and_get_extended_profile_form") + def test_patch_account_extended_profile_multiple_fields(self, mock_validate_form: mock.Mock): + """ + Test PATCH with multiple extended_profile fields + """ + mock_form = mock.Mock() + mock_validate_form.return_value = (mock_form, {}) + extended_profile_data = [ + {"field_name": "department", "field_value": "Engineering"}, + {"field_name": "title", "field_value": "Software Engineer"}, + {"field_name": "company", "field_value": "EdX"}, + {"field_name": "location", "field_value": "Remote"}, + ] + json_data = {"extended_profile": extended_profile_data} + + response = self.client.patch(self.url, data=json.dumps(json_data), content_type="application/merge-patch+json") + + self.assertEqual(response.status_code, 200) # noqa: PT009 + mock_validate_form.assert_called_once_with(extended_profile_data, self.user) + + def test_patch_account_extended_profile_unauthorized(self): + """ + Test that unauthorized users cannot update extended_profile + """ + self.different_client.login(username=self.different_user.username, password=TEST_PASSWORD) + extended_profile_data = [{"field_name": "department", "field_value": "Engineering"}] + json_data = {"extended_profile": extended_profile_data} + + response = self.different_client.patch( + self.url, data=json.dumps(json_data), content_type="application/merge-patch+json" + ) + + self.assertIn(response.status_code, [403, 404]) # noqa: PT009 + + @ddt.ddt class NameChangeViewTests(UserAPITestCase): """ NameChangeView tests """ @@ -1403,14 +1527,14 @@ def test_create_request_succeeds(self): """ self.client.login(username=self.user.username, password=TEST_PASSWORD) response = self._send_create(self.client, {'name': 'New Name'}) - self.assertEqual(response.status_code, 201) + self.assertEqual(response.status_code, 201) # noqa: PT009 def test_create_unauthenticated(self): """ Test that a name change request fails for an unauthenticated user. """ response = self._send_create(self.client, {'name': 'New Name'}) - self.assertEqual(response.status_code, 401) + self.assertEqual(response.status_code, 401) # noqa: PT009 def test_create_empty_request(self): """ @@ -1418,7 +1542,7 @@ def test_create_empty_request(self): """ self.client.login(username=self.user.username, password=TEST_PASSWORD) response = self._send_create(self.client, {}) - self.assertEqual(response.status_code, 400) + self.assertEqual(response.status_code, 400) # noqa: PT009 def test_create_blank_name(self): """ @@ -1426,7 +1550,7 @@ def test_create_blank_name(self): """ self.client.login(username=self.user.username, password=TEST_PASSWORD) response = self._send_create(self.client, {'name': ''}) - self.assertEqual(response.status_code, 400) + self.assertEqual(response.status_code, 400) # noqa: PT009 @ddt.data('invalid name', 'https://invalid.com') def test_create_fails_validation(self, invalid_name): @@ -1435,7 +1559,7 @@ def test_create_fails_validation(self, invalid_name): """ self.client.login(username=self.user.username, password=TEST_PASSWORD) response = self._send_create(self.client, {'name': invalid_name}) - self.assertEqual(response.status_code, 400) + self.assertEqual(response.status_code, 400) # noqa: PT009 def test_confirm_succeeds(self): """ @@ -1444,8 +1568,8 @@ def test_confirm_succeeds(self): self.staff_client.login(username=self.staff_user.username, password=TEST_PASSWORD) do_name_change_request(self.user, 'New Name', 'test') response = self._send_confirm(self.staff_client, self.user.username) - self.assertEqual(response.status_code, 204) - self.assertIsNone(get_pending_name_change(self.user)) + self.assertEqual(response.status_code, 204) # noqa: PT009 + self.assertIsNone(get_pending_name_change(self.user)) # noqa: PT009 def test_confirm_non_staff(self): """ @@ -1454,8 +1578,8 @@ def test_confirm_non_staff(self): self.client.login(username=self.user.username, password=TEST_PASSWORD) do_name_change_request(self.user, 'New Name', 'test') response = self._send_confirm(self.client, self.user.username) - self.assertEqual(response.status_code, 403) - self.assertEqual(get_pending_name_change(self.user).new_name, 'New Name') + self.assertEqual(response.status_code, 403) # noqa: PT009 + self.assertEqual(get_pending_name_change(self.user).new_name, 'New Name') # noqa: PT009 def test_confirm_no_pending_name_change(self): """ @@ -1463,7 +1587,7 @@ def test_confirm_no_pending_name_change(self): """ self.staff_client.login(username=self.staff_user.username, password=TEST_PASSWORD) response = self._send_confirm(self.staff_client, self.user.username) - self.assertEqual(response.status_code, 404) + self.assertEqual(response.status_code, 404) # noqa: PT009 @ddt.ddt diff --git a/openedx/core/djangoapps/user_api/accounts/tests/testutils.py b/openedx/core/djangoapps/user_api/accounts/tests/testutils.py index 24f7c16f24eb..8dde4dc79ea4 100644 --- a/openedx/core/djangoapps/user_api/accounts/tests/testutils.py +++ b/openedx/core/djangoapps/user_api/accounts/tests/testutils.py @@ -3,8 +3,8 @@ """ -from openedx.core.djangoapps.user_api.accounts import EMAIL_MAX_LENGTH, USERNAME_MAX_LENGTH, USERNAME_MIN_LENGTH from common.djangoapps.util.password_policy_validators import DEFAULT_MAX_PASSWORD_LENGTH +from openedx.core.djangoapps.user_api.accounts import EMAIL_MAX_LENGTH, USERNAME_MAX_LENGTH, USERNAME_MIN_LENGTH INVALID_NAMES = [ None, diff --git a/openedx/core/djangoapps/user_api/accounts/utils.py b/openedx/core/djangoapps/user_api/accounts/utils.py index 826dbd42cd13..343cddb93ddc 100644 --- a/openedx/core/djangoapps/user_api/accounts/utils.py +++ b/openedx/core/djangoapps/user_api/accounts/utils.py @@ -7,22 +7,32 @@ import re import string -import waffle # lint-amnesty, pylint: disable=invalid-django-waffle-import +import waffle # pylint: disable=invalid-django-waffle-import from completion.models import BlockCompletion from completion.waffle import ENABLE_COMPLETION_TRACKING_SWITCH from django.conf import settings +from django.db.models import CharField, TextField, Value +from django.db.models.functions import Cast, Concat from django.utils.translation import gettext as _ from edx_django_utils.user import generate_password from social_django.models import UserSocialAuth -from common.djangoapps.student.models import AccountRecovery, Registration, get_retired_email_by_email +from common.djangoapps.student.models import ( + AccountRecovery, + Registration, + get_retired_email_by_email, +) from openedx.core.djangoapps.site_configuration.models import SiteConfiguration from openedx.core.djangoapps.theming.helpers import get_config_value_from_site_or_settings, get_current_site from openedx.core.djangolib.oauth2_retirement_utils import retire_dot_oauth2_models -from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order from ..models import UserRetirementStatus +# Prefix and suffix used to build a per-record redacted uid for UserSocialAuth. +REDACTED_SOCIAL_AUTH_UID_PREFIX = 'redacted-before-delete-' +REDACTED_SOCIAL_AUTH_UID_SUFFIX = '@safe.com' + ENABLE_SECONDARY_EMAIL_FEATURE_SWITCH = 'enable_secondary_email_feature' LOGGER = logging.getLogger(__name__) @@ -179,7 +189,7 @@ def retrieve_last_sitewide_block_completed(user): if not (lms_root and item): return - return "{lms_root}/courses/{course_key}/jump_to/{location}".format( + return "{lms_root}/courses/{course_key}/jump_to/{location}".format( # noqa: UP032 lms_root=lms_root, course_key=str(item.location.course_key), location=str(item.location), @@ -196,17 +206,58 @@ def is_secondary_email_feature_enabled(): return waffle.switch_is_active(ENABLE_SECONDARY_EMAIL_FEATURE_SWITCH) +def redact_and_delete_social_auth(user_id, skip_delete=False): + """ + Redact PII from all UserSocialAuth records for the given user, then delete them. + + Downstream copies of data may use soft-deletes, and redacting before deleting + ensures PII for retired users (or future retirements) is not retained. + + ``skip_delete`` should only be set to True when called from the pre_delete signal + handler, where deletion is already in progress. + """ + social_auth_queryset = UserSocialAuth.objects.filter(user_id=user_id) + # Important: this redacted uid must match the format used by ``get_redacted_social_auth_uid()``. + social_auth_queryset.update( + uid=Concat( + Value(REDACTED_SOCIAL_AUTH_UID_PREFIX), + Cast('id', output_field=CharField()), + Value(REDACTED_SOCIAL_AUTH_UID_SUFFIX), + ), + extra_data={}, + ) + if not skip_delete: + social_auth_queryset.delete() + + +def redact_and_delete_historical_social_auth(user_id): + """ + Redact PII from all HistoricalUserSocialAuth records for the given user, then delete them. + + Downstream copies of data may use soft-deletes, and redacting before deleting + ensures PII for retired users (or future retirements) is not retained. + """ + historical_social_auth_model = UserSocialAuth.history.model + historical_queryset = historical_social_auth_model.objects.filter(user_id=user_id) + historical_queryset.update( + uid=Concat( + Value(REDACTED_SOCIAL_AUTH_UID_PREFIX), + Cast('history_id', output_field=TextField()), + Value(REDACTED_SOCIAL_AUTH_UID_SUFFIX), + ), + extra_data={}, + ) + historical_queryset.delete() + + def create_retirement_request_and_deactivate_account(user): """ - Adds user to retirement queue, unlinks social auth accounts, changes user passwords - and delete tokens and activation keys + Adds user to retirement queue, changes user passwords + and delete tokens and activation keys. """ # Add user to retirement queue. UserRetirementStatus.create_retirement(user) - # Unlink LMS social auth accounts - UserSocialAuth.objects.filter(user_id=user.id).delete() - # Change LMS password & email user.email = get_retired_email_by_email(user.email) user.set_unusable_password() diff --git a/openedx/core/djangoapps/user_api/accounts/views.py b/openedx/core/djangoapps/user_api/accounts/views.py index c3ff6ce7a2f2..d89a96278944 100644 --- a/openedx/core/djangoapps/user_api/accounts/views.py +++ b/openedx/core/djangoapps/user_api/accounts/views.py @@ -8,9 +8,8 @@ import datetime import logging from functools import wraps - from zoneinfo import ZoneInfo -from consent.models import DataSharingConsent + from django.apps import apps from django.conf import settings from django.contrib.auth import authenticate, get_user_model, logout @@ -25,9 +24,6 @@ from edx_ace.recipient import Recipient from edx_rest_framework_extensions.auth.jwt.authentication import JwtAuthentication from edx_rest_framework_extensions.auth.session.authentication import SessionAuthenticationAllowInactiveUser -from enterprise.models import EnterpriseCourseEnrollment, EnterpriseCustomerUser, PendingEnterpriseCustomerUser -from integrated_channels.degreed.models import DegreedLearnerDataTransmissionAudit -from integrated_channels.sap_success_factors.models import SapSuccessFactorsLearnerDataTransmissionAudit from rest_framework import permissions, status from rest_framework.authentication import SessionAuthentication from rest_framework.exceptions import UnsupportedMediaType @@ -39,23 +35,25 @@ from wiki.models import ArticleRevision from wiki.models.pluginbase import RevisionPluginRevision -from common.djangoapps.track import segment from common.djangoapps.entitlements.models import CourseEntitlement from common.djangoapps.student.models import ( # lint-amnesty, pylint: disable=unused-import + AccountRecovery, CourseEnrollmentAllowed, LoginFailures, ManualEnrollmentAudit, PendingEmailChange, PendingNameChange, + PendingSecondaryEmailChange, User, UserProfile, get_potentially_retired_user_by_username, get_retired_email_by_email, get_retired_username_by_username, is_email_retired, - is_username_retired, + is_username_retired, # noqa: F401 ) from common.djangoapps.student.models_api import confirm_name_change, do_name_change_request, get_pending_name_change +from common.djangoapps.track import segment from lms.djangoapps.certificates.api import clear_pii_from_certificate_records_for_user from openedx.core.djangoapps.ace_common.template_context import get_base_template_context from openedx.core.djangoapps.api_admin.models import ApiAccessRequest @@ -66,7 +64,10 @@ from openedx.core.djangoapps.site_configuration import helpers as configuration_helpers from openedx.core.djangoapps.user_api import accounts from openedx.core.djangoapps.user_api.accounts.image_helpers import get_profile_image_names, set_has_profile_image -from openedx.core.djangoapps.user_api.accounts.utils import handle_retirement_cancellation +from openedx.core.djangoapps.user_api.accounts.utils import ( + handle_retirement_cancellation, + redact_and_delete_historical_social_auth, +) from openedx.core.djangoapps.user_authn.exceptions import AuthFailedError from openedx.core.lib.api.authentication import BearerAuthentication, BearerAuthenticationAllowInactiveUser from openedx.core.lib.api.parsers import MergePatchParser @@ -297,7 +298,6 @@ def retrieve(self, request, username): If the user makes the request for her own account, or makes a request for another account and has "is_staff" access, an HTTP 200 "OK" response is returned. The response contains the following values. * `id`: numerical lms user id in db - * `activation_key`: auto-genrated activation key when signed up via email * `bio`: null or textual representation of user biographical information ("about me"). * `country`: An ISO 3166 country code or null. * `date_joined`: The date the account was created, in the string format provided by datetime. For example, "2014-08-26T17:52:11Z". @@ -998,7 +998,7 @@ def partial_update(self, request): # than one row returned here (due to our MySQL collation being case-insensitive), and need # to disambiguate them in Python, which will respect case in the comparison. retirement = None - if len(retirements) < 1: # lint-amnesty, pylint: disable=no-else-raise + if len(retirements) < 1: # pylint: disable=no-else-raise raise UserRetirementStatus.DoesNotExist() elif len(retirements) >= 1: for r in retirements: @@ -1024,14 +1024,20 @@ def cleanup(self, request): ``` { - 'usernames': ['user1', 'user2', ...] + 'usernames': ['user1', 'user2', ...], + 'redacted_username': 'Value to store in username field', + 'redacted_email': 'Value to store in email field', + 'redacted_name': 'Value to store in name field' } ``` - Deletes a batch of retirement requests by username. + Redacts and then deletes a batch of retirement requests by username. """ try: usernames = request.data["usernames"] + redacted_username = request.data.get("redacted_username", "redacted") + redacted_email = request.data.get("redacted_email", "redacted") + redacted_name = request.data.get("redacted_name", "redacted") if not isinstance(usernames, list): raise TypeError("Usernames should be an array.") @@ -1045,7 +1051,20 @@ def cleanup(self, request): if len(usernames) != len(retirements): raise UserRetirementStatus.DoesNotExist("Not all usernames exist in the COMPLETE state.") - retirements.delete() + # Redact PII fields first, then delete. In case an ETL tool is syncing data + # to a downstream data warehouse, and treats the deletes as soft-deletes, + # the data will have first been redacted, protecting the sensitive PII. + # Get the IDs of the retirements to update/delete + retirement_ids = list(retirements.values_list('id', flat=True)) + # Update by IDs + UserRetirementStatus.objects.filter(id__in=retirement_ids).update( + original_username=redacted_username, + original_email=redacted_email, + original_name=redacted_name + ) + # Delete by IDs + UserRetirementStatus.objects.filter(id__in=retirement_ids, current_state=complete_state).delete() + return Response(status=status.HTTP_204_NO_CONTENT) except (RetirementStateError, UserRetirementStatus.DoesNotExist, TypeError) as exc: return Response(str(exc), status=status.HTTP_400_BAD_REQUEST) @@ -1090,6 +1109,7 @@ def post(self, request): CreditRequest.retire_user(retirement) ApiAccessRequest.retire_user(retirement.user) CreditRequirementStatus.retire_user(retirement) + redact_and_delete_historical_social_auth(retirement.user.id) # This signal allows code in higher points of LMS to retire the user as necessary USER_RETIRE_LMS_MISC.send(sender=self.__class__, user=retirement.user) @@ -1154,28 +1174,31 @@ def post(self, request): # Retire user information from any certificate records associated with the learner self.clear_pii_from_certificate_records(user) - # Retire data from Enterprise models - self.retire_users_data_sharing_consent(username, retired_username) - self.retire_sapsf_data_transmission(user) - self.retire_degreed_data_transmission(user) - self.retire_user_from_pending_enterprise_customer_user(user, retired_email) self.retire_entitlement_support_detail(user) # Retire misc. models that may contain PII of this user PendingEmailChange.delete_by_user_value(user, field="user") UserOrgTag.delete_by_user_value(user, field="user") + PendingSecondaryEmailChange.redact_and_delete_pending_secondary_email(user.id) + AccountRecovery.retire_recovery_email(user.id) # Retire any objects linked to the user via their original email CourseEnrollmentAllowed.delete_by_user_value(original_email, field="email") UnregisteredLearnerCohortAssignments.delete_by_user_value(original_email, field="email") # This signal allows code in higher points of LMS to retire the user as necessary - USER_RETIRE_LMS_CRITICAL.send(sender=self.__class__, user=user) + USER_RETIRE_LMS_CRITICAL.send( + sender=self.__class__, + user=user, + retired_username=retired_username, + retired_email=retired_email, + ) user.first_name = "" user.last_name = "" user.is_active = False user.username = retired_username + user.email = retired_email user.save() except UserRetirementStatus.DoesNotExist: return Response(status=status.HTTP_404_NOT_FOUND) @@ -1209,32 +1232,6 @@ def delete_users_country_cache(user): cache_key = UserProfile.country_cache_key_name(user.id) cache.delete(cache_key) - @staticmethod - def retire_users_data_sharing_consent(username, retired_username): - DataSharingConsent.objects.filter(username=username).update(username=retired_username) - - @staticmethod - def retire_sapsf_data_transmission(user): # lint-amnesty, pylint: disable=missing-function-docstring - for ent_user in EnterpriseCustomerUser.objects.filter(user_id=user.id): - for enrollment in EnterpriseCourseEnrollment.objects.filter(enterprise_customer_user=ent_user): - audits = SapSuccessFactorsLearnerDataTransmissionAudit.objects.filter( - enterprise_course_enrollment_id=enrollment.id - ) - audits.update(sapsf_user_id="") - - @staticmethod - def retire_degreed_data_transmission(user): # lint-amnesty, pylint: disable=missing-function-docstring - for ent_user in EnterpriseCustomerUser.objects.filter(user_id=user.id): - for enrollment in EnterpriseCourseEnrollment.objects.filter(enterprise_customer_user=ent_user): - audits = DegreedLearnerDataTransmissionAudit.objects.filter( - enterprise_course_enrollment_id=enrollment.id - ) - audits.update(degreed_user_email="") - - @staticmethod - def retire_user_from_pending_enterprise_customer_user(user, retired_email): - PendingEnterpriseCustomerUser.objects.filter(user_email=user.email).update(user_email=retired_email) - @staticmethod def retire_entitlement_support_detail(user): """ diff --git a/openedx/core/djangoapps/user_api/admin.py b/openedx/core/djangoapps/user_api/admin.py index 228a9a5bc451..976fa0d79ab5 100644 --- a/openedx/core/djangoapps/user_api/admin.py +++ b/openedx/core/djangoapps/user_api/admin.py @@ -16,7 +16,7 @@ RetirementState, UserRetirementPartnerReportingStatus, UserRetirementRequest, - UserRetirementStatus + UserRetirementStatus, ) @@ -194,8 +194,8 @@ def reset_state_false(self, request, queryset): if rows_updated == 1: message_bit = "one user was" else: - message_bit = "%s users were" % rows_updated - self.message_user(request, "%s successfully reset to False." % message_bit) + message_bit = "%s users were" % rows_updated # noqa: UP031 + self.message_user(request, "%s successfully reset to False." % message_bit) # noqa: UP031 reset_state_false.short_description = "Reset is_being_processed to False" @@ -207,8 +207,8 @@ def reset_state_true(self, request, queryset): if rows_updated == 1: message_bit = "one user was" else: - message_bit = "%s users were" % rows_updated - self.message_user(request, "%s successfully reset to True." % message_bit) + message_bit = "%s users were" % rows_updated # noqa: UP031 + self.message_user(request, "%s successfully reset to True." % message_bit) # noqa: UP031 reset_state_true.short_description = "Reset is_being_processed to True" diff --git a/openedx/core/djangoapps/user_api/course_tag/api.py b/openedx/core/djangoapps/user_api/course_tag/api.py index 4222f91264c4..c8606aea61c4 100644 --- a/openedx/core/djangoapps/user_api/course_tag/api.py +++ b/openedx/core/djangoapps/user_api/course_tag/api.py @@ -20,7 +20,7 @@ COURSE_SCOPE = 'course' -class BulkCourseTags: # lint-amnesty, pylint: disable=missing-class-docstring +class BulkCourseTags: # pylint: disable=missing-class-docstring CACHE_NAMESPACE = 'user_api.course_tag.api' @classmethod diff --git a/openedx/core/djangoapps/user_api/course_tag/tests/test_api.py b/openedx/core/djangoapps/user_api/course_tag/tests/test_api.py index ab336d6f3f1d..e424fdec9150 100644 --- a/openedx/core/djangoapps/user_api/course_tag/tests/test_api.py +++ b/openedx/core/djangoapps/user_api/course_tag/tests/test_api.py @@ -6,8 +6,8 @@ from django.test import TestCase from opaque_keys.edx.locator import CourseLocator -from openedx.core.djangoapps.user_api.course_tag import api as course_tag_api from common.djangoapps.student.tests.factories import UserFactory +from openedx.core.djangoapps.user_api.course_tag import api as course_tag_api class TestCourseTagAPI(TestCase): diff --git a/openedx/core/djangoapps/user_api/errors.py b/openedx/core/djangoapps/user_api/errors.py index 2bde3b182a84..c2e4a0c78a12 100644 --- a/openedx/core/djangoapps/user_api/errors.py +++ b/openedx/core/djangoapps/user_api/errors.py @@ -5,72 +5,72 @@ class UserAPIRequestError(Exception): """There was a problem with the request to the User API. """ - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass class UserAPIInternalError(Exception): """An internal error occurred in the User API. """ - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass class UserNotFound(UserAPIRequestError): """The requested user does not exist. """ - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass class UserNotAuthorized(UserAPIRequestError): """The user is not authorized to perform the requested action. """ - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass class AccountRequestError(UserAPIRequestError): """There was a problem with the request to the account API. """ - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass class AccountUserAlreadyExists(AccountRequestError): """User with the same username and/or email already exists. """ - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass class AccountUsernameAlreadyExists(AccountRequestError): """User with the same username already exists. """ - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass class AccountEmailAlreadyExists(AccountRequestError): """User with the same email already exists. """ - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass class AccountUsernameInvalid(AccountRequestError): """The requested username is not in a valid format. """ - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass class AccountEmailInvalid(AccountRequestError): """The requested email is not in a valid format. """ - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass class AccountPasswordInvalid(AccountRequestError): """The requested password is not in a valid format. """ - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass class AccountCountryInvalid(AccountRequestError): """The requested country does not exist. """ - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass class AccountDataBadLength(AccountRequestError): """The requested account data is either too short or too long. """ - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass class AccountDataBadType(AccountRequestError): """The requested account data is of the wrong type. """ - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass class AccountUpdateError(AccountRequestError): @@ -78,7 +78,7 @@ class AccountUpdateError(AccountRequestError): An update to the account failed. More detailed information is present in developer_message, and depending on the type of error encountered, there may also be a non-null user_message field. """ - def __init__(self, developer_message, user_message=None): # lint-amnesty, pylint: disable=super-init-not-called + def __init__(self, developer_message, user_message=None): # pylint: disable=super-init-not-called self.developer_message = developer_message self.user_message = user_message @@ -90,13 +90,13 @@ class AccountValidationError(AccountRequestError): there will be at least a developer_message describing the validation issue, and possibly also a user_message. """ - def __init__(self, field_errors): # lint-amnesty, pylint: disable=super-init-not-called + def __init__(self, field_errors): # pylint: disable=super-init-not-called self.field_errors = field_errors class PreferenceRequestError(UserAPIRequestError): """There was a problem with a preference request.""" - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass class PreferenceValidationError(PreferenceRequestError): @@ -124,4 +124,4 @@ def __init__(self, developer_message, user_message=None): class CountryCodeError(ValueError): """There was a problem with the country code""" - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass diff --git a/openedx/core/djangoapps/user_api/helpers.py b/openedx/core/djangoapps/user_api/helpers.py index 6c4aabe6f42a..c45970c98b56 100644 --- a/openedx/core/djangoapps/user_api/helpers.py +++ b/openedx/core/djangoapps/user_api/helpers.py @@ -63,7 +63,7 @@ def _wrapped(*args, **kwargs): func_name=func.__name__, args=args, kwargs=kwargs, - exception=ex.developer_message if hasattr(ex, 'developer_message') else repr(ex) # lint-amnesty, pylint: disable=no-member + exception=ex.developer_message if hasattr(ex, 'developer_message') else repr(ex) # pylint: disable=no-member ) LOGGER.warning(msg) raise @@ -79,11 +79,11 @@ def _wrapped(*args, **kwargs): func_name=func.__name__, args=args, kwargs=kwargs, - exception=ex.developer_message if hasattr(ex, 'developer_message') else repr(ex), # lint-amnesty, pylint: disable=no-member + exception=ex.developer_message if hasattr(ex, 'developer_message') else repr(ex), # pylint: disable=no-member caller=caller.strip(), ) LOGGER.exception(msg) - raise api_error(msg) # lint-amnesty, pylint: disable=raise-missing-from + raise api_error(msg) # pylint: disable=raise-missing-from # noqa: B904 return _wrapped return _decorator @@ -353,7 +353,7 @@ class LocalizedJSONEncoder(DjangoJSONEncoder): """ # pylint: disable=method-hidden - def default(self, obj): # lint-amnesty, pylint: disable=arguments-differ + def default(self, obj): # pylint: disable=arguments-differ """ Forces evaluation of gettext_lazy promises. """ diff --git a/openedx/core/djangoapps/user_api/legacy_urls.py b/openedx/core/djangoapps/user_api/legacy_urls.py index 3c8da9bd830a..f2ec67c9cefb 100644 --- a/openedx/core/djangoapps/user_api/legacy_urls.py +++ b/openedx/core/djangoapps/user_api/legacy_urls.py @@ -2,10 +2,12 @@ Defines the URL routes for this app. """ from django.conf import settings -from django.urls import path, re_path, include +from django.urls import include, path, re_path from django.views.generic import RedirectView from rest_framework import routers +from openedx.core.djangoapps.site_configuration import helpers as configuration_helpers + from . import views as user_api_views from .models import UserPreference @@ -17,7 +19,12 @@ # This redirect is needed for backward compatibility with the old URL structure for the authentication # workflows using third-party authentication providers until the authentication workflows fully support # the URL structure with MFEs. - re_path(r'^account(?:/settings)?/?$', RedirectView.as_view(url=settings.ACCOUNT_MICROFRONTEND_URL)), + re_path(r'^account(?:/settings)?/?$', RedirectView.as_view( + url=configuration_helpers.get_value( + 'ACCOUNT_MICROFRONTEND_URL', + settings.ACCOUNT_MICROFRONTEND_URL, + )), + ), path('user_api/v1/', include(USER_API_ROUTER.urls)), re_path( fr'^user_api/v1/preferences/(?P{UserPreference.KEY_REGEX})/users/$', diff --git a/openedx/core/djangoapps/user_api/management/commands/bulk_user_org_email_optout.py b/openedx/core/djangoapps/user_api/management/commands/bulk_user_org_email_optout.py index d194e58ee880..b383bd27de82 100644 --- a/openedx/core/djangoapps/user_api/management/commands/bulk_user_org_email_optout.py +++ b/openedx/core/djangoapps/user_api/management/commands/bulk_user_org_email_optout.py @@ -115,7 +115,7 @@ def handle(self, *args, **options): query = 'INSERT INTO user_api_userorgtag (`user_id`, `org`, `key`, `value`, `created`, `modified`) VALUES ' query_values = [] for idx in range(start_idx, end_idx + 1): - query_values.append('({},"{}","email-optin","False",NOW(),NOW())'.format( + query_values.append('({},"{}","email-optin","False",NOW(),NOW())'.format( # noqa: UP032 optout_rows[idx][0], optout_rows[idx][1]) ) query += ','.join(query_values) diff --git a/openedx/core/djangoapps/user_api/management/commands/cancel_user_retirement_request.py b/openedx/core/djangoapps/user_api/management/commands/cancel_user_retirement_request.py index adb29a4fd3a8..b568ee3b49ab 100644 --- a/openedx/core/djangoapps/user_api/management/commands/cancel_user_retirement_request.py +++ b/openedx/core/djangoapps/user_api/management/commands/cancel_user_retirement_request.py @@ -37,12 +37,12 @@ def handle(self, *args, **options): original_email=email_address ) except UserRetirementStatus.DoesNotExist: - raise CommandError(f"No retirement request with email address '{email_address}' exists.") # lint-amnesty, pylint: disable=raise-missing-from + raise CommandError(f"No retirement request with email address '{email_address}' exists.") # pylint: disable=raise-missing-from # noqa: B904 # Check if the user has started the retirement process -or- not. if retirement_status.current_state.state_name != 'PENDING': raise CommandError( - "Retirement requests can only be cancelled for users in the PENDING state." + "Retirement requests can only be cancelled for users in the PENDING state." # noqa: UP032 " Current request state for '{}': {}".format( email_address, retirement_status.current_state.state_name diff --git a/openedx/core/djangoapps/user_api/management/commands/create_user_gdpr_testing.py b/openedx/core/djangoapps/user_api/management/commands/create_user_gdpr_testing.py index fd574cb83fa1..fbabe6adaab7 100644 --- a/openedx/core/djangoapps/user_api/management/commands/create_user_gdpr_testing.py +++ b/openedx/core/djangoapps/user_api/management/commands/create_user_gdpr_testing.py @@ -8,26 +8,26 @@ from datetime import datetime from textwrap import dedent from uuid import uuid4 +from zoneinfo import ZoneInfo from consent.models import DataSharingConsent -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.core.management.base import BaseCommand from enterprise.models import ( EnterpriseCourseEnrollment, EnterpriseCustomer, EnterpriseCustomerUser, - PendingEnterpriseCustomerUser + PendingEnterpriseCustomerUser, ) from integrated_channels.sap_success_factors.models import SapSuccessFactorsLearnerDataTransmissionAudit from opaque_keys.edx.keys import CourseKey -from zoneinfo import ZoneInfo from common.djangoapps.entitlements.models import CourseEntitlement, CourseEntitlementSupportDetail +from common.djangoapps.student.models import CourseEnrollment, CourseEnrollmentAllowed, PendingEmailChange, UserProfile from lms.djangoapps.verify_student.models import SoftwareSecurePhotoVerification from openedx.core.djangoapps.course_groups.models import CourseUserGroup, UnregisteredLearnerCohortAssignments from openedx.core.djangoapps.profile_images.images import create_profile_images from openedx.core.djangoapps.profile_images.tests.helpers import make_image_file -from common.djangoapps.student.models import CourseEnrollment, CourseEnrollmentAllowed, PendingEmailChange, UserProfile from ...models import UserOrgTag diff --git a/openedx/core/djangoapps/user_api/management/commands/email_opt_in_list.py b/openedx/core/djangoapps/user_api/management/commands/email_opt_in_list.py index e7a7ac16e485..045ac19a13fa 100644 --- a/openedx/core/djangoapps/user_api/management/commands/email_opt_in_list.py +++ b/openedx/core/djangoapps/user_api/management/commands/email_opt_in_list.py @@ -23,10 +23,11 @@ import contextlib import csv -from datetime import datetime, timezone as dt_timezone import logging import os.path import time +from datetime import datetime +from datetime import timezone as dt_timezone from django.conf import settings from django.core.management.base import BaseCommand, CommandError @@ -240,7 +241,7 @@ def _write_email_opt_in_prefs(self, file_handle, org_aliases, courses): user_id, username, email, full_name, course_id, is_opted_in, pref_set_datetime = row if pref_set_datetime: - pref_set_datetime = timezone.make_aware(pref_set_datetime, dt_timezone.utc) + pref_set_datetime = timezone.make_aware(pref_set_datetime, dt_timezone.utc) # noqa: UP017 else: pref_set_datetime = self.DEFAULT_DATETIME_STR diff --git a/openedx/core/djangoapps/user_api/management/commands/migrate_user_profile_langs.py b/openedx/core/djangoapps/user_api/management/commands/migrate_user_profile_langs.py index da3251794a9a..c73b777ddc91 100644 --- a/openedx/core/djangoapps/user_api/management/commands/migrate_user_profile_langs.py +++ b/openedx/core/djangoapps/user_api/management/commands/migrate_user_profile_langs.py @@ -62,12 +62,12 @@ def handle(self, *args, **options): langs += dark_lang_config.beta_languages_list if dark_lang_config.enable_beta_languages else [] if new_lang_code not in langs: - raise CommandError('{} is not a configured language code in settings.LANGUAGES ' + raise CommandError('{} is not a configured language code in settings.LANGUAGES ' # noqa: UP032 'or the current DarkLangConfig.'.format(new_lang_code)) max_id = UserPreference.objects.all().aggregate(Max('id'))['id__max'] - print('Updating user language preferences from {} to {}. ' + print('Updating user language preferences from {} to {}. ' # noqa: UP032 'Start id is {}, current max id is {}. ' 'Chunk size is of {}'.format(old_lang_code, new_lang_code, start, max_id, chunk_size)) @@ -98,7 +98,7 @@ def handle(self, *args, **options): end += chunk_size sleep(sleep_time_secs) - print('Finished! Updated {} total preferences from {} to {}'.format( + print('Finished! Updated {} total preferences from {} to {}'.format( # noqa: UP032 updated_count, old_lang_code, new_lang_code diff --git a/openedx/core/djangoapps/user_api/management/commands/populate_enterprise_learner_current_job.py b/openedx/core/djangoapps/user_api/management/commands/populate_enterprise_learner_current_job.py index 6593556ab871..cb4463315aad 100644 --- a/openedx/core/djangoapps/user_api/management/commands/populate_enterprise_learner_current_job.py +++ b/openedx/core/djangoapps/user_api/management/commands/populate_enterprise_learner_current_job.py @@ -1,13 +1,12 @@ """ Management command for populaing current job of learners in learner profile. """ import logging - -from edx_rest_api_client.client import OAuthAPIClient from urllib.parse import urljoin -from django.core.exceptions import ObjectDoesNotExist from django.conf import settings +from django.core.exceptions import ObjectDoesNotExist from django.core.management.base import BaseCommand +from edx_rest_api_client.client import OAuthAPIClient from common.djangoapps.student.models import User, UserProfile from openedx.core.djangoapps.user_api import errors @@ -68,7 +67,7 @@ def _get_user_profile(self, username): try: existing_user = User.objects.get(username=username) except ObjectDoesNotExist: - raise errors.UserNotFound() # lint-amnesty, pylint: disable=raise-missing-from + raise errors.UserNotFound() # pylint: disable=raise-missing-from # noqa: B904 existing_user_profile, _ = UserProfile.objects.get_or_create(user=existing_user) return existing_user_profile @@ -89,7 +88,7 @@ def _update_current_job_of_learner(self, username, current_job): user_profile.save() self.TOTAL_USERS_UPDATED += 1 - except Exception: # lint-amnesty, pylint: disable=broad-except + except Exception: # pylint: disable=broad-except LOGGER.exception('Could not update profile of user %s as %s.', username, current_job) def _populate_learner_current_job(self, response): @@ -141,5 +140,5 @@ def handle(self, *args, **options): self._populate_learner_profiles() LOGGER.info('Successfully populated current job of %s learner(s) from %s total learners.', self.TOTAL_USERS_UPDATED, self.TOTAL_USERS_COUNT) - except Exception as err: # lint-amnesty, pylint: disable=broad-except + except Exception as err: # pylint: disable=broad-except LOGGER.exception('Could not populate current job of learners. %s', err) diff --git a/openedx/core/djangoapps/user_api/management/commands/populate_retirement_states.py b/openedx/core/djangoapps/user_api/management/commands/populate_retirement_states.py index 5ab54a781b96..faa55d46982a 100644 --- a/openedx/core/djangoapps/user_api/management/commands/populate_retirement_states.py +++ b/openedx/core/djangoapps/user_api/management/commands/populate_retirement_states.py @@ -50,7 +50,7 @@ def _validate_new_states(self, new_states): raise CommandError('settings.RETIREMENT_STATES does not exist or is empty.') if not set(REQUIRED_STATES).issubset(set(new_states)): - raise CommandError('settings.RETIREMENT_STATES ({}) does not contain all required states ' + raise CommandError('settings.RETIREMENT_STATES ({}) does not contain all required states ' # noqa: UP032 '({})'.format(new_states, REQ_STR)) # Confirm that the start and end states are in the right places @@ -60,7 +60,7 @@ def _validate_new_states(self, new_states): num_end_states = len(END_STATES) if new_states[-num_end_states:] != END_STATES: - raise CommandError('The last {} states must be these (in this order): ' + raise CommandError('The last {} states must be these (in this order): ' # noqa: UP032 '{}'.format(num_end_states, END_STATES)) def _check_current_users(self): @@ -69,13 +69,13 @@ def _check_current_users(self): """ if UserRetirementStatus.objects.exclude(current_state__state_name__in=REQUIRED_STATES).exists(): raise CommandError( - 'Users are currently being processed. All users must be in one of these states to run this command: ' + 'Users are currently being processed. All users must be in one of these states to run this command: ' # noqa: UP032 # pylint: disable=line-too-long '{}'.format(REQ_STR) ) def _check_users_in_states_to_delete(self, states_to_delete): if UserRetirementStatus.objects.filter(current_state__state_name__in=states_to_delete).exists(): - raise CommandError('Users exist in a state that is marked for deletion! States to delete' + raise CommandError('Users exist in a state that is marked for deletion! States to delete' # noqa: UP032 'are: {}'.format(states_to_delete)) def _delete_old_states_and_create_new(self, new_states, dry_run=False): diff --git a/openedx/core/djangoapps/user_api/management/commands/retire_user.py b/openedx/core/djangoapps/user_api/management/commands/retire_user.py index e2db5c48b33b..e6577e1c5960 100644 --- a/openedx/core/djangoapps/user_api/management/commands/retire_user.py +++ b/openedx/core/djangoapps/user_api/management/commands/retire_user.py @@ -1,16 +1,13 @@ -# lint-amnesty, pylint: disable=missing-module-docstring +# pylint: disable=missing-module-docstring import logging -from django.contrib.auth import get_user_model # lint-amnesty, pylint: disable=unused-import -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth import get_user_model # pylint: disable=unused-import +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.core.management.base import BaseCommand, CommandError from django.db import transaction -from social_django.models import UserSocialAuth -from common.djangoapps.student.models import AccountRecovery, Registration, get_retired_email_by_email -from openedx.core.djangolib.oauth2_retirement_utils import retire_dot_oauth2_models - -from ...models import BulkUserRetirementConfig, UserRetirementStatus +from ...accounts.utils import create_retirement_request_and_deactivate_account +from ...models import BulkUserRetirementConfig logger = logging.getLogger(__name__) @@ -59,13 +56,13 @@ def append_users_lists(self, file_handler, user_model): try: if isinstance(file_handler, str): - userinfo = open(file_handler, 'r') + userinfo = open(file_handler, 'r') # noqa: UP015 else: userinfo = file_handler.open('r') except Exception as exc: error_message = f'Error while reading file: {exc}' logger.error(error_message) - raise CommandError(error_message) # lint-amnesty, pylint: disable=raise-missing-from + raise CommandError(error_message) # pylint: disable=raise-missing-from # noqa: B904 for record in userinfo: if isinstance(record, bytes): @@ -137,37 +134,22 @@ def handle(self, *args, **options): 'trying again' ) logger.error(error_message) - raise CommandError(error_message + f': {unknown_users}') # lint-amnesty, pylint: disable=raise-missing-from + raise CommandError(error_message + f': {unknown_users}') # pylint: disable=raise-missing-from try: with transaction.atomic(): for user in users: - # Add user to retirement queue. - UserRetirementStatus.create_retirement(user) - # Unlink LMS social auth accounts - UserSocialAuth.objects.filter(user_id=user.id).delete() - # Change LMS password & email - user.email = get_retired_email_by_email(user.email) - user.set_unusable_password() - user.save() - - # TODO: Unlink social accounts & change password on each IDA. - # Remove the activation keys sent by email to the user for account activation. - Registration.objects.filter(user=user).delete() - - # Delete OAuth tokens associated with the user. - retire_dot_oauth2_models(user) - AccountRecovery.retire_recovery_email(user.id) + create_retirement_request_and_deactivate_account(user) except KeyError: error_message = f'Username not specified {user}' logger.error(error_message) - raise CommandError(error_message) # lint-amnesty, pylint: disable=raise-missing-from + raise CommandError(error_message) # pylint: disable=raise-missing-from # noqa: B904 except user_model.DoesNotExist: error_message = f'The user "{user.username}" does not exist.' logger.error(error_message) - raise CommandError(error_message) # lint-amnesty, pylint: disable=raise-missing-from + raise CommandError(error_message) # pylint: disable=raise-missing-from # noqa: B904 except Exception as exc: # pylint: disable=broad-except error_message = f'500 error deactivating account: {exc}' logger.error(error_message) - raise CommandError(error_message) # lint-amnesty, pylint: disable=raise-missing-from + raise CommandError(error_message) # pylint: disable=raise-missing-from # noqa: B904 logger.info("User successfully moved to the retirement pipeline") diff --git a/openedx/core/djangoapps/user_api/management/commands/sync_hubspot_contacts.py b/openedx/core/djangoapps/user_api/management/commands/sync_hubspot_contacts.py index ef1f386317a5..d10d7ebfaa6b 100644 --- a/openedx/core/djangoapps/user_api/management/commands/sync_hubspot_contacts.py +++ b/openedx/core/djangoapps/user_api/management/commands/sync_hubspot_contacts.py @@ -13,7 +13,7 @@ from textwrap import dedent import requests -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.core.management.base import BaseCommand, CommandError from requests.exceptions import HTTPError @@ -68,7 +68,7 @@ def _get_batched_users(self, site_domain, users_queryset, offset, users_query_ba """ self.stdout.write( - 'Fetching Users for site {site} from {start} to {end}'.format( + 'Fetching Users for site {site} from {start} to {end}'.format( # noqa: UP032 site=site_domain, start=offset, end=offset + users_query_batch_size ) ) @@ -145,7 +145,7 @@ def _sync_with_hubspot(self, users_batch, site_conf): response.raise_for_status() return len(contacts) except HTTPError as ex: - message = 'An error occurred while syncing batch of contacts for site {domain}, {message}'.format( + message = 'An error occurred while syncing batch of contacts for site {domain}, {message}'.format( # noqa: UP032 # pylint: disable=line-too-long domain=site_conf.site.domain, message=str(ex) ) self.stderr.write(message) @@ -166,7 +166,7 @@ def _sync_site(self, site_conf, users_queryset, users_count, contacts_batch_size while offset < users_count: is_last_iteration = (offset + users_query_batch_size) >= users_count self.stdout.write( - 'Syncing users batch from {start} to {end} for site {site}'.format( + 'Syncing users batch from {start} to {end} for site {site}'.format( # noqa: UP032 start=offset, end=offset + users_query_batch_size, site=site_domain ) ) @@ -178,14 +178,14 @@ def _sync_site(self, site_conf, users_queryset, users_count, contacts_batch_size successfully_synced_contacts += self._sync_with_hubspot(users_batch, site_conf) time.sleep(0.1) # to make sure request per second could not exceed by 10 self.stdout.write( - 'Successfully synced users batch from {start} to {end} for site {site}'.format( + 'Successfully synced users batch from {start} to {end} for site {site}'.format( # noqa: UP032 start=offset, end=offset + users_query_batch_size, site=site_domain ) ) offset += users_query_batch_size self.stdout.write( - '{count} contacts found and sycned for site {site}'.format( + '{count} contacts found and sycned for site {site}'.format( # noqa: UP032 count=successfully_synced_contacts, site=site_domain ) ) @@ -227,4 +227,4 @@ def handle(self, *args, **options): except Exception as ex: traceback.print_exc() - raise CommandError('Command failed with traceback %s' % str(ex)) # lint-amnesty, pylint: disable=raise-missing-from + raise CommandError('Command failed with traceback %s' % str(ex)) # pylint: disable=raise-missing-from # noqa: B904, UP031 diff --git a/openedx/core/djangoapps/user_api/management/tests/test_bulk_user_org_email_optout.py b/openedx/core/djangoapps/user_api/management/tests/test_bulk_user_org_email_optout.py index 9fbd8fcc053e..9e393b82e43c 100644 --- a/openedx/core/djangoapps/user_api/management/tests/test_bulk_user_org_email_optout.py +++ b/openedx/core/djangoapps/user_api/management/tests/test_bulk_user_org_email_optout.py @@ -3,12 +3,12 @@ """ -import io # lint-amnesty, pylint: disable=unused-import +import io # pylint: disable=unused-import # noqa: F401 import os import tempfile from contextlib import contextmanager - from unittest import mock + import pytest from django.core.management import call_command diff --git a/openedx/core/djangoapps/user_api/management/tests/test_cancel_retirement.py b/openedx/core/djangoapps/user_api/management/tests/test_cancel_retirement.py index ad9071b2b0e1..835de47ea9a7 100644 --- a/openedx/core/djangoapps/user_api/management/tests/test_cancel_retirement.py +++ b/openedx/core/djangoapps/user_api/management/tests/test_cancel_retirement.py @@ -5,20 +5,20 @@ import pytest from django.contrib.auth.hashers import UNUSABLE_PASSWORD_PREFIX -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.core.management import CommandError, call_command +from common.djangoapps.student.tests.factories import UserFactory from openedx.core.djangoapps.user_api.accounts.tests.retirement_helpers import ( # pylint: disable=unused-import - logged_out_retirement_request, - setup_retirement_states + logged_out_retirement_request, # noqa: F401 + setup_retirement_states, # noqa: F401 ) from openedx.core.djangoapps.user_api.models import RetirementState, UserRetirementRequest, UserRetirementStatus -from common.djangoapps.student.tests.factories import UserFactory pytestmark = pytest.mark.django_db -def test_successful_cancellation(setup_retirement_states, logged_out_retirement_request, capsys): # pylint: disable=redefined-outer-name, unused-argument +def test_successful_cancellation(setup_retirement_states, logged_out_retirement_request, capsys): # pylint: disable=redefined-outer-name, unused-argument # noqa: F811 """ Test a successfully cancelled retirement request. """ @@ -38,7 +38,7 @@ def test_successful_cancellation(setup_retirement_states, logged_out_retirement_ assert logged_out_retirement_request.original_email in output -def test_cancellation_in_unrecoverable_state(setup_retirement_states, logged_out_retirement_request): # pylint: disable=redefined-outer-name, unused-argument +def test_cancellation_in_unrecoverable_state(setup_retirement_states, logged_out_retirement_request): # pylint: disable=redefined-outer-name, unused-argument # noqa: F811 """ Test a failed cancellation of a retirement request due to the retirement already beginning. """ @@ -49,7 +49,7 @@ def test_cancellation_in_unrecoverable_state(setup_retirement_states, logged_out call_command('cancel_user_retirement_request', logged_out_retirement_request.original_email) -def test_cancellation_unknown_email_address(setup_retirement_states, logged_out_retirement_request): # pylint: disable=redefined-outer-name, unused-argument +def test_cancellation_unknown_email_address(setup_retirement_states, logged_out_retirement_request): # pylint: disable=redefined-outer-name, unused-argument # noqa: F811 """ Test attempting to cancel a non-existent request of a user. """ diff --git a/openedx/core/djangoapps/user_api/management/tests/test_email_opt_in_list.py b/openedx/core/djangoapps/user_api/management/tests/test_email_opt_in_list.py index b32a8f723d5e..55d92cb36249 100644 --- a/openedx/core/djangoapps/user_api/management/tests/test_email_opt_in_list.py +++ b/openedx/core/djangoapps/user_api/management/tests/test_email_opt_in_list.py @@ -8,18 +8,20 @@ from collections import defaultdict import ddt -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.core.management import call_command from django.core.management.base import CommandError +from common.djangoapps.student.models import CourseEnrollment +from common.djangoapps.student.tests.factories import CourseEnrollmentFactory, UserFactory from openedx.core.djangoapps.user_api.management.commands import email_opt_in_list from openedx.core.djangoapps.user_api.models import UserOrgTag from openedx.core.djangoapps.user_api.preferences.api import update_email_opt_in from openedx.core.djangolib.testing.utils import skip_unless_lms -from common.djangoapps.student.models import CourseEnrollment -from common.djangoapps.student.tests.factories import CourseEnrollmentFactory, UserFactory -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + ModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order @ddt.ddt @@ -185,7 +187,7 @@ def test_no_courses_for_org_name(self): self._set_opt_in_pref(self.user, self.TEST_ORG, True) # No course available for this particular org - with self.assertRaisesRegex(CommandError, "^No courses found for orgs:"): + with self.assertRaisesRegex(CommandError, "^No courses found for orgs:"): # noqa: PT027 self._run_command("other_org") def test_specify_subset_of_courses(self): @@ -270,16 +272,16 @@ def test_not_enough_args(self, num_args): expected_msg_regex = ( "^Error: the following arguments are required: OUTPUT_FILENAME, ORG_ALIASES$" ) - with self.assertRaisesRegex(CommandError, expected_msg_regex): + with self.assertRaisesRegex(CommandError, expected_msg_regex): # noqa: PT027 call_command('email_opt_in_list', *args) def test_file_already_exists(self): - temp_file = tempfile.NamedTemporaryFile(delete=True) # lint-amnesty, pylint: disable=consider-using-with + temp_file = tempfile.NamedTemporaryFile(delete=True) # pylint: disable=consider-using-with def _cleanup(): temp_file.close() - with self.assertRaisesRegex(CommandError, "^File already exists"): + with self.assertRaisesRegex(CommandError, "^File already exists"): # noqa: PT027 call_command('email_opt_in_list', temp_file.name, self.TEST_ORG) def test_no_user_profile(self): diff --git a/openedx/core/djangoapps/user_api/management/tests/test_populate_retirement_states.py b/openedx/core/djangoapps/user_api/management/tests/test_populate_retirement_states.py index e43ebd54f9a7..36075e764133 100644 --- a/openedx/core/djangoapps/user_api/management/tests/test_populate_retirement_states.py +++ b/openedx/core/djangoapps/user_api/management/tests/test_populate_retirement_states.py @@ -8,9 +8,9 @@ import pytest from django.core.management import CommandError, call_command +from common.djangoapps.student.tests.factories import UserFactory from openedx.core.djangoapps.user_api.management.commands.populate_retirement_states import START_STATE from openedx.core.djangoapps.user_api.models import RetirementState, UserRetirementStatus -from common.djangoapps.student.tests.factories import UserFactory pytestmark = pytest.mark.django_db diff --git a/openedx/core/djangoapps/user_api/management/tests/test_retire_user.py b/openedx/core/djangoapps/user_api/management/tests/test_retire_user.py index 023efb54f4d7..9eab190a0687 100644 --- a/openedx/core/djangoapps/user_api/management/tests/test_retire_user.py +++ b/openedx/core/djangoapps/user_api/management/tests/test_retire_user.py @@ -3,22 +3,43 @@ """ +import csv +import os +from contextlib import contextmanager +from unittest import mock + import pytest -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.core.management import CommandError, call_command +from django.db.models.signals import pre_delete +from social_django.models import UserSocialAuth -from ...models import UserRetirementStatus -from openedx.core.djangoapps.user_api.accounts.tests.retirement_helpers import ( # lint-amnesty, pylint: disable=unused-import, wrong-import-order - setup_retirement_states +from common.djangoapps.student.tests.factories import UserFactory +from openedx.core.djangoapps.user_api.accounts.signals import ( + redact_social_auth_pii_before_deletion, ) -from openedx.core.djangolib.testing.utils import skip_unless_lms # lint-amnesty, pylint: disable=wrong-import-order -from common.djangoapps.student.tests.factories import UserFactory # lint-amnesty, pylint: disable=wrong-import-order -import csv -import os +from openedx.core.djangoapps.user_api.accounts.tests.retirement_helpers import ( + setup_retirement_states, # noqa: F401 +) +from openedx.core.djangolib.testing.utils import skip_unless_lms + +from ...models import UserRetirementStatus pytestmark = pytest.mark.django_db user_file = 'userfile.csv' +# Use a context manager to guarantee signal reconnection between tests. +@contextmanager +def disconnected_social_auth_redaction_signal(): + """ + Temporarily disconnect the fallback signal so these tests exercise the command path. + """ + pre_delete.disconnect(redact_social_auth_pii_before_deletion, sender=UserSocialAuth) + try: + yield + finally: + pre_delete.connect(redact_social_auth_pii_before_deletion, sender=UserSocialAuth) + def generate_dummy_users(): """ @@ -30,7 +51,7 @@ def generate_dummy_users(): user = UserFactory.create(username=f"user{i}", email=f"user{i}@example.com") users.append(user.username) emails.append(user.email) - users_list = [{'username': user, 'email': email} for user, email in zip(users, emails)] + users_list = [{'username': user, 'email': email} for user, email in zip(users, emails)] # noqa: B905 return users_list @@ -59,7 +80,7 @@ def remove_user_file(): @skip_unless_lms -def test_successful_retire_with_userfile(setup_retirement_states): # lint-amnesty, pylint: disable=redefined-outer-name, unused-argument +def test_successful_retire_with_userfile(setup_retirement_states): # pylint: disable=redefined-outer-name, unused-argument # noqa: F811 user = UserFactory.create(username='user0', email="user0@example.com") username = user.username user_email = user.email @@ -75,7 +96,7 @@ def test_successful_retire_with_userfile(setup_retirement_states): # lint-amnes @skip_unless_lms -def test_retire_user_with_usename_email_mismatch(setup_retirement_states): # lint-amnesty, pylint: disable=redefined-outer-name, unused-argument +def test_retire_user_with_usename_email_mismatch(setup_retirement_states): # pylint: disable=redefined-outer-name, unused-argument # noqa: F811 create_user_file(True) with pytest.raises(CommandError, match=r'Could not find users with specified username and email '): call_command('retire_user', user_file=user_file) @@ -83,7 +104,7 @@ def test_retire_user_with_usename_email_mismatch(setup_retirement_states): # li @skip_unless_lms -def test_successful_retire_with_username_email(setup_retirement_states): # lint-amnesty, pylint: disable=redefined-outer-name, unused-argument +def test_successful_retire_with_username_email(setup_retirement_states): # pylint: disable=redefined-outer-name, unused-argument # noqa: F811 user = UserFactory.create(username='user0', email="user0@example.com") username = user.username user_email = user.email @@ -97,7 +118,7 @@ def test_successful_retire_with_username_email(setup_retirement_states): # lint @skip_unless_lms -def test_retire_with_username_email_userfile(setup_retirement_states): # lint-amnesty, pylint: disable=redefined-outer-name, unused-argument +def test_retire_with_username_email_userfile(setup_retirement_states): # pylint: disable=redefined-outer-name, unused-argument # noqa: F811 user = UserFactory.create(username='user0', email="user0@example.com") username = user.username user_email = user.email @@ -105,3 +126,55 @@ def test_retire_with_username_email_userfile(setup_retirement_states): # lint-a with pytest.raises(CommandError, match=r'You cannot use userfile option with username and user_email'): call_command('retire_user', user_file=user_file, username=username, user_email=user_email) remove_user_file() + + +@skip_unless_lms +@pytest.mark.usefixtures('setup_retirement_states') +@mock.patch( + 'openedx.core.djangoapps.user_api.management.commands.retire_user.create_retirement_request_and_deactivate_account' +) +def test_retire_user_calls_shared_deactivate_helper(mock_deactivate_helper): + """ + Verify the command delegates retirement side effects to the shared helper. + """ + user = UserFactory.create(username='user-cleanup', email='user-cleanup@example.com') + + call_command('retire_user', username=user.username, user_email=user.email) + + mock_deactivate_helper.assert_called_once_with(user) + + +@pytest.mark.parametrize('social_auth_configs', [ + # Single SSO provider + [ + {'provider': 'google-oauth2', 'uid': 'sso@example.com', + 'extra_data': {'email': 'sso@example.com', 'name': 'SSO Test User', 'id': '123456789'}}, + ], + # Multiple SSO providers + [ + {'provider': 'google-oauth2', 'uid': 'google@example.com', + 'extra_data': {'email': 'google@example.com', 'name': 'Google User'}}, + {'provider': 'tpa-saml', 'uid': 'saml@example.com', + 'extra_data': {'email': 'saml@example.com', 'name': 'SAML User', 'uid': 'saml-123'}}, + ], +]) +def test_retire_user_redacts_sso_pii_before_deletion(setup_retirement_states, social_auth_configs): # lint-amnesty, pylint: disable=redefined-outer-name, unused-argument # noqa: F811 + """ + Test that Day 0 retirement preserves UserSocialAuth records. + Covers both single and multiple SSO provider scenarios. + """ + user = UserFactory.create(username='sso-user', email='sso-user@example.com') + auth_ids = [ + UserSocialAuth.objects.create(user=user, **cfg).id + for cfg in social_auth_configs + ] + + with disconnected_social_auth_redaction_signal(): + call_command('retire_user', username=user.username, user_email=user.email) + + for auth_id in auth_ids: + assert UserSocialAuth.objects.filter(id=auth_id).exists() + + retired_user_status = UserRetirementStatus.objects.filter(original_username=user.username).first() + assert retired_user_status is not None + assert retired_user_status.original_email == 'sso-user@example.com' diff --git a/openedx/core/djangoapps/user_api/management/tests/test_sync_hubspot_contacts.py b/openedx/core/djangoapps/user_api/management/tests/test_sync_hubspot_contacts.py index 4956554b1ef5..d72e874eed97 100644 --- a/openedx/core/djangoapps/user_api/management/tests/test_sync_hubspot_contacts.py +++ b/openedx/core/djangoapps/user_api/management/tests/test_sync_hubspot_contacts.py @@ -12,11 +12,11 @@ from django.test import TestCase from django.utils import timezone +from common.djangoapps.student.models import UserAttribute, UserProfile +from common.djangoapps.student.tests.factories import UserFactory from openedx.core.djangoapps.site_configuration.tests.factories import SiteConfigurationFactory from openedx.core.djangoapps.user_api.management.commands.sync_hubspot_contacts import Command as sync_command from openedx.core.djangolib.testing.utils import skip_unless_lms -from common.djangoapps.student.models import UserAttribute, UserProfile -from common.djangoapps.student.tests.factories import UserFactory @skip_unless_lms @@ -37,7 +37,7 @@ def setUpClass(cls): cls._create_users(cls.site_config) @classmethod - def _create_users(cls, site_conf): # lint-amnesty, pylint: disable=missing-function-docstring + def _create_users(cls, site_conf): # pylint: disable=missing-function-docstring # Create some test users for i in range(1, 20): profile_meta = { diff --git a/openedx/core/djangoapps/user_api/middleware.py b/openedx/core/djangoapps/user_api/middleware.py index 95bb3d568db6..ef33b27ab4a2 100644 --- a/openedx/core/djangoapps/user_api/middleware.py +++ b/openedx/core/djangoapps/user_api/middleware.py @@ -4,7 +4,6 @@ """ from django.utils.deprecation import MiddlewareMixin - from eventtracking import tracker from opaque_keys import InvalidKeyError from opaque_keys.edx.keys import CourseKey diff --git a/openedx/core/djangoapps/user_api/migrations/0005_bulkuserretirementconfig.py b/openedx/core/djangoapps/user_api/migrations/0005_bulkuserretirementconfig.py index af2508dea6a9..b312af831fa6 100644 --- a/openedx/core/djangoapps/user_api/migrations/0005_bulkuserretirementconfig.py +++ b/openedx/core/djangoapps/user_api/migrations/0005_bulkuserretirementconfig.py @@ -1,9 +1,9 @@ # Generated by Django 3.2.18 on 2023-03-22 10:34 -from django.conf import settings import django.core.validators -from django.db import migrations, models import django.db.models.deletion +from django.conf import settings +from django.db import migrations, models class Migration(migrations.Migration): diff --git a/openedx/core/djangoapps/user_api/models.py b/openedx/core/djangoapps/user_api/models.py index 2086ebecf3c6..7fd08dcbe110 100644 --- a/openedx/core/djangoapps/user_api/models.py +++ b/openedx/core/djangoapps/user_api/models.py @@ -3,18 +3,22 @@ """ -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from config_models.models import ConfigurationModel +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.core.validators import FileExtensionValidator, RegexValidator from django.db import models from django.db.models.signals import post_delete, post_save, pre_save from django.dispatch import receiver from django.utils.translation import gettext_lazy as _ - -from config_models.models import ConfigurationModel - from model_utils.models import TimeStampedModel from opaque_keys.edx.django.models import CourseKeyField +# pylint: disable=unused-import +from common.djangoapps.student.models import get_retired_email_by_email, get_retired_username_by_username +from common.djangoapps.util.model_utils import emit_settings_changed_event, get_changed_fields_dict +from openedx.core.djangolib.model_mixins import DeletableByUserValue +from openedx.core.lib.cache_utils import request_cached + # Currently, the "student" app is responsible for # accounts, profiles, enrollments, and the student dashboard. # We are trying to move some of this functionality into separate apps, @@ -22,25 +26,13 @@ # certain models. For now we will leave the models in "student" and # create an alias in "user_api". -from openedx.core.djangolib.model_mixins import DeletableByUserValue -from openedx.core.lib.cache_utils import request_cached -# pylint: disable=unused-import -from common.djangoapps.student.models import ( - get_retired_email_by_email, - get_retired_username_by_username -) -from common.djangoapps.util.model_utils import ( - emit_settings_changed_event, - get_changed_fields_dict, - -) class RetirementStateError(Exception): pass -class UserPreference(models.Model): +class UserPreference(models.Model): # noqa: DJ008 """ A user's preference, stored as generic text to be processed by client @@ -154,7 +146,7 @@ def post_delete_callback(sender, **kwargs): ) -class UserCourseTag(models.Model): +class UserCourseTag(models.Model): # noqa: DJ008 """ Per-course user tags, to be used by various things that want to store tags about the user. Added initially to store assignment to experimental groups. @@ -204,7 +196,7 @@ class RetirementState(models.Model): def __str__(self): return f'{self.state_name} (step {self.state_execution_order})' - class Meta: + class Meta: # noqa: DJ012 ordering = ('state_execution_order',) @classmethod @@ -247,7 +239,7 @@ class Meta: verbose_name_plural = 'User Retirement Reporting Statuses' def __str__(self): - return 'UserRetirementPartnerReportingStatus: {} is being processed: {}'.format( + return 'UserRetirementPartnerReportingStatus: {} is being processed: {}'.format( # noqa: UP032 self.user, self.is_being_processed ) @@ -324,7 +316,7 @@ def _validate_state_update(self, new_state): raise ValueError() except ValueError: err = f'{new_state} does not exist or is an eariler state than current state {self.current_state}' - raise RetirementStateError(err) # lint-amnesty, pylint: disable=raise-missing-from + raise RetirementStateError(err) # pylint: disable=raise-missing-from # noqa: B904 def _validate_update_data(self, data): """ @@ -351,7 +343,7 @@ def create_retirement(cls, user): try: pending = RetirementState.objects.all().order_by('state_execution_order')[0] except IndexError: - raise RetirementStateError('Default state does not exist! Populate retirement states to retire users.') # lint-amnesty, pylint: disable=raise-missing-from + raise RetirementStateError('Default state does not exist! Populate retirement states to retire users.') # pylint: disable=raise-missing-from,line-too-long # noqa: B904 if cls.objects.filter(user=user).exists(): raise RetirementStateError(f'User {user} already has a retirement status row!') @@ -415,13 +407,13 @@ def get_retirement_for_retirement_action(cls, username): break if retirement is None: - raise UserRetirementStatus.DoesNotExist('{} does not have an exact match in UserRetirementStatus. ' + raise UserRetirementStatus.DoesNotExist('{} does not have an exact match in UserRetirementStatus. ' # noqa: UP032 # pylint: disable=line-too-long '{} similar rows found.'.format(username, len(retirements))) state = retirement.current_state if state.required or state.state_name.endswith('_COMPLETE'): - raise RetirementStateError('{} is in {}, not a valid state to perform retirement ' + raise RetirementStateError('{} is in {}, not a valid state to perform retirement ' # noqa: UP032 'actions on.'.format(retirement, state.state_name)) return retirement diff --git a/openedx/core/djangoapps/user_api/partition_schemes.py b/openedx/core/djangoapps/user_api/partition_schemes.py index caa305387ac5..95af7f2a2fbf 100644 --- a/openedx/core/djangoapps/user_api/partition_schemes.py +++ b/openedx/core/djangoapps/user_api/partition_schemes.py @@ -9,7 +9,10 @@ from eventtracking import tracker import openedx.core.djangoapps.user_api.course_tag.api as course_tag_api -from xmodule.partitions.partitions import NoSuchUserPartitionGroupError, UserPartitionError # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.partitions.partitions import ( # pylint: disable=wrong-import-order + NoSuchUserPartitionGroupError, + UserPartitionError, +) log = logging.getLogger(__name__) diff --git a/openedx/core/djangoapps/user_api/permissions.py b/openedx/core/djangoapps/user_api/permissions.py index bf126fb4049b..3c10fcc63f76 100644 --- a/openedx/core/djangoapps/user_api/permissions.py +++ b/openedx/core/djangoapps/user_api/permissions.py @@ -3,7 +3,7 @@ """ -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.http import Http404 from django.shortcuts import get_object_or_404 from rest_framework import permissions diff --git a/openedx/core/djangoapps/user_api/preferences/api.py b/openedx/core/djangoapps/user_api/preferences/api.py index e0a6797ebe25..53ff77da9c29 100644 --- a/openedx/core/djangoapps/user_api/preferences/api.py +++ b/openedx/core/djangoapps/user_api/preferences/api.py @@ -13,18 +13,18 @@ from django_countries import countries from pytz import common_timezones, common_timezones_set, country_timezones -from openedx.core.lib.time_zone_utils import get_display_time_zone from common.djangoapps.student.models import User, UserProfile from common.djangoapps.track import segment +from openedx.core.lib.time_zone_utils import get_display_time_zone -from ..errors import ( # lint-amnesty, pylint: disable=unused-import - CountryCodeError, +from ..errors import ( # pylint: disable=unused-import + CountryCodeError, # noqa: F401 PreferenceUpdateError, PreferenceValidationError, UserAPIInternalError, UserAPIRequestError, UserNotAuthorized, - UserNotFound + UserNotFound, ) from ..helpers import intercept_errors, serializer_is_dirty from ..models import UserOrgTag, UserPreference @@ -168,7 +168,7 @@ def update_user_preferences(requesting_user, update, user=None): if serializer_is_dirty(serializer): serializer.save() except Exception as error: - raise _create_preference_update_error(preference_key, preference_value, error) # lint-amnesty, pylint: disable=raise-missing-from + raise _create_preference_update_error(preference_key, preference_value, error) # pylint: disable=raise-missing-from # noqa: B904 else: delete_user_preference(requesting_user, preference_key) @@ -208,7 +208,7 @@ def set_user_preference(requesting_user, preference_key, preference_value, usern try: serializer.save() except Exception as error: - raise _create_preference_update_error(preference_key, preference_value, error) # lint-amnesty, pylint: disable=raise-missing-from + raise _create_preference_update_error(preference_key, preference_value, error) # pylint: disable=raise-missing-from # noqa: B904 @intercept_errors(UserAPIInternalError, ignore_errors=[UserAPIRequestError]) @@ -246,8 +246,8 @@ def delete_user_preference(requesting_user, preference_key, username=None): try: user_preference.delete() except Exception as error: - raise PreferenceUpdateError( # lint-amnesty, pylint: disable=raise-missing-from - developer_message="Delete failed for user preference '{preference_key}': {error}".format( + raise PreferenceUpdateError( # pylint: disable=raise-missing-from # noqa: B904 + developer_message="Delete failed for user preference '{preference_key}': {error}".format( # noqa: UP032 preference_key=preference_key, error=error ), user_message=_("Delete failed for user preference '{preference_key}'.").format( @@ -284,7 +284,7 @@ def update_email_opt_in(user, org, opt_in): try: user_profile = UserProfile.objects.get(user=user) except ObjectDoesNotExist: - raise UserNotFound() # lint-amnesty, pylint: disable=raise-missing-from + raise UserNotFound() # pylint: disable=raise-missing-from # noqa: B904 if user_profile.requires_parental_consent( age_limit=getattr(settings, 'EMAIL_OPTIN_MINIMUM_AGE', 13), default_requires_consent=False, @@ -344,7 +344,7 @@ def _get_authorized_user(requesting_user, username=None, allow_staff=False): try: existing_user = User.objects.get(username=username) except ObjectDoesNotExist: - raise UserNotFound() # lint-amnesty, pylint: disable=raise-missing-from + raise UserNotFound() # pylint: disable=raise-missing-from # noqa: B904 return existing_user @@ -403,7 +403,7 @@ def validate_user_preference_serializer(serializer, preference_key, preference_v raise PreferenceValidationError({ preference_key: { "developer_message": format_string.format(preference_key=preference_key), - "user_message": _(format_string).format(preference_key=preference_key) # lint-amnesty, pylint: disable=translation-of-non-string + "user_message": _(format_string).format(preference_key=preference_key) # pylint: disable=translation-of-non-string } }) if not serializer.is_valid(): @@ -412,7 +412,7 @@ def validate_user_preference_serializer(serializer, preference_key, preference_v # messages into the strings only. for key in errors: errors[key] = [str(el) for el in errors[key]] - developer_message = "Value '{preference_value}' not valid for preference '{preference_key}': {error}".format( + developer_message = "Value '{preference_value}' not valid for preference '{preference_key}': {error}".format( # noqa: UP032 # pylint: disable=line-too-long preference_key=preference_key, preference_value=preference_value, error=errors ) if "key" in serializer.errors: @@ -445,7 +445,7 @@ def validate_user_preference_serializer(serializer, preference_key, preference_v def _create_preference_update_error(preference_key, preference_value, error): """ Creates a PreferenceUpdateError with developer_message and user_message. """ return PreferenceUpdateError( - developer_message="Save failed for user preference '{key}' with value '{value}': {error}".format( + developer_message="Save failed for user preference '{key}' with value '{value}': {error}".format( # noqa: UP032 key=preference_key, value=preference_value, error=error ), user_message=_("Save failed for user preference '{key}' with value '{value}'.").format( diff --git a/openedx/core/djangoapps/user_api/preferences/tests/test_api.py b/openedx/core/djangoapps/user_api/preferences/tests/test_api.py index 34295801801b..b2c360081449 100644 --- a/openedx/core/djangoapps/user_api/preferences/tests/test_api.py +++ b/openedx/core/djangoapps/user_api/preferences/tests/test_api.py @@ -5,27 +5,30 @@ import datetime from unittest.mock import patch -import pytest + import ddt +import pytest from dateutil.parser import parse as parse_datetime -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.test.utils import override_settings from django.urls import reverse from pytz import common_timezones, utc -from openedx.core.djangolib.testing.utils import CacheIsolationTestCase, skip_unless_lms -from openedx.core.lib.time_zone_utils import get_display_time_zone from common.djangoapps.student.models import UserProfile from common.djangoapps.student.tests.factories import UserFactory -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from openedx.core.djangolib.testing.utils import CacheIsolationTestCase, skip_unless_lms +from openedx.core.lib.time_zone_utils import get_display_time_zone +from xmodule.modulestore.tests.django_utils import ( + ModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order -from ...errors import ( # lint-amnesty, pylint: disable=unused-import - CountryCodeError, +from ...errors import ( # pylint: disable=unused-import + CountryCodeError, # noqa: F401 PreferenceUpdateError, PreferenceValidationError, UserNotAuthorized, - UserNotFound + UserNotFound, ) from ...models import UserOrgTag from ...preferences.api import ( @@ -35,7 +38,7 @@ get_user_preferences, set_user_preference, update_email_opt_in, - update_user_preferences + update_user_preferences, ) @@ -435,7 +438,7 @@ def get_expected_validation_developer_message(preference_key, preference_value): ) -def get_expected_key_error_user_message(preference_key, preference_value): # lint-amnesty, pylint: disable=unused-argument +def get_expected_key_error_user_message(preference_key, preference_value): # pylint: disable=unused-argument """ Returns the expected user message for an invalid key. """ diff --git a/openedx/core/djangoapps/user_api/preferences/tests/test_views.py b/openedx/core/djangoapps/user_api/preferences/tests/test_views.py index 361c449103df..0fd7c37ad313 100644 --- a/openedx/core/djangoapps/user_api/preferences/tests/test_views.py +++ b/openedx/core/djangoapps/user_api/preferences/tests/test_views.py @@ -11,8 +11,8 @@ from django.urls import reverse from rest_framework.test import APIClient -from openedx.core.djangolib.testing.utils import skip_unless_lms from common.djangoapps.student.tests.factories import TEST_PASSWORD, UserFactory +from openedx.core.djangolib.testing.utils import skip_unless_lms from ...accounts.tests.test_views import UserAPITestCase from ..api import set_user_preference @@ -149,7 +149,7 @@ def _do_create_preferences_test(self, is_active): expected_status=204 ) response = self.send_get(self.client) - # lint-amnesty, pylint: disable=bad-option-value, unicode-format-string + # pylint: disable=bad-option-value, unicode-format-string pref_dict = {"dict_pref": "{'int_key': 10}", "string_pref": "value"} assert pref_dict == response.data @@ -198,7 +198,7 @@ def test_update_preferences(self): # Verify that GET returns the updated preferences response = self.send_get(self.client) expected_preferences = { - "dict_pref": "{'int_key': 10}", # lint-amnesty, pylint: disable=bad-option-value, unicode-format-string + "dict_pref": "{'int_key': 10}", # pylint: disable=bad-option-value, unicode-format-string "string_pref": "updated_value", "new_pref": "new_value", "time_zone": "Europe/London", diff --git a/openedx/core/djangoapps/user_api/preferences/views.py b/openedx/core/djangoapps/user_api/preferences/views.py index 6f983a13afe2..6f7cdae47a99 100644 --- a/openedx/core/djangoapps/user_api/preferences/views.py +++ b/openedx/core/djangoapps/user_api/preferences/views.py @@ -24,7 +24,7 @@ get_user_preference, get_user_preferences, set_user_preference, - update_user_preferences + update_user_preferences, ) diff --git a/openedx/core/djangoapps/user_api/serializers.py b/openedx/core/djangoapps/user_api/serializers.py index 437a9a61cf51..5b4dda5e2d3d 100644 --- a/openedx/core/djangoapps/user_api/serializers.py +++ b/openedx/core/djangoapps/user_api/serializers.py @@ -3,13 +3,10 @@ """ -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from rest_framework import serializers -from lms.djangoapps.verify_student.models import ( - ManualVerification, - SoftwareSecurePhotoVerification -) +from lms.djangoapps.verify_student.models import ManualVerification, SoftwareSecurePhotoVerification from .models import UserPreference @@ -100,7 +97,7 @@ class CountryTimeZoneSerializer(serializers.Serializer): # pylint: disable=abst description = serializers.CharField() -class IDVerificationDetailsSerializer(serializers.Serializer): # lint-amnesty, pylint: disable=abstract-method, missing-class-docstring +class IDVerificationDetailsSerializer(serializers.Serializer): # pylint: disable=abstract-method, missing-class-docstring type = serializers.SerializerMethodField() status = serializers.CharField() expiration_datetime = serializers.DateTimeField() @@ -108,7 +105,7 @@ class IDVerificationDetailsSerializer(serializers.Serializer): # lint-amnesty, updated_at = serializers.DateTimeField() receipt_id = serializers.SerializerMethodField() - def get_type(self, obj): # lint-amnesty, pylint: disable=missing-function-docstring + def get_type(self, obj): # pylint: disable=missing-function-docstring if isinstance(obj, SoftwareSecurePhotoVerification): return 'Software Secure' elif isinstance(obj, ManualVerification): @@ -116,7 +113,7 @@ def get_type(self, obj): # lint-amnesty, pylint: disable=missing-function-docst else: return 'SSO' - def get_message(self, obj): # lint-amnesty, pylint: disable=missing-function-docstring + def get_message(self, obj): # pylint: disable=missing-function-docstring if isinstance(obj, SoftwareSecurePhotoVerification): return obj.error_msg elif isinstance(obj, ManualVerification): diff --git a/openedx/core/djangoapps/user_api/tests/factories.py b/openedx/core/djangoapps/user_api/tests/factories.py index 9b6302ae3a1e..12e0cb737b61 100644 --- a/openedx/core/djangoapps/user_api/tests/factories.py +++ b/openedx/core/djangoapps/user_api/tests/factories.py @@ -6,7 +6,6 @@ from opaque_keys.edx.locator import CourseLocator from common.djangoapps.student.tests.factories import UserFactory - from openedx.core.djangoapps.user_api.models import ( RetirementState, UserCourseTag, diff --git a/openedx/core/djangoapps/user_api/tests/test_api.py b/openedx/core/djangoapps/user_api/tests/test_api.py index a929d1b8c643..66e5b1c143e1 100644 --- a/openedx/core/djangoapps/user_api/tests/test_api.py +++ b/openedx/core/djangoapps/user_api/tests/test_api.py @@ -7,11 +7,7 @@ from common.djangoapps.student.tests.factories import UserFactory from openedx.core.djangoapps.user_api.api import get_retired_user_ids -from openedx.core.djangoapps.user_api.models import ( - RetirementState, - UserRetirementRequest, - UserRetirementStatus, -) +from openedx.core.djangoapps.user_api.models import RetirementState, UserRetirementRequest, UserRetirementStatus from openedx.core.djangoapps.user_api.tests.factories import ( RetirementStateFactory, UserRetirementRequestFactory, diff --git a/openedx/core/djangoapps/user_api/tests/test_helpers.py b/openedx/core/djangoapps/user_api/tests/test_helpers.py index 274e1a265bba..a16c65400c93 100644 --- a/openedx/core/djangoapps/user_api/tests/test_helpers.py +++ b/openedx/core/djangoapps/user_api/tests/test_helpers.py @@ -16,12 +16,12 @@ class FakeInputException(Exception): """Fake exception that should be intercepted.""" - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass class FakeOutputException(Exception): """Fake exception that should be raised.""" - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass @intercept_errors(FakeOutputException, ignore_errors=[ValueError]) @@ -47,7 +47,7 @@ def test_ignores_no_error(self): intercepted_function() def test_ignores_expected_errors(self): - with pytest.raises(ValueError): + with pytest.raises(ValueError): # noqa: PT011 intercepted_function(raise_error=ValueError) @mock.patch('openedx.core.djangoapps.user_api.helpers.LOGGER') diff --git a/openedx/core/djangoapps/user_api/tests/test_middleware.py b/openedx/core/djangoapps/user_api/tests/test_middleware.py index 04b5b4104971..071c1adfdf7d 100644 --- a/openedx/core/djangoapps/user_api/tests/test_middleware.py +++ b/openedx/core/djangoapps/user_api/tests/test_middleware.py @@ -2,6 +2,7 @@ from unittest.mock import Mock, patch + from django.http import HttpResponse from django.test import TestCase from django.test.client import RequestFactory diff --git a/openedx/core/djangoapps/user_api/tests/test_models.py b/openedx/core/djangoapps/user_api/tests/test_models.py index dfa84bd50d91..9086eb8ecdc9 100644 --- a/openedx/core/djangoapps/user_api/tests/test_models.py +++ b/openedx/core/djangoapps/user_api/tests/test_models.py @@ -8,8 +8,10 @@ from common.djangoapps.student.tests.factories import UserFactory from common.djangoapps.student.tests.tests import UserSettingsEventTestMixin -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + ModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order from ..models import UserOrgTag, UserPreference from ..preferences.api import set_user_preference diff --git a/openedx/core/djangoapps/user_api/tests/test_partition_schemes.py b/openedx/core/djangoapps/user_api/tests/test_partition_schemes.py index b1fc0e6e577f..767b50b4de6f 100644 --- a/openedx/core/djangoapps/user_api/tests/test_partition_schemes.py +++ b/openedx/core/djangoapps/user_api/tests/test_partition_schemes.py @@ -9,10 +9,12 @@ import pytest from django.test import TestCase -from openedx.core.djangoapps.user_api.partition_schemes import RandomUserPartitionScheme, UserPartitionError from common.djangoapps.student.tests.factories import UserFactory -from xmodule.partitions.partitions import Group, UserPartition # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.partitions.tests.test_partitions import PartitionTestCase # lint-amnesty, pylint: disable=wrong-import-order +from openedx.core.djangoapps.user_api.partition_schemes import RandomUserPartitionScheme, UserPartitionError +from xmodule.partitions.partitions import Group, UserPartition # pylint: disable=wrong-import-order +from xmodule.partitions.tests.test_partitions import ( + PartitionTestCase, # pylint: disable=wrong-import-order +) class MemoryCourseTagAPI: @@ -32,7 +34,7 @@ def set_course_tag(self, __, course_id, key, value): class BulkCourseTags: @classmethod - def is_prefetched(self, course_id): # lint-amnesty, pylint: disable=bad-classmethod-argument, unused-argument + def is_prefetched(self, course_id): # pylint: disable=bad-classmethod-argument, unused-argument return False @@ -97,7 +99,7 @@ def test_empty_partition(self): scheme=RandomUserPartitionScheme ) # get a group assigned to the user - with self.assertRaisesRegex(UserPartitionError, "Cannot assign user to an empty user partition"): + with self.assertRaisesRegex(UserPartitionError, "Cannot assign user to an empty user partition"): # noqa: PT027 RandomUserPartitionScheme.get_group_for_user(self.MOCK_COURSE_ID, self.user, empty_partition) def test_user_in_deleted_group(self): @@ -141,10 +143,10 @@ def test_change_group_name(self): class TestExtension(TestCase): """ Ensure that the scheme extension is correctly plugged in (via entry point - in setup.py) + in pyproject.toml) """ def test_get_scheme(self): assert UserPartition.get_scheme('random') == RandomUserPartitionScheme - with self.assertRaisesRegex(UserPartitionError, 'Unrecognized scheme'): + with self.assertRaisesRegex(UserPartitionError, 'Unrecognized scheme'): # noqa: PT027 UserPartition.get_scheme('other') diff --git a/openedx/core/djangoapps/user_api/tests/test_views.py b/openedx/core/djangoapps/user_api/tests/test_views.py index 446ade442c1d..143002b30df6 100644 --- a/openedx/core/djangoapps/user_api/tests/test_views.py +++ b/openedx/core/djangoapps/user_api/tests/test_views.py @@ -1,24 +1,26 @@ """Tests for the user API at the HTTP request level. """ -import pytest import ddt +import pytest from django.test.utils import override_settings from django.urls import reverse from opaque_keys.edx.keys import CourseKey -from pytz import common_timezones_set, common_timezones, country_timezones +from pytz import common_timezones, common_timezones_set, country_timezones +from common.djangoapps.student.tests.factories import UserFactory from openedx.core.djangoapps.django_comment_common import models from openedx.core.djangolib.testing.utils import CacheIsolationTestCase, skip_unless_lms from openedx.core.lib.api.test_utils import TEST_API_KEY, ApiTestCase from openedx.core.lib.time_zone_utils import get_display_time_zone -from common.djangoapps.student.tests.factories import UserFactory -from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + SharedModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order from ..accounts.tests.retirement_helpers import ( # pylint: disable=unused-import - RetirementTestCase, - fake_requested_retirement, - setup_retirement_states, + RetirementTestCase, # noqa: F401 + fake_requested_retirement, # noqa: F401 + setup_retirement_states, # noqa: F401 ) from ..models import UserOrgTag from ..tests.factories import UserPreferenceFactory @@ -53,10 +55,10 @@ def get_uri_for_pref(self, target_pref): def assertUserIsValid(self, user): """Assert that the given user result is valid""" - self.assertCountEqual(list(user.keys()), ["email", "id", "name", "username", "preferences", "url"]) - self.assertCountEqual( + self.assertCountEqual(list(user.keys()), ["email", "id", "name", "username", "preferences", "url"]) # noqa: PT009 # pylint: disable=line-too-long + self.assertCountEqual( # noqa: PT009 list(user["preferences"].items()), - [(pref.key, pref.value) for pref in self.prefs if pref.user.id == user["id"]] # lint-amnesty, pylint: disable=no-member + [(pref.key, pref.value) for pref in self.prefs if pref.user.id == user["id"]] # pylint: disable=no-member ) self.assertSelfReferential(user) @@ -64,7 +66,7 @@ def assertPrefIsValid(self, pref): """ Assert that the given preference is acknowledged by the system """ - self.assertCountEqual(list(pref.keys()), ["user", "key", "value", "url"]) + self.assertCountEqual(list(pref.keys()), ["user", "key", "value", "url"]) # noqa: PT009 self.assertSelfReferential(pref) self.assertUserIsValid(pref["user"]) diff --git a/openedx/core/djangoapps/user_api/urls.py b/openedx/core/djangoapps/user_api/urls.py index b4bf1b3b2bbe..5928a1d4f422 100644 --- a/openedx/core/djangoapps/user_api/urls.py +++ b/openedx/core/djangoapps/user_api/urls.py @@ -8,24 +8,22 @@ from rest_framework import routers from ..profile_images.views import ProfileImageView +from . import views as user_api_views from .accounts.views import ( AccountDeactivationView, AccountRetirementPartnerReportView, AccountRetirementStatusView, AccountRetirementView, AccountViewSet, + CancelAccountRetirementStatusView, DeactivateLogoutView, LMSAccountRetirementView, NameChangeView, - UsernameReplacementView, CancelAccountRetirementStatusView + UsernameReplacementView, ) -from . import views as user_api_views from .models import UserPreference from .preferences.views import PreferencesDetailView, PreferencesView -from .verification_api.views import ( - IDVerificationStatusView, - IDVerificationStatusDetailsView, -) +from .verification_api.views import IDVerificationStatusDetailsView, IDVerificationStatusView ME = AccountViewSet.as_view({ 'get': 'get', diff --git a/openedx/core/djangoapps/user_api/verification_api/tests/test_views.py b/openedx/core/djangoapps/user_api/verification_api/tests/test_views.py index b8f51ef79a59..1c48b7753a31 100644 --- a/openedx/core/djangoapps/user_api/verification_api/tests/test_views.py +++ b/openedx/core/djangoapps/user_api/verification_api/tests/test_views.py @@ -176,12 +176,12 @@ def get_expected_response(self, *args, **kwargs): }] def test_multiple_verification_types(self): - self.manual_verification = ManualVerification.objects.create( # lint-amnesty, pylint: disable=attribute-defined-outside-init + self.manual_verification = ManualVerification.objects.create( # pylint: disable=attribute-defined-outside-init user=self.user, status='approved', reason='testing' ) - self.sso_verification = SSOVerificationFactory(user=self.user, status='approved') # lint-amnesty, pylint: disable=attribute-defined-outside-init + self.sso_verification = SSOVerificationFactory(user=self.user, status='approved') # pylint: disable=attribute-defined-outside-init self.photo_verification.error_msg = 'tested_error' self.photo_verification.error_code = 'error_code' self.photo_verification.status = 'denied' @@ -219,7 +219,7 @@ def test_multiple_verification_types(self): assert json.loads(response.content.decode('utf-8')) == expected def test_multiple_verification_instances(self): - self.sso_verification = SSOVerificationFactory(user=self.user, status='approved') # lint-amnesty, pylint: disable=attribute-defined-outside-init + self.sso_verification = SSOVerificationFactory(user=self.user, status='approved') # pylint: disable=attribute-defined-outside-init second_ss_photo_verification = SoftwareSecurePhotoVerification.objects.create( user=self.user, status='denied', diff --git a/openedx/core/djangoapps/user_api/verification_api/views.py b/openedx/core/djangoapps/user_api/verification_api/views.py index 1ef159150cda..deb97143b371 100644 --- a/openedx/core/djangoapps/user_api/verification_api/views.py +++ b/openedx/core/djangoapps/user_api/verification_api/views.py @@ -19,7 +19,7 @@ class IDVerificationStatusView(APIView): authentication_classes = (JwtAuthentication, BearerAuthentication, SessionAuthentication,) permission_classes = (IsStaffOrOwner,) - def get(self, request, **kwargs): # lint-amnesty, pylint: disable=missing-function-docstring + def get(self, request, **kwargs): # pylint: disable=missing-function-docstring username = kwargs.get('username') User = get_user_model() try: @@ -35,7 +35,7 @@ def get(self, request, **kwargs): # lint-amnesty, pylint: disable=missing-funct }) except User.DoesNotExist: - raise Http404 # lint-amnesty, pylint: disable=raise-missing-from + raise Http404 # pylint: disable=raise-missing-from # noqa: B904 class IDVerificationStatusDetailsView(ListAPIView): @@ -59,4 +59,4 @@ def get_queryset(self): return sorted(verifications, key=lambda x: x.updated_at, reverse=True) except User.DoesNotExist: - raise Http404 # lint-amnesty, pylint: disable=raise-missing-from + raise Http404 # pylint: disable=raise-missing-from # noqa: B904 diff --git a/openedx/core/djangoapps/user_api/views.py b/openedx/core/djangoapps/user_api/views.py index d52493556a19..2504c38db9bd 100644 --- a/openedx/core/djangoapps/user_api/views.py +++ b/openedx/core/djangoapps/user_api/views.py @@ -1,6 +1,6 @@ """HTTP end-points for the User API. """ -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.http import HttpResponse from django.utils.decorators import method_decorator from django.views.decorators.csrf import ensure_csrf_cookie diff --git a/openedx/core/djangoapps/user_authn/api/form_fields.py b/openedx/core/djangoapps/user_authn/api/form_fields.py index ca001ba3f1b5..f700a2298091 100644 --- a/openedx/core/djangoapps/user_authn/api/form_fields.py +++ b/openedx/core/djangoapps/user_authn/api/form_fields.py @@ -2,6 +2,7 @@ Field Descriptions """ import logging + from django import forms from django.conf import settings from django.utils.translation import gettext as _ diff --git a/openedx/core/djangoapps/user_authn/api/helper.py b/openedx/core/djangoapps/user_authn/api/helper.py index 21bd7c278d70..9e4c8104b0ff 100644 --- a/openedx/core/djangoapps/user_authn/api/helper.py +++ b/openedx/core/djangoapps/user_authn/api/helper.py @@ -6,10 +6,10 @@ from django.conf import settings from rest_framework.views import APIView +from common.djangoapps.student.models import UserProfile from openedx.core.djangoapps.site_configuration import helpers as configuration_helpers from openedx.core.djangoapps.user_authn.api import form_fields from openedx.core.djangoapps.user_authn.views.registration_form import get_registration_extension_form -from common.djangoapps.student.models import UserProfile class RegistrationFieldsContext(APIView): @@ -100,7 +100,8 @@ def get_fields(self): """ Returns the required or optional fields configured in REGISTRATION_EXTRA_FIELDS settings. """ - # Custom form fields can be added via the form set in settings.REGISTRATION_EXTENSION_FORM + # Custom form fields can be added via the form set in settings.PROFILE_EXTENSION_FORM + # (or deprecated settings.REGISTRATION_EXTENSION_FORM) custom_form = get_registration_extension_form() or {} response = {} for field in self.valid_fields: diff --git a/openedx/core/djangoapps/user_authn/api/tests/test_serializers.py b/openedx/core/djangoapps/user_authn/api/tests/test_serializers.py index 77d0dbb27153..3b22508958aa 100644 --- a/openedx/core/djangoapps/user_authn/api/tests/test_serializers.py +++ b/openedx/core/djangoapps/user_authn/api/tests/test_serializers.py @@ -27,7 +27,7 @@ def test_mfe_context_serializer(self): MFE_CONTEXT_WITH_TPA_DATA ).data - self.assertDictEqual( + self.assertDictEqual( # noqa: PT009 output_data, SERIALIZED_MFE_CONTEXT_WITH_TPA_DATA ) @@ -40,7 +40,7 @@ def test_mfe_context_serializer_default_response(self): MFE_CONTEXT_WITHOUT_TPA_DATA ).data - self.assertDictEqual( + self.assertDictEqual( # noqa: PT009 serialized_data, SERIALIZED_MFE_CONTEXT_WITHOUT_TPA_DATA ) diff --git a/openedx/core/djangoapps/user_authn/api/tests/test_views.py b/openedx/core/djangoapps/user_authn/api/tests/test_views.py index d6720c46fc58..42372bb375e4 100644 --- a/openedx/core/djangoapps/user_authn/api/tests/test_views.py +++ b/openedx/core/djangoapps/user_authn/api/tests/test_views.py @@ -1,15 +1,16 @@ """ Logistration API View Tests """ -import ddt import socket +from unittest.mock import patch +from urllib.parse import urlencode + +import ddt from django.conf import settings from django.test.utils import override_settings from django.urls import reverse from rest_framework import status from rest_framework.test import APITestCase -from unittest.mock import patch -from urllib.parse import urlencode from common.djangoapps.student.models import Registration from common.djangoapps.student.tests.factories import UserFactory @@ -257,7 +258,7 @@ def test_optional_field_has_no_description(self): 'goals': { 'name': 'goals', 'type': 'textarea', - 'label': "Tell us why you're interested in {platform_name}".format( + 'label': "Tell us why you're interested in {platform_name}".format( # noqa: UP032 platform_name=settings.PLATFORM_NAME ), 'error_message': '', @@ -359,13 +360,13 @@ def test_mfe_context_api_serialized_response(self): Test MFE Context API serialized response """ response = self.client.get(self.url, self.query_params) - self.assertEqual(response.status_code, status.HTTP_200_OK) + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 params = { 'next': self.query_params['next'] } - self.assertEqual( + self.assertEqual( # noqa: PT009 response.data, self.get_context(params) ) @@ -375,10 +376,10 @@ def test_mfe_context_api_response_keys(self): Test MFE Context API response keys """ response = self.client.get(self.url, self.query_params) - self.assertEqual(response.status_code, status.HTTP_200_OK) + self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 response_keys = set(response.data.keys()) - self.assertSetEqual( + self.assertSetEqual( # noqa: PT009 response_keys, { 'contextData', diff --git a/openedx/core/djangoapps/user_authn/api/urls.py b/openedx/core/djangoapps/user_authn/api/urls.py index 212249d1c8b3..32782b9704bc 100644 --- a/openedx/core/djangoapps/user_authn/api/urls.py +++ b/openedx/core/djangoapps/user_authn/api/urls.py @@ -2,10 +2,9 @@ Authn API urls """ from django.urls import path -from openedx.core.djangoapps.user_authn.api.views import ( - MFEContextView, - SendAccountActivationEmail, -) + +from openedx.core.djangoapps.user_authn.api.views import MFEContextView, SendAccountActivationEmail + urlpatterns = [ path('third_party_auth_context', MFEContextView.as_view(), name='third_party_auth_context'), path('mfe_context', MFEContextView.as_view(), name='mfe_context'), diff --git a/openedx/core/djangoapps/user_authn/api/views.py b/openedx/core/djangoapps/user_authn/api/views.py index f5811412232b..2cf4d608f1f2 100644 --- a/openedx/core/djangoapps/user_authn/api/views.py +++ b/openedx/core/djangoapps/user_authn/api/views.py @@ -3,13 +3,12 @@ """ from django.conf import settings - +from edx_rest_framework_extensions.auth.session.authentication import SessionAuthenticationAllowInactiveUser from rest_framework import status +from rest_framework.permissions import IsAuthenticated from rest_framework.response import Response from rest_framework.throttling import AnonRateThrottle from rest_framework.views import APIView -from rest_framework.permissions import IsAuthenticated -from edx_rest_framework_extensions.auth.session.authentication import SessionAuthenticationAllowInactiveUser from common.djangoapps.student.helpers import get_next_url_for_login_page from common.djangoapps.student.views import compose_and_send_activation_email @@ -48,7 +47,7 @@ def _get_optional_fields_context(self): return optional_fields_context - def get(self, request, **kwargs): # lint-amnesty, pylint: disable=unused-argument + def get(self, request, **kwargs): # pylint: disable=unused-argument """ Returns - dynamic registration fields @@ -122,7 +121,7 @@ class SendAccountActivationEmail(APIView): authentication_classes = (SessionAuthenticationAllowInactiveUser,) permission_classes = (IsAuthenticated,) - def post(self, request, **kwargs): # lint-amnesty, pylint: disable=unused-argument + def post(self, request, **kwargs): # pylint: disable=unused-argument """ Returns status code. Arguments: diff --git a/openedx/core/djangoapps/user_authn/cookies.py b/openedx/core/djangoapps/user_authn/cookies.py index 036baf2125b2..d41faf0cb5aa 100644 --- a/openedx/core/djangoapps/user_authn/cookies.py +++ b/openedx/core/djangoapps/user_authn/cookies.py @@ -9,23 +9,23 @@ from urllib.parse import urljoin from django.conf import settings -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.dispatch import Signal from django.urls import NoReverseMatch, reverse from django.utils.http import http_date, parse_http_date from edx_rest_framework_extensions.auth.jwt import cookies as jwt_cookies from edx_rest_framework_extensions.auth.jwt.constants import JWT_DELIMITER from oauth2_provider.models import Application -from common.djangoapps.student.models import UserProfile +from common.djangoapps.student.models import UserProfile +from common.djangoapps.util.json_request import JsonResponse from openedx.core.djangoapps.oauth_dispatch.adapters import DOTAdapter from openedx.core.djangoapps.oauth_dispatch.api import create_dot_access_token from openedx.core.djangoapps.oauth_dispatch.jwt import create_jwt_from_token +from openedx.core.djangoapps.site_configuration import helpers as configuration_helpers +from openedx.core.djangoapps.user_api.accounts.image_helpers import get_profile_image_urls_for_user from openedx.core.djangoapps.user_api.accounts.utils import retrieve_last_sitewide_block_completed from openedx.core.djangoapps.user_authn.exceptions import AuthFailedError -from common.djangoapps.util.json_request import JsonResponse -from openedx.core.djangoapps.user_api.accounts.image_helpers import get_profile_image_urls_for_user - log = logging.getLogger(__name__) @@ -245,7 +245,10 @@ def _get_user_info_cookie_data(request, user): # External sites will need to have fallback mechanisms to handle this case # (most likely just hiding the links). try: - header_urls['account_settings'] = settings.ACCOUNT_MICROFRONTEND_URL + header_urls['account_settings'] = configuration_helpers.get_value( + 'ACCOUNT_MICROFRONTEND_URL', + settings.ACCOUNT_MICROFRONTEND_URL, + ) header_urls['learner_profile'] = urljoin(settings.PROFILE_MICROFRONTEND_URL, f'/u/{user.username}') except NoReverseMatch: pass @@ -358,6 +361,6 @@ def _get_login_oauth_client(): try: return Application.objects.get(client_id=login_client_id) except Application.DoesNotExist: - raise AuthFailedError( # lint-amnesty, pylint: disable=raise-missing-from + raise AuthFailedError( # pylint: disable=raise-missing-from # noqa: B904 f"OAuth Client for the Login service, '{login_client_id}', is not configured." ) diff --git a/openedx/core/djangoapps/user_authn/exceptions.py b/openedx/core/djangoapps/user_authn/exceptions.py index 984aa7e4c10b..d3f5b50992d5 100644 --- a/openedx/core/djangoapps/user_authn/exceptions.py +++ b/openedx/core/djangoapps/user_authn/exceptions.py @@ -9,8 +9,8 @@ class AuthFailedError(Exception): This is a helper for the login view, allowing the various sub-methods to error out with an appropriate failure message. """ - def __init__( # lint-amnesty, pylint: disable=dangerous-default-value - self, value=None, redirect=None, redirect_url=None, error_code=None, context={}, + def __init__( # pylint: disable=dangerous-default-value + self, value=None, redirect=None, redirect_url=None, error_code=None, context={}, # noqa: B006 ): super().__init__() self.value = Text(value) diff --git a/openedx/core/djangoapps/user_authn/signals.py b/openedx/core/djangoapps/user_authn/signals.py index a5c3517fc01e..dcab05cc3e96 100644 --- a/openedx/core/djangoapps/user_authn/signals.py +++ b/openedx/core/djangoapps/user_authn/signals.py @@ -2,7 +2,7 @@ Signals for user_authn """ -from typing import Any, Dict, Optional, Tuple +from typing import Any, Dict, Optional, Tuple # noqa: UP035 from common.djangoapps.student.models import UserProfile from common.djangoapps.track import segment @@ -11,7 +11,7 @@ def user_fields_changed( user=None, table=None, - changed_fields: Optional[Dict[str, Tuple[Any, Any]]] = None, + changed_fields: Optional[Dict[str, Tuple[Any, Any]]] = None, # noqa: UP006, UP045 **_kwargs, ): """ diff --git a/openedx/core/djangoapps/user_authn/tasks.py b/openedx/core/djangoapps/user_authn/tasks.py index c1c781d2f26f..b54e761dd25f 100644 --- a/openedx/core/djangoapps/user_authn/tasks.py +++ b/openedx/core/djangoapps/user_authn/tasks.py @@ -7,7 +7,7 @@ from celery import shared_task from celery.exceptions import MaxRetriesExceededError from django.conf import settings -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.contrib.sites.models import Site from edx_ace import ace from edx_ace.errors import RecoverableChannelDeliveryError @@ -46,7 +46,7 @@ def check_pwned_password_and_send_track_event( 'Unable to get response from pwned password api for user_id: "%s"', user_id, ) - return {} # lint-amnesty, pylint: disable=raise-missing-from + return {} # pylint: disable=raise-missing-from @shared_task(bind=True, default_retry_delay=30, max_retries=2) @@ -75,7 +75,7 @@ def send_activation_email(self, msg_string, from_address=None, site_id=None): with emulate_http_request(site=site, user=user): ace.send(msg) except RecoverableChannelDeliveryError: - log.info('Retrying sending email to user {dest_addr}, attempt # {attempt} of {max_attempts}'.format( + log.info('Retrying sending email to user {dest_addr}, attempt # {attempt} of {max_attempts}'.format( # noqa: UP032 # pylint: disable=line-too-long dest_addr=dest_addr, attempt=retries, max_attempts=max_retries @@ -95,4 +95,4 @@ def send_activation_email(self, msg_string, from_address=None, site_id=None): from_address, dest_addr, ) - raise Exception # lint-amnesty, pylint: disable=raise-missing-from + raise Exception # pylint: disable=raise-missing-from # noqa: B904 diff --git a/openedx/core/djangoapps/user_authn/tests/test_cookies.py b/openedx/core/djangoapps/user_authn/tests/test_cookies.py index aa2e687102f2..56ebae7756aa 100644 --- a/openedx/core/djangoapps/user_authn/tests/test_cookies.py +++ b/openedx/core/djangoapps/user_authn/tests/test_cookies.py @@ -1,28 +1,30 @@ # pylint: disable=missing-docstring -from datetime import date, datetime import json -from pytz import UTC +from datetime import date, datetime from unittest.mock import MagicMock, patch from urllib.parse import urljoin + from django.conf import settings from django.http import HttpResponse -from django.test import RequestFactory, TestCase +from django.test import RequestFactory, TestCase, override_settings from django.urls import reverse from edx_rest_framework_extensions.auth.jwt.decoder import jwt_decode_handler from edx_rest_framework_extensions.auth.jwt.middleware import JwtAuthCookieMiddleware +from pytz import UTC +from common.djangoapps.student.tests.factories import AnonymousUserFactory, UserFactory, UserProfileFactory +from openedx.core.djangoapps.profile_images.images import create_profile_images +from openedx.core.djangoapps.profile_images.tests.helpers import make_image_file +from openedx.core.djangoapps.user_api.accounts.image_helpers import ( + get_profile_image_names, + get_profile_image_urls_for_user, +) from openedx.core.djangoapps.user_api.accounts.utils import retrieve_last_sitewide_block_completed from openedx.core.djangoapps.user_authn import cookies as cookies_api from openedx.core.djangoapps.user_authn.tests.utils import setup_login_oauth_client from openedx.core.djangolib.testing.utils import skip_unless_lms -from common.djangoapps.student.tests.factories import AnonymousUserFactory, UserFactory, UserProfileFactory -from openedx.core.djangoapps.profile_images.tests.helpers import make_image_file -from openedx.core.djangoapps.profile_images.images import create_profile_images -from openedx.core.djangoapps.user_api.accounts.image_helpers import get_profile_image_names -from openedx.core.djangoapps.user_api.accounts.image_helpers import get_profile_image_urls_for_user - TEST_PROFILE_IMAGE_UPLOAD_DT = datetime(2002, 1, 9, 15, 43, 1, tzinfo=UTC) @@ -33,7 +35,7 @@ def setUp(self): self.user = UserFactory.create() self.user.profile = UserProfileFactory.create(user=self.user) self.user.profile.profile_image_uploaded_at = TEST_PROFILE_IMAGE_UPLOAD_DT - self.user.profile.save() # lint-amnesty, pylint: disable=no-member + self.user.profile.save() # pylint: disable=no-member self.request = RequestFactory().get('/') self.request.user = self.user self.request.session = self._get_stub_session() @@ -87,7 +89,7 @@ def _assert_recreate_jwt_from_cookies(self, response, can_recreate): def _assert_cookies_present(self, response, expected_cookies): """ Verify all expected_cookies are present in the response. """ - self.assertSetEqual(set(response.cookies.keys()), set(expected_cookies)) + self.assertSetEqual(set(response.cookies.keys()), set(expected_cookies)) # noqa: PT009 def _assert_consistent_expires(self, response, num_of_unique_expires=1): """ Verify cookies in the response have the same expiration, as expected. """ @@ -110,7 +112,7 @@ def test_get_user_info_cookie_data(self): 'user_image_urls': get_profile_image_urls_for_user(self.user), } - self.assertDictEqual(actual, expected) + self.assertDictEqual(actual, expected) # noqa: PT009 def test_set_logged_in_cookies_anonymous_user(self): anonymous_user = AnonymousUserFactory() @@ -154,3 +156,41 @@ def test_refresh_jwt_cookies(self): self._assert_cookies_present(response, cookies_api.JWT_COOKIE_NAMES) self._assert_consistent_expires(response, num_of_unique_expires=1) self._assert_recreate_jwt_from_cookies(response, can_recreate=True) + + @skip_unless_lms + def test_user_info_cookie_account_settings_uses_site_config_value(self): + """ + When site config overrides ACCOUNT_MICROFRONTEND_URL, the user info cookie + should use that exact value for 'account_settings'. + """ + siteconf_url = "https://accounts.siteconf.example" + + with patch( + "openedx.core.djangoapps.user_authn.cookies.configuration_helpers.get_value", + side_effect=lambda key, default=None, *a, **k: + siteconf_url if key == "ACCOUNT_MICROFRONTEND_URL" else default, + ): + data = cookies_api._get_user_info_cookie_data(self.request, self.user) # pylint: disable=protected-access + + assert data["header_urls"]["account_settings"] == siteconf_url + + @skip_unless_lms + def test_user_info_cookie_account_settings_falls_back_to_settings(self): + """ + If site config does not override, the user info cookie should fall back to + settings.ACCOUNT_MICROFRONTEND_URL for 'account_settings'. + """ + fallback = "https://accounts.settings.example" + + with override_settings(ACCOUNT_MICROFRONTEND_URL=fallback): + with patch( + "openedx.core.djangoapps.user_authn.cookies.configuration_helpers.get_value", + # Simulate "no override": return the provided default + side_effect=lambda key, default=None, *a, **k: default, + ): + data = cookies_api._get_user_info_cookie_data( # pylint: disable=protected-access + self.request, + self.user, + ) + + assert data["header_urls"]["account_settings"] == fallback diff --git a/openedx/core/djangoapps/user_authn/tests/test_signals.py b/openedx/core/djangoapps/user_authn/tests/test_signals.py index e87ffc55847e..8e03a57f477c 100644 --- a/openedx/core/djangoapps/user_authn/tests/test_signals.py +++ b/openedx/core/djangoapps/user_authn/tests/test_signals.py @@ -1,6 +1,7 @@ """Tests for user_authn signals""" from unittest.mock import patch + from django.test import TestCase from common.djangoapps.student.tests.factories import UserFactory, UserProfileFactory diff --git a/openedx/core/djangoapps/user_authn/tests/test_tasks.py b/openedx/core/djangoapps/user_authn/tests/test_tasks.py index 5103343a0879..b4fa8456ef8f 100644 --- a/openedx/core/djangoapps/user_authn/tests/test_tasks.py +++ b/openedx/core/djangoapps/user_authn/tests/test_tasks.py @@ -3,10 +3,11 @@ """ +from unittest import mock # pylint: disable=wrong-import-order + from django.conf import settings from django.test import TestCase from edx_ace.errors import ChannelError, RecoverableChannelDeliveryError -from unittest import mock # lint-amnesty, pylint: disable=wrong-import-order from common.djangoapps.student.models import Registration from common.djangoapps.student.views.management import compose_activation_email, compose_and_send_activation_email @@ -49,7 +50,7 @@ def test_ComposeEmail(self): @mock.patch('time.sleep', mock.Mock(return_value=None)) @mock.patch('openedx.core.djangoapps.user_authn.tasks.log') - @mock.patch('openedx.core.djangoapps.user_authn.tasks.ace.send', mock.Mock(side_effect=RecoverableChannelDeliveryError(None, None))) # lint-amnesty, pylint: disable=line-too-long + @mock.patch('openedx.core.djangoapps.user_authn.tasks.ace.send', mock.Mock(side_effect=RecoverableChannelDeliveryError(None, None))) # pylint: disable=line-too-long def test_RetrySendUntilFail(self, mock_log): """ Tests retries when the activation email doesn't send @@ -62,7 +63,7 @@ def test_RetrySendUntilFail(self, mock_log): # Asserts sending email retry logging. for attempt in range(email_max_attempts): mock_log.info.assert_any_call( - 'Retrying sending email to user {dest_addr}, attempt # {attempt} of {max_attempts}'.format( + 'Retrying sending email to user {dest_addr}, attempt # {attempt} of {max_attempts}'.format( # noqa: UP032 # pylint: disable=line-too-long dest_addr=self.student.email, attempt=attempt, max_attempts=email_max_attempts diff --git a/openedx/core/djangoapps/user_authn/tests/test_utils.py b/openedx/core/djangoapps/user_authn/tests/test_utils.py index 34578a661df9..377c75b1b905 100644 --- a/openedx/core/djangoapps/user_authn/tests/test_utils.py +++ b/openedx/core/djangoapps/user_authn/tests/test_utils.py @@ -3,6 +3,7 @@ from collections import namedtuple from urllib.parse import urlencode # pylint: disable=import-error + import ddt from django.test import TestCase from django.test.client import RequestFactory @@ -10,8 +11,8 @@ from openedx.core.djangoapps.oauth_dispatch.tests.factories import ApplicationFactory from openedx.core.djangoapps.user_authn.utils import ( - is_safe_login_or_logout_redirect, generate_username_suggestions, + is_safe_login_or_logout_redirect, remove_special_characters_from_name, ) diff --git a/openedx/core/djangoapps/user_authn/tests/utils.py b/openedx/core/djangoapps/user_authn/tests/utils.py index 31b4be7c400a..c387e9cde2c4 100644 --- a/openedx/core/djangoapps/user_authn/tests/utils.py +++ b/openedx/core/djangoapps/user_authn/tests/utils.py @@ -4,16 +4,16 @@ from datetime import datetime, timedelta from enum import Enum from unittest.mock import patch +from zoneinfo import ZoneInfo import ddt -from zoneinfo import ZoneInfo from django.conf import settings from oauth2_provider import models as dot_models from rest_framework import status +from common.djangoapps.student.tests.factories import UserFactory from openedx.core.djangoapps.oauth_dispatch.adapters.dot import DOTAdapter from openedx.core.djangoapps.oauth_dispatch.jwt import _create_jwt -from common.djangoapps.student.tests.factories import UserFactory class AuthType(Enum): diff --git a/openedx/core/djangoapps/user_authn/utils.py b/openedx/core/djangoapps/user_authn/utils.py index e5a75637ec2d..2fe8d838d1d5 100644 --- a/openedx/core/djangoapps/user_authn/utils.py +++ b/openedx/core/djangoapps/user_authn/utils.py @@ -7,7 +7,7 @@ import random import re from urllib.parse import urlparse # pylint: disable=import-error -from uuid import uuid4 # lint-amnesty, pylint: disable=unused-import +from uuid import uuid4 # pylint: disable=unused-import # noqa: F401 from django.conf import settings from django.utils import http diff --git a/openedx/core/djangoapps/user_authn/views/auth.py b/openedx/core/djangoapps/user_authn/views/auth.py index 673b2230ddeb..09768950d040 100644 --- a/openedx/core/djangoapps/user_authn/views/auth.py +++ b/openedx/core/djangoapps/user_authn/views/auth.py @@ -1,9 +1,11 @@ """ Views related to auth. """ import json -from common.djangoapps.util.json_request import JsonResponse + from django.conf import settings +from common.djangoapps.util.json_request import JsonResponse + def get_public_signing_jwks(request): """ diff --git a/openedx/core/djangoapps/user_authn/views/auto_auth.py b/openedx/core/djangoapps/user_authn/views/auto_auth.py index 324a0c1959d4..b8c7de9df2d8 100644 --- a/openedx/core/djangoapps/user_authn/views/auto_auth.py +++ b/openedx/core/djangoapps/user_authn/views/auto_auth.py @@ -6,7 +6,7 @@ from django.conf import settings from django.contrib.auth import login as django_login -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.core.exceptions import PermissionDenied from django.core.validators import ValidationError from django.http import HttpResponseForbidden @@ -14,17 +14,14 @@ from django.template.context_processors import csrf from django.urls import NoReverseMatch, reverse from django.utils.translation import gettext as _ +from edx_django_utils.user import generate_password # pylint: disable=wrong-import-order from opaque_keys.edx.locator import CourseLocator -from lms.djangoapps.verify_student.models import ManualVerification -from openedx.core.djangoapps.django_comment_common.models import assign_role -from openedx.core.djangoapps.user_authn.views.registration_form import AccountCreationForm -from openedx.features.course_experience import course_home_url from common.djangoapps.student.helpers import ( AccountValidationError, authenticate_new_user, create_or_set_user_attribute_created_on_site, - do_create_account + do_create_account, ) from common.djangoapps.student.models import ( CourseAccessRole, @@ -32,11 +29,13 @@ Registration, UserProfile, anonymous_id_for_user, - create_comments_service_user + create_comments_service_user, ) from common.djangoapps.util.json_request import JsonResponse - -from edx_django_utils.user import generate_password # lint-amnesty, pylint: disable=wrong-import-order +from lms.djangoapps.verify_student.models import ManualVerification +from openedx.core.djangoapps.django_comment_common.models import assign_role +from openedx.core.djangoapps.user_authn.views.registration_form import AccountCreationForm +from openedx.features.course_experience import course_home_url def auto_auth(request): # pylint: disable=too-many-statements diff --git a/openedx/core/djangoapps/user_authn/views/login.py b/openedx/core/djangoapps/user_authn/views/login.py index 0dd9a4819d5e..6a012d8d212d 100644 --- a/openedx/core/djangoapps/user_authn/views/login.py +++ b/openedx/core/djangoapps/user_authn/views/login.py @@ -59,7 +59,6 @@ from openedx.core.djangoapps.user_authn.views.utils import API_V1, ENTERPRISE_ENROLLMENT_URL_REGEX, UUID4_REGEX from openedx.core.djangoapps.util.user_messages import PageLevelMessages from openedx.core.djangolib.markup import HTML, Text -from openedx.core.lib.api.view_utils import require_post_params # lint-amnesty, pylint: disable=unused-import from openedx.features.enterprise_support.api import activate_learner_enterprise, get_enterprise_learner_data_from_api log = logging.getLogger("edx.student") @@ -83,7 +82,7 @@ def _do_third_party_auth(request): return pipeline.get_authenticated_user(requested_provider, username, third_party_uid) except USER_MODEL.DoesNotExist: AUDIT_LOG.info( - "Login failed - user with username {username} has no social auth " + "Login failed - user with username {username} has no social auth " # noqa: UP032 "with backend_name {backend_name}".format(username=username, backend_name=backend_name) ) message = Text( @@ -102,7 +101,7 @@ def _do_third_party_auth(request): register_label_strong=HTML("{register_text}").format(register_text=_("Register")), ) - raise AuthFailedError(message, error_code="third-party-auth-with-no-linked-account") # lint-amnesty, pylint: disable=raise-missing-from + raise AuthFailedError(message, error_code="third-party-auth-with-no-linked-account") # pylint: disable=raise-missing-from # noqa: B904 def _get_user_by_email(email): @@ -188,7 +187,7 @@ def _generate_locked_out_error_message(): ) -def _enforce_password_policy_compliance(request, user): # lint-amnesty, pylint: disable=missing-function-docstring +def _enforce_password_policy_compliance(request, user): # pylint: disable=missing-function-docstring try: password_policy_compliance.enforce_compliance_on_login(user, request.POST.get("password")) except password_policy_compliance.NonCompliantPasswordWarning as e: @@ -211,7 +210,7 @@ def _enforce_password_policy_compliance(request, user): # lint-amnesty, pylint: send_password_reset_email_for_user(user, request) # Prevent the login attempt. - raise AuthFailedError(HTML(str(e)), error_code=e.__class__.__name__) # lint-amnesty, pylint: disable=raise-missing-from + raise AuthFailedError(HTML(str(e)), error_code=e.__class__.__name__) # pylint: disable=raise-missing-from # noqa: B904 def _log_and_raise_inactive_user_auth_error(unauthenticated_user): @@ -241,7 +240,7 @@ def _authenticate_first_party(request, unauthenticated_user, third_party_auth_re if should_be_rate_limited: raise AuthFailedError( _("Too many failed login attempts. Try again later.") - ) # lint-amnesty, pylint: disable=raise-missing-from + ) # pylint: disable=raise-missing-from # If the user doesn't exist, we want to set the username to an invalid username so that authentication is guaranteed # to fail and we can take advantage of the ratelimited backend @@ -514,13 +513,13 @@ def enterprise_selection_page(request, user, next_url): rate=settings.LOGISTRATION_PER_EMAIL_RATELIMIT_RATE, method="POST", block=False, -) # lint-amnesty, pylint: disable=too-many-statements +) # pylint: disable=too-many-statements @ratelimit( key="openedx.core.djangoapps.util.ratelimit.real_ip", rate=settings.LOGISTRATION_RATELIMIT_RATE, method="POST", block=False, -) # lint-amnesty, pylint: disable=too-many-statements +) # pylint: disable=too-many-statements def login_user(request, api_version="v1"): # pylint: disable=too-many-statements """ AJAX request to log in the user. @@ -702,7 +701,7 @@ def login_user(request, api_version="v1"): # pylint: disable=too-many-statement # complexity. @csrf_exempt @require_http_methods(["POST"]) -def login_refresh(request): # lint-amnesty, pylint: disable=missing-function-docstring +def login_refresh(request): # pylint: disable=missing-function-docstring if not request.user.is_authenticated or request.user.is_anonymous: return JsonResponse("Unauthorized", status=401) @@ -754,7 +753,7 @@ class LoginSessionView(APIView): @method_decorator(ensure_csrf_cookie) def get(self, request, *args, **kwargs): - return HttpResponse(get_login_session_form(request).to_json(), content_type="application/json") # lint-amnesty, pylint: disable=http-response-with-content-type-json + return HttpResponse(get_login_session_form(request).to_json(), content_type="application/json") # pylint: disable=http-response-with-content-type-json @swagger_auto_schema( request_body=login_user_schema, @@ -801,4 +800,4 @@ def _parse_analytics_param_for_course_id(request): modified_request["course_id"] = analytics.get("enroll_course_id") except (ValueError, TypeError): set_custom_attribute("shim_analytics_course_id", "parse-error") - log.error("Could not parse analytics object sent to user API: {analytics}".format(analytics=analytics)) + log.error("Could not parse analytics object sent to user API: {analytics}".format(analytics=analytics)) # noqa: UP032 # pylint: disable=line-too-long diff --git a/openedx/core/djangoapps/user_authn/views/login_form.py b/openedx/core/djangoapps/user_authn/views/login_form.py index bb78a9df1a3c..47f21f0adbe1 100644 --- a/openedx/core/djangoapps/user_authn/views/login_form.py +++ b/openedx/core/djangoapps/user_authn/views/login_form.py @@ -16,28 +16,28 @@ from common.djangoapps import third_party_auth from common.djangoapps.edxmako.shortcuts import render_to_response +from common.djangoapps.student.helpers import get_next_url_for_login_page +from common.djangoapps.third_party_auth import pipeline +from common.djangoapps.third_party_auth.decorators import xframe_allow_whitelisted +from common.djangoapps.util.password_policy_validators import DEFAULT_MAX_PASSWORD_LENGTH from openedx.core.djangoapps.site_configuration import helpers as configuration_helpers from openedx.core.djangoapps.user_api import accounts -from openedx.core.djangoapps.user_api.accounts.utils import ( - is_secondary_email_feature_enabled -) +from openedx.core.djangoapps.user_api.accounts.utils import is_secondary_email_feature_enabled from openedx.core.djangoapps.user_api.helpers import FormDescription from openedx.core.djangoapps.user_authn.cookies import set_logged_in_cookies -from openedx.core.djangoapps.user_authn.toggles import should_redirect_to_authn_microfrontend +from openedx.core.djangoapps.user_authn.toggles import ( + is_require_third_party_auth_enabled, + should_redirect_to_authn_microfrontend, +) from openedx.core.djangoapps.user_authn.views.password_reset import get_password_reset_form from openedx.core.djangoapps.user_authn.views.registration_form import RegistrationFormFactory from openedx.core.djangoapps.user_authn.views.utils import third_party_auth_context -from openedx.core.djangoapps.user_authn.toggles import is_require_third_party_auth_enabled from openedx.features.enterprise_support.api import enterprise_customer_for_request, enterprise_enabled from openedx.features.enterprise_support.utils import ( get_enterprise_slug_login_url, handle_enterprise_cookies_for_logistration, - update_logistration_context_for_enterprise + update_logistration_context_for_enterprise, ) -from common.djangoapps.student.helpers import get_next_url_for_login_page -from common.djangoapps.third_party_auth import pipeline -from common.djangoapps.third_party_auth.decorators import xframe_allow_whitelisted -from common.djangoapps.util.password_policy_validators import DEFAULT_MAX_PASSWORD_LENGTH log = logging.getLogger(__name__) @@ -164,7 +164,7 @@ def login_and_registration_form(request, initial_mode="login"): # If present, we display a login page focused on third-party auth with that provider. third_party_auth_hint = None tpa_hint_provider = None - if '?' in redirect_to: # lint-amnesty, pylint: disable=too-many-nested-blocks + if '?' in redirect_to: # pylint: disable=too-many-nested-blocks try: next_args = urllib.parse.parse_qs(urllib.parse.urlparse(redirect_to).query) if 'tpa_hint' in next_args: diff --git a/openedx/core/djangoapps/user_authn/views/logout.py b/openedx/core/djangoapps/user_authn/views/logout.py index 083e8d4ccb0d..20cc70287142 100644 --- a/openedx/core/djangoapps/user_authn/views/logout.py +++ b/openedx/core/djangoapps/user_authn/views/logout.py @@ -12,10 +12,10 @@ from django.views.generic import TemplateView from oauth2_provider.models import Application +from common.djangoapps.third_party_auth import pipeline as tpa_pipeline from openedx.core.djangoapps.safe_sessions.middleware import mark_user_change_as_expected from openedx.core.djangoapps.user_authn.cookies import delete_logged_in_cookies from openedx.core.djangoapps.user_authn.utils import is_safe_login_or_logout_redirect -from common.djangoapps.third_party_auth import pipeline as tpa_pipeline class LogoutView(TemplateView): diff --git a/openedx/core/djangoapps/user_authn/views/password_reset.py b/openedx/core/djangoapps/user_authn/views/password_reset.py index 321101fb9a18..b38ce4d3643a 100644 --- a/openedx/core/djangoapps/user_authn/views/password_reset.py +++ b/openedx/core/djangoapps/user_authn/views/password_reset.py @@ -7,7 +7,7 @@ from django.contrib.auth import update_session_auth_hash from django.contrib.auth.forms import PasswordResetForm, SetPasswordForm from django.contrib.auth.hashers import UNUSABLE_PASSWORD_PREFIX -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.contrib.auth.tokens import default_token_generator from django.contrib.auth.views import INTERNAL_RESET_SESSION_TOKEN, PasswordResetConfirmView from django.core.exceptions import ObjectDoesNotExist @@ -21,33 +21,33 @@ from django.utils.translation import gettext_lazy as _ from django.views.decorators.csrf import csrf_exempt, ensure_csrf_cookie from django.views.decorators.http import require_POST +from django_ratelimit.decorators import ratelimit from edx_ace import ace from edx_ace.recipient import Recipient from eventtracking import tracker -from django_ratelimit.decorators import ratelimit from rest_framework.response import Response from rest_framework.throttling import AnonRateThrottle from rest_framework.views import APIView from common.djangoapps.edxmako.shortcuts import render_to_string +from common.djangoapps.student.forms import send_account_recovery_email_for_user +from common.djangoapps.student.models import AccountRecovery, LoginFailures +from common.djangoapps.util.json_request import JsonResponse +from common.djangoapps.util.password_policy_validators import normalize_password, validate_password from openedx.core.djangoapps.ace_common.template_context import get_base_template_context from openedx.core.djangoapps.lang_pref import LANGUAGE_KEY from openedx.core.djangoapps.oauth_dispatch.api import destroy_oauth_tokens from openedx.core.djangoapps.site_configuration import helpers as configuration_helpers from openedx.core.djangoapps.theming.helpers import get_current_request, get_current_site from openedx.core.djangoapps.user_api import accounts, errors, helpers -from openedx.core.djangoapps.user_authn.toggles import should_redirect_to_authn_microfrontend from openedx.core.djangoapps.user_api.accounts.utils import is_secondary_email_feature_enabled from openedx.core.djangoapps.user_api.helpers import FormDescription from openedx.core.djangoapps.user_api.models import UserRetirementRequest from openedx.core.djangoapps.user_api.preferences.api import get_user_preference from openedx.core.djangoapps.user_authn.message_types import PasswordReset, PasswordResetSuccess +from openedx.core.djangoapps.user_authn.toggles import should_redirect_to_authn_microfrontend from openedx.core.djangoapps.user_authn.utils import check_pwned_password from openedx.core.djangolib.markup import HTML -from common.djangoapps.student.forms import send_account_recovery_email_for_user -from common.djangoapps.student.models import AccountRecovery, LoginFailures -from common.djangoapps.util.json_request import JsonResponse -from common.djangoapps.util.password_policy_validators import normalize_password, validate_password POST_EMAIL_KEY = 'openedx.core.djangoapps.util.ratelimit.request_post_email' REAL_IP_KEY = 'openedx.core.djangoapps.util.ratelimit.real_ip' @@ -238,7 +238,7 @@ class PasswordResetView(APIView): @method_decorator(ensure_csrf_cookie) def get(self, request): - return HttpResponse(get_password_reset_form().to_json(), content_type="application/json") # lint-amnesty, pylint: disable=http-response-with-content-type-json + return HttpResponse(get_password_reset_form().to_json(), content_type="application/json") # pylint: disable=http-response-with-content-type-json @helpers.intercept_errors(errors.UserAPIInternalError, ignore_errors=[errors.UserAPIRequestError]) @@ -369,7 +369,7 @@ def __init__(self): self.uidb64 = '' self.uid_int = -1 - def _process_password_reset_success(self, request, token, uidb64, extra_context): # lint-amnesty, pylint: disable=missing-function-docstring + def _process_password_reset_success(self, request, token, uidb64, extra_context): # pylint: disable=missing-function-docstring self.user = self.get_user(uidb64) form = SetPasswordForm(self.user, request.POST) if self.token_generator.check_token(self.user, token) and form.is_valid(): @@ -392,7 +392,7 @@ def _get_token_from_session(self, request): def _get_platform_name(): return {"platform_name": configuration_helpers.get_value('platform_name', settings.PLATFORM_NAME)} - def _set_user(self, request): # lint-amnesty, pylint: disable=missing-function-docstring + def _set_user(self, request): # pylint: disable=missing-function-docstring try: self.uid_int = base36_to_int(self.uidb36) if request.user.is_authenticated and request.user.id != self.uid_int: @@ -419,7 +419,7 @@ def _handle_retired_user(self, request): request, 'registration/password_reset_confirm.html', context ) - def _validate_password(self, password, request): # lint-amnesty, pylint: disable=missing-function-docstring + def _validate_password(self, password, request): # pylint: disable=missing-function-docstring try: validate_password(password, user=self.user) except ValidationError as err: @@ -434,7 +434,7 @@ def _validate_password(self, password, request): # lint-amnesty, pylint: disabl request, 'registration/password_reset_confirm.html', context ) - def _handle_password_reset_failure(self, response): # lint-amnesty, pylint: disable=missing-function-docstring + def _handle_password_reset_failure(self, response): # pylint: disable=missing-function-docstring form_valid = response.context_data['form'].is_valid() if response.context_data['form'] else False if not form_valid: log.warning( @@ -445,7 +445,7 @@ def _handle_password_reset_failure(self, response): # lint-amnesty, pylint: dis response.context_data['err_msg'] = _('Error in resetting your password. Please try again.') return response - def _handle_primary_email_update(self, updated_user): # lint-amnesty, pylint: disable=missing-function-docstring + def _handle_primary_email_update(self, updated_user): # pylint: disable=missing-function-docstring try: updated_user.email = updated_user.account_recovery.secondary_email updated_user.account_recovery.delete() @@ -460,7 +460,7 @@ def _handle_primary_email_update(self, updated_user): # lint-amnesty, pylint: d } ) except ObjectDoesNotExist: - log.error('Account recovery process initiated without AccountRecovery instance for user {username}' + log.error('Account recovery process initiated without AccountRecovery instance for user {username}' # noqa: UP032 # pylint: disable=line-too-long .format(username=updated_user.username)) def _handle_password_creation(self, request, updated_user): @@ -659,7 +659,7 @@ def password_change_request_handler(request): ) ace.send(msg) except errors.UserAPIInternalError as err: - log.exception('Error occurred during password change for user {email}: {error}' + log.exception('Error occurred during password change for user {email}: {error}' # noqa: UP032 .format(email=email, error=err)) return HttpResponse(_("Some error occurred during password change. Please try again"), status=500) @@ -692,7 +692,7 @@ def parse_rate(self, rate): return _get_rate(rate) -class PasswordResetTokenValidation(APIView): # lint-amnesty, pylint: disable=missing-class-docstring +class PasswordResetTokenValidation(APIView): # pylint: disable=missing-class-docstring """ API to validate generated password reset token """ @@ -732,7 +732,7 @@ def parse_rate(self, rate): return _get_rate(rate) -class LogistrationPasswordResetView(APIView): # lint-amnesty, pylint: disable=missing-class-docstring +class LogistrationPasswordResetView(APIView): # pylint: disable=missing-class-docstring """ API to update new password credentials for a correct token """ @@ -754,7 +754,7 @@ def post(self, request, **kwargs): AUDIT_LOG.exception("Invalid password reset confirm token") return Response({'reset_status': reset_status, 'token_invalid': True}) - request.data._mutable = True # lint-amnesty, pylint: disable=protected-access + request.data._mutable = True # pylint: disable=protected-access request.data['new_password1'] = normalize_password(request.data['new_password1']) request.data['new_password2'] = normalize_password(request.data['new_password2']) diff --git a/openedx/core/djangoapps/user_authn/views/register.py b/openedx/core/djangoapps/user_authn/views/register.py index 2fc0818a3ab9..0ab4c9f81dfa 100644 --- a/openedx/core/djangoapps/user_authn/views/register.py +++ b/openedx/core/djangoapps/user_authn/views/register.py @@ -6,10 +6,11 @@ import datetime import json import logging +from zoneinfo import ZoneInfo from django.conf import settings from django.contrib.auth import login as django_login -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.core.exceptions import NON_FIELD_ERRORS, PermissionDenied from django.core.validators import ValidationError from django.db import transaction @@ -22,12 +23,12 @@ from django.views.decorators.csrf import csrf_exempt, ensure_csrf_cookie from django.views.decorators.debug import sensitive_post_parameters from django_countries import countries +from django_ratelimit.decorators import ratelimit from edx_django_utils.monitoring import set_custom_attribute +from edx_django_utils.user import generate_password # pylint: disable=wrong-import-order from openedx_events.learning.data import UserData, UserPersonalData from openedx_events.learning.signals import STUDENT_REGISTRATION_COMPLETED from openedx_filters.learning.filters import StudentRegistrationRequested -from zoneinfo import ZoneInfo -from django_ratelimit.decorators import ratelimit from requests import HTTPError from rest_framework.response import Response from rest_framework.views import APIView @@ -35,9 +36,30 @@ from social_django import utils as social_utils from common.djangoapps import third_party_auth + # Note that this lives in LMS, so this dependency should be refactored. # TODO Have the discussions code subscribe to the REGISTER_USER signal instead. -from common.djangoapps.student.helpers import get_next_url_for_login_page, get_redirect_url_with_host +from common.djangoapps.student.helpers import ( + AccountValidationError, + authenticate_new_user, + create_or_set_user_attribute_created_on_site, + do_create_account, + get_next_url_for_login_page, + get_redirect_url_with_host, +) +from common.djangoapps.student.models import ( + RegistrationCookieConfiguration, + UserAttribute, + create_comments_service_user, + email_exists_or_retired, + username_exists_or_retired, +) +from common.djangoapps.student.views import compose_and_send_activation_email +from common.djangoapps.third_party_auth import pipeline, provider +from common.djangoapps.third_party_auth.saml import SAP_SUCCESSFACTORS_SAML_KEY +from common.djangoapps.track import segment +from common.djangoapps.util.db import outer_atomic +from common.djangoapps.util.json_request import JsonResponse from lms.djangoapps.discussion.notification_prefs.views import enable_notifications from openedx.core.djangoapps.lang_pref import LANGUAGE_KEY from openedx.core.djangoapps.safe_sessions.middleware import mark_user_change_as_expected @@ -51,45 +73,22 @@ get_name_validation_error, get_password_validation_error, get_username_existence_validation_error, - get_username_validation_error + get_username_validation_error, ) from openedx.core.djangoapps.user_api.preferences import api as preferences_api from openedx.core.djangoapps.user_authn.cookies import set_logged_in_cookies -from openedx.core.djangoapps.user_authn.utils import ( - generate_username_suggestions, is_registration_api_v1 +from openedx.core.djangoapps.user_authn.tasks import check_pwned_password_and_send_track_event +from openedx.core.djangoapps.user_authn.toggles import ( + is_auto_generated_username_enabled, + is_require_third_party_auth_enabled, ) +from openedx.core.djangoapps.user_authn.utils import generate_username_suggestions, is_registration_api_v1 from openedx.core.djangoapps.user_authn.views.registration_form import ( AccountCreationForm, RegistrationFormFactory, - get_registration_extension_form + get_registration_extension_form, ) from openedx.core.djangoapps.user_authn.views.utils import get_auto_generated_username -from openedx.core.djangoapps.user_authn.tasks import check_pwned_password_and_send_track_event -from openedx.core.djangoapps.user_authn.toggles import ( - is_require_third_party_auth_enabled, - is_auto_generated_username_enabled -) -from common.djangoapps.student.helpers import ( - AccountValidationError, - authenticate_new_user, - create_or_set_user_attribute_created_on_site, - do_create_account -) -from common.djangoapps.student.models import ( - RegistrationCookieConfiguration, - UserAttribute, - create_comments_service_user, - email_exists_or_retired, - username_exists_or_retired -) -from common.djangoapps.student.views import compose_and_send_activation_email -from common.djangoapps.third_party_auth import pipeline, provider -from common.djangoapps.third_party_auth.saml import SAP_SUCCESSFACTORS_SAML_KEY -from common.djangoapps.track import segment -from common.djangoapps.util.db import outer_atomic -from common.djangoapps.util.json_request import JsonResponse - -from edx_django_utils.user import generate_password # lint-amnesty, pylint: disable=wrong-import-order log = logging.getLogger("edx.student") AUDIT_LOG = logging.getLogger("audit") @@ -375,7 +374,7 @@ def _track_user_registration(user, profile, params, third_party_provider, regist 'education': profile.level_of_education_display, 'address': profile.mailing_address, 'gender': profile.gender_display, - 'country': str(profile.country), + 'country': str(profile.country) if profile.country else '', 'is_marketable': is_marketable, 'anonymous_id': anonymous_id } @@ -555,7 +554,7 @@ def dispatch(self, request, *args, **kwargs): @method_decorator(ensure_csrf_cookie) def get(self, request): - return HttpResponse(RegistrationFormFactory().get_registration_form(request).to_json(), # lint-amnesty, pylint: disable=http-response-with-content-type-json + return HttpResponse(RegistrationFormFactory().get_registration_form(request).to_json(), # pylint: disable=http-response-with-content-type-json content_type="application/json") @method_decorator(csrf_exempt) @@ -700,7 +699,7 @@ def _create_account(self, request, data): response = self._create_response(request, errors, status_code=409, error_code=err.error_code) except ValidationError as err: # Should only get field errors from this exception - assert NON_FIELD_ERRORS not in err.message_dict + assert NON_FIELD_ERRORS not in err.message_dict # noqa: PT017 # Error messages are returned as arrays from ValidationError error_code = err.message_dict.get('error_code', ['validation-error'])[0] diff --git a/openedx/core/djangoapps/user_authn/views/registration_form.py b/openedx/core/djangoapps/user_authn/views/registration_form.py index efee92e700b7..77984aa2bce7 100644 --- a/openedx/core/djangoapps/user_authn/views/registration_form.py +++ b/openedx/core/djangoapps/user_authn/views/registration_form.py @@ -3,14 +3,16 @@ """ import copy +import logging import re from importlib import import_module from django import forms from django.conf import settings -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.core.exceptions import ImproperlyConfigured from django.core.validators import RegexValidator, ValidationError, slug_re +from django.db.models import Model from django.forms import widgets from django.urls import reverse from django.utils.translation import gettext as _ @@ -20,10 +22,11 @@ from common.djangoapps import third_party_auth from common.djangoapps.edxmako.shortcuts import marketing_link from common.djangoapps.student.models import CourseEnrollmentAllowed, UserProfile, email_exists_or_retired +from common.djangoapps.third_party_auth.models import SAMLProviderConfig from common.djangoapps.util.password_policy_validators import ( password_validators_instruction_texts, password_validators_restrictions, - validate_password + validate_password, ) from openedx.core.djangoapps.embargo.models import GlobalRestrictedCountry from openedx.core.djangoapps.site_configuration import helpers as configuration_helpers @@ -35,6 +38,8 @@ from openedx.core.djangolib.markup import HTML, Text from openedx.features.enterprise_support.api import enterprise_customer_for_request +log = logging.getLogger(__name__) + class TrueCheckbox(widgets.CheckboxInput): """ @@ -116,7 +121,7 @@ class UsernameField(forms.CharField): default_validators = [validate_username] - def __init__(self, *args, **kwargs): # lint-amnesty, pylint: disable=unused-argument + def __init__(self, *args, **kwargs): # pylint: disable=unused-argument super().__init__( min_length=accounts.USERNAME_MIN_LENGTH, max_length=accounts.USERNAME_MAX_LENGTH, @@ -312,17 +317,96 @@ def clean_country(self): return self.cleaned_data.get("country") -def get_registration_extension_form(*args, **kwargs): +def get_registration_extension_form(*args, **kwargs) -> forms.Form | None: """ - Convenience function for getting the custom form set in settings.REGISTRATION_EXTENSION_FORM. + Convenience function for getting the custom form set in settings.PROFILE_EXTENSION_FORM + or settings.REGISTRATION_EXTENSION_FORM (deprecated). + + Returns an instance of the configured profile extension form. + + The function first checks for PROFILE_EXTENSION_FORM (recommended), then falls back to + REGISTRATION_EXTENSION_FORM for backwards compatibility. When REGISTRATION_EXTENSION_FORM + is used, a deprecation warning is logged. An example form app for this can be found at http://github.com/open-craft/custom-form-app + + Returns: + Form instance or None if no form is configured + """ + # Check for the new setting first + setting_value = getattr(settings, "PROFILE_EXTENSION_FORM", None) + setting_name = "PROFILE_EXTENSION_FORM" + + # Fall back to the deprecated setting + if not setting_value: + setting_value = getattr(settings, "REGISTRATION_EXTENSION_FORM", None) + if setting_value: + setting_name = "REGISTRATION_EXTENSION_FORM" + log.warning( + "REGISTRATION_EXTENSION_FORM is deprecated and will be removed in a future release. " + "Please use PROFILE_EXTENSION_FORM instead. Current value: %s", + setting_value, + ) + + if not setting_value: + return None + + try: + module, klass = setting_value.rsplit(".", 1) + module = import_module(module) + return getattr(module, klass)(*args, **kwargs) + except (ValueError, ImportError, AttributeError) as e: + log.error("Could not load form from %s='%s': %s", setting_name, setting_value, str(e)) + return None + + +def get_extended_profile_model() -> type[Model] | None: + """ + Get the model class for the extended profile form. + + Returns the Django model class associated with the form specified in + the `PROFILE_EXTENSION_FORM` setting. + + IMPORTANT: This function only works with PROFILE_EXTENSION_FORM. If you're using + the deprecated REGISTRATION_EXTENSION_FORM, this will return None to maintain + backward compatibility. The new profile extension capabilities (loading/saving + to a custom model) are only available when using PROFILE_EXTENSION_FORM. + + Migration path: + - Old behavior (REGISTRATION_EXTENSION_FORM): Custom fields only for registration, + data stored in UserProfile.meta field + - New behavior (PROFILE_EXTENSION_FORM): Custom fields for registration and profile, + data stored in dedicated model with ability to load/update via account settings API + + Returns: + type[Model] | None: The model class if PROFILE_EXTENSION_FORM is configured + and valid, None otherwise (including when using the deprecated + REGISTRATION_EXTENSION_FORM). + + Examples: + # New setting with model support: + # In settings.py: PROFILE_EXTENSION_FORM = 'myapp.forms.ExtendedProfileForm' + model_class = get_extended_profile_model() # Returns the model + + # Deprecated setting - maintains old behavior: + # In settings.py: REGISTRATION_EXTENSION_FORM = 'myapp.forms.ExtendedForm' + model_class = get_extended_profile_model() # Returns None (no model support) """ - if not getattr(settings, 'REGISTRATION_EXTENSION_FORM', None): + # Only check for the new setting - do NOT fall back to REGISTRATION_EXTENSION_FORM + # This ensures backward compatibility: users of the old setting keep the old behavior + setting_value = getattr(settings, "PROFILE_EXTENSION_FORM", None) + + if not setting_value: + return None + + try: + module_path, klass_name = setting_value.rsplit(".", 1) + module = import_module(module_path) + form_class = getattr(module, klass_name) + return getattr(form_class.Meta, "model", None) + except (ValueError, ImportError, AttributeError) as e: + log.warning("Could not load extended profile model from PROFILE_EXTENSION_FORM='%s': %s", setting_value, e) return None - module, klass = settings.REGISTRATION_EXTENSION_FORM.rsplit('.', 1) - module = import_module(module) - return getattr(module, klass)(*args, **kwargs) class RegistrationFormFactory: @@ -334,7 +418,20 @@ class RegistrationFormFactory: def _is_field_visible(self, field_name): """Check whether a field is visible based on Django settings. """ - return self._extra_fields_setting.get(field_name) in ["required", "optional", "optional-exposed"] + is_visible = self._extra_fields_setting.get(field_name) in ["required", "optional", "optional-exposed"] + + # If SAML provider config wants to skip optional checkboxes, hide marketing_emails_opt_in + if is_visible and field_name == 'marketing_emails_opt_in': + saml_config = self._get_saml_provider_config() + if saml_config and saml_config.skip_registration_optional_checkboxes: + log.info( + "SAML provider %s has skip_registration_optional_checkboxes=True, " + "hiding marketing_emails_opt_in field", + saml_config.slug + ) + return False + + return is_visible def _is_field_required(self, field_name): """Check whether a field is required based on Django settings. """ @@ -410,6 +507,62 @@ def __init__(self): field_order.extend(sorted(difference)) self.field_order = field_order + self.request = None # Will be set by get_registration_form + + def _get_saml_provider_config(self): + """ + Get the SAML provider config for the current request's running pipeline. + + Returns: + SAMLProviderConfig or None: The SAML provider config if found, None otherwise + """ + if not self.request or not third_party_auth.is_enabled(): + return None + + running_pipeline = third_party_auth.pipeline.get(self.request) + if not running_pipeline: + return None + + try: + # idp_name can be in kwargs directly, in kwargs['details'], or in kwargs['response'] + saml_provider_name = running_pipeline.get('kwargs', {}).get('idp_name') + if not saml_provider_name: + saml_provider_name = ( + running_pipeline.get('kwargs', {}) + .get('details', {}) + .get('idp_name') + ) + if not saml_provider_name: + saml_provider_name = ( + running_pipeline.get('kwargs', {}) + .get('response', {}) + .get('idp_name') + ) + + if not saml_provider_name: + return None + + try: + # Try to find the SAML provider config + # First try with current_set(), then fall back to direct query + try: + return SAMLProviderConfig.objects.current_set().get( + slug=saml_provider_name + ) + except SAMLProviderConfig.DoesNotExist: + # Fallback to direct query without current_set() + return SAMLProviderConfig.objects.get( + slug=saml_provider_name + ) + except SAMLProviderConfig.DoesNotExist: + log.debug( + "SAML provider config not found for idp_name: %s", + saml_provider_name + ) + return None + except Exception as exc: # pylint: disable=broad-except + log.debug("Error getting SAML provider config: %s", str(exc)) + return None def get_registration_form(self, request): """Return a description of the registration form. @@ -426,10 +579,12 @@ def get_registration_form(self, request): Returns: HttpResponse """ + self.request = request form_desc = FormDescription("post", self._get_registration_submit_url(request)) self._apply_third_party_auth_overrides(request, form_desc) - # Custom form fields can be added via the form set in settings.REGISTRATION_EXTENSION_FORM + # Custom form fields can be added via the form set in settings.PROFILE_EXTENSION_FORM + # (or deprecated settings.REGISTRATION_EXTENSION_FORM) custom_form = get_registration_extension_form() if custom_form: custom_form_field_names = [field_name for field_name, field in custom_form.fields.items()] @@ -461,7 +616,7 @@ def get_registration_form(self, request): FormDescription.FIELD_TYPE_MAP.get(field.__class__)) if not field_type: raise ImproperlyConfigured( - "Field type '{}' not recognized for registration extension field '{}'.".format( + "Field type '{}' not recognized for registration extension field '{}'.".format( # noqa: UP032 # pylint: disable=line-too-long field_type, field_name ) @@ -693,6 +848,11 @@ def _add_year_of_birth_field(self, form_desc, required=True): def _add_marketing_emails_opt_in_field(self, form_desc, required=False): """Add a marketing email checkbox to form description. + + If a SAML provider config has skip_registration_optional_checkboxes=True, + the field will default to False (opt-out) and not be required, overriding + the global settings. + Arguments: form_desc: A form description Keyword Arguments: @@ -703,13 +863,31 @@ def _add_marketing_emails_opt_in_field(self, form_desc, required=False): platform_name=configuration_helpers.get_value('PLATFORM_NAME', settings.PLATFORM_NAME), ) + # Default: checkbox is checked, field requirement follows the passed parameter + default_value = True + field_required = required + field_exposed = True + + # Check if SAML provider wants to skip optional checkboxes + # This overrides both global settings and provider field overrides + saml_config = self._get_saml_provider_config() + if saml_config and saml_config.skip_registration_optional_checkboxes: + log.info( + "SAML provider %s has skip_registration_optional_checkboxes=True, " + "hiding field and setting default to False", + saml_config.slug + ) + default_value = False # User opts out by default when field is skipped + field_required = False # Make field optional + field_exposed = False # Hide the field from the form + form_desc.add_field( 'marketing_emails_opt_in', label=opt_in_label, field_type="checkbox", - exposed=True, - default=True, # the checkbox will automatically be checked; meaning user has opted in - required=required, + exposed=field_exposed, + default=default_value, + required=field_required, ) def _add_field_with_configurable_select_options(self, field_name, field_label, form_desc, required=False): @@ -1149,7 +1327,24 @@ def _apply_third_party_auth_overrides(self, request, form_desc): ) for field_name in self.DEFAULT_FIELDS + self.EXTRA_FIELDS: - if field_name in field_overrides: + if field_name not in field_overrides: + continue + + # Special handling for marketing_emails_opt_in: + # If SAML provider config has skip_registration_optional_checkboxes=True, + # don't let the provider's get_register_form_data override the default + skip_override = False + if field_name == 'marketing_emails_opt_in': + saml_config = self._get_saml_provider_config() + if saml_config and saml_config.skip_registration_optional_checkboxes: + log.debug( + "Skipping provider override for marketing_emails_opt_in " + "due to SAML config for provider: %s", + saml_config.slug + ) + skip_override = True + + if not skip_override: form_desc.override_field_properties( field_name, default=field_overrides[field_name] ) @@ -1159,9 +1354,11 @@ def _apply_third_party_auth_overrides(self, request, form_desc): field_overrides[field_name] and hide_registration_fields_except_tos ): + field_default = field_overrides[field_name] form_desc.override_field_properties( field_name, field_type="hidden", + default=field_default, label="", instructions="", ) diff --git a/openedx/core/djangoapps/user_authn/views/tests/test_auth.py b/openedx/core/djangoapps/user_authn/views/tests/test_auth.py index 7ca8bc96fbaf..29a0c709d1bf 100644 --- a/openedx/core/djangoapps/user_authn/views/tests/test_auth.py +++ b/openedx/core/djangoapps/user_authn/views/tests/test_auth.py @@ -2,11 +2,13 @@ import json -from django.test import TestCase +from unittest import mock + from django.conf import settings +from django.test import TestCase from django.urls import reverse + from openedx.core.djangolib.testing.utils import skip_unless_lms -from unittest import mock @skip_unless_lms diff --git a/openedx/core/djangoapps/user_authn/views/tests/test_auto_auth.py b/openedx/core/djangoapps/user_authn/views/tests/test_auto_auth.py index b68774903092..ff393d1ca01b 100644 --- a/openedx/core/djangoapps/user_authn/views/tests/test_auto_auth.py +++ b/openedx/core/djangoapps/user_authn/views/tests/test_auto_auth.py @@ -6,22 +6,24 @@ import ddt from django.conf import settings -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.test import TestCase from django.test.client import Client from opaque_keys.edx.locator import CourseLocator from common.djangoapps.student.models import CourseAccessRole, CourseEnrollment, UserProfile, anonymous_id_for_user from common.djangoapps.util.testing import UrlResetMixin +from common.test.utils import assert_dict_contains_subset from openedx.core.djangoapps.django_comment_common.models import ( FORUM_ROLE_ADMINISTRATOR, FORUM_ROLE_MODERATOR, FORUM_ROLE_STUDENT, - Role + Role, ) from openedx.core.djangoapps.django_comment_common.utils import seed_permissions_roles -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from common.test.utils import assert_dict_contains_subset +from xmodule.modulestore.tests.django_utils import ( + ModuleStoreTestCase, # pylint: disable=wrong-import-order +) class AutoAuthTestCase(UrlResetMixin, TestCase): diff --git a/openedx/core/djangoapps/user_authn/views/tests/test_events.py b/openedx/core/djangoapps/user_authn/views/tests/test_events.py index 7efd4e4cf5c0..edaba19cc3ee 100644 --- a/openedx/core/djangoapps/user_authn/views/tests/test_events.py +++ b/openedx/core/djangoapps/user_authn/views/tests/test_events.py @@ -9,20 +9,20 @@ """ from unittest.mock import Mock -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.urls import reverse from openedx_events.learning.data import UserData, UserPersonalData from openedx_events.learning.signals import SESSION_LOGIN_COMPLETED, STUDENT_REGISTRATION_COMPLETED -from openedx_events.tests.utils import OpenEdxEventsTestMixin +from openedx_events.testing import OpenEdxEventsTestMixin from common.djangoapps.student.tests.factories import UserFactory, UserProfileFactory +from common.test.utils import assert_dict_contains_subset from openedx.core.djangoapps.user_api.tests.test_views import UserAPITestCase from openedx.core.djangolib.testing.utils import skip_unless_lms -from common.test.utils import assert_dict_contains_subset @skip_unless_lms -class RegistrationEventTest(UserAPITestCase, OpenEdxEventsTestMixin): +class RegistrationEventTest(OpenEdxEventsTestMixin, UserAPITestCase): """ Tests for the Open edX Events associated with the registration process through the registration view. @@ -36,19 +36,6 @@ class RegistrationEventTest(UserAPITestCase, OpenEdxEventsTestMixin): ENABLED_OPENEDX_EVENTS = ["org.openedx.learning.student.registration.completed.v1"] - @classmethod - def setUpClass(cls): - """ - Set up class method for the Test class. - - So the Open edX Events Isolation starts, the setUpClass must be explicitly - called with the method that executes the isolation. We do this to avoid - MRO resolution conflicts with other sibling classes while ensuring the - isolation process begins. - """ - super().setUpClass() - cls.start_events_isolation() - def setUp(self): # pylint: disable=arguments-differ super().setUp() self.url = reverse("user_api_registration") @@ -83,7 +70,7 @@ def test_send_registration_event(self): self.client.post(self.url, self.user_info) user = User.objects.get(username=self.user_info.get("username")) - self.assertTrue(self.receiver_called) + self.assertTrue(self.receiver_called) # noqa: PT009 assert_dict_contains_subset( self, { @@ -104,7 +91,7 @@ def test_send_registration_event(self): @skip_unless_lms -class LoginSessionEventTest(UserAPITestCase, OpenEdxEventsTestMixin): +class LoginSessionEventTest(OpenEdxEventsTestMixin, UserAPITestCase): """ Tests for the Open edX Events associated with the login process through the login_user view. @@ -118,17 +105,6 @@ class LoginSessionEventTest(UserAPITestCase, OpenEdxEventsTestMixin): ENABLED_OPENEDX_EVENTS = ["org.openedx.learning.auth.session.login.completed.v1"] - @classmethod - def setUpClass(cls): - """ - Set up class method for the Test class. - - This method starts manually events isolation. Explanation here: - openedx/core/djangoapps/user_authn/views/tests/test_events.py#L44 - """ - super().setUpClass() - cls.start_events_isolation() - def setUp(self): # pylint: disable=arguments-differ super().setUp() self.url = reverse("user_api_login_session", kwargs={"api_version": "v1"}) @@ -166,7 +142,7 @@ def test_send_login_event(self): self.client.post(self.url, data) user = User.objects.get(username=self.user.username) - self.assertTrue(self.receiver_called) + self.assertTrue(self.receiver_called) # noqa: PT009 assert_dict_contains_subset( self, { diff --git a/openedx/core/djangoapps/user_authn/views/tests/test_filters.py b/openedx/core/djangoapps/user_authn/views/tests/test_filters.py index dbca91830028..41f994501ef7 100644 --- a/openedx/core/djangoapps/user_authn/views/tests/test_filters.py +++ b/openedx/core/djangoapps/user_authn/views/tests/test_filters.py @@ -137,7 +137,7 @@ def test_register_filter_executed(self): self.client.post(self.url, self.user_info) user = User.objects.filter(username=f"{self.user_info.get('username')}-OpenEdx-Test") - self.assertTrue(user) + self.assertTrue(user) # noqa: PT009 @override_settings( OPEN_EDX_FILTERS_CONFIG={ @@ -160,7 +160,7 @@ def test_register_filter_prevent_registration(self): """ response = self.client.post(self.url, self.user_info) - self.assertEqual(status.HTTP_403_FORBIDDEN, response.status_code) + self.assertEqual(status.HTTP_403_FORBIDDEN, response.status_code) # noqa: PT009 @override_settings(OPEN_EDX_FILTERS_CONFIG={}) def test_register_without_filter_configuration(self): @@ -174,7 +174,7 @@ def test_register_without_filter_configuration(self): self.client.post(self.url, self.user_info) user = User.objects.filter(username=f"{self.user_info.get('username')}") - self.assertTrue(user) + self.assertTrue(user) # noqa: PT009 @skip_unless_lms @@ -225,7 +225,7 @@ def test_login_filter_executed(self): self.client.post(self.url, data) user = User.objects.get(username=self.user.username) - self.assertDictEqual({"logged_in": True, "another_logged_in": True}, user.profile.get_meta()) + self.assertDictEqual({"logged_in": True, "another_logged_in": True}, user.profile.get_meta()) # noqa: PT009 @override_settings( OPEN_EDX_FILTERS_CONFIG={ @@ -253,7 +253,7 @@ def test_login_filter_prevent_login(self): response = self.client.post(self.url, data) - self.assertEqual(status.HTTP_400_BAD_REQUEST, response.status_code) + self.assertEqual(status.HTTP_400_BAD_REQUEST, response.status_code) # noqa: PT009 @override_settings(OPEN_EDX_FILTERS_CONFIG={}) def test_login_without_filter_configuration(self): @@ -271,4 +271,4 @@ def test_login_without_filter_configuration(self): response = self.client.post(self.url, data) - self.assertEqual(status.HTTP_200_OK, response.status_code) + self.assertEqual(status.HTTP_200_OK, response.status_code) # noqa: PT009 diff --git a/openedx/core/djangoapps/user_authn/views/tests/test_login.py b/openedx/core/djangoapps/user_authn/views/tests/test_login.py index c8bfa082900b..4e4d0a9e8894 100644 --- a/openedx/core/djangoapps/user_authn/views/tests/test_login.py +++ b/openedx/core/djangoapps/user_authn/views/tests/test_login.py @@ -12,7 +12,7 @@ import ddt from django.conf import settings -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.core import mail from django.core.cache import cache from django.http import HttpResponse @@ -21,30 +21,30 @@ from django.urls import NoReverseMatch, reverse from edx_toggles.toggles.testutils import override_waffle_switch from freezegun import freeze_time -from common.djangoapps.student.tests.factories import RegistrationFactory, UserFactory, UserProfileFactory -from openedx_events.tests.utils import OpenEdxEventsTestMixin # lint-amnesty, pylint: disable=wrong-import-order +from openedx_events.testing import OpenEdxEventsTestMixin # pylint: disable=wrong-import-order +from common.djangoapps.student.models import LoginFailures +from common.djangoapps.student.tests.factories import RegistrationFactory, UserFactory, UserProfileFactory +from common.djangoapps.util.password_policy_validators import DEFAULT_MAX_PASSWORD_LENGTH +from common.test.utils import assert_dict_contains_subset from openedx.core.djangoapps.password_policy.compliance import ( NonCompliantPasswordException, - NonCompliantPasswordWarning + NonCompliantPasswordWarning, ) from openedx.core.djangoapps.password_policy.hibp import PwnedPasswordsAPI -from openedx.core.djangoapps.user_api.accounts import EMAIL_MIN_LENGTH, EMAIL_MAX_LENGTH +from openedx.core.djangoapps.site_configuration.tests.mixins import SiteMixin +from openedx.core.djangoapps.user_api.accounts import EMAIL_MAX_LENGTH, EMAIL_MIN_LENGTH from openedx.core.djangoapps.user_authn.config.waffle import ENABLE_PWNED_PASSWORD_API from openedx.core.djangoapps.user_authn.cookies import jwt_cookies from openedx.core.djangoapps.user_authn.tests.utils import setup_login_oauth_client from openedx.core.djangoapps.user_authn.views.login import ( ENABLE_LOGIN_USING_THIRDPARTY_AUTH_ONLY, AllowedAuthUser, - _check_user_auth_flow + _check_user_auth_flow, ) from openedx.core.djangolib.testing.utils import CacheIsolationTestCase, skip_unless_lms -from openedx.core.djangoapps.site_configuration.tests.mixins import SiteMixin from openedx.core.lib.api.test_utils import ApiTestCase from openedx.features.enterprise_support.tests.factories import EnterpriseCustomerUserFactory -from common.djangoapps.student.models import LoginFailures -from common.djangoapps.util.password_policy_validators import DEFAULT_MAX_PASSWORD_LENGTH -from common.test.utils import assert_dict_contains_subset @ddt.ddt @@ -53,7 +53,7 @@ ENABLE_AUTHN_LOGIN_BLOCK_HIBP_POLICY=False, ENABLE_AUTHN_LOGIN_NUDGE_HIBP_POLICY=False, ) -class LoginTest(SiteMixin, CacheIsolationTestCase, OpenEdxEventsTestMixin): +class LoginTest(OpenEdxEventsTestMixin, SiteMixin, CacheIsolationTestCase): """ Test login_user() view """ @@ -67,17 +67,6 @@ class LoginTest(SiteMixin, CacheIsolationTestCase, OpenEdxEventsTestMixin): user_email = 'test@edx.org' password = 'test_password' - @classmethod - def setUpClass(cls): - """ - Set up class method for the Test class. - - This method starts manually events isolation. Explanation here: - openedx/core/djangoapps/user_authn/views/tests/test_events.py#L44 - """ - super().setUpClass() - cls.start_events_isolation() - def setUp(self): """Setup a test user along with its registration and profile""" super().setUp() @@ -173,7 +162,7 @@ def test_public_login_failure_with_only_third_part_auth_enabled(self): 'next_url': None, 'course_id': 'coursekey', 'expected_redirect': ( - '{root_url}/account/finish_auth?course_id=coursekey&next=%2Fdashboard'. + '{root_url}/account/finish_auth?course_id=coursekey&next=%2Fdashboard'. # noqa: UP032 format(root_url=settings.LMS_ROOT_URL) ), }, @@ -192,7 +181,7 @@ def test_public_login_failure_with_only_third_part_auth_enabled(self): 'next_url': 'http://scam.scam', 'course_id': 'coursekey', 'expected_redirect': ( - '{root_url}/account/finish_auth?course_id=coursekey&next=%2Fdashboard'. + '{root_url}/account/finish_auth?course_id=coursekey&next=%2Fdashboard'. # noqa: UP032 format(root_url=settings.LMS_ROOT_URL) ), }, @@ -838,7 +827,7 @@ def _assert_response(self, response, success=None, value=None, status_code=None, try: response_dict = json.loads(response.content.decode('utf-8')) except ValueError: - self.fail("Could not parse response content as JSON: %s" + self.fail("Could not parse response content as JSON: %s" # noqa: UP031 % str(response.content)) if success is not None: @@ -848,7 +837,7 @@ def _assert_response(self, response, success=None, value=None, status_code=None, assert response_dict['error_code'] == error_code if value is not None: - msg = ("'%s' did not contain '%s'" % + msg = ("'%s' did not contain '%s'" % # noqa: UP031 (str(response_dict['value']), str(value))) assert value in response_dict['value'], msg @@ -861,7 +850,7 @@ def _assert_redirect_url(self, response, expected_redirect_url): """ response_dict = json.loads(response.content.decode('utf-8')) assert 'redirect_url' in response_dict, ( - "Response JSON unexpectedly does not have redirect_url: {!r}".format( + "Response JSON unexpectedly does not have redirect_url: {!r}".format( # noqa: UP032 response_dict ) ) @@ -1046,7 +1035,7 @@ def test_check_user_auth_flow_bad_email(self): @ddt.ddt @skip_unless_lms -class LoginSessionViewTest(ApiTestCase, OpenEdxEventsTestMixin): +class LoginSessionViewTest(OpenEdxEventsTestMixin, ApiTestCase): """Tests for the login end-points of the user API. """ ENABLED_OPENEDX_EVENTS = [] @@ -1055,17 +1044,6 @@ class LoginSessionViewTest(ApiTestCase, OpenEdxEventsTestMixin): EMAIL = "bob@example.com" PASSWORD = "password" - @classmethod - def setUpClass(cls): - """ - Set up class method for the Test class. - - This method starts manually events isolation. Explanation here: - openedx/core/djangoapps/user_authn/views/tests/test_events.py#L44 - """ - super().setUpClass() - cls.start_events_isolation() - def setUp(self): super().setUp() self.url = reverse("user_api_login_session", kwargs={'api_version': 'v1'}) @@ -1102,7 +1080,7 @@ def test_login_form(self): assert form_desc['submit_url'] == reverse('user_api_login_session', kwargs={'api_version': 'v1'}) assert form_desc['fields'] == [{'name': 'email', 'defaultValue': '', 'type': 'email', 'exposed': True, 'required': True, 'label': 'Email', 'placeholder': '', - 'instructions': 'The email address you used to register with {platform_name}' + 'instructions': 'The email address you used to register with {platform_name}' # noqa: UP032 # pylint: disable=line-too-long .format(platform_name=settings.PLATFORM_NAME), 'restrictions': {'min_length': EMAIL_MIN_LENGTH, 'max_length': EMAIL_MAX_LENGTH}, diff --git a/openedx/core/djangoapps/user_authn/views/tests/test_logistration.py b/openedx/core/djangoapps/user_authn/views/tests/test_logistration.py index 3220cd513974..b94da138ea5d 100644 --- a/openedx/core/djangoapps/user_authn/views/tests/test_logistration.py +++ b/openedx/core/djangoapps/user_authn/views/tests/test_logistration.py @@ -2,8 +2,8 @@ from http.cookies import SimpleCookie -from urllib.parse import urlencode from unittest import mock +from urllib.parse import urlencode import ddt from django.conf import settings @@ -19,6 +19,8 @@ from django.utils.translation import gettext as _ from common.djangoapps.course_modes.models import CourseMode +from common.djangoapps.third_party_auth.tests.testutil import ThirdPartyAuthTestMixin, simulate_running_pipeline +from common.djangoapps.util.testing import UrlResetMixin from lms.djangoapps.branding.api import get_privacy_url from openedx.core.djangoapps.site_configuration.tests.mixins import SiteMixin from openedx.core.djangoapps.theming.tests.test_util import with_comprehensive_theme_context @@ -28,9 +30,9 @@ from openedx.core.djangolib.js_utils import dump_js_escaped_json from openedx.core.djangolib.markup import HTML, Text from openedx.core.djangolib.testing.utils import skip_unless_lms -from common.djangoapps.third_party_auth.tests.testutil import ThirdPartyAuthTestMixin, simulate_running_pipeline -from common.djangoapps.util.testing import UrlResetMixin -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + ModuleStoreTestCase, # pylint: disable=wrong-import-order +) @skip_unless_lms @@ -411,7 +413,7 @@ def test_hinted_login_dialog_disabled(self, url_name, auth_entry): params = [("next", "/courses/something/?tpa_hint=oa2-google-oauth2")] response = self.client.get(reverse(url_name), params, HTTP_ACCEPT="text/html") expected_url = '/auth/login/google-oauth2/?auth_entry={}&next=%2Fcourses'\ - '%2Fsomething%2F%3Ftpa_hint%3Doa2-google-oauth2'.format(auth_entry) + '%2Fsomething%2F%3Ftpa_hint%3Doa2-google-oauth2'.format(auth_entry) # noqa: UP032 self.assertRedirects( response, expected_url, @@ -456,7 +458,7 @@ def test_settings_tpa_hinted_login_dialog_disabled(self, url_name, auth_entry): params = [("next", "/courses/something/")] response = self.client.get(reverse(url_name), params, HTTP_ACCEPT="text/html") expected_url = '/auth/login/google-oauth2/?auth_entry={}&next=%2Fcourses'\ - '%2Fsomething%2F%3Ftpa_hint%3Doa2-google-oauth2'.format(auth_entry) + '%2Fsomething%2F%3Ftpa_hint%3Doa2-google-oauth2'.format(auth_entry) # noqa: UP032 self.assertRedirects( response, expected_url, @@ -569,14 +571,15 @@ def _assert_third_party_auth_data(self, response, current_backend, current_provi "errorMessage": None, "registerFormSubmitButtonText": "Create Account", "syncLearnerProfileData": False, - "pipeline_user_details": {"email": "test@test.com"} if add_user_details else {} + "pipeline_user_details": {"email": "test@test.com"} if add_user_details else {}, + "skipRegistrationOptionalCheckboxes": False } if expected_ec is not None: # If we set an EnterpriseCustomer, third-party auth providers ought to be hidden. auth_info['providers'] = [] auth_info = dump_js_escaped_json(auth_info) - expected_data = '"third_party_auth": {auth_info}'.format( + expected_data = '"third_party_auth": {auth_info}'.format( # noqa: UP032 auth_info=auth_info ) self.assertContains(response, expected_data) @@ -600,11 +603,12 @@ def _assert_saml_auth_data_with_error( 'errorMessage': expected_error_message, 'registerFormSubmitButtonText': 'Create Account', 'syncLearnerProfileData': False, - 'pipeline_user_details': {'response': {'idp_name': 'testshib'}} + 'pipeline_user_details': {'response': {'idp_name': 'testshib'}}, + 'skipRegistrationOptionalCheckboxes': False } auth_info = dump_js_escaped_json(auth_info) - expected_data = '"third_party_auth": {auth_info}'.format( + expected_data = '"third_party_auth": {auth_info}'.format( # noqa: UP032 auth_info=auth_info ) self.assertContains(response, expected_data) diff --git a/openedx/core/djangoapps/user_authn/views/tests/test_logout.py b/openedx/core/djangoapps/user_authn/views/tests/test_logout.py index a81d11c42cf4..e29a8d6e292b 100644 --- a/openedx/core/djangoapps/user_authn/views/tests/test_logout.py +++ b/openedx/core/djangoapps/user_authn/views/tests/test_logout.py @@ -4,6 +4,7 @@ import urllib from unittest import mock + import ddt import nh3 from django.conf import settings @@ -11,10 +12,10 @@ from django.test.utils import override_settings from django.urls import reverse -from openedx.core.djangoapps.oauth_dispatch.tests.factories import ApplicationFactory -from openedx.core.djangolib.testing.utils import skip_unless_lms from common.djangoapps.student.tests.factories import UserFactory from common.test.utils import assert_dict_contains_subset +from openedx.core.djangoapps.oauth_dispatch.tests.factories import ApplicationFactory +from openedx.core.djangolib.testing.utils import skip_unless_lms @skip_unless_lms diff --git a/openedx/core/djangoapps/user_authn/views/tests/test_password.py b/openedx/core/djangoapps/user_authn/views/tests/test_password.py index 57a988c0b354..958ec3d941e9 100644 --- a/openedx/core/djangoapps/user_authn/views/tests/test_password.py +++ b/openedx/core/djangoapps/user_authn/views/tests/test_password.py @@ -6,9 +6,10 @@ import re from datetime import datetime, timedelta from unittest.mock import Mock, patch +from zoneinfo import ZoneInfo -import pytest import ddt +import pytest from django.conf import settings from django.contrib.auth import get_user_model from django.core import mail @@ -19,16 +20,15 @@ from freezegun import freeze_time from oauth2_provider.models import AccessToken as dot_access_token from oauth2_provider.models import RefreshToken as dot_refresh_token -from zoneinfo import ZoneInfo from testfixtures import LogCapture +from common.djangoapps.student.tests.factories import UserFactory from openedx.core.djangoapps.oauth_dispatch.tests import factories as dot_factories from openedx.core.djangoapps.site_configuration.tests.factories import SiteFactory from openedx.core.djangoapps.user_api.accounts.tests.test_api import CreateAccountMixin from openedx.core.djangoapps.user_api.errors import UserAPIInternalError, UserNotFound from openedx.core.djangoapps.user_authn.views.password_reset import request_password_change from openedx.core.djangolib.testing.utils import CacheIsolationTestCase, skip_unless_lms -from common.djangoapps.student.tests.factories import UserFactory LOGGER_NAME = 'audit' User = get_user_model() # pylint:disable=invalid-name @@ -213,7 +213,7 @@ def test_password_change_failure(self): side_effect=UserAPIInternalError, ): self._change_password() - self.assertRaises(UserAPIInternalError) + self.assertRaises(UserAPIInternalError) # noqa: PT027 @patch.dict(settings.FEATURES, {'ENABLE_PASSWORD_RESET_FAILURE_EMAIL': True}) def test_password_reset_failure_email(self): @@ -234,7 +234,7 @@ def test_password_reset_failure_email(self): html_body = sent_message.alternatives[0][0] for email_body in [text_body, html_body]: - msg = 'However, there is currently no user account associated with your email address: {email}'.format( + msg = 'However, there is currently no user account associated with your email address: {email}'.format( # noqa: UP032 # pylint: disable=line-too-long email=bad_email ) diff --git a/openedx/core/djangoapps/user_authn/views/tests/test_register.py b/openedx/core/djangoapps/user_authn/views/tests/test_register.py index e79b8ae6daa2..5ba40a6c960e 100644 --- a/openedx/core/djangoapps/user_authn/views/tests/test_register.py +++ b/openedx/core/djangoapps/user_authn/views/tests/test_register.py @@ -4,19 +4,19 @@ from datetime import datetime from unittest import mock, skipIf, skipUnless from unittest.mock import patch +from zoneinfo import ZoneInfo import ddt import httpretty from django.conf import settings -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.core import mail from django.core.cache import cache from django.test import TransactionTestCase from django.test.client import RequestFactory from django.test.utils import override_settings from django.urls import reverse -from openedx_events.tests.utils import OpenEdxEventsTestMixin -from zoneinfo import ZoneInfo +from openedx_events.testing import OpenEdxEventsTestMixin from social_django.models import Partial, UserSocialAuth from testfixtures import LogCapture @@ -26,13 +26,13 @@ from common.djangoapps.third_party_auth.tests.utils import ( ThirdPartyOAuthTestMixin, ThirdPartyOAuthTestMixinFacebook, - ThirdPartyOAuthTestMixinGoogle + ThirdPartyOAuthTestMixinGoogle, ) from common.djangoapps.util.password_policy_validators import ( DEFAULT_MAX_PASSWORD_LENGTH, create_validator_config, password_validators_instruction_texts, - password_validators_restrictions + password_validators_restrictions, ) from openedx.core.djangoapps.embargo.models import Country, GlobalRestrictedCountry from openedx.core.djangoapps.site_configuration.helpers import get_value @@ -52,14 +52,14 @@ USERNAME_INVALID_CHARS_ASCII, USERNAME_INVALID_CHARS_UNICODE, USERNAME_MAX_LENGTH, - USERNAME_MIN_LENGTH + USERNAME_MIN_LENGTH, ) from openedx.core.djangoapps.user_api.accounts.api import get_account_settings from openedx.core.djangoapps.user_api.accounts.tests import testutils from openedx.core.djangoapps.user_api.accounts.tests.retirement_helpers import ( # pylint: disable=unused-import RetirementTestCase, fake_requested_retirement, - setup_retirement_states + setup_retirement_states, # noqa: F401 ) from openedx.core.djangoapps.user_api.tests.test_constants import SORTED_COUNTRIES from openedx.core.djangoapps.user_api.tests.test_helpers import TestCaseForm @@ -74,7 +74,7 @@ @ddt.ddt @skip_unless_lms class RegistrationViewValidationErrorTest( - ThirdPartyAuthTestMixin, UserAPITestCase, RetirementTestCase, OpenEdxEventsTestMixin + OpenEdxEventsTestMixin, ThirdPartyAuthTestMixin, UserAPITestCase, RetirementTestCase ): """ Tests for catching duplicate email and username validation errors within @@ -96,17 +96,6 @@ class RegistrationViewValidationErrorTest( COUNTRY = "US" GOALS = "Learn all the things!" - @classmethod - def setUpClass(cls): - """ - Set up class method for the Test class. - - This method starts manually events isolation. Explanation here: - openedx/core/djangoapps/user_authn/views/tests/test_events.py#L44 - """ - super().setUpClass() - cls.start_events_isolation() - def setUp(self): # pylint: disable=arguments-differ super().setUp() self.url = reverse("user_api_registration") @@ -156,7 +145,7 @@ def test_register_retired_email_validation_error(self): assert response.status_code == 409 response_json = json.loads(response.content.decode('utf-8')) - self.assertDictEqual( + self.assertDictEqual( # noqa: PT009 response_json, { "email": [{ @@ -198,7 +187,7 @@ def test_register_duplicate_retired_username_account_validation_error(self): response_json = json.loads(response.content.decode('utf-8')) username_suggestions = response_json.pop('username_suggestions') assert len(username_suggestions) == 3 - self.assertDictEqual( + self.assertDictEqual( # noqa: PT009 response_json, { "username": [{ @@ -231,7 +220,7 @@ def test_register_duplicate_email_validation_error(self): assert response.status_code == 409 response_json = json.loads(response.content.decode('utf-8')) - self.assertDictEqual( + self.assertDictEqual( # noqa: PT009 response_json, { "email": [{ @@ -268,7 +257,7 @@ def test_register_duplicate_email_validation_error_with_recovery(self): assert response.status_code == 409 response_json = json.loads(response.content.decode('utf-8')) - self.assertDictEqual( + self.assertDictEqual( # noqa: PT009 response_json, { "email": [{ @@ -291,7 +280,7 @@ def test_register_fullname_url_validation_error(self): }) assert response.status_code == 400 response_json = json.loads(response.content.decode('utf-8')) - self.assertDictEqual( + self.assertDictEqual( # noqa: PT009 response_json, { "name": [{"user_message": 'Enter a valid name'}], @@ -309,7 +298,7 @@ def test_register_fullname_url_validation_error(self): }) assert response.status_code == 400 response_json = json.loads(response.content.decode('utf-8')) - self.assertDictEqual( + self.assertDictEqual( # noqa: PT009 response_json, { "name": [{"user_message": 'Enter a valid name'}], @@ -333,7 +322,7 @@ def test_register_fullname_max_lenghth_validation_error(self): assert response.status_code == 400 response_json = json.loads(response.content.decode('utf-8')) - self.assertDictEqual( + self.assertDictEqual( # noqa: PT009 response_json, { "name": [{"user_message": expected_error_message}], @@ -354,7 +343,7 @@ def test_register_fullname_html_validation_error(self): }) assert response.status_code == 400 response_json = json.loads(response.content.decode('utf-8')) - self.assertDictEqual( + self.assertDictEqual( # noqa: PT009 response_json, { 'name': [{'user_message': 'Full Name cannot contain the following characters: < >'}], @@ -386,7 +375,7 @@ def test_register_duplicate_username_account_validation_error(self): response_json = json.loads(response.content.decode('utf-8')) username_suggestions = response_json.pop('username_suggestions') assert len(username_suggestions) == 3 - self.assertDictEqual( + self.assertDictEqual( # noqa: PT009 response_json, { "username": [{ @@ -420,7 +409,7 @@ def test_register_duplicate_username_and_email_validation_errors(self): response_json = json.loads(response.content.decode('utf-8')) username_suggestions = response_json.pop('username_suggestions') assert len(username_suggestions) == 3 - self.assertDictEqual( + self.assertDictEqual( # noqa: PT009 response_json, { "username": [{ @@ -458,7 +447,7 @@ def test_duplicate_email_username_error(self): assert response.status_code == 409 username_suggestions = response_json.pop('username_suggestions') assert len(username_suggestions) == 3 - self.assertDictEqual( + self.assertDictEqual( # noqa: PT009 response_json, { "username": [{ @@ -483,7 +472,7 @@ def test_invalid_country_code_error(self): response_json = json.loads(response.content.decode('utf-8')) self.assertHttpBadRequest(response) - self.assertDictEqual( + self.assertDictEqual( # noqa: PT009 response_json, { "country": [{ @@ -497,7 +486,7 @@ def test_invalid_country_code_error(self): @ddt.ddt @skip_unless_lms class RegistrationViewTestV1( - ThirdPartyAuthTestMixin, UserAPITestCase, OpenEdxEventsTestMixin + OpenEdxEventsTestMixin, ThirdPartyAuthTestMixin, UserAPITestCase ): """Tests for the registration end-points of the User API. """ @@ -563,17 +552,6 @@ class RegistrationViewTestV1( ] link_template = "{link_label}" - @classmethod - def setUpClass(cls): - """ - Set up class method for the Test class. - - This method starts manually events isolation. Explanation here: - openedx/core/djangoapps/user_authn/views/tests/test_events.py#L44 - """ - super().setUpClass() - cls.start_events_isolation() - def setUp(self): # pylint: disable=arguments-differ super().setUp() self.url = reverse("user_api_registration") @@ -984,7 +962,7 @@ def test_register_form_marketing_emails_opt_in_field(self): "name": "marketing_emails_opt_in", "type": "checkbox", "required": False, - "label": 'I agree that {platform_name} may send me marketing messages.'.format( + "label": 'I agree that {platform_name} may send me marketing messages.'.format( # noqa: UP032 platform_name=settings.PLATFORM_NAME, ), "exposed": True, @@ -1081,7 +1059,7 @@ def test_registration_form_goals(self): "name": "goals", "type": "textarea", "required": False, - "label": "Tell us why you're interested in {platform_name}".format( + "label": "Tell us why you're interested in {platform_name}".format( # noqa: UP032 platform_name=settings.PLATFORM_NAME ), "errorMessages": { @@ -1177,7 +1155,7 @@ def test_registration_honor_code_mktg_site_enabled(self): "type": "plaintext", "required": True, "errorMessages": { - "required": "You must agree to the {platform_name} {link_label}".format( + "required": "You must agree to the {platform_name} {link_label}".format( # noqa: UP032 platform_name=settings.PLATFORM_NAME, link_label=link_label ) @@ -1209,7 +1187,7 @@ def test_registration_honor_code_mktg_site_disabled(self): "type": "plaintext", "required": True, "errorMessages": { - "required": "You must agree to the {platform_name} {link_label}".format( + "required": "You must agree to the {platform_name} {link_label}".format( # noqa: UP032 platform_name=settings.PLATFORM_NAME, link_label=link_label ) @@ -1231,7 +1209,7 @@ def test_registration_separate_terms_of_service_mktg_site_enabled(self): self._assert_reg_field( {"honor_code": "required", "terms_of_service": "required"}, { - "label": "I agree to the {platform_name} {link_label}".format( + "label": "I agree to the {platform_name} {link_label}".format( # noqa: UP032 platform_name=settings.PLATFORM_NAME, link_label=link_template.format(link_label=link_label) ), @@ -1240,7 +1218,7 @@ def test_registration_separate_terms_of_service_mktg_site_enabled(self): "type": "checkbox", "required": True, "errorMessages": { - "required": "You must agree to the {platform_name} {link_label}".format( + "required": "You must agree to the {platform_name} {link_label}".format( # noqa: UP032 platform_name=settings.PLATFORM_NAME, link_label=link_label ) @@ -1254,7 +1232,7 @@ def test_registration_separate_terms_of_service_mktg_site_enabled(self): self._assert_reg_field( {"honor_code": "required", "terms_of_service": "required"}, { - "label": "I agree to the {platform_name} {link_label}".format( + "label": "I agree to the {platform_name} {link_label}".format( # noqa: UP032 platform_name=settings.PLATFORM_NAME, link_label=link_template.format(link_label=link_label) ), @@ -1263,7 +1241,7 @@ def test_registration_separate_terms_of_service_mktg_site_enabled(self): "type": "checkbox", "required": True, "errorMessages": { - "required": "You must agree to the {platform_name} {link_label}".format( + "required": "You must agree to the {platform_name} {link_label}".format( # noqa: UP032 platform_name=settings.PLATFORM_NAME, link_label=link_label ) @@ -1280,7 +1258,7 @@ def test_registration_separate_terms_of_service_mktg_site_disabled(self): self._assert_reg_field( {"honor_code": "required", "terms_of_service": "required"}, { - "label": "I agree to the {platform_name} {link_label}".format( + "label": "I agree to the {platform_name} {link_label}".format( # noqa: UP032 platform_name=settings.PLATFORM_NAME, link_label=self.link_template.format(link_label=link_label) ), @@ -1289,7 +1267,7 @@ def test_registration_separate_terms_of_service_mktg_site_disabled(self): "type": "checkbox", "required": True, "errorMessages": { - "required": "You must agree to the {platform_name} Honor Code".format( + "required": "You must agree to the {platform_name} Honor Code".format( # noqa: UP032 platform_name=settings.PLATFORM_NAME ) } @@ -1302,7 +1280,7 @@ def test_registration_separate_terms_of_service_mktg_site_disabled(self): self._assert_reg_field( {"honor_code": "required", "terms_of_service": "required"}, { - "label": "I agree to the {platform_name} {link_label}".format( + "label": "I agree to the {platform_name} {link_label}".format( # noqa: UP032 platform_name=settings.PLATFORM_NAME, link_label=link_template.format(link_label=link_label) ), @@ -1311,7 +1289,7 @@ def test_registration_separate_terms_of_service_mktg_site_disabled(self): "type": "checkbox", "required": True, "errorMessages": { - "required": "You must agree to the {platform_name} Terms of Service".format( + "required": "You must agree to the {platform_name} Terms of Service".format( # noqa: UP032 platform_name=settings.PLATFORM_NAME ) } @@ -1641,7 +1619,7 @@ def test_register_missing_country_required_field(self): response_json = json.loads(response.content.decode('utf-8')) self.assertHttpBadRequest(response) - self.assertDictEqual( + self.assertDictEqual( # noqa: PT009 response_json, { "country": [{ @@ -1665,7 +1643,7 @@ def test_register_invalid_country_required_field(self): response_json = json.loads(response.content.decode('utf-8')) self.assertHttpBadRequest(response) - self.assertDictEqual( + self.assertDictEqual( # noqa: PT009 response_json, { "country": [{ @@ -1697,7 +1675,7 @@ def test_register_duplicate_email(self): assert response.status_code == 409 response_json = json.loads(response.content.decode('utf-8')) - self.assertDictEqual( + self.assertDictEqual( # noqa: PT009 response_json, { "email": [{ @@ -1731,7 +1709,7 @@ def test_register_duplicate_username(self): response_json = json.loads(response.content.decode('utf-8')) username_suggestions = response_json.pop('username_suggestions') assert len(username_suggestions) == 3 - self.assertDictEqual( + self.assertDictEqual( # noqa: PT009 response_json, { "username": [{ @@ -1765,7 +1743,7 @@ def test_register_duplicate_username_and_email(self): response_json = json.loads(response.content.decode('utf-8')) username_suggestions = response_json.pop('username_suggestions') assert len(username_suggestions) == 3 - self.assertDictEqual( + self.assertDictEqual( # noqa: PT009 response_json, { "username": [{ @@ -1799,7 +1777,7 @@ def test_missing_fields(self): ) assert response.status_code == 400 response_json = json.loads(response.content.decode('utf-8')) - self.assertDictEqual( + self.assertDictEqual( # noqa: PT009 response_json, { "username": [{"user_message": USERNAME_BAD_LENGTH_MSG}], @@ -1905,7 +1883,7 @@ def test_register_with_empty_name(self): }) assert response.status_code == 400 response_json = json.loads(response.content.decode('utf-8')) - self.assertDictEqual( + self.assertDictEqual( # noqa: PT009 response_json, { "name": [{"user_message": 'Your legal name must be a minimum of one character long'}], @@ -1958,7 +1936,7 @@ def test_register_autogenerated_duplicate_username(self, assert response.status_code == 409 response_json = json.loads(response.content.decode('utf-8')) response_json.pop('username_suggestions') - self.assertDictEqual( + self.assertDictEqual( # noqa: PT009 response_json, { "username": [{ @@ -1976,7 +1954,7 @@ def _assert_fields_match(self, actual_field, expected_field): for key in expected_field: assert actual_field[key] == expected_field[key], \ - "Expected {expected} for {key} but got {actual} instead".format( + "Expected {expected} for {key} but got {actual} instead".format( # noqa: UP032 key=key, actual=actual_field[key], expected=expected_field[key]) def _populate_always_present_fields(self, field): @@ -2051,7 +2029,7 @@ def _assert_reg_absent_field(self, extra_fields_setting, expected_absent_field: current_present_field_names = [field["name"] for field in form_desc["fields"]] assert expected_absent_field not in current_present_field_names, \ - "Expected absent field {expected}".format(expected=expected_absent_field) + "Expected absent field {expected}".format(expected=expected_absent_field) # noqa: UP032 def _assert_password_field_hidden(self, field_settings): self._assert_reg_field(field_settings, { @@ -2077,19 +2055,8 @@ class RegistrationViewTestV2(RegistrationViewTestV1): # pylint: disable=test-inherits-tests - @classmethod - def setUpClass(cls): - """ - Set up class method for the Test class. - - This method starts manually events isolation. Explanation here: - openedx/core/djangoapps/user_authn/views/tests/test_events.py#L44 - """ - super().setUpClass() - cls.start_events_isolation() - def setUp(self): # pylint: disable=arguments-differ - super(RegistrationViewTestV1, self).setUp() # lint-amnesty, pylint: disable=bad-super-call + super(RegistrationViewTestV1, self).setUp() # pylint: disable=bad-super-call self.url = reverse("user_api_registration_v2") @override_settings( @@ -2308,7 +2275,7 @@ def _assert_redirect_url(self, response, expected_redirect_url): """ response_dict = json.loads(response.content.decode('utf-8')) assert 'redirect_url' in response_dict, ( - "Response JSON unexpectedly does not have redirect_url: {!r}".format( + "Response JSON unexpectedly does not have redirect_url: {!r}".format( # noqa: UP032 response_dict ) ) @@ -2479,7 +2446,7 @@ def test_register_with_disabled_country(self): }) assert response.status_code == 400 response_json = json.loads(response.content.decode('utf-8')) - self.assertDictEqual( + self.assertDictEqual( # noqa: PT009 response_json, {'country': [ @@ -2507,13 +2474,13 @@ def test_registration_allowed_when_embargo_disabled(self): "country": "KP", }) - self.assertEqual(response.status_code, 200) + self.assertEqual(response.status_code, 200) # noqa: PT009 @httpretty.activate @ddt.ddt class ThirdPartyRegistrationTestMixin( - ThirdPartyOAuthTestMixin, CacheIsolationTestCase, OpenEdxEventsTestMixin + OpenEdxEventsTestMixin, ThirdPartyOAuthTestMixin, CacheIsolationTestCase ): """ Tests for the User API registration endpoint with 3rd party authentication. @@ -2526,17 +2493,6 @@ class ThirdPartyRegistrationTestMixin( __test__ = False - @classmethod - def setUpClass(cls): - """ - Set up class method for the Test class. - - This method starts manually events isolation. Explanation here: - openedx/core/djangoapps/user_authn/views/tests/test_events.py#L44 - """ - super().setUpClass() - cls.start_events_isolation() - def setUp(self): super().setUp() self.url = reverse('user_api_registration') @@ -2574,7 +2530,7 @@ def _assert_access_token_error(self, response, expected_error_message, error_cod """Assert that the given response was an error for the access_token field with the given error message.""" assert response.status_code == 400 response_json = json.loads(response.content.decode('utf-8')) - self.assertDictEqual( + self.assertDictEqual( # noqa: PT009 response_json, { "access_token": [{"user_message": expected_error_message}], @@ -2586,7 +2542,7 @@ def _assert_third_party_session_expired_error(self, response, expected_error_mes """Assert that given response is an error due to third party session expiry""" assert response.status_code == 400 response_json = json.loads(response.content.decode('utf-8')) - self.assertDictEqual( + self.assertDictEqual( # noqa: PT009 response_json, { "session_expired": [{"user_message": expected_error_message}], @@ -2600,7 +2556,7 @@ def _verify_user_existence(self, user_exists, social_link_exists, user_is_active assert users.exists() == user_exists if user_exists: assert users[0].is_active == user_is_active - self.assertEqual( + self.assertEqual( # noqa: PT009 UserSocialAuth.objects.filter(user=users[0], provider=self.BACKEND).exists(), social_link_exists ) @@ -2731,7 +2687,7 @@ def test_expired_pipeline(self): @skipUnless(settings.FEATURES.get("ENABLE_THIRD_PARTY_AUTH"), "third party auth not enabled") class TestFacebookRegistrationView( - ThirdPartyRegistrationTestMixin, ThirdPartyOAuthTestMixinFacebook, TransactionTestCase, OpenEdxEventsTestMixin + ThirdPartyRegistrationTestMixin, ThirdPartyOAuthTestMixinFacebook, TransactionTestCase ): """Tests the User API registration endpoint with Facebook authentication.""" @@ -2739,17 +2695,6 @@ class TestFacebookRegistrationView( __test__ = True - @classmethod - def setUpClass(cls): - """ - Set up class method for the Test class. - - This method starts manually events isolation. Explanation here: - openedx/core/djangoapps/user_authn/views/tests/test_events.py#L44 - """ - super().setUpClass() - cls.start_events_isolation() - def test_social_auth_exception(self): """ According to the do_auth method in social_core.backends.facebook.py, @@ -2763,7 +2708,7 @@ def test_social_auth_exception(self): @skipUnless(settings.FEATURES.get("ENABLE_THIRD_PARTY_AUTH"), "third party auth not enabled") class TestGoogleRegistrationView( - ThirdPartyRegistrationTestMixin, ThirdPartyOAuthTestMixinGoogle, TransactionTestCase, OpenEdxEventsTestMixin + ThirdPartyRegistrationTestMixin, ThirdPartyOAuthTestMixinGoogle, TransactionTestCase ): """Tests the User API registration endpoint with Google authentication.""" @@ -2771,20 +2716,9 @@ class TestGoogleRegistrationView( __test__ = True - @classmethod - def setUpClass(cls): - """ - Set up class method for the Test class. - - This method starts manually events isolation. Explanation here: - openedx/core/djangoapps/user_authn/views/tests/test_events.py#L44 - """ - super().setUpClass() - cls.start_events_isolation() - @ddt.ddt -class RegistrationValidationViewTests(test_utils.ApiTestCase, OpenEdxEventsTestMixin): +class RegistrationValidationViewTests(OpenEdxEventsTestMixin, test_utils.ApiTestCase): """ Tests for validity of user data in registration forms. """ @@ -2794,17 +2728,6 @@ class RegistrationValidationViewTests(test_utils.ApiTestCase, OpenEdxEventsTestM endpoint_name = 'registration_validation' path = reverse(endpoint_name) - @classmethod - def setUpClass(cls): - """ - Set up class method for the Test class. - - This method starts manually events isolation. Explanation here: - openedx/core/djangoapps/user_authn/views/tests/test_events.py#L44 - """ - super().setUpClass() - cls.start_events_isolation() - def setUp(self): super().setUp() cache.clear() diff --git a/openedx/core/djangoapps/user_authn/views/tests/test_reset_password.py b/openedx/core/djangoapps/user_authn/views/tests/test_reset_password.py index aed040a8a21c..7388e51edddc 100644 --- a/openedx/core/djangoapps/user_authn/views/tests/test_reset_password.py +++ b/openedx/core/djangoapps/user_authn/views/tests/test_reset_password.py @@ -7,11 +7,12 @@ import unicodedata from datetime import datetime, timedelta from unittest.mock import Mock, patch +from zoneinfo import ZoneInfo import ddt from django.conf import settings from django.contrib.auth.hashers import UNUSABLE_PASSWORD_PREFIX, make_password -from django.contrib.auth.models import AnonymousUser, User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import AnonymousUser, User # pylint: disable=imported-auth-user from django.contrib.auth.tokens import default_token_generator from django.contrib.auth.views import INTERNAL_RESET_SESSION_TOKEN, PasswordResetConfirmView from django.contrib.sessions.middleware import SessionMiddleware @@ -24,25 +25,27 @@ from django.utils.http import int_to_base36 from freezegun import freeze_time from oauth2_provider import models as dot_models -from zoneinfo import ZoneInfo -from openedx.core.djangoapps.oauth_dispatch.tests import factories as dot_factories -from openedx.core.djangoapps.site_configuration import helpers as configuration_helpers -from openedx.core.djangolib.testing.utils import skip_unless_lms -from openedx.core.djangoapps.user_api.models import UserRetirementRequest -from openedx.core.djangoapps.user_api.tests.test_views import UserAPITestCase -from openedx.core.djangoapps.user_api.accounts import EMAIL_MAX_LENGTH, EMAIL_MIN_LENGTH -from openedx.core.djangoapps.user_authn.views.password_reset import ( - SETTING_CHANGE_INITIATED, PASSWORD_RESET_INITIATED, password_reset, LogistrationPasswordResetView, - PasswordResetConfirmWrapper, password_change_request_handler) -from openedx.core.djangolib.testing.utils import CacheIsolationTestCase +from common.djangoapps.student.models import AccountRecovery, LoginFailures from common.djangoapps.student.tests.factories import TEST_PASSWORD, UserFactory from common.djangoapps.student.tests.test_configuration_overrides import fake_get_value from common.djangoapps.student.tests.test_email import mock_render_to_string -from common.djangoapps.student.models import AccountRecovery, LoginFailures - from common.djangoapps.util.password_policy_validators import create_validator_config from common.djangoapps.util.testing import EventTestMixin +from openedx.core.djangoapps.oauth_dispatch.tests import factories as dot_factories +from openedx.core.djangoapps.site_configuration import helpers as configuration_helpers +from openedx.core.djangoapps.user_api.accounts import EMAIL_MAX_LENGTH, EMAIL_MIN_LENGTH +from openedx.core.djangoapps.user_api.models import UserRetirementRequest +from openedx.core.djangoapps.user_api.tests.test_views import UserAPITestCase +from openedx.core.djangoapps.user_authn.views.password_reset import ( + PASSWORD_RESET_INITIATED, + SETTING_CHANGE_INITIATED, + LogistrationPasswordResetView, + PasswordResetConfirmWrapper, + password_change_request_handler, + password_reset, +) +from openedx.core.djangolib.testing.utils import CacheIsolationTestCase, skip_unless_lms ENABLE_AUTHN_MICROFRONTEND = settings.FEATURES.copy() ENABLE_AUTHN_MICROFRONTEND['ENABLE_AUTHN_MICROFRONTEND'] = True @@ -278,7 +281,7 @@ def test_ratelimited_from_different_ips_with_same_email(self): cache.clear() - def request_password_reset(self, status, new_ip=None): # lint-amnesty, pylint: disable=missing-function-docstring + def request_password_reset(self, status, new_ip=None): # pylint: disable=missing-function-docstring extra_args = {} if new_ip: extra_args = {'REMOTE_ADDR': new_ip} @@ -650,7 +653,7 @@ def test_reset_password_with_other_user_link(self): reset_request = self.request_factory.get(self.password_reset_confirm_url) reset_request.user = UserFactory.create() - self.assertRaises(Http404, PasswordResetConfirmWrapper.as_view(), reset_request, uidb36=self.uidb36, + self.assertRaises(Http404, PasswordResetConfirmWrapper.as_view(), reset_request, uidb36=self.uidb36, # noqa: PT027 # pylint: disable=line-too-long token=self.token) @override_settings(FEATURES={'ENABLE_MAX_FAILED_LOGIN_ATTEMPTS': True}, MAX_FAILED_LOGIN_ATTEMPTS_ALLOWED=1) @@ -754,7 +757,7 @@ def test_password_reset_form(self): assert form_desc['fields'] ==\ [{'name': 'email', 'defaultValue': '', 'type': 'email', 'exposed': True, 'required': True, 'label': 'Email', 'placeholder': 'username@domain.com', - 'instructions': 'The email address you used to register with {platform_name}' + 'instructions': 'The email address you used to register with {platform_name}' # noqa: UP032 .format(platform_name=settings.PLATFORM_NAME), 'restrictions': {'min_length': EMAIL_MIN_LENGTH, 'max_length': EMAIL_MAX_LENGTH}, @@ -772,7 +775,7 @@ def setUp(self): self.user = UserFactory.create() self.user.is_active = False self.user.save() - self.token = '{uidb36}-{token}'.format( + self.token = '{uidb36}-{token}'.format( # noqa: UP032 uidb36=int_to_base36(self.user.id), token=default_token_generator.make_token(self.user) ) @@ -837,7 +840,7 @@ class ResetPasswordAPITests(EventTestMixin, CacheIsolationTestCase): request_factory = RequestFactory() ENABLED_CACHES = ['default'] - def setUp(self): # lint-amnesty, pylint: disable=arguments-differ + def setUp(self): # pylint: disable=arguments-differ super().setUp('openedx.core.djangoapps.user_authn.views.password_reset.tracker') self.user = UserFactory.create() self.user.save() diff --git a/openedx/core/djangoapps/user_authn/views/tests/test_saml_optional_checkboxes.py b/openedx/core/djangoapps/user_authn/views/tests/test_saml_optional_checkboxes.py new file mode 100644 index 000000000000..d759f6009f98 --- /dev/null +++ b/openedx/core/djangoapps/user_authn/views/tests/test_saml_optional_checkboxes.py @@ -0,0 +1,319 @@ +""" +Tests for SAML provider configuration to skip optional checkboxes in registration form. +""" + +import logging +from unittest import mock + +from django.test import TestCase, override_settings +from django.test.client import RequestFactory + +from common.djangoapps.third_party_auth.tests.factories import SAMLProviderConfigFactory +from common.djangoapps.third_party_auth.tests.testutil import simulate_running_pipeline +from openedx.core.djangoapps.user_authn.views.registration_form import RegistrationFormFactory + +log = logging.getLogger(__name__) + + +class SAMLProviderOptionalCheckboxTest(TestCase): + """ + Tests for SAML provider configuration options to skip optional checkboxes + (marketing emails, etc.) during registration. + """ + + def setUp(self): + """Set up test fixtures.""" + super().setUp() + self.factory = RequestFactory() + + def _create_request(self): + """Create a test request with session support.""" + from importlib import import_module + + from django.conf import settings + + request = self.factory.get('/register') + engine = import_module(settings.SESSION_ENGINE) + session_key = None + request.session = engine.SessionStore(session_key) + return request + + @override_settings( + MARKETING_EMAILS_OPT_IN=True, + REGISTRATION_EXTRA_FIELDS={}, + REGISTRATION_FIELD_ORDER=[] + ) + @mock.patch( + 'openedx.core.djangoapps.user_authn.views.registration_form.third_party_auth.is_enabled', + return_value=True, + ) + def test_marketing_checkbox_hidden_with_marketing_opt_in_setting(self, mock_is_enabled): + """ + Test that marketing checkbox is hidden when SAML provider config + has skip_registration_optional_checkboxes=True, even when the global + MARKETING_EMAILS_OPT_IN setting is True (production scenario). + """ + # Create a SAML provider config that skips optional checkboxes + saml_config = SAMLProviderConfigFactory( + skip_registration_optional_checkboxes=True + ) + + # Simulate running SAML authentication pipeline + with simulate_running_pipeline( + "common.djangoapps.third_party_auth.pipeline", + "tpa-saml", + idp_name=saml_config.slug, + email="testuser@example.com", + fullname="Test User", + username="testuser" + ): + request = self._create_request() + form_factory = RegistrationFormFactory() + form_desc = form_factory.get_registration_form(request) + + # Find the marketing_emails_opt_in field + marketing_field = None + for field in form_desc.fields: + if field['name'] == 'marketing_emails_opt_in': + marketing_field = field + break + + # Even though MARKETING_EMAILS_OPT_IN=True globally, + # the field should not be present when skipped via SAML config + self.assertIsNone( # noqa: PT009 + marketing_field, + "marketing_emails_opt_in field should not be present when skipped via SAML config, " + "even when MARKETING_EMAILS_OPT_IN=True" + ) + + @override_settings( + MARKETING_EMAILS_OPT_IN=True, + REGISTRATION_EXTRA_FIELDS={}, + REGISTRATION_FIELD_ORDER=[] + ) + @mock.patch( + 'openedx.core.djangoapps.user_authn.views.registration_form.third_party_auth.is_enabled', + return_value=True, + ) + def test_marketing_checkbox_visible_with_marketing_opt_in_setting_no_skip(self, mock_is_enabled): + """ + Test that marketing checkbox is visible when MARKETING_EMAILS_OPT_IN=True + and SAML provider config does NOT have skip_registration_optional_checkboxes=True. + """ + # Create a SAML provider config that doesn't skip checkboxes + saml_config = SAMLProviderConfigFactory( + skip_registration_optional_checkboxes=False + ) + + # Simulate running SAML authentication pipeline + with simulate_running_pipeline( + "common.djangoapps.third_party_auth.pipeline", + "tpa-saml", + idp_name=saml_config.slug, + email="testuser@example.com", + fullname="Test User", + username="testuser" + ): + request = self._create_request() + form_factory = RegistrationFormFactory() + form_desc = form_factory.get_registration_form(request) + + # Find the marketing_emails_opt_in field + marketing_field = None + for field in form_desc.fields: + if field['name'] == 'marketing_emails_opt_in': + marketing_field = field + break + + # When MARKETING_EMAILS_OPT_IN=True and SAML config doesn't skip, + # the field should be present + self.assertIsNotNone( # noqa: PT009 + marketing_field, + "marketing_emails_opt_in field should be present when MARKETING_EMAILS_OPT_IN=True " + "and SAML config does not skip checkboxes" + ) + # The field should be visible (exposed) + self.assertTrue( # noqa: PT009 + marketing_field.get('exposed', False), + "Marketing checkbox should be visible when SAML config does not skip checkboxes" + ) + # The field should be optional (not required) when MARKETING_EMAILS_OPT_IN=True + self.assertFalse( # noqa: PT009 + marketing_field.get('required', False), + "Marketing checkbox should be optional when MARKETING_EMAILS_OPT_IN=True" + ) + + @override_settings( + REGISTRATION_EXTRA_FIELDS={ + "marketing_emails_opt_in": "optional" + }, + REGISTRATION_FIELD_ORDER=[] + ) + def test_marketing_checkbox_optional_without_saml_config(self): + """ + Test that marketing checkbox is optional by default when REGISTRATION_EXTRA_FIELDS + is set to optional, regardless of SAML config. + """ + request = self._create_request() + form_factory = RegistrationFormFactory() + form_desc = form_factory.get_registration_form(request) + + # Find the marketing_emails_opt_in field + marketing_field = None + for field in form_desc.fields: + if field['name'] == 'marketing_emails_opt_in': + marketing_field = field + break + + self.assertIsNotNone(marketing_field, "marketing_emails_opt_in field not found") # noqa: PT009 + # When REGISTRATION_EXTRA_FIELDS is optional, the field should not be required + self.assertFalse(marketing_field.get('required', False)) # noqa: PT009 + # The field should be visible (exposed=True) by default + self.assertTrue( # noqa: PT009 + marketing_field.get('exposed', False), + "Marketing checkbox should be visible when no SAML config skips it" + ) + + @override_settings( + REGISTRATION_EXTRA_FIELDS={ + "marketing_emails_opt_in": "required" + }, + REGISTRATION_FIELD_ORDER=[] + ) + @mock.patch( + 'openedx.core.djangoapps.user_authn.views.registration_form.third_party_auth.is_enabled', + return_value=True, + ) + def test_marketing_checkbox_optional_with_saml_config(self, mock_is_enabled): + """ + Test that marketing checkbox is hidden when SAML provider config + has skip_registration_optional_checkboxes=True, overriding global settings. + """ + # Create a SAML provider config that skips optional checkboxes + saml_config = SAMLProviderConfigFactory( + skip_registration_optional_checkboxes=True + ) + + # Simulate running SAML authentication pipeline + with simulate_running_pipeline( + "common.djangoapps.third_party_auth.pipeline", + "tpa-saml", + idp_name=saml_config.slug, + email="testuser@example.com", + fullname="Test User", + username="testuser" + ): + request = self._create_request() + form_factory = RegistrationFormFactory() + form_desc = form_factory.get_registration_form(request) + + # Find the marketing_emails_opt_in field + marketing_field = None + for field in form_desc.fields: + if field['name'] == 'marketing_emails_opt_in': + marketing_field = field + break + + # When SAML provider config sets skip_registration_optional_checkboxes=True, + # the field should not be present in the form at all + self.assertIsNone( # noqa: PT009 + marketing_field, + "marketing_emails_opt_in field should not be present when skipped via SAML config" + ) + + @override_settings( + REGISTRATION_EXTRA_FIELDS={ + "marketing_emails_opt_in": "required" + }, + REGISTRATION_FIELD_ORDER=[] + ) + @mock.patch( + 'openedx.core.djangoapps.user_authn.views.registration_form.third_party_auth.is_enabled', + return_value=True, + ) + def test_marketing_checkbox_still_optional_when_config_false(self, mock_is_enabled): + """ + Test that when SAML provider config has skip_registration_optional_checkboxes=False, + the global REGISTRATION_EXTRA_FIELDS setting is used (required in this case). + """ + # Create a SAML provider config that doesn't skip checkboxes (default behavior) + saml_config = SAMLProviderConfigFactory( + skip_registration_optional_checkboxes=False + ) + + # Simulate running SAML authentication pipeline + with simulate_running_pipeline( + "common.djangoapps.third_party_auth.pipeline", + "tpa-saml", + idp_name=saml_config.slug, + email="testuser@example.com", + fullname="Test User", + username="testuser" + ): + request = self._create_request() + form_factory = RegistrationFormFactory() + form_desc = form_factory.get_registration_form(request) + + # Find the marketing_emails_opt_in field + marketing_field = None + for field in form_desc.fields: + if field['name'] == 'marketing_emails_opt_in': + marketing_field = field + break + + self.assertIsNotNone(marketing_field, "marketing_emails_opt_in field not found") # noqa: PT009 + # When SAML provider config sets skip_registration_optional_checkboxes=False, + # it should use the global setting (required in this test) + self.assertTrue(marketing_field.get('required', False)) # noqa: PT009 + # The field should be visible (exposed=True) when config is False + self.assertTrue( # noqa: PT009 + marketing_field.get('exposed', False), + "Marketing checkbox should be visible when SAML config is False" + ) + + @override_settings( + REGISTRATION_EXTRA_FIELDS={ + "marketing_emails_opt_in": "required" + }, + REGISTRATION_FIELD_ORDER=[] + ) + @mock.patch( + 'openedx.core.djangoapps.user_authn.views.registration_form.third_party_auth.is_enabled', + return_value=True, + ) + def test_marketing_checkbox_hidden_with_saml_config(self, mock_is_enabled): + """ + Test that when marketing checkbox is skipped via SAML provider config, + it is not present in the form at all (completely hidden). + """ + # Create a SAML provider config that skips optional checkboxes + saml_config = SAMLProviderConfigFactory( + skip_registration_optional_checkboxes=True + ) + + # Simulate running SAML authentication pipeline + with simulate_running_pipeline( + "common.djangoapps.third_party_auth.pipeline", + "tpa-saml", + idp_name=saml_config.slug, + email="testuser@example.com", + fullname="Test User", + username="testuser" + ): + request = self._create_request() + form_factory = RegistrationFormFactory() + form_desc = form_factory.get_registration_form(request) + + # Find the marketing_emails_opt_in field + marketing_field = None + for field in form_desc.fields: + if field['name'] == 'marketing_emails_opt_in': + marketing_field = field + break + + # When SAML provider config sets skip_registration_optional_checkboxes=True, + # the field should not be present in the form at all + self.assertIsNone( # noqa: PT009 + marketing_field, + "marketing_emails_opt_in field should not be present when skipped via SAML config" + ) diff --git a/openedx/core/djangoapps/user_authn/views/tests/test_utils.py b/openedx/core/djangoapps/user_authn/views/tests/test_utils.py index 397448005f85..e9fb7f71a81c 100644 --- a/openedx/core/djangoapps/user_authn/views/tests/test_utils.py +++ b/openedx/core/djangoapps/user_authn/views/tests/test_utils.py @@ -1,11 +1,20 @@ """ Tests for user utils functionality. """ -from django.test import TestCase + from datetime import datetime -from openedx.core.djangoapps.user_authn.views.utils import get_auto_generated_username, _get_username_prefix +from unittest.mock import Mock, patch + import ddt -from unittest.mock import patch +from django.db.models import Model +from django.test import TestCase +from django.test.utils import override_settings + +from openedx.core.djangoapps.user_authn.views.registration_form import ( + get_extended_profile_model, + get_registration_extension_form, +) +from openedx.core.djangoapps.user_authn.views.utils import _get_username_prefix, get_auto_generated_username @ddt.ddt @@ -15,41 +24,41 @@ class TestGenerateUsername(TestCase): """ @ddt.data( - ({'first_name': 'John', 'last_name': 'Doe'}, "JD"), - ({'name': 'Jane Smith'}, "JS"), - ({'name': 'Jane'}, "J"), - ({'name': 'John Doe Smith'}, "JD") + ({"first_name": "John", "last_name": "Doe"}, "JD"), + ({"name": "Jane Smith"}, "JS"), + ({"name": "Jane"}, "J"), + ({"name": "John Doe Smith"}, "JD"), ) @ddt.unpack def test_generate_username_from_data(self, data, expected_initials): """ Test get_auto_generated_username function. """ - random_string = 'XYZA' + random_string = "XYZA" current_year_month = f"_{datetime.now().year % 100}{datetime.now().month:02d}_" - with patch('openedx.core.djangoapps.user_authn.views.utils.random.choices') as mock_choices: - mock_choices.return_value = ['X', 'Y', 'Z', 'A'] + with patch("openedx.core.djangoapps.user_authn.views.utils.random.choices") as mock_choices: + mock_choices.return_value = ["X", "Y", "Z", "A"] username = get_auto_generated_username(data) expected_username = expected_initials + current_year_month + random_string - self.assertEqual(username, expected_username) + self.assertEqual(username, expected_username) # noqa: PT009 @ddt.data( - ({'first_name': 'John', 'last_name': 'Doe'}, "JD"), - ({'name': 'Jane Smith'}, "JS"), - ({'name': 'Jane'}, "J"), - ({'name': 'John Doe Smith'}, "JD"), - ({'first_name': 'John Doe', 'last_name': 'Smith'}, "JD"), + ({"first_name": "John", "last_name": "Doe"}, "JD"), + ({"name": "Jane Smith"}, "JS"), + ({"name": "Jane"}, "J"), + ({"name": "John Doe Smith"}, "JD"), + ({"first_name": "John Doe", "last_name": "Smith"}, "JD"), ({}, None), - ({'first_name': '', 'last_name': ''}, None), - ({'name': ''}, None), - ({'name': '='}, None), - ({'name': '@'}, None), - ({'first_name': '阿提亚', 'last_name': '阿提亚'}, "AT"), - ({'first_name': 'أحمد', 'last_name': 'محمد'}, "HM"), - ({'name': 'أحمد محمد'}, "HM"), + ({"first_name": "", "last_name": ""}, None), + ({"name": ""}, None), + ({"name": "="}, None), + ({"name": "@"}, None), + ({"first_name": "阿提亚", "last_name": "阿提亚"}, "AT"), + ({"first_name": "أحمد", "last_name": "محمد"}, "HM"), + ({"name": "أحمد محمد"}, "HM"), ) @ddt.unpack def test_get_username_prefix(self, data, expected_initials): @@ -57,23 +66,260 @@ def test_get_username_prefix(self, data, expected_initials): Test _get_username_prefix function. """ username_prefix = _get_username_prefix(data) - self.assertEqual(username_prefix, expected_initials) + self.assertEqual(username_prefix, expected_initials) # noqa: PT009 - @patch('openedx.core.djangoapps.user_authn.views.utils._get_username_prefix') - @patch('openedx.core.djangoapps.user_authn.views.utils.random.choices') - @patch('openedx.core.djangoapps.user_authn.views.utils.datetime') + @patch("openedx.core.djangoapps.user_authn.views.utils._get_username_prefix") + @patch("openedx.core.djangoapps.user_authn.views.utils.random.choices") + @patch("openedx.core.djangoapps.user_authn.views.utils.datetime") def test_get_auto_generated_username_no_prefix(self, mock_datetime, mock_choices, mock_get_username_prefix): """ Test get_auto_generated_username function when no name data is provided. """ mock_datetime.now.return_value.strftime.return_value = f"{datetime.now().year % 100} {datetime.now().month:02d}" - mock_choices.return_value = ['X', 'Y', 'Z', 'A'] # Fixed random string for testing + mock_choices.return_value = ["X", "Y", "Z", "A"] # Fixed random string for testing mock_get_username_prefix.return_value = None current_year_month = f"{datetime.now().year % 100}{datetime.now().month:02d}_" - random_string = 'XYZA' + random_string = "XYZA" expected_username = current_year_month + random_string username = get_auto_generated_username({}) - self.assertEqual(username, expected_username) + self.assertEqual(username, expected_username) # noqa: PT009 + + +@ddt.ddt +class TestGetExtendedProfileModel(TestCase): + """ + Tests for `get_extended_profile_model function + """ + + @ddt.data(None, "") + def test_get_extended_profile_model_no_setting_or_empty_string(self, setting_value: str | None): + """ + Test when `PROFILE_EXTENSION_FORM` setting is not configured + """ + with override_settings(PROFILE_EXTENSION_FORM=setting_value): + result = get_extended_profile_model() + + self.assertIsNone(result) # noqa: PT009 + + @override_settings(PROFILE_EXTENSION_FORM="invalid.module.path") + @patch("openedx.core.djangoapps.user_authn.views.registration_form.log") + def test_get_extended_profile_model_invalid_module(self, mock_logger: Mock): + """ + Test when the module path is invalid + """ + result = get_extended_profile_model() + + self.assertIsNone(result) # noqa: PT009 + mock_logger.warning.assert_called_once() + self.assertIn("Could not load extended profile model", str(mock_logger.warning.call_args)) # noqa: PT009 + + @override_settings(PROFILE_EXTENSION_FORM="django.forms.Form") + def test_get_extended_profile_model_no_meta_class(self): + """ + Test when the form class doesn't have a Meta class + """ + result = get_extended_profile_model() + + self.assertIsNone(result) # noqa: PT009 + + @override_settings(PROFILE_EXTENSION_FORM="invalid_module_path") + @patch("openedx.core.djangoapps.user_authn.views.registration_form.log") + def test_get_extended_profile_model_malformed_path(self, mock_logger: Mock): + """ + Test when the setting value doesn't have a dot separator + """ + result = get_extended_profile_model() + + self.assertIsNone(result) # noqa: PT009 + mock_logger.warning.assert_called_once() + self.assertIn("Could not load extended profile model", str(mock_logger.warning.call_args)) # noqa: PT009 + + @override_settings(PROFILE_EXTENSION_FORM="myapp.forms.CustomExtendedProfileForm") + @patch("openedx.core.djangoapps.user_authn.views.registration_form.import_module") + def test_get_extended_profile_model_custom_form(self, mock_import_module: Mock): + """ + Test loading model from a custom extended profile form + """ + mock_model = Mock(spec=Model) + mock_form_class = Mock() + mock_form_class.Meta = Mock() + mock_form_class.Meta.model = mock_model + mock_module = Mock() + mock_module.CustomExtendedProfileForm = mock_form_class + mock_import_module.return_value = mock_module + + result = get_extended_profile_model() + + self.assertEqual(result, mock_model) # noqa: PT009 + mock_import_module.assert_called_once_with("myapp.forms") + + @override_settings(PROFILE_EXTENSION_FORM="myapp.forms.FormWithoutModel") + @patch("openedx.core.djangoapps.user_authn.views.registration_form.import_module") + def test_get_extended_profile_model_form_without_model(self, mock_import_module: Mock): + """ + Test when form has Meta but no model attribute + """ + # Create a mock form class with Meta but no model + mock_form_class = Mock() + mock_form_class.Meta = Mock(spec=[]) # Meta exists but has no model attribute + # Create a mock module with the form class + mock_module = Mock() + mock_module.FormWithoutModel = mock_form_class + mock_import_module.return_value = mock_module + + result = get_extended_profile_model() + + self.assertIsNone(result) # noqa: PT009 + + @ddt.data((ImportError, "Module not found")) + @ddt.unpack + @override_settings(PROFILE_EXTENSION_FORM="myapp.forms.ExtendedProfileForm") + @patch("openedx.core.djangoapps.user_authn.views.registration_form.import_module") + @patch("openedx.core.djangoapps.user_authn.views.registration_form.log") + def test_get_extended_profile_model_import_errors( + self, exception_class: type, error_message: str, mock_logger: Mock, mock_import_module: Mock + ): + """ + Test when import_module raises ImportError or ModuleNotFoundError + """ + mock_import_module.side_effect = exception_class(error_message) + + result = get_extended_profile_model() + + self.assertIsNone(result) # noqa: PT009 + mock_logger.warning.assert_called_once() + self.assertIn("Could not load extended profile model", str(mock_logger.warning.call_args)) # noqa: PT009 + + @override_settings(PROFILE_EXTENSION_FORM="myapp.forms.NonExistentForm") + @patch("openedx.core.djangoapps.user_authn.views.registration_form.import_module") + @patch("openedx.core.djangoapps.user_authn.views.registration_form.log") + def test_get_extended_profile_model_attribute_error(self, mock_logger: Mock, mock_import_module: Mock): + """ + Test when the form class doesn't exist in the module + """ + mock_module = Mock(spec=[]) + mock_import_module.return_value = mock_module + + result = get_extended_profile_model() + + self.assertIsNone(result) # noqa: PT009 + mock_logger.warning.assert_called_once() + self.assertIn("Could not load extended profile model", str(mock_logger.warning.call_args)) # noqa: PT009 + + @override_settings(PROFILE_EXTENSION_FORM=None, REGISTRATION_EXTENSION_FORM="myapp.forms.LegacyForm") + def test_get_extended_profile_model_with_deprecated_setting_returns_none(self): + """ + Test that using REGISTRATION_EXTENSION_FORM returns None (maintains old behavior). + + This ensures backward compatibility: sites using REGISTRATION_EXTENSION_FORM + will NOT get the new model-based profile capabilities. They continue using + the old UserProfile.meta field approach. + """ + result = get_extended_profile_model() + + self.assertIsNone(result) # noqa: PT009 + + +@ddt.ddt +class TestGetRegistrationExtensionForm(TestCase): + """ + Tests for get_registration_extension_form function + """ + + @ddt.data(None, "") + def test_get_registration_extension_form_no_setting(self, setting_value: str | None): + """ + Test when neither PROFILE_EXTENSION_FORM nor REGISTRATION_EXTENSION_FORM is configured + """ + with override_settings(PROFILE_EXTENSION_FORM=setting_value, REGISTRATION_EXTENSION_FORM=setting_value): + result = get_registration_extension_form() + + self.assertIsNone(result) # noqa: PT009 + + @override_settings(PROFILE_EXTENSION_FORM="myapp.forms.CustomProfileForm") + @patch("openedx.core.djangoapps.user_authn.views.registration_form.import_module") + def test_get_registration_extension_form_with_new_setting(self, mock_import_module: Mock): + """ + Test loading form from PROFILE_EXTENSION_FORM (new setting) + """ + mock_form_instance = Mock() + mock_form_class = Mock(return_value=mock_form_instance) + mock_module = Mock() + mock_module.CustomProfileForm = mock_form_class + mock_import_module.return_value = mock_module + + result = get_registration_extension_form(data={"field": "value"}) + + self.assertEqual(result, mock_form_instance) # noqa: PT009 + mock_import_module.assert_called_once_with("myapp.forms") + mock_form_class.assert_called_once_with(data={"field": "value"}) + + @override_settings(PROFILE_EXTENSION_FORM="myapp.forms.NewForm", REGISTRATION_EXTENSION_FORM="myapp.forms.OldForm") + @patch("openedx.core.djangoapps.user_authn.views.registration_form.import_module") + def test_get_registration_extension_form_new_setting_precedence(self, mock_import_module: Mock): + """ + Test that PROFILE_EXTENSION_FORM takes precedence over REGISTRATION_EXTENSION_FORM + """ + mock_form_instance = Mock() + mock_form_class = Mock(return_value=mock_form_instance) + mock_module = Mock() + mock_module.NewForm = mock_form_class + mock_import_module.return_value = mock_module + + result = get_registration_extension_form() + + self.assertEqual(result, mock_form_instance) # noqa: PT009 + mock_import_module.assert_called_once_with("myapp.forms") + + @override_settings(PROFILE_EXTENSION_FORM=None, REGISTRATION_EXTENSION_FORM="myapp.forms.LegacyForm") + @patch("openedx.core.djangoapps.user_authn.views.registration_form.import_module") + @patch("openedx.core.djangoapps.user_authn.views.registration_form.log") + def test_get_registration_extension_form_deprecation_warning(self, mock_logger: Mock, mock_import_module: Mock): + """ + Test that using REGISTRATION_EXTENSION_FORM logs a deprecation warning + """ + mock_form_instance = Mock() + mock_form_class = Mock(return_value=mock_form_instance) + mock_module = Mock() + mock_module.LegacyForm = mock_form_class + mock_import_module.return_value = mock_module + + result = get_registration_extension_form() + + self.assertEqual(result, mock_form_instance) # noqa: PT009 + deprecation_calls = [call for call in mock_logger.warning.call_args_list if "deprecated" in str(call).lower()] + self.assertGreater(len(deprecation_calls), 0, "Expected a deprecation warning to be logged") # noqa: PT009 + warning_message = str(deprecation_calls[0]) + self.assertIn("REGISTRATION_EXTENSION_FORM", warning_message) # noqa: PT009 + self.assertIn("PROFILE_EXTENSION_FORM", warning_message) # noqa: PT009 + + @override_settings(PROFILE_EXTENSION_FORM="invalid.path") + @patch("openedx.core.djangoapps.user_authn.views.registration_form.import_module") + @patch("openedx.core.djangoapps.user_authn.views.registration_form.log") + def test_get_registration_extension_form_import_error(self, mock_logger: Mock, mock_import_module: Mock): + """ + Test when form import fails + """ + mock_import_module.side_effect = ImportError("Module not found") + + result = get_registration_extension_form() + + self.assertIsNone(result) # noqa: PT009 + error_calls = mock_logger.error.call_args_list + self.assertGreater(len(error_calls), 0, "Expected an error to be logged") # noqa: PT009 + + @override_settings(PROFILE_EXTENSION_FORM="invalid_path_without_dot") + @patch("openedx.core.djangoapps.user_authn.views.registration_form.log") + def test_get_registration_extension_form_malformed_path(self, mock_logger: Mock): + """ + Test when setting value doesn't have proper format (no dot separator) + """ + result = get_registration_extension_form() + + self.assertIsNone(result) # noqa: PT009 + + error_calls = mock_logger.error.call_args_list + self.assertGreater(len(error_calls), 0, "Expected an error to be logged") # noqa: PT009 diff --git a/openedx/core/djangoapps/user_authn/views/utils.py b/openedx/core/djangoapps/user_authn/views/utils.py index 14eb91d38efb..56ecf37c6f5c 100644 --- a/openedx/core/djangoapps/user_authn/views/utils.py +++ b/openedx/core/djangoapps/user_authn/views/utils.py @@ -2,8 +2,11 @@ User Auth Views Utils """ import logging +import random import re -from typing import Dict +import string +from datetime import datetime +from typing import Dict # noqa: UP035 from django.conf import settings from django.contrib import messages @@ -15,11 +18,8 @@ from common.djangoapps.third_party_auth import pipeline from common.djangoapps.third_party_auth.models import clean_username from openedx.core.djangoapps.embargo.models import GlobalRestrictedCountry -from openedx.core.djangoapps.site_configuration import helpers as configuration_helpers from openedx.core.djangoapps.geoinfo.api import country_code_from_ip -import random -import string -from datetime import datetime +from openedx.core.djangoapps.site_configuration import helpers as configuration_helpers log = logging.getLogger(__name__) API_V1 = 'v1' @@ -52,7 +52,8 @@ def third_party_auth_context(request, redirect_to, tpa_hint=None): "errorMessage": None, "registerFormSubmitButtonText": _("Create Account"), "syncLearnerProfileData": False, - "pipeline_user_details": {} + "pipeline_user_details": {}, + "skipRegistrationOptionalCheckboxes": False } if third_party_auth.is_enabled(): @@ -96,6 +97,12 @@ def third_party_auth_context(request, redirect_to, tpa_hint=None): # As a reliable way of "skipping" the registration form, we just submit it automatically context["autoSubmitRegForm"] = True + # Check if SAML provider wants to skip optional checkboxes + if hasattr(current_provider, 'skip_registration_optional_checkboxes'): + context["skipRegistrationOptionalCheckboxes"] = ( + current_provider.skip_registration_optional_checkboxes + ) + # Check for any error messages we may want to display: for msg in messages.get_messages(request): if msg.extra_tags.split()[0] == "social-auth": @@ -182,7 +189,7 @@ def get_auto_generated_username(data): return f"{username_prefix}_{username_suffix}" if username_prefix else username_suffix -def remove_disabled_country_from_list(countries: Dict) -> Dict: +def remove_disabled_country_from_list(countries: Dict) -> Dict: # noqa: UP006 """ Remove disabled countries from the list of countries. diff --git a/openedx/core/djangoapps/util/apps.py b/openedx/core/djangoapps/util/apps.py index e194fd7b5110..8ad7c426826a 100644 --- a/openedx/core/djangoapps/util/apps.py +++ b/openedx/core/djangoapps/util/apps.py @@ -18,5 +18,5 @@ def ready(self): """ Registers signal handlers at startup. """ - import openedx.core.djangoapps.util.signals # pylint: disable=unused-import, unused-variable import openedx.core.djangoapps.util.checks # pylint: disable=unused-import, unused-variable + import openedx.core.djangoapps.util.signals # pylint: disable=unused-import, unused-variable # noqa: F401 diff --git a/openedx/core/djangoapps/util/checks.py b/openedx/core/djangoapps/util/checks.py index 9d06dd58b9cf..4376831f6a0e 100644 --- a/openedx/core/djangoapps/util/checks.py +++ b/openedx/core/djangoapps/util/checks.py @@ -4,7 +4,6 @@ from django.conf import settings from django.core import checks - _DEVSTACK_SETTINGS_MODULES = [ "lms.envs.devstack", "cms.envs.devstack", diff --git a/openedx/core/djangoapps/util/forms.py b/openedx/core/djangoapps/util/forms.py index eb37ff696064..b2f6917932a3 100644 --- a/openedx/core/djangoapps/util/forms.py +++ b/openedx/core/djangoapps/util/forms.py @@ -22,7 +22,7 @@ class MultiValueField(Field): """ widget = MultipleHiddenInput - def to_python(self, list_of_string_values): # lint-amnesty, pylint: disable=arguments-differ + def to_python(self, list_of_string_values): # pylint: disable=arguments-differ """ Convert the form input to a list of strings """ @@ -37,7 +37,7 @@ def to_python(self, list_of_string_values): # lint-amnesty, pylint: disable=arg return values - def validate(self, values): # lint-amnesty, pylint: disable=arguments-differ + def validate(self, values): # pylint: disable=arguments-differ """ Ensure no empty values were passed """ diff --git a/openedx/core/djangoapps/util/management/commands/print_setting.py b/openedx/core/djangoapps/util/management/commands/print_setting.py index c53f49d23a19..6353d8a51333 100644 --- a/openedx/core/djangoapps/util/management/commands/print_setting.py +++ b/openedx/core/djangoapps/util/management/commands/print_setting.py @@ -44,7 +44,7 @@ def handle(self, *args, **options): for setting in settings_to_print: if not hasattr(settings, setting): - raise CommandError('%s not found in settings.' % setting) + raise CommandError('%s not found in settings.' % setting) # noqa: UP031 setting_value = getattr(settings, setting) diff --git a/openedx/core/djangoapps/util/management/commands/reset_db.py b/openedx/core/djangoapps/util/management/commands/reset_db.py index 23f100925b41..3d8462c47b3c 100644 --- a/openedx/core/djangoapps/util/management/commands/reset_db.py +++ b/openedx/core/djangoapps/util/management/commands/reset_db.py @@ -13,15 +13,15 @@ """ +import configparser import logging -import configparser import django from django.conf import settings from django.core.management.base import BaseCommand, CommandError -class Command(BaseCommand): # lint-amnesty, pylint: disable=missing-class-docstring +class Command(BaseCommand): # pylint: disable=missing-class-docstring help = "Resets the database for this project." def add_arguments(self, parser): @@ -29,7 +29,7 @@ def add_arguments(self, parser): '-R', '--router', action='store', dest='router', default='default', help='Use this router-database other than defined in settings.py') - def handle(self, *args, **options): # lint-amnesty, pylint: disable=too-many-statements + def handle(self, *args, **options): # pylint: disable=too-many-statements """ Resets the database for this project. @@ -39,7 +39,7 @@ def handle(self, *args, **options): # lint-amnesty, pylint: disable=too-many-st router = options.get('router') dbinfo = settings.DATABASES.get(router) if dbinfo is None: - raise CommandError("Unknown database router %s" % router) + raise CommandError("Unknown database router %s" % router) # noqa: UP031 engine = dbinfo.get('ENGINE').split('.')[-1] @@ -83,19 +83,19 @@ def handle(self, *args, **options): # lint-amnesty, pylint: disable=too-many-st kwargs['port'] = int(database_port) connection = Database.connect(**kwargs) - drop_query = 'DROP DATABASE IF EXISTS `%s`' % database_name + drop_query = 'DROP DATABASE IF EXISTS `%s`' % database_name # noqa: UP031 utf8_support = 'CHARACTER SET utf8' create_query = f'CREATE DATABASE `{database_name}` {utf8_support}' - logging.info('Executing... "' + drop_query + '"') # lint-amnesty, pylint: disable=logging-not-lazy + logging.info('Executing... "' + drop_query + '"') # pylint: disable=logging-not-lazy connection.query(drop_query) - logging.info('Executing... "' + create_query + '"') # lint-amnesty, pylint: disable=logging-not-lazy + logging.info('Executing... "' + create_query + '"') # pylint: disable=logging-not-lazy connection.query(create_query) elif engine in ('postgresql', 'postgresql_psycopg2', 'postgis'): if engine == 'postgresql' and django.VERSION < (1, 9): - import psycopg as Database # NOQA # lint-amnesty, pylint: disable=import-error + import psycopg as Database # NOQA # pylint: disable=import-error elif engine in ('postgresql', 'postgresql_psycopg2', 'postgis'): - import psycopg2 as Database # NOQA # lint-amnesty, pylint: disable=import-error + import psycopg2 as Database # NOQA # pylint: disable=import-error conn_params = {'database': 'template1'} if user: @@ -111,35 +111,35 @@ def handle(self, *args, **options): # lint-amnesty, pylint: disable=too-many-st connection.set_isolation_level(0) # autocommit false cursor = connection.cursor() - drop_query = "DROP DATABASE \"%s\";" % database_name - logging.info('Executing... "' + drop_query + '"') # lint-amnesty, pylint: disable=logging-not-lazy + drop_query = "DROP DATABASE \"%s\";" % database_name # noqa: UP031 + logging.info('Executing... "' + drop_query + '"') # pylint: disable=logging-not-lazy try: cursor.execute(drop_query) except Database.ProgrammingError as e: logging.exception("Error: %s", e) - create_query = "CREATE DATABASE \"%s\"" % database_name + create_query = "CREATE DATABASE \"%s\"" % database_name # noqa: UP031 if owner: - create_query += " WITH OWNER = \"%s\" " % owner + create_query += " WITH OWNER = \"%s\" " % owner # noqa: UP031 create_query += " ENCODING = 'UTF8'" if engine == 'postgis' and django.VERSION < (1, 9): # For PostGIS 1.5, fetch template name if it exists from django.contrib.gis.db.backends.postgis.base import DatabaseWrapper - postgis_template = DatabaseWrapper(dbinfo).template_postgis # lint-amnesty, pylint: disable=no-member + postgis_template = DatabaseWrapper(dbinfo).template_postgis # pylint: disable=no-member if postgis_template is not None: - create_query += ' TEMPLATE = %s' % postgis_template + create_query += ' TEMPLATE = %s' % postgis_template # noqa: UP031 if settings.DEFAULT_TABLESPACE: - create_query += ' TABLESPACE = %s;' % settings.DEFAULT_TABLESPACE + create_query += ' TABLESPACE = %s;' % settings.DEFAULT_TABLESPACE # noqa: UP031 else: create_query += ';' - logging.info('Executing... "' + create_query + '"') # lint-amnesty, pylint: disable=logging-not-lazy + logging.info('Executing... "' + create_query + '"') # pylint: disable=logging-not-lazy cursor.execute(create_query) else: - raise CommandError("Unknown database engine %s" % engine) + raise CommandError("Unknown database engine %s" % engine) # noqa: UP031 if verbosity >= 2: print("Reset successful.") diff --git a/openedx/core/djangoapps/util/model_utils.py b/openedx/core/djangoapps/util/model_utils.py index e234edf084ea..858b22f40c5b 100644 --- a/openedx/core/djangoapps/util/model_utils.py +++ b/openedx/core/djangoapps/util/model_utils.py @@ -1,4 +1,4 @@ -# lint-amnesty, pylint: disable=missing-module-docstring +# pylint: disable=missing-module-docstring class Creator: """ A placeholder class that provides a way to set the attribute on the model. @@ -6,7 +6,7 @@ class Creator: def __init__(self, field): self.field = field - def __get__(self, obj, type=None): # lint-amnesty, pylint: disable=redefined-builtin + def __get__(self, obj, type=None): # pylint: disable=redefined-builtin if obj is None: return self return obj.__dict__[self.field.name] @@ -24,5 +24,5 @@ def contribute_to_class(self, cls, name, *args, **kwargs): super().contribute_to_class(cls, name, *args, **kwargs) setattr(cls, name, Creator(self)) - def from_db_value(self, value, expression, connection): # lint-amnesty, pylint: disable=unused-argument + def from_db_value(self, value, expression, connection): # pylint: disable=unused-argument return self.to_python(value) diff --git a/openedx/core/djangoapps/util/row_delete.py b/openedx/core/djangoapps/util/row_delete.py index a0ecc240b210..ab9189baadc1 100644 --- a/openedx/core/djangoapps/util/row_delete.py +++ b/openedx/core/djangoapps/util/row_delete.py @@ -62,7 +62,7 @@ def delete_rows(model_mgr, # The "as id" below fools Django raw query into thinking the primary key is being queried. # It's necessary because Django will throw an exception if the raw SQL does not query the primary key. min_max_ids = model_mgr.raw( - f'SELECT MIN({primary_id_name}) as id, MAX({primary_id_name}) as max_id FROM {table_name}' # lint-amnesty, pylint: disable=duplicate-string-formatting-argument + f'SELECT MIN({primary_id_name}) as id, MAX({primary_id_name}) as max_id FROM {table_name}' # pylint: disable=duplicate-string-formatting-argument )[0] min_id = min_max_ids.id max_id = min_max_ids.max_id @@ -81,7 +81,7 @@ def delete_rows(model_mgr, log.info("Deleting around %s rows between ids %s and %s...", deletions_now, lower_id, upper_id) with transaction.atomic(): # xss-lint: disable=python-wrap-html - delete_sql = 'DELETE FROM {} WHERE {} >= {} AND {} < {}'.format( # lint-amnesty, pylint: disable=duplicate-string-formatting-argument + delete_sql = 'DELETE FROM {} WHERE {} >= {} AND {} < {}'.format( # pylint: disable=duplicate-string-formatting-argument # noqa: UP032 table_name, primary_id_name, lower_id, primary_id_name, upper_id ) log.info(delete_sql) @@ -113,7 +113,7 @@ def add_arguments(self, parser): '--chunk_size', default=self.DEFAULT_CHUNK_SIZE, type=int, - help='Maximum number of rows to delete in each DB transaction. Choose this value carefully to avoid DB outages!' # lint-amnesty, pylint: disable=line-too-long + help='Maximum number of rows to delete in each DB transaction. Choose this value carefully to avoid DB outages!' # pylint: disable=line-too-long ) parser.add_argument( '--sleep_between', diff --git a/openedx/core/djangoapps/util/signals.py b/openedx/core/djangoapps/util/signals.py index ec7474b41ba0..dd6267f8dca4 100644 --- a/openedx/core/djangoapps/util/signals.py +++ b/openedx/core/djangoapps/util/signals.py @@ -19,7 +19,7 @@ def record_request_exception(sender, **kwargs): Logs the stack trace whenever an exception occurs in processing a request. """ - logging.exception("Uncaught exception from {sender}".format( + logging.exception("Uncaught exception from {sender}".format( # noqa: UP032 sender=sender )) diff --git a/openedx/core/djangoapps/util/test_forms.py b/openedx/core/djangoapps/util/test_forms.py index 9f6c585848ee..cd8f7ee33f99 100644 --- a/openedx/core/djangoapps/util/test_forms.py +++ b/openedx/core/djangoapps/util/test_forms.py @@ -28,7 +28,7 @@ def assert_valid(self, expected_cleaned_data): Check that the form returns the expected data """ form = self.get_form(expected_valid=True) - self.assertDictEqual(form.cleaned_data, expected_cleaned_data) + self.assertDictEqual(form.cleaned_data, expected_cleaned_data) # noqa: PT009 def assert_field_value(self, field, expected_value): """ diff --git a/openedx/core/djangoapps/util/testing.py b/openedx/core/djangoapps/util/testing.py index 4686bdc6e75d..feb177e4bbea 100644 --- a/openedx/core/djangoapps/util/testing.py +++ b/openedx/core/djangoapps/util/testing.py @@ -2,19 +2,23 @@ from datetime import datetime - from zoneinfo import ZoneInfo +from common.djangoapps.student.tests.factories import CourseEnrollmentFactory, UserFactory from openedx.core.djangoapps.course_groups.models import CourseUserGroupPartitionGroup from openedx.core.djangoapps.course_groups.tests.helpers import CohortFactory from openedx.core.djangoapps.django_comment_common.models import Role from openedx.core.djangoapps.django_comment_common.utils import seed_permissions_roles from openedx.core.djangoapps.user_api.tests.factories import UserCourseTagFactory from openedx.core.lib.teams_config import TeamsConfig -from common.djangoapps.student.tests.factories import CourseEnrollmentFactory, UserFactory -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory, BlockFactory # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.partitions.partitions import Group, UserPartition # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + ModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import ( # pylint: disable=wrong-import-order + BlockFactory, + CourseFactory, +) +from xmodule.partitions.partitions import Group, UserPartition # pylint: disable=wrong-import-order class ContentGroupTestCase(ModuleStoreTestCase): diff --git a/openedx/core/djangoapps/util/tests/test_dump_settings.py b/openedx/core/djangoapps/util/tests/test_dump_settings.py index 90171eb48c95..830d2c0be280 100644 --- a/openedx/core/djangoapps/util/tests/test_dump_settings.py +++ b/openedx/core/djangoapps/util/tests/test_dump_settings.py @@ -10,7 +10,7 @@ from django.core.management import call_command -from openedx.core.djangolib.testing.utils import skip_unless_lms, skip_unless_cms +from openedx.core.djangolib.testing.utils import skip_unless_cms, skip_unless_lms @skip_unless_lms diff --git a/openedx/core/djangoapps/util/tests/test_print_setting.py b/openedx/core/djangoapps/util/tests/test_print_setting.py index 18a319e32e3c..d05a2a5fdccf 100644 --- a/openedx/core/djangoapps/util/tests/test_print_setting.py +++ b/openedx/core/djangoapps/util/tests/test_print_setting.py @@ -1,9 +1,9 @@ -# lint-amnesty, pylint: disable=missing-module-docstring +# pylint: disable=missing-module-docstring import pytest from django.core.management import CommandError, call_command -def test_without_args(capsys): # lint-amnesty, pylint: disable=unused-argument +def test_without_args(capsys): # pylint: disable=unused-argument with pytest.raises(CommandError, match='Error: the following arguments are required: setting'): call_command('print_setting') @@ -11,6 +11,6 @@ def test_without_args(capsys): # lint-amnesty, pylint: disable=unused-argument def test_with_setting_args(capsys): call_command('print_setting', 'DEBUG') - out, err = capsys.readouterr() # lint-amnesty, pylint: disable=unused-variable + out, err = capsys.readouterr() # pylint: disable=unused-variable assert 'False' in out assert 'INSTALLED_APPS' not in out diff --git a/openedx/core/djangoapps/util/tests/test_signals.py b/openedx/core/djangoapps/util/tests/test_signals.py index 168476fbfba6..73f5c7bfa968 100644 --- a/openedx/core/djangoapps/util/tests/test_signals.py +++ b/openedx/core/djangoapps/util/tests/test_signals.py @@ -2,11 +2,11 @@ from unittest import TestCase -from pytest import mark from celery import shared_task from django.test.utils import override_settings from edx_django_utils.cache import RequestCache +from pytest import mark # noqa: PT013 @mark.django_db diff --git a/openedx/core/djangoapps/util/tests/test_user_messages.py b/openedx/core/djangoapps/util/tests/test_user_messages.py index 4aebf1fbac21..fbc9f196b9b9 100644 --- a/openedx/core/djangoapps/util/tests/test_user_messages.py +++ b/openedx/core/djangoapps/util/tests/test_user_messages.py @@ -9,9 +9,9 @@ from django.contrib.messages.middleware import MessageMiddleware from django.test import RequestFactory, TestCase +from common.djangoapps.student.tests.factories import UserFactory from common.test.utils import normalize_repr from openedx.core.djangolib.markup import HTML, Text -from common.djangoapps.student.tests.factories import UserFactory from ..user_messages import PageLevelMessages, UserMessageType diff --git a/openedx/core/djangoapps/util/user_messages.py b/openedx/core/djangoapps/util/user_messages.py index 2b6962f39f55..1f951e81526d 100644 --- a/openedx/core/djangoapps/util/user_messages.py +++ b/openedx/core/djangoapps/util/user_messages.py @@ -52,11 +52,11 @@ class UserMessageType(Enum): } -class UserMessage(): +class UserMessage(): # noqa: UP039 """ Representation of a message to be shown to a user. """ - def __init__(self, type, message_html): # lint-amnesty, pylint: disable=redefined-builtin + def __init__(self, type, message_html): # pylint: disable=redefined-builtin assert isinstance(type, UserMessageType) self.type = type self.message_html = message_html @@ -76,13 +76,13 @@ def icon_class(self): return ICON_CLASSES[self.type] -class UserMessageCollection(): +class UserMessageCollection(): # noqa: UP039 """ A collection of messages to be shown to a user. """ @classmethod @abstractmethod - def get_namespace(self): # lint-amnesty, pylint: disable=bad-classmethod-argument + def get_namespace(self): # pylint: disable=bad-classmethod-argument """ Returns the namespace of the message collection. @@ -127,35 +127,35 @@ def register_user_message(cls, request, message_type, body_html, once_only=False messages.add_message(request, message_type.value, Text(message), extra_tags=cls.get_namespace()) @classmethod - def register_info_message(self, request, message, **kwargs): # lint-amnesty, pylint: disable=bad-classmethod-argument + def register_info_message(self, request, message, **kwargs): # pylint: disable=bad-classmethod-argument """ Registers an information message to be shown to the user. """ self.register_user_message(request, UserMessageType.INFO, message, **kwargs) @classmethod - def register_success_message(self, request, message, **kwargs): # lint-amnesty, pylint: disable=bad-classmethod-argument + def register_success_message(self, request, message, **kwargs): # pylint: disable=bad-classmethod-argument """ Registers a success message to be shown to the user. """ self.register_user_message(request, UserMessageType.SUCCESS, message, **kwargs) @classmethod - def register_warning_message(self, request, message, **kwargs): # lint-amnesty, pylint: disable=bad-classmethod-argument + def register_warning_message(self, request, message, **kwargs): # pylint: disable=bad-classmethod-argument """ Registers a warning message to be shown to the user. """ self.register_user_message(request, UserMessageType.WARNING, message, **kwargs) @classmethod - def register_error_message(self, request, message, **kwargs): # lint-amnesty, pylint: disable=bad-classmethod-argument + def register_error_message(self, request, message, **kwargs): # pylint: disable=bad-classmethod-argument """ Registers an error message to be shown to the user. """ self.register_user_message(request, UserMessageType.ERROR, message, **kwargs) @classmethod - def user_messages(self, request): # lint-amnesty, pylint: disable=bad-classmethod-argument + def user_messages(self, request): # pylint: disable=bad-classmethod-argument """ Returns any outstanding user messages. @@ -166,7 +166,7 @@ def _get_message_type_for_level(level): """ Returns the user message type associated with a level. """ - for __, type in UserMessageType.__members__.items(): # lint-amnesty, pylint: disable=redefined-builtin, no-member + for __, type in UserMessageType.__members__.items(): # pylint: disable=redefined-builtin, no-member if type.value is level: return type raise Exception(f'Unable to find UserMessageType for level {level}') @@ -228,7 +228,7 @@ def user_messages(cls, request): message_html=str(cls.get_message_html(Text(notice_message))), )) except BaseException as e: - warnings.warn(f"Could not register global notice: {e!r}", UserWarning) + warnings.warn(f"Could not register global notice: {e!r}", UserWarning) # noqa: B028 return msgs @@ -266,7 +266,7 @@ def get_message_html(cls, body_html, title=None, dismissable=False, **kwargs): ) @classmethod - def get_namespace(self): # lint-amnesty, pylint: disable=bad-classmethod-argument + def get_namespace(self): # pylint: disable=bad-classmethod-argument """ Returns the namespace of the message collection. """ diff --git a/openedx/core/djangoapps/verified_track_content/partition_scheme.py b/openedx/core/djangoapps/verified_track_content/partition_scheme.py index e0472ce10ebc..7e5a72873ac0 100644 --- a/openedx/core/djangoapps/verified_track_content/partition_scheme.py +++ b/openedx/core/djangoapps/verified_track_content/partition_scheme.py @@ -9,13 +9,13 @@ from opaque_keys.edx.keys import CourseKey from common.djangoapps.course_modes.models import CourseMode +from common.djangoapps.student.models import CourseEnrollment from lms.djangoapps.courseware.masquerade import ( get_course_masquerade, get_masquerading_user_group, - is_masquerading_as_specific_student + is_masquerading_as_specific_student, ) -from common.djangoapps.student.models import CourseEnrollment -from xmodule.partitions.partitions import Group, UserPartition # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.partitions.partitions import Group, UserPartition # pylint: disable=wrong-import-order LOGGER = logging.getLogger(__name__) diff --git a/openedx/core/djangoapps/verified_track_content/tests/test_partition_scheme.py b/openedx/core/djangoapps/verified_track_content/tests/test_partition_scheme.py index f7de6042ef19..4e2dfd6f0970 100644 --- a/openedx/core/djangoapps/verified_track_content/tests/test_partition_scheme.py +++ b/openedx/core/djangoapps/verified_track_content/tests/test_partition_scheme.py @@ -4,15 +4,22 @@ from datetime import datetime, timedelta - from zoneinfo import ZoneInfo + import pytest + from common.djangoapps.course_modes.models import CourseMode from common.djangoapps.student.models import CourseEnrollment from common.djangoapps.student.tests.factories import UserFactory -from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.partitions.partitions import MINIMUM_UNUSED_PARTITION_ID, UserPartition, ReadOnlyUserPartitionError # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + SharedModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order +from xmodule.partitions.partitions import ( # pylint: disable=wrong-import-order + MINIMUM_UNUSED_PARTITION_ID, + ReadOnlyUserPartitionError, + UserPartition, +) from ..partition_scheme import ENROLLMENT_GROUP_IDS, EnrollmentTrackPartitionScheme, EnrollmentTrackUserPartition @@ -94,7 +101,7 @@ def setUpClass(cls): def test_get_scheme(self): """ - Ensure that the scheme extension is correctly plugged in (via entry point in setup.py) + Ensure that the scheme extension is correctly plugged in (via entry point in pyproject.toml) """ assert UserPartition.get_scheme('enrollment_track') == EnrollmentTrackPartitionScheme diff --git a/openedx/core/djangoapps/video_config/admin.py b/openedx/core/djangoapps/video_config/admin.py index f58277ec9a20..9e06eaa24299 100644 --- a/openedx/core/djangoapps/video_config/admin.py +++ b/openedx/core/djangoapps/video_config/admin.py @@ -8,15 +8,19 @@ from openedx.core.djangoapps.video_config.forms import ( CourseHLSPlaybackFlagAdminForm, - CourseYoutubeBlockedFlagAdminForm, CourseVideoTranscriptFlagAdminForm, + CourseYoutubeBlockedFlagAdminForm, ) from openedx.core.djangoapps.video_config.models import ( - CourseHLSPlaybackEnabledFlag, HLSPlaybackEnabledFlag, + CourseHLSPlaybackEnabledFlag, + CourseVideoTranscriptEnabledFlag, CourseYoutubeBlockedFlag, - CourseVideoTranscriptEnabledFlag, VideoTranscriptEnabledFlag, - TranscriptMigrationSetting, MigrationEnqueuedCourse, - VideoThumbnailSetting, UpdatedCourseVideos, + HLSPlaybackEnabledFlag, + MigrationEnqueuedCourse, + TranscriptMigrationSetting, + UpdatedCourseVideos, + VideoThumbnailSetting, + VideoTranscriptEnabledFlag, ) diff --git a/openedx/core/djangoapps/video_config/forms.py b/openedx/core/djangoapps/video_config/forms.py index 7caec4e8afb9..e0071154bb07 100644 --- a/openedx/core/djangoapps/video_config/forms.py +++ b/openedx/core/djangoapps/video_config/forms.py @@ -8,8 +8,8 @@ from openedx.core.djangoapps.video_config.models import ( CourseHLSPlaybackEnabledFlag, - CourseYoutubeBlockedFlag, CourseVideoTranscriptEnabledFlag, + CourseYoutubeBlockedFlag, ) from openedx.core.lib.courses import clean_course_id @@ -39,7 +39,7 @@ class CourseHLSPlaybackFlagAdminForm(CourseSpecificFlagAdminBaseForm): class Meta: model = CourseHLSPlaybackEnabledFlag - fields = '__all__' + fields = '__all__' # noqa: DJ007 class CourseYoutubeBlockedFlagAdminForm(CourseSpecificFlagAdminBaseForm): @@ -49,7 +49,7 @@ class CourseYoutubeBlockedFlagAdminForm(CourseSpecificFlagAdminBaseForm): class Meta: model = CourseYoutubeBlockedFlag - fields = '__all__' + fields = '__all__' # noqa: DJ007 class CourseVideoTranscriptFlagAdminForm(CourseSpecificFlagAdminBaseForm): @@ -59,4 +59,4 @@ class CourseVideoTranscriptFlagAdminForm(CourseSpecificFlagAdminBaseForm): class Meta: model = CourseVideoTranscriptEnabledFlag - fields = '__all__' + fields = '__all__' # noqa: DJ007 diff --git a/openedx/core/djangoapps/video_config/migrations/0001_initial.py b/openedx/core/djangoapps/video_config/migrations/0001_initial.py index 1ed36c753d81..10db5c407404 100644 --- a/openedx/core/djangoapps/video_config/migrations/0001_initial.py +++ b/openedx/core/djangoapps/video_config/migrations/0001_initial.py @@ -1,6 +1,6 @@ -from django.db import migrations, models -from django.conf import settings import django.db.models.deletion +from django.conf import settings +from django.db import migrations, models from opaque_keys.edx.django.models import CourseKeyField diff --git a/openedx/core/djangoapps/video_config/migrations/0002_coursevideotranscriptenabledflag_videotranscriptenabledflag.py b/openedx/core/djangoapps/video_config/migrations/0002_coursevideotranscriptenabledflag_videotranscriptenabledflag.py index 8b68ddff0dc9..6d0d403b01e3 100644 --- a/openedx/core/djangoapps/video_config/migrations/0002_coursevideotranscriptenabledflag_videotranscriptenabledflag.py +++ b/openedx/core/djangoapps/video_config/migrations/0002_coursevideotranscriptenabledflag_videotranscriptenabledflag.py @@ -1,6 +1,6 @@ -from django.db import migrations, models -from django.conf import settings import django.db.models.deletion +from django.conf import settings +from django.db import migrations, models from opaque_keys.edx.django.models import CourseKeyField diff --git a/openedx/core/djangoapps/video_config/migrations/0003_transcriptmigrationsetting.py b/openedx/core/djangoapps/video_config/migrations/0003_transcriptmigrationsetting.py index 50f398eee56f..67e8f8a05b8a 100644 --- a/openedx/core/djangoapps/video_config/migrations/0003_transcriptmigrationsetting.py +++ b/openedx/core/djangoapps/video_config/migrations/0003_transcriptmigrationsetting.py @@ -1,6 +1,6 @@ -from django.db import migrations, models import django.db.models.deletion from django.conf import settings +from django.db import migrations, models class Migration(migrations.Migration): diff --git a/openedx/core/djangoapps/video_config/migrations/0005_auto_20180719_0752.py b/openedx/core/djangoapps/video_config/migrations/0005_auto_20180719_0752.py index d6baf0109746..87289b50bf4c 100644 --- a/openedx/core/djangoapps/video_config/migrations/0005_auto_20180719_0752.py +++ b/openedx/core/djangoapps/video_config/migrations/0005_auto_20180719_0752.py @@ -1,10 +1,10 @@ # Generated by Django 1.11.14 on 2018-07-19 07:52 -from django.db import migrations, models import django.utils.timezone import model_utils.fields import opaque_keys.edx.django.models +from django.db import migrations, models class Migration(migrations.Migration): diff --git a/openedx/core/djangoapps/video_config/migrations/0006_videothumbnailetting_updatedcoursevideos.py b/openedx/core/djangoapps/video_config/migrations/0006_videothumbnailetting_updatedcoursevideos.py index 9856bc5024d7..2dc0f66d6080 100644 --- a/openedx/core/djangoapps/video_config/migrations/0006_videothumbnailetting_updatedcoursevideos.py +++ b/openedx/core/djangoapps/video_config/migrations/0006_videothumbnailetting_updatedcoursevideos.py @@ -1,12 +1,12 @@ # Generated by Django 1.11.15 on 2018-08-15 19:13 -from django.conf import settings -from django.db import migrations, models import django.db.models.deletion import django.utils.timezone import model_utils.fields import opaque_keys.edx.django.models +from django.conf import settings +from django.db import migrations, models class Migration(migrations.Migration): diff --git a/openedx/core/djangoapps/video_config/migrations/0008_courseyoutubeblockedflag.py b/openedx/core/djangoapps/video_config/migrations/0008_courseyoutubeblockedflag.py index 4632bb044a48..b10f1148bfa4 100644 --- a/openedx/core/djangoapps/video_config/migrations/0008_courseyoutubeblockedflag.py +++ b/openedx/core/djangoapps/video_config/migrations/0008_courseyoutubeblockedflag.py @@ -1,10 +1,10 @@ # Generated by Django 1.11.23 on 2019-08-25 16:11 -from django.conf import settings -from django.db import migrations, models import django.db.models.deletion import opaque_keys.edx.django.models +from django.conf import settings +from django.db import migrations, models class Migration(migrations.Migration): diff --git a/openedx/core/djangoapps/video_config/models.py b/openedx/core/djangoapps/video_config/models.py index 9a54585475f2..16051fb1acf3 100644 --- a/openedx/core/djangoapps/video_config/models.py +++ b/openedx/core/djangoapps/video_config/models.py @@ -58,7 +58,7 @@ def feature_enabled(cls, course_id): def __str__(self): current_model = HLSPlaybackEnabledFlag.current() - return "HLSPlaybackEnabledFlag: enabled {is_enabled}".format( + return "HLSPlaybackEnabledFlag: enabled {is_enabled}".format( # noqa: UP032 is_enabled=current_model.is_enabled() ) @@ -87,7 +87,7 @@ def __str__(self): if self.enabled: not_en = "" - return "Course '{course_key}': HLS Playback {not_enabled}Enabled".format( + return "Course '{course_key}': HLS Playback {not_enabled}Enabled".format( # noqa: UP032 course_key=str(self.course_id), not_enabled=not_en ) @@ -123,7 +123,7 @@ def __str__(self): if self.enabled: not_en = "" - return "Course '{course_key}': Youtube Block {not_enabled}Enabled".format( + return "Course '{course_key}': Youtube Block {not_enabled}Enabled".format( # noqa: UP032 course_key=str(self.course_id), not_enabled=not_en ) @@ -169,7 +169,7 @@ def feature_enabled(cls, course_id): def __str__(self): current_model = VideoTranscriptEnabledFlag.current() - return "VideoTranscriptEnabledFlag: enabled {is_enabled}".format( + return "VideoTranscriptEnabledFlag: enabled {is_enabled}".format( # noqa: UP032 is_enabled=current_model.is_enabled() ) @@ -192,7 +192,7 @@ def __str__(self): if self.enabled: not_en = "" - return "Course '{course_key}': Video Transcript {not_enabled}Enabled".format( + return "Course '{course_key}': Video Transcript {not_enabled}Enabled".format( # noqa: UP032 course_key=str(self.course_id), not_enabled=not_en ) @@ -251,7 +251,7 @@ class MigrationEnqueuedCourse(TimeStampedModel): command_run = PositiveIntegerField(default=0) def __str__(self): - return 'MigrationEnqueuedCourse: ID={course_id}, Run={command_run}'.format( + return 'MigrationEnqueuedCourse: ID={course_id}, Run={command_run}'.format( # noqa: UP032 course_id=self.course_id, command_run=self.command_run ) @@ -312,6 +312,6 @@ class Meta: unique_together = ('course_id', 'edx_video_id') def __str__(self): - return 'UpdatedCourseVideos: CourseID={course_id}, VideoID={video_id}, Run={command_run}'.format( + return 'UpdatedCourseVideos: CourseID={course_id}, VideoID={video_id}, Run={command_run}'.format( # noqa: UP032 course_id=self.course_id, video_id=self.edx_video_id, command_run=self.command_run ) diff --git a/openedx/core/djangoapps/video_config/services.py b/openedx/core/djangoapps/video_config/services.py index 5f2ca454eaa6..cf79cec5e1f0 100644 --- a/openedx/core/djangoapps/video_config/services.py +++ b/openedx/core/djangoapps/video_config/services.py @@ -10,35 +10,32 @@ from typing import Any from django.conf import settings -from opaque_keys.edx.keys import CourseKey, UsageKey -from opaque_keys.edx.locator import LibraryLocatorV2 -from xblocks_contrib.video.exceptions import TranscriptNotFoundError - -from openedx.core.djangoapps.video_config import sharing from django.core.files import File from django.core.files.base import ContentFile from edxval.api import create_external_video, create_or_update_video_transcript, delete_video_transcript +from opaque_keys.edx.keys import CourseKey, UsageKey +from opaque_keys.edx.locator import LibraryLocatorV2 from organizations.api import get_course_organization -from openedx.core.djangoapps.video_config.models import ( - CourseYoutubeBlockedFlag, - HLSPlaybackEnabledFlag, -) -from openedx.core.djangoapps.video_config.toggles import TRANSCRIPT_FEEDBACK -from openedx.core.djangoapps.video_pipeline.config.waffle import DEPRECATE_YOUTUBE +from xblocks_contrib.video.exceptions import TranscriptNotFoundError + from openedx.core.djangoapps.content_libraries.api import ( add_library_block_static_asset_file, delete_library_block_static_asset_file, ) +from openedx.core.djangoapps.video_config import sharing +from openedx.core.djangoapps.video_config.models import CourseYoutubeBlockedFlag, HLSPlaybackEnabledFlag +from openedx.core.djangoapps.video_config.sharing_sites import sharing_sites_info_for_video +from openedx.core.djangoapps.video_config.toggles import TRANSCRIPT_FEEDBACK from openedx.core.djangoapps.video_config.transcripts_utils import ( Transcript, clean_video_id, get_html5_ids, + get_transcript, + get_transcript_for_video, manage_video_subtitles_save, remove_subs_from_store, - get_transcript_for_video, - get_transcript, ) - +from openedx.core.djangoapps.video_pipeline.config.waffle import DEPRECATE_YOUTUBE from xmodule.exceptions import NotFoundError from xmodule.modulestore.inheritance import own_metadata @@ -93,7 +90,6 @@ def get_public_sharing_context(self, video_block, course_key: CourseKey) -> dict organization = get_course_organization(course_key) - from openedx.core.djangoapps.video_config.sharing_sites import sharing_sites_info_for_video sharing_sites_info = sharing_sites_info_for_video( public_video_url, organization=organization @@ -231,7 +227,7 @@ def upload_transcript( is_library = isinstance(video_block.usage_key.context_key, LibraryLocatorV2) content: bytes = transcript_file.read() if is_library: - # Save transcript as static asset in Learning Core if is a library component + # Save transcript as static asset in openedx_content if is a library component filename = f'static/transcript-{new_language_code}.srt' add_library_block_static_asset_file(video_block.usage_key, filename, content) else: @@ -355,7 +351,7 @@ def handle_editor_saved( def _save_transcript_field(video_block): """ - Hacky workaround to ensure that transcript field is saved for Learning Core video blocks. + Hacky workaround to ensure that transcript field is saved for openedx_content video blocks. It's not clear why this is necessary. """ diff --git a/openedx/core/djangoapps/video_config/sharing.py b/openedx/core/djangoapps/video_config/sharing.py index 4cc66cdb0530..d37a3889e2ee 100644 --- a/openedx/core/djangoapps/video_config/sharing.py +++ b/openedx/core/djangoapps/video_config/sharing.py @@ -41,7 +41,7 @@ def is_public_sharing_enabled(usage_key: UsageKey, public_access: bool) -> bool: try: # Video share feature must be enabled for sharing settings to take effect feature_enabled = PUBLIC_VIDEO_SHARE.is_enabled(usage_key.context_key) - except Exception as err: # pylint: disable=broad-except + except Exception as err: # pylint: disable=broad-except # noqa: F841 log.exception(f"Error retrieving course for course ID: {usage_key.context_key}") return False @@ -76,6 +76,6 @@ def get_course_video_sharing_override(usage_key: UsageKey) -> str | None: try: course = get_course_by_id(usage_key.context_key) return getattr(course, 'video_sharing_options', None) - except Exception as err: # pylint: disable=broad-except + except Exception as err: # pylint: disable=broad-except # noqa: F841 log.exception(f"Error retrieving course for course ID: {usage_key.context_key}") return None diff --git a/openedx/core/djangoapps/video_config/sharing_sites.py b/openedx/core/djangoapps/video_config/sharing_sites.py index 189c316760a9..880c51d1ff05 100644 --- a/openedx/core/djangoapps/video_config/sharing_sites.py +++ b/openedx/core/djangoapps/video_config/sharing_sites.py @@ -2,9 +2,10 @@ Defines the sharing sites for different social media platforms """ from collections import namedtuple +from urllib.parse import urlencode + from django.conf import settings from django.utils.translation import gettext_lazy as _ -from urllib.parse import urlencode SharingSiteConfig = namedtuple( 'SharingSiteConfig', diff --git a/openedx/core/djangoapps/video_config/tests/test_models.py b/openedx/core/djangoapps/video_config/tests/test_models.py index 3a971a252486..ab45e9f9969b 100644 --- a/openedx/core/djangoapps/video_config/tests/test_models.py +++ b/openedx/core/djangoapps/video_config/tests/test_models.py @@ -2,17 +2,18 @@ Tests for the models that configures HLS Playback feature. """ -import ddt -import itertools # lint-amnesty, pylint: disable=wrong-import-order - -from contextlib import contextmanager # lint-amnesty, pylint: disable=wrong-import-order +import itertools # pylint: disable=wrong-import-order +from contextlib import contextmanager # pylint: disable=wrong-import-order +import ddt from django.test import TestCase - from opaque_keys.edx.locator import CourseLocator + from openedx.core.djangoapps.video_config.models import ( - CourseHLSPlaybackEnabledFlag, HLSPlaybackEnabledFlag, - CourseVideoTranscriptEnabledFlag, VideoTranscriptEnabledFlag, + CourseHLSPlaybackEnabledFlag, + CourseVideoTranscriptEnabledFlag, + HLSPlaybackEnabledFlag, + VideoTranscriptEnabledFlag, ) diff --git a/openedx/core/djangoapps/video_config/tests/test_services.py b/openedx/core/djangoapps/video_config/tests/test_services.py new file mode 100644 index 000000000000..15f7464b022c --- /dev/null +++ b/openedx/core/djangoapps/video_config/tests/test_services.py @@ -0,0 +1,85 @@ +""" +Tests for VideoConfigService. +""" + +import unittest +from unittest.mock import patch + +from django.conf import settings +from opaque_keys.edx.locator import CourseLocator +from xblock.field_data import DictFieldData +from xblock.fields import ScopeIds + +from openedx.core.djangoapps.video_config.services import VideoConfigService +from xmodule.tests import get_test_descriptor_system +from xmodule.video_block import VideoBlock + + +class VideoConfigServiceTestCase(unittest.TestCase): + """ + Unit tests for the VideoConfigService class. + """ + + def instantiate_video_block(self, **field_data): + """Instantiate a video block with the given field data (e.g. data=xml_string).""" + if field_data.get('data', None): + field_data = VideoBlock.parse_video_xml(field_data['data']) + system = get_test_descriptor_system() + course_key = CourseLocator('org', 'course', 'run') + usage_key = course_key.make_usage_key('video', 'SampleProblem') + return system.construct_xblock_from_class( + VideoBlock, + scope_ids=ScopeIds(None, None, usage_key, usage_key), + field_data=DictFieldData(field_data), + ) + + def test_video_with_multiple_transcripts_translation_retrieval(self): + """ + Test translation retrieval of a video block with + multiple transcripts uploaded by a user. + """ + xml_data_transcripts = ''' + + ''' + + block = self.instantiate_video_block(data=xml_data_transcripts) + video_config_service = block.runtime.service(block, 'video_config') + assert isinstance(video_config_service, VideoConfigService) + translations = video_config_service.available_translations( + block, block.get_transcripts_info() + ) + assert sorted(translations) == sorted(['hr', 'ge']) + + def test_video_with_no_transcripts_translation_retrieval(self): + """ + Test translation retrieval of a video block with + no transcripts uploaded by a user- ie, that retrieval + does not throw an exception. + """ + block = self.instantiate_video_block(data=None) + video_config_service = block.runtime.service(block, 'video_config') + assert isinstance(video_config_service, VideoConfigService) + translations_with_fallback = video_config_service.available_translations( + block, block.get_transcripts_info() + ) + assert translations_with_fallback == ['en'] + + with patch.dict(settings.FEATURES, FALLBACK_TO_ENGLISH_TRANSCRIPTS=False): + # Some organizations don't have English transcripts for all videos + # This feature makes it configurable + translations_no_fallback = video_config_service.available_translations( + block, block.get_transcripts_info() + ) + assert translations_no_fallback == [] diff --git a/openedx/core/djangoapps/video_config/tests/test_transcripts_utils.py b/openedx/core/djangoapps/video_config/tests/test_transcripts_utils.py index 273d31444f01..6004a5cc143a 100644 --- a/openedx/core/djangoapps/video_config/tests/test_transcripts_utils.py +++ b/openedx/core/djangoapps/video_config/tests/test_transcripts_utils.py @@ -7,7 +7,7 @@ - among the fields found in a track descriptor is a caption URL (aka caption link) - use this link to obtain the track's caption data ''' -from unittest import mock, TestCase +from unittest import TestCase, mock import ddt @@ -118,7 +118,7 @@ def test_get_transcript_link_from_youtube(self, language_code, mock_get): mock_get.return_value = YoutubeVideoHTMLResponse.with_caption_track(language_code) language_specific_caption_link = get_transcript_link_from_youtube(YOUTUBE_VIDEO_ID) - self.assertEqual( + self.assertEqual( # noqa: PT009 language_specific_caption_link, {language_code: CAPTION_URL_UTF8_DECODED_TEMPLATE.format(language_code)} ) @@ -132,7 +132,7 @@ def test_get_caption_no_caption(self, language_code, mock_get): mock_get.return_value = YoutubeVideoHTMLResponse.with_caption_track(language_code) english_language_caption_link = get_transcript_link_from_youtube(YOUTUBE_VIDEO_ID) - self.assertIsNone(english_language_caption_link) + self.assertIsNone(english_language_caption_link) # noqa: PT009 @ mock.patch('requests.get') def test_get_caption_malformed_caption_locator(self, mock_get): @@ -143,4 +143,4 @@ def test_get_caption_malformed_caption_locator(self, mock_get): mock_get.return_value = YoutubeVideoHTMLResponse.with_malformed_caption_track(language_code) english_language_caption_link = get_transcript_link_from_youtube(YOUTUBE_VIDEO_ID) - self.assertIsNone(english_language_caption_link) + self.assertIsNone(english_language_caption_link) # noqa: PT009 diff --git a/openedx/core/djangoapps/video_config/transcripts_utils.py b/openedx/core/djangoapps/video_config/transcripts_utils.py index 7714680a3192..e253641b7188 100644 --- a/openedx/core/djangoapps/video_config/transcripts_utils.py +++ b/openedx/core/djangoapps/video_config/transcripts_utils.py @@ -19,18 +19,17 @@ from django.utils.translation import get_language_info from lxml import etree from opaque_keys.edx.keys import UsageKeyV2 +from opaque_keys.edx.locator import LibraryLocatorV2 from pysrt import SubRipFile, SubRipItem, SubRipTime from pysrt.srtexc import Error -from opaque_keys.edx.locator import LibraryLocatorV2 +from xblocks_contrib.video.bumper_utils import get_bumper_settings +from xblocks_contrib.video.exceptions import TranscriptsGenerationException from openedx.core.djangoapps.xblock.api import get_component_from_usage_key from xmodule.contentstore.content import StaticContent from xmodule.contentstore.django import contentstore from xmodule.exceptions import NotFoundError -from xblocks_contrib.video.exceptions import TranscriptsGenerationException - - try: from edxval import api as edxval_api except ImportError: @@ -70,7 +69,7 @@ def wrapper(*args, **kwds): return func(*args, **kwds) except (TranscriptsGenerationException, UnicodeDecodeError) as ex: log.exception(str(ex)) - raise NotFoundError # lint-amnesty, pylint: disable=raise-missing-from + raise NotFoundError # pylint: disable=raise-missing-from # noqa: B904 return wrapper @@ -197,7 +196,7 @@ def get_transcript_link_from_youtube(youtube_id): return None -def get_transcript_links_from_youtube(youtube_id, settings, i18n, youtube_transcript_name=''): # lint-amnesty, pylint: disable=redefined-outer-name +def get_transcript_links_from_youtube(youtube_id, settings, i18n, youtube_transcript_name=''): # pylint: disable=redefined-outer-name """ Gets transcripts from youtube for youtube_id. @@ -256,7 +255,7 @@ def get_transcript_from_youtube(link, youtube_id, i18n): return {'start': sub_starts, 'end': sub_ends, 'text': sub_texts} -def download_youtube_subs(youtube_id, video_block, settings): # lint-amnesty, pylint: disable=redefined-outer-name +def download_youtube_subs(youtube_id, video_block, settings): # pylint: disable=redefined-outer-name """ Download transcripts from Youtube. @@ -311,7 +310,7 @@ def generate_subs_from_source(speed_subs, subs_type, subs_filedata, block, langu msg = _("Something wrong with SubRip transcripts file during parsing. Inner message is {error_message}").format( error_message=str(ex) ) - raise TranscriptsGenerationException(msg) # lint-amnesty, pylint: disable=raise-missing-from + raise TranscriptsGenerationException(msg) # pylint: disable=raise-missing-from # noqa: B904 if not srt_subs_obj: raise TranscriptsGenerationException(_("Something wrong with SubRip transcripts file during parsing.")) @@ -469,7 +468,7 @@ def youtube_speed_dict(item): """ yt_ids = [item.youtube_id_0_75, item.youtube_id_1_0, item.youtube_id_1_25, item.youtube_id_1_5] yt_speeds = [0.75, 1.00, 1.25, 1.50] - youtube_ids = {p[0]: p[1] for p in zip(yt_ids, yt_speeds) if p[0]} + youtube_ids = {p[0]: p[1] for p in zip(yt_ids, yt_speeds) if p[0]} # noqa: B905 return youtube_ids @@ -492,7 +491,7 @@ def generate_sjson_for_all_speeds(block, user_filename, result_subs_dict, lang): try: srt_transcripts = contentstore().find(Transcript.asset_location(block.location, user_filename)) except NotFoundError as ex: - raise TranscriptException(_("{exception_message}: Can't find uploaded transcripts: {user_filename}").format( # lint-amnesty, pylint: disable=raise-missing-from + raise TranscriptException(_("{exception_message}: Can't find uploaded transcripts: {user_filename}").format( # noqa: B904 # pylint: disable=raise-missing-from,line-too-long exception_message=str(ex), user_filename=user_filename )) @@ -786,11 +785,6 @@ def get_transcripts_info(self, is_bumper=False): is_bumper(bool): If True, the request is for the bumper transcripts include_val_transcripts(bool): If True, include edx-val transcripts as well """ - # TODO: This causes a circular import when imported at the top-level. - # This import will be removed as part of the VideoBlock extraction. - # https://github.com/openedx/edx-platform/issues/36282 - from xmodule.video_block.bumper_utils import get_bumper_settings - if is_bumper: transcripts = copy.deepcopy(get_bumper_settings(self).get('transcripts', {})) sub = transcripts.pop("en", "") @@ -850,7 +844,7 @@ def get_transcript_for_video(video_location, subs_id, file_name, language): """ Get video transcript from content store. This is a lower level function and is used by `get_transcript_from_contentstore`. Prefer that function instead where possible. If you - need to support getting transcripts from VAL or Learning Core as well, use the `get_transcript` + need to support getting transcripts from VAL or openedx_content as well, use the `get_transcript` function instead. NOTE: Transcripts can be searched from content store by two ways: @@ -918,7 +912,7 @@ def get_transcript_from_contentstore(video, language, output_format, transcripts continue if transcript_content is None: - raise NotFoundError('No transcript for `{lang}` language'.format( + raise NotFoundError('No transcript for `{lang}` language'.format( # noqa: UP032 lang=language )) @@ -945,13 +939,13 @@ def build_components_import_path(usage_key, file_path): return f"components/{usage_key.block_type}/{usage_key.block_id}/{file_path}" -def get_transcript_from_learning_core(video_block, language, output_format, transcripts_info): +def get_transcript_from_openedx_content(video_block, language, output_format, transcripts_info): """ - Get video transcript from Learning Core (used for Content Libraries) + Get video transcript from the openedx_content API. Limitation: This is only going to grab from the Draft version. - Learning Core models a VideoBlock's data in a more generic thing it calls a + openedx_content models a VideoBlock's data in a more generic thing it calls a Component. Each Component has its own virtual space for file-like data. The OLX for the VideoBlock itself is stored at the root of that space, as ``block.xml``. Static assets that are meant to be user-downloadable are @@ -1015,17 +1009,17 @@ def get_transcript_from_learning_core(video_block, language, output_format, tran f"transcript files, but we tried to look up {file_path} for {usage_key}" ) - # TODO: There should be a Learning Core API call for this: + # TODO: There should be a openedx_content API call for this: try: - content = ( + media = ( component_version - .componentversioncontent_set - .filter(content__has_file=True) - .select_related('content') - .get(key=file_path) - .content + .componentversionmedia_set + .filter(media__has_file=True) + .select_related('media') + .get(path=file_path) + .media ) - data = content.read_file().read() + data = media.read_file().read() except ObjectDoesNotExist as exc: raise NotFoundError( f"No file {file_path} found for {usage_key} " @@ -1074,8 +1068,8 @@ def get_transcript(video, lang=None, output_format=Transcript.SRT, youtube_id=No lang = video.get_default_transcript_language(transcripts_info) if isinstance(video.scope_ids.usage_id, UsageKeyV2): - # This block is in Learning Core. - return get_transcript_from_learning_core(video, lang, output_format, transcripts_info) + # This block is in openedx_content. + return get_transcript_from_openedx_content(video, lang, output_format, transcripts_info) try: edx_video_id = clean_video_id(video.edx_video_id) @@ -1096,7 +1090,7 @@ def resolve_language_code_to_transcript_code(transcripts, dest_lang): """ Attempts to match the requested dest lang with the existing transcript languages """ - sub, other_lang = transcripts["sub"], transcripts["transcripts"] + sub, other_lang = transcripts["sub"], transcripts["transcripts"] # noqa: F841 # lang code exists in list of other transcript languages as-is if dest_lang in other_lang: return dest_lang diff --git a/openedx/core/djangoapps/video_pipeline/admin.py b/openedx/core/djangoapps/video_pipeline/admin.py index 26f354205a2d..bad3131284ff 100644 --- a/openedx/core/djangoapps/video_pipeline/admin.py +++ b/openedx/core/djangoapps/video_pipeline/admin.py @@ -2,18 +2,18 @@ Django admin for Video Pipeline models. """ +from config_models.admin import ConfigurationModelAdmin from django.contrib import admin -from config_models.admin import ConfigurationModelAdmin from openedx.core.djangoapps.video_config.admin import CourseSpecificEnabledFlagBaseAdmin from openedx.core.djangoapps.video_pipeline.forms import ( CourseVideoUploadsEnabledByDefaultAdminForm, - VEMPipelineIntegrationAdminForm + VEMPipelineIntegrationAdminForm, ) from openedx.core.djangoapps.video_pipeline.models import ( CourseVideoUploadsEnabledByDefault, VEMPipelineIntegration, - VideoUploadsEnabledByDefault + VideoUploadsEnabledByDefault, ) diff --git a/openedx/core/djangoapps/video_pipeline/config/waffle.py b/openedx/core/djangoapps/video_pipeline/config/waffle.py index fb11634b23ea..66fc2c7f2bf2 100644 --- a/openedx/core/djangoapps/video_pipeline/config/waffle.py +++ b/openedx/core/djangoapps/video_pipeline/config/waffle.py @@ -34,6 +34,6 @@ # .. toggle_tickets: https://github.com/openedx/edx-platform/pull/23375 ENABLE_DEVSTACK_VIDEO_UPLOADS = WaffleFlag(f'{WAFFLE_NAMESPACE}.enable_devstack_video_uploads', __name__, LOG_PREFIX) -ENABLE_VEM_PIPELINE = CourseWaffleFlag( # lint-amnesty, pylint: disable=toggle-missing-annotation +ENABLE_VEM_PIPELINE = CourseWaffleFlag( # pylint: disable=toggle-missing-annotation f'{WAFFLE_NAMESPACE}.enable_vem_pipeline', __name__, LOG_PREFIX ) diff --git a/openedx/core/djangoapps/video_pipeline/forms.py b/openedx/core/djangoapps/video_pipeline/forms.py index f763746331e3..6f87b29a1e48 100644 --- a/openedx/core/djangoapps/video_pipeline/forms.py +++ b/openedx/core/djangoapps/video_pipeline/forms.py @@ -4,10 +4,7 @@ from django import forms from openedx.core.djangoapps.video_config.forms import CourseSpecificFlagAdminBaseForm -from openedx.core.djangoapps.video_pipeline.models import ( - CourseVideoUploadsEnabledByDefault, - VEMPipelineIntegration, -) +from openedx.core.djangoapps.video_pipeline.models import CourseVideoUploadsEnabledByDefault, VEMPipelineIntegration class CourseVideoUploadsEnabledByDefaultAdminForm(CourseSpecificFlagAdminBaseForm): @@ -26,4 +23,4 @@ class VEMPipelineIntegrationAdminForm(forms.ModelForm): """ class Meta: model = VEMPipelineIntegration - fields = '__all__' + fields = '__all__' # noqa: DJ007 diff --git a/openedx/core/djangoapps/video_pipeline/migrations/0001_initial.py b/openedx/core/djangoapps/video_pipeline/migrations/0001_initial.py index 0eef050c20eb..1de114a4af39 100644 --- a/openedx/core/djangoapps/video_pipeline/migrations/0001_initial.py +++ b/openedx/core/djangoapps/video_pipeline/migrations/0001_initial.py @@ -1,6 +1,6 @@ -from django.db import migrations, models import django.db.models.deletion from django.conf import settings +from django.db import migrations, models class Migration(migrations.Migration): diff --git a/openedx/core/djangoapps/video_pipeline/migrations/0003_coursevideouploadsenabledbydefault_videouploadsenabledbydefault.py b/openedx/core/djangoapps/video_pipeline/migrations/0003_coursevideouploadsenabledbydefault_videouploadsenabledbydefault.py index 72a54f806bbd..fa7c1220e78a 100644 --- a/openedx/core/djangoapps/video_pipeline/migrations/0003_coursevideouploadsenabledbydefault_videouploadsenabledbydefault.py +++ b/openedx/core/djangoapps/video_pipeline/migrations/0003_coursevideouploadsenabledbydefault_videouploadsenabledbydefault.py @@ -1,6 +1,6 @@ -from django.db import migrations, models -from django.conf import settings import django.db.models.deletion +from django.conf import settings +from django.db import migrations, models from opaque_keys.edx.django.models import CourseKeyField diff --git a/openedx/core/djangoapps/video_pipeline/migrations/0004_vempipelineintegration.py b/openedx/core/djangoapps/video_pipeline/migrations/0004_vempipelineintegration.py index 1655ddcbb144..d7d3f65ae612 100644 --- a/openedx/core/djangoapps/video_pipeline/migrations/0004_vempipelineintegration.py +++ b/openedx/core/djangoapps/video_pipeline/migrations/0004_vempipelineintegration.py @@ -1,8 +1,8 @@ # Generated by Django 2.2.12 on 2020-05-29 12:15 +import django.db.models.deletion from django.conf import settings from django.db import migrations, models -import django.db.models.deletion class Migration(migrations.Migration): diff --git a/openedx/core/djangoapps/video_pipeline/models.py b/openedx/core/djangoapps/video_pipeline/models.py index 1e21c19feef3..64617399d9fc 100644 --- a/openedx/core/djangoapps/video_pipeline/models.py +++ b/openedx/core/djangoapps/video_pipeline/models.py @@ -5,7 +5,6 @@ from config_models.models import ConfigurationModel from django.contrib.auth import get_user_model from django.db import models - from django.utils.translation import gettext_lazy as _ from opaque_keys.edx.django.models import CourseKeyField @@ -96,7 +95,7 @@ def feature_enabled(cls, course_id): def __str__(self): current_model = VideoUploadsEnabledByDefault.current() - return "VideoUploadsEnabledByDefault: enabled {is_enabled}".format( + return "VideoUploadsEnabledByDefault: enabled {is_enabled}".format( # noqa: UP032 is_enabled=current_model.is_enabled() ) @@ -125,7 +124,7 @@ def __str__(self): if self.enabled: not_en = "" - return "Course '{course_key}': Video Uploads {not_enabled}Enabled by default.".format( + return "Course '{course_key}': Video Uploads {not_enabled}Enabled by default.".format( # noqa: UP032 course_key=str(self.course_id), not_enabled=not_en ) diff --git a/openedx/core/djangoapps/video_pipeline/tests/test_api.py b/openedx/core/djangoapps/video_pipeline/tests/test_api.py index 35cc9eaf2998..2cfce0a4c05c 100644 --- a/openedx/core/djangoapps/video_pipeline/tests/test_api.py +++ b/openedx/core/djangoapps/video_pipeline/tests/test_api.py @@ -19,7 +19,7 @@ class TestAPIUtils(VideoPipelineMixin, TestCase): """ Tests for API Utils. """ - def setUp(self): # lint-amnesty, pylint: disable=super-method-not-called + def setUp(self): # pylint: disable=super-method-not-called """ Setup VEM oauth client. """ @@ -66,7 +66,7 @@ def test_update_transcription_service_credentials(self, credentials_payload, moc error_response, is_updated = update_3rd_party_transcription_service_credentials(**credentials_payload) # Making sure log.exception is not called. - self.assertDictEqual(error_response, {}) + self.assertDictEqual(error_response, {}) # noqa: PT009 assert not mock_logger.exception.called assert is_updated @@ -97,7 +97,7 @@ def test_update_transcription_service_credentials_exceptions(self, mock_client, # Assert the results. assert not is_updated - self.assertDictEqual(error_response, json.loads(error_content)) + self.assertDictEqual(error_response, json.loads(error_content)) # noqa: PT009 mock_logger.exception.assert_called_with( 'Unable to update transcript credentials -- org=%s, provider=%s, response=%s', credentials_payload['org'], diff --git a/openedx/core/djangoapps/video_pipeline/tests/test_models.py b/openedx/core/djangoapps/video_pipeline/tests/test_models.py index 7120b75ba33c..58f9e32f5595 100644 --- a/openedx/core/djangoapps/video_pipeline/tests/test_models.py +++ b/openedx/core/djangoapps/video_pipeline/tests/test_models.py @@ -2,13 +2,15 @@ Tests for the models that configures 'VideoUploadsEnabledByDefault' feature. """ -import ddt -import itertools # lint-amnesty, pylint: disable=wrong-import-order +import itertools # pylint: disable=wrong-import-order +import ddt from django.test import TestCase + from openedx.core.djangoapps.video_config.tests.test_models import FeatureFlagTestMixin from openedx.core.djangoapps.video_pipeline.models import ( - CourseVideoUploadsEnabledByDefault, VideoUploadsEnabledByDefault, + CourseVideoUploadsEnabledByDefault, + VideoUploadsEnabledByDefault, ) diff --git a/openedx/core/djangoapps/video_pipeline/utils.py b/openedx/core/djangoapps/video_pipeline/utils.py index b76026927b6e..541200b1e800 100644 --- a/openedx/core/djangoapps/video_pipeline/utils.py +++ b/openedx/core/djangoapps/video_pipeline/utils.py @@ -2,7 +2,6 @@ Utils for video_pipeline app. """ from django.conf import settings - from edx_rest_api_client.client import OAuthAPIClient diff --git a/openedx/core/djangoapps/waffle_utils/admin.py b/openedx/core/djangoapps/waffle_utils/admin.py index bd905a7c9e78..93f1be13aeac 100644 --- a/openedx/core/djangoapps/waffle_utils/admin.py +++ b/openedx/core/djangoapps/waffle_utils/admin.py @@ -2,10 +2,8 @@ Django admin page for waffle utils models """ -from django.contrib import admin - from config_models.admin import KeyedConfigurationModelAdmin - +from django.contrib import admin from .forms import WaffleFlagCourseOverrideAdminForm, WaffleFlagOrgOverrideAdminForm from .models import WaffleFlagCourseOverrideModel, WaffleFlagOrgOverrideModel diff --git a/openedx/core/djangoapps/waffle_utils/forms.py b/openedx/core/djangoapps/waffle_utils/forms.py index 18592eddac7d..86a336201e6c 100644 --- a/openedx/core/djangoapps/waffle_utils/forms.py +++ b/openedx/core/djangoapps/waffle_utils/forms.py @@ -15,7 +15,7 @@ class WaffleFlagCourseOverrideAdminForm(forms.ModelForm): """ class Meta: model = WaffleFlagCourseOverrideModel - fields = '__all__' + fields = '__all__' # noqa: DJ007 def clean_course_id(self): """ @@ -42,7 +42,7 @@ class WaffleFlagOrgOverrideAdminForm(forms.ModelForm): """ class Meta: model = WaffleFlagOrgOverrideModel - fields = '__all__' + fields = '__all__' # noqa: DJ007 def clean_org(self): """ diff --git a/openedx/core/djangoapps/waffle_utils/migrations/0003_add_org_level_waffle_override.py b/openedx/core/djangoapps/waffle_utils/migrations/0003_add_org_level_waffle_override.py index 2f9c7a67ad0d..4319482cd935 100644 --- a/openedx/core/djangoapps/waffle_utils/migrations/0003_add_org_level_waffle_override.py +++ b/openedx/core/djangoapps/waffle_utils/migrations/0003_add_org_level_waffle_override.py @@ -1,8 +1,8 @@ # Generated by Django 3.2.11 on 2022-01-13 18:42 +import django.db.models.deletion from django.conf import settings from django.db import migrations, models -import django.db.models.deletion class Migration(migrations.Migration): diff --git a/openedx/core/djangoapps/waffle_utils/models.py b/openedx/core/djangoapps/waffle_utils/models.py index a89201ef3a9f..9a49ca8c432a 100644 --- a/openedx/core/djangoapps/waffle_utils/models.py +++ b/openedx/core/djangoapps/waffle_utils/models.py @@ -2,12 +2,12 @@ Models for configuring waffle utils. """ -from django.db.models import CharField, TextField, Index +from config_models.models import ConfigurationModel +from django.db.models import CharField, Index, TextField from django.utils.translation import gettext_lazy as _ from model_utils import Choices from opaque_keys.edx.django.models import CourseKeyField -from config_models.models import ConfigurationModel from openedx.core.lib.cache_utils import request_cached diff --git a/openedx/core/djangoapps/waffle_utils/tests/test_views.py b/openedx/core/djangoapps/waffle_utils/tests/test_views.py index 126d65d30067..1078245f3d2f 100644 --- a/openedx/core/djangoapps/waffle_utils/tests/test_views.py +++ b/openedx/core/djangoapps/waffle_utils/tests/test_views.py @@ -11,7 +11,7 @@ from .. import views as toggle_state_views -class ToggleStateViewTests(TestCase): # lint-amnesty, pylint: disable=missing-class-docstring +class ToggleStateViewTests(TestCase): # pylint: disable=missing-class-docstring """ Tests for the toggle state report view. """ diff --git a/openedx/core/djangoapps/waffle_utils/urls.py b/openedx/core/djangoapps/waffle_utils/urls.py index 7f93ac341eb2..e026ff1fa19a 100644 --- a/openedx/core/djangoapps/waffle_utils/urls.py +++ b/openedx/core/djangoapps/waffle_utils/urls.py @@ -1,5 +1,6 @@ """ URL definitions for waffle utils. """ from django.urls import path + from openedx.core.djangoapps.waffle_utils.views import ToggleStateView urlpatterns = [ diff --git a/openedx/core/djangoapps/xblock/README.rst b/openedx/core/djangoapps/xblock/README.rst index 245af2259932..a5d755af683c 100644 --- a/openedx/core/djangoapps/xblock/README.rst +++ b/openedx/core/djangoapps/xblock/README.rst @@ -1,5 +1,5 @@ This README was written back when the new runtime was backed by Blockstore. -Now that the runtime is backed by Learning Core, this README is out of date. +Now that the runtime is backed by openedx_content, this README is out of date. We need to audit and update it as part of `this task `_. diff --git a/openedx/core/djangoapps/xblock/api.py b/openedx/core/djangoapps/xblock/api.py index c0293f614b00..a4661f67b164 100644 --- a/openedx/core/djangoapps/xblock/api.py +++ b/openedx/core/djangoapps/xblock/api.py @@ -7,50 +7,47 @@ Note that these views are only for interacting with existing blocks. Other Studio APIs cover use cases like adding/deleting/editing blocks. """ -# pylint: disable=unused-import -from enum import Enum -from datetime import datetime import logging -import threading +import threading # pylint: disable=unused-import # noqa: F401 +from datetime import datetime # pylint: disable=unused-import # noqa: F401 + +# pylint: disable=unused-import +from enum import Enum # noqa: F401 from django.core.exceptions import PermissionDenied from django.urls import reverse from django.utils.translation import gettext as _ -from openedx_learning.api import authoring as authoring_api -from openedx_learning.api.authoring_models import Component, ComponentVersion from opaque_keys.edx.keys import UsageKeyV2 -from opaque_keys.edx.locator import LibraryUsageLocatorV2 +from opaque_keys.edx.locator import LibraryUsageLocatorV2 # noqa: F401 +from openedx_content import api as content_api +from openedx_content.models_api import Component, ComponentVersion from rest_framework.exceptions import NotFound from xblock.core import XBlock from xblock.exceptions import NoSuchUsage, NoSuchViewError from xblock.plugin import PluginMissingError -from openedx.core.types import User as UserType from openedx.core.djangoapps.xblock.apps import get_xblock_app_config + +# Made available as part of this package's public API: +from openedx.core.djangoapps.xblock.learning_context import LearningContext # noqa: F401 from openedx.core.djangoapps.xblock.learning_context.manager import get_learning_context_impl -from openedx.core.djangoapps.xblock.runtime.learning_core_runtime import ( - LearningCoreFieldData, - LearningCoreXBlockRuntime, +from openedx.core.djangoapps.xblock.runtime.openedx_content_runtime import ( + OpenedXContentFieldData, + OpenedXContentRuntime, ) -from .data import CheckPerm, LatestVersion -from .rest_api.url_converters import VersionConverter -from .utils import ( - get_secure_token_for_xblock_handler, - get_xblock_id_for_anonymous_user, - get_auto_latest_version, -) - -from .runtime.learning_core_runtime import LearningCoreXBlockRuntime +from openedx.core.types import User as UserType -# Made available as part of this package's public API: -from openedx.core.djangoapps.xblock.learning_context import LearningContext +from .data import CheckPerm, LatestVersion +from .rest_api.url_converters import VersionConverter # noqa: F401 +from .runtime.openedx_content_runtime import OpenedXContentRuntime # noqa: F811 +from .utils import get_auto_latest_version, get_secure_token_for_xblock_handler, get_xblock_id_for_anonymous_user # Implementation: log = logging.getLogger(__name__) -def get_runtime(user: UserType | None) -> LearningCoreXBlockRuntime: +def get_runtime(user: UserType | None) -> OpenedXContentRuntime: """ Return a new XBlockRuntime. @@ -62,9 +59,9 @@ def get_runtime(user: UserType | None) -> LearningCoreXBlockRuntime: params = get_xblock_app_config().get_runtime_params() params.update( handler_url=get_handler_url, - authored_data_store=LearningCoreFieldData(), + authored_data_store=OpenedXContentFieldData(), ) - runtime = LearningCoreXBlockRuntime(user, **params) + runtime = OpenedXContentRuntime(user, **params) return runtime @@ -202,14 +199,14 @@ def get_component_from_usage_key(usage_key: UsageKeyV2) -> Component: This is a lower-level function that will return a Component even if there is no current draft version of that Component (because it's been soft-deleted). """ - learning_package = authoring_api.get_learning_package_by_key( + learning_package = content_api.get_learning_package_by_ref( str(usage_key.context_key) ) - return authoring_api.get_component_by_key( + return content_api.get_component_by_code( learning_package.id, namespace='xblock.v1', type_name=usage_key.block_type, - local_key=usage_key.block_id, + component_code=usage_key.block_id, ) @@ -219,7 +216,7 @@ def get_block_olx( version: int | LatestVersion = LatestVersion.AUTO ) -> str: """ - Get the OLX source of the of the given Learning-Core-backed XBlock and a version. + Get the OLX source of the of the given openedx_content-backed XBlock and a version. """ component = get_component_from_usage_key(usage_key) version = get_auto_latest_version(version) @@ -235,9 +232,9 @@ def get_block_olx( raise NoSuchUsage(usage_key) # TODO: we should probably make a method on ComponentVersion that returns - # a content based on the name. Accessing by componentversioncontent__key is + # a content based on the name. Accessing by componentversionmedia__path is # awkward. - content = component_version.contents.get(componentversioncontent__key="block.xml") + content = component_version.media.get(componentversionmedia__path="block.xml") return content.text diff --git a/openedx/core/djangoapps/xblock/apps.py b/openedx/core/djangoapps/xblock/apps.py index e4f07666c35e..aba2c1aa48f7 100644 --- a/openedx/core/djangoapps/xblock/apps.py +++ b/openedx/core/djangoapps/xblock/apps.py @@ -5,7 +5,8 @@ from django.conf import settings from openedx.core.djangoapps.site_configuration import helpers as configuration_helpers -from .data import StudentDataMode, AuthoredDataMode + +from .data import AuthoredDataMode, StudentDataMode class XBlockAppConfig(AppConfig): @@ -18,7 +19,7 @@ class XBlockAppConfig(AppConfig): def get_runtime_params(self): """ - Get the LearningCoreXBlockRuntime parameters appropriate for viewing and/or + Get the OpenedXContentRuntime parameters appropriate for viewing and/or editing XBlock content. """ raise NotImplementedError @@ -45,7 +46,7 @@ class LmsXBlockAppConfig(XBlockAppConfig): def get_runtime_params(self): """ - Get the LearningCoreXBlockRuntime parameters appropriate for viewing and/or + Get the OpenedXContentRuntime parameters appropriate for viewing and/or editing XBlock content in the LMS """ return dict( @@ -68,7 +69,7 @@ class StudioXBlockAppConfig(XBlockAppConfig): def get_runtime_params(self): """ - Get the LearningCoreXBlockRuntime parameters appropriate for viewing and/or + Get the OpenedXContentRuntime parameters appropriate for viewing and/or editing XBlock content in Studio """ return dict( diff --git a/openedx/core/djangoapps/xblock/learning_context/__init__.py b/openedx/core/djangoapps/xblock/learning_context/__init__.py index d4bad77ed934..b28484fbff67 100644 --- a/openedx/core/djangoapps/xblock/learning_context/__init__.py +++ b/openedx/core/djangoapps/xblock/learning_context/__init__.py @@ -2,4 +2,4 @@ A "Learning Context" is a course, a library, a program, or some other collection of content where learning happens. """ -from .learning_context import LearningContext +from .learning_context import LearningContext # noqa: F401 diff --git a/openedx/core/djangoapps/xblock/learning_context/learning_context.py b/openedx/core/djangoapps/xblock/learning_context/learning_context.py index dc7a21f1c397..22bd92701350 100644 --- a/openedx/core/djangoapps/xblock/learning_context/learning_context.py +++ b/openedx/core/djangoapps/xblock/learning_context/learning_context.py @@ -2,9 +2,10 @@ A "Learning Context" is a course, a library, a program, or some other collection of content where learning happens. """ -from openedx.core.types import User as UserType from opaque_keys.edx.keys import UsageKeyV2 +from openedx.core.types import User as UserType + class LearningContext: """ @@ -69,18 +70,3 @@ def definition_for_usage(self, usage_key, **kwargs): Retuns None if the usage key doesn't exist in this context. """ raise NotImplementedError - - def send_block_updated_event(self, usage_key): - """ - Send a "block updated" event for the block with the given usage_key in this context. - - usage_key: the UsageKeyV2 subclass used for this learning context - """ - - def send_container_updated_events(self, usage_key): - """ - Send "container updated" events for containers that contains the block with - the given usage_key in this context. - - usage_key: the UsageKeyV2 subclass used for this learning context - """ diff --git a/openedx/core/djangoapps/xblock/rest_api/urls.py b/openedx/core/djangoapps/xblock/rest_api/urls.py index a83d5104e570..ed76f5638f94 100644 --- a/openedx/core/djangoapps/xblock/rest_api/urls.py +++ b/openedx/core/djangoapps/xblock/rest_api/urls.py @@ -2,8 +2,8 @@ URL configuration for the new XBlock API """ from django.urls import include, path, re_path, register_converter -from . import url_converters -from . import views + +from . import url_converters, views # Note that the exact same API URLs are used in Studio and the LMS, but the API # may act a bit differently in each (e.g. Studio stores user state ephemerally). diff --git a/openedx/core/djangoapps/xblock/rest_api/views.py b/openedx/core/djangoapps/xblock/rest_api/views.py index 4135fcbf6cdb..36fc1b9ae6d1 100644 --- a/openedx/core/djangoapps/xblock/rest_api/views.py +++ b/openedx/core/djangoapps/xblock/rest_api/views.py @@ -4,7 +4,7 @@ import json from pathlib import Path -from common.djangoapps.util.json_request import JsonResponse +import openassessment from corsheaders.signals import check_request_enabled from django.conf import settings from django.contrib.auth import get_user_model @@ -15,32 +15,26 @@ from django.views.decorators.csrf import csrf_exempt from opaque_keys.edx.keys import UsageKeyV2 from rest_framework import permissions, serializers -from rest_framework.decorators import api_view, permission_classes # lint-amnesty, pylint: disable=unused-import -from rest_framework.exceptions import PermissionDenied, AuthenticationFailed, NotFound -from rest_framework.response import Response +from rest_framework.decorators import api_view, permission_classes # pylint: disable=unused-import +from rest_framework.exceptions import AuthenticationFailed, NotFound, PermissionDenied from rest_framework.fields import BooleanField +from rest_framework.response import Response from rest_framework.views import APIView from xblock.django.request import DjangoWebobRequest, webob_to_django_response from xblock.exceptions import NoSuchUsage from xblock.fields import Scope -import openassessment import openedx.core.djangoapps.site_configuration.helpers as configuration_helpers +from common.djangoapps.util.json_request import JsonResponse from openedx.core.djangoapps.xblock.learning_context.manager import get_learning_context_impl from openedx.core.lib.api.view_utils import view_auth_classes -from ..api import ( - CheckPerm, - LatestVersion, - get_block_metadata, - get_block_display_name, - get_handler_url as _get_handler_url, - load_block, - render_block_view as _render_block_view, - get_block_olx, -) + +from ..api import CheckPerm, LatestVersion, get_block_display_name, get_block_metadata, get_block_olx, load_block +from ..api import get_handler_url as _get_handler_url +from ..api import render_block_view as _render_block_view from ..utils import validate_secure_token_for_xblock_handler -from .url_converters import VersionConverter from .serializers import XBlockOlxSerializer +from .url_converters import VersionConverter User = get_user_model() @@ -131,7 +125,7 @@ def embed_block_view(request, usage_key: UsageKeyV2, view_name: str): new_oa_manifest = {} if oa_manifest_path.exists(): - with open(oa_manifest_path, "r") as f: + with open(oa_manifest_path, "r") as f: # noqa: UP015 oa_manifest = json.load(f) new_oa_manifest = { # When we add the RTL style, it automatically applies that style (right-to-left reading) regardless @@ -263,7 +257,7 @@ def get_block_olx_view( return Response(XBlockOlxSerializer({"olx": olx}).data) -def cors_allow_xblock_handler(sender, request, **kwargs): # lint-amnesty, pylint: disable=unused-argument +def cors_allow_xblock_handler(sender, request, **kwargs): # pylint: disable=unused-argument """ Sandboxed XBlocks need to be able to call XBlock handlers via POST, from a different domain. See 'xblock_handler' method for details and how security is @@ -369,7 +363,7 @@ def get_explicitly_set_fields_by_scope(self, block, scope=Scope.content): (Including any set to None.) """ result = {} - for field in block.fields.values(): # lint-amnesty, pylint: disable=no-member + for field in block.fields.values(): # pylint: disable=no-member if field.scope == scope and field.is_set_on(block): try: result[field.name] = field.read_json(block) diff --git a/openedx/core/djangoapps/xblock/runtime/ephemeral_field_data.py b/openedx/core/djangoapps/xblock/runtime/ephemeral_field_data.py index d4ff23960103..ba84fa9579ff 100644 --- a/openedx/core/djangoapps/xblock/runtime/ephemeral_field_data.py +++ b/openedx/core/djangoapps/xblock/runtime/ephemeral_field_data.py @@ -21,7 +21,6 @@ from django.core.cache import caches from xblock.runtime import KeyValueStore - FIELD_DATA_TIMEOUT = None # keep in cache indefinitely, until cache needs pruning diff --git a/openedx/core/djangoapps/xblock/runtime/mixin.py b/openedx/core/djangoapps/xblock/runtime/mixin.py index 5e413ce5ebe5..de002639973c 100644 --- a/openedx/core/djangoapps/xblock/runtime/mixin.py +++ b/openedx/core/djangoapps/xblock/runtime/mixin.py @@ -5,9 +5,9 @@ from django.utils.translation import gettext as _ +from web_fragments.fragment import Fragment from xblock.core import XBlock, XBlockMixin from xblock.exceptions import JsonHandlerError -from web_fragments.fragment import Fragment from openedx.core.djangolib.markup import HTML @@ -36,7 +36,7 @@ def publish_completion(self, data, suffix=''): # pylint: disable=unused-argumen Copied from lms.djangoapps.lms_xblock.mixin.LmsBlockMixin """ completion_service = self.runtime.service(self, 'completion') - if completion_service is None: # lint-amnesty, pylint: disable=no-else-raise + if completion_service is None: # pylint: disable=no-else-raise raise JsonHandlerError(500, "No completion service found") elif not completion_service.completion_tracking_enabled(): raise JsonHandlerError(404, "Completion tracking is not enabled and API calls are unexpected") diff --git a/openedx/core/djangoapps/xblock/runtime/learning_core_runtime.py b/openedx/core/djangoapps/xblock/runtime/openedx_content_runtime.py similarity index 82% rename from openedx/core/djangoapps/xblock/runtime/learning_core_runtime.py rename to openedx/core/djangoapps/xblock/runtime/openedx_content_runtime.py index 5c8bc81c5ffd..8c4996869324 100644 --- a/openedx/core/djangoapps/xblock/runtime/learning_core_runtime.py +++ b/openedx/core/djangoapps/xblock/runtime/openedx_content_runtime.py @@ -1,5 +1,5 @@ """ -Learning Core XBlock Runtime code +openedx_content XBlock Runtime code """ from __future__ import annotations @@ -11,52 +11,49 @@ from django.core.exceptions import ObjectDoesNotExist, ValidationError from django.db.transaction import atomic from django.urls import reverse - -from openedx_learning.api import authoring as authoring_api - from lxml import etree - +from openedx_content import api as content_api from xblock.core import XBlock from xblock.exceptions import NoSuchUsage -from xblock.fields import Field, Scope, ScopeIds from xblock.field_data import FieldData +from xblock.fields import Field, Scope, ScopeIds from openedx.core.djangoapps.xblock.api import get_xblock_app_config -from openedx.core.lib.xblock_serializer.api import serialize_modulestore_block_for_learning_core +from openedx.core.lib.xblock_serializer.api import serialize_modulestore_block_for_openedx_content from openedx.core.lib.xblock_serializer.data import StaticFile + from ..data import AuthoredDataMode, LatestVersion -from ..utils import get_auto_latest_version from ..learning_context.manager import get_learning_context_impl +from ..utils import get_auto_latest_version from .runtime import XBlockRuntime - log = logging.getLogger(__name__) -class LearningCoreFieldData(FieldData): +class OpenedXContentFieldData(FieldData): """ - FieldData for the Learning Core XBlock Runtime + FieldData for the openedx_content XBlock Runtime - LearningCoreFieldData only supports the ``content`` and ``settings`` scopes. + OpenedXContentFieldData only supports the ``content`` and ``settings`` scopes. Any attempt to read or write fields with other scopes will raise a ``NotImplementedError``. This class does NOT support the parent and children scopes. - LearningCoreFieldData should only live for the duration of one request. The - interaction between LearningCoreXBlockRuntime and LearningCoreFieldData is + OpenedXContentFieldData should only live for the duration of one request. The + interaction between OpenedXContentRuntime and OpenedXContentFieldData is as follows: - 1. LearningCoreXBlockRuntime knows how retrieve authored content data from - the Learning Core APIs in openedx-learning. This content is stored as - OLX, and LearningCoreXBlockRuntime won't know how to parse it into + 1. OpenedXContentRuntime knows how retrieve authored content data from + the Content API in openedx_content. This content is stored as + OLX, and OpenedXContentRuntime won't know how to parse it into fields, since serialization logic can happen in the XBlock itself. - 2. LearningCoreXBlockRuntime will then invoke the block to parse the OLX and - then force_save its field data into LearningCoreFieldData. + 2. OpenedXContentRuntime will then invoke the block to parse the OLX and + then force_save its field data into OpenedXContentFieldData. 3. After this point, various handler and API calls might alter fields for a given block using the XBlock. - 4. The main thing that LearningCoreXBlockRuntime will want to know later on + 4. The main thing that OpenedXContentRuntime will want to know later on is whether it needs to write any changes when its save_block method is - invoked. To support this, LearningCoreFieldData needs to track which + invoked. To support this, OpenedXContentFieldData needs to track which blocks have changes to any of their fields. See the marked_unchanged method docstring for more details. """ @@ -74,9 +71,9 @@ def mark_unchanged(self, block): Calling set or delete on a field always marks the block with that field as changed, by adding its usage key to self.changed. But set() is also called at the very beginning, when a block is first loaded from the - database by the LearningCoreXBlockRuntime's get_block call. + database by the OpenedXContentRuntime's get_block call. - This method exists so that LearningCoreXBlockRuntime can call it + This method exists so that OpenedXContentRuntime can call it whenever it has either just done a get_block operation (because those set() calls represent the already-persisted content state), or a save_block operation (since those changes will have been persisted). @@ -153,14 +150,14 @@ def _check_field(self, block, name): if field.scope not in (Scope.content, Scope.settings): raise NotImplementedError( f"Scope {field.scope} (field {name} of {block.scope_ids.usage_id}) " - "is unsupported. LearningCoreFieldData only supports the content" + "is unsupported. OpenedXContentFieldData only supports the content" " and settings scopes." ) -class LearningCoreXBlockRuntime(XBlockRuntime): +class OpenedXContentRuntime(XBlockRuntime): """ - XBlock runtime that uses openedx-learning apps for content storage. + XBlock runtime that uses openedx_content APIs (not ModuleStore). The superclass is doing all the hard stuff. This class only only has to worry about the block storage, block serialization/de-serialization, and @@ -169,11 +166,11 @@ class LearningCoreXBlockRuntime(XBlockRuntime): def get_block(self, usage_key, for_parent=None, *, version: int | LatestVersion = LatestVersion.AUTO): """ - Fetch an XBlock from Learning Core data models. + Fetch an XBlock from openedx_content data models. - This method will find the OLX for the content in Learning Core, parse it + This method will find the OLX for the content in openedx_content, parse it into an XBlock (with mixins) instance, and properly initialize our - internal LearningCoreFieldData instance with the field values from the + internal OpenedXContentFieldData instance with the field values from the parsed OLX. """ # We can do this more efficiently in a single query later, but for now @@ -193,8 +190,8 @@ def get_block(self, usage_key, for_parent=None, *, version: int | LatestVersion if component_version is None: raise NoSuchUsage(usage_key) - content = component_version.contents.get( - componentversioncontent__key="block.xml" + content = component_version.media.get( + componentversionmedia__path="block.xml" ) xml_node = etree.fromstring(content.text) block_type = usage_key.block_type @@ -248,27 +245,27 @@ def get_block_assets(self, block, fetch_asset_data): """ component_version = self.get_component_version_from_block(block) - # cvc = the ComponentVersionContent through-table - cvc_list = ( + # cvm = the ComponentVersionMedia through-table + cvm_list = ( component_version - .componentversioncontent_set - .filter(content__has_file=True) - .select_related('content') - .order_by('key') + .componentversionmedia_set + .filter(media__has_file=True) + .select_related('media') + .order_by('path') ) return [ StaticFile( - name=cvc.key, - url=self._absolute_url_for_asset(component_version, cvc.key), - data=cvc.content.read_file().read() if fetch_asset_data else None, + name=cvm.path, + url=self._absolute_url_for_asset(component_version, cvm.path), + data=cvm.media.read_file().read() if fetch_asset_data else None, ) - for cvc in cvc_list + for cvm in cvm_list ] def save_block(self, block): """ - Save any pending field data values to Learning Core data models. + Save any pending field data values to openedx_content data models. This gets called by block.save() - do not call this directly. """ @@ -290,36 +287,31 @@ def save_block(self, block): log.warning("User %s does not have permission to edit %s", self.user.username, block.scope_ids.usage_id) raise RuntimeError("You do not have permission to edit this XBlock") - serialized = serialize_modulestore_block_for_learning_core(block) - now = datetime.now(tz=timezone.utc) + serialized = serialize_modulestore_block_for_openedx_content(block) + now = datetime.now(tz=timezone.utc) # noqa: UP017 usage_key = block.scope_ids.usage_id with atomic(): component = self._get_component_from_usage_key(usage_key) - block_media_type = authoring_api.get_or_create_media_type( + block_media_type = content_api.get_or_create_media_type( f"application/vnd.openedx.xblock.v1.{usage_key.block_type}+xml" ) - content = authoring_api.get_or_create_text_content( + media = content_api.get_or_create_text_media( component.learning_package_id, block_media_type.id, text=serialized.olx_str, created=now, ) - authoring_api.create_next_version( - component.pk, + content_api.create_next_component_version( + component.id, title=block.display_name, - content_to_replace={ - "block.xml": content.id, + media_to_replace={ + "block.xml": media.id, }, created=now, created_by=self.user.id if self.user else None ) self.authored_data_store.mark_unchanged(block) - # Signal that we've modified this block - learning_context = get_learning_context_impl(usage_key) - learning_context.send_block_updated_event(usage_key) - learning_context.send_container_updated_events(usage_key) - def _get_component_from_usage_key(self, usage_key): """ Note that Components aren't ever really truly deleted, so this will @@ -329,13 +321,13 @@ def _get_component_from_usage_key(self, usage_key): TODO: This is the third place where we're implementing this. Figure out where the definitive place should be and have everything else call that. """ - learning_package = authoring_api.get_learning_package_by_key(str(usage_key.lib_key)) + learning_package = content_api.get_learning_package_by_ref(str(usage_key.lib_key)) try: - component = authoring_api.get_component_by_key( + component = content_api.get_component_by_code( learning_package.id, namespace='xblock.v1', type_name=usage_key.block_type, - local_key=usage_key.block_id, + component_code=usage_key.block_id, ) except ObjectDoesNotExist as exc: raise NoSuchUsage(usage_key) from exc @@ -344,7 +336,7 @@ def _get_component_from_usage_key(self, usage_key): def get_component_version_from_block(self, block): """ - Given an XBlock instance, return the Learning Core ComponentVersion. + Given an XBlock instance, return the openedx_content ComponentVersion. This relies on our runtime setting the _runtime_requested_version attribute on blocks that it fetches. @@ -401,20 +393,20 @@ def _lookup_asset_url(self, block: XBlock, asset_path: str) -> str | None: leading "static/" part because it assumes that all files will exist in a shared, flat namespace (i.e. a course's Files and Uploads). - Learning Core treats assets differently. Each Component has its own, + openedx_content treats assets differently. Each Component has its own, isolated namespace for asset storage. Furthermore, that namespace contains content that are not meant to be downloadable, like the block.xml (the OLX of the Component). There may one day be other files that are not meant to be externally downloadable there as well, like Markdown or LaTeX source files or grader code. - By convention, the static assets that we store in Learning Core and are + By convention, the static assets that we store in openedx_content and are meant for download sit inside a static/ directory that is local to each Component (and actually separate for each Component Version). So the transformation looks like this: - 1. The Learning Core ComponentVersion has an asset stored as + 1. The openedx_content ComponentVersion has an asset stored as ``static/test.png`` in the database. 2. The original OLX content we store references ``/static/test.png``, per OLX convention. Note the leading "/". @@ -446,22 +438,22 @@ def _lookup_asset_url(self, block: XBlock, asset_path: str) -> str | None: component_version = self.get_component_version_from_block(block) try: - content = ( + media = ( component_version - .componentversioncontent_set - .filter(content__has_file=True) - .get(key=f"static/{asset_path}") + .componentversionmedia_set + .filter(media__has_file=True) + .get(path=f"static/{asset_path}") ) except ObjectDoesNotExist: try: # Retry with unquoted path. We don't always unquote because it would not # be backwards-compatible, but we need to try both. asset_path = unquote(asset_path) - content = ( + media = ( # noqa: F841 component_version - .componentversioncontent_set - .filter(content__has_file=True) - .get(key=f"static/{asset_path}") + .componentversionmedia_set + .filter(media__has_file=True) + .get(path=f"static/{asset_path}") ) except ObjectDoesNotExist: # This means we see a path that _looks_ like it should be a static diff --git a/openedx/core/djangoapps/xblock/runtime/runtime.py b/openedx/core/djangoapps/xblock/runtime/runtime.py index 2ae4a431bfbe..f3544a6102d8 100644 --- a/openedx/core/djangoapps/xblock/runtime/runtime.py +++ b/openedx/core/djangoapps/xblock/runtime/runtime.py @@ -2,19 +2,18 @@ Common base classes for all new XBlock runtimes. """ import logging -from typing import Callable, Protocol +from typing import Callable, Protocol # noqa: UP035 from urllib.parse import urljoin # pylint: disable=import-error import crum -from common.djangoapps.student.models import anonymous_id_for_user -from completion.waffle import ENABLE_COMPLETION_TRACKING_SWITCH from completion.models import BlockCompletion from completion.services import CompletionService +from completion.waffle import ENABLE_COMPLETION_TRACKING_SWITCH from django.contrib.auth import get_user_model from django.core.cache import cache from django.core.exceptions import PermissionDenied from eventtracking import tracker -from opaque_keys.edx.keys import UsageKeyV2, LearningContextKey +from opaque_keys.edx.keys import LearningContextKey, UsageKeyV2 from web_fragments.fragment import Fragment from xblock.core import XBlock from xblock.exceptions import NoSuchServiceError @@ -22,27 +21,28 @@ from xblock.fields import Scope, ScopeIds from xblock.runtime import IdReader, KvsFieldData, MemoryIdManager, Runtime -from xmodule.errortracker import make_error_tracker -from xmodule.contentstore.django import contentstore -from xmodule.modulestore.django import XBlockI18nService -from xmodule.services import EventPublishingService, RebindUserService -from xmodule.util.sandboxing import SandboxService from common.djangoapps.edxmako.services import MakoService from common.djangoapps.static_replace.services import ReplaceURLService +from common.djangoapps.student.models import anonymous_id_for_user from common.djangoapps.track import contexts as track_contexts from common.djangoapps.track import views as track_views from common.djangoapps.xblock_django.user_service import DjangoXBlockUserService from lms.djangoapps.courseware.model_data import DjangoKeyValueStore, FieldDataCache from lms.djangoapps.grades.api import signals as grades_signals -from openedx.core.types import User as UserType from openedx.core.djangoapps.enrollments.services import EnrollmentsService from openedx.core.djangoapps.xblock.apps import get_xblock_app_config -from openedx.core.djangoapps.xblock.data import AuthoredDataMode, StudentDataMode, LatestVersion +from openedx.core.djangoapps.xblock.data import AuthoredDataMode, LatestVersion, StudentDataMode from openedx.core.djangoapps.xblock.runtime.ephemeral_field_data import EphemeralKeyValueStore from openedx.core.djangoapps.xblock.runtime.mixin import LmsBlockMixin from openedx.core.djangoapps.xblock.utils import get_xblock_id_for_anonymous_user from openedx.core.lib.cache_utils import CacheService -from openedx.core.lib.xblock_utils import wrap_fragment, xblock_local_resource_url, request_token +from openedx.core.lib.xblock_utils import request_token, wrap_fragment, xblock_local_resource_url +from openedx.core.types import User as UserType +from xmodule.contentstore.django import contentstore +from xmodule.errortracker import make_error_tracker +from xmodule.modulestore.django import XBlockI18nService +from xmodule.services import EventPublishingService, RebindUserService, XQueueService +from xmodule.util.sandboxing import SandboxService from .id_managers import OpaqueKeyReader from .shims import RuntimeShim, XBlockShim @@ -85,6 +85,9 @@ class XBlockRuntime(RuntimeShim, Runtime): The main reason we cannot make the runtime a long-lived singleton is that the XBlock runtime API requires 'user_id' to be a property of the runtime, not an argument passed in when loading particular blocks. + + TODO: This should probably be merged with OpenedXContentRuntime, its one and + only child class. See https://github.com/openedx/openedx-platform/issues/38021 """ # ** Do not add any XModule compatibility code to this class ** @@ -259,14 +262,14 @@ def applicable_aside_types(self, block: XBlock): def parse_xml_file(self, fileobj): # Deny access to the inherited method - raise NotImplementedError("XML Serialization is only supported with LearningCoreXBlockRuntime") + raise NotImplementedError("XML Serialization is only supported with OpenedXContentRuntime") def add_node_as_child(self, block, node): """ Called by XBlock.parse_xml to treat a child node as a child block. """ # Deny access to the inherited method - raise NotImplementedError("XML Serialization is only supported with LearningCoreXBlockRuntime") + raise NotImplementedError("XML Serialization is only supported with OpenedXContentRuntime") def service(self, block: XBlock, service_name: str): """ @@ -301,7 +304,7 @@ def service(self, block: XBlock, service_name: str): return DjangoXBlockUserService( self.user, - # The value should be updated to whether the user is staff in the context when Learning Core runtime + # The value should be updated to whether the user is staff in the context when openedx_content runtime # adds support for courses. user_is_staff=self.user.is_staff, # type: ignore anonymous_user_id=self.anonymous_student_id, @@ -347,6 +350,11 @@ def service(self, block: XBlock, service_name: str): # Import here to avoid circular dependency from openedx.core.djangoapps.video_config.services import VideoConfigService return VideoConfigService() + elif service_name == 'discussion_config_service': + from openedx.core.djangoapps.discussions.services import DiscussionConfigService + return DiscussionConfigService() + elif service_name == 'xqueue': + return XQueueService(block) # Otherwise, fall back to the base implementation which loads services # defined in the constructor: @@ -363,7 +371,7 @@ def _init_field_data_for_block(self, block: XBlock) -> FieldData: student_data_store = DictFieldData({}) elif self.user.is_anonymous: # This is an anonymous (non-registered) user: - assert isinstance(self.user_id, str) and self.user_id.startswith("anon") + assert isinstance(self.user_id, str) and self.user_id.startswith("anon") # noqa: PT018 kvs = EphemeralKeyValueStore() student_data_store = KvsFieldData(kvs) elif self.student_data_mode == StudentDataMode.Ephemeral: diff --git a/openedx/core/djangoapps/xblock/runtime/shims.py b/openedx/core/djangoapps/xblock/runtime/shims.py index 578db22a5250..8d1e22c64c01 100644 --- a/openedx/core/djangoapps/xblock/runtime/shims.py +++ b/openedx/core/djangoapps/xblock/runtime/shims.py @@ -4,6 +4,7 @@ # pylint: disable=no-member import warnings + from django.conf import settings from django.core.cache import cache from django.template import TemplateDoesNotExist @@ -102,7 +103,7 @@ def get_python_lib_zip(self): Only used for capa problems. """ - # TODO: load the python code from Learning Core. Ensure it's not publicly accessible. + # TODO: load the python code from openedx_content. Ensure it's not publicly accessible. return None @property diff --git a/openedx/core/djangoapps/xblock/tests/test_utils.py b/openedx/core/djangoapps/xblock/tests/test_utils.py index 229406e1bca1..fe01a1a6ff5f 100644 --- a/openedx/core/djangoapps/xblock/tests/test_utils.py +++ b/openedx/core/djangoapps/xblock/tests/test_utils.py @@ -7,10 +7,10 @@ from django.test import override_settings from freezegun import freeze_time -from openedx.core.djangoapps.xblock.utils import ( # lint-amnesty, pylint: disable=reimported - get_secure_token_for_xblock_handler, +from openedx.core.djangoapps.xblock.utils import ( # pylint: disable=reimported _get_secure_token_for_xblock_handler, - validate_secure_token_for_xblock_handler + get_secure_token_for_xblock_handler, + validate_secure_token_for_xblock_handler, ) REFERENCE_PARAMS = { @@ -24,13 +24,13 @@ "validation_xblock_handler_token_keys": None, # A reference time that produces a token that will expire within the next day # but not for a few hours. - "reference_time": datetime.datetime(2021, 1, 28, 13, 26, 38, 787309, datetime.timezone.utc), + "reference_time": datetime.datetime(2021, 1, 28, 13, 26, 38, 787309, datetime.timezone.utc), # noqa: UP017 "validation_time_delta_s": 0, } @pytest.mark.parametrize( - "param_delta,expected_validation", + "param_delta,expected_validation", # noqa: PT006 [ # Happy Path case with the above REFERENCE_PARAMS. ({}, True), @@ -48,7 +48,7 @@ # Demonstrating maximum possible validity period is just below 4 days # This passes because validation time is just below the cutoff point ( - {"reference_time": datetime.datetime(2021, 1, 27, 0, 0, 20, tzinfo=datetime.timezone.utc), + {"reference_time": datetime.datetime(2021, 1, 27, 0, 0, 20, tzinfo=datetime.timezone.utc), # noqa: UP017 "validation_time_delta_s": (86400 * 4) - 21 }, True, @@ -57,7 +57,7 @@ # Demonstrating maximum possible validity period is just below 4 days # This does not pass because validation time is just above the cutoff point ( - {"reference_time": datetime.datetime(2021, 1, 27, 0, 0, 20, tzinfo=datetime.timezone.utc), + {"reference_time": datetime.datetime(2021, 1, 27, 0, 0, 20, tzinfo=datetime.timezone.utc), # noqa: UP017 "validation_time_delta_s": (86400 * 4) - 19 }, False, @@ -66,7 +66,7 @@ # Demonstrating minimum possible validity period is just above 2 days # This passes because validation time is just below the cutoff point ( - {"reference_time": datetime.datetime(2021, 1, 28, 23, 59, 40, tzinfo=datetime.timezone.utc), + {"reference_time": datetime.datetime(2021, 1, 28, 23, 59, 40, tzinfo=datetime.timezone.utc), # noqa: UP017 "validation_time_delta_s": (86400 * 2) + 19 }, True, @@ -75,7 +75,7 @@ # Demonstrating minimum possible validity period is just above 2 days # This fails because validation time is just above the cutoff point ( - {"reference_time": datetime.datetime(2021, 1, 28, 23, 59, 40, tzinfo=datetime.timezone.utc), + {"reference_time": datetime.datetime(2021, 1, 28, 23, 59, 40, tzinfo=datetime.timezone.utc), # noqa: UP017 "validation_time_delta_s": (86400 * 2) + 21 }, False), @@ -162,7 +162,7 @@ def test_private_get_secure_token_for_xblock_handler(): Confirms function behaviour has not changed and is giving the same token for same inputs If these tokens change, this will invalidate some or all of the tokens handed out to learners """ - with freeze_time(datetime.datetime(2021, 1, 27, 0, 0, 0, tzinfo=datetime.timezone.utc)): + with freeze_time(datetime.datetime(2021, 1, 27, 0, 0, 0, tzinfo=datetime.timezone.utc)): # noqa: UP017 token_now = _get_secure_token_for_xblock_handler("12345", "some_block_key", 0, "some_hashing_key") token_previous = _get_secure_token_for_xblock_handler("12345", "some_block_key", -1, "some_hashing_key") assert token_now == "de8399a51fef6aa7584a" diff --git a/openedx/core/djangoapps/zendesk_proxy/apps.py b/openedx/core/djangoapps/zendesk_proxy/apps.py index e2d6f8a57a4f..88a661a10fe9 100644 --- a/openedx/core/djangoapps/zendesk_proxy/apps.py +++ b/openedx/core/djangoapps/zendesk_proxy/apps.py @@ -5,7 +5,7 @@ from django.apps import AppConfig -from edx_django_utils.plugins import PluginURLs, PluginSettings +from edx_django_utils.plugins import PluginSettings, PluginURLs from openedx.core.djangoapps.plugins.constants import ProjectType, SettingsType diff --git a/openedx/core/djangoapps/zendesk_proxy/tests/test_utils.py b/openedx/core/djangoapps/zendesk_proxy/tests/test_utils.py index 628f8302b464..02fae657b09c 100644 --- a/openedx/core/djangoapps/zendesk_proxy/tests/test_utils.py +++ b/openedx/core/djangoapps/zendesk_proxy/tests/test_utils.py @@ -5,11 +5,11 @@ import json from collections import OrderedDict - from unittest.mock import MagicMock, patch -from django.test.utils import override_settings import ddt +from django.test.utils import override_settings + from openedx.core.djangoapps.zendesk_proxy.utils import create_zendesk_ticket from openedx.core.lib.api.test_utils import ApiTestCase @@ -20,7 +20,7 @@ ZENDESK_OAUTH_ACCESS_TOKEN="abcdefghijklmnopqrstuvwxyz1234567890", ZENDESK_GROUP_ID_MAPPING={"Financial Assistance": 123}, ) -class TestUtils(ApiTestCase): # lint-amnesty, pylint: disable=missing-class-docstring +class TestUtils(ApiTestCase): # pylint: disable=missing-class-docstring def setUp(self): self.request_data = { 'email': 'JohnQStudent@example.com', diff --git a/openedx/core/djangoapps/zendesk_proxy/tests/test_v0_views.py b/openedx/core/djangoapps/zendesk_proxy/tests/test_v0_views.py index bf3a7cc24e22..8cc6b168a8a6 100644 --- a/openedx/core/djangoapps/zendesk_proxy/tests/test_v0_views.py +++ b/openedx/core/djangoapps/zendesk_proxy/tests/test_v0_views.py @@ -1,13 +1,13 @@ """Tests for zendesk_proxy views.""" -from copy import deepcopy import json - +from copy import deepcopy from unittest.mock import MagicMock, patch + import ddt -from django.urls import reverse from django.test.utils import override_settings +from django.urls import reverse from openedx.core.djangoapps.zendesk_proxy.v0.views import ZENDESK_REQUESTS_PER_HOUR from openedx.core.lib.api.test_utils import ApiTestCase @@ -45,7 +45,7 @@ def test_post(self): self.assertHttpCreated(response) (mock_args, mock_kwargs) = mock_post.call_args assert mock_args == ('https://www.superrealurlsthataredefinitelynotfake.com/api/v2/tickets.json',) - self.assertCountEqual(mock_kwargs.keys(), ['headers', 'data']) + self.assertCountEqual(mock_kwargs.keys(), ['headers', 'data']) # noqa: PT009 assert mock_kwargs['headers'] == { 'content-type': 'application/json', 'Authorization': 'Bearer abcdefghijklmnopqrstuvwxyz1234567890' } diff --git a/openedx/core/djangoapps/zendesk_proxy/tests/test_v1_views.py b/openedx/core/djangoapps/zendesk_proxy/tests/test_v1_views.py index 8259013e098f..9c2efe340fab 100644 --- a/openedx/core/djangoapps/zendesk_proxy/tests/test_v1_views.py +++ b/openedx/core/djangoapps/zendesk_proxy/tests/test_v1_views.py @@ -1,13 +1,13 @@ """Tests for zendesk_proxy views.""" -from copy import deepcopy import json +from copy import deepcopy from unittest.mock import MagicMock, patch import ddt -from django.urls import reverse from django.test.utils import override_settings +from django.urls import reverse from common.djangoapps.student.tests.factories import UserFactory from openedx.core.djangoapps.zendesk_proxy.v1.views import ZendeskProxyThrottle @@ -69,7 +69,7 @@ def test_post(self, user_activation_status): self.assertHttpCreated(response) (mock_args, mock_kwargs) = mock_post.call_args assert mock_args == ('https://www.superrealurlsthataredefinitelynotfake.com/api/v2/tickets.json',) - self.assertCountEqual(mock_kwargs.keys(), ['headers', 'data']) + self.assertCountEqual(mock_kwargs.keys(), ['headers', 'data']) # noqa: PT009 assert mock_kwargs['headers'] == { 'content-type': 'application/json', 'Authorization': 'Bearer abcdefghijklmnopqrstuvwxyz1234567890' } diff --git a/openedx/core/djangoapps/zendesk_proxy/urls.py b/openedx/core/djangoapps/zendesk_proxy/urls.py index 9881b72664fd..12477772a766 100644 --- a/openedx/core/djangoapps/zendesk_proxy/urls.py +++ b/openedx/core/djangoapps/zendesk_proxy/urls.py @@ -3,6 +3,7 @@ """ from django.urls import path + from openedx.core.djangoapps.zendesk_proxy.v0.views import ZendeskPassthroughView as v0_view from openedx.core.djangoapps.zendesk_proxy.v1.views import ZendeskPassthroughView as v1_view diff --git a/openedx/core/djangoapps/zendesk_proxy/utils.py b/openedx/core/djangoapps/zendesk_proxy/utils.py index 9ddfa2874686..ccfa5eabb3af 100644 --- a/openedx/core/djangoapps/zendesk_proxy/utils.py +++ b/openedx/core/djangoapps/zendesk_proxy/utils.py @@ -99,7 +99,7 @@ def create_zendesk_ticket( except (ValueError, KeyError): log.error( _std_error_message( - "Got an unexpected response from zendesk api. Can't" + "Got an unexpected response from zendesk api. Can't" # noqa: UP032 " get the ticket number to add extra info. {}".format(additional_info), response.content ) diff --git a/openedx/core/djangolib/default_auth_classes.py b/openedx/core/djangolib/default_auth_classes.py index 651bd79238a4..6ad01a302c01 100644 --- a/openedx/core/djangolib/default_auth_classes.py +++ b/openedx/core/djangolib/default_auth_classes.py @@ -28,7 +28,7 @@ def authenticate(self, request): else: set_custom_attribute('session_auth_result', 'n/a') return user_and_auth - except Exception as exception: + except Exception as exception: # noqa: F841 set_custom_attribute('session_auth_result', 'failure') raise diff --git a/openedx/core/djangolib/js_utils.py b/openedx/core/djangolib/js_utils.py index 115419d1c67b..f380e9ee16f2 100644 --- a/openedx/core/djangolib/js_utils.py +++ b/openedx/core/djangolib/js_utils.py @@ -69,7 +69,7 @@ def dump_js_escaped_json(obj, cls=EdxJSONEncoder): (string) Escaped encoded JSON. """ - obj = list(obj) if isinstance(obj, type({}.values())) else obj # lint-amnesty, pylint: disable=isinstance-second-argument-not-valid-type, line-too-long + obj = list(obj) if isinstance(obj, type({}.values())) else obj # pylint: disable=isinstance-second-argument-not-valid-type, line-too-long json_string = json.dumps(obj, ensure_ascii=True, cls=cls) json_string = _escape_json_for_js(json_string) return json_string diff --git a/openedx/core/djangolib/model_mixins.py b/openedx/core/djangolib/model_mixins.py index ae0ce8ea239a..6eb9ab917dff 100644 --- a/openedx/core/djangolib/model_mixins.py +++ b/openedx/core/djangolib/model_mixins.py @@ -20,22 +20,40 @@ class DeletableByUserValue: associated with some specified user. """ + @classmethod + def redact_before_delete_fields(cls): + """ + Returns dict of PII fields and their redacted values. + + Always returns an empty dict unless overridden by the inheriting model. + Results are used by ``delete_by_user_value`` to redact PII before delete. + """ + return {} + @classmethod def delete_by_user_value(cls, value, field): """ - Deletes instances of this model where ``field`` equals ``value``. + Redacts as-needed and always deletes instances of this model where ``field`` equals ``value``. e.g. ``delete_by_user_value(value='learner@example.com', field='email')`` + If ``redact_before_delete_fields()`` returns a non-empty dict, the + returned PII fields are redacted before any records are deleted. + Returns True if any instances were deleted. Returns False otherwise. """ filter_kwargs = {field: value} records_matching_user_value = cls.objects.filter(**filter_kwargs) - - if not records_matching_user_value.exists(): + record_ids_matching_user_value = list(records_matching_user_value.values_list('id', flat=True)) + if not record_ids_matching_user_value: return False - records_matching_user_value.delete() + # Converting to query set by id ensures we redact and delete the appropriate records + user_value_records_by_id = cls.objects.filter(id__in=record_ids_matching_user_value) + redact_fields = cls.redact_before_delete_fields() + if redact_fields: + user_value_records_by_id.update(**redact_fields) + user_value_records_by_id.delete() return True diff --git a/openedx/core/djangolib/oauth2_retirement_utils.py b/openedx/core/djangolib/oauth2_retirement_utils.py index 90e69f9e91d3..23d18eb02ba7 100644 --- a/openedx/core/djangolib/oauth2_retirement_utils.py +++ b/openedx/core/djangolib/oauth2_retirement_utils.py @@ -3,12 +3,10 @@ """ -from oauth2_provider.models import ( - AccessToken as DOTAccessToken, - Application as DOTApplication, - Grant as DOTGrant, - RefreshToken as DOTRefreshToken, -) +from oauth2_provider.models import AccessToken as DOTAccessToken +from oauth2_provider.models import Application as DOTApplication +from oauth2_provider.models import Grant as DOTGrant +from oauth2_provider.models import RefreshToken as DOTRefreshToken class ModelRetirer: diff --git a/openedx/core/djangolib/testing/tests/test_utils.py b/openedx/core/djangolib/testing/tests/test_utils.py index b81b25a78134..d5caf867c1ae 100644 --- a/openedx/core/djangolib/testing/tests/test_utils.py +++ b/openedx/core/djangolib/testing/tests/test_utils.py @@ -3,7 +3,6 @@ """ from crum import set_current_request - from django.contrib.auth import get_user_model from django.contrib.auth.models import AnonymousUser from django.http.request import HttpRequest @@ -11,7 +10,6 @@ from ..utils import get_mock_request - USER_MODEL = get_user_model() @@ -19,7 +17,7 @@ class TestGetMockRequest(TestCase): """ Validate the behavior of get_mock_request """ - def setUp(self): # lint-amnesty, pylint: disable=super-method-not-called + def setUp(self): # pylint: disable=super-method-not-called self.addCleanup(set_current_request, None) def test_mock_request_is_request(self): diff --git a/openedx/core/djangolib/testing/utils.py b/openedx/core/djangolib/testing/utils.py index 3beb63586b3f..3b263c2b1a53 100644 --- a/openedx/core/djangolib/testing/utils.py +++ b/openedx/core/djangolib/testing/utils.py @@ -25,6 +25,51 @@ from openedx.core.lib import ensure_cms, ensure_lms +# Used to ignore queries against authz tables when using assertNumQueries in FilteredQueryCountMixin +AUTHZ_TABLES = [ + "casbin_rule", + "openedx_authz_policycachecontrol", + "django_migrations", +] + + +def assert_redact_before_delete( + sql_list, + table, + expected_redacted_value_list, + num_redact_delete_pairs=1, +): + """ + Assert that PII is redacted before deleted. + + Redacting before deleting protects downstream sync of data from holding PII + in soft-deleted records. This helper ensures UPDATE and DELETE queries for + ``table`` occur in consecutive pairs, and that each UPDATE contains the + expected redacted values. + """ + assert expected_redacted_value_list + + table_key = table.upper() + expected_sql_list = [ + sql for sql in sql_list + if table_key in sql.upper() and ('UPDATE' in sql.upper() or 'DELETE' in sql.upper()) + ] + + assert len(expected_sql_list) == num_redact_delete_pairs * 2, ( + f'Expected {num_redact_delete_pairs * 2} UPDATE/DELETE queries on {table}, ' + f'got {len(expected_sql_list)}' + ) + + for index in range(0, len(expected_sql_list), 2): + update_sql = expected_sql_list[index] + delete_sql = expected_sql_list[index + 1] + assert 'UPDATE' in update_sql.upper(), f'Expected UPDATE at position {index} for {table}' + assert 'DELETE' in delete_sql.upper(), f'Expected DELETE at position {index + 1} for {table}' + for expected_redacted_value in expected_redacted_value_list: + assert expected_redacted_value.upper() in update_sql.upper(), ( + f'Expected UPDATE to set redacted value {expected_redacted_value} for {table}' + ) + class CacheIsolationMixin: """ @@ -182,9 +227,9 @@ def is_unfiltered_query(query): if self.table_ignorelist: for table in self.table_ignorelist: # SQL contains the following format for columns: - # "table_name"."column_name". The regex ensures there is no - # "." before the name to avoid matching columns. - if re.search(fr'[^.]"{table}"', query['sql']): + # "table_name"."column_name" or table_name.column_name. + # The regex ensures there is no "." before the name to avoid matching columns. + if re.search(fr'[^."]"?{table}"?', query['sql']): return False return True @@ -195,7 +240,7 @@ def is_unfiltered_query(query): executed = len(filtered_queries) assert executed == self.num, ( - '%d queries executed, %d expected\nCaptured queries were:\n%s' % ( + '%d queries executed, %d expected\nCaptured queries were:\n%s' % ( # noqa: UP031 executed, self.num, '\n'.join(query['sql'] for query in filtered_queries) ) ) @@ -207,7 +252,7 @@ class FilteredQueryCountMixin: assertNumQueries with one that accepts a ignorelist of tables to filter out of the count. """ - def assertNumQueries(self, num, func=None, table_ignorelist=None, *args, **kwargs): # lint-amnesty, pylint: disable=keyword-arg-before-vararg + def assertNumQueries(self, num, func=None, table_ignorelist=None, *args, **kwargs): # pylint: disable=keyword-arg-before-vararg """ Used to replace Django's assertNumQueries with the same capability, with the addition of the following argument: diff --git a/openedx/core/djangolib/tests/test_js_utils.py b/openedx/core/djangolib/tests/test_js_utils.py index ee2afbebc43b..99cca3c48153 100644 --- a/openedx/core/djangolib/tests/test_js_utils.py +++ b/openedx/core/djangolib/tests/test_js_utils.py @@ -1,11 +1,11 @@ -# lint-amnesty, pylint: disable=bad-option-value, unicode-format-string +# pylint: disable=bad-option-value, unicode-format-string """ Tests for js_utils.py """ +import html import json import re -import html from unittest import TestCase from mako.template import Template @@ -30,7 +30,7 @@ class SampleJSONEncoder(json.JSONEncoder): A test encoder that is used to prove that the encoder does its job before the escaping. """ # pylint: disable=method-hidden - def default(self, noDefaultEncodingObj): # lint-amnesty, pylint: disable=arguments-differ + def default(self, noDefaultEncodingObj): # pylint: disable=arguments-differ return noDefaultEncodingObj.value.replace("" - expected_escaped_string_for_js = str( + expected_escaped_string_for_js = str( # noqa: UP018 r"\u003C/script\u003E\u003Cscript\u003Ealert(\u0027hello, \u0027)\u003B\u003C/script\u003E" ) escaped_string_for_js = js_escaped_string(malicious_js_string) diff --git a/openedx/core/djangolib/tests/test_model_mixins.py b/openedx/core/djangolib/tests/test_model_mixins.py new file mode 100644 index 000000000000..d0b70c5bf3ab --- /dev/null +++ b/openedx/core/djangolib/tests/test_model_mixins.py @@ -0,0 +1,90 @@ +""" +Tests for model_mixins.py. +""" + +from unittest import TestCase, mock + +import ddt + +from openedx.core.djangolib.model_mixins import DeletableByUserValue + + +@ddt.ddt +class TestDeletableByUserValue(TestCase): + """ + Unit tests for DeletableByUserValue. + """ + + class NonRedactingModel(DeletableByUserValue): + """ + Dummy model that uses default redaction behavior. + """ + + class RedactingModel(DeletableByUserValue): + """ + Dummy model that overrides redaction fields. + """ + + @classmethod + def redact_before_delete_fields(cls): + return {'email': 'redacted@retired.invalid'} + + def _make_queryset(self, exists): + """ + Return a mock queryset with ``exists`` and ``values_list`` pre-configured. + """ + queryset = mock.Mock() + queryset.exists.return_value = exists + queryset.values_list.return_value = [11, 12] if exists else [] + return queryset + + def test_redact_before_delete_fields_defaults_to_empty_dict(self): + """ + Verify the default redaction hook does not request any field updates. + """ + assert not self.NonRedactingModel.redact_before_delete_fields() + + def test_delete_by_user_value_returns_false_when_no_matches(self): + """ + Verify no updates or deletes occur when no rows match the filter. + """ + queryset = self._make_queryset(exists=False) + with mock.patch.object(self.NonRedactingModel, 'objects', create=True) as mock_objects: + mock_objects.filter.return_value = queryset + + was_deleted = self.NonRedactingModel.delete_by_user_value(value='missing@example.com', field='email') + + assert not was_deleted + mock_objects.filter.assert_called_once_with(email='missing@example.com') + queryset.update.assert_not_called() + queryset.delete.assert_not_called() + + @ddt.data( + ('NonRedactingModel', None), + ('RedactingModel', {'email': 'redacted@retired.invalid'}), + ) + @ddt.unpack + def test_delete_by_user_value(self, model_name, expected_redact_fields): + """ + Verify delete behavior with and without redaction configured. + + When no redaction hook is set, rows are deleted directly. + When a redaction hook is set, fields are updated before deletion. + """ + model_cls = getattr(self, model_name) + queryset = self._make_queryset(exists=True) + with mock.patch.object(model_cls, 'objects', create=True) as mock_objects: + mock_objects.filter.return_value = queryset + + was_deleted = model_cls.delete_by_user_value(value='learner@example.com', field='email') + + assert was_deleted + assert mock_objects.filter.call_args_list == [ + mock.call(email='learner@example.com'), + mock.call(id__in=[11, 12]), + ] + if expected_redact_fields: + queryset.update.assert_called_once_with(**expected_redact_fields) + else: + queryset.update.assert_not_called() + queryset.delete.assert_called_once_with() diff --git a/openedx/core/djangolib/tests/test_oauth2_retirement_utils.py b/openedx/core/djangolib/tests/test_oauth2_retirement_utils.py index e5465aa1d109..08d06244aa15 100644 --- a/openedx/core/djangolib/tests/test_oauth2_retirement_utils.py +++ b/openedx/core/djangolib/tests/test_oauth2_retirement_utils.py @@ -11,13 +11,13 @@ from oauth2_provider.models import Grant as DOTGrant from oauth2_provider.models import RefreshToken as DOTRefreshToken -from openedx.core.djangoapps.oauth_dispatch.tests import factories from common.djangoapps.student.tests.factories import UserFactory +from openedx.core.djangoapps.oauth_dispatch.tests import factories from ..oauth2_retirement_utils import retire_dot_oauth2_models -class RetireDOTModelsTest(TestCase): # lint-amnesty, pylint: disable=missing-class-docstring +class RetireDOTModelsTest(TestCase): # pylint: disable=missing-class-docstring def test_delete_dot_models(self): user = UserFactory.create() diff --git a/openedx/core/djangolib/tests/test_translation_utils.py b/openedx/core/djangolib/tests/test_translation_utils.py index 655504c3bb15..4b8e6ed07fa6 100644 --- a/openedx/core/djangolib/tests/test_translation_utils.py +++ b/openedx/core/djangolib/tests/test_translation_utils.py @@ -3,9 +3,9 @@ """ +import datetime import unittest -import datetime import ddt from openedx.core.djangolib.translation_utils import translate_date diff --git a/openedx/core/djangolib/translation_utils.py b/openedx/core/djangolib/translation_utils.py index 9bd5ea37773b..fc9ccfe7ca19 100644 --- a/openedx/core/djangolib/translation_utils.py +++ b/openedx/core/djangolib/translation_utils.py @@ -3,8 +3,8 @@ """ -from django.utils.translation import override from django.utils.formats import dateformat, get_format +from django.utils.translation import override def translate_date(date, language, date_format='DATE_FORMAT'): diff --git a/openedx/core/lib/.coveragerc b/openedx/core/lib/.coveragerc index 94ab6a513d39..a1e0a6404650 100644 --- a/openedx/core/lib/.coveragerc +++ b/openedx/core/lib/.coveragerc @@ -1,4 +1,4 @@ -# .coveragerc for Open edX core lib +# .coveragerc for openedx/core/lib [run] data_file = reports/openedx/core/lib/.coverage source = openedx/core/lib @@ -8,7 +8,7 @@ parallel = true ignore_errors = True [html] -title = Open edX Core Lib Python Test Coverage Report +title = openedx/core/lib Python Test Coverage Report directory = reports/openedx/core/lib/cover [xml] diff --git a/openedx/core/lib/__init__.py b/openedx/core/lib/__init__.py index b394a735a6cd..f0281b1f04e0 100644 --- a/openedx/core/lib/__init__.py +++ b/openedx/core/lib/__init__.py @@ -9,7 +9,6 @@ from django.conf import settings from django.core.exceptions import ImproperlyConfigured - _LMS_URLCONF = 'lms.urls' _CMS_URLCONF = 'cms.urls' diff --git a/openedx/core/lib/api/authentication.py b/openedx/core/lib/api/authentication.py index a762d398b378..a73287fcaa65 100644 --- a/openedx/core/lib/api/authentication.py +++ b/openedx/core/lib/api/authentication.py @@ -3,10 +3,10 @@ import logging import django.utils.timezone +from edx_django_utils.monitoring import set_custom_attribute from oauth2_provider import models as dot_models -from rest_framework.exceptions import AuthenticationFailed from rest_framework.authentication import BaseAuthentication, get_authorization_header -from edx_django_utils.monitoring import set_custom_attribute +from rest_framework.exceptions import AuthenticationFailed OAUTH2_TOKEN_ERROR = 'token_error' OAUTH2_TOKEN_ERROR_EXPIRED = 'token_expired' @@ -43,7 +43,7 @@ def authenticate(self, request): set_custom_attribute("BearerAuthentication", "Failed") # default value auth = get_authorization_header(request).split() - if len(auth) == 1: # lint-amnesty, pylint: disable=no-else-raise + if len(auth) == 1: # pylint: disable=no-else-raise raise AuthenticationFailed({ 'error_code': OAUTH2_TOKEN_ERROR_NOT_PROVIDED, 'developer_message': 'Invalid token header. No credentials provided.'}) @@ -75,12 +75,12 @@ def authenticate_credentials(self, access_token): try: token = self.get_access_token(access_token) except AuthenticationFailed as exc: - raise AuthenticationFailed({ # lint-amnesty, pylint: disable=raise-missing-from + raise AuthenticationFailed({ # pylint: disable=raise-missing-from # noqa: B904 'error_code': OAUTH2_TOKEN_ERROR, 'developer_message': exc.detail }) - if not token: # lint-amnesty, pylint: disable=no-else-raise + if not token: # pylint: disable=no-else-raise raise AuthenticationFailed({ 'error_code': OAUTH2_TOKEN_ERROR_NONEXISTENT, 'developer_message': 'The provided access token does not match any valid tokens.' @@ -94,15 +94,15 @@ def authenticate_credentials(self, access_token): user = token.user has_application = dot_models.Application.objects.filter(user_id=user.id) if not user.has_usable_password() and not has_application: - msg = 'User disabled by admin: %s' % user.get_username() + msg = 'User disabled by admin: %s' % user.get_username() # noqa: UP031 raise AuthenticationFailed({ 'error_code': OAUTH2_USER_DISABLED_ERROR, 'developer_message': msg}) # Check to make sure the users have activated their account (by confirming their email) - if not self.allow_inactive_users and not user.is_active: # lint-amnesty, pylint: disable=no-else-raise + if not self.allow_inactive_users and not user.is_active: # pylint: disable=no-else-raise set_custom_attribute("BearerAuthentication_user_active", False) - msg = 'User inactive or deleted: %s' % user.get_username() + msg = 'User inactive or deleted: %s' % user.get_username() # noqa: UP031 raise AuthenticationFailed({ 'error_code': OAUTH2_USER_NOT_ACTIVE_ERROR, 'developer_message': msg}) @@ -124,7 +124,7 @@ def authenticate_header(self, request): Return a string to be used as the value of the `WWW-Authenticate` header in a `401 Unauthenticated` response """ - return 'Bearer realm="%s"' % self.www_authenticate_realm + return 'Bearer realm="%s"' % self.www_authenticate_realm # noqa: UP031 class BearerAuthenticationAllowInactiveUser(BearerAuthentication): diff --git a/openedx/core/lib/api/fields.py b/openedx/core/lib/api/fields.py index 0f8e5ddf186d..6b7d929c4256 100644 --- a/openedx/core/lib/api/fields.py +++ b/openedx/core/lib/api/fields.py @@ -3,7 +3,7 @@ from rest_framework.serializers import Field, URLField -class ExpandableField(Field): # lint-amnesty, pylint: disable=abstract-method +class ExpandableField(Field): # pylint: disable=abstract-method """Field that can dynamically use a more detailed serializer based on a user-provided "expand" parameter. Kwargs: @@ -13,12 +13,12 @@ class ExpandableField(Field): # lint-amnesty, pylint: disable=abstract-method def __init__(self, **kwargs): """Sets up the ExpandableField with the collapsed and expanded versions of the serializer.""" - assert 'collapsed_serializer' in kwargs and 'expanded_serializer' in kwargs + assert 'collapsed_serializer' in kwargs and 'expanded_serializer' in kwargs # noqa: PT018 self.collapsed = kwargs.pop('collapsed_serializer') self.expanded = kwargs.pop('expanded_serializer') super().__init__(**kwargs) - def to_representation(self, obj): # lint-amnesty, pylint: disable=arguments-differ + def to_representation(self, obj): # pylint: disable=arguments-differ """ Return a representation of the field that is either expanded or collapsed. """ @@ -47,7 +47,7 @@ def to_representation(self, value): request = self.context.get('request', None) assert request is not None, ( - "`%s` requires the request in the serializer context. " + "`%s` requires the request in the serializer context. " # noqa: UP031 "Add `context={'request': request}` when instantiating the serializer." % self.__class__.__name__ ) diff --git a/openedx/core/lib/api/permissions.py b/openedx/core/lib/api/permissions.py index 7c5458684786..2e7b3492325c 100644 --- a/openedx/core/lib/api/permissions.py +++ b/openedx/core/lib/api/permissions.py @@ -6,13 +6,13 @@ from django.conf import settings from django.http import Http404 from edx_django_utils.monitoring import set_custom_attribute +from edx_rest_framework_extensions.permissions import IsStaff, IsUserInUrl from opaque_keys import InvalidKeyError from opaque_keys.edx.keys import CourseKey from rest_framework import permissions -from edx_rest_framework_extensions.permissions import IsStaff, IsUserInUrl -from openedx.core.lib.log_utils import audit_log from common.djangoapps.student.roles import CourseInstructorRole, CourseStaffRole +from openedx.core.lib.log_utils import audit_log class ApiKeyHeaderPermission(permissions.BasePermission): @@ -93,7 +93,7 @@ def has_permission(self, request, view): try: course_key = CourseKey.from_string(master_course_id) except InvalidKeyError: - raise Http404() # lint-amnesty, pylint: disable=raise-missing-from + raise Http404() # pylint: disable=raise-missing-from # noqa: B904 return (hasattr(request, 'user') and (CourseInstructorRole(course_key).has_user(request.user) or CourseStaffRole(course_key).has_user(request.user))) diff --git a/openedx/core/lib/api/serializers.py b/openedx/core/lib/api/serializers.py index dbcf4b304741..3775165627a3 100644 --- a/openedx/core/lib/api/serializers.py +++ b/openedx/core/lib/api/serializers.py @@ -13,7 +13,7 @@ class CollapsedReferenceSerializer(serializers.HyperlinkedModelSerializer): """Serializes arbitrary models in a collapsed format, with just an id and url.""" url = serializers.HyperlinkedIdentityField(view_name='') - def __init__(self, model_class, view_name, id_source='id', lookup_field=None, *args, **kwargs): # lint-amnesty, pylint: disable=keyword-arg-before-vararg + def __init__(self, model_class, view_name, id_source='id', lookup_field=None, *args, **kwargs): # pylint: disable=keyword-arg-before-vararg """Configures the serializer. Args: @@ -46,7 +46,7 @@ class Meta: class CourseKeyField(serializers.Field): """ Serializer field for a model CourseKey field. """ - def to_representation(self, data): # lint-amnesty, pylint: disable=arguments-differ + def to_representation(self, data): # pylint: disable=arguments-differ """Convert a course key to unicode. """ return str(data) @@ -61,7 +61,7 @@ def to_internal_value(self, data): class UsageKeyField(serializers.Field): """ Serializer field for a model UsageKey field. """ - def to_representation(self, data): # lint-amnesty, pylint: disable=arguments-differ + def to_representation(self, data): # pylint: disable=arguments-differ """Convert a usage key to unicode. """ return str(data) diff --git a/openedx/core/lib/api/test_utils.py b/openedx/core/lib/api/test_utils.py index 6a647b485427..1c716092e40a 100644 --- a/openedx/core/lib/api/test_utils.py +++ b/openedx/core/lib/api/test_utils.py @@ -49,7 +49,7 @@ def assertAllowedMethods(self, uri, expected_methods): allow_header = resp.get("Allow") assert allow_header is not None allowed_methods = re.split('[^A-Z]+', allow_header) - self.assertCountEqual(allowed_methods, expected_methods) + self.assertCountEqual(allowed_methods, expected_methods) # noqa: PT009 def assertSelfReferential(self, obj): """Assert that accessing the "url" entry in the given object returns the same object""" diff --git a/openedx/core/lib/api/tests/mixins.py b/openedx/core/lib/api/tests/mixins.py index 21da4509ec2a..e75701a771a4 100644 --- a/openedx/core/lib/api/tests/mixins.py +++ b/openedx/core/lib/api/tests/mixins.py @@ -4,9 +4,8 @@ from time import time -from django.conf import settings import jwt - +from django.conf import settings JWT_AUTH = 'JWT_AUTH' diff --git a/openedx/core/lib/api/tests/test_authentication.py b/openedx/core/lib/api/tests/test_authentication.py index 881f850cfd70..45c50b3d2307 100644 --- a/openedx/core/lib/api/tests/test_authentication.py +++ b/openedx/core/lib/api/tests/test_authentication.py @@ -12,9 +12,9 @@ from django.http import HttpResponse from django.test import TestCase from django.test.utils import override_settings +from django.urls import path from django.utils.http import urlencode from django.utils.timezone import now -from django.urls import path from oauth2_provider import models as dot_models from rest_framework import status from rest_framework.permissions import IsAuthenticated @@ -53,7 +53,7 @@ def put(self, _request): @ddt.ddt # pylint: disable=missing-docstring @override_settings(ROOT_URLCONF=__name__) -class OAuth2AllowInActiveUsersTests(TestCase): # lint-amnesty, pylint: disable=missing-class-docstring +class OAuth2AllowInActiveUsersTests(TestCase): # pylint: disable=missing-class-docstring OAUTH2_BASE_TESTING_URL = '/oauth2-inactive-test/' def setUp(self): @@ -142,7 +142,7 @@ def test_get_form_passing_auth_with_dot(self): def test_get_form_failing_auth_url_transport(self): """Ensure GETing form over OAuth with correct client credentials in query fails when DEBUG is False""" query = urlencode({'access_token': self.dot_access_token.token}) - response = self.csrf_client.get(self.OAUTH2_BASE_TESTING_URL + '?%s' % query) + response = self.csrf_client.get(self.OAUTH2_BASE_TESTING_URL + '?%s' % query) # noqa: UP031 assert response.status_code == status.HTTP_401_UNAUTHORIZED # This case is handled directly by DRF so no error_code is provided (yet). @@ -214,7 +214,7 @@ def test_response_for_post_request_with_bad_auth_token(self, token_error): self.check_error_codes(response, status_code=status.HTTP_401_UNAUTHORIZED, error_code=token_error.error_code) -class BearerAuthenticationTests(OAuth2AllowInActiveUsersTests): # lint-amnesty, pylint: disable=missing-class-docstring, test-inherits-tests +class BearerAuthenticationTests(OAuth2AllowInActiveUsersTests): # pylint: disable=missing-class-docstring, test-inherits-tests OAUTH2_BASE_TESTING_URL = '/oauth2-test/' diff --git a/openedx/core/lib/api/tests/test_fields.py b/openedx/core/lib/api/tests/test_fields.py index f23756fb0e4b..b58cbce213e0 100644 --- a/openedx/core/lib/api/tests/test_fields.py +++ b/openedx/core/lib/api/tests/test_fields.py @@ -27,7 +27,7 @@ def setUp(self): def test_to_representation_without_request(self): """ Verify an AssertionError is raised if no request is passed as context to the field. """ self.field._context = {} # pylint:disable=protected-access - self.assertRaises(AssertionError, self.field.to_representation, '/image.jpg') + self.assertRaises(AssertionError, self.field.to_representation, '/image.jpg') # noqa: PT027 @ddt.data( 'http://example.com', diff --git a/openedx/core/lib/api/tests/test_parsers.py b/openedx/core/lib/api/tests/test_parsers.py index f9af1e850c5d..79500f86a296 100644 --- a/openedx/core/lib/api/tests/test_parsers.py +++ b/openedx/core/lib/api/tests/test_parsers.py @@ -84,12 +84,12 @@ def test_parse_mismatched_filename_and_mimetype(self): HTTP_CONTENT_DISPOSITION='attachment; filename="file.jpg"', ) context = {'view': self.view, 'request': request} - with pytest.raises(exceptions.ParseError) as err: + with pytest.raises(exceptions.ParseError) as err: # noqa: PT012 self.parser.parse(stream=BytesIO(b'abcdefgh'), media_type='image/png', parser_context=context) assert 'developer_message' in err.detail - # lint-amnesty, pylint: disable=no-member + # pylint: disable=no-member assert 'user_message' not in err.detail - # lint-amnesty, pylint: disable=no-member + # pylint: disable=no-member def test_no_acceptable_types(self): """ @@ -105,9 +105,9 @@ def test_no_acceptable_types(self): HTTP_CONTENT_DISPOSITION='attachment; filename="file.png"', ) context = {'view': view, 'request': request} - with pytest.raises(exceptions.UnsupportedMediaType) as err: + with pytest.raises(exceptions.UnsupportedMediaType) as err: # noqa: PT012 self.parser.parse(stream=BytesIO(b'abcdefgh'), media_type='image/png', parser_context=context) assert 'developer_message' in err.detail - # lint-amnesty, pylint: disable=no-member + # pylint: disable=no-member assert 'user_message' in err.detail - # lint-amnesty, pylint: disable=no-member + # pylint: disable=no-member diff --git a/openedx/core/lib/api/tests/test_view_utils.py b/openedx/core/lib/api/tests/test_view_utils.py index 2886dd806354..386ac6c7164f 100644 --- a/openedx/core/lib/api/tests/test_view_utils.py +++ b/openedx/core/lib/api/tests/test_view_utils.py @@ -8,9 +8,11 @@ from rest_framework.views import APIView from openedx.core.djangoapps.content.course_overviews.models import CourseOverview -from xmodule.modulestore import ModuleStoreEnum # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore import ModuleStoreEnum # pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + SharedModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order from ..view_utils import DeveloperErrorViewMixin, verify_course_exists diff --git a/openedx/core/lib/api/view_utils.py b/openedx/core/lib/api/view_utils.py index d876e49ae579..57cc9d0de95f 100644 --- a/openedx/core/lib/api/view_utils.py +++ b/openedx/core/lib/api/view_utils.py @@ -97,7 +97,7 @@ def handle_exception(self, exc): elif isinstance(exc, ValidationError): return self._make_validation_error_response(exc) else: - raise # lint-amnesty, pylint: disable=misplaced-bare-raise + raise # pylint: disable=misplaced-bare-raise class ExpandableFieldViewMixin: @@ -156,7 +156,7 @@ def add_serializer_errors(serializer, data, field_errors): for key, error in errors.items(): error = clean_errors(error) if key == 'bio': - user_message = _(f"The about me field must be at most {BIO_MAX_LENGTH} characters long.") # lint-amnesty, pylint: disable=translation-of-non-string + user_message = _(f"The about me field must be at most {BIO_MAX_LENGTH} characters long.") # pylint: disable=translation-of-non-string else: user_message = _("This value is invalid.") @@ -180,7 +180,7 @@ def build_api_error(message, **kwargs): """ return { 'developer_message': message.format(**kwargs), - 'user_message': _(message).format(**kwargs), # lint-amnesty, pylint: disable=translation-of-non-string + 'user_message': _(message).format(**kwargs), # pylint: disable=translation-of-non-string } @@ -291,7 +291,7 @@ def __getitem__(self, index): self._data.append(next(self.iterable)) except StopIteration: self._exhausted = True - raise IndexError("Underlying sequence exhausted") # lint-amnesty, pylint: disable=raise-missing-from + raise IndexError("Underlying sequence exhausted") # pylint: disable=raise-missing-from # noqa: B904 return self._data[index] elif isinstance(index, slice): @@ -324,12 +324,12 @@ def __getitem__(self, index): def __repr__(self): if self._exhausted: - return "LazySequence({!r}, {!r})".format( + return "LazySequence({!r}, {!r})".format( # noqa: UP032 self._data, self.est_len, ) else: - return "LazySequence(itertools.chain({!r}, {!r}), {!r})".format( + return "LazySequence(itertools.chain({!r}, {!r}), {!r})".format( # noqa: UP032 self._data, self.iterable, self.est_len, @@ -347,10 +347,10 @@ def paginator(self): The paginator instance associated with the view, or `None`. """ if not hasattr(self, '_paginator'): - if self.pagination_class is None: # lint-amnesty, pylint: disable=no-member + if self.pagination_class is None: # pylint: disable=no-member self._paginator = None else: - self._paginator = self.pagination_class() # lint-amnesty, pylint: disable=no-member + self._paginator = self.pagination_class() # pylint: disable=no-member return self._paginator def paginate_queryset(self, queryset): diff --git a/openedx/core/lib/cache_utils.py b/openedx/core/lib/cache_utils.py index a889da6130ee..dd80ceb9ccd1 100644 --- a/openedx/core/lib/cache_utils.py +++ b/openedx/core/lib/cache_utils.py @@ -6,13 +6,12 @@ import collections import functools import itertools -import zlib import pickle +import zlib import wrapt -from django.db.models.signals import post_save, post_delete +from django.db.models.signals import post_delete, post_save from django.utils.encoding import force_str - from edx_django_utils.cache import RequestCache, TieredCache diff --git a/openedx/core/lib/celery/routers.py b/openedx/core/lib/celery/routers.py index 3f61bf65bf09..cf13d1bbf7b0 100644 --- a/openedx/core/lib/celery/routers.py +++ b/openedx/core/lib/celery/routers.py @@ -8,7 +8,6 @@ from django.conf import settings - log = logging.getLogger(__name__) diff --git a/openedx/core/lib/celery/task_utils.py b/openedx/core/lib/celery/task_utils.py index 10a3809fa651..845b10c76af2 100644 --- a/openedx/core/lib/celery/task_utils.py +++ b/openedx/core/lib/celery/task_utils.py @@ -6,6 +6,7 @@ from crum import CurrentRequestUserMiddleware from django.http import HttpResponse + from openedx.core.djangoapps.theming.middleware import CurrentSiteThemeMiddleware from openedx.core.lib.request_utils import get_request_or_stub diff --git a/openedx/core/lib/command_utils.py b/openedx/core/lib/command_utils.py index dd9936f5dd65..add0b89063d8 100644 --- a/openedx/core/lib/command_utils.py +++ b/openedx/core/lib/command_utils.py @@ -46,4 +46,4 @@ def parse_course_keys(course_key_strings): try: return [CourseKey.from_string(course_key_string) for course_key_string in course_key_strings] except InvalidKeyError as error: - raise CommandError(f'Invalid key specified: {str(error)}') # lint-amnesty, pylint: disable=raise-missing-from + raise CommandError(f'Invalid key specified: {str(error)}') # pylint: disable=raise-missing-from # noqa: B904 diff --git a/openedx/core/lib/course_tabs.py b/openedx/core/lib/course_tabs.py index bfb9de749bc9..046f944780c3 100644 --- a/openedx/core/lib/course_tabs.py +++ b/openedx/core/lib/course_tabs.py @@ -2,9 +2,9 @@ Tabs for courseware. """ -from edx_django_utils.plugins import PluginManager -from functools import cmp_to_key # lint-amnesty, pylint: disable=wrong-import-order +from functools import cmp_to_key # pylint: disable=wrong-import-order +from edx_django_utils.plugins import PluginManager # Stevedore extension point namespaces COURSE_TAB_NAMESPACE = 'openedx.course_tab' diff --git a/openedx/core/lib/courses.py b/openedx/core/lib/courses.py index 98321abfef77..eb879d5453c9 100644 --- a/openedx/core/lib/courses.py +++ b/openedx/core/lib/courses.py @@ -5,10 +5,10 @@ from django import forms from django.conf import settings from django.http import Http404 - from opaque_keys import InvalidKeyError from opaque_keys.edx.locator import CourseKey from organizations.models import Organization + from xmodule.assetstore.assetmgr import AssetManager from xmodule.contentstore.content import StaticContent from xmodule.contentstore.django import contentstore @@ -83,7 +83,7 @@ def clean_course_id(model_form, is_required=True): course_key = CourseKey.from_string(cleaned_id) except InvalidKeyError: msg = f'Course id invalid. Entered course id was: "{cleaned_id}".' - raise forms.ValidationError(msg) # lint-amnesty, pylint: disable=raise-missing-from + raise forms.ValidationError(msg) # pylint: disable=raise-missing-from # noqa: B904 if not modulestore().has_course(course_key): msg = f'Course not found. Entered course id was: "{str(course_key)}".' diff --git a/openedx/core/lib/derived.py b/openedx/core/lib/derived.py index 745d6f1262f8..366573337471 100644 --- a/openedx/core/lib/derived.py +++ b/openedx/core/lib/derived.py @@ -11,14 +11,13 @@ import types import typing as t - -Settings: t.TypeAlias = types.ModuleType +Settings: t.TypeAlias = types.ModuleType # noqa: UP040 T = t.TypeVar('T') -class Derived(t.Generic[T]): +class Derived(t.Generic[T]): # noqa: UP046 """ A temporary Django setting value, defined with a function which generates the setting's eventual value. diff --git a/openedx/core/lib/django_require/staticstorage.py b/openedx/core/lib/django_require/staticstorage.py index e718dbd87653..59e590b144e6 100644 --- a/openedx/core/lib/django_require/staticstorage.py +++ b/openedx/core/lib/django_require/staticstorage.py @@ -12,4 +12,4 @@ class OptimizedCachedRequireJsStorage(OptimizedFilesMixin, PipelineForgivingMixi """ Custom storage backend that is used by Django-require. """ - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass diff --git a/openedx/core/lib/edx_api_utils.py b/openedx/core/lib/edx_api_utils.py index 90c45ce17eaa..0ec4eed9c98c 100644 --- a/openedx/core/lib/edx_api_utils.py +++ b/openedx/core/lib/edx_api_utils.py @@ -2,7 +2,7 @@ import logging -from typing import TYPE_CHECKING, Any, Dict, List, Optional, Union +from typing import TYPE_CHECKING, Any, Dict, List, Optional, Union # noqa: UP035 from urllib.parse import urljoin from django.core.cache import cache @@ -28,15 +28,15 @@ def get_api_data( resource: str, api_client: "session", base_api_url: str, - resource_id: Optional[Union[int, str]] = None, - querystring: Optional[Dict[Any, Any]] = None, - cache_key: Optional[str] = None, + resource_id: Optional[Union[int, str]] = None, # noqa: UP007, UP045 + querystring: Optional[Dict[Any, Any]] = None, # noqa: UP006, UP045 + cache_key: Optional[str] = None, # noqa: UP045 many: bool = True, traverse_pagination: bool = True, - fields: Optional[List[Any]] = None, + fields: Optional[List[Any]] = None, # noqa: UP006, UP045 long_term_cache: bool = False, raise_on_error: bool = False, -) -> Union[List[Any], Dict[Any, Any]]: +) -> Union[List[Any], Dict[Any, Any]]: # noqa: UP006, UP007 """ GET data from an edX REST API endpoint using the API client. diff --git a/openedx/core/lib/exceptions.py b/openedx/core/lib/exceptions.py index 7a49dd535660..988378b7cbd0 100644 --- a/openedx/core/lib/exceptions.py +++ b/openedx/core/lib/exceptions.py @@ -9,18 +9,18 @@ class CourseNotFoundError(ObjectDoesNotExist): """ Course was not found. """ - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass class PageNotFoundError(ObjectDoesNotExist): """ Page was not found. Used for paginated endpoint. """ - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass class DiscussionNotFoundError(ObjectDoesNotExist): """ Discussion Block was not found. """ - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass diff --git a/openedx/core/lib/extract_archive.py b/openedx/core/lib/extract_archive.py index 4706e0caffb7..d3de59c2527f 100644 --- a/openedx/core/lib/extract_archive.py +++ b/openedx/core/lib/extract_archive.py @@ -7,12 +7,11 @@ """ import logging -from os.path import abspath, dirname +from os.path import abspath, dirname, realpath from os.path import join as joinpath -from os.path import realpath -from typing import List, Union -from zipfile import ZipFile, ZipInfo from tarfile import TarFile, TarInfo +from typing import List, Union # noqa: UP035 +from zipfile import ZipFile, ZipInfo from django.conf import settings from django.core.exceptions import SuspiciousOperation @@ -65,7 +64,7 @@ def _check_tarinfo(finfo: TarInfo, base: str): raise SuspiciousOperation("Dev file") -def _checkmembers(members: Union[List[ZipInfo], List[TarInfo]], base: str): +def _checkmembers(members: Union[List[ZipInfo], List[TarInfo]], base: str): # noqa: UP006, UP007 """ Check that all elements of the archive file are safe. """ diff --git a/openedx/core/lib/features_setting_proxy.py b/openedx/core/lib/features_setting_proxy.py index 9de2b3c44d93..eb38ad7f9100 100644 --- a/openedx/core/lib/features_setting_proxy.py +++ b/openedx/core/lib/features_setting_proxy.py @@ -2,8 +2,7 @@ Features Proxy Implementation """ import warnings - -from collections.abc import MutableMapping, Mapping +from collections.abc import Mapping, MutableMapping class FeaturesProxy(MutableMapping): diff --git a/openedx/core/lib/gating/api.py b/openedx/core/lib/gating/api.py index 4cd53598c017..93e5cc869515 100644 --- a/openedx/core/lib/gating/api.py +++ b/openedx/core/lib/gating/api.py @@ -6,20 +6,20 @@ import logging from completion.models import BlockCompletion -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.urls import reverse from django.utils.translation import gettext as _ from milestones import api as milestones_api from opaque_keys.edx.keys import UsageKey from xblock.completable import XBlockCompletionMode as CompletionMode +from common.djangoapps.util import milestones_helpers from lms.djangoapps.course_blocks.api import get_course_blocks from lms.djangoapps.courseware.access import _has_access_to_course from lms.djangoapps.grades.api import SubsectionGradeFactory from openedx.core.lib.gating.exceptions import GatingValidationError -from common.djangoapps.util import milestones_helpers -from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.exceptions import ItemNotFoundError # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order +from xmodule.modulestore.exceptions import ItemNotFoundError # pylint: disable=wrong-import-order log = logging.getLogger(__name__) @@ -37,7 +37,7 @@ def _get_prerequisite_milestone(prereq_content_key): Returns: dict: Milestone dict """ - milestones = milestones_api.get_milestones("{usage_key}{qualifier}".format( + milestones = milestones_api.get_milestones("{usage_key}{qualifier}".format( # noqa: UP032 usage_key=prereq_content_key, qualifier=GATING_NAMESPACE_QUALIFIER )) @@ -72,7 +72,7 @@ def _validate_min_score(min_score): try: min_score = int(min_score) except ValueError: - raise GatingValidationError(message) # lint-amnesty, pylint: disable=raise-missing-from + raise GatingValidationError(message) # pylint: disable=raise-missing-from # noqa: B904 if min_score < 0 or min_score > 100: raise GatingValidationError(message) @@ -184,7 +184,7 @@ def add_prerequisite(course_key, prereq_content_key): milestone = milestones_api.add_milestone( { 'name': _('Gating milestone for {usage_key}').format(usage_key=str(prereq_content_key)), - 'namespace': "{usage_key}{qualifier}".format( + 'namespace': "{usage_key}{qualifier}".format( # noqa: UP032 usage_key=prereq_content_key, qualifier=GATING_NAMESPACE_QUALIFIER ), @@ -206,7 +206,7 @@ def remove_prerequisite(prereq_content_key): Returns: None """ - milestones = milestones_api.get_milestones("{usage_key}{qualifier}".format( + milestones = milestones_api.get_milestones("{usage_key}{qualifier}".format( # noqa: UP032 usage_key=prereq_content_key, qualifier=GATING_NAMESPACE_QUALIFIER )) diff --git a/openedx/core/lib/gating/exceptions.py b/openedx/core/lib/gating/exceptions.py index 41c4a01e836b..26e48b1c0aa4 100644 --- a/openedx/core/lib/gating/exceptions.py +++ b/openedx/core/lib/gating/exceptions.py @@ -7,4 +7,4 @@ class GatingValidationError(Exception): """ Exception class for validation errors related to course gating information """ - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass diff --git a/openedx/core/lib/gating/tests/test_api.py b/openedx/core/lib/gating/tests/test_api.py index 58f3e4b67e32..3afe84a06a87 100644 --- a/openedx/core/lib/gating/tests/test_api.py +++ b/openedx/core/lib/gating/tests/test_api.py @@ -9,18 +9,18 @@ from ddt import data, ddt, unpack from milestones import api as milestones_api from milestones.tests.utils import MilestonesTestCaseMixin -from xmodule.modulestore.tests.django_utils import TEST_DATA_SPLIT_MODULESTORE, ModuleStoreTestCase -from xmodule.modulestore.tests.factories import CourseFactory, BlockFactory from common.djangoapps.student.tests.factories import UserFactory -from openedx.core.djangolib.testing.utils import skip_unless_lms from lms.djangoapps.gating import api as lms_gating_api from lms.djangoapps.grades.constants import GradeOverrideFeatureEnum from lms.djangoapps.grades.models import PersistentSubsectionGrade, PersistentSubsectionGradeOverride from lms.djangoapps.grades.tests.base import GradeTestBase from lms.djangoapps.grades.tests.utils import mock_get_score +from openedx.core.djangolib.testing.utils import skip_unless_lms from openedx.core.lib.gating import api as gating_api from openedx.core.lib.gating.exceptions import GatingValidationError +from xmodule.modulestore.tests.django_utils import TEST_DATA_SPLIT_MODULESTORE, ModuleStoreTestCase +from xmodule.modulestore.tests.factories import BlockFactory, CourseFactory @ddt diff --git a/openedx/core/lib/graph_traversals.py b/openedx/core/lib/graph_traversals.py index 027b050a4f03..4660d247a021 100644 --- a/openedx/core/lib/graph_traversals.py +++ b/openedx/core/lib/graph_traversals.py @@ -116,7 +116,7 @@ def traverse_topologically( start_node, get_parents, - get_children, # lint-amnesty, pylint: disable=redefined-outer-name + get_children, # pylint: disable=redefined-outer-name filter_func=None, yield_descendants_of_unyielded=False, ): @@ -161,7 +161,7 @@ def traverse_topologically( ) -def traverse_pre_order(start_node, get_children, filter_func=None): # lint-amnesty, pylint: disable=redefined-outer-name +def traverse_pre_order(start_node, get_children, filter_func=None): # pylint: disable=redefined-outer-name """ Generator for yielding nodes of a tree (or directed acyclic graph) in a pre-order sort. @@ -178,7 +178,7 @@ def traverse_pre_order(start_node, get_children, filter_func=None): # lint-amne ) -def traverse_post_order(start_node, get_children, filter_func=None): # lint-amnesty, pylint: disable=redefined-outer-name +def traverse_post_order(start_node, get_children, filter_func=None): # pylint: disable=redefined-outer-name """ Generator for yielding nodes of a tree (or directed acyclic graph) in a post-order sort. @@ -192,7 +192,7 @@ class _Node: An active iterator is needed in order to determine when all children are visited and so the node itself should be visited. """ - def __init__(self, node, get_children): # lint-amnesty, pylint: disable=redefined-outer-name + def __init__(self, node, get_children): # pylint: disable=redefined-outer-name self.node = node self.children = iter(get_children(node)) @@ -237,7 +237,7 @@ def __init__(self, node, get_children): # lint-amnesty, pylint: disable=redefin def _traverse_generic( start_node, get_parents, - get_children, # lint-amnesty, pylint: disable=redefined-outer-name + get_children, # pylint: disable=redefined-outer-name filter_func=None, yield_descendants_of_unyielded=False, ): diff --git a/openedx/core/lib/hash_utils.py b/openedx/core/lib/hash_utils.py index 2c7956345819..d0c283013d53 100644 --- a/openedx/core/lib/hash_utils.py +++ b/openedx/core/lib/hash_utils.py @@ -6,9 +6,10 @@ random tokens """ import hashlib -from django.utils.encoding import force_bytes -from django.utils.crypto import get_random_string + from django.conf import settings +from django.utils.crypto import get_random_string +from django.utils.encoding import force_bytes def create_hash256(max_length=None): diff --git a/openedx/core/lib/html_to_text.py b/openedx/core/lib/html_to_text.py index fdb851840cae..67d480be4702 100644 --- a/openedx/core/lib/html_to_text.py +++ b/openedx/core/lib/html_to_text.py @@ -12,7 +12,7 @@ def html_to_text(html_message): Currently uses lynx in a subprocess; should be refactored to use something more pythonic. """ - process = Popen( # lint-amnesty, pylint: disable=consider-using-with + process = Popen( # pylint: disable=consider-using-with ['lynx', '-stdin', '-display_charset=UTF-8', '-assume_charset=UTF-8', '-dump'], stdin=PIPE, stdout=PIPE diff --git a/openedx/core/lib/json_utils.py b/openedx/core/lib/json_utils.py index 5befd82e9d88..928c2105c770 100644 --- a/openedx/core/lib/json_utils.py +++ b/openedx/core/lib/json_utils.py @@ -4,6 +4,7 @@ import datetime + from django.core.serializers.json import DjangoJSONEncoder from opaque_keys.edx.keys import CourseKey, UsageKey diff --git a/openedx/core/lib/jwt.py b/openedx/core/lib/jwt.py index 199c6fead8c2..4223a9bd0b18 100644 --- a/openedx/core/lib/jwt.py +++ b/openedx/core/lib/jwt.py @@ -2,9 +2,9 @@ JWT Token handling and signing functions. """ -import jwt from time import time +import jwt from django.conf import settings from jwt.api_jwk import PyJWK, PyJWKSet from jwt.exceptions import ExpiredSignatureError, InvalidSignatureError, MissingRequiredClaimError diff --git a/openedx/core/lib/license/__init__.py b/openedx/core/lib/license/__init__.py index e120a77eb61c..9b719c61c27c 100644 --- a/openedx/core/lib/license/__init__.py +++ b/openedx/core/lib/license/__init__.py @@ -1,3 +1,3 @@ -# lint-amnesty, pylint: disable=missing-module-docstring -from .mixin import LicenseMixin -from .wrapper import wrap_with_license +# pylint: disable=missing-module-docstring +from .mixin import LicenseMixin # noqa: F401 +from .wrapper import wrap_with_license # noqa: F401 diff --git a/openedx/core/lib/logsettings.py b/openedx/core/lib/logsettings.py index ee78b26623ad..cd19581b8c7e 100644 --- a/openedx/core/lib/logsettings.py +++ b/openedx/core/lib/logsettings.py @@ -10,7 +10,7 @@ LOG_LEVELS = ['DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL'] -def get_logger_config(log_dir, # lint-amnesty, pylint: disable=unused-argument +def get_logger_config(log_dir, # pylint: disable=unused-argument logging_env="no_env", local_loglevel='INFO', service_variant=""): @@ -28,7 +28,7 @@ def get_logger_config(log_dir, # lint-amnesty, pylint: disable=unused-argument local_loglevel = 'INFO' hostname = platform.node().split(".")[0] - syslog_format = ("[service_variant={service_variant}]" + syslog_format = ("[service_variant={service_variant}]" # noqa: UP032 "[%(name)s][env:{logging_env}] %(levelname)s " "[{hostname} %(process)d] [user %(userid)s] [ip %(remoteip)s] [%(filename)s:%(lineno)d] " "- %(message)s").format(service_variant=service_variant, @@ -171,7 +171,7 @@ def get_docker_logger_config(log_dir='/var/tmp', """ hostname = platform.node().split(".")[0] - syslog_format = ( + syslog_format = ( # noqa: UP032 "[service_variant={service_variant}]" "[%(name)s][env:{logging_env}] %(levelname)s " "[{hostname} %(process)d] [%(filename)s:%(lineno)d] " diff --git a/openedx/core/lib/safe_lxml/__init__.py b/openedx/core/lib/safe_lxml/__init__.py index d7d5239c5102..6976e10d4102 100644 --- a/openedx/core/lib/safe_lxml/__init__.py +++ b/openedx/core/lib/safe_lxml/__init__.py @@ -10,6 +10,7 @@ def defuse_xml_libs(): import lxml import lxml.etree + from . import etree as safe_etree lxml.etree = safe_etree diff --git a/openedx/core/lib/safe_lxml/conftest.py b/openedx/core/lib/safe_lxml/conftest.py index afddae8356b8..c1d7878e084b 100644 --- a/openedx/core/lib/safe_lxml/conftest.py +++ b/openedx/core/lib/safe_lxml/conftest.py @@ -3,5 +3,4 @@ """ from openedx.core.lib.safe_lxml import defuse_xml_libs - defuse_xml_libs() diff --git a/openedx/core/lib/safe_lxml/etree.py b/openedx/core/lib/safe_lxml/etree.py index 9b685ac66162..08e55c93c2c6 100644 --- a/openedx/core/lib/safe_lxml/etree.py +++ b/openedx/core/lib/safe_lxml/etree.py @@ -1,3 +1,4 @@ +# ruff: noqa: I001 """ Safer version of lxml.etree. @@ -5,8 +6,6 @@ It also includes a safer XMLParser. For processing xml always prefer this over using lxml.etree directly. - -isort:skip_file """ # Names are imported into this module so that it can be a stand-in for @@ -15,11 +14,11 @@ from lxml.etree import XMLParser as _XMLParser -from lxml.etree import * # lint-amnesty, pylint: disable=redefined-builtin +from lxml.etree import * # pylint: disable=redefined-builtin # noqa: F403 # These private elements are used in some libraries to also defuse xml exploits for their own purposes. # We need to re-expose them so that the libraries still work. -from lxml.etree import _Comment, _Element, _ElementTree, _Entity, _ProcessingInstruction -from .xmlparser import XML, fromstring, parse +from lxml.etree import _Comment, _Element, _ElementTree, _Entity, _ProcessingInstruction # noqa: F401 +from .xmlparser import XML, fromstring, parse # noqa: F401 class XMLParser(_XMLParser): # pylint: disable=function-redefined @@ -30,4 +29,4 @@ class XMLParser(_XMLParser): # pylint: disable=function-redefined def __init__(self, *args, **kwargs): if "resolve_entities" not in kwargs: kwargs["resolve_entities"] = False - super(XMLParser, self).__init__(*args, **kwargs) # lint-amnesty, pylint: disable=super-with-arguments + super(XMLParser, self).__init__(*args, **kwargs) # pylint: disable=super-with-arguments # noqa: UP008 diff --git a/openedx/core/lib/safe_lxml/tests.py b/openedx/core/lib/safe_lxml/tests.py index 23e16d24d420..bd20452c29d5 100644 --- a/openedx/core/lib/safe_lxml/tests.py +++ b/openedx/core/lib/safe_lxml/tests.py @@ -3,11 +3,11 @@ """ -from lxml import etree +import pytest from defusedxml.common import EntitiesForbidden -from .xmlparser import fromstring +from lxml import etree -import pytest +from .xmlparser import fromstring def test_entities_arent_resolved_exception(): diff --git a/openedx/core/lib/safe_lxml/xmlparser.py b/openedx/core/lib/safe_lxml/xmlparser.py index a463ff31477e..5512305d17a8 100644 --- a/openedx/core/lib/safe_lxml/xmlparser.py +++ b/openedx/core/lib/safe_lxml/xmlparser.py @@ -2,7 +2,7 @@ # """lxml.etree protection""" -from __future__ import absolute_import, print_function +from __future__ import absolute_import, print_function # noqa: UP010 import threading @@ -41,12 +41,12 @@ def iterchildren(self, tag=None, reversed=False): # pylint: disable=redefined-b def iter(self, tag=None, *tags): # pylint: disable=keyword-arg-before-vararg """Iterate over the element tree excluding blacklisted nodes.""" - iterator = super().iter(tag=tag, *tags) + iterator = super().iter(tag=tag, *tags) # noqa: B026 return self._filter(iterator) def iterdescendants(self, tag=None, *tags): # pylint: disable=keyword-arg-before-vararg """Iterate over descendants while filtering out blacklisted nodes.""" - iterator = super().iterdescendants(tag=tag, *tags) + iterator = super().iterdescendants(tag=tag, *tags) # noqa: B026 return self._filter(iterator) def itersiblings(self, tag=None, preceding=False): diff --git a/openedx/core/lib/teams_config.py b/openedx/core/lib/teams_config.py index 7210eed0f02f..61ed16c55651 100644 --- a/openedx/core/lib/teams_config.py +++ b/openedx/core/lib/teams_config.py @@ -7,9 +7,10 @@ from django.utils.functional import cached_property from django.utils.translation import gettext_lazy as _ -from openedx.core.djangoapps.waffle_utils import CourseWaffleFlag +from openedx.core.djangoapps.waffle_utils import CourseWaffleFlag from xmodule.partitions.partitions import UserPartition, UserPartitionError + log = logging.getLogger(__name__) # "Arbitrarily large" but still limited @@ -177,7 +178,7 @@ def calc_max_team_size(self, teamset_id): try: teamset = self.teamsets_by_id[teamset_id] except KeyError: - raise ValueError(f"Team-set {teamset_id!r} does not exist.") # lint-amnesty, pylint: disable=raise-missing-from + raise ValueError(f"Team-set {teamset_id!r} does not exist.") # pylint: disable=raise-missing-from # noqa: B904 if teamset.teamset_type != TeamsetType.open: return MANAGED_TEAM_MAX_TEAM_SIZE if teamset.max_team_size: diff --git a/openedx/core/lib/tests/assertions/events.py b/openedx/core/lib/tests/assertions/events.py index 65d1fffdb3b0..a62f64db99f7 100644 --- a/openedx/core/lib/tests/assertions/events.py +++ b/openedx/core/lib/tests/assertions/events.py @@ -234,7 +234,7 @@ def compare_structs(expected, actual, should_strict_compare=None, path=None): differences.extend(child_differences) elif expected != actual: - differences.append('{path}: {a} != {b} (expected != actual)'.format( + differences.append('{path}: {a} != {b} (expected != actual)'.format( # noqa: UP032 path=_path_to_string(path), a=repr(expected), b=repr(actual) diff --git a/openedx/core/lib/tests/test_cache_utils.py b/openedx/core/lib/tests/test_cache_utils.py index e417a72dace5..9998f54793d3 100644 --- a/openedx/core/lib/tests/test_cache_utils.py +++ b/openedx/core/lib/tests/test_cache_utils.py @@ -6,9 +6,9 @@ from unittest.mock import Mock import ddt -from edx_django_utils.cache import RequestCache from django.core.cache import cache from django.test.utils import override_settings +from edx_django_utils.cache import RequestCache from openedx.core.lib.cache_utils import CacheService, request_cached @@ -18,7 +18,7 @@ class TestRequestCachedDecorator(TestCase): """ Test the request_cached decorator. """ - def setUp(self): # lint-amnesty, pylint: disable=super-method-not-called + def setUp(self): # pylint: disable=super-method-not-called RequestCache.clear_all_namespaces() def test_request_cached_miss_and_then_hit(self): @@ -33,7 +33,7 @@ def mock_wrapper(*args, **kwargs): """Simple wrapper to let us decorate our mock.""" return to_be_wrapped(*args, **kwargs) - wrapped = request_cached()(mock_wrapper) # lint-amnesty, pylint: disable=no-value-for-parameter + wrapped = request_cached()(mock_wrapper) # pylint: disable=no-value-for-parameter result = wrapped() assert result == 42 assert to_be_wrapped.call_count == 1 @@ -54,7 +54,7 @@ def mock_wrapper(*args, **kwargs): """Simple wrapper to let us decorate our mock.""" return to_be_wrapped(*args, **kwargs) - wrapped = request_cached()(mock_wrapper) # lint-amnesty, pylint: disable=no-value-for-parameter + wrapped = request_cached()(mock_wrapper) # pylint: disable=no-value-for-parameter result = wrapped() assert result == 1 assert to_be_wrapped.call_count == 1 @@ -88,7 +88,7 @@ def mock_wrapper(*args, **kwargs): """Simple wrapper to let us decorate our mock.""" return to_be_wrapped(*args, **kwargs) - wrapped = request_cached()(mock_wrapper) # lint-amnesty, pylint: disable=no-value-for-parameter + wrapped = request_cached()(mock_wrapper) # pylint: disable=no-value-for-parameter # This will be a miss, and make an underlying call. result = wrapped(1) @@ -127,7 +127,7 @@ def mock_wrapper(*args, **kwargs): """Simple wrapper to let us decorate our mock.""" return to_be_wrapped(*args, **kwargs) - wrapped = request_cached()(mock_wrapper) # lint-amnesty, pylint: disable=no-value-for-parameter + wrapped = request_cached()(mock_wrapper) # pylint: disable=no-value-for-parameter # This will be a miss, and make an underlying call. result = wrapped(1, foo=1) @@ -183,7 +183,7 @@ def dummy_function(arg1, arg2): assert dummy_function('Hello', 'World'), 'Should be callable with ASCII chars' assert dummy_function('H∂llå', 'Wørld'), 'Should be callable with non-ASCII chars' - wrapped = request_cached()(dummy_function) # lint-amnesty, pylint: disable=no-value-for-parameter + wrapped = request_cached()(dummy_function) # pylint: disable=no-value-for-parameter assert wrapped('Hello', 'World'), 'Wrapper should handle ASCII only chars' assert wrapped('H∂llå', 'Wørld'), 'Wrapper should handle non-ASCII chars' @@ -202,7 +202,7 @@ def mock_wrapper(*args, **kwargs): """Simple wrapper to let us decorate our mock.""" return to_be_wrapped(*args, **kwargs) - wrapped = request_cached()(mock_wrapper) # lint-amnesty, pylint: disable=no-value-for-parameter + wrapped = request_cached()(mock_wrapper) # pylint: disable=no-value-for-parameter # This will be a miss, and make an underlying call. result = wrapped(1) @@ -242,7 +242,7 @@ def mock_wrapper(*args, **kwargs): return to_be_wrapped(*args, **kwargs) request_cache_getter = lambda args, kwargs: RequestCache('test') - wrapped = request_cached(request_cache_getter=request_cache_getter)(mock_wrapper) # lint-amnesty, pylint: disable=no-value-for-parameter + wrapped = request_cached(request_cache_getter=request_cache_getter)(mock_wrapper) # pylint: disable=no-value-for-parameter # This will be a miss, and make an underlying call. result = wrapped(1) @@ -277,7 +277,7 @@ def mock_wrapper(*args, **kwargs): return to_be_wrapped(*args, **kwargs) arg_map_function = lambda arg: str(arg == 1) - wrapped = request_cached(arg_map_function=arg_map_function)(mock_wrapper) # lint-amnesty, pylint: disable=no-value-for-parameter + wrapped = request_cached(arg_map_function=arg_map_function)(mock_wrapper) # pylint: disable=no-value-for-parameter # This will be a miss, and make an underlying call. result = wrapped(1) diff --git a/openedx/core/lib/tests/test_derived.py b/openedx/core/lib/tests/test_derived.py index 7d3f70fa6ab1..07cfd0c8c432 100644 --- a/openedx/core/lib/tests/test_derived.py +++ b/openedx/core/lib/tests/test_derived.py @@ -5,6 +5,7 @@ import sys from unittest import TestCase + from openedx.core.lib.derived import Derived, derive_settings diff --git a/openedx/core/lib/tests/test_edx_api_utils.py b/openedx/core/lib/tests/test_edx_api_utils.py index 68601caba0d6..725645408d9f 100644 --- a/openedx/core/lib/tests/test_edx_api_utils.py +++ b/openedx/core/lib/tests/test_edx_api_utils.py @@ -475,7 +475,7 @@ def test_data_retrieval_raise_on_error(self): ] ) - with self.assertRaises(Exception): + with self.assertRaises(Exception): # noqa: B017, PT027 get_api_data( catalog_integration, "programs", diff --git a/openedx/core/lib/tests/test_grade_utils.py b/openedx/core/lib/tests/test_grade_utils.py index 9c319d5b475a..7ae8448c5984 100644 --- a/openedx/core/lib/tests/test_grade_utils.py +++ b/openedx/core/lib/tests/test_grade_utils.py @@ -61,5 +61,5 @@ def test_compare_scores_treat_undefined_as_zero(self): (0.0, 0.0) ) @ddt.unpack - def test_round_away_from_zero(self, precise, expected_rounded_number, rounding_precision=0): + def test_round_away_from_zero(self, precise, expected_rounded_number, rounding_precision=0): # noqa: PT028 assert round_away_from_zero(precise, rounding_precision) == expected_rounded_number diff --git a/openedx/core/lib/tests/test_jwt.py b/openedx/core/lib/tests/test_jwt.py index da1f047e4877..25330a905822 100644 --- a/openedx/core/lib/tests/test_jwt.py +++ b/openedx/core/lib/tests/test_jwt.py @@ -1,19 +1,22 @@ """ Tests for token handling """ +import datetime import unittest from time import time +import pytest +from freezegun import freeze_time from jwt.exceptions import ExpiredSignatureError, InvalidSignatureError, MissingRequiredClaimError from openedx.core.djangolib.testing.utils import skip_unless_lms -from openedx.core.lib.jwt import _encode_and_sign, create_jwt, unpack_jwt, unpack_and_verify - +from openedx.core.lib.jwt import _encode_and_sign, create_jwt, unpack_and_verify, unpack_jwt test_user_id = 121 invalid_test_user_id = 120 test_timeout = 1000 test_now = int(time()) +time_snapshot = datetime.datetime.fromtimestamp(test_now, tz=datetime.UTC) test_claims = {"foo": "bar", "baz": "quux", "meaning": 42} expected_full_token = { "lms_user_id": test_user_id, @@ -25,6 +28,7 @@ @skip_unless_lms +@freeze_time(time_snapshot) class TestSign(unittest.TestCase): """ Tests for JWT creation and signing. @@ -34,7 +38,7 @@ def test_create_jwt(self): token = create_jwt(test_user_id, test_timeout, {}, test_now) decoded = unpack_and_verify(token) - self.assertEqual(expected_full_token, decoded) + assert decoded == expected_full_token def test_create_jwt_with_claims(self): token = create_jwt(test_user_id, test_timeout, test_claims, test_now) @@ -43,20 +47,18 @@ def test_create_jwt_with_claims(self): expected_token_with_claims.update(test_claims) decoded = unpack_and_verify(token) - self.assertEqual(expected_token_with_claims, decoded) + assert decoded == expected_token_with_claims def test_malformed_token(self): token = create_jwt(test_user_id, test_timeout, test_claims, test_now) token = token + "a" - expected_token_with_claims = expected_full_token.copy() - expected_token_with_claims.update(test_claims) - - with self.assertRaises(InvalidSignatureError): + with pytest.raises(InvalidSignatureError): unpack_and_verify(token) @skip_unless_lms +@freeze_time(time_snapshot) class TestUnpack(unittest.TestCase): """ Tests for JWT unpacking. @@ -66,7 +68,7 @@ def test_unpack_jwt(self): token = create_jwt(test_user_id, test_timeout, {}, test_now) decoded = unpack_jwt(token, test_user_id, test_now) - self.assertEqual(expected_full_token, decoded) + assert decoded == expected_full_token def test_unpack_jwt_with_claims(self): token = create_jwt(test_user_id, test_timeout, test_claims, test_now) @@ -76,28 +78,25 @@ def test_unpack_jwt_with_claims(self): decoded = unpack_jwt(token, test_user_id, test_now) - self.assertEqual(expected_token_with_claims, decoded) + assert decoded == expected_token_with_claims def test_malformed_token(self): token = create_jwt(test_user_id, test_timeout, test_claims, test_now) token = token + "a" - expected_token_with_claims = expected_full_token.copy() - expected_token_with_claims.update(test_claims) - - with self.assertRaises(InvalidSignatureError): + with pytest.raises(InvalidSignatureError): unpack_jwt(token, test_user_id, test_now) def test_unpack_token_with_invalid_user(self): token = create_jwt(invalid_test_user_id, test_timeout, {}, test_now) - with self.assertRaises(InvalidSignatureError): + with pytest.raises(InvalidSignatureError): unpack_jwt(token, test_user_id, test_now) def test_unpack_expired_token(self): token = create_jwt(test_user_id, test_timeout, {}, test_now) - with self.assertRaises(ExpiredSignatureError): + with pytest.raises(ExpiredSignatureError): unpack_jwt(token, test_user_id, test_now + test_timeout + 1) def test_missing_expired_lms_user_id(self): @@ -105,7 +104,7 @@ def test_missing_expired_lms_user_id(self): del payload['lms_user_id'] token = _encode_and_sign(payload) - with self.assertRaises(MissingRequiredClaimError): + with pytest.raises(MissingRequiredClaimError): unpack_jwt(token, test_user_id, test_now) def test_missing_expired_key(self): @@ -113,5 +112,5 @@ def test_missing_expired_key(self): del payload['exp'] token = _encode_and_sign(payload) - with self.assertRaises(MissingRequiredClaimError): + with pytest.raises(MissingRequiredClaimError): unpack_jwt(token, test_user_id, test_now) diff --git a/openedx/core/lib/tests/test_request_utils.py b/openedx/core/lib/tests/test_request_utils.py index 3eedea756bde..331031719dd3 100644 --- a/openedx/core/lib/tests/test_request_utils.py +++ b/openedx/core/lib/tests/test_request_utils.py @@ -16,8 +16,8 @@ _get_ignored_error_settings_dict, clear_cached_ignored_error_settings, course_id_from_url, - ignored_error_exception_handler, get_request_or_stub, + ignored_error_exception_handler, safe_get_host, ) diff --git a/openedx/core/lib/tests/test_teams_config.py b/openedx/core/lib/tests/test_teams_config.py index c983e841c50c..f7d7e6932ef9 100644 --- a/openedx/core/lib/tests/test_teams_config.py +++ b/openedx/core/lib/tests/test_teams_config.py @@ -6,7 +6,7 @@ import ddt from django.test import TestCase -from ..teams_config import TeamsConfig, TeamsetConfig, MANAGED_TEAM_MAX_TEAM_SIZE, DEFAULT_COURSE_RUN_MAX_TEAM_SIZE +from ..teams_config import DEFAULT_COURSE_RUN_MAX_TEAM_SIZE, MANAGED_TEAM_MAX_TEAM_SIZE, TeamsConfig, TeamsetConfig @ddt.ddt @@ -185,7 +185,7 @@ def test_teams_config_round_trip(self, input_data, expected_output_data): """ teams_config = TeamsConfig(input_data) actual_output_data = teams_config.cleaned_data - self.assertDictEqual(actual_output_data, expected_output_data) + self.assertDictEqual(actual_output_data, expected_output_data) # noqa: PT009 @ddt.data( (None, None, "open", DEFAULT_COURSE_RUN_MAX_TEAM_SIZE), diff --git a/openedx/core/lib/tests/test_time_zone_utils.py b/openedx/core/lib/tests/test_time_zone_utils.py index c876f68be2b0..973a33e0350f 100644 --- a/openedx/core/lib/tests/test_time_zone_utils.py +++ b/openedx/core/lib/tests/test_time_zone_utils.py @@ -5,8 +5,8 @@ from freezegun import freeze_time from pytz import timezone -from openedx.core.lib.time_zone_utils import get_display_time_zone, get_time_zone_abbr, get_time_zone_offset from common.djangoapps.student.tests.factories import UserFactory +from openedx.core.lib.time_zone_utils import get_display_time_zone, get_time_zone_abbr, get_time_zone_offset class TestTimeZoneUtils(TestCase): @@ -37,7 +37,7 @@ def _assert_time_zone_info_equal(self, display_tz_info, expected_name, expected_ """ Asserts that all display_tz_info is equal to the expected inputs """ - assert display_tz_info['str'] == '{name} ({abbr}, UTC{offset})'.format( + assert display_tz_info['str'] == '{name} ({abbr}, UTC{offset})'.format( # noqa: UP032 name=expected_name, abbr=expected_abbr, offset=expected_offset ) assert display_tz_info['abbr'] == expected_abbr diff --git a/openedx/core/lib/tests/test_user_util.py b/openedx/core/lib/tests/test_user_util.py index 48d7941aa022..214c5d016312 100644 --- a/openedx/core/lib/tests/test_user_util.py +++ b/openedx/core/lib/tests/test_user_util.py @@ -2,9 +2,10 @@ """Tests for `user_util` package.""" -import pytest from types import GeneratorType +import pytest + from openedx.core.lib import user_util VALID_SALT_LIST_ONE_SALT = ['gsw@&2p)$^p2hdk&ou0e%c=ou80o=%!+tv7(u(ircv@+96jl6$'] @@ -66,7 +67,7 @@ def test_unicode_username_to_hash(): assert len(retired_username.split('_')[-1]) == 40 -@pytest.mark.parametrize('salt_list', (VALID_SALT_LIST_THREE_SALTS,)) +@pytest.mark.parametrize('salt_list', (VALID_SALT_LIST_THREE_SALTS,)) # noqa: PT007 def test_correct_username_hash(salt_list): """ Verify that get_retired_username uses the current salt and returns the expected hash. @@ -82,7 +83,7 @@ def test_correct_username_hash(salt_list): assert retired_username == valid_retired_usernames[-1] -@pytest.mark.parametrize('salt_list', (VALID_SALT_LIST_FIVE_SALTS,)) +@pytest.mark.parametrize('salt_list', (VALID_SALT_LIST_FIVE_SALTS,)) # noqa: PT007 def test_all_usernames_to_hash(salt_list): username = 'ALearnerUserName' retired_username_generator = user_util.get_all_retired_usernames(username, salt_list) @@ -135,7 +136,7 @@ def test_unicode_email_to_hash(): assert len(retired_email.split('@')[0]) == len('retired_email_') + 40 -@pytest.mark.parametrize('salt_list', (VALID_SALT_LIST_THREE_SALTS,)) +@pytest.mark.parametrize('salt_list', (VALID_SALT_LIST_THREE_SALTS,)) # noqa: PT007 def test_correct_email_hash(salt_list): """ Verify that get_retired_email uses the current salt and returns the expected hash. @@ -151,7 +152,7 @@ def test_correct_email_hash(salt_list): assert retired_email == valid_retired_emails[-1] -@pytest.mark.parametrize('salt_list', (VALID_SALT_LIST_FIVE_SALTS,)) +@pytest.mark.parametrize('salt_list', (VALID_SALT_LIST_FIVE_SALTS,)) # noqa: PT007 def test_all_emails_to_hash(salt_list): email = 'a.learner@example.com' retired_email_generator = user_util.get_all_retired_emails(email, salt_list) @@ -205,7 +206,7 @@ def test_unicode_external_key_to_hash(): assert len(retired_external_key) == len('retired_external_key_') + 40 -@pytest.mark.parametrize('salt_list', (VALID_SALT_LIST_THREE_SALTS,)) +@pytest.mark.parametrize('salt_list', (VALID_SALT_LIST_THREE_SALTS,)) # noqa: PT007 def test_correct_external_key_hash(salt_list): """ Verify that get_retired_external_key uses the current salt and returns the expected hash. @@ -222,7 +223,7 @@ def test_correct_external_key_hash(salt_list): assert retired_email == valid_retired_external_keys[-1] -@pytest.mark.parametrize('salt_list', (VALID_SALT_LIST_FIVE_SALTS,)) +@pytest.mark.parametrize('salt_list', (VALID_SALT_LIST_FIVE_SALTS,)) # noqa: PT007 def test_all_external_keys_to_hash(salt_list): external_key = 'S34839GEF3' retired_external_key_generator = user_util.get_all_retired_external_keys(external_key, salt_list) diff --git a/openedx/core/lib/tests/test_xblock_utils.py b/openedx/core/lib/tests/test_xblock_utils.py index 7b817f3fe6fd..60237038f35c 100644 --- a/openedx/core/lib/tests/test_xblock_utils.py +++ b/openedx/core/lib/tests/test_xblock_utils.py @@ -12,21 +12,22 @@ from opaque_keys.edx.asides import AsideUsageKeyV1, AsideUsageKeyV2 from web_fragments.fragment import Fragment from xblock.core import XBlockAside -from xmodule.modulestore import ModuleStoreEnum -from xmodule.modulestore.tests.django_utils import TEST_DATA_SPLIT_MODULESTORE, SharedModuleStoreTestCase -from xmodule.modulestore.tests.factories import CourseFactory, BlockFactory -from xmodule.modulestore.tests.test_asides import AsideTestType from openedx.core.lib.url_utils import quote_slashes -from openedx.core.lib.xblock_utils import get_css_dependencies, get_js_dependencies from openedx.core.lib.xblock_utils import ( get_aside_from_xblock, + get_css_dependencies, + get_js_dependencies, is_xblock_aside, request_token, sanitize_html_id, wrap_fragment, - wrap_xblock + wrap_xblock, ) +from xmodule.modulestore import ModuleStoreEnum +from xmodule.modulestore.tests.django_utils import TEST_DATA_SPLIT_MODULESTORE, SharedModuleStoreTestCase +from xmodule.modulestore.tests.factories import BlockFactory, CourseFactory +from xmodule.modulestore.tests.test_asides import AsideTestType @ddt.ddt diff --git a/openedx/core/lib/user_util.py b/openedx/core/lib/user_util.py index c15a2bac1437..76c74bb0c1a4 100644 --- a/openedx/core/lib/user_util.py +++ b/openedx/core/lib/user_util.py @@ -1,7 +1,6 @@ """Main module.""" import hashlib - RETIRED_USERNAME_DEFAULT_FMT = 'retired_username_{}' RETIRED_EMAIL_DEFAULT_FMT = 'retired_email_{}@retired.edx.org' RETIRED_EXTERNAL_KEY_DEFAULT_FMT = 'retired_external_key_{}' diff --git a/openedx/core/lib/x_forwarded_for/middleware.py b/openedx/core/lib/x_forwarded_for/middleware.py index cd208809820e..ed5a39541568 100644 --- a/openedx/core/lib/x_forwarded_for/middleware.py +++ b/openedx/core/lib/x_forwarded_for/middleware.py @@ -64,7 +64,7 @@ def process_request(self, request): set_custom_attribute('ip_chain.safest_client_ip', safest_client_ip) except BaseException: - warnings.warn('Error while computing IP chain metrics') + warnings.warn('Error while computing IP chain metrics') # noqa: B028 # Older code for the Gunicorn 19.0 upgrade. Original docstring: # diff --git a/openedx/core/lib/xblock_pipeline/finder.py b/openedx/core/lib/xblock_pipeline/finder.py index a87b564afce1..7673a2a53016 100644 --- a/openedx/core/lib/xblock_pipeline/finder.py +++ b/openedx/core/lib/xblock_pipeline/finder.py @@ -2,9 +2,9 @@ Django pipeline finder for handling static assets required by XBlocks. """ +import importlib.resources as resources import os from datetime import datetime, timezone -import importlib.resources as resources from django.contrib.staticfiles import utils from django.contrib.staticfiles.finders import BaseFinder @@ -40,7 +40,7 @@ def path(self, name): with resources.as_file(resources.files(self.module.rsplit('.', 1)[0]) / self.base_dir / name) as file_path: return str(file_path) - def exists(self, path): # lint-amnesty, pylint: disable=arguments-differ + def exists(self, path): # pylint: disable=arguments-differ """ Returns True if the specified path exists. """ @@ -81,19 +81,19 @@ def get_accessed_time(self, name): """ Returns a URL to the package resource. """ - return datetime.fromtimestamp(os.path.getatime(self.path(name)), timezone.utc) + return datetime.fromtimestamp(os.path.getatime(self.path(name)), timezone.utc) # noqa: UP017 def get_created_time(self, name): """ Returns the created time of the package resource. """ - return datetime.fromtimestamp(os.path.getctime(self.path(name)), timezone.utc) + return datetime.fromtimestamp(os.path.getctime(self.path(name)), timezone.utc) # noqa: UP017 def get_modified_time(self, name): """ Returns the modified time of the resource. """ - return datetime.fromtimestamp(os.path.getmtime(self.path(name)), timezone.utc) + return datetime.fromtimestamp(os.path.getmtime(self.path(name)), timezone.utc) # noqa: UP017 def url(self, name): """ @@ -108,7 +108,7 @@ def delete(self, name): raise NotImplementedError("Deleting files from a package is not supported") -class XBlockPipelineFinder(BaseFinder): # lint-amnesty, pylint: disable=abstract-method +class XBlockPipelineFinder(BaseFinder): # pylint: disable=abstract-method """ A static files finder that gets static assets from xblocks. """ @@ -123,7 +123,7 @@ def __init__(self, *args, **kwargs): # xblock_resource_info holds (package_name, resources_dir) tuples. While # it never happens in practice, the XBlock API does allow different - # XBlocks installed with the same setup.py to refer to their shared + # XBlocks installed from the same package to refer to their shared # static assets using different prefixes. xblock_resource_info = { (xblock_resource_pkg(xblock_class), xblock_class.get_resources_dir()) diff --git a/openedx/core/lib/xblock_serializer/api.py b/openedx/core/lib/xblock_serializer/api.py index b2a905b2b857..7367310aaeb7 100644 --- a/openedx/core/lib/xblock_serializer/api.py +++ b/openedx/core/lib/xblock_serializer/api.py @@ -2,7 +2,7 @@ Public python API for serializing XBlocks to OLX """ # pylint: disable=unused-import -from .block_serializer import StaticFile, XBlockSerializer +from .block_serializer import StaticFile, XBlockSerializer # noqa: F401 def serialize_xblock_to_olx(block): @@ -17,17 +17,17 @@ def serialize_xblock_to_olx(block): return XBlockSerializer(block) -def serialize_modulestore_block_for_learning_core(block): +def serialize_modulestore_block_for_openedx_content(block): """ This class will serialize an XBlock, producing: - (1) A new definition ID for use in Learning Core + (1) A new definition ID for use in openedx_content (2) an XML string defining the XBlock and referencing the IDs of its children using syntax (which doesn't actually contain the OLX of its children, just refers to them, so you have to separately serialize them.) (3) a list of any static files required by the XBlock and their URL - TODO: We should deprecate this in favor of a new Learning Core implementation. + TODO: We should deprecate this in favor of a new openedx_content implementation. We've left it as-is for now partly because there are bigger questions that we have around how we should rewrite this (e.g. are we going to remove ?). diff --git a/openedx/core/lib/xblock_serializer/block_serializer.py b/openedx/core/lib/xblock_serializer/block_serializer.py index 169352730e1c..fdfb8aeaefc2 100644 --- a/openedx/core/lib/xblock_serializer/block_serializer.py +++ b/openedx/core/lib/xblock_serializer/block_serializer.py @@ -2,17 +2,18 @@ Code for serializing a modulestore XBlock to OLX. """ from __future__ import annotations + import logging import os from lxml import etree from opaque_keys.edx.locator import LibraryLocatorV2 -from openedx.core.djangoapps.content_tagging.api import get_all_object_tags, TagValuesByObjectIdDict +from openedx.core.djangoapps.content_tagging.api import TagValuesByObjectIdDict, get_all_object_tags from xmodule.xml_block import serialize_field -from .data import StaticFile from . import utils +from .data import StaticFile log = logging.getLogger(__name__) @@ -49,8 +50,7 @@ def __init__(self, block, write_url_name=True, fetch_asset_data=False, write_cop runtime_supports_explicit_assets = hasattr(block.runtime, 'get_block_assets') if runtime_supports_explicit_assets: # If a block supports explicitly tracked assets, things are simple. - # Learning Core backed content supports this, which currently means - # v2 Content Libraries. + # openedx_content (v2 Content Libraries) currently supports this. self.static_files.extend( block.runtime.get_block_assets(block, fetch_asset_data) ) diff --git a/openedx/core/lib/xblock_serializer/data.py b/openedx/core/lib/xblock_serializer/data.py index 141fff7dfd57..f5b50aeb18d8 100644 --- a/openedx/core/lib/xblock_serializer/data.py +++ b/openedx/core/lib/xblock_serializer/data.py @@ -2,6 +2,7 @@ Simple data structures used for XBlock serialization """ from __future__ import annotations + from typing import NamedTuple diff --git a/openedx/core/lib/xblock_serializer/test_api.py b/openedx/core/lib/xblock_serializer/test_api.py index 8787e1791862..d8703661693d 100644 --- a/openedx/core/lib/xblock_serializer/test_api.py +++ b/openedx/core/lib/xblock_serializer/test_api.py @@ -3,19 +3,19 @@ """ from xml.etree import ElementTree +from openedx_tagging.models import Tag + +from openedx.core.djangoapps.content_tagging import api as tagging_api +from openedx.core.djangoapps.content_tagging.models import TaxonomyOrg from openedx.core.djangolib.testing.utils import skip_unless_cms from xmodule.modulestore.django import contentstore, modulestore from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase, upload_file_to_course -from xmodule.modulestore.tests.factories import BlockFactory, CourseFactory, ToyCourseFactory, LibraryFactory +from xmodule.modulestore.tests.factories import BlockFactory, CourseFactory, LibraryFactory, ToyCourseFactory from xmodule.util.sandboxing import DEFAULT_PYTHON_LIB_FILENAME -from openedx_tagging.core.tagging.models import Tag -from openedx.core.djangoapps.content_tagging.models import TaxonomyOrg -from openedx.core.djangoapps.content_tagging import api as tagging_api from . import api from .block_serializer import XBlockSerializer - # The expected OLX string for the 'Toy_Videos' sequential in the toy course EXPECTED_SEQUENTIAL_OLX = """ @@ -98,14 +98,14 @@ def setUpClass(cls): root1 = Tag.objects.create(taxonomy=cls.taxonomy1, value="ROOT1") root2 = Tag.objects.create(taxonomy=cls.taxonomy2, value="ROOT2") Tag.objects.create(taxonomy=cls.taxonomy1, value="normal tag", parent=root1) - Tag.objects.create(taxonomy=cls.taxonomy1, value=" tag", parent=root1) + Tag.objects.create(taxonomy=cls.taxonomy1, value=" tag", parent=root1) Tag.objects.create(taxonomy=cls.taxonomy1, value="anotherTag", parent=root1) Tag.objects.create(taxonomy=cls.taxonomy2, value="tag", parent=root2) Tag.objects.create(taxonomy=cls.taxonomy2, value="other tag", parent=root2) def assertXmlEqual(self, xml_str_a: str, xml_str_b: str) -> None: """ Assert that the given XML strings are equal, ignoring attribute order and some whitespace variations. """ - self.assertEqual( + self.assertEqual( # noqa: PT009 ElementTree.canonicalize(xml_str_a, strip_text=True), ElementTree.canonicalize(xml_str_b, strip_text=True), ) @@ -131,8 +131,8 @@ def test_html_with_static_asset(self): ]]> """ ) - self.assertIn("CDATA", serialized.olx_str) - self.assertEqual(serialized.static_files, [ + self.assertIn("CDATA", serialized.olx_str) # noqa: PT009 + self.assertEqual(serialized.static_files, [ # noqa: PT009 api.StaticFile( name="foo_bar.jpg", url="/asset-v1:edX+toy+2012_Fall+type@asset+block@foo_bar.jpg", @@ -140,17 +140,17 @@ def test_html_with_static_asset(self): ), ]) - def test_html_with_static_asset_learning_core(self): + def test_html_with_static_asset_openedx_content(self): """ - Test the learning-core-specific serialization of an HTML block + Test the openedx_content-specific serialization of an HTML block """ block_id = self.course.id.make_usage_key('html', 'just_img') # see sample_courses.py html_block = modulestore().get_item(block_id) serialized = api.serialize_xblock_to_olx(html_block) - serialized_learning_core = api.serialize_modulestore_block_for_learning_core(html_block) + serialized_openedx_content = api.serialize_modulestore_block_for_openedx_content(html_block) self.assertXmlEqual( - serialized_learning_core.olx_str, - # For learning core, OLX should never contain "url_name" as that ID + serialized_openedx_content.olx_str, + # For openedx_content, OLX should never contain "url_name" as that ID # is specified by the Component key: """ """ ) - self.assertIn("CDATA", serialized.olx_str) + self.assertIn("CDATA", serialized.olx_str) # noqa: PT009 # Static files should be identical: - self.assertEqual(serialized.static_files, serialized_learning_core.static_files) + self.assertEqual(serialized.static_files, serialized_openedx_content.static_files) # noqa: PT009 def test_html_with_fields(self): """ Test an HTML Block with non-default fields like editor='raw' """ @@ -270,7 +270,7 @@ def test_jsinput_extra_files(self): ("simple-question.js", "./common/test/data/uploads/simple-question.js"), ("simple-question.css", "./common/test/data/uploads/simple-question.css"), ("image.jpg", "./common/test/data/uploads/image.jpg"), - ("jschannel.js", "./common/static/js/capa/src/jschannel.js"), + ("jschannel.js", "./common/test/data/uploads/jschannel.js"), ] for filename, full_path in jsinput_files: upload_file_to_course( @@ -292,7 +292,7 @@ def test_jsinput_extra_files(self): serialized = api.serialize_xblock_to_olx(jsinput_problem) assert len(serialized.static_files) == 5 for file in serialized.static_files: - self.assertIn(file.name, list(map(lambda f: f[0], jsinput_files))) + self.assertIn(file.name, list(map(lambda f: f[0], jsinput_files))) # noqa: PT009 self.assertXmlEqual( serialized.olx_str, @@ -322,7 +322,7 @@ def test_tagged_units(self): tagging_api.tag_object( object_id=str(unit.location), taxonomy=self.taxonomy1, - tags=["normal tag", " tag", "anotherTag"] + tags=["normal tag", " tag", "anotherTag"] ) tagging_api.tag_object( object_id=str(unit.location), @@ -342,10 +342,10 @@ def test_tagged_units(self): /> """ ) - self.assertEqual( + self.assertEqual( # noqa: PT009 serialized.tags, { str(unit.location): { - self.taxonomy1.id: ["normal tag", " tag", "anotherTag"], + self.taxonomy1.id: ["normal tag", " tag", "anotherTag"], self.taxonomy2.id: ["tag", "other tag"], } } @@ -371,7 +371,7 @@ def test_tagged_html_block(self): tagging_api.tag_object( object_id=str(html_block.location), taxonomy=self.taxonomy1, - tags=["normal tag", " tag", "anotherTag"] + tags=["normal tag", " tag", "anotherTag"] ) tagging_api.tag_object( object_id=str(html_block.location), @@ -395,10 +395,10 @@ def test_tagged_html_block(self): ]]> """ ) - self.assertEqual( + self.assertEqual( # noqa: PT009 serialized.tags, { str(html_block.location): { - self.taxonomy1.id: ["normal tag", " tag", "anotherTag"], + self.taxonomy1.id: ["normal tag", " tag", "anotherTag"], self.taxonomy2.id: ["tag", "other tag"], } } @@ -436,7 +436,7 @@ def test_tagged_problem_blocks(self): tagging_api.tag_object( object_id=str(regular_problem.location), taxonomy=self.taxonomy1, - tags=["normal tag", " tag", "anotherTag"] + tags=["normal tag", " tag", "anotherTag"] ) tagging_api.tag_object( object_id=str(regular_problem.location), @@ -446,7 +446,7 @@ def test_tagged_problem_blocks(self): tagging_api.tag_object( object_id=str(python_problem.location), taxonomy=self.taxonomy1, - tags=["normal tag", " tag", "anotherTag"] + tags=["normal tag", " tag", "anotherTag"] ) tagging_api.tag_object( object_id=str(python_problem.location), @@ -469,10 +469,10 @@ def test_tagged_problem_blocks(self):           """ ) - self.assertEqual( + self.assertEqual( # noqa: PT009 serialized.tags, { str(regular_problem.location): { - self.taxonomy1.id: ["normal tag", " tag", "anotherTag"], + self.taxonomy1.id: ["normal tag", " tag", "anotherTag"], self.taxonomy2.id: ["tag", "other tag"], } } @@ -491,10 +491,10 @@ def test_tagged_problem_blocks(self):           """ ) - self.assertEqual( + self.assertEqual( # noqa: PT009 serialized.tags, { str(python_problem.location): { - self.taxonomy1.id: ["normal tag", " tag", "anotherTag"], + self.taxonomy1.id: ["normal tag", " tag", "anotherTag"], self.taxonomy2.id: ["tag", "other tag"], } } @@ -518,7 +518,7 @@ def test_tagged_library_content_blocks(self): tagging_api.tag_object( object_id=str(lc_block.location), taxonomy=self.taxonomy1, - tags=["normal tag", " tag", "anotherTag"] + tags=["normal tag", " tag", "anotherTag"] ) # Check that the tags data is serialized, omitted from the OLX, and properly escaped @@ -535,9 +535,9 @@ def test_tagged_library_content_blocks(self): /> """ ) - self.assertEqual(serialized.tags, { + self.assertEqual(serialized.tags, { # noqa: PT009 str(lc_block.location): { - self.taxonomy1.id: ["normal tag", " tag", "anotherTag"], + self.taxonomy1.id: ["normal tag", " tag", "anotherTag"], } }) @@ -556,7 +556,7 @@ def test_tagged_video_block(self): tagging_api.tag_object( object_id=str(video_block.location), taxonomy=self.taxonomy1, - tags=["normal tag", " tag", "anotherTag"] + tags=["normal tag", " tag", "anotherTag"] ) # Check that the tags data is serialized and omitted from the OLX. @@ -572,9 +572,9 @@ def test_tagged_video_block(self): /> """ ) - self.assertEqual(serialized.tags, { + self.assertEqual(serialized.tags, { # noqa: PT009 str(video_block.location): { - self.taxonomy1.id: ["normal tag", " tag", "anotherTag"], + self.taxonomy1.id: ["normal tag", " tag", "anotherTag"], } }) @@ -593,19 +593,19 @@ def test_tagged_openassessment_block(self): tagging_api.tag_object( object_id=str(openassessment_block.location), taxonomy=self.taxonomy1, - tags=["normal tag", " tag", "anotherTag"] + tags=["normal tag", " tag", "anotherTag"] ) # Check that the tags data is serialized and omitted from the OLX serialized = api.serialize_xblock_to_olx(openassessment_block) - self.assertNotIn("normal tag", serialized.olx_str) - self.assertNotIn(" tag", serialized.olx_str) - self.assertNotIn("anotherTag", serialized.olx_str) + self.assertNotIn("normal tag", serialized.olx_str) # noqa: PT009 + self.assertNotIn(" tag", serialized.olx_str) # noqa: PT009 + self.assertNotIn("anotherTag", serialized.olx_str) # noqa: PT009 - self.assertEqual(serialized.tags, { + self.assertEqual(serialized.tags, { # noqa: PT009 str(openassessment_block.location): { - self.taxonomy1.id: ["normal tag", " tag", "anotherTag"], + self.taxonomy1.id: ["normal tag", " tag", "anotherTag"], } }) diff --git a/openedx/core/lib/xblock_serializer/test_utils.py b/openedx/core/lib/xblock_serializer/test_utils.py index 7b011bf064a6..ddff66be3134 100644 --- a/openedx/core/lib/xblock_serializer/test_utils.py +++ b/openedx/core/lib/xblock_serializer/test_utils.py @@ -2,6 +2,7 @@ Test the OLX serialization utils """ from __future__ import annotations + import unittest import ddt diff --git a/openedx/core/lib/xblock_serializer/utils.py b/openedx/core/lib/xblock_serializer/utils.py index 6f48eef391e7..89d60926691c 100644 --- a/openedx/core/lib/xblock_serializer/utils.py +++ b/openedx/core/lib/xblock_serializer/utils.py @@ -225,17 +225,18 @@ def override_export_fs(block): XmlMixin.export_to_file = old_global_export_to_file -def learning_core_def_key_from_modulestore_usage_key(usage_key): +def openedx_core_def_key_from_modulestore_usage_key(usage_key): """ In modulestore, the "definition key" is a MongoDB ObjectID kept in split's definitions table, which theoretically allows the same block to be used in many places (each with a unique usage key). However, that functionality is not exposed in Studio (other than via content libraries). So when we import - into learning core, we assume that each usage is unique, don't generate a usage - key, and create a new "definition key" from the original usage key. + into the OeX core content API, we assume that each usage is unique, don't + generate a usage key, and create a new "definition key" from the original + usage key. So modulestore usage key block-v1:A+B+C+type@html+block@introduction - will become learning core definition key + will become openedx_content definition key html/introduction """ block_type = usage_key.block_type diff --git a/openedx/core/lib/xblock_utils/__init__.py b/openedx/core/lib/xblock_utils/__init__.py index d398a159f998..ed0aa2cad82e 100644 --- a/openedx/core/lib/xblock_utils/__init__.py +++ b/openedx/core/lib/xblock_utils/__init__.py @@ -9,31 +9,31 @@ import logging import re import uuid +from zoneinfo import ZoneInfo import markupsafe from django.conf import settings -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user # noqa: F401 from django.contrib.staticfiles.storage import staticfiles_storage from django.urls import reverse from django.utils.html import escape from edx_django_utils.plugins import pluggable_override from lxml import etree, html from opaque_keys.edx.asides import AsideUsageKeyV1, AsideUsageKeyV2 -from zoneinfo import ZoneInfo from web_fragments.fragment import Fragment -from xblock.core import XBlock +from xblock.core import XBlock # noqa: F401 from xblock.exceptions import InvalidScopeError from xblock.scorable import ScorableXBlockMixin -from common.djangoapps import static_replace +from common.djangoapps import static_replace # noqa: F401 from common.djangoapps.edxmako.shortcuts import render_to_string -from xmodule.seq_block import SequenceBlock # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.vertical_block import VerticalBlock # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.x_module import ( # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.seq_block import SequenceBlock # pylint: disable=wrong-import-order +from xmodule.vertical_block import VerticalBlock # pylint: disable=wrong-import-order +from xmodule.x_module import ( # pylint: disable=wrong-import-order PREVIEW_VIEWS, STUDENT_VIEW, STUDIO_VIEW, - shim_xmodule_js + shim_xmodule_js, # noqa: F401 ) log = logging.getLogger(__name__) @@ -105,7 +105,7 @@ def wrap_xblock( css_classes = [ 'xblock', f'xblock-{markupsafe.escape(view)}', - 'xblock-{}-{}'.format( + 'xblock-{}-{}'.format( # noqa: UP032 markupsafe.escape(view), markupsafe.escape(block.scope_ids.block_type), ) @@ -193,7 +193,7 @@ def wrap_xblock_aside( css_classes = [ f'xblock-{markupsafe.escape(view)}', - 'xblock-{}-{}'.format( + 'xblock-{}-{}'.format( # noqa: UP032 markupsafe.escape(view), markupsafe.escape(aside.scope_ids.block_type), ), @@ -388,7 +388,7 @@ def _course_info_content(html_parsed): try: course_html_parsed = html.fromstring(course_updates.data) except (etree.XMLSyntaxError, etree.ParserError): - log.error("Cannot parse: " + course_updates.data) # lint-amnesty, pylint: disable=logging-not-lazy + log.error("Cannot parse: " + course_updates.data) # pylint: disable=logging-not-lazy escaped = escape(course_updates.data) # xss-lint: disable=python-concat-html course_html_parsed = html.fromstring("
          1. " + escaped + "
          ") @@ -423,7 +423,7 @@ def xblock_local_resource_url(block, uri): """ xblock_class = getattr(block.__class__, 'unmixed_class', block.__class__) if settings.PIPELINE['PIPELINE_ENABLED'] or not settings.REQUIRE_DEBUG: - return staticfiles_storage.url('xblock/resources/{package_name}/{path}'.format( + return staticfiles_storage.url('xblock/resources/{package_name}/{path}'.format( # noqa: UP032 package_name=xblock_resource_pkg(xblock_class), path=uri )) diff --git a/openedx/core/process_warnings.py b/openedx/core/process_warnings.py index 712f0f1ea8f5..63146c44dcac 100644 --- a/openedx/core/process_warnings.py +++ b/openedx/core/process_warnings.py @@ -1,10 +1,10 @@ -# lint-amnesty, pylint: disable=django-not-configured +# pylint: disable=django-not-configured """ Script to process pytest warnings output by pytest-json-report plugin and output it as a html """ import argparse -import io # lint-amnesty, pylint: disable=unused-import +import io # pylint: disable=unused-import # noqa: F401 import itertools import json import os @@ -102,7 +102,7 @@ def read_warning_data(dir_path): # go through each warning file and aggregate warnings into warnings_data warnings_data = [] for temp_file in warnings_files: - with open(os.path.expanduser(dir_path + "/" + temp_file), "r") as read_file: + with open(os.path.expanduser(dir_path + "/" + temp_file), "r") as read_file: # noqa: UP015 json_input = json.load(read_file) if "warnings" in json_input: data = [ @@ -209,7 +209,7 @@ def write_html_report(warnings_data, html_path): ) for category, group_in_category, category_count in category_sorted_by_count: # xss-lint: disable=python-wrap-html - html = '{category}, count: {count} '.format( + html = '{category}, count: {count} '.format( # noqa: UP032 category=escape(category), count=category_count ) html_writer.start_section(html, klass="category") @@ -223,7 +223,7 @@ def write_html_report(warnings_data, html_path): location_count, ) in locations_sorted_by_count: # xss-lint: disable=python-wrap-html - html = '{location}, count: {count} '.format( + html = '{location}, count: {count} '.format( # noqa: UP032 location=escape(location), count=location_count ) html_writer.start_section(html, klass="location") @@ -236,7 +236,7 @@ def write_html_report(warnings_data, html_path): message_count, ) in message_group_sorted_by_count: # xss-lint: disable=python-wrap-html - html = '{warning_text}, count: {count} '.format( + html = '{warning_text}, count: {count} '.format( # noqa: UP032 warning_text=escape(message), count=message_count ) html_writer.start_section(html, klass="warning_text") diff --git a/openedx/core/pytest_hooks.py b/openedx/core/pytest_hooks.py index 49911c92f87e..16afe851ac0b 100644 --- a/openedx/core/pytest_hooks.py +++ b/openedx/core/pytest_hooks.py @@ -1,9 +1,9 @@ """ Module to put all pytest hooks that modify pytest behaviour """ -import os -import io # lint-amnesty, pylint: disable=unused-import +import io # pylint: disable=unused-import # noqa: F401 import json +import os def pytest_json_modifyreport(json_report): diff --git a/openedx/core/storage.py b/openedx/core/storage.py index 5dd0873d2724..bfb4ac880d9a 100644 --- a/openedx/core/storage.py +++ b/openedx/core/storage.py @@ -3,26 +3,27 @@ """ +from functools import lru_cache + from django.conf import settings from django.contrib.staticfiles.storage import StaticFilesStorage from django.core.files.storage import FileSystemStorage from django.utils.deconstruct import deconstructible from django.utils.module_loading import import_string -from functools import lru_cache from pipeline.storage import NonPackagingMixin from require.storage import OptimizedFilesMixin from storages.backends.s3boto3 import S3Boto3Storage -from openedx.core.djangoapps.theming.storage import ThemeManifestFilesMixin, ThemePipelineMixin, ThemeMixin +from openedx.core.djangoapps.theming.storage import ThemeManifestFilesMixin, ThemeMixin, ThemePipelineMixin class PipelineForgivingMixin: """ An extension of the django-pipeline storage backend which forgives missing files. """ - def hashed_name(self, name, content=None, **kwargs): # lint-amnesty, pylint: disable=missing-function-docstring + def hashed_name(self, name, content=None, **kwargs): # pylint: disable=missing-function-docstring try: - out = super().hashed_name(name, content, **kwargs) # lint-amnesty, pylint: disable=super-with-arguments + out = super().hashed_name(name, content, **kwargs) # pylint: disable=super-with-arguments except ValueError: # This means that a file could not be found, and normally this would # cause a fatal error, which seems rather excessive given that @@ -30,9 +31,9 @@ def hashed_name(self, name, content=None, **kwargs): # lint-amnesty, pylint: di out = name return out - def stored_name(self, name): # lint-amnesty, pylint: disable=missing-function-docstring + def stored_name(self, name): # pylint: disable=missing-function-docstring try: - out = super().stored_name(name) # lint-amnesty, pylint: disable=super-with-arguments + out = super().stored_name(name) # pylint: disable=super-with-arguments except ValueError: # This means that a file could not be found, and normally this would # cause a fatal error, which seems rather excessive given that @@ -55,7 +56,7 @@ class ProductionMixin( """ def __init__(self, *args, **kwargs): kwargs.update(settings.STATICFILES_STORAGE_KWARGS.get(settings.STORAGES['staticfiles']['BACKEND'], {})) - super().__init__(*args, **kwargs) # lint-amnesty, pylint: disable=super-with-arguments + super().__init__(*args, **kwargs) # pylint: disable=super-with-arguments class ProductionStorage(ProductionMixin, StaticFilesStorage): @@ -77,7 +78,7 @@ class DevelopmentStorage( that provide additional functionality. We use this version for development, so that we can skip packaging and optimization. """ - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass @deconstructible @@ -102,7 +103,7 @@ def get_available_name(self, name, max_length=None): return name -@lru_cache() +@lru_cache() # noqa: UP011 def get_storage(storage_class=None, **kwargs): """ Returns a storage instance with the given class name and kwargs. If the diff --git a/openedx/core/tests/test_admin_view.py b/openedx/core/tests/test_admin_view.py index 1eafb9f0debe..87a5531b26ec 100644 --- a/openedx/core/tests/test_admin_view.py +++ b/openedx/core/tests/test_admin_view.py @@ -7,8 +7,8 @@ from django.test import Client, TestCase from django.urls import reverse from edx_toggles.toggles.testutils import override_waffle_switch -from common.djangoapps.student.tests.factories import UserFactory, TEST_PASSWORD +from common.djangoapps.student.tests.factories import TEST_PASSWORD, UserFactory from openedx.core.djangoapps.user_authn.views.login import ENABLE_LOGIN_USING_THIRDPARTY_AUTH_ONLY diff --git a/openedx/core/tests/test_storage.py b/openedx/core/tests/test_storage.py index 1a15786ba58e..0a491b0a15bf 100644 --- a/openedx/core/tests/test_storage.py +++ b/openedx/core/tests/test_storage.py @@ -2,8 +2,8 @@ Tests for the get_storage utility function. """ -from django.test import TestCase, override_settings from django.core.files.storage import FileSystemStorage +from django.test import TestCase, override_settings from openedx.core.storage import get_storage @@ -30,13 +30,13 @@ def tearDown(self): def test_get_storage_returns_default_storage_when_no_class_specified(self): """Test that get_storage returns the default storage when no storage_class is provided.""" storage = get_storage() - self.assertIsInstance(storage, FileSystemStorage) + self.assertIsInstance(storage, FileSystemStorage) # noqa: PT009 def test_get_storage_returns_custom_storage_when_class_specified(self): """Test that get_storage returns the specified storage class.""" storage_class = 'django.core.files.storage.FileSystemStorage' storage = get_storage(storage_class=storage_class) - self.assertIsInstance(storage, FileSystemStorage) + self.assertIsInstance(storage, FileSystemStorage) # noqa: PT009 def test_get_storage_caching_behavior(self): """Test that get_storage caches instances with identical arguments.""" @@ -46,9 +46,9 @@ def test_get_storage_caching_behavior(self): storage1 = get_storage(storage_class=storage_class, **kwargs) # Second Call storage2 = get_storage(storage_class=storage_class, **kwargs) - self.assertIs(storage1, storage2) + self.assertIs(storage1, storage2) # noqa: PT009 def test_get_storage_handles_invalid_storage_class(self): """Test that get_storage raises appropriate error for invalid storage class.""" - with self.assertRaises(ImportError): + with self.assertRaises(ImportError): # noqa: PT027 get_storage(storage_class='nonexistent.storage.InvalidStorage') diff --git a/openedx/core/toggles.py b/openedx/core/toggles.py index b4f704dca2e1..a5491566448f 100644 --- a/openedx/core/toggles.py +++ b/openedx/core/toggles.py @@ -4,6 +4,8 @@ """ from edx_toggles.toggles import SettingToggle +from openedx.core.djangoapps.waffle_utils import CourseWaffleFlag + # .. toggle_name: ENTRANCE_EXAMS # .. toggle_implementation: SettingToggle # .. toggle_default: False @@ -15,3 +17,21 @@ ENTRANCE_EXAMS = SettingToggle( "ENTRANCE_EXAMS", default=False, module_name=__name__ ) + +# .. toggle_name: authz.enable_course_authoring +# .. toggle_implementation: CourseWaffleFlag +# .. toggle_default: False +# .. toggle_description: This toggle will enable the new openedx-authz authorization engine for course authoring. +# .. toggle_warning: Enabling this toggle will trigger a data migration to move role assignations between the legacy and the openedx-authz system. +# .. toggle_use_cases: temporary +# .. toggle_creation_date: 2026-02-05 +# .. toggle_target_removal_date: 2027-06-09 +# .. toggle_tickets: https://github.com/openedx/openedx-platform/issues/37927 +AUTHZ_COURSE_AUTHORING_FLAG = CourseWaffleFlag('authz.enable_course_authoring', __name__) + + +def enable_authz_course_authoring(course_key): + """ + Returns a boolean if the AuthZ for course authoring feature is enabled for the given course. + """ + return AUTHZ_COURSE_AUTHORING_FLAG.is_enabled(course_key) diff --git a/openedx/core/types/__init__.py b/openedx/core/types/__init__.py index a4a4dc7e77ae..1ff8eba86c88 100644 --- a/openedx/core/types/__init__.py +++ b/openedx/core/types/__init__.py @@ -1,5 +1,6 @@ """ Add here typing utilities API functions and classes. """ -from django.contrib.admin import display as admin_display -from .user import User +from django.contrib.admin import display as admin_display # noqa: F401 + +from .user import AuthUser, User # noqa: F401 diff --git a/openedx/core/types/user.py b/openedx/core/types/user.py index e680a33b42ae..e54c01ba7847 100644 --- a/openedx/core/types/user.py +++ b/openedx/core/types/user.py @@ -3,9 +3,9 @@ """ from __future__ import annotations -import typing as t - import django.contrib.auth.models -AuthUser: t.TypeAlias = django.contrib.auth.models.User -User: t.TypeAlias = django.contrib.auth.models.User | django.contrib.auth.models.AnonymousUser +# base type for an authenticated user +type AuthUser = django.contrib.auth.models.User +# base type for a generic user making an HTTP request, which may or may not be authenticated: +type User = AuthUser | django.contrib.auth.models.AnonymousUser diff --git a/openedx/core/write_to_html.py b/openedx/core/write_to_html.py index 8c211e113825..cec155328062 100644 --- a/openedx/core/write_to_html.py +++ b/openedx/core/write_to_html.py @@ -2,7 +2,8 @@ Class used to write pytest warning data into html format """ import textwrap -import six # lint-amnesty, pylint: disable=unused-import + +import six # pylint: disable=unused-import # noqa: F401 class HtmlOutlineWriter: diff --git a/openedx/envs/common.py b/openedx/envs/common.py index 5d7c105025ed..31b0015d34d9 100644 --- a/openedx/envs/common.py +++ b/openedx/envs/common.py @@ -25,34 +25,30 @@ def center_with_hashes(text: str, width: int = 76): print(f"{f' {text} ':#^{width}}") ``` """ -import os import importlib.util -from path import Path as path +import os from django.utils.translation import gettext_lazy as _ +from path import Path as path -from openedx.core.lib.derived import Derived -from openedx.core.release import doc_version -from openedx.core.djangoapps.theming.helpers_dirs import ( - get_themes_unchecked, - get_theme_base_dirs_from_settings -) +from lms.djangoapps.lms_xblock.mixin import LmsBlockMixin # We have legacy components that reference these constants via the settings module. # New code should import them directly from `openedx.core.constants` instead. from openedx.core.constants import ( # pylint: disable=unused-import - ASSET_KEY_PATTERN, - COURSE_KEY_REGEX, - COURSE_KEY_PATTERN, - COURSE_ID_PATTERN, - USAGE_KEY_PATTERN, - USAGE_ID_PATTERN, + ASSET_KEY_PATTERN, # noqa: F401 + COURSE_ID_PATTERN, # noqa: F401 + COURSE_KEY_PATTERN, # noqa: F401 + COURSE_KEY_REGEX, # noqa: F401 + USAGE_ID_PATTERN, # noqa: F401 + USAGE_KEY_PATTERN, # noqa: F401 ) - +from openedx.core.djangoapps.theming.helpers_dirs import get_theme_base_dirs_from_settings, get_themes_unchecked +from openedx.core.lib.derived import Derived +from openedx.core.release import doc_version from xmodule.modulestore.edit_info import EditInfoMixin from xmodule.modulestore.inheritance import InheritanceMixin from xmodule.x_module import XModuleMixin -from lms.djangoapps.lms_xblock.mixin import LmsBlockMixin ################ Shared Functions for Derived Configuration ################ @@ -455,7 +451,6 @@ def _make_locale_paths(settings): 'DIRS': [ Derived(lambda settings: settings.PROJECT_ROOT / "templates"), COMMON_ROOT / 'templates', - XMODULE_ROOT / 'capa' / 'templates', COMMON_ROOT / 'djangoapps' / 'pipeline_mako' / 'templates', COMMON_ROOT / 'static', # required to statically include common Underscore templates ], @@ -519,7 +514,7 @@ def make_mako_module_dir(settings): # Since the CMS uses the LMS's list of mako template directories for the "preview" # template engine, we define the list here lms_mako_template_dirs_base = list(MAKO_TEMPLATE_DIRS_BASE) -lms_mako_template_dirs_base.insert(2, XMODULE_ROOT / 'capa' / 'templates') +lms_mako_template_dirs_base.append(REPO_ROOT / 'lms' / 'djangoapps' / 'teams' / 'templates') lms_mako_template_dirs_base.append(OPENEDX_ROOT / 'features' / 'course_experience' / 'templates') CONTEXT_PROCESSORS = [ @@ -745,6 +740,19 @@ def make_mako_module_dir(settings): LANGUAGE_DICT = dict(LANGUAGES) +# .. setting_name: COURSE_ACCESS_DURATION_MIN_WEEKS +# .. setting_default: 4 +# .. setting_description: Minimum course duration in weeks when Discovery service data is unavailable or course has no +# .. weeks_to_complete value. Used as fallback for course access duration calculations (e.g., audit access expiration +# .. and discussion notification filtering). +COURSE_ACCESS_DURATION_MIN_WEEKS = 4 + +# .. setting_name: COURSE_ACCESS_DURATION_MAX_WEEKS +# .. setting_default: 18 +# .. setting_description: Maximum course duration in weeks. Course access duration is bounded by this upper limit +# .. regardless of Discovery service data. +COURSE_ACCESS_DURATION_MAX_WEEKS = 18 + ############################## Optional Apps ############################### OPTIONAL_APPS = [ @@ -763,9 +771,8 @@ def make_mako_module_dir(settings): # edxval ('edxval', 'openedx.core.djangoapps.content.course_overviews.apps.CourseOverviewsConfig'), - # Enterprise Apps (http://github.com/openedx/edx-enterprise) - ('enterprise', None), - ('consent', None), + # Deprecated apps from the edx-enterprise package. We're working on removing these as part of + # pluginifying edx-enterprise () ('integrated_channels.integrated_channel', None), ('integrated_channels.degreed', None), ('integrated_channels.degreed2', None), @@ -1898,6 +1905,16 @@ def add_optional_apps(optional_apps, installed_apps): # .. setting_description: Base URL of the micro-frontend-based learner home page. LEARNER_HOME_MICROFRONTEND_URL = None +# .. setting_name: COURSE_AUTHORING_MICROFRONTEND_URL +# .. setting_default: None +# .. setting_description: Base URL of the micro-frontend-based course authoring (Studio) page. +COURSE_AUTHORING_MICROFRONTEND_URL = None + +# .. setting_name: ADMIN_CONSOLE_MICROFRONTEND_URL +# .. setting_default: None +# .. setting_description: Base URL of the micro-frontend-based admin console page. +ADMIN_CONSOLE_MICROFRONTEND_URL = None + ################################## Swift ################################### SWIFT_USERNAME = None @@ -1918,6 +1935,21 @@ def add_optional_apps(optional_apps, installed_apps): SOCIAL_AUTH_SAML_SP_PRIVATE_KEY_DICT = {} SOCIAL_AUTH_SAML_SP_PUBLIC_CERT_DICT = {} +# .. toggle_name: SAML_METADATA_URL_ALLOW_PRIVATE_IPS +# .. toggle_default: False +# .. toggle_description: When False (the default), fetching SAML metadata from +# private IP address ranges (RFC 1918: 10.x, 172.16.x, 192.168.x) is blocked +# as a defense against SSRF attacks. Set to True only in deployments where the +# SAML Identity Provider is hosted on the same private network as the Open edX +# server. Note: loopback (127.x) and link-local (169.254.x) addresses remain +# blocked regardless of this toggle. Operators are also encouraged to enforce +# network-level egress filtering as a complementary control, particularly to +# cover hostname-based URLs that are not subject to IP validation. +# .. toggle_implementation: DjangoSetting +# .. toggle_use_cases: open_edx +# .. toggle_creation_date: 2026-04-24 +SAML_METADATA_URL_ALLOW_PRIVATE_IPS = False + ########################### django-fernet-fields ########################### FERNET_KEYS = [ @@ -2028,53 +2060,48 @@ def add_optional_apps(optional_apps, installed_apps): # Ticket: https://github.com/openedx/edx-platform/issues/35308 # .. toggle_name: USE_EXTRACTED_WORD_CLOUD_BLOCK -# .. toggle_default: False +# .. toggle_default: True # .. toggle_implementation: DjangoSetting # .. toggle_description: Enables the use of the extracted Word Cloud XBlock, which has been shifted to the 'openedx/xblocks-contrib' repo. # .. toggle_use_cases: temporary -# .. toggle_warning: Not production-ready until https://github.com/openedx/edx-platform/issues/34840 is done. # .. toggle_creation_date: 2024-11-10 -# .. toggle_target_removal_date: 2025-06-01 +# .. toggle_target_removal_date: 2026-04-10 USE_EXTRACTED_WORD_CLOUD_BLOCK = True # .. toggle_name: USE_EXTRACTED_ANNOTATABLE_BLOCK -# .. toggle_default: False +# .. toggle_default: True # .. toggle_implementation: DjangoSetting # .. toggle_description: Enables the use of the extracted annotatable XBlock, which has been shifted to the 'openedx/xblocks-contrib' repo. # .. toggle_use_cases: temporary -# .. toggle_warning: Not production-ready until https://github.com/openedx/edx-platform/issues/34841 is done. # .. toggle_creation_date: 2024-11-10 -# .. toggle_target_removal_date: 2025-06-01 +# .. toggle_target_removal_date: 2026-04-10 USE_EXTRACTED_ANNOTATABLE_BLOCK = True # .. toggle_name: USE_EXTRACTED_POLL_QUESTION_BLOCK -# .. toggle_default: False +# .. toggle_default: True # .. toggle_implementation: DjangoSetting # .. toggle_description: Enables the use of the extracted poll question XBlock, which has been shifted to the 'openedx/xblocks-contrib' repo. # .. toggle_use_cases: temporary -# .. toggle_warning: Not production-ready until https://github.com/openedx/edx-platform/issues/34839 is done. # .. toggle_creation_date: 2024-11-10 -# .. toggle_target_removal_date: 2025-06-01 +# .. toggle_target_removal_date: 2026-04-10 USE_EXTRACTED_POLL_QUESTION_BLOCK = True # .. toggle_name: USE_EXTRACTED_LTI_BLOCK -# .. toggle_default: False +# .. toggle_default: True # .. toggle_implementation: DjangoSetting # .. toggle_description: Enables the use of the extracted LTI XBlock, which has been shifted to the 'openedx/xblocks-contrib' repo. # .. toggle_use_cases: temporary -# .. toggle_warning: Not production-ready until relevant subtask https://github.com/openedx/edx-platform/issues/34827 is done. # .. toggle_creation_date: 2024-11-10 -# .. toggle_target_removal_date: 2025-06-01 +# .. toggle_target_removal_date: 2026-04-10 USE_EXTRACTED_LTI_BLOCK = True # .. toggle_name: USE_EXTRACTED_HTML_BLOCK -# .. toggle_default: False +# .. toggle_default: True # .. toggle_implementation: DjangoSetting # .. toggle_description: Enables the use of the extracted HTML XBlock, which has been shifted to the 'openedx/xblocks-contrib' repo. # .. toggle_use_cases: temporary -# .. toggle_warning: Not production-ready until relevant subtask https://github.com/openedx/edx-platform/issues/34827 is done. # .. toggle_creation_date: 2024-11-10 -# .. toggle_target_removal_date: 2025-06-01 +# .. toggle_target_removal_date: 2026-04-10 USE_EXTRACTED_HTML_BLOCK = True # .. toggle_name: USE_EXTRACTED_DISCUSSION_BLOCK @@ -2084,8 +2111,8 @@ def add_optional_apps(optional_apps, installed_apps): # .. toggle_use_cases: temporary # .. toggle_warning: Not production-ready until relevant subtask https://github.com/openedx/edx-platform/issues/34827 is done. # .. toggle_creation_date: 2024-11-10 -# .. toggle_target_removal_date: 2025-06-01 -USE_EXTRACTED_DISCUSSION_BLOCK = False +# .. toggle_target_removal_date: 2026-04-10 +USE_EXTRACTED_DISCUSSION_BLOCK = True # .. toggle_name: USE_EXTRACTED_PROBLEM_BLOCK # .. toggle_default: False @@ -2094,18 +2121,17 @@ def add_optional_apps(optional_apps, installed_apps): # .. toggle_use_cases: temporary # .. toggle_warning: Not production-ready until relevant subtask https://github.com/openedx/edx-platform/issues/34827 is done. # .. toggle_creation_date: 2024-11-10 -# .. toggle_target_removal_date: 2025-06-01 -USE_EXTRACTED_PROBLEM_BLOCK = False +# .. toggle_target_removal_date: 2026-04-10 +USE_EXTRACTED_PROBLEM_BLOCK = True # .. toggle_name: USE_EXTRACTED_VIDEO_BLOCK -# .. toggle_default: False +# .. toggle_default: True # .. toggle_implementation: DjangoSetting # .. toggle_description: Enables the use of the extracted Video XBlock, which has been shifted to the 'openedx/xblocks-contrib' repo. # .. toggle_use_cases: temporary -# .. toggle_warning: Not production-ready until relevant subtask https://github.com/openedx/edx-platform/issues/34827 is done. # .. toggle_creation_date: 2024-11-10 -# .. toggle_target_removal_date: 2025-06-01 -USE_EXTRACTED_VIDEO_BLOCK = False +# .. toggle_target_removal_date: 2026-04-10 +USE_EXTRACTED_VIDEO_BLOCK = True ############################## Marketing Site ############################## @@ -2663,8 +2689,17 @@ def add_optional_apps(optional_apps, installed_apps): NOTIFICATION_TYPE_ICONS = {} DEFAULT_NOTIFICATION_ICON_URL = "" +# Digest email delivery schedule settings (all times in UTC). +# Instance operators can override these to control when daily/weekly digest emails are sent. +NOTIFICATION_DAILY_DIGEST_DELIVERY_HOUR = 17 # Hour of day (0-23) to send daily digest (default: 5 PM UTC) +NOTIFICATION_DAILY_DIGEST_DELIVERY_MINUTE = 0 # Minute of hour (0-59) to send daily digest +NOTIFICATION_WEEKLY_DIGEST_DELIVERY_DAY = 0 # Day of week (0=Monday, 6=Sunday) to send weekly digest +NOTIFICATION_WEEKLY_DIGEST_DELIVERY_HOUR = 17 # Hour of day (0-23) to send weekly digest (default: 5 PM UTC) +NOTIFICATION_WEEKLY_DIGEST_DELIVERY_MINUTE = 0 # Minute of hour (0-59) to send weekly digest + # These settings are used to override the default notification preferences values for apps and types. -# Here is complete documentation about how to use them: openedx/core/djangoapps/notifications/docs/settings.md +# Here is complete documentation about how to use them: +# https://docs.openedx.org/en/latest/site_ops/how-tos/enable_notifications.html#how-to-override-default-notification-preferences NOTIFICATION_APPS_OVERRIDE = {} NOTIFICATION_TYPES_OVERRIDE = {} diff --git a/openedx/envs/test.py b/openedx/envs/test.py index 66558c2c8e26..8c0fafe6c372 100644 --- a/openedx/envs/test.py +++ b/openedx/envs/test.py @@ -1,3 +1,4 @@ +# ruff: noqa: I001 - settings file: star-import order is semantically significant """ Common test related Django settings for Open edX services. @@ -5,15 +6,13 @@ rather than duplicated or imported accross services. """ import os -from path import Path as path from uuid import uuid4 from django.utils.translation import gettext_lazy - -from openedx.core.lib.derived import Derived +from path import Path as path from common.djangoapps.util.testing import patch_sessions, patch_testcase - +from openedx.core.lib.derived import Derived # This patch disables the commit_on_success decorator during tests # in TestCase subclasses. diff --git a/openedx/features/calendar_sync/admin.py b/openedx/features/calendar_sync/admin.py index b368aeef00ae..70058aa32800 100644 --- a/openedx/features/calendar_sync/admin.py +++ b/openedx/features/calendar_sync/admin.py @@ -1,4 +1,4 @@ -# lint-amnesty, pylint: disable=missing-module-docstring +# pylint: disable=missing-module-docstring from django.contrib import admin from .models import UserCalendarSyncConfig diff --git a/openedx/features/calendar_sync/apps.py b/openedx/features/calendar_sync/apps.py index fde6dfb152ec..ce72e74c3a3c 100644 --- a/openedx/features/calendar_sync/apps.py +++ b/openedx/features/calendar_sync/apps.py @@ -8,11 +8,11 @@ from django.apps import AppConfig -class UserCalendarSyncConfig(AppConfig): # lint-amnesty, pylint: disable=missing-class-docstring +class UserCalendarSyncConfig(AppConfig): # pylint: disable=missing-class-docstring name = 'openedx.features.calendar_sync' def ready(self): super().ready() # noinspection PyUnresolvedReferences - import openedx.features.calendar_sync.signals # pylint: disable=import-outside-toplevel,unused-import + import openedx.features.calendar_sync.signals # pylint: disable=import-outside-toplevel,unused-import # noqa: F401 diff --git a/openedx/features/calendar_sync/ics.py b/openedx/features/calendar_sync/ics.py index c6d3a03a1ccf..c06a7f180ad0 100644 --- a/openedx/features/calendar_sync/ics.py +++ b/openedx/features/calendar_sync/ics.py @@ -1,8 +1,8 @@ """ Generate .ics files from a user schedule """ from datetime import datetime, timedelta - from zoneinfo import ZoneInfo + from django.conf import settings from django.utils.translation import gettext as _ from icalendar import Calendar, Event, vCalAddress, vText diff --git a/openedx/features/calendar_sync/models.py b/openedx/features/calendar_sync/models.py index d0d01e0a4c18..9ce51be3eab9 100644 --- a/openedx/features/calendar_sync/models.py +++ b/openedx/features/calendar_sync/models.py @@ -3,13 +3,13 @@ """ -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.db import models from opaque_keys.edx.django.models import CourseKeyField from simple_history.models import HistoricalRecords -class UserCalendarSyncConfig(models.Model): +class UserCalendarSyncConfig(models.Model): # noqa: DJ008 """ Model to track if a user has the calendar integration enabled for a specific Course diff --git a/openedx/features/calendar_sync/plugins.py b/openedx/features/calendar_sync/plugins.py index 75178a1ace7f..792216d053e7 100644 --- a/openedx/features/calendar_sync/plugins.py +++ b/openedx/features/calendar_sync/plugins.py @@ -6,11 +6,11 @@ from django.urls import reverse from django.utils.translation import gettext as _ +from common.djangoapps.student.models import CourseEnrollment from openedx.features.calendar_sync.api import SUBSCRIBE, UNSUBSCRIBE from openedx.features.calendar_sync.models import UserCalendarSyncConfig from openedx.features.course_experience import CALENDAR_SYNC_FLAG, RELATIVE_DATES_FLAG from openedx.features.course_experience.course_tools import CourseTool, HttpMethod -from common.djangoapps.student.models import CourseEnrollment class CalendarSyncToggleTool(CourseTool): diff --git a/openedx/features/calendar_sync/signals.py b/openedx/features/calendar_sync/signals.py index 7bd13d13640e..211f2cf4bc64 100644 --- a/openedx/features/calendar_sync/signals.py +++ b/openedx/features/calendar_sync/signals.py @@ -13,7 +13,7 @@ @receiver(post_save, sender=UserCalendarSyncConfig) -def handle_calendar_sync_email(sender, instance, created, **kwargs): # lint-amnesty, pylint: disable=missing-function-docstring, unused-argument +def handle_calendar_sync_email(sender, instance, created, **kwargs): # pylint: disable=missing-function-docstring, unused-argument if ( CALENDAR_SYNC_FLAG.is_enabled(instance.course_key) and RELATIVE_DATES_FLAG.is_enabled(instance.course_key) and diff --git a/openedx/features/calendar_sync/tests/factories.py b/openedx/features/calendar_sync/tests/factories.py index cfba6ce7dee8..acc2dc6e8c2b 100644 --- a/openedx/features/calendar_sync/tests/factories.py +++ b/openedx/features/calendar_sync/tests/factories.py @@ -1,4 +1,4 @@ -# lint-amnesty, pylint: disable=missing-module-docstring +# pylint: disable=missing-module-docstring from factory.django import DjangoModelFactory from openedx.features.calendar_sync.models import UserCalendarSyncConfig diff --git a/openedx/features/calendar_sync/tests/test_api.py b/openedx/features/calendar_sync/tests/test_api.py index 331aa2b9ba8d..662462082c34 100644 --- a/openedx/features/calendar_sync/tests/test_api.py +++ b/openedx/features/calendar_sync/tests/test_api.py @@ -4,8 +4,10 @@ from common.djangoapps.student.tests.factories import UserFactory from openedx.features.calendar_sync.api import subscribe_user_to_calendar, unsubscribe_user_to_calendar from openedx.features.calendar_sync.models import UserCalendarSyncConfig -from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + SharedModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order TEST_PASSWORD = 'test' diff --git a/openedx/features/calendar_sync/tests/test_ics.py b/openedx/features/calendar_sync/tests/test_ics.py index 73327b09a964..8675d0fbe820 100644 --- a/openedx/features/calendar_sync/tests/test_ics.py +++ b/openedx/features/calendar_sync/tests/test_ics.py @@ -2,8 +2,8 @@ from datetime import datetime, timedelta from unittest.mock import patch - from zoneinfo import ZoneInfo + from django.test import RequestFactory, TestCase from freezegun import freeze_time @@ -99,7 +99,7 @@ def assert_ics(self, *assignments): file.decode('utf8').replace('\r\n', '\n') for file in sorted(self.generate_ics(*assignments).values()) ] assert len(generated) == len(assignments) - self.assertListEqual(generated, list(self.expected_ics(*assignments))) + self.assertListEqual(generated, list(self.expected_ics(*assignments))) # noqa: PT009 def test_generate_ics_for_user_course(self): """ Tests that a simple sample set of course assignments is generated correctly """ diff --git a/openedx/features/calendar_sync/tests/test_init.py b/openedx/features/calendar_sync/tests/test_init.py index b8c39dc9c3b4..adb954843131 100644 --- a/openedx/features/calendar_sync/tests/test_init.py +++ b/openedx/features/calendar_sync/tests/test_init.py @@ -20,7 +20,7 @@ def test_get_calendar_event_id(self): date_type = 'due' hostname = 'example.com' event_id = get_calendar_event_id(self.user, block_key, date_type, hostname) - expected = '{user_id}.{block_key}.{date_type}@{hostname}'.format( + expected = '{user_id}.{block_key}.{date_type}@{hostname}'.format( # noqa: UP032 user_id=self.user.id, block_key=block_key, date_type=date_type, hostname=hostname ) assert event_id == expected diff --git a/openedx/features/calendar_sync/tests/test_models.py b/openedx/features/calendar_sync/tests/test_models.py index e64ef5bd3752..faba7a35990d 100644 --- a/openedx/features/calendar_sync/tests/test_models.py +++ b/openedx/features/calendar_sync/tests/test_models.py @@ -3,8 +3,10 @@ from common.djangoapps.student.tests.factories import UserFactory from openedx.features.calendar_sync.models import UserCalendarSyncConfig -from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + SharedModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order TEST_PASSWORD = 'test' diff --git a/openedx/features/calendar_sync/tests/test_plugins.py b/openedx/features/calendar_sync/tests/test_plugins.py index 2f2fba4045d1..12d878fe3419 100644 --- a/openedx/features/calendar_sync/tests/test_plugins.py +++ b/openedx/features/calendar_sync/tests/test_plugins.py @@ -10,8 +10,11 @@ from openedx.features.calendar_sync.plugins import CalendarSyncToggleTool from openedx.features.course_experience import CALENDAR_SYNC_FLAG, RELATIVE_DATES_FLAG -from xmodule.modulestore.tests.django_utils import CourseUserType, SharedModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( # pylint: disable=wrong-import-order + CourseUserType, + SharedModuleStoreTestCase, +) +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order @ddt.ddt diff --git a/openedx/features/calendar_sync/tests/test_views.py b/openedx/features/calendar_sync/tests/test_views.py index 0b566aeb1a64..70d7393d4d52 100644 --- a/openedx/features/calendar_sync/tests/test_views.py +++ b/openedx/features/calendar_sync/tests/test_views.py @@ -8,8 +8,10 @@ from django.urls import reverse from openedx.features.calendar_sync.api import SUBSCRIBE, UNSUBSCRIBE -from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + SharedModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order TEST_PASSWORD = 'test' diff --git a/openedx/features/calendar_sync/urls.py b/openedx/features/calendar_sync/urls.py index 22367f3a961c..b3fff2d34210 100644 --- a/openedx/features/calendar_sync/urls.py +++ b/openedx/features/calendar_sync/urls.py @@ -3,6 +3,7 @@ """ from django.urls import path + from .views.calendar_sync import CalendarSyncView urlpatterns = [ diff --git a/openedx/features/calendar_sync/utils.py b/openedx/features/calendar_sync/utils.py index ff6f6a662e12..233cf9355dc4 100644 --- a/openedx/features/calendar_sync/utils.py +++ b/openedx/features/calendar_sync/utils.py @@ -1,18 +1,19 @@ -# lint-amnesty, pylint: disable=missing-module-docstring +# pylint: disable=missing-module-docstring import logging +import os # pylint: disable=wrong-import-order from email.mime.application import MIMEApplication from email.mime.multipart import MIMEMultipart from email.mime.text import MIMEText + +import boto3 from django.conf import settings from django.utils.html import format_html from django.utils.translation import gettext_lazy as _ -import os # lint-amnesty, pylint: disable=wrong-import-order -import boto3 logger = logging.getLogger(__name__) -def calendar_sync_initial_email_content(course_name): # lint-amnesty, pylint: disable=missing-function-docstring +def calendar_sync_initial_email_content(course_name): # pylint: disable=missing-function-docstring subject = _('Sync {course} to your calendar').format(course=course_name) body_paragraph_1 = _('Sticking to a schedule is the best way to ensure that you successfully complete your ' 'self-paced course. This schedule for {course} will help you stay on track!' @@ -29,7 +30,7 @@ def calendar_sync_initial_email_content(course_name): # lint-amnesty, pylint: d return subject, body -def calendar_sync_update_email_content(course_name): # lint-amnesty, pylint: disable=missing-function-docstring +def calendar_sync_update_email_content(course_name): # pylint: disable=missing-function-docstring subject = _('{course} dates have been updated on your calendar').format(course=course_name) body_paragraph = _('You have successfully shifted your course schedule and your calendar is up to date.' ).format(course=course_name) @@ -58,7 +59,7 @@ def prepare_attachments(attachment_data, file_ext=''): return attachments -def send_email_with_attachment(to_emails, attachment_data, course_name, is_initial): # lint-amnesty, pylint: disable=missing-function-docstring +def send_email_with_attachment(to_emails, attachment_data, course_name, is_initial): # pylint: disable=missing-function-docstring # connect to SES client = boto3.client('ses', region_name=settings.AWS_SES_REGION_NAME) diff --git a/openedx/features/calendar_sync/views/calendar_sync.py b/openedx/features/calendar_sync/views/calendar_sync.py index 20f182daffd2..3e86525d3f2c 100644 --- a/openedx/features/calendar_sync/views/calendar_sync.py +++ b/openedx/features/calendar_sync/views/calendar_sync.py @@ -19,7 +19,7 @@ SUBSCRIBE, UNSUBSCRIBE, subscribe_user_to_calendar, - unsubscribe_user_to_calendar + unsubscribe_user_to_calendar, ) from openedx.features.course_experience import course_home_url diff --git a/openedx/features/content_type_gating/admin.py b/openedx/features/content_type_gating/admin.py index 3f4f58d2585f..ce69e62cc568 100644 --- a/openedx/features/content_type_gating/admin.py +++ b/openedx/features/content_type_gating/admin.py @@ -9,5 +9,4 @@ from .models import ContentTypeGatingConfig - admin.site.register(ContentTypeGatingConfig, StackedConfigModelAdmin) diff --git a/openedx/features/content_type_gating/block_transformers.py b/openedx/features/content_type_gating/block_transformers.py index 94b66eda4367..b374e3ff5174 100644 --- a/openedx/features/content_type_gating/block_transformers.py +++ b/openedx/features/content_type_gating/block_transformers.py @@ -25,8 +25,8 @@ class ContentTypeGateTransformer(BlockStructureTransformer): @classmethod def name(cls): """ - Unique identifier for the transformer's class; - same identifier used in setup.py. + Unique identifier for the transformer's class. + This must match the entry point name in the package configuration. """ return "content_type_gate" diff --git a/openedx/features/content_type_gating/helpers.py b/openedx/features/content_type_gating/helpers.py index 05323d7c57f8..fb5e8f1cc4ba 100644 --- a/openedx/features/content_type_gating/helpers.py +++ b/openedx/features/content_type_gating/helpers.py @@ -7,10 +7,10 @@ from django.utils import timezone from common.djangoapps.course_modes.models import CourseMode -from openedx.core.djangoapps.config_model_utils.utils import is_in_holdback from common.djangoapps.student.models import CourseEnrollment from common.djangoapps.student.role_helpers import has_staff_roles -from xmodule.partitions.partitions import Group # lint-amnesty, pylint: disable=wrong-import-order +from openedx.core.djangoapps.config_model_utils.utils import is_in_holdback +from xmodule.partitions.partitions import Group # pylint: disable=wrong-import-order # Studio generates partition IDs starting at 100. There is already a manually generated # partition for Enrollment Track that uses ID 50, so we'll use 51. @@ -80,8 +80,11 @@ def has_full_access_role_in_masquerade(user, course_key): """ # The masquerade module imports from us, so avoid a circular dependency here from lms.djangoapps.courseware.masquerade import ( - get_course_masquerade, is_masquerading_as_full_access, is_masquerading_as_non_audit_enrollment, - is_masquerading_as_specific_student, is_masquerading_as_staff, + get_course_masquerade, + is_masquerading_as_full_access, + is_masquerading_as_non_audit_enrollment, + is_masquerading_as_specific_student, + is_masquerading_as_staff, ) course_masquerade = get_course_masquerade(user, course_key) diff --git a/openedx/features/content_type_gating/models.py b/openedx/features/content_type_gating/models.py index 2756322db6e1..8e26d0640f50 100644 --- a/openedx/features/content_type_gating/models.py +++ b/openedx/features/content_type_gating/models.py @@ -5,7 +5,6 @@ from django.core.exceptions import ValidationError from django.db import models from django.utils import timezone - from django.utils.translation import gettext_lazy as _ from openedx.core.djangoapps.config_model_utils.models import StackedConfigurationModel @@ -102,7 +101,7 @@ def enabled_as_of_datetime(self, target_datetime): return bool(self.enabled and self.enabled_as_of <= target_datetime) def __str__(self): - return "ContentTypeGatingConfig(enabled={!r}, enabled_as_of={!r}, studio_override_enabled={!r})".format( + return "ContentTypeGatingConfig(enabled={!r}, enabled_as_of={!r}, studio_override_enabled={!r})".format( # noqa: UP032 # pylint: disable=line-too-long self.enabled, self.enabled_as_of, self.studio_override_enabled, diff --git a/openedx/features/content_type_gating/partitions.py b/openedx/features/content_type_gating/partitions.py index a5e833f60bc5..17313de5e82b 100644 --- a/openedx/features/content_type_gating/partitions.py +++ b/openedx/features/content_type_gating/partitions.py @@ -8,9 +8,9 @@ import datetime import logging +from zoneinfo import ZoneInfo import crum -from zoneinfo import ZoneInfo from django.template.loader import render_to_string from django.utils.translation import gettext_lazy as _ from web_fragments.fragment import Fragment @@ -22,7 +22,10 @@ from openedx.features.content_type_gating.helpers import CONTENT_GATING_PARTITION_ID, FULL_ACCESS, LIMITED_ACCESS from openedx.features.content_type_gating.models import ContentTypeGatingConfig from openedx.features.discounts.utils import format_strikeout_price -from xmodule.partitions.partitions import UserPartition, UserPartitionError # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.partitions.partitions import ( # pylint: disable=wrong-import-order + UserPartition, + UserPartitionError, +) LOG = logging.getLogger(__name__) diff --git a/openedx/features/content_type_gating/services.py b/openedx/features/content_type_gating/services.py index 363fd8168876..8cee754a7e8c 100644 --- a/openedx/features/content_type_gating/services.py +++ b/openedx/features/content_type_gating/services.py @@ -4,9 +4,7 @@ import crum from lms.djangoapps.courseware.access import has_access -from lms.djangoapps.courseware.masquerade import ( - is_masquerading_as_limited_access, is_masquerading_as_audit_enrollment, -) +from lms.djangoapps.courseware.masquerade import is_masquerading_as_audit_enrollment, is_masquerading_as_limited_access from openedx.core.lib.graph_traversals import get_children, leaf_filter, traverse_pre_order from openedx.features.content_type_gating.models import ContentTypeGatingConfig diff --git a/openedx/features/content_type_gating/tests/test_access.py b/openedx/features/content_type_gating/tests/test_access.py index 3e3dae129801..edb7aafa2a6a 100644 --- a/openedx/features/content_type_gating/tests/test_access.py +++ b/openedx/features/content_type_gating/tests/test_access.py @@ -2,30 +2,32 @@ Test audit user's access to various content based on content-gating features. """ from datetime import datetime, timedelta -from unittest.mock import patch, Mock +from unittest.mock import Mock, patch import ddt from django.conf import settings -from django.test.client import RequestFactory, Client +from django.contrib.auth import get_user_model +from django.test.client import Client, RequestFactory from django.test.utils import override_settings from django.urls import reverse from django.utils import timezone -from django.contrib.auth import get_user_model from pyquery import PyQuery as pq -from xmodule.modulestore.tests.django_utils import ( - TEST_DATA_SPLIT_MODULESTORE, ModuleStoreTestCase, SharedModuleStoreTestCase, -) -from xmodule.modulestore.tests.factories import CourseFactory, BlockFactory -from xmodule.partitions.partitions import ENROLLMENT_TRACK_PARTITION_ID -from lms.djangoapps.course_api.blocks.api import get_blocks from common.djangoapps.course_modes.tests.factories import CourseModeFactory -from common.djangoapps.student.tests.factories import BetaTesterFactory -from common.djangoapps.student.tests.factories import GlobalStaffFactory -from common.djangoapps.student.tests.factories import InstructorFactory -from common.djangoapps.student.tests.factories import OrgInstructorFactory -from common.djangoapps.student.tests.factories import OrgStaffFactory -from common.djangoapps.student.tests.factories import StaffFactory +from common.djangoapps.student.models import CourseEnrollment, FBEEnrollmentExclusion +from common.djangoapps.student.roles import CourseInstructorRole +from common.djangoapps.student.tests.factories import ( + TEST_PASSWORD, + BetaTesterFactory, + CourseEnrollmentFactory, + GlobalStaffFactory, + InstructorFactory, + OrgInstructorFactory, + OrgStaffFactory, + StaffFactory, + UserFactory, +) +from lms.djangoapps.course_api.blocks.api import get_blocks from lms.djangoapps.courseware.block_render import load_single_xblock from lms.djangoapps.courseware.tests.helpers import MasqueradeMixin from lms.djangoapps.discussion.django_comment_client.tests.factories import RoleFactory @@ -33,7 +35,7 @@ FORUM_ROLE_ADMINISTRATOR, FORUM_ROLE_COMMUNITY_TA, FORUM_ROLE_GROUP_MODERATOR, - FORUM_ROLE_MODERATOR + FORUM_ROLE_MODERATOR, ) from openedx.core.djangoapps.user_api.tests.factories import UserCourseTagFactory from openedx.core.djangoapps.util.testing import TestConditionalContent @@ -43,9 +45,13 @@ from openedx.features.content_type_gating.models import ContentTypeGatingConfig from openedx.features.content_type_gating.partitions import ContentTypeGatingPartition from openedx.features.content_type_gating.services import ContentTypeGatingService -from common.djangoapps.student.models import CourseEnrollment, FBEEnrollmentExclusion -from common.djangoapps.student.roles import CourseInstructorRole -from common.djangoapps.student.tests.factories import TEST_PASSWORD, CourseEnrollmentFactory, UserFactory +from xmodule.modulestore.tests.django_utils import ( + TEST_DATA_SPLIT_MODULESTORE, + ModuleStoreTestCase, + SharedModuleStoreTestCase, +) +from xmodule.modulestore.tests.factories import BlockFactory, CourseFactory +from xmodule.partitions.partitions import ENROLLMENT_TRACK_PARTITION_ID METADATA = { 'group_access': { @@ -205,8 +211,8 @@ def setUpClass(cls): # Create components with the cartesian product of possible values of # graded/has_score/weight for the test_graded_score_weight_values test. cls.graded_score_weight_blocks = {} - for graded, has_score, weight, gated in cls.GRADED_SCORE_WEIGHT_TEST_CASES: - case_name = ' Graded: ' + str(graded) + ' Has Score: ' + str(has_score) + ' Weight: ' + str(weight) + for graded, has_score, weight, gated in cls.GRADED_SCORE_WEIGHT_TEST_CASES: # noqa: B007 + case_name = ' Graded: ' + str(graded) + ' Has Score: ' + str(has_score) + ' Weight: ' + str(weight) # noqa: F841 # pylint: disable=line-too-long block_args = { 'parent': cls.blocks_dict['vertical'], # has_score is determined by XBlock type. It is not a value set on an instance of an XBlock. diff --git a/openedx/features/content_type_gating/tests/test_models.py b/openedx/features/content_type_gating/tests/test_models.py index adb9bd6737df..fab1b5d3ec56 100644 --- a/openedx/features/content_type_gating/tests/test_models.py +++ b/openedx/features/content_type_gating/tests/test_models.py @@ -1,28 +1,29 @@ # pylint: disable=missing-module-docstring -import pytest - - -import itertools # lint-amnesty, pylint: disable=wrong-import-order -from datetime import datetime, timedelta # lint-amnesty, pylint: disable=wrong-import-order +import itertools # pylint: disable=wrong-import-order +from datetime import datetime, timedelta # pylint: disable=wrong-import-order +from unittest.mock import Mock # pylint: disable=wrong-import-order +from zoneinfo import ZoneInfo import ddt -from zoneinfo import ZoneInfo +import pytest from django.utils import timezone from edx_django_utils.cache import RequestCache -from unittest.mock import Mock # lint-amnesty, pylint: disable=wrong-import-order from opaque_keys.edx.locator import CourseLocator from common.djangoapps.course_modes.tests.factories import CourseModeFactory +from common.djangoapps.student.tests.factories import CourseEnrollmentFactory, UserFactory from openedx.core.djangoapps.config_model_utils.models import Provenance from openedx.core.djangoapps.content.course_overviews.tests.factories import CourseOverviewFactory from openedx.core.djangoapps.site_configuration.tests.factories import SiteConfigurationFactory -from openedx.core.djangolib.testing.utils import CacheIsolationTestCase +from openedx.core.djangoapps.waffle_utils.testutils import WAFFLE_TABLES +from openedx.core.djangolib.testing.utils import AUTHZ_TABLES, CacheIsolationTestCase, FilteredQueryCountMixin from openedx.features.content_type_gating.models import ContentTypeGatingConfig -from common.djangoapps.student.tests.factories import CourseEnrollmentFactory, UserFactory + +QUERY_COUNT_TABLE_IGNORELIST = WAFFLE_TABLES + AUTHZ_TABLES @ddt.ddt -class TestContentTypeGatingConfig(CacheIsolationTestCase): # pylint: disable=missing-class-docstring +class TestContentTypeGatingConfig(FilteredQueryCountMixin, CacheIsolationTestCase): # pylint: disable=missing-class-docstring ENABLED_CACHES = ['default'] @@ -53,7 +54,7 @@ def test_enabled_for_enrollment( else: enabled_as_of = datetime.now() - timedelta(days=1) - config = ContentTypeGatingConfig.objects.create( + config = ContentTypeGatingConfig.objects.create( # noqa: F841 enabled=True, course=self.course_overview, enabled_as_of=enabled_as_of, @@ -65,15 +66,15 @@ def test_enabled_for_enrollment( course=self.course_overview, ) else: - existing_enrollment = None + existing_enrollment = None # noqa: F841 - enrollment = None + enrollment = None # noqa: F841 user = self.user course_key = self.course_overview.id - query_count = 7 + query_count = 9 - with self.assertNumQueries(query_count): + with self.assertNumQueries(query_count, table_ignorelist=QUERY_COUNT_TABLE_IGNORELIST): enabled = ContentTypeGatingConfig.enabled_for_enrollment( user=user, course_key=course_key, @@ -81,11 +82,11 @@ def test_enabled_for_enrollment( assert (not enrolled_before_enabled) == enabled def test_enabled_for_enrollment_failure(self): - with pytest.raises(ValueError): + with pytest.raises(ValueError): # noqa: PT011 ContentTypeGatingConfig.enabled_for_enrollment(None, None) - with pytest.raises(ValueError): + with pytest.raises(ValueError): # noqa: PT011 ContentTypeGatingConfig.enabled_for_enrollment(Mock(name='user'), None) - with pytest.raises(ValueError): + with pytest.raises(ValueError): # noqa: PT011 ContentTypeGatingConfig.enabled_for_enrollment(None, Mock(name='course_key')) @ddt.data(True, False) @@ -165,7 +166,7 @@ def test_config_overrides(self, global_setting, site_setting, org_setting, cours site=test_site_cfg.site, enabled=site_setting, enabled_as_of=datetime(2018, 1, 1) ) - all_settings = [global_setting, site_setting, org_setting, course_setting] + all_settings = [global_setting, site_setting, org_setting, course_setting] # noqa: F841 expected_global_setting = self._resolve_settings([global_setting]) expected_site_setting = self._resolve_settings([global_setting, site_setting]) expected_org_setting = self._resolve_settings([global_setting, site_setting, org_setting]) diff --git a/openedx/features/content_type_gating/tests/test_partitions.py b/openedx/features/content_type_gating/tests/test_partitions.py index aba6914a566f..7b1721c9b0fb 100644 --- a/openedx/features/content_type_gating/tests/test_partitions.py +++ b/openedx/features/content_type_gating/tests/test_partitions.py @@ -1,17 +1,18 @@ # pylint: disable=missing-module-docstring from datetime import datetime +from unittest.mock import Mock, patch # pylint: disable=wrong-import-order + from django.test import RequestFactory -from unittest.mock import Mock, patch # lint-amnesty, pylint: disable=wrong-import-order from opaque_keys.edx.keys import CourseKey from common.djangoapps.course_modes.tests.factories import CourseModeFactory from common.djangoapps.student.tests.factories import GlobalStaffFactory +from openedx.core.djangoapps.content.course_overviews.tests.factories import CourseOverviewFactory from openedx.core.djangolib.testing.utils import CacheIsolationTestCase from openedx.features.content_type_gating.helpers import CONTENT_GATING_PARTITION_ID, FULL_ACCESS, LIMITED_ACCESS from openedx.features.content_type_gating.models import ContentTypeGatingConfig from openedx.features.content_type_gating.partitions import create_content_gating_partition -from openedx.core.djangoapps.content.course_overviews.tests.factories import CourseOverviewFactory -from xmodule.partitions.partitions import UserPartitionError # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.partitions.partitions import UserPartitionError # pylint: disable=wrong-import-order class TestContentTypeGatingPartition(CacheIsolationTestCase): # pylint: disable=missing-class-docstring @@ -76,7 +77,7 @@ def test_access_denied_fragment_for_masquerading(self): mock_request = RequestFactory().get('/') mock_course = Mock(id=self.course_key, user_partitions={}) mock_block = Mock(scope_ids=Mock(usage_id=Mock(course_key=mock_course.id))) - mock_course_masquerade = Mock( + mock_course_masquerade = Mock( # noqa: F841 role='student', user_partition_id=CONTENT_GATING_PARTITION_ID, group_id=LIMITED_ACCESS.id, diff --git a/openedx/features/course_bookmarks/plugins.py b/openedx/features/course_bookmarks/plugins.py index 895a7df26719..9975234a868a 100644 --- a/openedx/features/course_bookmarks/plugins.py +++ b/openedx/features/course_bookmarks/plugins.py @@ -6,9 +6,9 @@ from django.urls import reverse from django.utils.translation import gettext as _ +from common.djangoapps.student.models import CourseEnrollment from lms.djangoapps.courseware.permissions import EDIT_BOOKMARK from openedx.features.course_experience.course_tools import CourseTool -from common.djangoapps.student.models import CourseEnrollment class CourseBookmarksTool(CourseTool): @@ -32,14 +32,14 @@ def is_enabled(cls, request, course_key): return CourseEnrollment.is_enrolled(request.user, course_key) @classmethod - def title(cls): # lint-amnesty, pylint: disable=arguments-differ + def title(cls): # pylint: disable=arguments-differ """ Returns the title of this tool. """ return _('Bookmarks') @classmethod - def icon_classes(cls): # lint-amnesty, pylint: disable=arguments-differ + def icon_classes(cls): # pylint: disable=arguments-differ """ Returns the icon classes needed to represent this tool. """ diff --git a/openedx/features/course_bookmarks/templates/course_bookmarks/course-bookmarks.html b/openedx/features/course_bookmarks/templates/course_bookmarks/course-bookmarks.html index a7038b3bdae6..bda15a7431af 100644 --- a/openedx/features/course_bookmarks/templates/course_bookmarks/course-bookmarks.html +++ b/openedx/features/course_bookmarks/templates/course_bookmarks/course-bookmarks.html @@ -15,7 +15,7 @@ from django.utils.translation import gettext as _ from django.template.defaultfilters import escapejs -from lms.djangoapps.discussion.django_comment_client.permissions import has_permission +from openedx.core.djangoapps.django_comment_common.models import has_permission from openedx.core.djangolib.js_utils import dump_js_escaped_json, js_escaped_string from openedx.core.djangolib.markup import HTML from openedx.features.course_experience import course_home_page_title diff --git a/openedx/features/course_bookmarks/tests/test_course_bookmarks.py b/openedx/features/course_bookmarks/tests/test_course_bookmarks.py index 313ea3d3b15a..d6d90d72ff3c 100644 --- a/openedx/features/course_bookmarks/tests/test_course_bookmarks.py +++ b/openedx/features/course_bookmarks/tests/test_course_bookmarks.py @@ -8,7 +8,7 @@ from xmodule.modulestore import ModuleStoreEnum from xmodule.modulestore.tests.django_utils import CourseUserType, SharedModuleStoreTestCase -from xmodule.modulestore.tests.factories import CourseFactory, BlockFactory +from xmodule.modulestore.tests.factories import BlockFactory, CourseFactory from ..plugins import CourseBookmarksTool diff --git a/openedx/features/course_bookmarks/urls.py b/openedx/features/course_bookmarks/urls.py index 441d2b0d10d8..d19055793531 100644 --- a/openedx/features/course_bookmarks/urls.py +++ b/openedx/features/course_bookmarks/urls.py @@ -3,6 +3,7 @@ """ from django.urls import path + from .views.course_bookmarks import CourseBookmarksFragmentView, CourseBookmarksView urlpatterns = [ diff --git a/openedx/features/course_bookmarks/views/course_bookmarks.py b/openedx/features/course_bookmarks/views/course_bookmarks.py index 7cdab73fc381..8f153fefca1f 100644 --- a/openedx/features/course_bookmarks/views/course_bookmarks.py +++ b/openedx/features/course_bookmarks/views/course_bookmarks.py @@ -16,11 +16,11 @@ from opaque_keys.edx.keys import CourseKey from web_fragments.fragment import Fragment +from common.djangoapps.util.views import ensure_valid_course_key from lms.djangoapps.courseware.courses import get_course_with_access from openedx.core.djangoapps.plugin_api.views import EdxFragmentView from openedx.core.djangoapps.user_api.models import UserPreference from openedx.features.course_experience import default_course_url -from common.djangoapps.util.views import ensure_valid_course_key class CourseBookmarksView(View): @@ -64,7 +64,7 @@ class CourseBookmarksFragmentView(EdxFragmentView): Fragment view that shows a user's bookmarks for a course. """ - def render_to_fragment(self, request, course_id=None, **kwargs): # lint-amnesty, pylint: disable=arguments-differ + def render_to_fragment(self, request, course_id=None, **kwargs): # pylint: disable=arguments-differ """ Renders the user's course bookmarks as a fragment. """ diff --git a/openedx/features/course_duration_limits/access.py b/openedx/features/course_duration_limits/access.py index 8f73ae2266ea..2f76de083d9a 100644 --- a/openedx/features/course_duration_limits/access.py +++ b/openedx/features/course_duration_limits/access.py @@ -13,8 +13,8 @@ from common.djangoapps.util.date_utils import strftime_localized, strftime_localized_html from lms.djangoapps.courseware.access_response import AccessError from lms.djangoapps.courseware.access_utils import ACCESS_GRANTED -from lms.djangoapps.courseware.utils import verified_upgrade_deadline_link from lms.djangoapps.courseware.masquerade import get_course_masquerade, is_masquerading_as_specific_student +from lms.djangoapps.courseware.utils import verified_upgrade_deadline_link from openedx.core.djangoapps.content.course_overviews.models import CourseOverview from openedx.core.djangoapps.course_date_signals.utils import get_expected_duration from openedx.core.djangolib.markup import HTML @@ -42,7 +42,7 @@ def __init__(self, user, course, expiration_date): expiration_date=expiration_date ) - # lint-amnesty, pylint: disable=super-with-arguments + # pylint: disable=super-with-arguments super().__init__(error_code, developer_message, user_message, additional_context_user_message) diff --git a/openedx/features/course_duration_limits/models.py b/openedx/features/course_duration_limits/models.py index fc80adb48125..bfa6e5ebd400 100644 --- a/openedx/features/course_duration_limits/models.py +++ b/openedx/features/course_duration_limits/models.py @@ -5,7 +5,6 @@ from django.core.exceptions import ValidationError from django.db import models from django.utils import timezone - from django.utils.translation import gettext_lazy as _ from openedx.core.djangoapps.config_model_utils.models import StackedConfigurationModel @@ -102,7 +101,7 @@ def enabled_as_of_datetime(self, target_datetime): return bool(self.enabled and self.enabled_as_of <= target_datetime) def __str__(self): - return "CourseDurationLimits(enabled={!r}, enabled_as_of={!r})".format( + return "CourseDurationLimits(enabled={!r}, enabled_as_of={!r})".format( # noqa: UP032 self.enabled, self.enabled_as_of, ) diff --git a/openedx/features/course_duration_limits/tests/test_access.py b/openedx/features/course_duration_limits/tests/test_access.py index f948324b48b3..05ddb3e161f9 100644 --- a/openedx/features/course_duration_limits/tests/test_access.py +++ b/openedx/features/course_duration_limits/tests/test_access.py @@ -3,13 +3,12 @@ import itertools from datetime import datetime, timedelta +from zoneinfo import ZoneInfo import ddt from crum import set_current_request from django.test import RequestFactory from django.utils import timezone -from zoneinfo import ZoneInfo -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase from common.djangoapps.course_modes.models import CourseMode from common.djangoapps.course_modes.tests.factories import CourseModeFactory @@ -23,16 +22,17 @@ generate_course_expired_message, get_access_expiration_data, get_user_course_duration, - get_user_course_expiration_date + get_user_course_expiration_date, ) from openedx.features.course_duration_limits.models import CourseDurationLimitConfig +from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase @ddt.ddt class TestAccess(ModuleStoreTestCase): """Tests of openedx.features.course_duration_limits.access""" def setUp(self): - super().setUp() # lint-amnesty, pylint: disable=super-with-arguments + super().setUp() # pylint: disable=super-with-arguments CourseDurationLimitConfig.objects.create( enabled=True, @@ -41,12 +41,12 @@ def setUp(self): DynamicUpgradeDeadlineConfiguration.objects.create(enabled=True) self.course = CourseOverviewFactory.create(start=datetime(2018, 1, 1, tzinfo=ZoneInfo("UTC")), self_paced=True) - def assertDateInMessage(self, date, message): # lint-amnesty, pylint: disable=missing-function-docstring + def assertDateInMessage(self, date, message): # pylint: disable=missing-function-docstring # First, check that the formatted version is in there assert strftime_localized(date, 'SHORT_DATE') in message # But also that the machine-readable version is in there - assert 'data-datetime="%s"' % date.isoformat() in message + assert 'data-datetime="%s"' % date.isoformat() in message # noqa: UP031 def test_get_access_expiration_data(self): enrollment = CourseEnrollmentFactory() diff --git a/openedx/features/course_duration_limits/tests/test_course_expiration.py b/openedx/features/course_duration_limits/tests/test_course_expiration.py index b794ef3076c4..8ab7ca14c338 100644 --- a/openedx/features/course_duration_limits/tests/test_course_expiration.py +++ b/openedx/features/course_duration_limits/tests/test_course_expiration.py @@ -4,25 +4,27 @@ from datetime import timedelta from unittest import mock +from unittest.mock import patch import ddt from django.conf import settings from django.urls import reverse from django.utils.timezone import now -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase -from xmodule.modulestore.tests.factories import CourseFactory, BlockFactory -from xmodule.partitions.partitions import ENROLLMENT_TRACK_PARTITION_ID from common.djangoapps.course_modes.models import CourseMode from common.djangoapps.student.models import CourseEnrollment, FBEEnrollmentExclusion from common.djangoapps.student.roles import CourseInstructorRole -from common.djangoapps.student.tests.factories import BetaTesterFactory -from common.djangoapps.student.tests.factories import TEST_PASSWORD, CourseEnrollmentFactory, UserFactory -from common.djangoapps.student.tests.factories import GlobalStaffFactory -from common.djangoapps.student.tests.factories import InstructorFactory -from common.djangoapps.student.tests.factories import OrgInstructorFactory -from common.djangoapps.student.tests.factories import OrgStaffFactory -from common.djangoapps.student.tests.factories import StaffFactory +from common.djangoapps.student.tests.factories import ( + TEST_PASSWORD, + BetaTesterFactory, + CourseEnrollmentFactory, + GlobalStaffFactory, + InstructorFactory, + OrgInstructorFactory, + OrgStaffFactory, + StaffFactory, + UserFactory, +) from lms.djangoapps.courseware.tests.helpers import MasqueradeMixin from lms.djangoapps.discussion.django_comment_client.tests.factories import RoleFactory from openedx.core.djangoapps.content.course_overviews.models import CourseOverview @@ -31,13 +33,16 @@ FORUM_ROLE_ADMINISTRATOR, FORUM_ROLE_COMMUNITY_TA, FORUM_ROLE_GROUP_MODERATOR, - FORUM_ROLE_MODERATOR + FORUM_ROLE_MODERATOR, ) from openedx.core.djangoapps.schedules.models import Schedule from openedx.features.content_type_gating.helpers import CONTENT_GATING_PARTITION_ID, CONTENT_TYPE_GATE_GROUP_IDS from openedx.features.course_duration_limits.access import get_user_course_expiration_date from openedx.features.course_duration_limits.models import CourseDurationLimitConfig from openedx.features.course_experience.tests.views.helpers import add_course_mode +from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase +from xmodule.modulestore.tests.factories import BlockFactory, CourseFactory +from xmodule.partitions.partitions import ENROLLMENT_TRACK_PARTITION_ID # pylint: disable=no-member @@ -45,7 +50,12 @@ class CourseExpirationTestCase(ModuleStoreTestCase, MasqueradeMixin): """Tests to verify the get_user_course_expiration_date function is working correctly""" def setUp(self): - super().setUp() # lint-amnesty, pylint: disable=super-with-arguments + super().setUp() # pylint: disable=super-with-arguments + self.catalog_patch = patch( + 'openedx.core.djangoapps.catalog.models.CatalogIntegration.is_enabled', + return_value=True + ) + self.catalog_patch.start() self.course = CourseFactory( start=now() - timedelta(weeks=10), ) @@ -72,8 +82,9 @@ def setUp(self): add_course_mode(self.course) def tearDown(self): + self.catalog_patch.stop() CourseEnrollment.unenroll(self.user, self.course.id) - super().tearDown() # lint-amnesty, pylint: disable=super-with-arguments + super().tearDown() # pylint: disable=super-with-arguments def get_courseware(self): """Returns a response from a GET on a courseware section""" @@ -255,7 +266,7 @@ def test_masquerade(self, masquerade_config, show_expiration_banner, mock_get_co response = self.get_courseware() assert response.status_code == 200 - self.assertCountEqual(response.redirect_chain, []) + self.assertCountEqual(response.redirect_chain, []) # noqa: PT009 banner_text = 'You lose all access to this course, including your progress,' if show_expiration_banner: self.assertContains(response, banner_text) @@ -291,7 +302,7 @@ def test_masquerade_in_holdback(self, mock_get_course_run_details): response = self.get_courseware() assert response.status_code == 200 - self.assertCountEqual(response.redirect_chain, []) + self.assertCountEqual(response.redirect_chain, []) # noqa: PT009 banner_text = 'You lose all access to this course, including your progress,' self.assertNotContains(response, banner_text) @@ -326,7 +337,7 @@ def test_masquerade_expired(self, mock_get_course_run_details): response = self.get_courseware() assert response.status_code == 200 - self.assertCountEqual(response.redirect_chain, []) + self.assertCountEqual(response.redirect_chain, []) # noqa: PT009 banner_text = 'This learner does not have access to this course. Their access expired on' self.assertContains(response, banner_text) @@ -376,7 +387,7 @@ def test_no_banner_when_masquerading_as_staff(self, role_factory, mock_get_cours response = self.get_courseware() assert response.status_code == 200 - self.assertCountEqual(response.redirect_chain, []) + self.assertCountEqual(response.redirect_chain, []) # noqa: PT009 banner_text = 'This learner does not have access to this course. Their access expired on' self.assertNotContains(response, banner_text) @@ -424,6 +435,6 @@ def test_no_banner_when_masquerading_as_forum_staff(self, role_name, mock_get_co response = self.get_courseware() assert response.status_code == 200 - self.assertCountEqual(response.redirect_chain, []) + self.assertCountEqual(response.redirect_chain, []) # noqa: PT009 banner_text = 'This learner does not have access to this course. Their access expired on' self.assertNotContains(response, banner_text) diff --git a/openedx/features/course_duration_limits/tests/test_models.py b/openedx/features/course_duration_limits/tests/test_models.py index f596f3534489..2892cbe7edf6 100644 --- a/openedx/features/course_duration_limits/tests/test_models.py +++ b/openedx/features/course_duration_limits/tests/test_models.py @@ -5,10 +5,10 @@ import itertools from datetime import datetime, timedelta from unittest.mock import Mock +from zoneinfo import ZoneInfo import ddt import pytest -from zoneinfo import ZoneInfo from django.utils import timezone from edx_django_utils.cache import RequestCache from opaque_keys.edx.locator import CourseLocator @@ -18,12 +18,15 @@ from openedx.core.djangoapps.config_model_utils.models import Provenance from openedx.core.djangoapps.content.course_overviews.tests.factories import CourseOverviewFactory from openedx.core.djangoapps.site_configuration.tests.factories import SiteConfigurationFactory -from openedx.core.djangolib.testing.utils import CacheIsolationTestCase +from openedx.core.djangoapps.waffle_utils.testutils import WAFFLE_TABLES +from openedx.core.djangolib.testing.utils import AUTHZ_TABLES, CacheIsolationTestCase, FilteredQueryCountMixin from openedx.features.course_duration_limits.models import CourseDurationLimitConfig +QUERY_COUNT_TABLE_IGNORELIST = WAFFLE_TABLES + AUTHZ_TABLES + @ddt.ddt -class TestCourseDurationLimitConfig(CacheIsolationTestCase): +class TestCourseDurationLimitConfig(FilteredQueryCountMixin, CacheIsolationTestCase): """ Tests of CourseDurationLimitConfig """ @@ -35,7 +38,7 @@ def setUp(self): CourseModeFactory.create(course_id=self.course_overview.id, mode_slug='audit') CourseModeFactory.create(course_id=self.course_overview.id, mode_slug='verified') self.user = UserFactory.create() - super().setUp() # lint-amnesty, pylint: disable=super-with-arguments + super().setUp() # pylint: disable=super-with-arguments @ddt.data( (True, True), @@ -64,31 +67,31 @@ def test_enabled_for_enrollment( ) if already_enrolled: - existing_enrollment = CourseEnrollmentFactory.create( # lint-amnesty, pylint: disable=unused-variable + existing_enrollment = CourseEnrollmentFactory.create( # pylint: disable=unused-variable user=self.user, course=self.course_overview, ) else: - existing_enrollment = None + existing_enrollment = None # noqa: F841 user = self.user - course_key = self.course_overview.id # lint-amnesty, pylint: disable=unused-variable + course_key = self.course_overview.id # pylint: disable=unused-variable # noqa: F841 - query_count = 7 + query_count = 9 - with self.assertNumQueries(query_count): + with self.assertNumQueries(query_count, table_ignorelist=QUERY_COUNT_TABLE_IGNORELIST): enabled = CourseDurationLimitConfig.enabled_for_enrollment(user, self.course_overview) assert (not enrolled_before_enabled) == enabled def test_enabled_for_enrollment_failure(self): - with pytest.raises(ValueError): + with pytest.raises(ValueError): # noqa: PT011 CourseDurationLimitConfig.enabled_for_enrollment(None, None) - with pytest.raises(ValueError): + with pytest.raises(ValueError): # noqa: PT011 CourseDurationLimitConfig.enabled_for_enrollment( Mock(name='user'), None ) - with pytest.raises(ValueError): + with pytest.raises(ValueError): # noqa: PT011 CourseDurationLimitConfig.enabled_for_enrollment( None, Mock(name='course_key') @@ -207,7 +210,7 @@ def test_all_current_course_configs(self): id=CourseLocator(test_org, 'test_course', f'run-{course_setting}') ) CourseDurationLimitConfig.objects.create( - course=test_course, enabled=course_setting, enabled_as_of=datetime(2018, 1, 1, tzinfo=ZoneInfo("UTC")) # lint-amnesty, pylint: disable=line-too-long + course=test_course, enabled=course_setting, enabled_as_of=datetime(2018, 1, 1, tzinfo=ZoneInfo("UTC")) # pylint: disable=line-too-long ) with self.assertNumQueries(4): @@ -265,7 +268,7 @@ def test_caching_global(self): def test_caching_site(self): site_cfg = SiteConfigurationFactory() - site_config = CourseDurationLimitConfig(site=site_cfg.site, enabled=True, enabled_as_of=datetime(2018, 1, 1, tzinfo=ZoneInfo("UTC"))) # lint-amnesty, pylint: disable=line-too-long + site_config = CourseDurationLimitConfig(site=site_cfg.site, enabled=True, enabled_as_of=datetime(2018, 1, 1, tzinfo=ZoneInfo("UTC"))) # pylint: disable=line-too-long site_config.save() RequestCache.clear_all_namespaces() @@ -306,7 +309,7 @@ def test_caching_org(self): site_cfg = SiteConfigurationFactory.create( site_values={'course_org_filter': course.org} ) - org_config = CourseDurationLimitConfig(org=course.org, enabled=True, enabled_as_of=datetime(2018, 1, 1, tzinfo=ZoneInfo("UTC"))) # lint-amnesty, pylint: disable=line-too-long + org_config = CourseDurationLimitConfig(org=course.org, enabled=True, enabled_as_of=datetime(2018, 1, 1, tzinfo=ZoneInfo("UTC"))) # pylint: disable=line-too-long org_config.save() RequestCache.clear_all_namespaces() @@ -342,7 +345,7 @@ def test_caching_org(self): with self.assertNumQueries(0): assert not CourseDurationLimitConfig.current(org=course.org).enabled - site_config = CourseDurationLimitConfig(site=site_cfg.site, enabled=True, enabled_as_of=datetime(2018, 1, 1, tzinfo=ZoneInfo("UTC"))) # lint-amnesty, pylint: disable=line-too-long + site_config = CourseDurationLimitConfig(site=site_cfg.site, enabled=True, enabled_as_of=datetime(2018, 1, 1, tzinfo=ZoneInfo("UTC"))) # pylint: disable=line-too-long site_config.save() RequestCache.clear_all_namespaces() @@ -356,7 +359,7 @@ def test_caching_course(self): site_cfg = SiteConfigurationFactory.create( site_values={'course_org_filter': course.org} ) - course_config = CourseDurationLimitConfig(course=course, enabled=True, enabled_as_of=datetime(2018, 1, 1, tzinfo=ZoneInfo("UTC"))) # lint-amnesty, pylint: disable=line-too-long + course_config = CourseDurationLimitConfig(course=course, enabled=True, enabled_as_of=datetime(2018, 1, 1, tzinfo=ZoneInfo("UTC"))) # pylint: disable=line-too-long course_config.save() RequestCache.clear_all_namespaces() @@ -392,7 +395,7 @@ def test_caching_course(self): with self.assertNumQueries(0): assert not CourseDurationLimitConfig.current(course_key=course.id).enabled - site_config = CourseDurationLimitConfig(site=site_cfg.site, enabled=True, enabled_as_of=datetime(2018, 1, 1, tzinfo=ZoneInfo("UTC"))) # lint-amnesty, pylint: disable=line-too-long + site_config = CourseDurationLimitConfig(site=site_cfg.site, enabled=True, enabled_as_of=datetime(2018, 1, 1, tzinfo=ZoneInfo("UTC"))) # pylint: disable=line-too-long site_config.save() RequestCache.clear_all_namespaces() @@ -401,7 +404,7 @@ def test_caching_course(self): with self.assertNumQueries(0): assert not CourseDurationLimitConfig.current(course_key=course.id).enabled - org_config = CourseDurationLimitConfig(org=course.org, enabled=True, enabled_as_of=datetime(2018, 1, 1, tzinfo=ZoneInfo("UTC"))) # lint-amnesty, pylint: disable=line-too-long + org_config = CourseDurationLimitConfig(org=course.org, enabled=True, enabled_as_of=datetime(2018, 1, 1, tzinfo=ZoneInfo("UTC"))) # pylint: disable=line-too-long org_config.save() RequestCache.clear_all_namespaces() diff --git a/openedx/features/course_experience/__init__.py b/openedx/features/course_experience/__init__.py index 1305879f1cb8..b64ed9a9528f 100644 --- a/openedx/features/course_experience/__init__.py +++ b/openedx/features/course_experience/__init__.py @@ -2,24 +2,24 @@ Unified course experience settings and helper methods. """ -from django.urls import reverse +from django.urls import reverse # noqa: F401 from django.utils.translation import gettext as _ from edx_toggles.toggles import WaffleFlag -from openedx.core.djangoapps.waffle_utils import CourseWaffleFlag from openedx_filters.exceptions import OpenEdxFilterException from openedx_filters.learning.filters import CourseHomeUrlCreationStarted +from openedx.core.djangoapps.waffle_utils import CourseWaffleFlag # Namespace for course experience waffle flags. WAFFLE_FLAG_NAMESPACE = 'course_experience' # Waffle flag to disable the separate course outline page and full width content. -DISABLE_COURSE_OUTLINE_PAGE_FLAG = CourseWaffleFlag( # lint-amnesty, pylint: disable=toggle-missing-annotation +DISABLE_COURSE_OUTLINE_PAGE_FLAG = CourseWaffleFlag( # pylint: disable=toggle-missing-annotation f'{WAFFLE_FLAG_NAMESPACE}.disable_course_outline_page', __name__ ) # Waffle flag to let learners access a course before its start date. -COURSE_PRE_START_ACCESS_FLAG = WaffleFlag(f'{WAFFLE_FLAG_NAMESPACE}.pre_start_access', __name__) # lint-amnesty, pylint: disable=toggle-missing-annotation +COURSE_PRE_START_ACCESS_FLAG = WaffleFlag(f'{WAFFLE_FLAG_NAMESPACE}.pre_start_access', __name__) # pylint: disable=toggle-missing-annotation # .. toggle_name: course_experience.enable_course_goals # .. toggle_implementation: CourseWaffleFlag @@ -29,7 +29,7 @@ # .. toggle_creation_date: 2017-09-11 # .. toggle_target_removal_date: None # .. toggle_warning: This temporary feature toggle does not have a target removal date. -ENABLE_COURSE_GOALS = CourseWaffleFlag(f'{WAFFLE_FLAG_NAMESPACE}.enable_course_goals', __name__) # lint-amnesty, pylint: disable=toggle-missing-annotation +ENABLE_COURSE_GOALS = CourseWaffleFlag(f'{WAFFLE_FLAG_NAMESPACE}.enable_course_goals', __name__) # pylint: disable=toggle-missing-annotation # .. toggle_name: course_experience.enable_ses_for_goalreminder # .. toggle_implementation: CourseWaffleFlag @@ -39,11 +39,11 @@ # .. toggle_creation_date: 2024-10-06 # .. toggle_target_removal_date: None # .. toggle_warning: This temporary feature toggle does not have a target removal date. -ENABLE_SES_FOR_GOALREMINDER = CourseWaffleFlag(f'{WAFFLE_FLAG_NAMESPACE}.enable_ses_for_goalreminder', __name__) # lint-amnesty, pylint: disable=toggle-missing-annotation +ENABLE_SES_FOR_GOALREMINDER = CourseWaffleFlag(f'{WAFFLE_FLAG_NAMESPACE}.enable_ses_for_goalreminder', __name__) # pylint: disable=toggle-missing-annotation # Waffle flag to enable anonymous access to a course SEO_WAFFLE_FLAG_NAMESPACE = 'seo' -COURSE_ENABLE_UNENROLLED_ACCESS_FLAG = CourseWaffleFlag( # lint-amnesty, pylint: disable=toggle-missing-annotation +COURSE_ENABLE_UNENROLLED_ACCESS_FLAG = CourseWaffleFlag( # pylint: disable=toggle-missing-annotation f'{SEO_WAFFLE_FLAG_NAMESPACE}.enable_anonymous_courseware_access', __name__ ) @@ -57,7 +57,7 @@ # .. toggle_warning: To set a relative due date for self-paced courses, the weeks_to_complete field for a course run # needs to be set. Currently it can be set through the publisher app. # .. toggle_tickets: https://openedx.atlassian.net/browse/AA-27 -RELATIVE_DATES_FLAG = CourseWaffleFlag(f'{WAFFLE_FLAG_NAMESPACE}.relative_dates', __name__) # lint-amnesty, pylint: disable=toggle-missing-annotation +RELATIVE_DATES_FLAG = CourseWaffleFlag(f'{WAFFLE_FLAG_NAMESPACE}.relative_dates', __name__) # pylint: disable=toggle-missing-annotation # .. toggle_name: course_experience.relative_dates_disable_reset # .. toggle_implementation: CourseWaffleFlag @@ -81,7 +81,7 @@ # .. toggle_creation_date: 2021-01-26 # .. toggle_target_removal_date: 2021-04-26 # .. toggle_tickets: https://openedx.atlassian.net/browse/AA-36 -CALENDAR_SYNC_FLAG = CourseWaffleFlag(f'{WAFFLE_FLAG_NAMESPACE}.calendar_sync', __name__) # lint-amnesty, pylint: disable=toggle-missing-annotation +CALENDAR_SYNC_FLAG = CourseWaffleFlag(f'{WAFFLE_FLAG_NAMESPACE}.calendar_sync', __name__) # pylint: disable=toggle-missing-annotation # .. toggle_name: course_experience.enforce_masquerade_start_dates # .. toggle_implementation: CourseWaffleFlag @@ -140,7 +140,7 @@ def course_home_url(course_key): course_key, home_url = CourseHomeUrlCreationStarted.run_filter( course_key=course_key, course_home_url=home_url ) - except OpenEdxFilterException as exc: + except OpenEdxFilterException as exc: # noqa: F841 pass return home_url diff --git a/openedx/features/course_experience/api/v1/serializers.py b/openedx/features/course_experience/api/v1/serializers.py index 10f2a785d1b0..32180f028882 100644 --- a/openedx/features/course_experience/api/v1/serializers.py +++ b/openedx/features/course_experience/api/v1/serializers.py @@ -1,9 +1,8 @@ """ Serializer for Course Deadlines (Mobile) """ -from rest_framework import serializers - from opaque_keys.edx.keys import CourseKey +from rest_framework import serializers from lms.djangoapps.course_home_api.serializers import DatesBannerSerializer from openedx.core.djangoapps.content.course_overviews.models import CourseOverview @@ -13,7 +12,7 @@ class CourseDeadlinesMobileSerializer(DatesBannerSerializer): """Serializer for course deadlines""" has_ended = serializers.SerializerMethodField() - def get_has_ended(self, _): # lint-amnesty, pylint: disable=missing-function-docstring + def get_has_ended(self, _): # pylint: disable=missing-function-docstring course_key_string = self.context['view'].kwargs.get('course_key_string') course_key = CourseKey.from_string(course_key_string) course = CourseOverview.get_from_id(course_key) diff --git a/openedx/features/course_experience/api/v1/tests/test_utils.py b/openedx/features/course_experience/api/v1/tests/test_utils.py index 741a2d7658f1..45355650539e 100644 --- a/openedx/features/course_experience/api/v1/tests/test_utils.py +++ b/openedx/features/course_experience/api/v1/tests/test_utils.py @@ -14,9 +14,9 @@ from lms.djangoapps.courseware.tests.helpers import MasqueradeMixin from openedx.core.djangoapps.schedules.models import Schedule from openedx.features.course_experience.api.v1.utils import ( - reset_deadlines_for_course, + reset_bulk_course_deadlines, reset_course_deadlines_for_user, - reset_bulk_course_deadlines + reset_deadlines_for_course, ) from xmodule.modulestore.tests.factories import CourseFactory diff --git a/openedx/features/course_experience/api/v1/urls.py b/openedx/features/course_experience/api/v1/urls.py index 2c84af437f70..22c2f5c4373a 100644 --- a/openedx/features/course_experience/api/v1/urls.py +++ b/openedx/features/course_experience/api/v1/urls.py @@ -4,12 +4,12 @@ from django.conf import settings -from django.urls import re_path, path +from django.urls import path, re_path from openedx.features.course_experience.api.v1.views import ( - reset_course_deadlines, - reset_all_course_deadlines, CourseDeadlinesMobileView, + reset_all_course_deadlines, + reset_course_deadlines, ) urlpatterns = [] diff --git a/openedx/features/course_experience/api/v1/utils.py b/openedx/features/course_experience/api/v1/utils.py index 8f9205b0f113..2eead8900c31 100644 --- a/openedx/features/course_experience/api/v1/utils.py +++ b/openedx/features/course_experience/api/v1/utils.py @@ -3,15 +3,15 @@ Course Experience API utilities. """ import logging + from eventtracking import tracker +from lms.djangoapps.course_api.api import course_detail from lms.djangoapps.courseware.access import has_access from lms.djangoapps.courseware.masquerade import is_masquerading, setup_masquerade -from lms.djangoapps.course_api.api import course_detail from openedx.core.djangoapps.schedules.utils import reset_self_paced_schedule from openedx.features.course_experience.utils import dates_banner_should_display - logger = logging.getLogger(__name__) @@ -37,7 +37,7 @@ def reset_course_deadlines_for_user(user, course_key): return False -def reset_bulk_course_deadlines(request, course_keys, research_event_data={}): # lint-amnesty, pylint: disable=dangerous-default-value +def reset_bulk_course_deadlines(request, course_keys, research_event_data={}): # pylint: disable=dangerous-default-value # noqa: B006 """ Reset deadlines for multiple courses for the requesting user. @@ -82,7 +82,7 @@ def reset_bulk_course_deadlines(request, course_keys, research_event_data={}): return success_course_keys, failed_course_keys -def reset_deadlines_for_course(request, course_key, research_event_data={}): # lint-amnesty, pylint: disable=dangerous-default-value +def reset_deadlines_for_course(request, course_key, research_event_data={}): # pylint: disable=dangerous-default-value # noqa: B006 """ Set the start_date of a schedule to today, which in turn will adjust due dates for sequentials belonging to a self paced course diff --git a/openedx/features/course_experience/api/v1/views.py b/openedx/features/course_experience/api/v1/views.py index d822fdd65c67..978fa1ed3868 100644 --- a/openedx/features/course_experience/api/v1/views.py +++ b/openedx/features/course_experience/api/v1/views.py @@ -5,25 +5,22 @@ from django.utils.html import format_html from django.utils.translation import gettext as _ - +from edx_rest_framework_extensions.auth.jwt.authentication import JwtAuthentication +from edx_rest_framework_extensions.auth.session.authentication import SessionAuthenticationAllowInactiveUser +from opaque_keys.edx.keys import CourseKey from rest_framework.decorators import api_view, authentication_classes, permission_classes from rest_framework.exceptions import APIException, ParseError +from rest_framework.generics import RetrieveAPIView from rest_framework.permissions import IsAuthenticated from rest_framework.response import Response -from rest_framework.generics import RetrieveAPIView - -from edx_rest_framework_extensions.auth.jwt.authentication import JwtAuthentication -from edx_rest_framework_extensions.auth.session.authentication import SessionAuthenticationAllowInactiveUser -from opaque_keys.edx.keys import CourseKey from common.djangoapps.student.models import CourseEnrollment from lms.djangoapps.course_goals.models import UserActivity from lms.djangoapps.courseware.courses import get_course_with_access - from openedx.core.lib.api.authentication import BearerAuthenticationAllowInactiveUser from openedx.features.course_experience.api.v1.serializers import CourseDeadlinesMobileSerializer +from openedx.features.course_experience.api.v1.utils import reset_bulk_course_deadlines, reset_deadlines_for_course from openedx.features.course_experience.url_helpers import get_learning_mfe_home_url -from openedx.features.course_experience.api.v1.utils import reset_deadlines_for_course, reset_bulk_course_deadlines log = logging.getLogger(__name__) diff --git a/openedx/features/course_experience/course_tools.py b/openedx/features/course_experience/course_tools.py index d1c47ada8606..9bf8ed60804b 100644 --- a/openedx/features/course_experience/course_tools.py +++ b/openedx/features/course_experience/course_tools.py @@ -41,7 +41,7 @@ def analytics_id(cls): raise NotImplementedError("Must specify an id to enable course tool eventing.") @classmethod - def is_enabled(cls, request, course_key): # lint-amnesty, pylint: disable=unused-argument + def is_enabled(cls, request, course_key): # pylint: disable=unused-argument """ Returns true if this tool is enabled for the specified course key. """ diff --git a/openedx/features/course_experience/plugins.py b/openedx/features/course_experience/plugins.py index 35f0cea02349..d0bde9e540ab 100644 --- a/openedx/features/course_experience/plugins.py +++ b/openedx/features/course_experience/plugins.py @@ -27,14 +27,14 @@ def analytics_id(cls): return 'edx.updates' @classmethod - def title(cls): # lint-amnesty, pylint: disable=arguments-differ + def title(cls): # pylint: disable=arguments-differ """ Returns the title of this tool. """ return _('Updates') @classmethod - def icon_classes(cls): # lint-amnesty, pylint: disable=arguments-differ + def icon_classes(cls): # pylint: disable=arguments-differ """ Returns icon classes needed to represent this tool. """ diff --git a/openedx/features/course_experience/tests/__init__.py b/openedx/features/course_experience/tests/__init__.py index 9581c095a446..5ad089b96a26 100644 --- a/openedx/features/course_experience/tests/__init__.py +++ b/openedx/features/course_experience/tests/__init__.py @@ -5,11 +5,16 @@ from common.djangoapps.student.models import CourseEnrollment from common.djangoapps.student.tests.factories import UserFactory from lms.djangoapps.courseware.courses import get_course_info_usage_key -from xmodule.modulestore import ModuleStoreEnum # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.exceptions import ItemNotFoundError # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory, BlockFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore import ModuleStoreEnum # pylint: disable=wrong-import-order +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order +from xmodule.modulestore.exceptions import ItemNotFoundError # pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + SharedModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import ( # pylint: disable=wrong-import-order + BlockFactory, + CourseFactory, +) class BaseCourseUpdatesTestCase(SharedModuleStoreTestCase): diff --git a/openedx/features/course_experience/tests/test_course_updates.py b/openedx/features/course_experience/tests/test_course_updates.py index accad1734f0c..8200102db1ea 100644 --- a/openedx/features/course_experience/tests/test_course_updates.py +++ b/openedx/features/course_experience/tests/test_course_updates.py @@ -6,7 +6,9 @@ from openedx.core.djangoapps.user_api.course_tag.api import get_course_tag, set_course_tag from openedx.features.course_experience.course_updates import ( - dismiss_current_update_for_user, get_current_update_for_user, get_ordered_updates, + dismiss_current_update_for_user, + get_current_update_for_user, + get_ordered_updates, ) from openedx.features.course_experience.tests import BaseCourseUpdatesTestCase @@ -28,7 +30,7 @@ def test_update_structure(self): date = 'January 1, 2000' self.create_course_update(content, date=date) updates = get_ordered_updates(self.request, self.course) - self.assertListEqual(updates, [{ + self.assertListEqual(updates, [{ # noqa: PT009 'id': 1, 'content': content, 'date': date, @@ -44,13 +46,13 @@ def test_ordered_updates(self): ill_formed = self.create_course_update('Ill-formed date is parsed as now()', date='foobar') self.create_course_update('Deleted is ignored', deleted=True) updates = get_ordered_updates(self.request, self.course) - self.assertListEqual(updates, [ill_formed, third, second, injected, first]) + self.assertListEqual(updates, [ill_formed, third, second, injected, first]) # noqa: PT009 def test_replace_urls(self): """We should be replacing static URLs with course specific ones.""" self.create_course_update("") updates = get_ordered_updates(self.request, self.course) - expected = "".format( + expected = "".format( # noqa: UP032 org=self.course.id.org, course=self.course.id.course, run=self.course.id.run, diff --git a/openedx/features/course_experience/tests/test_url_helpers.py b/openedx/features/course_experience/tests/test_url_helpers.py index 96baaeb2a55d..6ddf1b6b8781 100644 --- a/openedx/features/course_experience/tests/test_url_helpers.py +++ b/openedx/features/course_experience/tests/test_url_helpers.py @@ -1,14 +1,15 @@ """ Test some of the functions in url_helpers """ +from unittest.mock import patch + import ddt from django.test import TestCase from django.test.client import RequestFactory from django.test.utils import override_settings -from unittest.mock import patch from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase -from xmodule.modulestore.tests.factories import CourseFactory, BlockFactory +from xmodule.modulestore.tests.factories import BlockFactory, CourseFactory from .. import url_helpers @@ -167,4 +168,4 @@ def test_get_courseware_url( url = url_helpers.get_courseware_url(block.location) path = url.split('?')[0] assert path == expected_path - course_run = self.items['course_run'] + course_run = self.items['course_run'] # noqa: F841 diff --git a/openedx/features/course_experience/tests/views/test_course_updates.py b/openedx/features/course_experience/tests/views/test_course_updates.py index 6ca701f14677..f35e2a792a37 100644 --- a/openedx/features/course_experience/tests/views/test_course_updates.py +++ b/openedx/features/course_experience/tests/views/test_course_updates.py @@ -3,16 +3,17 @@ """ from datetime import datetime +from zoneinfo import ZoneInfo from django.urls import reverse -from zoneinfo import ZoneInfo from openedx.core.djangoapps.waffle_utils.testutils import WAFFLE_TABLES +from openedx.core.djangolib.testing.utils import AUTHZ_TABLES from openedx.features.content_type_gating.models import ContentTypeGatingConfig from openedx.features.course_experience.tests import BaseCourseUpdatesTestCase -from xmodule.modulestore.tests.factories import check_mongo_calls # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.factories import check_mongo_calls # pylint: disable=wrong-import-order -QUERY_COUNT_TABLE_IGNORELIST = WAFFLE_TABLES +QUERY_COUNT_TABLE_IGNORELIST = WAFFLE_TABLES + AUTHZ_TABLES def course_updates_url(course): @@ -49,7 +50,7 @@ def test_queries(self): # Fetch the view and verify that the query counts haven't changed # TODO: decrease query count as part of REVO-28 - with self.assertNumQueries(52, table_ignorelist=QUERY_COUNT_TABLE_IGNORELIST): + with self.assertNumQueries(54, table_ignorelist=QUERY_COUNT_TABLE_IGNORELIST): with check_mongo_calls(3): url = course_updates_url(self.course) self.client.get(url) diff --git a/openedx/features/course_experience/tests/views/test_masquerade.py b/openedx/features/course_experience/tests/views/test_masquerade.py index f0c110d8e9aa..b3230b796047 100644 --- a/openedx/features/course_experience/tests/views/test_masquerade.py +++ b/openedx/features/course_experience/tests/views/test_masquerade.py @@ -2,13 +2,17 @@ Tests for masquerading functionality on course_experience """ -from lms.djangoapps.courseware.tests.helpers import MasqueradeMixin from common.djangoapps.student.roles import CourseStaffRole from common.djangoapps.student.tests.factories import CourseEnrollmentFactory, UserFactory -from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.partitions.partitions import ENROLLMENT_TRACK_PARTITION_ID # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.partitions.partitions_service import PartitionService # lint-amnesty, pylint: disable=wrong-import-order +from lms.djangoapps.courseware.tests.helpers import MasqueradeMixin +from xmodule.modulestore.tests.django_utils import ( + SharedModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order +from xmodule.partitions.partitions import ( + ENROLLMENT_TRACK_PARTITION_ID, # pylint: disable=wrong-import-order +) +from xmodule.partitions.partitions_service import PartitionService # pylint: disable=wrong-import-order from .helpers import add_course_mode diff --git a/openedx/features/course_experience/url_helpers.py b/openedx/features/course_experience/url_helpers.py index e70019dbe25b..23c616a5269e 100644 --- a/openedx/features/course_experience/url_helpers.py +++ b/openedx/features/course_experience/url_helpers.py @@ -5,26 +5,25 @@ because the Studio course outline may need these utilities. """ from typing import Optional +from urllib.parse import urlparse from django.conf import settings from django.contrib.auth import get_user_model from django.http import HttpRequest from django.http.request import QueryDict from opaque_keys.edx.keys import CourseKey, UsageKey -from urllib.parse import urlparse - -from xmodule.modulestore import ModuleStoreEnum # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.search import path_to_location # lint-amnesty, pylint: disable=wrong-import-order from openedx.core.djangoapps.site_configuration import helpers as configuration_helpers +from xmodule.modulestore import ModuleStoreEnum # pylint: disable=wrong-import-order +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order +from xmodule.modulestore.search import path_to_location # pylint: disable=wrong-import-order User = get_user_model() def get_courseware_url( usage_key: UsageKey, - request: Optional[HttpRequest] = None, + request: Optional[HttpRequest] = None, # noqa: UP045 is_staff: bool = False, ) -> str: """ @@ -47,7 +46,7 @@ def get_courseware_url( def _get_new_courseware_url( usage_key: UsageKey, - request: Optional[HttpRequest] = None, + request: Optional[HttpRequest] = None, # noqa: UP045 is_staff: bool = None, ) -> str: """ @@ -92,9 +91,9 @@ def _get_new_courseware_url( def make_learning_mfe_courseware_url( course_key: CourseKey, - sequence_key: Optional[UsageKey] = None, - unit_key: Optional[UsageKey] = None, - params: Optional[QueryDict] = None, + sequence_key: Optional[UsageKey] = None, # noqa: UP045 + unit_key: Optional[UsageKey] = None, # noqa: UP045 + params: Optional[QueryDict] = None, # noqa: UP045 preview: bool = None, ) -> str: """ @@ -156,8 +155,8 @@ def make_learning_mfe_courseware_url( def get_learning_mfe_home_url( course_key: CourseKey, - url_fragment: Optional[str] = None, - params: Optional[QueryDict] = None, + url_fragment: Optional[str] = None, # noqa: UP045 + params: Optional[QueryDict] = None, # noqa: UP045 ) -> str: """ Given a course run key and view name, return the appropriate course home (MFE) URL. diff --git a/openedx/features/course_experience/urls.py b/openedx/features/course_experience/urls.py index ac560d43f9f1..8edb0f75ffdf 100644 --- a/openedx/features/course_experience/urls.py +++ b/openedx/features/course_experience/urls.py @@ -3,6 +3,7 @@ """ from django.urls import path + from .views.course_home import outline_tab from .views.course_updates import CourseUpdatesView diff --git a/openedx/features/course_experience/utils.py b/openedx/features/course_experience/utils.py index c20b7f077136..f4d181f70047 100644 --- a/openedx/features/course_experience/utils.py +++ b/openedx/features/course_experience/utils.py @@ -5,17 +5,17 @@ from django.utils import timezone from opaque_keys.edx.keys import CourseKey +from common.djangoapps.student.models import CourseEnrollment from lms.djangoapps.course_api.blocks.api import get_blocks from lms.djangoapps.course_blocks.api import get_course_blocks from openedx.core.djangoapps.content.course_overviews.models import CourseOverview from openedx.core.lib.cache_utils import request_cached from openedx.features.course_experience import RELATIVE_DATES_DISABLE_RESET_FLAG, RELATIVE_DATES_FLAG -from common.djangoapps.student.models import CourseEnrollment -from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.django import modulestore # pylint: disable=wrong-import-order @request_cached() -def get_course_outline_block_tree(request, course_id, user=None, allow_start_dates_in_future=False): # lint-amnesty, pylint: disable=too-many-statements +def get_course_outline_block_tree(request, course_id, user=None, allow_start_dates_in_future=False): # pylint: disable=too-many-statements """ Returns the root block of the course outline, with children as blocks. diff --git a/openedx/features/course_experience/views/course_dates.py b/openedx/features/course_experience/views/course_dates.py index e9f1a8d574b6..82d2a4b2ab1d 100644 --- a/openedx/features/course_experience/views/course_dates.py +++ b/openedx/features/course_experience/views/course_dates.py @@ -9,8 +9,8 @@ from lms.djangoapps.courseware.courses import get_course_date_blocks, get_course_with_access from lms.djangoapps.courseware.tabs import DatesTab -from openedx.features.course_experience.url_helpers import get_learning_mfe_home_url from openedx.core.djangoapps.plugin_api.views import EdxFragmentView +from openedx.features.course_experience.url_helpers import get_learning_mfe_home_url class CourseDatesFragmentView(EdxFragmentView): @@ -19,7 +19,7 @@ class CourseDatesFragmentView(EdxFragmentView): """ template_name = 'course_experience/course-dates-fragment.html' - def render_to_fragment(self, request, course_id=None, **kwargs): # lint-amnesty, pylint: disable=arguments-differ + def render_to_fragment(self, request, course_id=None, **kwargs): # pylint: disable=arguments-differ """ Render the course dates fragment. """ diff --git a/openedx/features/course_experience/views/course_updates.py b/openedx/features/course_experience/views/course_updates.py index 6789172f3606..43d486513f0c 100644 --- a/openedx/features/course_experience/views/course_updates.py +++ b/openedx/features/course_experience/views/course_updates.py @@ -23,13 +23,13 @@ class CourseUpdatesView(CourseTabView): """ @method_decorator(login_required) @method_decorator(cache_control(no_cache=True, no_store=True, must_revalidate=True)) - def get(self, request, course_id, **kwargs): # lint-amnesty, pylint: disable=arguments-differ + def get(self, request, course_id, **kwargs): # pylint: disable=arguments-differ """ Displays the home page for the specified course. """ return super().get(request, course_id, 'courseware', **kwargs) - def render_to_fragment(self, request, course=None, tab=None, **kwargs): # lint-amnesty, pylint: disable=arguments-differ, unused-argument + def render_to_fragment(self, request, course=None, tab=None, **kwargs): # pylint: disable=arguments-differ, unused-argument course_id = str(course.id) updates_fragment_view = CourseUpdatesFragmentView() return updates_fragment_view.render_to_fragment(request, course_id=course_id, **kwargs) @@ -40,7 +40,7 @@ class CourseUpdatesFragmentView(EdxFragmentView): A fragment to render the updates page for a course. """ - def render_to_fragment(self, request, course_id=None, **kwargs): # lint-amnesty, pylint: disable=arguments-differ + def render_to_fragment(self, request, course_id=None, **kwargs): # pylint: disable=arguments-differ """ Renders the course's home page as a fragment. """ @@ -66,11 +66,11 @@ def render_to_fragment(self, request, course_id=None, **kwargs): # lint-amnesty return Fragment(html) @classmethod - def has_updates(self, request, course): # lint-amnesty, pylint: disable=bad-classmethod-argument + def has_updates(self, request, course): # pylint: disable=bad-classmethod-argument return len(get_ordered_updates(request, course)) > 0 @classmethod - def get_plain_html_updates(self, request, course): # lint-amnesty, pylint: disable=bad-classmethod-argument + def get_plain_html_updates(self, request, course): # pylint: disable=bad-classmethod-argument """ Returns any course updates in an html chunk. Used for older implementations and a few tests that store diff --git a/openedx/features/discounts/applicability.py b/openedx/features/discounts/applicability.py index c930ae2da878..89ddc1d59b71 100644 --- a/openedx/features/discounts/applicability.py +++ b/openedx/features/discounts/applicability.py @@ -10,8 +10,8 @@ from datetime import datetime, timedelta - from zoneinfo import ZoneInfo + from crum import get_current_request, impersonate from django.conf import settings from django.utils import timezone @@ -20,14 +20,13 @@ from common.djangoapps.course_modes.models import CourseMode from common.djangoapps.entitlements.models import CourseEntitlement -from lms.djangoapps.courseware.utils import is_mode_upsellable +from common.djangoapps.student.models import CourseEnrollment +from common.djangoapps.track import segment from lms.djangoapps.courseware.toggles import COURSEWARE_MFE_MILESTONES_STREAK_DISCOUNT +from lms.djangoapps.courseware.utils import is_mode_upsellable from lms.djangoapps.experiments.models import ExperimentData from lms.djangoapps.experiments.stable_bucketing import stable_bucketing_hash_group from openedx.features.discounts.models import DiscountPercentageConfig, DiscountRestrictionConfig -from common.djangoapps.student.models import CourseEnrollment -from common.djangoapps.track import segment - # .. toggle_name: discounts.enable_first_purchase_discount_override # .. toggle_implementation: WaffleFlag @@ -127,6 +126,7 @@ def can_show_streak_discount_coupon(user, course): # We can't import this at Django load time within the openedx tests settings context from openedx.features.enterprise_support.utils import is_enterprise_learner + # Don't give discount to enterprise users if is_enterprise_learner(user): return False @@ -181,6 +181,7 @@ def can_receive_discount(user, course, discount_expiration_date=None): # We can't import this at Django load time within the openedx tests settings context from openedx.features.enterprise_support.utils import is_enterprise_learner + # Don't give discount to enterprise users if is_enterprise_learner(user): return False diff --git a/openedx/features/discounts/migrations/0002_auto_20191022_1720.py b/openedx/features/discounts/migrations/0002_auto_20191022_1720.py index 022a9e635f1a..7b432ca9dfe7 100644 --- a/openedx/features/discounts/migrations/0002_auto_20191022_1720.py +++ b/openedx/features/discounts/migrations/0002_auto_20191022_1720.py @@ -1,9 +1,10 @@ # Generated by Django 1.11.25 on 2019-10-22 17:20 +import django.db.models.deletion from django.conf import settings from django.db import migrations, models -import django.db.models.deletion + import openedx.core.djangoapps.config_model_utils.models diff --git a/openedx/features/discounts/models.py b/openedx/features/discounts/models.py index 8c7c5ff53ea0..5e6d7f8645a5 100644 --- a/openedx/features/discounts/models.py +++ b/openedx/features/discounts/models.py @@ -6,7 +6,6 @@ from django.db import models - from django.utils.translation import gettext_lazy as _ from openedx.core.djangoapps.config_model_utils.models import StackedConfigurationModel @@ -37,7 +36,7 @@ def disabled_for_course_stacked_config(cls, course): return current_config.disabled def __str__(self): - return "DiscountRestrictionConfig(disabled={!r})".format( + return "DiscountRestrictionConfig(disabled={!r})".format( # noqa: UP032 self.disabled ) @@ -52,7 +51,7 @@ class DiscountPercentageConfig(StackedConfigurationModel): percentage = models.PositiveIntegerField() def __str__(self): - return "DiscountPercentageConfig(enabled={!r},percentage={!r})".format( + return "DiscountPercentageConfig(enabled={!r},percentage={!r})".format( # noqa: UP032 self.enabled, self.percentage ) diff --git a/openedx/features/discounts/tests/test_applicability.py b/openedx/features/discounts/tests/test_applicability.py index 472120b38705..3256bc543ec4 100644 --- a/openedx/features/discounts/tests/test_applicability.py +++ b/openedx/features/discounts/tests/test_applicability.py @@ -3,10 +3,10 @@ from datetime import datetime, timedelta from unittest.mock import Mock, patch +from zoneinfo import ZoneInfo import ddt import pytest -from zoneinfo import ZoneInfo from django.contrib.sites.models import Site from django.utils.timezone import now from edx_toggles.toggles.testutils import override_waffle_flag @@ -20,8 +20,10 @@ from openedx.core.djangoapps.content.course_overviews.models import CourseOverview from openedx.features.discounts.models import DiscountRestrictionConfig from openedx.features.discounts.utils import REV1008_EXPERIMENT_ID -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + ModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order from ..applicability import DISCOUNT_APPLICABILITY_FLAG, _is_in_holdback_and_bucket, can_receive_discount @@ -78,8 +80,8 @@ def test_can_receive_discount_course_requirements(self): assert applicability is False disabled_course = CourseFactory() - CourseModeFactory.create(course_id=disabled_course.id, mode_slug='verified') # lint-amnesty, pylint: disable=no-member - disabled_course_overview = CourseOverview.get_from_id(disabled_course.id) # lint-amnesty, pylint: disable=no-member + CourseModeFactory.create(course_id=disabled_course.id, mode_slug='verified') # pylint: disable=no-member + disabled_course_overview = CourseOverview.get_from_id(disabled_course.id) # pylint: disable=no-member DiscountRestrictionConfig.objects.create(disabled=True, course=disabled_course_overview) applicability = can_receive_discount(user=self.user, course=disabled_course) assert applicability is False diff --git a/openedx/features/discounts/tests/test_discount_restriction_models.py b/openedx/features/discounts/tests/test_discount_restriction_models.py index 38815a660f70..92c434959536 100644 --- a/openedx/features/discounts/tests/test_discount_restriction_models.py +++ b/openedx/features/discounts/tests/test_discount_restriction_models.py @@ -7,11 +7,11 @@ import ddt +from common.djangoapps.student.tests.factories import UserFactory from openedx.core.djangoapps.content.course_overviews.tests.factories import CourseOverviewFactory from openedx.core.djangoapps.site_configuration.tests.factories import SiteConfigurationFactory from openedx.core.djangolib.testing.utils import CacheIsolationTestCase from openedx.features.discounts.models import DiscountRestrictionConfig -from common.djangoapps.student.tests.factories import UserFactory @ddt.ddt diff --git a/openedx/features/discounts/tests/test_utils.py b/openedx/features/discounts/tests/test_utils.py index 6bd9d1cd1593..66f61f0652e9 100644 --- a/openedx/features/discounts/tests/test_utils.py +++ b/openedx/features/discounts/tests/test_utils.py @@ -1,7 +1,7 @@ """ Tests of the openedx.features.discounts.utils module. """ -from unittest.mock import patch, Mock +from unittest.mock import Mock, patch import ddt from django.contrib.auth.models import AnonymousUser @@ -17,7 +17,7 @@ from openedx.features.discounts.applicability import ( DISCOUNT_APPLICABILITY_FLAG, FIRST_PURCHASE_DISCOUNT_OVERRIDE_FLAG, - get_discount_expiration_date + get_discount_expiration_date, ) from .. import utils @@ -50,7 +50,7 @@ def test_eligible_eligible(self, discount_percentage, base_price, formatted_base ): content, has_discount = utils.format_strikeout_price(Mock(name='user'), Mock(name='course')) - assert str(content) == ( + assert str(content) == ( # noqa: UP032 "" "Original price: {original_price}, discount price: " "" @@ -100,5 +100,5 @@ def test_anonymous(self): assert utils.generate_offer_data(AnonymousUser(), self.overview) is None @patch('openedx.features.discounts.utils.can_receive_discount', return_value=False) - def test_no_discount(self, _mock): + def test_no_discount(self, _mock): # noqa: PT019 assert utils.generate_offer_data(self.user, self.overview) is None diff --git a/openedx/features/discounts/tests/test_views.py b/openedx/features/discounts/tests/test_views.py index 0ab286535863..583107884075 100644 --- a/openedx/features/discounts/tests/test_views.py +++ b/openedx/features/discounts/tests/test_views.py @@ -6,8 +6,10 @@ from django.urls import reverse from common.djangoapps.student.tests.factories import TEST_PASSWORD, UserFactory -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + ModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order class TestCourseUserDiscount(ModuleStoreTestCase): diff --git a/openedx/features/discounts/utils.py b/openedx/features/discounts/utils.py index 00b60f6cadfd..2c7f4d7f552a 100644 --- a/openedx/features/discounts/utils.py +++ b/openedx/features/discounts/utils.py @@ -3,23 +3,23 @@ """ from datetime import datetime - from zoneinfo import ZoneInfo + from django.conf import settings from django.utils.translation import get_language from django.utils.translation import gettext as _ from edx_django_utils.plugins import pluggable_override from common.djangoapps.course_modes.models import format_course_price, get_course_prices -from lms.djangoapps.experiments.models import ExperimentData from lms.djangoapps.courseware.utils import verified_upgrade_deadline_link +from lms.djangoapps.experiments.models import ExperimentData from openedx.core.djangolib.markup import HTML from openedx.features.discounts.applicability import ( FIRST_PURCHASE_DISCOUNT_OVERRIDE_FLAG, REV1008_EXPERIMENT_ID, can_receive_discount, discount_percentage, - get_discount_expiration_date + get_discount_expiration_date, ) diff --git a/openedx/features/discounts/views.py b/openedx/features/discounts/views.py index c91c5cb06f10..d158201b19c2 100644 --- a/openedx/features/discounts/views.py +++ b/openedx/features/discounts/views.py @@ -7,7 +7,7 @@ import logging -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.utils.decorators import method_decorator from edx_rest_framework_extensions.auth.jwt.authentication import JwtAuthentication from edx_rest_framework_extensions.auth.session.authentication import SessionAuthenticationAllowInactiveUser @@ -24,7 +24,7 @@ from openedx.core.lib.api.permissions import ApiKeyHeaderPermissionIsAuthenticated from openedx.core.lib.api.view_utils import DeveloperErrorViewMixin -from .applicability import can_receive_discount, discount_percentage, REV1008_EXPERIMENT_ID +from .applicability import REV1008_EXPERIMENT_ID, can_receive_discount, discount_percentage log = logging.getLogger(__name__) diff --git a/openedx/features/effort_estimation/api.py b/openedx/features/effort_estimation/api.py index c02d7e009a6b..bc286ad19e93 100644 --- a/openedx/features/effort_estimation/api.py +++ b/openedx/features/effort_estimation/api.py @@ -4,4 +4,4 @@ # pylint: disable=unused-import -from .block_transformers import EffortEstimationTransformer +from .block_transformers import EffortEstimationTransformer # noqa: F401 diff --git a/openedx/features/effort_estimation/block_transformers.py b/openedx/features/effort_estimation/block_transformers.py index d315aefd065c..c3e6bce1f80e 100644 --- a/openedx/features/effort_estimation/block_transformers.py +++ b/openedx/features/effort_estimation/block_transformers.py @@ -53,7 +53,10 @@ class MissingEstimationData(Exception): @classmethod def name(cls): - """Unique identifier for the transformer's class; same identifier used in setup.py.""" + """ + Unique identifier for the transformer's class. + This must match the entry point name in the package configuration. + """ return 'effort_estimation' @classmethod diff --git a/openedx/features/effort_estimation/tests/test_block_transformers.py b/openedx/features/effort_estimation/tests/test_block_transformers.py index ae70eff26126..3af3d29d1739 100644 --- a/openedx/features/effort_estimation/tests/test_block_transformers.py +++ b/openedx/features/effort_estimation/tests/test_block_transformers.py @@ -8,14 +8,15 @@ from edxval.api import create_video, remove_video_for_course from openedx.core.djangoapps.content.block_structure.factory import BlockStructureFactory -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import SampleCourseFactory # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.sample_courses import BlockInfo # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + ModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import SampleCourseFactory # pylint: disable=wrong-import-order +from xmodule.modulestore.tests.sample_courses import BlockInfo # pylint: disable=wrong-import-order from ..block_transformers import EffortEstimationTransformer from ..toggles import EFFORT_ESTIMATION_DISABLED_FLAG - # Copied here, rather than used directly from class, just to catch any accidental changes DISABLE_ESTIMATION = 'disable_estimation' EFFORT_ACTIVITIES = 'effort_activities' diff --git a/openedx/features/effort_estimation/toggles.py b/openedx/features/effort_estimation/toggles.py index ad83c1fef239..184ed78479b4 100644 --- a/openedx/features/effort_estimation/toggles.py +++ b/openedx/features/effort_estimation/toggles.py @@ -4,7 +4,6 @@ from openedx.core.djangoapps.waffle_utils import CourseWaffleFlag - WAFFLE_FLAG_NAMESPACE = 'effort_estimation' # .. toggle_name: effort_estimation.disabled diff --git a/openedx/features/enterprise_support/admin/forms.py b/openedx/features/enterprise_support/admin/forms.py index bf193efc66d0..e1788e0f2383 100644 --- a/openedx/features/enterprise_support/admin/forms.py +++ b/openedx/features/enterprise_support/admin/forms.py @@ -7,7 +7,7 @@ from enterprise.admin.utils import validate_csv -class CSVImportForm(forms.Form): # lint-amnesty, pylint: disable=missing-class-docstring +class CSVImportForm(forms.Form): # pylint: disable=missing-class-docstring csv_file = forms.FileField( required=True, label=_('CSV File'), diff --git a/openedx/features/enterprise_support/admin/views.py b/openedx/features/enterprise_support/admin/views.py index 37fedcc69b88..f377f7c668ce 100644 --- a/openedx/features/enterprise_support/admin/views.py +++ b/openedx/features/enterprise_support/admin/views.py @@ -8,8 +8,8 @@ from django.views.generic.edit import FormView from enterprise.models import EnterpriseCourseEnrollment -from openedx.features.enterprise_support.admin.forms import CSVImportForm from common.djangoapps.student.models import CourseEnrollment, CourseEnrollmentAttribute +from openedx.features.enterprise_support.admin.forms import CSVImportForm class EnrollmentAttributeOverrideView(FormView): diff --git a/openedx/features/enterprise_support/api.py b/openedx/features/enterprise_support/api.py index 32c493d1e35e..fe9519acf026 100644 --- a/openedx/features/enterprise_support/api.py +++ b/openedx/features/enterprise_support/api.py @@ -9,8 +9,9 @@ import requests from crum import get_current_request +from django.apps import apps as django_apps from django.conf import settings -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.contrib.sites.models import Site from django.core.cache import cache from django.shortcuts import redirect @@ -33,14 +34,12 @@ from consent.models import DataSharingConsent, DataSharingConsentTextOverrides from enterprise.api.v1.serializers import ( EnterpriseCustomerUserReadOnlySerializer, - EnterpriseCustomerUserWriteSerializer + EnterpriseCustomerUserWriteSerializer, ) from enterprise.models import ( EnterpriseCourseEnrollment, EnterpriseCustomer, - EnterpriseCustomerIdentityProvider, EnterpriseCustomerUser, - PendingEnterpriseCustomerUser ) except ImportError: # pragma: no cover pass @@ -184,7 +183,7 @@ def post_enterprise_course_enrollment(self, username, course_id): response = self.client.post(api_url, data=data) response.raise_for_status() except HTTPError: - message = ( + message = ( # noqa: UP032 "An error occured while posting EnterpriseCourseEnrollment for user {username} and " "course run {course_id}." ).format( @@ -192,7 +191,7 @@ def post_enterprise_course_enrollment(self, username, course_id): course_id=course_id, ) LOGGER.exception(message) - raise EnterpriseApiException(message) # lint-amnesty, pylint: disable=raise-missing-from + raise EnterpriseApiException(message) # pylint: disable=raise-missing-from # noqa: B904 def fetch_enterprise_learner_data(self, user): """ @@ -373,7 +372,7 @@ def enterprise_enabled(): """ Determines whether the Enterprise app is installed """ - return 'enterprise' in settings.INSTALLED_APPS and settings.FEATURES.get('ENABLE_ENTERPRISE_INTEGRATION', False) + return django_apps.is_installed('enterprise') and settings.FEATURES.get('ENABLE_ENTERPRISE_INTEGRATION', False) def enterprise_is_enabled(otherwise=None): @@ -604,7 +603,7 @@ def consent_needed_for_course(request, user, course_id, enrollment_exists=False) data sharing permissions before accessing a course. """ LOGGER.info( - "[ENTERPRISE DSC] Determining if user [{username}] must consent to data sharing for course" + "[ENTERPRISE DSC] Determining if user [{username}] must consent to data sharing for course" # noqa: UP032 " [{course_id}]".format( username=user.username, course_id=course_id @@ -615,7 +614,7 @@ def consent_needed_for_course(request, user, course_id, enrollment_exists=False) if not active_enterprise_learner_info: # user is not linked to any enterprise so return False LOGGER.info( - "[ENTERPRISE DSC] Consent from user [{username}] is not needed for course [{course_id}]." + "[ENTERPRISE DSC] Consent from user [{username}] is not needed for course [{course_id}]." # noqa: UP032 " The user is not linked to an enterprise.".format( username=user.username, course_id=course_id @@ -630,7 +629,7 @@ def consent_needed_for_course(request, user, course_id, enrollment_exists=False) data_sharing_consent_needed_cache = TieredCache.get_cached_response(consent_cache_key) if data_sharing_consent_needed_cache.is_found and data_sharing_consent_needed_cache.value == 0: LOGGER.info( - "[ENTERPRISE DSC] Consent from user [{username}] is not needed for course [{course_id}]. " + "[ENTERPRISE DSC] Consent from user [{username}] is not needed for course [{course_id}]. " # noqa: UP032 "The DSC cache was checked and the value was 0.".format( username=user.username, course_id=course_id @@ -673,7 +672,7 @@ def consent_needed_for_course(request, user, course_id, enrollment_exists=False) enterprise_and_learner_have_same_domain = enterprise_domain == request.site if not enterprise_and_learner_have_same_domain: LOGGER.info( - '[ENTERPRISE DSC] Site mismatch. USER: [{username}], RequestSite: [{request_site}], ' + '[ENTERPRISE DSC] Site mismatch. USER: [{username}], RequestSite: [{request_site}], ' # noqa: UP032 'LearnerEnterpriseDomain: [{enterprise_domain}]'.format( username=user.username, request_site=request.site, @@ -693,7 +692,7 @@ def consent_needed_for_course(request, user, course_id, enrollment_exists=False) ) if not consent_required: LOGGER.info( - "[ENTERPRISE DSC] Consent from user [{username}] is not needed for course [{course_id}]. The user's current" + "[ENTERPRISE DSC] Consent from user [{username}] is not needed for course [{course_id}]. The user's current" # noqa: UP032 # pylint: disable=line-too-long " enterprise does not require data sharing consent.".format( username=user.username, course_id=course_id @@ -703,7 +702,7 @@ def consent_needed_for_course(request, user, course_id, enrollment_exists=False) return False LOGGER.info( - "[ENTERPRISE DSC] Consent from user [{username}] is needed for course [{course_id}]. The user's " + "[ENTERPRISE DSC] Consent from user [{username}] is needed for course [{course_id}]. The user's " # noqa: UP032 "current enterprise requires data sharing consent, and it has not been given.".format( username=user.username, course_id=course_id @@ -712,29 +711,6 @@ def consent_needed_for_course(request, user, course_id, enrollment_exists=False) return True -@enterprise_is_enabled(otherwise=set()) -def get_consent_required_courses(user, course_ids): - """ - Returns a set of course_ids that require consent - Note that this function makes use of the Enterprise models directly instead of using the API calls - """ - result = set() - enterprise_learner = EnterpriseCustomerUser.objects.filter(user_id=user.id).first() - if not enterprise_learner or not enterprise_learner.enterprise_customer: - return result - - enterprise_uuid = enterprise_learner.enterprise_customer.uuid - data_sharing_consent = DataSharingConsent.objects.filter(username=user.username, - course_id__in=course_ids, - enterprise_customer__uuid=enterprise_uuid) - - for consent in data_sharing_consent: - if consent.consent_required(): - result.add(consent.course_id) - - return result - - @enterprise_is_enabled(otherwise='') def get_enterprise_consent_url(request, course_id, user=None, return_to=None, enrollment_exists=False, source='lms'): """ @@ -751,7 +727,7 @@ def get_enterprise_consent_url(request, course_id, user=None, return_to=None, en user = user or request.user LOGGER.info( - 'Getting enterprise consent url for user [{username}] and course [{course_id}].'.format( + 'Getting enterprise consent url for user [{username}] and course [{course_id}].'.format( # noqa: UP032 username=user.username, course_id=course_id ) @@ -817,7 +793,7 @@ def get_active_enterprise_customer_user(user): enterprise_customer_user = EnterpriseCustomerUser.objects.get(user_id=user.id, active=True) except EnterpriseCustomerUser.DoesNotExist: LOGGER.info( - "Active EnterpriseCustomerUser for user [{username}] does not exist".format(username=user.username) + "Active EnterpriseCustomerUser for user [{username}] does not exist".format(username=user.username) # noqa: UP032 # pylint: disable=line-too-long ) return None return EnterpriseCustomerUserReadOnlySerializer(instance=enterprise_customer_user).data @@ -1025,50 +1001,3 @@ def get_dashboard_consent_notification(request, user, course_enrollments): } ) return '' - - -@enterprise_is_enabled() -def insert_enterprise_pipeline_elements(pipeline): - """ - If the enterprise app is enabled, insert additional elements into the - pipeline related to enterprise. - """ - additional_elements = ( - 'enterprise.tpa_pipeline.handle_enterprise_logistration', - ) - - insert_point = pipeline.index('social_core.pipeline.social_auth.load_extra_data') - for index, element in enumerate(additional_elements): - pipeline.insert(insert_point + index, element) - - -@enterprise_is_enabled() -def unlink_enterprise_user_from_idp(request, user, idp_backend_name): - """ - Un-links learner from their enterprise identity provider - Args: - request (wsgi request): request object - user (User): user who initiated disconnect request - idp_backend_name (str): Name of identity provider's backend - - Returns: None - - """ - enterprise_customer = enterprise_customer_for_request(request) - if user and enterprise_customer: - enabled_providers = Registry.get_enabled_by_backend_name(idp_backend_name) - provider_ids = [enabled_provider.provider_id for enabled_provider in enabled_providers] - enterprise_customer_idps = EnterpriseCustomerIdentityProvider.objects.filter( - enterprise_customer__uuid=enterprise_customer['uuid'], - provider_id__in=provider_ids - ) - - if enterprise_customer_idps: - try: - # Unlink user email from each Enterprise Customer. - for enterprise_customer_idp in enterprise_customer_idps: - EnterpriseCustomerUser.objects.unlink_user( - enterprise_customer=enterprise_customer_idp.enterprise_customer, user_email=user.email - ) - except (EnterpriseCustomerUser.DoesNotExist, PendingEnterpriseCustomerUser.DoesNotExist): - pass diff --git a/openedx/features/enterprise_support/apps.py b/openedx/features/enterprise_support/apps.py index af8ee2539b60..e664beff53c5 100644 --- a/openedx/features/enterprise_support/apps.py +++ b/openedx/features/enterprise_support/apps.py @@ -14,4 +14,4 @@ class EnterpriseSupportConfig(AppConfig): def ready(self): # Import signals to activate signal handler for enterprise. - from . import signals # pylint: disable=unused-import + from . import signals # pylint: disable=unused-import # noqa: F401 diff --git a/openedx/features/enterprise_support/enrollments/exceptions.py b/openedx/features/enterprise_support/enrollments/exceptions.py index 0364bd1f26d4..58d9a1484f50 100644 --- a/openedx/features/enterprise_support/enrollments/exceptions.py +++ b/openedx/features/enterprise_support/enrollments/exceptions.py @@ -1,4 +1,4 @@ -# lint-amnesty, pylint: disable=missing-module-docstring +# pylint: disable=missing-module-docstring class CourseIdMissingException(Exception): """ diff --git a/openedx/features/enterprise_support/enrollments/tests/test_utils.py b/openedx/features/enterprise_support/enrollments/tests/test_utils.py index f9233c3724c8..632bd42a1cbd 100644 --- a/openedx/features/enterprise_support/enrollments/tests/test_utils.py +++ b/openedx/features/enterprise_support/enrollments/tests/test_utils.py @@ -8,14 +8,11 @@ from opaque_keys.edx.keys import CourseKey from openedx.core.djangoapps.course_groups.cohorts import CourseUserGroup -from openedx.core.djangoapps.enrollments.errors import ( - CourseEnrollmentError, - CourseEnrollmentExistsError, -) +from openedx.core.djangoapps.enrollments.errors import CourseEnrollmentError, CourseEnrollmentExistsError from openedx.core.djangolib.testing.utils import skip_unless_lms from openedx.features.enterprise_support.enrollments.exceptions import ( CourseIdMissingException, - UserDoesNotExistException + UserDoesNotExistException, ) from openedx.features.enterprise_support.enrollments.utils import lms_update_or_create_enrollment @@ -40,13 +37,13 @@ def setUp(self): self.a_user.username = USERNAME def test_validation_of_inputs_course_id(self): - with self.assertRaises(CourseIdMissingException): + with self.assertRaises(CourseIdMissingException): # noqa: PT027 lms_update_or_create_enrollment( USERNAME, None, COURSE_MODE, is_active=True, enterprise_uuid=ENTERPRISE_UUID ) def test_validation_of_inputs_user_not_provided(self): - with self.assertRaises(UserDoesNotExistException): + with self.assertRaises(UserDoesNotExistException): # noqa: PT027 lms_update_or_create_enrollment( None, COURSE_ID, COURSE_MODE, is_active=True, enterprise_uuid=ENTERPRISE_UUID ) @@ -60,7 +57,7 @@ def test_validation_of_inputs_user_not_found( ): mock_tx.return_value.atomic.side_effect = None mock_user_model.side_effect = ObjectDoesNotExist() - with self.assertRaises(UserDoesNotExistException): + with self.assertRaises(UserDoesNotExistException): # noqa: PT027 lms_update_or_create_enrollment( USERNAME, COURSE_ID, COURSE_MODE, is_active=True, enterprise_uuid=ENTERPRISE_UUID ) @@ -81,7 +78,7 @@ def test_course_enrollment_error_raises( mock_user_model.return_value = self.a_user mock_get_enrollment_api.return_value = None - with self.assertRaises(CourseEnrollmentError): + with self.assertRaises(CourseEnrollmentError): # noqa: PT027 lms_update_or_create_enrollment( USERNAME, COURSE_ID, COURSE_MODE, is_active=True, enterprise_uuid=ENTERPRISE_UUID ) @@ -103,7 +100,7 @@ def test_course_group_error_raises( mock_user_model.return_value = self.a_user mock_get_enrollment_api.return_value = None - with self.assertRaises(CourseUserGroup.DoesNotExist): + with self.assertRaises(CourseUserGroup.DoesNotExist): # noqa: PT027 lms_update_or_create_enrollment( USERNAME, COURSE_ID, COURSE_MODE, is_active=True, enterprise_uuid=ENTERPRISE_UUID ) diff --git a/openedx/features/enterprise_support/enrollments/utils.py b/openedx/features/enterprise_support/enrollments/utils.py index e0d5f65aedde..92193358967a 100644 --- a/openedx/features/enterprise_support/enrollments/utils.py +++ b/openedx/features/enterprise_support/enrollments/utils.py @@ -3,7 +3,7 @@ """ import logging -from django.core.exceptions import ObjectDoesNotExist # lint-amnesty, pylint: disable=wrong-import-order +from django.core.exceptions import ObjectDoesNotExist # pylint: disable=wrong-import-order from django.db import transaction from common.djangoapps.student.models import User @@ -16,7 +16,7 @@ from openedx.core.lib.log_utils import audit_log from openedx.features.enterprise_support.enrollments.exceptions import ( CourseIdMissingException, - UserDoesNotExistException + UserDoesNotExistException, ) log = logging.getLogger(__name__) diff --git a/openedx/features/enterprise_support/serializers.py b/openedx/features/enterprise_support/serializers.py index 54171de513fa..030d4160c098 100644 --- a/openedx/features/enterprise_support/serializers.py +++ b/openedx/features/enterprise_support/serializers.py @@ -6,8 +6,9 @@ from rest_framework import serializers try: - from enterprise.api.v1.serializers import \ - EnterpriseCourseEnrollmentReadOnlySerializer as BaseEnterpriseCourseEnrollmentSerializer + from enterprise.api.v1.serializers import ( + EnterpriseCourseEnrollmentReadOnlySerializer as BaseEnterpriseCourseEnrollmentSerializer, + ) from enterprise.models import EnterpriseCourseEnrollment except ImportError: # pragma: no cover pass diff --git a/openedx/features/enterprise_support/signals.py b/openedx/features/enterprise_support/signals.py index c8122e2102ca..7fbb366ba7e0 100644 --- a/openedx/features/enterprise_support/signals.py +++ b/openedx/features/enterprise_support/signals.py @@ -6,13 +6,13 @@ import logging from django.conf import settings -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.db.models.signals import post_save, pre_save from django.dispatch import receiver from enterprise.models import EnterpriseCourseEnrollment, EnterpriseCustomer from integrated_channels.integrated_channel.tasks import ( transmit_single_learner_data, - transmit_single_subsection_learner_data + transmit_single_subsection_learner_data, ) from slumber.exceptions import HttpClientError @@ -49,7 +49,7 @@ def update_dsc_cache_on_enterprise_customer_update(sender, instance, **kwargs): if new_value != old_value: kwargs = {'enterprise_customer_uuid': str(instance.uuid)} result = clear_enterprise_customer_data_consent_share_cache.apply_async(kwargs=kwargs) - log.info("DSC: Created {task_name}[{task_id}] with arguments {kwargs}".format( + log.info("DSC: Created {task_name}[{task_id}] with arguments {kwargs}".format( # noqa: UP032 task_name=clear_enterprise_customer_data_consent_share_cache.name, task_id=result.task_id, kwargs=kwargs, diff --git a/openedx/features/enterprise_support/tasks.py b/openedx/features/enterprise_support/tasks.py index c3fa4c054dbc..f41da3031076 100644 --- a/openedx/features/enterprise_support/tasks.py +++ b/openedx/features/enterprise_support/tasks.py @@ -7,8 +7,8 @@ from celery import shared_task from edx_django_utils.monitoring import set_code_owner_attribute - from enterprise.models import EnterpriseCourseEnrollment + from openedx.features.enterprise_support.utils import clear_data_consent_share_cache log = logging.getLogger('edx.celery.task') @@ -25,7 +25,7 @@ def clear_enterprise_customer_data_consent_share_cache(enterprise_customer_uuid) ) count = enterprise_course_enrollments.count() log.info( - 'Stated Clearing {count} data_sharing_consent_needed cache for enterprise customer {uuid}'.format( + 'Stated Clearing {count} data_sharing_consent_needed cache for enterprise customer {uuid}'.format( # noqa: UP032 # pylint: disable=line-too-long count=count, uuid=enterprise_customer_uuid, ) @@ -36,6 +36,6 @@ def clear_enterprise_customer_data_consent_share_cache(enterprise_customer_uuid) enrollment.course_id, enterprise_customer_uuid, ) - log.info('Ended Clearing data_sharing_consent_needed cache for enterprise customer {uuid}'.format( + log.info('Ended Clearing data_sharing_consent_needed cache for enterprise customer {uuid}'.format( # noqa: UP032 uuid=enterprise_customer_uuid, )) diff --git a/openedx/features/enterprise_support/tests/factories.py b/openedx/features/enterprise_support/tests/factories.py index a0244f2bcc8e..f0a2887ae998 100644 --- a/openedx/features/enterprise_support/tests/factories.py +++ b/openedx/features/enterprise_support/tests/factories.py @@ -6,8 +6,6 @@ from uuid import UUID import factory -from faker import Factory as FakerFactory - from enterprise.models import ( EnterpriseCourseEnrollment, EnterpriseCustomer, @@ -15,6 +13,8 @@ EnterpriseCustomerIdentityProvider, EnterpriseCustomerUser, ) +from faker import Factory as FakerFactory + from openedx.core.djangoapps.site_configuration.tests.factories import SiteFactory FAKER = FakerFactory.create() diff --git a/openedx/features/enterprise_support/tests/mixins/enterprise.py b/openedx/features/enterprise_support/tests/mixins/enterprise.py index 8b8f420dddfb..1ef7201ad7c0 100644 --- a/openedx/features/enterprise_support/tests/mixins/enterprise.py +++ b/openedx/features/enterprise_support/tests/mixins/enterprise.py @@ -1,10 +1,9 @@ -""" # lint-amnesty, pylint: disable=cyclic-import +""" # pylint: disable=cyclic-import Mixins for the EnterpriseApiClient. """ import json - from unittest import mock import httpretty @@ -12,6 +11,7 @@ from django.core.cache import cache from django.test import SimpleTestCase from django.urls import reverse + from openedx.features.enterprise_support.tests import FAKE_ENTERPRISE_CUSTOMER @@ -78,7 +78,7 @@ def mock_enterprise_course_enrollment_post_api_failure(self): # pylint: disable status=500 ) - def mock_consent_response( # lint-amnesty, pylint: disable=missing-function-docstring + def mock_consent_response( # pylint: disable=missing-function-docstring self, username, course_id, diff --git a/openedx/features/enterprise_support/tests/test_admin.py b/openedx/features/enterprise_support/tests/test_admin.py index b5495670d18e..be80dc022ee0 100644 --- a/openedx/features/enterprise_support/tests/test_admin.py +++ b/openedx/features/enterprise_support/tests/test_admin.py @@ -10,11 +10,13 @@ from django.test import Client from django.urls import reverse -from openedx.core.djangoapps.catalog.tests.factories import CourseRunFactory -from openedx.features.enterprise_support.admin.forms import CSVImportForm from common.djangoapps.student.models import CourseEnrollment, CourseEnrollmentAttribute from common.djangoapps.student.tests.factories import TEST_PASSWORD, AdminFactory, CourseEnrollmentFactory, UserFactory -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order +from openedx.core.djangoapps.catalog.tests.factories import CourseRunFactory +from openedx.features.enterprise_support.admin.forms import CSVImportForm +from xmodule.modulestore.tests.django_utils import ( + ModuleStoreTestCase, # pylint: disable=wrong-import-order +) class EnrollmentAttributeOverrideViewTest(ModuleStoreTestCase): @@ -36,7 +38,7 @@ def setUp(self): self.users.append(UserFactory()) self.course = CourseRunFactory() - self.course_id = self.course.get('key') # lint-amnesty, pylint: disable=no-member + self.course_id = self.course.get('key') # pylint: disable=no-member self.csv_data = [ [self.users[0].id, self.course_id, 'OP_4321'], [self.users[1].id, self.course_id, 'OP_8765'], diff --git a/openedx/features/enterprise_support/tests/test_api.py b/openedx/features/enterprise_support/tests/test_api.py index 40f2c834e6b0..d93a77ed9ae8 100644 --- a/openedx/features/enterprise_support/tests/test_api.py +++ b/openedx/features/enterprise_support/tests/test_api.py @@ -6,18 +6,17 @@ import ddt import httpretty import pytest -from testfixtures import LogCapture from consent.models import DataSharingConsent from django.conf import settings -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.core.cache import cache from django.http import HttpResponseRedirect from django.test.utils import override_settings from django.urls import reverse -from edx_django_utils.cache import get_cache_key, TieredCache -from enterprise.models import EnterpriseCustomerUser # lint-amnesty, pylint: disable=wrong-import-order +from edx_django_utils.cache import TieredCache, get_cache_key from requests.exceptions import HTTPError from six.moves.urllib.parse import parse_qs +from testfixtures import LogCapture from common.djangoapps.student.tests.factories import UserFactory from openedx.core.djangoapps.site_configuration.tests.factories import SiteFactory @@ -42,7 +41,6 @@ enterprise_enabled, get_active_enterprise_customer_user, get_consent_notification_data, - get_consent_required_courses, get_dashboard_consent_notification, get_data_sharing_consents, get_enterprise_consent_url, @@ -50,8 +48,6 @@ get_enterprise_learner_data_from_api, get_enterprise_learner_data_from_db, get_enterprise_learner_portal_enabled_message, - insert_enterprise_pipeline_elements, - unlink_enterprise_user_from_idp, ) from openedx.features.enterprise_support.tests import FEATURES_WITH_ENTERPRISE_ENABLED from openedx.features.enterprise_support.tests.factories import ( @@ -533,38 +529,6 @@ def test_consent_needed_for_course_when_consent_is_required( ) ) - @httpretty.activate - @mock.patch('enterprise.models.EnterpriseCustomer.catalog_contains_course') - def test_get_consent_required_courses(self, mock_catalog_contains_course): - mock_catalog_contains_course.return_value = True - user = UserFactory() - enterprise_customer_user = EnterpriseCustomerUserFactory(user_id=user.id) - - course_id = 'fake-course' - data_sharing_consent = DataSharingConsent( - course_id=course_id, - enterprise_customer=enterprise_customer_user.enterprise_customer, - username=user.username, - granted=False - ) - data_sharing_consent.save() - consent_required = get_consent_required_courses(user, [course_id]) - assert course_id in consent_required - - # now grant consent and call our method again - data_sharing_consent.granted = True - data_sharing_consent.save() - consent_required = get_consent_required_courses(user, [course_id]) - assert course_id not in consent_required - - def test_consent_not_required_for_non_enterprise_user(self): - user = UserFactory() - course_id = 'fake-course' - - consent_required_courses = get_consent_required_courses(user, [course_id]) - - assert set() == consent_required_courses - @mock.patch('openedx.features.enterprise_support.api.create_jwt_for_user') def test_fetch_enterprise_learner_data_unauthenticated(self, mock_jwt_builder): api_client = self._assert_api_client_with_user(EnterpriseApiClient, mock_jwt_builder) @@ -1075,21 +1039,6 @@ def test_utils_with_enterprise_disabled(self): the utilities to return the expected default values. """ assert not enterprise_enabled() - assert insert_enterprise_pipeline_elements(None) is None - - def test_utils_with_enterprise_enabled(self): - """ - Test that enabling enterprise integration (which is currently on by default) causes the - the utilities to return the expected values. - """ - assert enterprise_enabled() - pipeline = ['abc', 'social_core.pipeline.social_auth.load_extra_data', 'def'] - insert_enterprise_pipeline_elements(pipeline) - assert pipeline == \ - [ - 'abc', 'enterprise.tpa_pipeline.handle_enterprise_logistration', - 'social_core.pipeline.social_auth.load_extra_data', 'def' - ] @mock.patch('openedx.features.enterprise_support.api.get_enterprise_learner_data_from_db') def test_enterprise_customer_from_session_or_db_cache_miss_no_customer(self, mock_learner_data_from_db): @@ -1363,45 +1312,3 @@ def test_get_consent_notification_data(self, mock_override_model): assert mock_override.declined_notification_title == title_template assert mock_override.declined_notification_message == message_template - - @mock.patch('openedx.features.enterprise_support.api.Registry') - @mock.patch('openedx.features.enterprise_support.api.enterprise_customer_for_request') - def test_unlink_enterprise_user_from_idp(self, mock_customer_from_request, mock_registry): - customer_idp = EnterpriseCustomerIdentityProviderFactory.create( - provider_id='the-provider', - ) - customer = customer_idp.enterprise_customer - customer_user = EnterpriseCustomerUserFactory.create( # lint-amnesty, pylint: disable=unused-variable - enterprise_customer=customer, - user_id=self.user.id, - ) - mock_customer_from_request.return_value = { - 'uuid': customer.uuid, - } - mock_registry.get_enabled_by_backend_name.return_value = [ - mock.Mock(provider_id='the-provider') - ] - request = mock.Mock() - - unlink_enterprise_user_from_idp(request, self.user, idp_backend_name='the-backend-name') - - assert 0 == EnterpriseCustomerUser.objects.filter(user_id=self.user.id).count() - - @mock.patch('openedx.features.enterprise_support.api.Registry') - @mock.patch('openedx.features.enterprise_support.api.enterprise_customer_for_request') - def test_unlink_enterprise_user_from_idp_no_customer_user(self, mock_customer_from_request, mock_registry): - customer_idp = EnterpriseCustomerIdentityProviderFactory.create( - provider_id='the-provider', - ) - customer = customer_idp.enterprise_customer - mock_customer_from_request.return_value = { - 'uuid': customer.uuid, - } - mock_registry.get_enabled_by_backend_name.return_value = [ - mock.Mock(provider_id='the-provider') - ] - request = mock.Mock() - - unlink_enterprise_user_from_idp(request, self.user, idp_backend_name='the-backend-name') - - assert 0 == EnterpriseCustomerUser.objects.filter(user_id=self.user.id).count() diff --git a/openedx/features/enterprise_support/tests/test_context.py b/openedx/features/enterprise_support/tests/test_context.py index d775859b1b24..07f10a63017a 100644 --- a/openedx/features/enterprise_support/tests/test_context.py +++ b/openedx/features/enterprise_support/tests/test_context.py @@ -4,13 +4,13 @@ from django.conf import settings from django.test.utils import override_settings -from common.djangoapps.student.tests.factories import UserFactory, CourseEnrollmentFactory +from common.djangoapps.student.tests.factories import CourseEnrollmentFactory, UserFactory from openedx.core.djangolib.testing.utils import CacheIsolationTestCase, skip_unless_lms from openedx.features.enterprise_support.context import get_enterprise_event_context from openedx.features.enterprise_support.tests import FEATURES_WITH_ENTERPRISE_ENABLED from openedx.features.enterprise_support.tests.factories import ( + EnterpriseCourseEnrollmentFactory, EnterpriseCustomerUserFactory, - EnterpriseCourseEnrollmentFactory ) from openedx.features.enterprise_support.tests.mixins.enterprise import EnterpriseServiceMockMixin diff --git a/openedx/features/enterprise_support/tests/test_logout.py b/openedx/features/enterprise_support/tests/test_logout.py index cbec23397795..ee915fe8eb50 100644 --- a/openedx/features/enterprise_support/tests/test_logout.py +++ b/openedx/features/enterprise_support/tests/test_logout.py @@ -11,15 +11,15 @@ from common.djangoapps.student.tests.factories import UserFactory from common.djangoapps.util.testing import UrlResetMixin +from common.test.utils import assert_dict_contains_subset from openedx.core.djangolib.testing.utils import CacheIsolationTestCase, skip_unless_lms from openedx.features.enterprise_support.api import enterprise_enabled from openedx.features.enterprise_support.tests import ( FAKE_ENTERPRISE_CUSTOMER, FEATURES_WITH_ENTERPRISE_ENABLED, - factories + factories, ) from openedx.features.enterprise_support.tests.mixins.enterprise import EnterpriseServiceMockMixin -from common.test.utils import assert_dict_contains_subset @ddt.ddt diff --git a/openedx/features/enterprise_support/tests/test_serializers.py b/openedx/features/enterprise_support/tests/test_serializers.py index 1f1b73bae664..eff9993f8b59 100644 --- a/openedx/features/enterprise_support/tests/test_serializers.py +++ b/openedx/features/enterprise_support/tests/test_serializers.py @@ -9,7 +9,7 @@ from openedx.features.enterprise_support.serializers import EnterpriseCourseEnrollmentSerializer from openedx.features.enterprise_support.tests.factories import ( EnterpriseCourseEnrollmentFactory, - EnterpriseCustomerUserFactory + EnterpriseCustomerUserFactory, ) @@ -19,7 +19,7 @@ class EnterpriseCourseEnrollmentSerializerTests(TestCase): """ @classmethod - def setUpTestData(cls): # lint-amnesty, pylint: disable=super-method-not-called + def setUpTestData(cls): # pylint: disable=super-method-not-called enterprise_customer_user = EnterpriseCustomerUserFactory() enterprise_course_enrollment = EnterpriseCourseEnrollmentFactory( enterprise_customer_user=enterprise_customer_user @@ -49,7 +49,7 @@ def test_data_with_license(self): 'is_revoked': licensed_ece.is_revoked, } } - self.assertDictEqual(serializer.data, expected) + self.assertDictEqual(serializer.data, expected) # noqa: PT009 def test_data_without_license(self): """ Verify the correct fields are serialized when the enrollment is not licensed. """ @@ -63,4 +63,4 @@ def test_data_without_license(self): 'saved_for_later': self.enterprise_course_enrollment.saved_for_later, 'license': None } - self.assertDictEqual(serializer.data, expected) + self.assertDictEqual(serializer.data, expected) # noqa: PT009 diff --git a/openedx/features/enterprise_support/tests/test_signals.py b/openedx/features/enterprise_support/tests/test_signals.py index 3207aeb024f3..9bb96a4be918 100644 --- a/openedx/features/enterprise_support/tests/test_signals.py +++ b/openedx/features/enterprise_support/tests/test_signals.py @@ -11,6 +11,7 @@ from edx_django_utils.cache import TieredCache from opaque_keys.edx.keys import CourseKey from slumber.exceptions import HttpClientError, HttpServerError + # from requests.exceptions import HTTPError from testfixtures import LogCapture @@ -25,11 +26,13 @@ from openedx.features.enterprise_support.tests.factories import ( EnterpriseCourseEnrollmentFactory, EnterpriseCustomerFactory, - EnterpriseCustomerUserFactory + EnterpriseCustomerUserFactory, ) from openedx.features.enterprise_support.utils import get_data_consent_share_cache_key -from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + SharedModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order log = logging.getLogger(__name__) @@ -184,7 +187,7 @@ def test_refund_order_voucher_with_client_errors(self, mock_error, log_level, mo ( LOGGER_NAME, log_level, - 'Encountered {} from ecommerce while creating refund voucher. ' + 'Encountered {} from ecommerce while creating refund voucher. ' # noqa: UP032 'Order=EDX-000000001, enrollment={}, user={}'.format( mock_error.__name__, enrollment, enrollment.user ), diff --git a/openedx/features/enterprise_support/tests/test_utils.py b/openedx/features/enterprise_support/tests/test_utils.py index 48a331083f41..4d4c1b57d3f9 100644 --- a/openedx/features/enterprise_support/tests/test_utils.py +++ b/openedx/features/enterprise_support/tests/test_utils.py @@ -25,7 +25,7 @@ from openedx.features.enterprise_support.tests.factories import ( EnterpriseCustomerBrandingConfigurationFactory, EnterpriseCustomerFactory, - EnterpriseCustomerUserFactory + EnterpriseCustomerUserFactory, ) from openedx.features.enterprise_support.utils import ( ENTERPRISE_HEADER_LINKS, @@ -45,10 +45,15 @@ is_enterprise_learner, update_account_settings_context_for_enterprise, update_logistration_context_for_enterprise, - update_third_party_auth_context_for_enterprise + update_third_party_auth_context_for_enterprise, +) +from xmodule.modulestore.tests.django_utils import ( + SharedModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import ( # pylint: disable=wrong-import-order + BlockFactory, + CourseFactory, ) -from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory, BlockFactory # lint-amnesty, pylint: disable=wrong-import-order TEST_PASSWORD = 'test' @@ -358,7 +363,7 @@ def test_get_enterprise_learner_portal_uncached(self): other_enterprise_customer_user.save() portal = get_enterprise_learner_portal(request) - self.assertDictEqual(portal, { + self.assertDictEqual(portal, { # noqa: PT009 'name': enterprise_customer_user.enterprise_customer.name, 'slug': enterprise_customer_user.enterprise_customer.slug, 'logo': enterprise_customer_user.enterprise_customer.safe_branding_configuration.safe_logo_url, @@ -380,7 +385,7 @@ def test_get_enterprise_learner_portal_no_branding_config(self): request.GET = {'enterprise_customer': enterprise_customer_user.enterprise_customer.uuid} portal = get_enterprise_learner_portal(request) - self.assertDictEqual(portal, { + self.assertDictEqual(portal, { # noqa: PT009 'name': enterprise_customer_user.enterprise_customer.name, 'slug': enterprise_customer_user.enterprise_customer.slug, 'logo': enterprise_customer_user.enterprise_customer.safe_branding_configuration.safe_logo_url, @@ -414,7 +419,7 @@ def test_get_enterprise_learner_portal_no_customer_from_request(self): ): portal = get_enterprise_learner_portal(request) - self.assertDictEqual(portal, { + self.assertDictEqual(portal, { # noqa: PT009 'name': enterprise_customer_user.enterprise_customer.name, 'slug': enterprise_customer_user.enterprise_customer.slug, 'logo': enterprise_customer_user.enterprise_customer.safe_branding_configuration.safe_logo_url, @@ -431,7 +436,7 @@ def test_get_enterprise_learner_portal_cached(self): 'enterprise_learner_portal': json.dumps(enterprise_customer_data) }, user=self.user) portal = get_enterprise_learner_portal(request) - self.assertDictEqual(portal, enterprise_customer_data) + self.assertDictEqual(portal, enterprise_customer_data) # noqa: PT009 @override_waffle_flag(ENTERPRISE_HEADER_LINKS, True) def test_get_enterprise_learner_portal_no_enterprise_user(self): @@ -487,7 +492,7 @@ def test_is_enterprise_learner_no_enterprise_user(self): @mock.patch('django.core.cache.cache.set') @mock.patch('django.core.cache.cache.get') @mock.patch('openedx.features.enterprise_support.api.enterprise_enabled', return_value=False) - def test_is_enterprise_learner_enterprise_disabled(self, _, mock_cache_get, mock_cache_set): + def test_is_enterprise_learner_enterprise_disabled(self, _, mock_cache_get, mock_cache_set): # noqa: PT019 assert not is_enterprise_learner(self.user) assert not is_enterprise_learner(self.user.id) assert not mock_cache_get.called @@ -607,7 +612,7 @@ def setUpClass(cls): cls.course = cls.create_test_course() @classmethod - def setUpTestData(cls): # lint-amnesty, pylint: disable=super-method-not-called + def setUpTestData(cls): # pylint: disable=super-method-not-called """Set up and enroll our fake user in the course.""" cls.user = UserFactory(password=TEST_PASSWORD) CourseEnrollment.enroll(cls.user, cls.course.id) @@ -679,4 +684,4 @@ def test_course_accessed_with_completion_api(self): self.complete_sequential(self.course, vertical1) course_accessed = is_course_accessed(self.user, str(self.course.id)) - self.assertTrue(course_accessed) + self.assertTrue(course_accessed) # noqa: PT009 diff --git a/openedx/features/enterprise_support/utils.py b/openedx/features/enterprise_support/utils.py index 9e99bf599267..cc6402e60492 100644 --- a/openedx/features/enterprise_support/utils.py +++ b/openedx/features/enterprise_support/utils.py @@ -25,7 +25,7 @@ from openedx.core.djangoapps.user_authn.cookies import standard_cookie_settings from openedx.core.djangolib.markup import HTML, Text -ENTERPRISE_HEADER_LINKS = WaffleFlag('enterprise.enterprise_header_links', __name__) # lint-amnesty, pylint: disable=toggle-missing-annotation +ENTERPRISE_HEADER_LINKS = WaffleFlag('enterprise.enterprise_header_links', __name__) # pylint: disable=toggle-missing-annotation def get_data_consent_share_cache_key(user_id, course_id, enterprise_customer_uuid=None): @@ -326,7 +326,7 @@ def get_enterprise_learner_portal(request): Caches and returns result in/from the user's request session if provided. """ # Prevent a circular import. - from openedx.features.enterprise_support.api import enterprise_enabled, enterprise_customer_uuid_for_request + from openedx.features.enterprise_support.api import enterprise_customer_uuid_for_request, enterprise_enabled user = request.user # Only cache this if a learner is authenticated (AnonymousUser exists and should not be tracked) diff --git a/openedx/features/lti_course_tab/tab.py b/openedx/features/lti_course_tab/tab.py index 924dbe27f798..97fc5c5bca37 100644 --- a/openedx/features/lti_course_tab/tab.py +++ b/openedx/features/lti_course_tab/tab.py @@ -1,7 +1,7 @@ """ Code related to LTI course tab functionality. """ -from typing import Dict +from typing import Dict # noqa: UP035 from urllib.parse import quote from django.contrib.auth.models import AbstractBaseUser @@ -14,13 +14,13 @@ from opaque_keys.edx.keys import CourseKey from web_fragments.fragment import Fragment +from common.djangoapps.student.models import anonymous_id_for_user from lms.djangoapps.courseware.access import get_user_role from lms.djangoapps.courseware.tabs import EnrolledTab from openedx.core.djangoapps.discussions.models import DiscussionsConfiguration from openedx.core.djangolib.markup import HTML -from common.djangoapps.student.models import anonymous_id_for_user -from xmodule.course_block import CourseBlock # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.tabs import TabFragmentViewMixin, key_checker # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.course_block import CourseBlock # pylint: disable=wrong-import-order +from xmodule.tabs import TabFragmentViewMixin, key_checker # pylint: disable=wrong-import-order class LtiCourseLaunchMixin: @@ -35,7 +35,7 @@ class LtiCourseLaunchMixin: } DEFAULT_ROLE = 'Student,Learner' - def _get_pii_lti_parameters(self, course: CourseBlock, request: HttpRequest) -> Dict[str, str]: + def _get_pii_lti_parameters(self, course: CourseBlock, request: HttpRequest) -> Dict[str, str]: # noqa: UP006 """ Get LTI parameters that contain PII. @@ -62,7 +62,7 @@ def _get_pii_lti_parameters(self, course: CourseBlock, request: HttpRequest) -> pii_config['person_contact_email_primary'] = request.user.email return pii_config - def _get_additional_lti_parameters(self, course: CourseBlock, request: HttpRequest) -> Dict[str, str]: + def _get_additional_lti_parameters(self, course: CourseBlock, request: HttpRequest) -> Dict[str, str]: # noqa: UP006 # pylint: disable=line-too-long """ Get additional misc LTI parameters. @@ -101,7 +101,7 @@ def _get_resource_link_id(course_key: CourseKey, request: HttpRequest) -> str: @staticmethod def _get_result_sourcedid(context_id: str, resource_link_id: str, user_id: str) -> str: - return "{context}:{resource_link}:{user_id}".format( + return "{context}:{resource_link}:{user_id}".format( # noqa: UP032 context=context_id, resource_link=resource_link_id, user_id=user_id, @@ -109,7 +109,7 @@ def _get_result_sourcedid(context_id: str, resource_link_id: str, user_id: str) @staticmethod def _get_context_title(course: CourseBlock) -> str: - return "{} - {}".format( + return "{} - {}".format( # noqa: UP032 course.display_name_with_default, course.display_org_with_default, ) diff --git a/openedx/features/name_affirmation_api/tests/test_utils.py b/openedx/features/name_affirmation_api/tests/test_utils.py index 7ce42509e56e..05d606d22926 100644 --- a/openedx/features/name_affirmation_api/tests/test_utils.py +++ b/openedx/features/name_affirmation_api/tests/test_utils.py @@ -16,10 +16,10 @@ class TestNameAffirmationAPIUtils(TestCase): @patch('openedx.features.name_affirmation_api.utils.PluginManager') def test_name_affirmation_installed(self, mock_manager): mock_manager.get_plugin.return_value = 'mock plugin' - self.assertTrue(is_name_affirmation_installed()) + self.assertTrue(is_name_affirmation_installed()) # noqa: PT009 @patch('openedx.features.name_affirmation_api.utils.PluginManager') def test_name_affirmation_not_installed(self, mock_manager): mock_manager.side_effect = PluginError('No such plugin') - with self.assertRaises(PluginError): - self.assertFalse(is_name_affirmation_installed()) + with self.assertRaises(PluginError): # noqa: PT027 + self.assertFalse(is_name_affirmation_installed()) # noqa: PT009 diff --git a/openedx/features/personalized_learner_schedules/call_to_action.py b/openedx/features/personalized_learner_schedules/call_to_action.py index 634c425b38bd..cb9bf91f76b8 100644 --- a/openedx/features/personalized_learner_schedules/call_to_action.py +++ b/openedx/features/personalized_learner_schedules/call_to_action.py @@ -5,17 +5,17 @@ import logging from crum import get_current_request - from django.conf import settings from django.urls import reverse -from django.utils.translation import gettext as _, ngettext +from django.utils.translation import gettext as _ +from django.utils.translation import ngettext -from xmodule.util.misc import is_xblock_an_assignment from openedx.core.djangolib.markup import HTML, Text from openedx.core.lib.mobile_utils import is_request_from_mobile_app from openedx.features.course_experience import RELATIVE_DATES_DISABLE_RESET_FLAG from openedx.features.course_experience.url_helpers import is_request_from_learning_mfe from openedx.features.course_experience.utils import dates_banner_should_display +from xmodule.util.misc import is_xblock_an_assignment log = logging.getLogger(__name__) diff --git a/openedx/features/personalized_learner_schedules/show_answer/show_answer_field_override.py b/openedx/features/personalized_learner_schedules/show_answer/show_answer_field_override.py index d6452a84962f..6a3e923d3b06 100644 --- a/openedx/features/personalized_learner_schedules/show_answer/show_answer_field_override.py +++ b/openedx/features/personalized_learner_schedules/show_answer/show_answer_field_override.py @@ -5,7 +5,7 @@ from lms.djangoapps.courseware.field_overrides import FieldOverrideProvider from openedx.features.course_experience import RELATIVE_DATES_FLAG -from xmodule.capa_block import SHOWANSWER # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.capa_block import SHOWANSWER # pylint: disable=wrong-import-order class ShowAnswerFieldOverride(FieldOverrideProvider): diff --git a/openedx/features/personalized_learner_schedules/show_answer/tests/test_show_answer_override.py b/openedx/features/personalized_learner_schedules/show_answer/tests/test_show_answer_override.py index 0a0c03725545..00dbe644a3c4 100644 --- a/openedx/features/personalized_learner_schedules/show_answer/tests/test_show_answer_override.py +++ b/openedx/features/personalized_learner_schedules/show_answer/tests/test_show_answer_override.py @@ -3,16 +3,17 @@ import ddt from django.test import RequestFactory from django.test.utils import override_settings - from edx_toggles.toggles.testutils import override_waffle_flag from lms.djangoapps.ccx.tests.test_overrides import inject_field_overrides -from lms.djangoapps.courseware.model_data import FieldDataCache from lms.djangoapps.courseware.block_render import get_block +from lms.djangoapps.courseware.model_data import FieldDataCache from openedx.features.course_experience import RELATIVE_DATES_FLAG -from xmodule.capa_block import SHOWANSWER # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.capa_block import SHOWANSWER # pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + ModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order @override_settings( diff --git a/openedx/features/survey_report/admin.py b/openedx/features/survey_report/admin.py index a5719d966a93..3d40c5efc05c 100644 --- a/openedx/features/survey_report/admin.py +++ b/openedx/features/survey_report/admin.py @@ -3,10 +3,11 @@ """ -from django.contrib import admin from django.conf import settings -from .models import SurveyReport +from django.contrib import admin + from .api import send_report_to_external_api +from .models import SurveyReport class SurveyReportAdmin(admin.ModelAdmin): diff --git a/openedx/features/survey_report/api.py b/openedx/features/survey_report/api.py index cb8eadc29f1e..dd6547f5bfbf 100644 --- a/openedx/features/survey_report/api.py +++ b/openedx/features/survey_report/api.py @@ -2,23 +2,22 @@ Contains the logic to manage survey report model. """ import requests - from django.conf import settings from django.forms.models import model_to_dict from openedx.features.survey_report.models import ( + SURVEY_REPORT_ERROR, + SURVEY_REPORT_GENERATED, SurveyReport, - SurveyReportUpload, SurveyReportAnonymousSiteID, - SURVEY_REPORT_ERROR, - SURVEY_REPORT_GENERATED + SurveyReportUpload, ) from openedx.features.survey_report.queries import ( get_course_enrollments, - get_recently_active_users, get_generated_certificates, + get_recently_active_users, get_registered_learners, - get_unique_courses_offered + get_unique_courses_offered, ) MAX_WEEKS_SINCE_LAST_LOGIN: int = 4 @@ -56,7 +55,7 @@ def generate_report() -> None: data["state"] = SURVEY_REPORT_GENERATED update_report(survey_report.id, data) send_report_to_external_api(survey_report.id) - except (Exception, ) as update_report_error: + except (Exception, ) as update_report_error: # noqa: B013 update_report(survey_report.id, {"state": SURVEY_REPORT_ERROR}) raise Exception(update_report_error) from update_report_error return survey_report.id diff --git a/openedx/features/survey_report/context_processors.py b/openedx/features/survey_report/context_processors.py index f2e8892d84bc..47a355e7b95d 100644 --- a/openedx/features/survey_report/context_processors.py +++ b/openedx/features/survey_report/context_processors.py @@ -26,10 +26,12 @@ It enhances the admin interface by providing dynamic context for displaying a survey report banner based on defined conditions and settings. """ -from django.conf import settings -from django.urls import reverse from datetime import datetime + from dateutil.relativedelta import relativedelta +from django.conf import settings +from django.urls import reverse + from .models import SurveyReport diff --git a/openedx/features/survey_report/migrations/0001_initial.py b/openedx/features/survey_report/migrations/0001_initial.py index 46d816a363cc..77377aac625b 100644 --- a/openedx/features/survey_report/migrations/0001_initial.py +++ b/openedx/features/survey_report/migrations/0001_initial.py @@ -1,7 +1,7 @@ # Generated by Django 3.2.16 on 2022-11-03 20:07 -from django.db import migrations, models import jsonfield.fields +from django.db import migrations, models class Migration(migrations.Migration): diff --git a/openedx/features/survey_report/migrations/0002_auto_20221130_1533.py b/openedx/features/survey_report/migrations/0002_auto_20221130_1533.py index ebb79a08fd69..e5a686b18ac9 100644 --- a/openedx/features/survey_report/migrations/0002_auto_20221130_1533.py +++ b/openedx/features/survey_report/migrations/0002_auto_20221130_1533.py @@ -1,7 +1,7 @@ # Generated by Django 3.2.16 on 2022-11-30 15:33 -from django.db import migrations, models import jsonfield.fields +from django.db import migrations, models class Migration(migrations.Migration): diff --git a/openedx/features/survey_report/migrations/0004_surveyreportupload.py b/openedx/features/survey_report/migrations/0004_surveyreportupload.py index cc77eaef71bb..02bd313c5ac3 100644 --- a/openedx/features/survey_report/migrations/0004_surveyreportupload.py +++ b/openedx/features/survey_report/migrations/0004_surveyreportupload.py @@ -1,7 +1,7 @@ # Generated by Django 3.2.16 on 2023-02-01 15:16 -from django.db import migrations, models import django.db.models.deletion +from django.db import migrations, models class Migration(migrations.Migration): diff --git a/openedx/features/survey_report/migrations/0005_surveyreportanonymoussiteid.py b/openedx/features/survey_report/migrations/0005_surveyreportanonymoussiteid.py index ccf7d059a2d2..a18a102d4f82 100644 --- a/openedx/features/survey_report/migrations/0005_surveyreportanonymoussiteid.py +++ b/openedx/features/survey_report/migrations/0005_surveyreportanonymoussiteid.py @@ -1,8 +1,9 @@ # Generated by Django 3.2.16 on 2023-02-10 15:45 -from django.db import migrations, models import uuid +from django.db import migrations, models + class Migration(migrations.Migration): diff --git a/openedx/features/survey_report/models.py b/openedx/features/survey_report/models.py index a753da620b33..ea27def37386 100644 --- a/openedx/features/survey_report/models.py +++ b/openedx/features/survey_report/models.py @@ -18,7 +18,7 @@ ] -class SurveyReport(models.Model): +class SurveyReport(models.Model): # noqa: DJ008 """ This model stores information to automate the way of gathering impact data from the openedx project. @@ -62,7 +62,7 @@ class Meta: get_latest_by = 'created_at' -class SurveyReportUpload(models.Model): +class SurveyReportUpload(models.Model): # noqa: DJ008 """ This model stores the result of the POST request made to an external service after generating a survey report. @@ -77,7 +77,7 @@ class SurveyReportUpload(models.Model): sent_at = models.DateTimeField(auto_now=True, help_text="Date when the report was sent to external api.") report = models.ForeignKey(SurveyReport, on_delete=models.CASCADE, help_text="The report that was sent.") status_code = models.IntegerField(help_text="Request status code.") - request_details = models.CharField( + request_details = models.CharField( # noqa: DJ001 max_length=255, null=True, blank=True, @@ -88,7 +88,7 @@ def is_uploaded(self) -> bool: return 200 <= self.status_code < 300 -class SurveyReportAnonymousSiteID(models.Model): +class SurveyReportAnonymousSiteID(models.Model): # noqa: DJ008 """ This model is just to save the identification which will be send to the external API when the settings ANONYMOUS_SURVEY_REPORT is defined. diff --git a/openedx/features/survey_report/queries.py b/openedx/features/survey_report/queries.py index 011a0d5b4790..f7bedf9cb33d 100644 --- a/openedx/features/survey_report/queries.py +++ b/openedx/features/survey_report/queries.py @@ -5,11 +5,11 @@ import logging from datetime import datetime, timedelta -from django.contrib.auth.models import User # lint-amnesty, pylint: disable=imported-auth-user +from django.contrib.auth.models import User # pylint: disable=imported-auth-user from django.db.models import Count, OuterRef, Q, Subquery -from common.djangoapps.util.query import read_replica_or_default from common.djangoapps.student.models import CourseEnrollment +from common.djangoapps.util.query import read_replica_or_default from lms.djangoapps.grades.models import PersistentCourseGrade from openedx.core.djangoapps.content.course_overviews.models import CourseOverview diff --git a/openedx/features/survey_report/tasks.py b/openedx/features/survey_report/tasks.py index a9065fb3258e..ff7fe2ac64f2 100644 --- a/openedx/features/survey_report/tasks.py +++ b/openedx/features/survey_report/tasks.py @@ -26,5 +26,5 @@ def generate_survey_report(): try: generate_report() log.info('Done - generate survey report') - except (Exception, ): # pylint: disable=broad-except + except (Exception, ): # pylint: disable=broad-except # noqa: B013 log.error('Error - generate survey report') diff --git a/openedx/features/survey_report/tests/test_query_methods.py b/openedx/features/survey_report/tests/test_query_methods.py index 9a4b6431ed59..b28c1857b83f 100644 --- a/openedx/features/survey_report/tests/test_query_methods.py +++ b/openedx/features/survey_report/tests/test_query_methods.py @@ -9,15 +9,14 @@ from openedx.core.djangoapps.content.course_overviews.tests.factories import CourseOverviewFactory from openedx.features.survey_report.queries import ( get_course_enrollments, - get_recently_active_users, get_generated_certificates, + get_recently_active_users, get_registered_learners, - get_unique_courses_offered + get_unique_courses_offered, ) - from xmodule.modulestore.django import modulestore from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase -from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.factories import CourseFactory # pylint: disable=wrong-import-order class TestSurveyReportCommands(ModuleStoreTestCase): @@ -30,7 +29,7 @@ def setUp(self): Setup for users and courses. """ super().setUp() - self.store = modulestore() # lint-amnesty, pylint: disable=protected-access + self.store = modulestore() # pylint: disable=protected-access self.first_course = CourseFactory.create( org="test", course="course1", display_name="run1" ) diff --git a/openedx/features/survey_report/urls.py b/openedx/features/survey_report/urls.py index dc7d2e29074a..9512168f0de6 100644 --- a/openedx/features/survey_report/urls.py +++ b/openedx/features/survey_report/urls.py @@ -3,6 +3,7 @@ """ from django.urls import path + from .views import SurveyReportView urlpatterns = [ diff --git a/openedx/features/survey_report/views.py b/openedx/features/survey_report/views.py index d8487e8cd4a4..ebc755426e4c 100644 --- a/openedx/features/survey_report/views.py +++ b/openedx/features/survey_report/views.py @@ -8,6 +8,7 @@ from django.utils.decorators import method_decorator from django.views.decorators.csrf import ensure_csrf_cookie from django.views.generic import View + from .tasks import generate_survey_report diff --git a/openedx/testing/coverage_context_listener/urls.py b/openedx/testing/coverage_context_listener/urls.py index 25208d683a90..0e7ce0379b3f 100644 --- a/openedx/testing/coverage_context_listener/urls.py +++ b/openedx/testing/coverage_context_listener/urls.py @@ -2,6 +2,7 @@ Coverage Context Listener URLs. """ from django.urls import path + from .views import update_context urlpatterns = [ diff --git a/openedx/testing/coverage_context_listener/views.py b/openedx/testing/coverage_context_listener/views.py index a139a4d8d87f..8c2a05bb5b73 100644 --- a/openedx/testing/coverage_context_listener/views.py +++ b/openedx/testing/coverage_context_listener/views.py @@ -4,8 +4,8 @@ import coverage from django.http import HttpResponse -from django.views.decorators.http import require_POST from django.views.decorators.csrf import csrf_exempt +from django.views.decorators.http import require_POST @require_POST diff --git a/openedx/tests/completion_integration/README.rst b/openedx/tests/completion_integration/README.rst index e69de29bb2d1..637254b8671c 100644 --- a/openedx/tests/completion_integration/README.rst +++ b/openedx/tests/completion_integration/README.rst @@ -0,0 +1,2 @@ +Completion Integration Tests +============================ diff --git a/openedx/tests/completion_integration/test_handlers.py b/openedx/tests/completion_integration/test_handlers.py index 4522768739ad..38bf74ff2ab4 100644 --- a/openedx/tests/completion_integration/test_handlers.py +++ b/openedx/tests/completion_integration/test_handlers.py @@ -4,6 +4,7 @@ from datetime import datetime from unittest.mock import patch +from zoneinfo import ZoneInfo import ddt import pytest @@ -11,7 +12,6 @@ from completion.models import BlockCompletion from completion.test_utils import CompletionSetUpMixin from django.test import TestCase -from zoneinfo import ZoneInfo from xblock.completable import XBlockCompletionMode from xblock.core import XBlock diff --git a/openedx/tests/completion_integration/test_models.py b/openedx/tests/completion_integration/test_models.py index e0aba950e859..e3e59ea575b0 100644 --- a/openedx/tests/completion_integration/test_models.py +++ b/openedx/tests/completion_integration/test_models.py @@ -31,7 +31,7 @@ def test_valid_percents(self): def test_invalid_percent(self): for value in [-0.00000000001, 1.0000000001, 47.1, 1000, None, float('inf'), float('nan')]: - self.assertRaises(ValidationError, models.validate_percent, value) + self.assertRaises(ValidationError, models.validate_percent, value) # noqa: PT027 class CompletionSetUpMixin(CompletionWaffleTestMixin): @@ -166,7 +166,7 @@ def test_submit_batch_completion(self): def test_submit_batch_completion_without_waffle(self): with override_waffle_switch(ENABLE_COMPLETION_TRACKING_SWITCH, False): - with pytest.raises(RuntimeError): + with pytest.raises(RuntimeError): # noqa: PT012 blocks = [(self.block_key, 1.0)] models.BlockCompletion.objects.submit_batch_completion(self.user, blocks) @@ -213,7 +213,7 @@ def setUp(self): def test_get_learning_context_completions_missing_runs(self): actual_completions = models.BlockCompletion.get_learning_context_completions(self.user, self.course_key) expected_block_keys = self.block_keys_with_runs[:3] - expected_completions = dict(list(zip(expected_block_keys, [1.0, 0.8, 0.6]))) + expected_completions = dict(list(zip(expected_block_keys, [1.0, 0.8, 0.6]))) # noqa: B905 assert expected_completions == actual_completions def test_get_learning_context_completions_empty_result_set(self): diff --git a/openedx/tests/completion_integration/test_services.py b/openedx/tests/completion_integration/test_services.py index 7a6fad8ece12..ced8bd4c4a9f 100644 --- a/openedx/tests/completion_integration/test_services.py +++ b/openedx/tests/completion_integration/test_services.py @@ -10,14 +10,14 @@ from django.conf import settings from django.test import override_settings from opaque_keys.edx.keys import CourseKey + +from common.djangoapps.student.tests.factories import UserFactory +from openedx.core.djangolib.testing.utils import skip_unless_lms from xmodule.library_tools import LegacyLibraryToolsService from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase -from xmodule.modulestore.tests.factories import CourseFactory, BlockFactory, LibraryFactory +from xmodule.modulestore.tests.factories import BlockFactory, CourseFactory, LibraryFactory from xmodule.tests import prepare_block_runtime -from openedx.core.djangolib.testing.utils import skip_unless_lms -from common.djangoapps.student.tests.factories import UserFactory - @ddt.ddt @skip_unless_lms @@ -122,7 +122,7 @@ def _bind_course_block(self, block): Bind a block (part of self.course) so we can access student-specific data. """ prepare_block_runtime(block.runtime, course_id=block.location.course_key) - block.runtime._services.update({'library_tools': LegacyLibraryToolsService(self.store, self.user.id)}) # lint-amnesty, pylint: disable=protected-access + block.runtime._services.update({'library_tools': LegacyLibraryToolsService(self.store, self.user.id)}) # pylint: disable=protected-access def get_block(descriptor): """Mocks module_system get_block_for_descriptor function""" @@ -191,7 +191,7 @@ def test_can_mark_library_content_complete_on_view(self): source_library_id=str(library.location.library_key), user_id=self.user.id, ) - self.assertTrue(self.completion_service.can_mark_block_complete_on_view(library_content_block)) + self.assertTrue(self.completion_service.can_mark_block_complete_on_view(library_content_block)) # noqa: PT009 def test_vertical_completion_with_library_content(self): library = LibraryFactory.create(modulestore=self.store) @@ -215,7 +215,7 @@ def test_vertical_completion_with_library_content(self): user_id=self.user.id, ) # Library Content Block needs its children to be completed. - self.assertFalse(self.completion_service.can_mark_block_complete_on_view(library_content_block)) + self.assertFalse(self.completion_service.can_mark_block_complete_on_view(library_content_block)) # noqa: PT009 # Dirty hack: # sync_from_library isn't *supposed* to work inside LMS, but this test case was written diff --git a/openedx/tests/completion_integration/test_views.py b/openedx/tests/completion_integration/test_views.py index e9e866224ec4..dc3e34198605 100644 --- a/openedx/tests/completion_integration/test_views.py +++ b/openedx/tests/completion_integration/test_views.py @@ -10,11 +10,16 @@ from edx_toggles.toggles.testutils import override_waffle_switch from rest_framework.test import APIClient -from openedx.core.djangolib.testing.utils import skip_unless_lms from common.djangoapps.student.tests.factories import CourseEnrollmentFactory, UserFactory -from xmodule.modulestore import ModuleStoreEnum # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order -from xmodule.modulestore.tests.factories import CourseFactory, BlockFactory # lint-amnesty, pylint: disable=wrong-import-order +from openedx.core.djangolib.testing.utils import skip_unless_lms +from xmodule.modulestore import ModuleStoreEnum # pylint: disable=wrong-import-order +from xmodule.modulestore.tests.django_utils import ( + ModuleStoreTestCase, # pylint: disable=wrong-import-order +) +from xmodule.modulestore.tests.factories import ( # pylint: disable=wrong-import-order + BlockFactory, + CourseFactory, +) @ddt.ddt @@ -126,7 +131,7 @@ def test_enable_completion_tracking(self): 400, { "detail": ( - "Block with key: 'block-v1:TestX+101+OtherCourse+type@problem+block@other' " + "Block with key: 'block-v1:TestX+101+OtherCourse+type@problem+block@other' " # noqa: UP032 "is not in context {}".format(COURSE_KEY) ) } diff --git a/openedx/tests/xblock_integration/test_crowdsource_hinter.py b/openedx/tests/xblock_integration/test_crowdsource_hinter.py index ecd3c09dd650..bb8d663a5025 100644 --- a/openedx/tests/xblock_integration/test_crowdsource_hinter.py +++ b/openedx/tests/xblock_integration/test_crowdsource_hinter.py @@ -8,12 +8,12 @@ import simplejson as json from django.conf import settings from django.urls import reverse -from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase -from xmodule.modulestore.tests.factories import CourseFactory, BlockFactory from common.djangoapps.student.tests.factories import GlobalStaffFactory from lms.djangoapps.courseware.tests.helpers import LoginEnrollmentTestCase from openedx.core.lib.url_utils import quote_slashes +from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase +from xmodule.modulestore.tests.factories import BlockFactory, CourseFactory class TestCrowdsourceHinter(SharedModuleStoreTestCase, LoginEnrollmentTestCase): diff --git a/openedx/tests/xblock_integration/test_external_xblocks.py b/openedx/tests/xblock_integration/test_external_xblocks.py index 01bdf2133cce..ac2c37e39195 100644 --- a/openedx/tests/xblock_integration/test_external_xblocks.py +++ b/openedx/tests/xblock_integration/test_external_xblocks.py @@ -22,18 +22,18 @@ class name for a test. In most cases, this means you have two versions effect deployed XBlocks. See discussion at: https://github.com/openedx/edx-platform/pull/11032#discussion_r48097392). ''' - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass class InvalidTestName(Exception): ''' This means you have an entry point for a test that does not correspond to a properly named test class. For example, if you cut-and-paste entry - points in `setup.py`, and forgot to repoint the class (so it points to - `DoneXBlock` instead of `TestDone`), or otherwise made an error, you - will see this exception. + points in your package configuration, and forgot to repoint the class + (so it points to `DoneXBlock` instead of `TestDone`), or otherwise made + an error, you will see this exception. ''' - pass # lint-amnesty, pylint: disable=unnecessary-pass + pass # pylint: disable=unnecessary-pass xblock_loaded = False # pylint: disable=invalid-name diff --git a/openedx/tests/xblock_integration/test_recommender.py b/openedx/tests/xblock_integration/test_recommender.py index ae06b09db162..b7e5faea372e 100644 --- a/openedx/tests/xblock_integration/test_recommender.py +++ b/openedx/tests/xblock_integration/test_recommender.py @@ -14,12 +14,12 @@ from ddt import data, ddt from django.conf import settings from django.urls import reverse -from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase -from xmodule.modulestore.tests.factories import CourseFactory, BlockFactory from common.djangoapps.student.tests.factories import GlobalStaffFactory from lms.djangoapps.courseware.tests.helpers import LoginEnrollmentTestCase from openedx.core.lib.url_utils import quote_slashes +from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase +from xmodule.modulestore.tests.factories import BlockFactory, CourseFactory class TestRecommender(SharedModuleStoreTestCase, LoginEnrollmentTestCase): @@ -211,7 +211,7 @@ def test_add_resource(self): for field in resource: expected_result[field] = resource[field] - self.assertDictEqual(json.loads(result.content), expected_result) + self.assertDictEqual(json.loads(result.content), expected_result) # noqa: PT009 self.assert_request_status_code(200, self.course_url) diff --git a/openedx/tests/xblock_integration/xblock_testcase.py b/openedx/tests/xblock_integration/xblock_testcase.py index af2a3410b75f..8e55b131f03b 100644 --- a/openedx/tests/xblock_integration/xblock_testcase.py +++ b/openedx/tests/xblock_integration/xblock_testcase.py @@ -37,24 +37,23 @@ import collections +import html import json import sys import unittest from datetime import datetime, timedelta -import html - from unittest import mock from zoneinfo import ZoneInfo + from bs4 import BeautifulSoup from django.conf import settings from django.urls import reverse from xblock.plugin import Plugin import xmodule.services -from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase -from xmodule.modulestore.tests.factories import CourseFactory, BlockFactory - from lms.djangoapps.courseware.tests.helpers import LoginEnrollmentTestCase +from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase +from xmodule.modulestore.tests.factories import BlockFactory, CourseFactory class XBlockEventTestMixin: diff --git a/package-lock.json b/package-lock.json index 3a0c3870b80a..4086fdb0f08e 100644 --- a/package-lock.json +++ b/package-lock.json @@ -22,7 +22,7 @@ "@testing-library/jest-dom": "^6", "@testing-library/react": "^12", "@testing-library/user-event": "^12", - "babel-loader": "^9", + "babel-loader": "^10.0.0", "babel-plugin-transform-class-properties": "^6", "babel-polyfill": "^6", "backbone": "^1", @@ -35,7 +35,7 @@ "datatables": "^1", "datatables.net-fixedcolumns": "^5", "edx-ui-toolkit": "^1", - "exports-loader": "^0.6", + "exports-loader": "^0.7.0", "file-loader": "^6", "font-awesome": "^4", "hls.js": "^1", @@ -46,17 +46,17 @@ "jquery.scrollto": "^2", "js-cookie": "^3", "moment": "^2", - "moment-timezone": "^0.5", - "node-gyp": "^11", + "moment-timezone": "^0.6.0", + "node-gyp": "^12.0.0", "popper.js": "^1", "prop-types": "^15", "raw-loader": "^0.5", "react": "^16", "react-dom": "^16", - "react-focus-lock": "^1", + "react-focus-lock": "^2.0.0", "react-redux": "^5", "react-router-dom": "^5", - "react-slick": "^0.30", + "react-slick": "^0.31.0", "redux": "3.7.2", "redux-thunk": "2.2.0", "requirejs": "^2", @@ -77,14 +77,14 @@ "devDependencies": { "@edx/stylelint-config-edx": "^2", "babel-jest": "^29", - "jasmine-core": "2.6.4", + "jasmine-core": "2.99.1", "jasmine-jquery": "git+https://git@github.com/velesin/jasmine-jquery.git#ebad463d592d3fea00c69f26ea18a930e09c7b58", "jest": "^29", - "karma": "^0.13", + "karma": "^6.0.0", "karma-chrome-launcher": "^3", "karma-coverage": "^2", "karma-firefox-launcher": "^2", - "karma-jasmine": "^0.3", + "karma-jasmine": "^1", "karma-jasmine-html-reporter": "^0.2", "karma-junit-reporter": "^2", "karma-requirejs": "^1", @@ -108,9 +108,9 @@ "license": "MIT" }, "node_modules/@babel/code-frame": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.28.6.tgz", - "integrity": "sha512-JYgintcMjRiCvS8mMECzaEn+m3PfoQiyqukOMCCVQtoJGYJw8j/8LBJEiqkHLkfwCcs74E3pbAUFNg7d9VNJ+Q==", + "version": "7.29.0", + "resolved": "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.29.0.tgz", + "integrity": "sha512-9NhCeYjq9+3uxgdtp20LSiJXJvN0FeCtNGpJxuMFZ1Kv3cWUNb6DOhJwUvcVCzKGR66cw4njwM6hrJLqgOwbcw==", "license": "MIT", "dependencies": { "@babel/helper-validator-identifier": "^7.28.5", @@ -122,30 +122,29 @@ } }, "node_modules/@babel/compat-data": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/compat-data/-/compat-data-7.28.6.tgz", - "integrity": "sha512-2lfu57JtzctfIrcGMz992hyLlByuzgIk58+hhGCxjKZ3rWI82NnVLjXcaTqkI2NvlcvOskZaiZ5kjUALo3Lpxg==", + "version": "7.29.3", + "resolved": "https://registry.npmjs.org/@babel/compat-data/-/compat-data-7.29.3.tgz", + "integrity": "sha512-LIVqM46zQWZhj17qA8wb4nW/ixr2y1Nw+r1etiAWgRM6U1IqP+LNhL1yg440jYZR72jCWcWbLWzIosH+uP1fqg==", "license": "MIT", "engines": { "node": ">=6.9.0" } }, "node_modules/@babel/core": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/core/-/core-7.28.6.tgz", - "integrity": "sha512-H3mcG6ZDLTlYfaSNi0iOKkigqMFvkTKlGUYlD8GW7nNOYRrevuA46iTypPyv+06V3fEmvvazfntkBU34L0azAw==", + "version": "7.29.0", + "resolved": "https://registry.npmjs.org/@babel/core/-/core-7.29.0.tgz", + "integrity": "sha512-CGOfOJqWjg2qW/Mb6zNsDm+u5vFQ8DxXfbM09z69p5Z6+mE1ikP2jUXw+j42Pf1XTYED2Rni5f95npYeuwMDQA==", "license": "MIT", - "peer": true, "dependencies": { - "@babel/code-frame": "^7.28.6", - "@babel/generator": "^7.28.6", + "@babel/code-frame": "^7.29.0", + "@babel/generator": "^7.29.0", "@babel/helper-compilation-targets": "^7.28.6", "@babel/helper-module-transforms": "^7.28.6", "@babel/helpers": "^7.28.6", - "@babel/parser": "^7.28.6", + "@babel/parser": "^7.29.0", "@babel/template": "^7.28.6", - "@babel/traverse": "^7.28.6", - "@babel/types": "^7.28.6", + "@babel/traverse": "^7.29.0", + "@babel/types": "^7.29.0", "@jridgewell/remapping": "^2.3.5", "convert-source-map": "^2.0.0", "debug": "^4.1.0", @@ -162,13 +161,13 @@ } }, "node_modules/@babel/generator": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/generator/-/generator-7.28.6.tgz", - "integrity": "sha512-lOoVRwADj8hjf7al89tvQ2a1lf53Z+7tiXMgpZJL3maQPDxh0DgLMN62B2MKUOFcoodBHLMbDM6WAbKgNy5Suw==", + "version": "7.29.0", + "resolved": "https://registry.npmjs.org/@babel/generator/-/generator-7.29.0.tgz", + "integrity": "sha512-vSH118/wwM/pLR38g/Sgk05sNtro6TlTJKuiMXDaZqPUfjTFcudpCOt00IhOfj+1BFAX+UFAlzCU+6WXr3GLFQ==", "license": "MIT", "dependencies": { - "@babel/parser": "^7.28.6", - "@babel/types": "^7.28.6", + "@babel/parser": "^7.29.0", + "@babel/types": "^7.29.0", "@jridgewell/gen-mapping": "^0.3.12", "@jridgewell/trace-mapping": "^0.3.28", "jsesc": "^3.0.2" @@ -434,12 +433,12 @@ } }, "node_modules/@babel/parser": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.28.6.tgz", - "integrity": "sha512-TeR9zWR18BvbfPmGbLampPMW+uW1NZnJlRuuHso8i87QZNq2JRF9i6RgxRqtEq+wQGsS19NNTWr2duhnE49mfQ==", + "version": "7.29.0", + "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.29.0.tgz", + "integrity": "sha512-IyDgFV5GeDUVX4YdF/3CPULtVGSXXMLh1xVIgdCgxApktqnQV0r7/8Nqthg+8YLGaAtdyIlo2qIdZrbCv4+7ww==", "license": "MIT", "dependencies": { - "@babel/types": "^7.28.6" + "@babel/types": "^7.29.0" }, "bin": { "parser": "bin/babel-parser.js" @@ -494,6 +493,22 @@ "@babel/core": "^7.0.0" } }, + "node_modules/@babel/plugin-bugfix-safari-rest-destructuring-rhs-array": { + "version": "7.29.3", + "resolved": "https://registry.npmjs.org/@babel/plugin-bugfix-safari-rest-destructuring-rhs-array/-/plugin-bugfix-safari-rest-destructuring-rhs-array-7.29.3.tgz", + "integrity": "sha512-SRS46DFR4HqzUzCVgi90/xMoL+zeBDBvWdKYXSEzh79kXswNFEglUpMKxR04//dPqwYXWUBJ3mpUd933ru9Kmg==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.28.6", + "@babel/helper-skip-transparent-expression-wrappers": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0" + } + }, "node_modules/@babel/plugin-bugfix-v8-spread-parameters-in-optional-chaining": { "version": "7.27.1", "resolved": "https://registry.npmjs.org/@babel/plugin-bugfix-v8-spread-parameters-in-optional-chaining/-/plugin-bugfix-v8-spread-parameters-in-optional-chaining-7.27.1.tgz", @@ -842,14 +857,14 @@ } }, "node_modules/@babel/plugin-transform-async-generator-functions": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-async-generator-functions/-/plugin-transform-async-generator-functions-7.28.6.tgz", - "integrity": "sha512-9knsChgsMzBV5Yh3kkhrZNxH3oCYAfMBkNNaVN4cP2RVlFPe8wYdwwcnOsAbkdDoV9UjFtOXWrWB52M8W4jNeA==", + "version": "7.29.0", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-async-generator-functions/-/plugin-transform-async-generator-functions-7.29.0.tgz", + "integrity": "sha512-va0VdWro4zlBr2JsXC+ofCPB2iG12wPtVGTWFx2WLDOM3nYQZZIGP82qku2eW/JR83sD+k2k+CsNtyEbUqhU6w==", "license": "MIT", "dependencies": { "@babel/helper-plugin-utils": "^7.28.6", "@babel/helper-remap-async-to-generator": "^7.27.1", - "@babel/traverse": "^7.28.6" + "@babel/traverse": "^7.29.0" }, "engines": { "node": ">=6.9.0" @@ -1021,9 +1036,9 @@ } }, "node_modules/@babel/plugin-transform-duplicate-named-capturing-groups-regex": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-duplicate-named-capturing-groups-regex/-/plugin-transform-duplicate-named-capturing-groups-regex-7.28.6.tgz", - "integrity": "sha512-5suVoXjC14lUN6ZL9OLKIHCNVWCrqGqlmEp/ixdXjvgnEl/kauLvvMO/Xw9NyMc95Joj1AeLVPVMvibBgSoFlA==", + "version": "7.29.0", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-duplicate-named-capturing-groups-regex/-/plugin-transform-duplicate-named-capturing-groups-regex-7.29.0.tgz", + "integrity": "sha512-zBPcW2lFGxdiD8PUnPwJjag2J9otbcLQzvbiOzDxpYXyCuYX9agOwMPGn1prVH0a4qzhCKu24rlH4c1f7yA8rw==", "license": "MIT", "dependencies": { "@babel/helper-create-regexp-features-plugin": "^7.28.5", @@ -1223,15 +1238,15 @@ } }, "node_modules/@babel/plugin-transform-modules-systemjs": { - "version": "7.28.5", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-modules-systemjs/-/plugin-transform-modules-systemjs-7.28.5.tgz", - "integrity": "sha512-vn5Jma98LCOeBy/KpeQhXcV2WZgaRUtjwQmjoBuLNlOmkg0fB5pdvYVeWRYI69wWKwK2cD1QbMiUQnoujWvrew==", + "version": "7.29.4", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-modules-systemjs/-/plugin-transform-modules-systemjs-7.29.4.tgz", + "integrity": "sha512-N7QmZ0xRZfjHOfZeQLJjwgX2zS9pdGHSVl/cjSGlo4dXMqvurfxXDMKY4RqEKzPozV78VMcd0lxyG13mlbKc4w==", "license": "MIT", "dependencies": { - "@babel/helper-module-transforms": "^7.28.3", - "@babel/helper-plugin-utils": "^7.27.1", + "@babel/helper-module-transforms": "^7.28.6", + "@babel/helper-plugin-utils": "^7.28.6", "@babel/helper-validator-identifier": "^7.28.5", - "@babel/traverse": "^7.28.5" + "@babel/traverse": "^7.29.0" }, "engines": { "node": ">=6.9.0" @@ -1257,13 +1272,13 @@ } }, "node_modules/@babel/plugin-transform-named-capturing-groups-regex": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-named-capturing-groups-regex/-/plugin-transform-named-capturing-groups-regex-7.27.1.tgz", - "integrity": "sha512-SstR5JYy8ddZvD6MhV0tM/j16Qds4mIpJTOd1Yu9J9pJjH93bxHECF7pgtc28XvkzTD6Pxcm/0Z73Hvk7kb3Ng==", + "version": "7.29.0", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-named-capturing-groups-regex/-/plugin-transform-named-capturing-groups-regex-7.29.0.tgz", + "integrity": "sha512-1CZQA5KNAD6ZYQLPw7oi5ewtDNxH/2vuCh+6SmvgDfhumForvs8a1o9n0UrEoBD8HU4djO2yWngTQlXl1NDVEQ==", "license": "MIT", "dependencies": { - "@babel/helper-create-regexp-features-plugin": "^7.27.1", - "@babel/helper-plugin-utils": "^7.27.1" + "@babel/helper-create-regexp-features-plugin": "^7.28.5", + "@babel/helper-plugin-utils": "^7.28.6" }, "engines": { "node": ">=6.9.0" @@ -1527,9 +1542,9 @@ } }, "node_modules/@babel/plugin-transform-regenerator": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-regenerator/-/plugin-transform-regenerator-7.28.6.tgz", - "integrity": "sha512-eZhoEZHYQLL5uc1gS5e9/oTknS0sSSAtd5TkKMUp3J+S/CaUjagc0kOUPsEbDmMeva0nC3WWl4SxVY6+OBuxfw==", + "version": "7.29.0", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-regenerator/-/plugin-transform-regenerator-7.29.0.tgz", + "integrity": "sha512-FijqlqMA7DmRdg/aINBSs04y8XNTYw/lr1gJ2WsmBnnaNw1iS43EPkJW+zK7z65auG3AWRFXWj+NcTQwYptUog==", "license": "MIT", "dependencies": { "@babel/helper-plugin-utils": "^7.28.6" @@ -1712,18 +1727,19 @@ } }, "node_modules/@babel/preset-env": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/preset-env/-/preset-env-7.28.6.tgz", - "integrity": "sha512-GaTI4nXDrs7l0qaJ6Rg06dtOXTBCG6TMDB44zbqofCIC4PqC7SEvmFFtpxzCDw9W5aJ7RKVshgXTLvLdBFV/qw==", + "version": "7.29.5", + "resolved": "https://registry.npmjs.org/@babel/preset-env/-/preset-env-7.29.5.tgz", + "integrity": "sha512-/69t2aEzGKHD76DyLbHysF/QH2LJOB8iFnYO37unDTKBTubzcMRv0f3H5EiN1Q6ajOd/eB7dAInF0qdFVS06kA==", "license": "MIT", "dependencies": { - "@babel/compat-data": "^7.28.6", + "@babel/compat-data": "^7.29.3", "@babel/helper-compilation-targets": "^7.28.6", "@babel/helper-plugin-utils": "^7.28.6", "@babel/helper-validator-option": "^7.27.1", "@babel/plugin-bugfix-firefox-class-in-computed-class-key": "^7.28.5", "@babel/plugin-bugfix-safari-class-field-initializer-scope": "^7.27.1", "@babel/plugin-bugfix-safari-id-destructuring-collision-in-function-expression": "^7.27.1", + "@babel/plugin-bugfix-safari-rest-destructuring-rhs-array": "^7.29.3", "@babel/plugin-bugfix-v8-spread-parameters-in-optional-chaining": "^7.27.1", "@babel/plugin-bugfix-v8-static-class-fields-redefine-readonly": "^7.28.6", "@babel/plugin-proposal-private-property-in-object": "7.21.0-placeholder-for-preset-env.2", @@ -1731,7 +1747,7 @@ "@babel/plugin-syntax-import-attributes": "^7.28.6", "@babel/plugin-syntax-unicode-sets-regex": "^7.18.6", "@babel/plugin-transform-arrow-functions": "^7.27.1", - "@babel/plugin-transform-async-generator-functions": "^7.28.6", + "@babel/plugin-transform-async-generator-functions": "^7.29.0", "@babel/plugin-transform-async-to-generator": "^7.28.6", "@babel/plugin-transform-block-scoped-functions": "^7.27.1", "@babel/plugin-transform-block-scoping": "^7.28.6", @@ -1742,7 +1758,7 @@ "@babel/plugin-transform-destructuring": "^7.28.5", "@babel/plugin-transform-dotall-regex": "^7.28.6", "@babel/plugin-transform-duplicate-keys": "^7.27.1", - "@babel/plugin-transform-duplicate-named-capturing-groups-regex": "^7.28.6", + "@babel/plugin-transform-duplicate-named-capturing-groups-regex": "^7.29.0", "@babel/plugin-transform-dynamic-import": "^7.27.1", "@babel/plugin-transform-explicit-resource-management": "^7.28.6", "@babel/plugin-transform-exponentiation-operator": "^7.28.6", @@ -1755,9 +1771,9 @@ "@babel/plugin-transform-member-expression-literals": "^7.27.1", "@babel/plugin-transform-modules-amd": "^7.27.1", "@babel/plugin-transform-modules-commonjs": "^7.28.6", - "@babel/plugin-transform-modules-systemjs": "^7.28.5", + "@babel/plugin-transform-modules-systemjs": "^7.29.4", "@babel/plugin-transform-modules-umd": "^7.27.1", - "@babel/plugin-transform-named-capturing-groups-regex": "^7.27.1", + "@babel/plugin-transform-named-capturing-groups-regex": "^7.29.0", "@babel/plugin-transform-new-target": "^7.27.1", "@babel/plugin-transform-nullish-coalescing-operator": "^7.28.6", "@babel/plugin-transform-numeric-separator": "^7.28.6", @@ -1769,7 +1785,7 @@ "@babel/plugin-transform-private-methods": "^7.28.6", "@babel/plugin-transform-private-property-in-object": "^7.28.6", "@babel/plugin-transform-property-literals": "^7.27.1", - "@babel/plugin-transform-regenerator": "^7.28.6", + "@babel/plugin-transform-regenerator": "^7.29.0", "@babel/plugin-transform-regexp-modifiers": "^7.28.6", "@babel/plugin-transform-reserved-words": "^7.27.1", "@babel/plugin-transform-shorthand-properties": "^7.27.1", @@ -1782,10 +1798,10 @@ "@babel/plugin-transform-unicode-regex": "^7.27.1", "@babel/plugin-transform-unicode-sets-regex": "^7.28.6", "@babel/preset-modules": "0.1.6-no-external-plugins", - "babel-plugin-polyfill-corejs2": "^0.4.14", - "babel-plugin-polyfill-corejs3": "^0.13.0", - "babel-plugin-polyfill-regenerator": "^0.6.5", - "core-js-compat": "^3.43.0", + "babel-plugin-polyfill-corejs2": "^0.4.15", + "babel-plugin-polyfill-corejs3": "^0.14.0", + "babel-plugin-polyfill-regenerator": "^0.6.6", + "core-js-compat": "^3.48.0", "semver": "^6.3.1" }, "engines": { @@ -1853,17 +1869,17 @@ } }, "node_modules/@babel/traverse": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/traverse/-/traverse-7.28.6.tgz", - "integrity": "sha512-fgWX62k02qtjqdSNTAGxmKYY/7FSL9WAS1o2Hu5+I5m9T0yxZzr4cnrfXQ/MX0rIifthCSs6FKTlzYbJcPtMNg==", + "version": "7.29.0", + "resolved": "https://registry.npmjs.org/@babel/traverse/-/traverse-7.29.0.tgz", + "integrity": "sha512-4HPiQr0X7+waHfyXPZpWPfWL/J7dcN1mx9gL6WdQVMbPnF3+ZhSMs8tCxN7oHddJE9fhNE7+lxdnlyemKfJRuA==", "license": "MIT", "dependencies": { - "@babel/code-frame": "^7.28.6", - "@babel/generator": "^7.28.6", + "@babel/code-frame": "^7.29.0", + "@babel/generator": "^7.29.0", "@babel/helper-globals": "^7.28.0", - "@babel/parser": "^7.28.6", + "@babel/parser": "^7.29.0", "@babel/template": "^7.28.6", - "@babel/types": "^7.28.6", + "@babel/types": "^7.29.0", "debug": "^4.3.1" }, "engines": { @@ -1871,9 +1887,9 @@ } }, "node_modules/@babel/types": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.28.6.tgz", - "integrity": "sha512-0ZrskXVEHSWIqZM/sQZ4EV3jZJXRkio/WCxaqKZP1g//CEWEPSfeZFcms4XeKBCHU0ZKnIkdJeU/kF+eRp5lBg==", + "version": "7.29.0", + "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.29.0.tgz", + "integrity": "sha512-LwdZHpScM4Qz8Xw2iKSzS+cfglZzJGvofQICy7W7v4caru4EaAmyUuO6BGrbyQ2mYV11W0U8j5mBhd14dd3B0A==", "license": "MIT", "dependencies": { "@babel/helper-string-parser": "^7.27.1", @@ -1903,6 +1919,7 @@ "integrity": "sha512-RbxnxAMf89Tp1dLhXMS7ceft/PGsDl1Ip7T20z5nZ+pwIAsQ1p2izPjVG69oCLv/jfQ7HDPHTWK0c9rcAWXN3A==", "dev": true, "license": "MIT", + "peer": true, "dependencies": { "@cacheable/utils": "^2.3.3", "@keyv/bigmap": "^1.3.0", @@ -1916,6 +1933,7 @@ "integrity": "sha512-WbzE9sdmQtKy8vrNPa9BRnwZh5UF4s1KTmSK0KUVLo3eff5BlQNNWDnFOouNpKfPKDnms9xynJjsMYjMaT/aFQ==", "dev": true, "license": "MIT", + "peer": true, "dependencies": { "hashery": "^1.4.0", "hookified": "^1.15.0" @@ -1944,6 +1962,7 @@ "integrity": "sha512-JsXDL70gQ+1Vc2W/KUFfkAJzgb4puKwwKehNLuB+HrNKWf91O736kGfxn4KujXCCSuh6mRRL4XEB0PkAFjWS0A==", "dev": true, "license": "MIT", + "peer": true, "dependencies": { "hashery": "^1.3.0", "keyv": "^5.5.5" @@ -1955,10 +1974,21 @@ "integrity": "sha512-CYDD3SOtsHtyXeEORYRx2qBtpDJFjRTGXUtmNEMGyzYOKj1TE3tycdlho7kA1Ufx9OYWZzg52QFBGALTirzDSw==", "dev": true, "license": "MIT", + "peer": true, "dependencies": { "@keyv/serialize": "^1.1.1" } }, + "node_modules/@colors/colors": { + "version": "1.5.0", + "resolved": "https://registry.npmjs.org/@colors/colors/-/colors-1.5.0.tgz", + "integrity": "sha512-ooWCrlZP11i8GImSjTHYHLkvFDP48nS4+204nGb1RiX/WXYHmJA2III9/e2DWVabCESdW7hBAEzHRqUn9OUVvQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.1.90" + } + }, "node_modules/@csstools/css-parser-algorithms": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/@csstools/css-parser-algorithms/-/css-parser-algorithms-4.0.0.tgz", @@ -1998,7 +2028,8 @@ "url": "https://opencollective.com/csstools" } ], - "license": "MIT-0" + "license": "MIT-0", + "peer": true }, "node_modules/@csstools/css-tokenizer": { "version": "4.0.0", @@ -2037,6 +2068,7 @@ } ], "license": "MIT", + "peer": true, "engines": { "node": ">=20.19.0" }, @@ -2061,6 +2093,7 @@ } ], "license": "MIT-0", + "peer": true, "engines": { "node": ">=20.19.0" }, @@ -2084,6 +2117,7 @@ } ], "license": "MIT-0", + "peer": true, "engines": { "node": ">=20.19.0" }, @@ -2150,8 +2184,7 @@ "version": "3.7.1", "resolved": "https://registry.npmjs.org/jquery/-/jquery-3.7.1.tgz", "integrity": "sha512-m4avr8yL8kmFN8psrbFFFmB/If14iN5o9nw/NgnnM+kybDJpRsAynV2BsfpTYrTRysYUdADVD7CkUUizgkpLfg==", - "license": "MIT", - "peer": true + "license": "MIT" }, "node_modules/@edx/edx-proctoring": { "version": "4.18.4", @@ -2287,7 +2320,6 @@ } ], "license": "MIT", - "peer": true, "engines": { "node": "^14 || ^16 || >=18" }, @@ -2311,7 +2343,6 @@ } ], "license": "MIT", - "peer": true, "engines": { "node": "^14 || ^16 || >=18" } @@ -2377,24 +2408,6 @@ "dev": true, "license": "MIT" }, - "node_modules/@edx/stylelint-config-edx/node_modules/brace-expansion": { - "version": "1.1.12", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.12.tgz", - "integrity": "sha512-9T9UjW3r0UW5c1Q7GTwllptXwhvYmEzFhzMfZ9H7FQWt+uZePjZPjBP/W1ZEyZ1twGWom5/56TF4lPcqjnDHcg==", - "dev": true, - "license": "MIT", - "dependencies": { - "balanced-match": "^1.0.0", - "concat-map": "0.0.1" - } - }, - "node_modules/@edx/stylelint-config-edx/node_modules/brace-expansion/node_modules/balanced-match": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz", - "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==", - "dev": true, - "license": "MIT" - }, "node_modules/@edx/stylelint-config-edx/node_modules/cosmiconfig": { "version": "8.3.6", "resolved": "https://registry.npmjs.org/cosmiconfig/-/cosmiconfig-8.3.6.tgz", @@ -2464,28 +2477,6 @@ "node": "^10.12.0 || >=12.0.0" } }, - "node_modules/@edx/stylelint-config-edx/node_modules/glob": { - "version": "7.2.3", - "resolved": "https://registry.npmjs.org/glob/-/glob-7.2.3.tgz", - "integrity": "sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q==", - "deprecated": "Glob versions prior to v9 are no longer supported", - "dev": true, - "license": "ISC", - "dependencies": { - "fs.realpath": "^1.0.0", - "inflight": "^1.0.4", - "inherits": "2", - "minimatch": "^3.1.1", - "once": "^1.3.0", - "path-is-absolute": "^1.0.0" - }, - "engines": { - "node": "*" - }, - "funding": { - "url": "https://github.com/sponsors/isaacs" - } - }, "node_modules/@edx/stylelint-config-edx/node_modules/globby": { "version": "11.1.0", "resolved": "https://registry.npmjs.org/globby/-/globby-11.1.0.tgz", @@ -2543,6 +2534,16 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/@edx/stylelint-config-edx/node_modules/is-fullwidth-code-point": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz", + "integrity": "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, "node_modules/@edx/stylelint-config-edx/node_modules/is-plain-object": { "version": "5.0.0", "resolved": "https://registry.npmjs.org/is-plain-object/-/is-plain-object-5.0.0.tgz", @@ -2618,19 +2619,6 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/@edx/stylelint-config-edx/node_modules/minimatch": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", - "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", - "dev": true, - "license": "ISC", - "dependencies": { - "brace-expansion": "^1.1.7" - }, - "engines": { - "node": "*" - } - }, "node_modules/@edx/stylelint-config-edx/node_modules/postcss-safe-parser": { "version": "6.0.0", "resolved": "https://registry.npmjs.org/postcss-safe-parser/-/postcss-safe-parser-6.0.0.tgz", @@ -2654,7 +2642,6 @@ "integrity": "sha512-Q8qQfPiZ+THO/3ZrOrO0cJJKfpYCagtMUkXbnEfmgUjwXg6z/WBeOyS9APBBPCTSiDV+s4SwQGu8yFsiMRIudg==", "dev": true, "license": "MIT", - "peer": true, "dependencies": { "cssesc": "^3.0.0", "util-deprecate": "^1.0.2" @@ -2680,23 +2667,6 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/@edx/stylelint-config-edx/node_modules/rimraf": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/rimraf/-/rimraf-3.0.2.tgz", - "integrity": "sha512-JZkJMZkAGFFPP2YqXZXPbMlMBgsxzE8ILs4lMIX/2o0L9UBw9O/Y3o6wFw/i9YLapcUJWwqbi3kdxIPdC62TIA==", - "deprecated": "Rimraf versions prior to v4 are no longer supported", - "dev": true, - "license": "ISC", - "dependencies": { - "glob": "^7.1.3" - }, - "bin": { - "rimraf": "bin.js" - }, - "funding": { - "url": "https://github.com/sponsors/isaacs" - } - }, "node_modules/@edx/stylelint-config-edx/node_modules/signal-exit": { "version": "4.1.0", "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-4.1.0.tgz", @@ -2728,6 +2698,21 @@ "url": "https://github.com/chalk/slice-ansi?sponsor=1" } }, + "node_modules/@edx/stylelint-config-edx/node_modules/string-width": { + "version": "4.2.3", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", + "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", + "dev": true, + "license": "MIT", + "dependencies": { + "emoji-regex": "^8.0.0", + "is-fullwidth-code-point": "^3.0.0", + "strip-ansi": "^6.0.1" + }, + "engines": { + "node": ">=8" + } + }, "node_modules/@edx/stylelint-config-edx/node_modules/strip-indent": { "version": "4.1.1", "resolved": "https://registry.npmjs.org/strip-indent/-/strip-indent-4.1.1.tgz", @@ -2747,7 +2732,6 @@ "integrity": "sha512-78O4c6IswZ9TzpcIiQJIN49K3qNoXTM8zEJzhaTE/xRTCZswaovSEVIa/uwbOltZrk16X4jAxjaOhzz/hTm1Kw==", "dev": true, "license": "MIT", - "peer": true, "dependencies": { "@csstools/css-parser-algorithms": "^2.3.1", "@csstools/css-tokenizer": "^2.2.0", @@ -2948,7 +2932,6 @@ "integrity": "sha512-YUcsLQKYb6DmaJjIHdDWpBIGCcyE/W+p/LMGvjQem55Mm2XWVAP5kWTMKWLv9lwpCVjpLxPyOMOyUocP1GxrtA==", "hasInstallScript": true, "license": "MIT", - "peer": true, "dependencies": { "@fortawesome/fontawesome-common-types": "^0.2.36" }, @@ -2983,102 +2966,6 @@ "react": ">=16.x" } }, - "node_modules/@isaacs/cliui": { - "version": "8.0.2", - "resolved": "https://registry.npmjs.org/@isaacs/cliui/-/cliui-8.0.2.tgz", - "integrity": "sha512-O8jcjabXaleOG9DQ0+ARXWZBTfnP4WNAqzuiJK7ll44AmxGKv/J2M4TPjxjY3znBCfvBXFzucm1twdyFybFqEA==", - "license": "ISC", - "dependencies": { - "string-width": "^5.1.2", - "string-width-cjs": "npm:string-width@^4.2.0", - "strip-ansi": "^7.0.1", - "strip-ansi-cjs": "npm:strip-ansi@^6.0.1", - "wrap-ansi": "^8.1.0", - "wrap-ansi-cjs": "npm:wrap-ansi@^7.0.0" - }, - "engines": { - "node": ">=12" - } - }, - "node_modules/@isaacs/cliui/node_modules/ansi-regex": { - "version": "6.2.2", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-6.2.2.tgz", - "integrity": "sha512-Bq3SmSpyFHaWjPk8If9yc6svM8c56dB5BAtW4Qbw5jHTwwXXcTLoRMkpDJp6VL0XzlWaCHTXrkFURMYmD0sLqg==", - "license": "MIT", - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/chalk/ansi-regex?sponsor=1" - } - }, - "node_modules/@isaacs/cliui/node_modules/ansi-styles": { - "version": "6.2.3", - "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-6.2.3.tgz", - "integrity": "sha512-4Dj6M28JB+oAH8kFkTLUo+a2jwOFkuqb3yucU0CANcRRUbxS0cP0nZYCGjcc3BNXwRIsUVmDGgzawme7zvJHvg==", - "license": "MIT", - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/chalk/ansi-styles?sponsor=1" - } - }, - "node_modules/@isaacs/cliui/node_modules/emoji-regex": { - "version": "9.2.2", - "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-9.2.2.tgz", - "integrity": "sha512-L18DaJsXSUk2+42pv8mLs5jJT2hqFkFE4j21wOmgbUqsZ2hL72NsUU785g9RXgo3s0ZNgVl42TiHp3ZtOv/Vyg==", - "license": "MIT" - }, - "node_modules/@isaacs/cliui/node_modules/string-width": { - "version": "5.1.2", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-5.1.2.tgz", - "integrity": "sha512-HnLOCR3vjcY8beoNLtcjZ5/nxn2afmME6lhrDrebokqMap+XbeW8n9TXpPDOqdGK5qcI3oT0GKTW6wC7EMiVqA==", - "license": "MIT", - "dependencies": { - "eastasianwidth": "^0.2.0", - "emoji-regex": "^9.2.2", - "strip-ansi": "^7.0.1" - }, - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/@isaacs/cliui/node_modules/strip-ansi": { - "version": "7.1.2", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-7.1.2.tgz", - "integrity": "sha512-gmBGslpoQJtgnMAvOVqGZpEz9dyoKTCzy2nfz/n8aIFhN/jCE/rCmcxabB6jOOHV+0WNnylOxaxBQPSvcWklhA==", - "license": "MIT", - "dependencies": { - "ansi-regex": "^6.0.1" - }, - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/chalk/strip-ansi?sponsor=1" - } - }, - "node_modules/@isaacs/cliui/node_modules/wrap-ansi": { - "version": "8.1.0", - "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-8.1.0.tgz", - "integrity": "sha512-si7QWI6zUMq56bESFvagtmzMdGOtoxfR+Sez11Mobfc7tm+VkUckk9bW2UeffTGVUbOksxmSw0AA2gs8g71NCQ==", - "license": "MIT", - "dependencies": { - "ansi-styles": "^6.1.0", - "string-width": "^5.0.1", - "strip-ansi": "^7.0.1" - }, - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/chalk/wrap-ansi?sponsor=1" - } - }, "node_modules/@isaacs/fs-minipass": { "version": "4.0.1", "resolved": "https://registry.npmjs.org/@isaacs/fs-minipass/-/fs-minipass-4.0.1.tgz", @@ -3338,39 +3225,6 @@ } } }, - "node_modules/@jest/reporters/node_modules/brace-expansion": { - "version": "1.1.12", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.12.tgz", - "integrity": "sha512-9T9UjW3r0UW5c1Q7GTwllptXwhvYmEzFhzMfZ9H7FQWt+uZePjZPjBP/W1ZEyZ1twGWom5/56TF4lPcqjnDHcg==", - "dev": true, - "license": "MIT", - "dependencies": { - "balanced-match": "^1.0.0", - "concat-map": "0.0.1" - } - }, - "node_modules/@jest/reporters/node_modules/glob": { - "version": "7.2.3", - "resolved": "https://registry.npmjs.org/glob/-/glob-7.2.3.tgz", - "integrity": "sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q==", - "deprecated": "Glob versions prior to v9 are no longer supported", - "dev": true, - "license": "ISC", - "dependencies": { - "fs.realpath": "^1.0.0", - "inflight": "^1.0.4", - "inherits": "2", - "minimatch": "^3.1.1", - "once": "^1.3.0", - "path-is-absolute": "^1.0.0" - }, - "engines": { - "node": "*" - }, - "funding": { - "url": "https://github.com/sponsors/isaacs" - } - }, "node_modules/@jest/reporters/node_modules/istanbul-lib-instrument": { "version": "6.0.3", "resolved": "https://registry.npmjs.org/istanbul-lib-instrument/-/istanbul-lib-instrument-6.0.3.tgz", @@ -3388,19 +3242,6 @@ "node": ">=10" } }, - "node_modules/@jest/reporters/node_modules/minimatch": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", - "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", - "dev": true, - "license": "ISC", - "dependencies": { - "brace-expansion": "^1.1.7" - }, - "engines": { - "node": "*" - } - }, "node_modules/@jest/reporters/node_modules/semver": { "version": "7.7.3", "resolved": "https://registry.npmjs.org/semver/-/semver-7.7.3.tgz", @@ -3577,7 +3418,8 @@ "resolved": "https://registry.npmjs.org/@keyv/serialize/-/serialize-1.1.1.tgz", "integrity": "sha512-dXn3FZhPv0US+7dtJsIi2R+c7qWYiReoEh5zUntWCf4oSpMNib8FDhSoed6m3QyZdx5hK7iLFkYk3rNxwt8vTA==", "dev": true, - "license": "MIT" + "license": "MIT", + "peer": true }, "node_modules/@nodelib/fs.scandir": { "version": "2.1.5", @@ -3617,87 +3459,6 @@ "node": ">= 8" } }, - "node_modules/@npmcli/agent": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/@npmcli/agent/-/agent-3.0.0.tgz", - "integrity": "sha512-S79NdEgDQd/NGCay6TCoVzXSj74skRZIKJcpJjC5lOq34SZzyI6MqtiiWoiVWoVrTcGjNeC4ipbh1VIHlpfF5Q==", - "license": "ISC", - "dependencies": { - "agent-base": "^7.1.0", - "http-proxy-agent": "^7.0.0", - "https-proxy-agent": "^7.0.1", - "lru-cache": "^10.0.1", - "socks-proxy-agent": "^8.0.3" - }, - "engines": { - "node": "^18.17.0 || >=20.5.0" - } - }, - "node_modules/@npmcli/agent/node_modules/agent-base": { - "version": "7.1.4", - "resolved": "https://registry.npmjs.org/agent-base/-/agent-base-7.1.4.tgz", - "integrity": "sha512-MnA+YT8fwfJPgBx3m60MNqakm30XOkyIoH1y6huTQvC0PwZG7ki8NacLBcrPbNoo8vEZy7Jpuk7+jMO+CUovTQ==", - "license": "MIT", - "engines": { - "node": ">= 14" - } - }, - "node_modules/@npmcli/agent/node_modules/http-proxy-agent": { - "version": "7.0.2", - "resolved": "https://registry.npmjs.org/http-proxy-agent/-/http-proxy-agent-7.0.2.tgz", - "integrity": "sha512-T1gkAiYYDWYx3V5Bmyu7HcfcvL7mUrTWiM6yOfa3PIphViJ/gFPbvidQ+veqSOHci/PxBcDabeUNCzpOODJZig==", - "license": "MIT", - "dependencies": { - "agent-base": "^7.1.0", - "debug": "^4.3.4" - }, - "engines": { - "node": ">= 14" - } - }, - "node_modules/@npmcli/agent/node_modules/https-proxy-agent": { - "version": "7.0.6", - "resolved": "https://registry.npmjs.org/https-proxy-agent/-/https-proxy-agent-7.0.6.tgz", - "integrity": "sha512-vK9P5/iUfdl95AI+JVyUuIcVtd4ofvtrOr3HNtM2yxC9bnMbEdp3x01OhQNnjb8IJYi38VlTE3mBXwcfvywuSw==", - "license": "MIT", - "dependencies": { - "agent-base": "^7.1.2", - "debug": "4" - }, - "engines": { - "node": ">= 14" - } - }, - "node_modules/@npmcli/agent/node_modules/lru-cache": { - "version": "10.4.3", - "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-10.4.3.tgz", - "integrity": "sha512-JNAzZcXrCt42VGLuYz0zfAzDfAvJWW6AfYlDBQyDV5DClI2m5sAmK+OIO7s59XfsRsWHp02jAJrRadPRGTt6SQ==", - "license": "ISC" - }, - "node_modules/@npmcli/fs": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/@npmcli/fs/-/fs-4.0.0.tgz", - "integrity": "sha512-/xGlezI6xfGO9NwuJlnwz/K14qD1kCSAGtacBHnGzeAIuJGazcp45KP5NuyARXoKb7cwulAGWVsbeSxdG/cb0Q==", - "license": "ISC", - "dependencies": { - "semver": "^7.3.5" - }, - "engines": { - "node": "^18.17.0 || >=20.5.0" - } - }, - "node_modules/@npmcli/fs/node_modules/semver": { - "version": "7.7.3", - "resolved": "https://registry.npmjs.org/semver/-/semver-7.7.3.tgz", - "integrity": "sha512-SdsKMrI9TdgjdweUSR9MweHA4EJ8YxHn8DFaDisvhVlUOe4BF1tLD7GAj0lIqWVl+dPb/rExr0Btby5loQm20Q==", - "license": "ISC", - "bin": { - "semver": "bin/semver.js" - }, - "engines": { - "node": ">=10" - } - }, "node_modules/@parcel/watcher": { "version": "2.5.6", "resolved": "https://registry.npmjs.org/@parcel/watcher/-/watcher-2.5.6.tgz", @@ -3994,29 +3755,6 @@ "url": "https://opencollective.com/parcel" } }, - "node_modules/@parcel/watcher/node_modules/is-extglob": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/is-extglob/-/is-extglob-2.1.1.tgz", - "integrity": "sha512-SbKbANkN603Vi4jEZv49LeVJMn4yGwsbzZworEoyEiutsN3nJYdbO36zfhGJ6QEDpOZIFkDtnq5JRxmvl3jsoQ==", - "license": "MIT", - "optional": true, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/@parcel/watcher/node_modules/is-glob": { - "version": "4.0.3", - "resolved": "https://registry.npmjs.org/is-glob/-/is-glob-4.0.3.tgz", - "integrity": "sha512-xelSayHH36ZgE7ZWhli7pW34hNbNl8Ojv5KVmkJD4hBdD3th8Tfk9vYasLM+mXWOZhFkgZfxhLSnrwRr4elSSg==", - "license": "MIT", - "optional": true, - "dependencies": { - "is-extglob": "^2.1.1" - }, - "engines": { - "node": ">=0.10.0" - } - }, "node_modules/@parcel/watcher/node_modules/picomatch": { "version": "4.0.3", "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-4.0.3.tgz", @@ -4030,16 +3768,6 @@ "url": "https://github.com/sponsors/jonschlinkert" } }, - "node_modules/@pkgjs/parseargs": { - "version": "0.11.0", - "resolved": "https://registry.npmjs.org/@pkgjs/parseargs/-/parseargs-0.11.0.tgz", - "integrity": "sha512-+1VkjdD0QBLPodGrJUeqarH8VAIvQODIbwh9XpP5Syisf7YoQgsJKPNFoqqLQlu+VQ/tVSshMR6loPMn8U+dPg==", - "license": "MIT", - "optional": true, - "engines": { - "node": ">=14" - } - }, "node_modules/@popperjs/core": { "version": "2.11.8", "resolved": "https://registry.npmjs.org/@popperjs/core/-/core-2.11.8.tgz", @@ -4083,6 +3811,7 @@ "integrity": "sha512-tlqY9xq5ukxTUZBmoOp+m61cqwQD5pHJtFY3Mn8CA8ps6yghLH/Hw8UPdqg4OLmFW3IFlcXnQNmo/dh8HzXYIQ==", "dev": true, "license": "MIT", + "peer": true, "engines": { "node": ">=18" }, @@ -4136,6 +3865,13 @@ "dev": true, "license": "(Unlicense OR Apache-2.0)" }, + "node_modules/@socket.io/component-emitter": { + "version": "3.1.2", + "resolved": "https://registry.npmjs.org/@socket.io/component-emitter/-/component-emitter-3.1.2.tgz", + "integrity": "sha512-9BCxFwvbGg/RsZK9tjXd8s4UcwR0MWeFQ1XEKIQVVvAGJyINdrqKMcTRyLoK8Rse1GjzLV9cwjWV1olXRWEXVA==", + "dev": true, + "license": "MIT" + }, "node_modules/@testing-library/dom": { "version": "10.4.1", "resolved": "https://registry.npmjs.org/@testing-library/dom/-/dom-10.4.1.tgz", @@ -4309,6 +4045,16 @@ "integrity": "sha512-LKVP3cgXBT9RYj+t+9FDKwS5tdI+rPBXaNSkma7hvqy35lc7mAokC2zsqWJH0LaqIt3B962nuYI77hsJoT1gow==", "license": "MIT" }, + "node_modules/@types/cors": { + "version": "2.8.19", + "resolved": "https://registry.npmjs.org/@types/cors/-/cors-2.8.19.tgz", + "integrity": "sha512-mFNylyeyqN93lfe/9CSxOGREz8cpzAhH+E93xJ4xWQf62V8sQ/24reV2nyzUWM6H6Xji+GGHpkbLe7pVoUEskg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/node": "*" + } + }, "node_modules/@types/eslint": { "version": "9.6.1", "resolved": "https://registry.npmjs.org/@types/eslint/-/eslint-9.6.1.tgz", @@ -4400,9 +4146,9 @@ "license": "MIT" }, "node_modules/@types/node": { - "version": "25.1.0", - "resolved": "https://registry.npmjs.org/@types/node/-/node-25.1.0.tgz", - "integrity": "sha512-t7frlewr6+cbx+9Ohpl0NOTKXZNV9xHRmNOvql47BFJKcEG1CxtxlPEEe+gR9uhVWM4DwhnvTF110mIL4yP9RA==", + "version": "25.2.0", + "resolved": "https://registry.npmjs.org/@types/node/-/node-25.2.0.tgz", + "integrity": "sha512-DZ8VwRFUNzuqJ5khrvwMXHmvPe+zGayJhr2CDNiKB1WBE1ST8Djl00D0IC4vvNmHMdj6DlbYRIaFE7WHjlDl5w==", "license": "MIT", "dependencies": { "undici-types": "~7.16.0" @@ -4426,7 +4172,6 @@ "resolved": "https://registry.npmjs.org/@types/react/-/react-17.0.90.tgz", "integrity": "sha512-P9beVR/x06U9rCJzSxtENnOr4BrbJ6VrsrDTc+73TtHv9XHhryXKbjGRB+6oooB2r0G/pQkD/S4dHo/7jUfwFw==", "license": "MIT", - "peer": true, "dependencies": { "@types/prop-types": "*", "@types/scheduler": "^0.16", @@ -4703,32 +4448,32 @@ "license": "BSD-3-Clause" }, "node_modules/abbrev": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/abbrev/-/abbrev-3.0.1.tgz", - "integrity": "sha512-AO2ac6pjRB3SJmGJo+v5/aK6Omggp6fsLrs6wN9bd35ulu4cCwaAU9+7ZhXjeqHVkaHThLuzH0nZr0YpCDhygg==", + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/abbrev/-/abbrev-4.0.0.tgz", + "integrity": "sha512-a1wflyaL0tHtJSmLSOVybYhy22vRih4eduhhrkcjgrWGnRfrZtovJ2FRjxuTtkkj47O/baf0R86QU5OuYpz8fA==", "license": "ISC", "engines": { - "node": "^18.17.0 || >=20.5.0" + "node": "^20.17.0 || >=22.9.0" } }, "node_modules/accepts": { - "version": "1.3.3", - "resolved": "https://registry.npmjs.org/accepts/-/accepts-1.3.3.tgz", - "integrity": "sha512-AOPopplFOUlmUugwiZUCDpOwmqvSgdCyE8iJVLWI4NcB7qfMKQN34dn5xYtlUU03XGG5egRWW4NW5gIxpa5hEA==", + "version": "1.3.8", + "resolved": "https://registry.npmjs.org/accepts/-/accepts-1.3.8.tgz", + "integrity": "sha512-PYAthTa2m2VKxuvSD3DPC/Gy+U+sOA1LAuT8mkmRuvw+NACSaeXEQ+NHcVF7rONl6qcaxV3Uuemwawk+7+SJLw==", "dev": true, "license": "MIT", "dependencies": { - "mime-types": "~2.1.11", - "negotiator": "0.6.1" + "mime-types": "~2.1.34", + "negotiator": "0.6.3" }, "engines": { "node": ">= 0.6" } }, "node_modules/accepts/node_modules/negotiator": { - "version": "0.6.1", - "resolved": "https://registry.npmjs.org/negotiator/-/negotiator-0.6.1.tgz", - "integrity": "sha512-qTxkr1RoLw5Pz+1+PTJ/66hWuyi2LEOeOuIDJDlx6JF8x75bmD5C7qXTg2UlX5W9rLfkqKP+r8q6Vy6NWdWrbw==", + "version": "0.6.3", + "resolved": "https://registry.npmjs.org/negotiator/-/negotiator-0.6.3.tgz", + "integrity": "sha512-+EUsqGPLsM+j/zdChZjsnX51g4XrHFOIXwfnCVPGlQk/k5giakcKsuxCObBRu6DSm9opw/O6slWbJdghQM4bBg==", "dev": true, "license": "MIT", "engines": { @@ -4736,11 +4481,10 @@ } }, "node_modules/acorn": { - "version": "8.15.0", - "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.15.0.tgz", - "integrity": "sha512-NZyJarBfL7nWwIq+FDL6Zp/yHEhePMNnnJ0y3qfieCrmNvYct8uvtiV41UvlSe6apAfk0fY1FbWx+NwfmpvtTg==", + "version": "8.16.0", + "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.16.0.tgz", + "integrity": "sha512-UVJyE9MttOsBQIDKw1skb9nAwQuR5wuGD3+82K6JgJlm/Y+KI92oNsMNGZCYdDsVtRHSak0pcV5Dno5+4jh9sw==", "license": "MIT", - "peer": true, "bin": { "acorn": "bin/acorn" }, @@ -4805,13 +4549,6 @@ "node": ">=0.4.0" } }, - "node_modules/after": { - "version": "0.8.2", - "resolved": "https://registry.npmjs.org/after/-/after-0.8.2.tgz", - "integrity": "sha512-QbJ0NTQ/I9DI3uSJA4cbexiwQeRAfjPScqIbSjUDd9TOrcg6pTkdgziesOqxBMBzit8vFCTwrP27t13vFOORRA==", - "dev": true, - "license": "MIT" - }, "node_modules/agent-base": { "version": "6.0.2", "resolved": "https://registry.npmjs.org/agent-base/-/agent-base-6.0.2.tgz", @@ -4859,7 +4596,6 @@ "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.17.1.tgz", "integrity": "sha512-B/gBuNg5SiMTrPkC+A2+cW0RszwxYmn6VYxB/inlBStS5nx6xHIt/ehKRhIMhqusl7a8LjQoZnjCs5vhwxOQ1g==", "license": "MIT", - "peer": true, "dependencies": { "fast-deep-equal": "^3.1.3", "fast-uri": "^3.0.1", @@ -4954,12 +4690,12 @@ } }, "node_modules/ansi-regex": { - "version": "5.0.1", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz", - "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==", + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-2.1.1.tgz", + "integrity": "sha512-TIGnTpdo+E3+pCyAluZvtED5p5wCqLdezCyhPZzKPcxvFplEt4i+W7OONCKgeZFT3+y5NZZfOOS/Bdcanm1MYA==", "license": "MIT", "engines": { - "node": ">=8" + "node": ">=0.10.0" } }, "node_modules/ansi-styles": { @@ -5022,6 +4758,12 @@ "node": ">=10" } }, + "node_modules/aria-hidden/node_modules/tslib": { + "version": "2.8.1", + "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.8.1.tgz", + "integrity": "sha512-oJFu94HQb+KVduSUQL7wnpmqnfmLsOA/nAh6b6EH0wCEoK0/mPeXU6c3wKDV83MkOuHPRHtSXKKU99IBazS/2w==", + "license": "0BSD" + }, "node_modules/aria-query": { "version": "5.3.0", "resolved": "https://registry.npmjs.org/aria-query/-/aria-query-5.3.0.tgz", @@ -5040,16 +4782,6 @@ "node": ">=0.10.0" } }, - "node_modules/arr-flatten": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/arr-flatten/-/arr-flatten-1.1.0.tgz", - "integrity": "sha512-L3hKV5R/p5o81R7O02IGnwpDmkp6E982XhtbuwSe3O4qOtMMMtodicASA1Cny2U+aCXcNpml+m4dPsvsJ3jatg==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, "node_modules/arr-union": { "version": "3.1.0", "resolved": "https://registry.npmjs.org/arr-union/-/arr-union-3.1.0.tgz", @@ -5075,16 +4807,6 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/array-slice": { - "version": "0.2.3", - "resolved": "https://registry.npmjs.org/array-slice/-/array-slice-0.2.3.tgz", - "integrity": "sha512-rlVfZW/1Ph2SNySXwR9QYkChp8EkOEiTMO5Vwx60usw04i4nWemkm9RXmQqgkQFaLHsqLuADvjp6IfgL9l2M8Q==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, "node_modules/array-union": { "version": "2.1.0", "resolved": "https://registry.npmjs.org/array-union/-/array-union-2.1.0.tgz", @@ -5095,16 +4817,6 @@ "node": ">=8" } }, - "node_modules/array-unique": { - "version": "0.2.1", - "resolved": "https://registry.npmjs.org/array-unique/-/array-unique-0.2.1.tgz", - "integrity": "sha512-G2n5bG5fSUCpnsXz4+8FUkYsGPkNfLn9YvS66U5qbTIXI2Ynnlo4Bi42bWv+omKUCqz+ejzfClwne0alJWJPhg==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, "node_modules/array.prototype.find": { "version": "2.2.3", "resolved": "https://registry.npmjs.org/array.prototype.find/-/array.prototype.find-2.2.3.tgz", @@ -5145,12 +4857,6 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/arraybuffer.slice": { - "version": "0.0.6", - "resolved": "https://registry.npmjs.org/arraybuffer.slice/-/arraybuffer.slice-0.0.6.tgz", - "integrity": "sha512-6ZjfQaBSy6CuIH0+B0NrxMfDE5VIOCP/5gOqSpEIsaAZx9/giszzrXg6PZ7G51U/n88UmlAgYLNQ9wAnII7PJA==", - "dev": true - }, "node_modules/arrify": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/arrify/-/arrify-1.0.1.tgz", @@ -5186,19 +4892,6 @@ "node": ">=8" } }, - "node_modules/async-each": { - "version": "1.0.6", - "resolved": "https://registry.npmjs.org/async-each/-/async-each-1.0.6.tgz", - "integrity": "sha512-c646jH1avxr+aVpndVMeAfYw7wAa6idufrlN3LPA4PmKS0QEGp6PIC9nwz0WQkkvBGAMEki3pFdtxaF39J9vvg==", - "dev": true, - "funding": [ - { - "type": "individual", - "url": "https://paulmillr.com/funding/" - } - ], - "license": "MIT" - }, "node_modules/async-function": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/async-function/-/async-function-1.0.0.tgz", @@ -5214,19 +4907,6 @@ "integrity": "sha512-Oei9OH4tRh0YqU3GxhX79dM/mwVgvbZJaSNaRk+bshkj0S5cfHcgYakreBjrHwatXKbz+IoIdYLxrKim2MjW0Q==", "license": "MIT" }, - "node_modules/atob": { - "version": "2.1.2", - "resolved": "https://registry.npmjs.org/atob/-/atob-2.1.2.tgz", - "integrity": "sha512-Wm6ukoaOGJi/73p/cl2GvLjTI5JM1k/O14isD73YML8StrH/7/lRFgmg8nICZgD3bZZvjwCGxtMOD3wWNAu8cg==", - "dev": true, - "license": "(MIT OR Apache-2.0)", - "bin": { - "atob": "bin/atob.js" - }, - "engines": { - "node": ">= 4.5.0" - } - }, "node_modules/available-typed-arrays": { "version": "1.0.7", "resolved": "https://registry.npmjs.org/available-typed-arrays/-/available-typed-arrays-1.0.7.tgz", @@ -5253,15 +4933,6 @@ "js-tokens": "^3.0.2" } }, - "node_modules/babel-code-frame/node_modules/ansi-regex": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-2.1.1.tgz", - "integrity": "sha512-TIGnTpdo+E3+pCyAluZvtED5p5wCqLdezCyhPZzKPcxvFplEt4i+W7OONCKgeZFT3+y5NZZfOOS/Bdcanm1MYA==", - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, "node_modules/babel-code-frame/node_modules/ansi-styles": { "version": "2.2.1", "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-2.2.1.tgz", @@ -5402,20 +5073,74 @@ } }, "node_modules/babel-loader": { - "version": "9.2.1", - "resolved": "https://registry.npmjs.org/babel-loader/-/babel-loader-9.2.1.tgz", - "integrity": "sha512-fqe8naHt46e0yIdkjUZYqddSXfej3AHajX+CSO5X7oy0EmPc6o5Xh+RClNoHjnieWz9AW4kZxW9yyFMhVB1QLA==", + "version": "10.1.1", + "resolved": "https://registry.npmjs.org/babel-loader/-/babel-loader-10.1.1.tgz", + "integrity": "sha512-JwKSzk2kjIe7mgPK+/lyZ2QAaJcpahNAdM+hgR2HI8D0OJVkdj8Rl6J3kaLYki9pwF7P2iWnD8qVv80Lq1ABtg==", "license": "MIT", "dependencies": { - "find-cache-dir": "^4.0.0", - "schema-utils": "^4.0.0" + "find-up": "^5.0.0" }, "engines": { - "node": ">= 14.15.0" + "node": "^18.20.0 || ^20.10.0 || >=22.0.0" }, "peerDependencies": { - "@babel/core": "^7.12.0", - "webpack": ">=5" + "@babel/core": "^7.12.0 || ^8.0.0-beta.1", + "@rspack/core": "^1.0.0 || ^2.0.0-0", + "webpack": ">=5.61.0" + }, + "peerDependenciesMeta": { + "@rspack/core": { + "optional": true + }, + "webpack": { + "optional": true + } + } + }, + "node_modules/babel-loader/node_modules/find-up": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/find-up/-/find-up-5.0.0.tgz", + "integrity": "sha512-78/PXT1wlLLDgTzDs7sjq9hzz0vXD+zn+7wypEe4fXQxCmdmqfGsEPQxmiCSQI3ajFV91bVSsvNtrJRiW6nGng==", + "license": "MIT", + "dependencies": { + "locate-path": "^6.0.0", + "path-exists": "^4.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/babel-loader/node_modules/locate-path": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-6.0.0.tgz", + "integrity": "sha512-iPZK6eYjbxRu3uB4/WZ3EsEIMJFMqAoopl3R+zuq0UjcAm/MO6KCweDgPfP3elTztoKP3KtnVHxTn2NHBSDVUw==", + "license": "MIT", + "dependencies": { + "p-locate": "^5.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/babel-loader/node_modules/p-locate": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-5.0.0.tgz", + "integrity": "sha512-LaNjtRWUBY++zB5nE/NwcaoMylSPk+S+ZHNB1TzdbMJMny6dynpAGt7X/tl/QYq3TIeE6nxHppbo2LGymrG5Pw==", + "license": "MIT", + "dependencies": { + "p-limit": "^3.0.2" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/babel-messages": { @@ -5569,13 +5294,13 @@ } }, "node_modules/babel-plugin-polyfill-corejs3": { - "version": "0.13.0", - "resolved": "https://registry.npmjs.org/babel-plugin-polyfill-corejs3/-/babel-plugin-polyfill-corejs3-0.13.0.tgz", - "integrity": "sha512-U+GNwMdSFgzVmfhNm8GJUX88AadB3uo9KpJqS3FaqNIPKgySuvMb+bHPsOmmuWyIcuqZj/pzt1RUIUZns4y2+A==", + "version": "0.14.0", + "resolved": "https://registry.npmjs.org/babel-plugin-polyfill-corejs3/-/babel-plugin-polyfill-corejs3-0.14.0.tgz", + "integrity": "sha512-AvDcMxJ34W4Wgy4KBIIePQTAOP1Ie2WFwkQp3dB7FQ/f0lI5+nM96zUnYEOE1P9sEg0es5VCP0HxiWu5fUHZAQ==", "license": "MIT", "dependencies": { - "@babel/helper-define-polyfill-provider": "^0.6.5", - "core-js-compat": "^3.43.0" + "@babel/helper-define-polyfill-provider": "^0.6.6", + "core-js-compat": "^3.48.0" }, "peerDependencies": { "@babel/core": "^7.4.0 || ^8.0.0-0 <8.0.0" @@ -5879,68 +5604,21 @@ "underscore": "^1.8.0" } }, - "node_modules/backo2": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/backo2/-/backo2-1.0.2.tgz", - "integrity": "sha512-zj6Z6M7Eq+PBZ7PQxl5NT665MvJdAkzp0f60nAJ+sLaSCBPMwVak5ZegFbgVCzFcCJTKFoMizvM5Ld7+JrRJHA==", - "dev": true, - "license": "MIT" - }, "node_modules/balanced-match": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz", "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==", - "license": "MIT" - }, - "node_modules/base": { - "version": "0.11.2", - "resolved": "https://registry.npmjs.org/base/-/base-0.11.2.tgz", - "integrity": "sha512-5T6P4xPgpp0YDFvSWwEZ4NoE3aM4QBQXDzmVbraCkFj8zHM+mba8SyqB5DbZWyR7mYHo6Y7BdQo3MoA4m0TeQg==", - "dev": true, - "license": "MIT", - "dependencies": { - "cache-base": "^1.0.1", - "class-utils": "^0.3.5", - "component-emitter": "^1.2.1", - "define-property": "^1.0.0", - "isobject": "^3.0.1", - "mixin-deep": "^1.2.0", - "pascalcase": "^0.1.1" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/base/node_modules/define-property": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/define-property/-/define-property-1.0.0.tgz", - "integrity": "sha512-cZTYKFWspt9jZsMscWo8sc/5lbPC9Q0N5nBLgb+Yd915iL3udB1uFgS3B8YCx66UVHq018DAVFoee7x+gxggeA==", - "dev": true, - "license": "MIT", - "dependencies": { - "is-descriptor": "^1.0.0" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/base64-arraybuffer": { - "version": "0.1.5", - "resolved": "https://registry.npmjs.org/base64-arraybuffer/-/base64-arraybuffer-0.1.5.tgz", - "integrity": "sha512-437oANT9tP582zZMwSvZGy2nmSeAb8DW2me3y+Uv1Wp2Rulr8Mqlyrv3E7MLxmsiaPSMMDmiDVzgE+e8zlMx9g==", "dev": true, - "engines": { - "node": ">= 0.6.0" - } + "license": "MIT" }, "node_modules/base64id": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/base64id/-/base64id-1.0.0.tgz", - "integrity": "sha512-rz8L+d/xByiB/vLVftPkyY215fqNrmasrcJsYkVcm4TgJNz+YXKrFaFAWibSaHkiKoSgMDCb+lipOIRQNGYesw==", + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/base64id/-/base64id-2.0.0.tgz", + "integrity": "sha512-lGe34o6EHj9y3Kts9R4ZYs/Gr+6N7MCaMlIFA3F1R2O5/m7K06AxfSeO5530PEERE6/WyEg3lsuyw4GHlPZHog==", "dev": true, "license": "MIT", "engines": { - "node": ">= 0.4.0" + "node": "^4.5.0 || >= 5.9" } }, "node_modules/baseline-browser-mapping": { @@ -5952,24 +5630,6 @@ "baseline-browser-mapping": "dist/cli.js" } }, - "node_modules/batch": { - "version": "0.5.3", - "resolved": "https://registry.npmjs.org/batch/-/batch-0.5.3.tgz", - "integrity": "sha512-aQgHPLH2DHpFTpBl5/GiVdNzHEqsLCSs1RiPvqkKP1+7RkNJlv71kL8/KXmvvaLqoZ7ylmvqkZhLjjAoRz8Xgw==", - "dev": true - }, - "node_modules/better-assert": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/better-assert/-/better-assert-1.0.2.tgz", - "integrity": "sha512-bYeph2DFlpK1XmGs6fvlLRUN29QISM3GBuUwSFsMY2XRx4AvC0WNCS57j4c/xGrK2RS24C1w3YoBOsw9fT46tQ==", - "dev": true, - "dependencies": { - "callsite": "1.0.0" - }, - "engines": { - "node": "*" - } - }, "node_modules/big.js": { "version": "5.2.2", "resolved": "https://registry.npmjs.org/big.js/-/big.js-5.2.2.tgz", @@ -5980,39 +5640,18 @@ } }, "node_modules/binary-extensions": { - "version": "1.13.1", - "resolved": "https://registry.npmjs.org/binary-extensions/-/binary-extensions-1.13.1.tgz", - "integrity": "sha512-Un7MIEDdUC5gNpcGDV97op1Ywk748MpHcFTHoYs6qnj1Z3j7I53VG3nwZhKzoBZmbdRNnb6WRdFlwl7tSDuZGw==", + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/binary-extensions/-/binary-extensions-2.3.0.tgz", + "integrity": "sha512-Ceh+7ox5qe7LJuLHoY0feh3pHuUDHAcRUeyL2VYghZwfpkNIy/+8Ocg0a3UuSoYzavmylwuLWQOf3hl0jjMMIw==", "dev": true, "license": "MIT", "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/bindings": { - "version": "1.5.0", - "resolved": "https://registry.npmjs.org/bindings/-/bindings-1.5.0.tgz", - "integrity": "sha512-p2q/t/mhvuOj/UeLlV6566GD/guowlr0hHxClI0W9m7MWYkL1F0hLo+0Aexs9HSPCtR1SXQ0TD3MMKrXZajbiQ==", - "dev": true, - "license": "MIT", - "optional": true, - "dependencies": { - "file-uri-to-path": "1.0.0" + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/blob": { - "version": "0.0.4", - "resolved": "https://registry.npmjs.org/blob/-/blob-0.0.4.tgz", - "integrity": "sha512-YRc9zvVz4wNaxcXmiSgb9LAg7YYwqQ2xd0Sj6osfA7k/PKmIGVlnOYs3wOFdkRC9/JpQu8sGt/zHgJV7xzerfg==", - "dev": true - }, - "node_modules/bluebird": { - "version": "2.11.0", - "resolved": "https://registry.npmjs.org/bluebird/-/bluebird-2.11.0.tgz", - "integrity": "sha512-UfFSr22dmHPQqPP9XWHRhq+gWnHCYguQGkXQlbyPtW5qTnhFWA8/iXg765tH0cAjy7l/zPJ1aBTO0g5XgA7kvQ==", - "dev": true, - "license": "MIT" - }, "node_modules/body-parser": { "version": "1.20.4", "resolved": "https://registry.npmjs.org/body-parser/-/body-parser-1.20.4.tgz", @@ -6048,19 +5687,6 @@ "ms": "2.0.0" } }, - "node_modules/body-parser/node_modules/iconv-lite": { - "version": "0.4.24", - "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.4.24.tgz", - "integrity": "sha512-v3MXnZAcvnywkTUEZomIActle7RXXeedOR31wwl7VlyoXO4Qi9arvSenNQWne1TcRwhCL1HwLI21bEqdpj8/rA==", - "dev": true, - "license": "MIT", - "dependencies": { - "safer-buffer": ">= 2.1.2 < 3" - }, - "engines": { - "node": ">=0.10.0" - } - }, "node_modules/body-parser/node_modules/ms": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", @@ -6083,24 +5709,26 @@ } }, "node_modules/brace-expansion": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.2.tgz", - "integrity": "sha512-Jt0vHyM+jmUBqojB7E1NIYadt0vI0Qxjxd2TErW94wDz+E2LAm5vKMXXwg6ZZBTHPuUlDgQHKXvjGBdfcF1ZDQ==", + "version": "1.1.12", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.12.tgz", + "integrity": "sha512-9T9UjW3r0UW5c1Q7GTwllptXwhvYmEzFhzMfZ9H7FQWt+uZePjZPjBP/W1ZEyZ1twGWom5/56TF4lPcqjnDHcg==", + "dev": true, "license": "MIT", "dependencies": { - "balanced-match": "^1.0.0" + "balanced-match": "^1.0.0", + "concat-map": "0.0.1" } }, "node_modules/braces": { - "version": "0.1.5", - "resolved": "https://registry.npmjs.org/braces/-/braces-0.1.5.tgz", - "integrity": "sha512-EIMHIv2UXHWFY2xubUGKz+hq9hNkENj4Pjvr7h58cmJgpkK2yMlKA8I484f7MSttkzVAy/lL7X9xDaILd6avzA==", - "dev": true, + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.3.tgz", + "integrity": "sha512-yQbXgO/OSZVD2IsiLlro+7Hf6Q18EJrKSEsdoMzKePKXct3gvD8oLcOQdIzGupr5Fj+EDe8gO/lxc1BzfMpxvA==", + "license": "MIT", "dependencies": { - "expand-range": "^0.1.0" + "fill-range": "^7.1.1" }, "engines": { - "node": ">=0.10.0" + "node": ">=8" } }, "node_modules/browserslist": { @@ -6122,7 +5750,6 @@ } ], "license": "MIT", - "peer": true, "dependencies": { "baseline-browser-mapping": "^2.9.0", "caniuse-lite": "^1.0.30001759", @@ -6147,31 +5774,6 @@ "node-int64": "^0.4.0" } }, - "node_modules/buffer-alloc": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/buffer-alloc/-/buffer-alloc-1.2.0.tgz", - "integrity": "sha512-CFsHQgjtW1UChdXgbyJGtnm+O/uLQeZdtbDo8mfUgYXCHSM1wgrVxXm6bSyrUuErEb+4sYVGCzASBRot7zyrow==", - "dev": true, - "license": "MIT", - "dependencies": { - "buffer-alloc-unsafe": "^1.1.0", - "buffer-fill": "^1.0.0" - } - }, - "node_modules/buffer-alloc-unsafe": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/buffer-alloc-unsafe/-/buffer-alloc-unsafe-1.1.0.tgz", - "integrity": "sha512-TEM2iMIEQdJ2yjPJoSIsldnleVaAk1oW3DBVUykyOLsEsFmEc9kn+SFFPz+gl54KQNxlDnAwCXosOS9Okx2xAg==", - "dev": true, - "license": "MIT" - }, - "node_modules/buffer-fill": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/buffer-fill/-/buffer-fill-1.0.0.tgz", - "integrity": "sha512-T7zexNBwiiaCOGDg9xNX9PBmjrubblRkENuptryuI64URkXDFum9il/JGL8Lm8wYfAXpredVXXZz7eMHilimiQ==", - "dev": true, - "license": "MIT" - }, "node_modules/buffer-from": { "version": "1.1.2", "resolved": "https://registry.npmjs.org/buffer-from/-/buffer-from-1.1.2.tgz", @@ -6188,97 +5790,13 @@ "node": ">= 0.8" } }, - "node_modules/cacache": { - "version": "19.0.1", - "resolved": "https://registry.npmjs.org/cacache/-/cacache-19.0.1.tgz", - "integrity": "sha512-hdsUxulXCi5STId78vRVYEtDAjq99ICAUktLTeTYsLoTE6Z8dS0c8pWNCxwdrk9YfJeobDZc2Y186hD/5ZQgFQ==", - "license": "ISC", - "dependencies": { - "@npmcli/fs": "^4.0.0", - "fs-minipass": "^3.0.0", - "glob": "^10.2.2", - "lru-cache": "^10.0.1", - "minipass": "^7.0.3", - "minipass-collect": "^2.0.1", - "minipass-flush": "^1.0.5", - "minipass-pipeline": "^1.2.4", - "p-map": "^7.0.2", - "ssri": "^12.0.0", - "tar": "^7.4.3", - "unique-filename": "^4.0.0" - }, - "engines": { - "node": "^18.17.0 || >=20.5.0" - } - }, - "node_modules/cacache/node_modules/glob": { - "version": "10.5.0", - "resolved": "https://registry.npmjs.org/glob/-/glob-10.5.0.tgz", - "integrity": "sha512-DfXN8DfhJ7NH3Oe7cFmu3NCu1wKbkReJ8TorzSAFbSKrlNaQSKfIzqYqVY8zlbs2NLBbWpRiU52GX2PbaBVNkg==", - "license": "ISC", - "dependencies": { - "foreground-child": "^3.1.0", - "jackspeak": "^3.1.2", - "minimatch": "^9.0.4", - "minipass": "^7.1.2", - "package-json-from-dist": "^1.0.0", - "path-scurry": "^1.11.1" - }, - "bin": { - "glob": "dist/esm/bin.mjs" - }, - "funding": { - "url": "https://github.com/sponsors/isaacs" - } - }, - "node_modules/cacache/node_modules/lru-cache": { - "version": "10.4.3", - "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-10.4.3.tgz", - "integrity": "sha512-JNAzZcXrCt42VGLuYz0zfAzDfAvJWW6AfYlDBQyDV5DClI2m5sAmK+OIO7s59XfsRsWHp02jAJrRadPRGTt6SQ==", - "license": "ISC" - }, - "node_modules/cacache/node_modules/minimatch": { - "version": "9.0.5", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.5.tgz", - "integrity": "sha512-G6T0ZX48xgozx7587koeX9Ys2NYy6Gmv//P89sEte9V9whIapMNF4idKxnW2QtCcLiTWlb/wfCabAtAFWhhBow==", - "license": "ISC", - "dependencies": { - "brace-expansion": "^2.0.1" - }, - "engines": { - "node": ">=16 || 14 >=14.17" - }, - "funding": { - "url": "https://github.com/sponsors/isaacs" - } - }, - "node_modules/cache-base": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/cache-base/-/cache-base-1.0.1.tgz", - "integrity": "sha512-AKcdTnFSWATd5/GCPRxr2ChwIJ85CeyrEyjRHlKxQ56d4XJMGym0uAiKn0xbLOGOl3+yRpOTi484dVCEc5AUzQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "collection-visit": "^1.0.0", - "component-emitter": "^1.2.1", - "get-value": "^2.0.6", - "has-value": "^1.0.0", - "isobject": "^3.0.1", - "set-value": "^2.0.0", - "to-object-path": "^0.3.0", - "union-value": "^1.0.0", - "unset-value": "^1.0.0" - }, - "engines": { - "node": ">=0.10.0" - } - }, "node_modules/cacheable": { "version": "2.3.2", "resolved": "https://registry.npmjs.org/cacheable/-/cacheable-2.3.2.tgz", "integrity": "sha512-w+ZuRNmex9c1TR9RcsxbfTKCjSL0rh1WA5SABbrWprIHeNBdmyQLSYonlDy9gpD+63XT8DgZ/wNh1Smvc9WnJA==", "dev": true, "license": "MIT", + "peer": true, "dependencies": { "@cacheable/memory": "^2.0.7", "@cacheable/utils": "^2.3.3", @@ -6293,6 +5811,7 @@ "integrity": "sha512-CYDD3SOtsHtyXeEORYRx2qBtpDJFjRTGXUtmNEMGyzYOKj1TE3tycdlho7kA1Ufx9OYWZzg52QFBGALTirzDSw==", "dev": true, "license": "MIT", + "peer": true, "dependencies": { "@keyv/serialize": "^1.1.1" } @@ -6367,15 +5886,6 @@ "node": ">=0.10.0" } }, - "node_modules/callsite": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/callsite/-/callsite-1.0.0.tgz", - "integrity": "sha512-0vdNRFXn5q+dtOqjfFtmtlI9N2eVZ7LMyEV2iKC5mEEFvSg/69Ml6b/WU2qF8W1nLRa0wiSrDT3Y5jOHZCwKPQ==", - "dev": true, - "engines": { - "node": "*" - } - }, "node_modules/callsites": { "version": "3.1.0", "resolved": "https://registry.npmjs.org/callsites/-/callsites-3.1.0.tgz", @@ -6451,9 +5961,9 @@ } }, "node_modules/caniuse-lite": { - "version": "1.0.30001766", - "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001766.tgz", - "integrity": "sha512-4C0lfJ0/YPjJQHagaE9x2Elb69CIqEPZeG0anQt9SIvIoOH4a4uaRl73IavyO+0qZh6MDLH//DrXThEYKHkmYA==", + "version": "1.0.30001767", + "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001767.tgz", + "integrity": "sha512-34+zUAMhSH+r+9eKmYG+k2Rpt8XttfE4yXAjoZvkAPs15xcYQhyBYdalJ65BzivAvGRMViEjy6oKr/S91loekQ==", "funding": [ { "type": "opencollective", @@ -6506,126 +6016,28 @@ } }, "node_modules/chokidar": { - "version": "1.7.0", - "resolved": "https://registry.npmjs.org/chokidar/-/chokidar-1.7.0.tgz", - "integrity": "sha512-mk8fAWcRUOxY7btlLtitj3A45jOwSAxH4tOFOoEGbVsl6cL6pPMWUy7dwZ/canfj3QEdP6FHSnf/l1c6/WkzVg==", - "dev": true, - "license": "MIT", - "dependencies": { - "anymatch": "^1.3.0", - "async-each": "^1.0.0", - "glob-parent": "^2.0.0", - "inherits": "^2.0.1", - "is-binary-path": "^1.0.0", - "is-glob": "^2.0.0", - "path-is-absolute": "^1.0.0", - "readdirp": "^2.0.0" - }, - "optionalDependencies": { - "fsevents": "^1.0.0" - } - }, - "node_modules/chokidar/node_modules/anymatch": { - "version": "1.3.2", - "resolved": "https://registry.npmjs.org/anymatch/-/anymatch-1.3.2.tgz", - "integrity": "sha512-0XNayC8lTHQ2OI8aljNCN3sSx6hsr/1+rlcDAotXJR7C1oZZHCNsfpbKwMjRA3Uqb5tF1Rae2oloTr4xpq+WjA==", - "dev": true, - "license": "ISC", - "dependencies": { - "micromatch": "^2.1.5", - "normalize-path": "^2.0.0" - } - }, - "node_modules/chokidar/node_modules/arr-diff": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/arr-diff/-/arr-diff-2.0.0.tgz", - "integrity": "sha512-dtXTVMkh6VkEEA7OhXnN1Ecb8aAGFdZ1LFxtOCoqj4qkyOJMt7+qs6Ahdy6p/NQCPYsRSXXivhSB/J5E9jmYKA==", - "dev": true, - "license": "MIT", - "dependencies": { - "arr-flatten": "^1.0.1" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/chokidar/node_modules/braces": { - "version": "1.8.5", - "resolved": "https://registry.npmjs.org/braces/-/braces-1.8.5.tgz", - "integrity": "sha512-xU7bpz2ytJl1bH9cgIurjpg/n8Gohy9GTw81heDYLJQ4RU60dlyJsa+atVF2pI0yMMvKxI9HkKwjePCj5XI1hw==", - "dev": true, - "license": "MIT", - "dependencies": { - "expand-range": "^1.8.1", - "preserve": "^0.2.0", - "repeat-element": "^1.1.2" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/chokidar/node_modules/expand-range": { - "version": "1.8.2", - "resolved": "https://registry.npmjs.org/expand-range/-/expand-range-1.8.2.tgz", - "integrity": "sha512-AFASGfIlnIbkKPQwX1yHaDjFvh/1gyKJODme52V6IORh69uEYgZp0o9C+qsIGNVEiuuhQU0CSSl++Rlegg1qvA==", - "dev": true, - "license": "MIT", - "dependencies": { - "fill-range": "^2.1.0" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/chokidar/node_modules/kind-of": { - "version": "3.2.2", - "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-3.2.2.tgz", - "integrity": "sha512-NOW9QQXMoZGg/oqnVNoNTTIFEIid1627WCffUBJEdMxYApq7mNE7CpzucIPc+ZQg25Phej7IJSmX3hO+oblOtQ==", + "version": "3.6.0", + "resolved": "https://registry.npmjs.org/chokidar/-/chokidar-3.6.0.tgz", + "integrity": "sha512-7VT13fmjotKpGipCW9JEQAusEPE+Ei8nl6/g4FBAmIm0GOOLMua9NDDo/DWp0ZAxCr3cPq5ZpBqmPAQgDda2Pw==", "dev": true, "license": "MIT", "dependencies": { - "is-buffer": "^1.1.5" + "anymatch": "~3.1.2", + "braces": "~3.0.2", + "glob-parent": "~5.1.2", + "is-binary-path": "~2.1.0", + "is-glob": "~4.0.1", + "normalize-path": "~3.0.0", + "readdirp": "~3.6.0" }, "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/chokidar/node_modules/micromatch": { - "version": "2.3.11", - "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-2.3.11.tgz", - "integrity": "sha512-LnU2XFEk9xxSJ6rfgAry/ty5qwUTyHYOBU0g4R6tIw5ljwgGIBmiKhRWLw5NpMOnrgUNcDJ4WMp8rl3sYVHLNA==", - "dev": true, - "license": "MIT", - "dependencies": { - "arr-diff": "^2.0.0", - "array-unique": "^0.2.1", - "braces": "^1.8.2", - "expand-brackets": "^0.1.4", - "extglob": "^0.3.1", - "filename-regex": "^2.0.0", - "is-extglob": "^1.0.0", - "is-glob": "^2.0.1", - "kind-of": "^3.0.2", - "normalize-path": "^2.0.1", - "object.omit": "^2.0.0", - "parse-glob": "^3.0.4", - "regex-cache": "^0.4.2" + "node": ">= 8.10.0" }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/chokidar/node_modules/normalize-path": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/normalize-path/-/normalize-path-2.1.1.tgz", - "integrity": "sha512-3pKJwH184Xo/lnH6oyP1q2pMd7HcypqqmRs91/6/i2CGtWwIKGCkOOMTm/zXbgTEWHw1uNpNi/igc3ePOYHb6w==", - "dev": true, - "license": "MIT", - "dependencies": { - "remove-trailing-separator": "^1.0.1" + "funding": { + "url": "https://paulmillr.com/funding/" }, - "engines": { - "node": ">=0.10.0" + "optionalDependencies": { + "fsevents": "~2.3.2" } }, "node_modules/chownr": { @@ -6676,49 +6088,6 @@ "dev": true, "license": "MIT" }, - "node_modules/class-utils": { - "version": "0.3.6", - "resolved": "https://registry.npmjs.org/class-utils/-/class-utils-0.3.6.tgz", - "integrity": "sha512-qOhPa/Fj7s6TY8H8esGu5QNpMMQxz79h+urzrNYN6mn+9BnxlDGf5QZ+XeCDsxSjPqsSR56XOZOJmpeurnLMeg==", - "dev": true, - "license": "MIT", - "dependencies": { - "arr-union": "^3.1.0", - "define-property": "^0.2.5", - "isobject": "^3.0.0", - "static-extend": "^0.1.1" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/class-utils/node_modules/define-property": { - "version": "0.2.5", - "resolved": "https://registry.npmjs.org/define-property/-/define-property-0.2.5.tgz", - "integrity": "sha512-Rr7ADjQZenceVOAKop6ALkkRAmH1A4Gx9hV/7ZujPUN2rkATqFO0JZLZInbAjpZYoJ1gUx8MRMQVkYemcbMSTA==", - "dev": true, - "license": "MIT", - "dependencies": { - "is-descriptor": "^0.1.0" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/class-utils/node_modules/is-descriptor": { - "version": "0.1.7", - "resolved": "https://registry.npmjs.org/is-descriptor/-/is-descriptor-0.1.7.tgz", - "integrity": "sha512-C3grZTvObeN1xud4cRWl366OMXZTj0+HGyk4hvfpx4ZHt1Pb60ANSXqCK7pdOTeUQpRzECBSTphqvD7U+l22Eg==", - "dev": true, - "license": "MIT", - "dependencies": { - "is-accessor-descriptor": "^1.0.1", - "is-data-descriptor": "^1.0.1" - }, - "engines": { - "node": ">= 0.4" - } - }, "node_modules/classnames": { "version": "2.5.1", "resolved": "https://registry.npmjs.org/classnames/-/classnames-2.5.1.tgz", @@ -6739,51 +6108,25 @@ "node": ">=0.2.5" } }, - "node_modules/cli/node_modules/brace-expansion": { - "version": "1.1.12", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.12.tgz", - "integrity": "sha512-9T9UjW3r0UW5c1Q7GTwllptXwhvYmEzFhzMfZ9H7FQWt+uZePjZPjBP/W1ZEyZ1twGWom5/56TF4lPcqjnDHcg==", + "node_modules/cli-cursor": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/cli-cursor/-/cli-cursor-1.0.2.tgz", + "integrity": "sha512-25tABq090YNKkF6JH7lcwO0zFJTRke4Jcq9iX2nr/Sz0Cjjv4gckmwlW6Ty/aoyFd6z3ysR2hMGC2GFugmBo6A==", "dev": true, "license": "MIT", "dependencies": { - "balanced-match": "^1.0.0", - "concat-map": "0.0.1" - } - }, - "node_modules/cli/node_modules/glob": { - "version": "7.2.3", - "resolved": "https://registry.npmjs.org/glob/-/glob-7.2.3.tgz", - "integrity": "sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q==", - "deprecated": "Glob versions prior to v9 are no longer supported", - "dev": true, - "license": "ISC", - "dependencies": { - "fs.realpath": "^1.0.0", - "inflight": "^1.0.4", - "inherits": "2", - "minimatch": "^3.1.1", - "once": "^1.3.0", - "path-is-absolute": "^1.0.0" + "restore-cursor": "^1.0.1" }, "engines": { - "node": "*" - }, - "funding": { - "url": "https://github.com/sponsors/isaacs" + "node": ">=0.10.0" } }, - "node_modules/cli/node_modules/minimatch": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", - "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", + "node_modules/cli-width": { + "version": "2.2.1", + "resolved": "https://registry.npmjs.org/cli-width/-/cli-width-2.2.1.tgz", + "integrity": "sha512-GRMWDxpOB6Dgk2E5Uo+3eEBvtOOlimMmpbFiKuLFnQzYDavtLFY3K5ona41jgN/WdRZtG7utuVSVTL4HbZHGkw==", "dev": true, - "license": "ISC", - "dependencies": { - "brace-expansion": "^1.1.7" - }, - "engines": { - "node": "*" - } + "license": "ISC" }, "node_modules/cliui": { "version": "8.0.1", @@ -6800,22 +6143,29 @@ "node": ">=12" } }, - "node_modules/cliui/node_modules/wrap-ansi": { - "version": "7.0.0", - "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-7.0.0.tgz", - "integrity": "sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q==", + "node_modules/cliui/node_modules/is-fullwidth-code-point": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz", + "integrity": "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/cliui/node_modules/string-width": { + "version": "4.2.3", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", + "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", "dev": true, "license": "MIT", "dependencies": { - "ansi-styles": "^4.0.0", - "string-width": "^4.1.0", - "strip-ansi": "^6.0.0" + "emoji-regex": "^8.0.0", + "is-fullwidth-code-point": "^3.0.0", + "strip-ansi": "^6.0.1" }, "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/chalk/wrap-ansi?sponsor=1" + "node": ">=8" } }, "node_modules/clone-deep": { @@ -6860,20 +6210,6 @@ "dev": true, "license": "MIT" }, - "node_modules/collection-visit": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/collection-visit/-/collection-visit-1.0.0.tgz", - "integrity": "sha512-lNkKvzEeMBBjUGHZ+q6z9pSJla0KWAQPvtzhEV9+iGyQYG+pBpl7xKDhxoNSOZH2hhv0v5k0y2yAM4o4SjoSkw==", - "dev": true, - "license": "MIT", - "dependencies": { - "map-visit": "^1.0.0", - "object-visit": "^1.0.0" - }, - "engines": { - "node": ">=0.10.0" - } - }, "node_modules/color-convert": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", @@ -6943,31 +6279,6 @@ "integrity": "sha512-GpVkmM8vF2vQUkj2LvZmD35JxeJOLCwJ9cUkugyk2nuhbv3+mJvpLYYt+0+USMxE+oj+ey/lJEnhZw75x/OMcQ==", "license": "MIT" }, - "node_modules/common-path-prefix": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/common-path-prefix/-/common-path-prefix-3.0.0.tgz", - "integrity": "sha512-QE33hToZseCH3jS0qN96O/bSh3kaw/h+Tq7ngyY9eWDUnTlTNUyqfqvCXioLe5Na5jFsL78ra/wuBU4iuEgd4w==", - "license": "ISC" - }, - "node_modules/component-bind": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/component-bind/-/component-bind-1.0.0.tgz", - "integrity": "sha512-WZveuKPeKAG9qY+FkYDeADzdHyTYdIboXS59ixDeRJL5ZhxpqUnxSOwop4FQjMsiYm3/Or8cegVbpAHNA7pHxw==", - "dev": true - }, - "node_modules/component-emitter": { - "version": "1.2.1", - "resolved": "https://registry.npmjs.org/component-emitter/-/component-emitter-1.2.1.tgz", - "integrity": "sha512-jPatnhd33viNplKjqXKRkGU345p263OIWzDL2wH3LGIGp5Kojo+uXizHmOADRvhGFFTnJqX3jBAKP6vvmSDKcA==", - "dev": true, - "license": "MIT" - }, - "node_modules/component-inherit": { - "version": "0.0.3", - "resolved": "https://registry.npmjs.org/component-inherit/-/component-inherit-0.0.3.tgz", - "integrity": "sha512-w+LhYREhatpVqTESyGFg3NlP6Iu0kEKUHETY9GoZP/pQyW4mHFZuFWRUCIqVPZ36ueVLtoOEZaAqbCF2RDndaA==", - "dev": true - }, "node_modules/concat-map": { "version": "0.0.1", "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz", @@ -6991,46 +6302,6 @@ "typedarray": "^0.0.6" } }, - "node_modules/concat-stream/node_modules/isarray": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/isarray/-/isarray-1.0.0.tgz", - "integrity": "sha512-VLghIWNM6ELQzo7zwmcg0NmTVyWKYjvIeM83yjp0wRDTmUnrM678fQbcKBo6n2CJEF0szoG//ytg+TKla89ALQ==", - "dev": true, - "license": "MIT" - }, - "node_modules/concat-stream/node_modules/readable-stream": { - "version": "2.3.8", - "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-2.3.8.tgz", - "integrity": "sha512-8p0AUk4XODgIewSi0l8Epjs+EVnWiK7NoDIEGU0HhE7+ZyY8D1IMY7odu5lRrFXGg71L15KG8QrPmum45RTtdA==", - "dev": true, - "license": "MIT", - "dependencies": { - "core-util-is": "~1.0.0", - "inherits": "~2.0.3", - "isarray": "~1.0.0", - "process-nextick-args": "~2.0.0", - "safe-buffer": "~5.1.1", - "string_decoder": "~1.1.1", - "util-deprecate": "~1.0.1" - } - }, - "node_modules/concat-stream/node_modules/safe-buffer": { - "version": "5.1.2", - "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.1.2.tgz", - "integrity": "sha512-Gd2UZBJDkXlY7GbJxfsE8/nvKkUEU1G38c1siN6QP6a9PT9MmHB8GnpscSmMJSoF8LOIrt8ud/wPtojys4G6+g==", - "dev": true, - "license": "MIT" - }, - "node_modules/concat-stream/node_modules/string_decoder": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.1.1.tgz", - "integrity": "sha512-n/ShnvDi6FHbbVfviro+WojiFzv+s8MPMHBczVePfUpDJLwoLT0ht1l4YwBCbi8pJAveEEdnkHyPyTP/mzRfwg==", - "dev": true, - "license": "MIT", - "dependencies": { - "safe-buffer": "~5.1.0" - } - }, "node_modules/connect": { "version": "3.7.0", "resolved": "https://registry.npmjs.org/connect/-/connect-3.7.0.tgz", @@ -7090,25 +6361,15 @@ "license": "MIT" }, "node_modules/cookie": { - "version": "0.3.1", - "resolved": "https://registry.npmjs.org/cookie/-/cookie-0.3.1.tgz", - "integrity": "sha512-+IJOX0OqlHCszo2mBUq+SrEbCj6w7Kpffqx60zYbPTFaO4+yYgRjHwcZNpWvaTylDHaV7PPmBHzSecZiMhtPgw==", + "version": "0.7.2", + "resolved": "https://registry.npmjs.org/cookie/-/cookie-0.7.2.tgz", + "integrity": "sha512-yki5XnKuf750l50uGTllt6kKILY4nQ1eNIQatoXEByZ5dWgnKqbnqmTrBE5B4N7lrMJKQ2ytWMiTO2o0v6Ew/w==", "dev": true, "license": "MIT", "engines": { "node": ">= 0.6" } }, - "node_modules/copy-descriptor": { - "version": "0.1.1", - "resolved": "https://registry.npmjs.org/copy-descriptor/-/copy-descriptor-0.1.1.tgz", - "integrity": "sha512-XgZ0pFcakEUlbwQEVNg3+QAis1FyTL3Qel9FYy8pSkQqoG3PNoT0bOCQtOXcOkur21r2Eq2kI+IE+gsmAEVlYw==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, "node_modules/core-js": { "version": "2.6.12", "resolved": "https://registry.npmjs.org/core-js/-/core-js-2.6.12.tgz", @@ -7134,15 +6395,33 @@ "version": "1.0.3", "resolved": "https://registry.npmjs.org/core-util-is/-/core-util-is-1.0.3.tgz", "integrity": "sha512-ZQBvi1DcpJ4GDqanjucZ2Hj3wEO5pZDS89BWbkcrvdxksJorwUDDZamX9ldFkp9aw2lmBDLgkObEA4DWNJ9FYQ==", - "dev": true, "license": "MIT" }, + "node_modules/cors": { + "version": "2.8.6", + "resolved": "https://registry.npmjs.org/cors/-/cors-2.8.6.tgz", + "integrity": "sha512-tJtZBBHA6vjIAaF6EnIaq6laBBP9aq/Y3ouVJjEfoHbRBcHBAHYcMh/w8LDrk2PvIMMq8gmopa5D4V8RmbrxGw==", + "dev": true, + "license": "MIT", + "dependencies": { + "object-assign": "^4", + "vary": "^1" + }, + "engines": { + "node": ">= 0.10" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/express" + } + }, "node_modules/cosmiconfig": { "version": "9.0.0", "resolved": "https://registry.npmjs.org/cosmiconfig/-/cosmiconfig-9.0.0.tgz", "integrity": "sha512-itvL5h8RETACmOTFc4UfIyB2RfEHi71Ax6E/PivVxq9NseKbOWpeyHEOIbmAw1rs8Ak0VursQNww7lf7YtUwzg==", "dev": true, "license": "MIT", + "peer": true, "dependencies": { "env-paths": "^2.2.1", "import-fresh": "^3.3.0", @@ -7169,7 +6448,8 @@ "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz", "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==", "dev": true, - "license": "Python-2.0" + "license": "Python-2.0", + "peer": true }, "node_modules/cosmiconfig/node_modules/js-yaml": { "version": "4.1.1", @@ -7177,6 +6457,7 @@ "integrity": "sha512-qQKT4zQxXl8lLwBtHMWwaTcGfFOZviOJet3Oy/xmGk2gZH677CJM9EvtfdSkgWcATZhj/55JZ0rmy3myCT5lsA==", "dev": true, "license": "MIT", + "peer": true, "dependencies": { "argparse": "^2.0.1" }, @@ -7210,6 +6491,7 @@ "version": "7.0.6", "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.6.tgz", "integrity": "sha512-uV2QOWP2nWzsy2aMp8aRibhi9dlzF5Hgh5SHaB9OiTGEyDTiJJyx0uy51QXdyWbtAHNua4XJzUKca3OzKUd3vA==", + "dev": true, "license": "MIT", "dependencies": { "path-key": "^3.1.0", @@ -7231,9 +6513,9 @@ } }, "node_modules/css-loader": { - "version": "7.1.3", - "resolved": "https://registry.npmjs.org/css-loader/-/css-loader-7.1.3.tgz", - "integrity": "sha512-frbERmjT0UC5lMheWpJmMilnt9GEhbZJN/heUb7/zaJYeIzj5St9HvDcfshzzOqbsS+rYpMk++2SD3vGETDSyA==", + "version": "7.1.4", + "resolved": "https://registry.npmjs.org/css-loader/-/css-loader-7.1.4.tgz", + "integrity": "sha512-vv3J9tlOl04WjiMvHQI/9tmIrCxVrj6PFbHemBB1iihpeRbi/I4h033eoFIhwxBBqLhI0KYFS7yvynBFhIZfTw==", "license": "MIT", "dependencies": { "icss-utils": "^5.1.0", @@ -7253,7 +6535,7 @@ "url": "https://opencollective.com/webpack" }, "peerDependencies": { - "@rspack/core": "0.x || 1.x", + "@rspack/core": "0.x || ^1.0.0 || ^2.0.0-0", "webpack": "^5.27.0" }, "peerDependenciesMeta": { @@ -7266,9 +6548,9 @@ } }, "node_modules/css-loader/node_modules/semver": { - "version": "7.7.3", - "resolved": "https://registry.npmjs.org/semver/-/semver-7.7.3.tgz", - "integrity": "sha512-SdsKMrI9TdgjdweUSR9MweHA4EJ8YxHn8DFaDisvhVlUOe4BF1tLD7GAj0lIqWVl+dPb/rExr0Btby5loQm20Q==", + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.7.4.tgz", + "integrity": "sha512-vFKC2IEtQnVhpT78h1Yp8wzwrf8CM+MzKMHGJZfBtzhZNycRFnXsHk6E5TxIkkMsgNS7mdX3AGB7x2QM2di4lA==", "license": "ISC", "bin": { "semver": "bin/semver.js" @@ -7289,6 +6571,7 @@ "integrity": "sha512-0eW44TGN5SQXU1mWSkKwFstI/22X2bG1nYzZTYMAWjylYURhse752YgbE4Cx46AC+bAvI+/dYTPRk1LqSUnu6w==", "dev": true, "license": "MIT", + "peer": true, "dependencies": { "mdn-data": "2.12.2", "source-map-js": "^1.0.1" @@ -7441,9 +6724,9 @@ } }, "node_modules/datatables.net": { - "version": "2.3.6", - "resolved": "https://registry.npmjs.org/datatables.net/-/datatables.net-2.3.6.tgz", - "integrity": "sha512-xQ/dCxrjfxM0XY70wSIzakkTZ6ghERwlLmAPyCnu8Sk5cyt9YvOVyOsFNOa/BZ/lM63Q3i2YSSvp/o7GXZGsbg==", + "version": "2.3.7", + "resolved": "https://registry.npmjs.org/datatables.net/-/datatables.net-2.3.7.tgz", + "integrity": "sha512-AvsjG/Nkp6OxeyBKYZauemuzQCPogE1kOtKwG4sYjvdqGCSLiGaJagQwXv4YxG+ts5vaJr6qKGG9ec3g6vTo3w==", "license": "MIT", "dependencies": { "jquery": ">=1.7" @@ -7459,6 +6742,16 @@ "jquery": ">=1.7" } }, + "node_modules/date-format": { + "version": "4.0.14", + "resolved": "https://registry.npmjs.org/date-format/-/date-format-4.0.14.tgz", + "integrity": "sha512-39BOQLs9ZjKh0/patS9nrT8wc3ioX3/eA/zgbKNopnF2wCqJEoxywwwElATYvRsXdnOxA/OQeQoFZ3rFjVajhg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=4.0" + } + }, "node_modules/date-now": { "version": "0.1.4", "resolved": "https://registry.npmjs.org/date-now/-/date-now-0.1.4.tgz", @@ -7538,16 +6831,6 @@ "integrity": "sha512-YpgQiITW3JXGntzdUmyUR1V812Hn8T1YVXhCu+wO3OpS4eU9l4YdD3qjyiKdV6mvV29zapkMeD390UVEf2lkUg==", "license": "MIT" }, - "node_modules/decode-uri-component": { - "version": "0.2.2", - "resolved": "https://registry.npmjs.org/decode-uri-component/-/decode-uri-component-0.2.2.tgz", - "integrity": "sha512-FqUYQ+8o158GyGTrMFJms9qh3CqTKvAqgqsTnkLI8sKu0028orqBhxNMFkFen0zGyg6epACD32pjVk58ngIErQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=0.10" - } - }, "node_modules/dedent": { "version": "1.7.1", "resolved": "https://registry.npmjs.org/dedent/-/dedent-1.7.1.tgz", @@ -7652,20 +6935,6 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/define-property": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/define-property/-/define-property-2.0.2.tgz", - "integrity": "sha512-jwK2UV4cnPpbcG7+VRARKTZPUWowwXA8bzH5NP6ud0oeAxyYPuGZUAC7hMugpCdz4BeSZl2Dl9k66CHJ/46ZYQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "is-descriptor": "^1.0.2", - "isobject": "^3.0.1" - }, - "engines": { - "node": ">=0.10.0" - } - }, "node_modules/delayed-stream": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/delayed-stream/-/delayed-stream-1.0.0.tgz", @@ -7907,12 +7176,6 @@ "node": ">= 0.4" } }, - "node_modules/eastasianwidth": { - "version": "0.2.0", - "resolved": "https://registry.npmjs.org/eastasianwidth/-/eastasianwidth-0.2.0.tgz", - "integrity": "sha512-I88TYZWc9XiYHRQ4/3c5rjjfgkjhLyW2luGIheGERbNQ6OY7yTybanSpDXZa8y7VUP9YmDcYa+eyq4ca7iLqWA==", - "license": "MIT" - }, "node_modules/edx-ui-toolkit": { "version": "1.8.7", "resolved": "https://registry.npmjs.org/edx-ui-toolkit/-/edx-ui-toolkit-1.8.7.tgz", @@ -8002,9 +7265,9 @@ "license": "MIT" }, "node_modules/electron-to-chromium": { - "version": "1.5.282", - "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.282.tgz", - "integrity": "sha512-FCPkJtpst28UmFzd903iU7PdeVTfY0KAeJy+Lk0GLZRwgwYHn/irRcaCbQQOmr5Vytc/7rcavsYLvTM8RiHYhQ==", + "version": "1.5.283", + "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.283.tgz", + "integrity": "sha512-3vifjt1HgrGW/h76UEeny+adYApveS9dH2h3p57JYzBSXJIKUJAvtmIytDKjcSCt9xHfrNCFJ7gts6vkhuq++w==", "license": "ISC" }, "node_modules/email-prop-type": { @@ -8041,6 +7304,7 @@ "version": "8.0.0", "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==", + "dev": true, "license": "MIT" }, "node_modules/emojis-list": { @@ -8062,155 +7326,72 @@ "node": ">= 0.8" } }, - "node_modules/encoding": { - "version": "0.1.13", - "resolved": "https://registry.npmjs.org/encoding/-/encoding-0.1.13.tgz", - "integrity": "sha512-ETBauow1T35Y/WZMkio9jiM0Z5xjHHmJ4XmjZOq1l/dXz3lr2sRn87nJy20RupqSh1F2m3HHPSp8ShIPQJrJ3A==", - "license": "MIT", - "optional": true, - "dependencies": { - "iconv-lite": "^0.6.2" - } - }, - "node_modules/encoding/node_modules/iconv-lite": { - "version": "0.6.3", - "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.6.3.tgz", - "integrity": "sha512-4fCk79wshMdzMp2rH06qWrJE4iolqLhCUH+OiuIgU++RB0+94NlDL81atO7GX55uUKueo0txHNtvEyI6D7WdMw==", - "license": "MIT", - "optional": true, - "dependencies": { - "safer-buffer": ">= 2.1.2 < 3.0.0" - }, - "engines": { - "node": ">=0.10.0" - } - }, "node_modules/engine.io": { - "version": "1.8.5", - "resolved": "https://registry.npmjs.org/engine.io/-/engine.io-1.8.5.tgz", - "integrity": "sha512-j1DWIcktw4hRwrv6nWx++5nFH2X64x16MAG2P0Lmi5Dvdfi3I+Jhc7JKJIdAmDJa+5aZ/imHV7dWRPy2Cqjh3A==", - "dev": true, - "license": "MIT", - "dependencies": { - "accepts": "1.3.3", - "base64id": "1.0.0", - "cookie": "0.3.1", - "debug": "2.3.3", - "engine.io-parser": "1.3.2", - "ws": "~1.1.5" - } - }, - "node_modules/engine.io-client": { - "version": "1.8.6", - "resolved": "https://registry.npmjs.org/engine.io-client/-/engine.io-client-1.8.6.tgz", - "integrity": "sha512-6+rInQu8xU7c0fIF6RC4SRKuHVWPt8Xq0bZYS4lMrTwmhRineOlEMsU3X0zS5mHIvCgJsmpOKEX7DhihGk7j0g==", - "dev": true, - "license": "MIT", - "dependencies": { - "component-emitter": "1.2.1", - "component-inherit": "0.0.3", - "debug": "2.3.3", - "engine.io-parser": "1.3.2", - "has-cors": "1.1.0", - "indexof": "0.0.1", - "parsejson": "0.0.3", - "parseqs": "0.0.5", - "parseuri": "0.0.5", - "ws": "~1.1.5", - "xmlhttprequest-ssl": "1.6.3", - "yeast": "0.1.2" - } - }, - "node_modules/engine.io-client/node_modules/debug": { - "version": "2.3.3", - "resolved": "https://registry.npmjs.org/debug/-/debug-2.3.3.tgz", - "integrity": "sha512-dCHp4G+F11zb+RtEu7BE2U8R32AYmM/4bljQfut8LipH3PdwsVBVGh083MXvtKkB7HSQUzSwiXz53c4mzJvYfw==", - "dev": true, - "license": "MIT", - "dependencies": { - "ms": "0.7.2" - } - }, - "node_modules/engine.io-client/node_modules/ms": { - "version": "0.7.2", - "resolved": "https://registry.npmjs.org/ms/-/ms-0.7.2.tgz", - "integrity": "sha512-5NnE67nQSQDJHVahPJna1PQ/zCXMnQop3yUCxjKPNzCxuyPSKWTQ/5Gu5CZmjetwGLWRA+PzeF5thlbOdbQldA==", - "dev": true, - "license": "MIT" - }, - "node_modules/engine.io-client/node_modules/ws": { - "version": "1.1.5", - "resolved": "https://registry.npmjs.org/ws/-/ws-1.1.5.tgz", - "integrity": "sha512-o3KqipXNUdS7wpQzBHSe180lBGO60SoK0yVo3CYJgb2MkobuWuBX6dhkYP5ORCLd55y+SaflMOV5fqAB53ux4w==", + "version": "6.6.5", + "resolved": "https://registry.npmjs.org/engine.io/-/engine.io-6.6.5.tgz", + "integrity": "sha512-2RZdgEbXmp5+dVbRm0P7HQUImZpICccJy7rN7Tv+SFa55pH+lxnuw6/K1ZxxBfHoYpSkHLAO92oa8O4SwFXA2A==", "dev": true, "license": "MIT", "dependencies": { - "options": ">=0.0.5", - "ultron": "1.0.x" + "@types/cors": "^2.8.12", + "@types/node": ">=10.0.0", + "accepts": "~1.3.4", + "base64id": "2.0.0", + "cookie": "~0.7.2", + "cors": "~2.8.5", + "debug": "~4.4.1", + "engine.io-parser": "~5.2.1", + "ws": "~8.18.3" + }, + "engines": { + "node": ">=10.2.0" } }, "node_modules/engine.io-parser": { - "version": "1.3.2", - "resolved": "https://registry.npmjs.org/engine.io-parser/-/engine.io-parser-1.3.2.tgz", - "integrity": "sha512-3UyTJo+5Jbmr7rd3MosTAApK7BOIo4sjx8dJYSHa3Em5R3A9Y2s9GWu4JFJe6Px0VieJC0hKUA5NBytC+O7k2A==", - "dev": true, - "license": "MIT", - "dependencies": { - "after": "0.8.2", - "arraybuffer.slice": "0.0.6", - "base64-arraybuffer": "0.1.5", - "blob": "0.0.4", - "has-binary": "0.1.7", - "wtf-8": "1.0.0" - } - }, - "node_modules/engine.io/node_modules/debug": { - "version": "2.3.3", - "resolved": "https://registry.npmjs.org/debug/-/debug-2.3.3.tgz", - "integrity": "sha512-dCHp4G+F11zb+RtEu7BE2U8R32AYmM/4bljQfut8LipH3PdwsVBVGh083MXvtKkB7HSQUzSwiXz53c4mzJvYfw==", + "version": "5.2.3", + "resolved": "https://registry.npmjs.org/engine.io-parser/-/engine.io-parser-5.2.3.tgz", + "integrity": "sha512-HqD3yTBfnBxIrbnM1DoD6Pcq8NECnh8d4As1Qgh0z5Gg3jRRIqijury0CL3ghu/edArpUYiYqQiDUQBIs4np3Q==", "dev": true, "license": "MIT", - "dependencies": { - "ms": "0.7.2" + "engines": { + "node": ">=10.0.0" } }, - "node_modules/engine.io/node_modules/ms": { - "version": "0.7.2", - "resolved": "https://registry.npmjs.org/ms/-/ms-0.7.2.tgz", - "integrity": "sha512-5NnE67nQSQDJHVahPJna1PQ/zCXMnQop3yUCxjKPNzCxuyPSKWTQ/5Gu5CZmjetwGLWRA+PzeF5thlbOdbQldA==", - "dev": true, - "license": "MIT" - }, "node_modules/engine.io/node_modules/ws": { - "version": "1.1.5", - "resolved": "https://registry.npmjs.org/ws/-/ws-1.1.5.tgz", - "integrity": "sha512-o3KqipXNUdS7wpQzBHSe180lBGO60SoK0yVo3CYJgb2MkobuWuBX6dhkYP5ORCLd55y+SaflMOV5fqAB53ux4w==", + "version": "8.18.3", + "resolved": "https://registry.npmjs.org/ws/-/ws-8.18.3.tgz", + "integrity": "sha512-PEIGCY5tSlUt50cqyMXfCzX+oOPqN0vuGqWzbcJ2xvnkzkq46oOpz7dQaTDBdfICb4N14+GARUDw2XV2N4tvzg==", "dev": true, "license": "MIT", - "dependencies": { - "options": ">=0.0.5", - "ultron": "1.0.x" + "engines": { + "node": ">=10.0.0" + }, + "peerDependencies": { + "bufferutil": "^4.0.1", + "utf-8-validate": ">=5.0.2" + }, + "peerDependenciesMeta": { + "bufferutil": { + "optional": true + }, + "utf-8-validate": { + "optional": true + } } }, "node_modules/enhanced-resolve": { - "version": "5.18.4", - "resolved": "https://registry.npmjs.org/enhanced-resolve/-/enhanced-resolve-5.18.4.tgz", - "integrity": "sha512-LgQMM4WXU3QI+SYgEc2liRgznaD5ojbmY3sb8LxyguVkIg5FxdpTkvk72te2R38/TGKxH634oLxXRGY6d7AP+Q==", + "version": "5.21.0", + "resolved": "https://registry.npmjs.org/enhanced-resolve/-/enhanced-resolve-5.21.0.tgz", + "integrity": "sha512-otxSQPw4lkOZWkHpB3zaEQs6gWYEsmX4xQF68ElXC/TWvGxGMSGOvoNbaLXm6/cS/fSfHtsEdw90y20PCd+sCA==", "license": "MIT", "dependencies": { "graceful-fs": "^4.2.4", - "tapable": "^2.2.0" + "tapable": "^2.3.3" }, "engines": { "node": ">=10.13.0" } }, - "node_modules/enquire.js": { - "version": "2.1.6", - "resolved": "https://registry.npmjs.org/enquire.js/-/enquire.js-2.1.6.tgz", - "integrity": "sha512-/KujNpO+PT63F7Hlpu4h3pE3TokKRHN26JYmQpPyjkRD/N57R7bPDNojMXdi7uveAKjYB7yQnartCxZnFWr0Xw==", - "license": "MIT" - }, "node_modules/ent": { "version": "2.2.2", "resolved": "https://registry.npmjs.org/ent/-/ent-2.2.2.tgz", @@ -8274,12 +7455,6 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/err-code": { - "version": "2.0.3", - "resolved": "https://registry.npmjs.org/err-code/-/err-code-2.0.3.tgz", - "integrity": "sha512-2bmlRpNKBxT/CRmPOlyISQpNj+qSeYvcym/uT0Jx2bMOlKLtSy1ZmLuVxSEKKyor/N5yhvp/ZiG1oE3DEYMSFA==", - "license": "MIT" - }, "node_modules/error-ex": { "version": "1.3.4", "resolved": "https://registry.npmjs.org/error-ex/-/error-ex-1.3.4.tgz", @@ -8747,26 +7922,6 @@ "node": ">=4.0" } }, - "node_modules/eslint/node_modules/ansi-escapes": { - "version": "1.4.0", - "resolved": "https://registry.npmjs.org/ansi-escapes/-/ansi-escapes-1.4.0.tgz", - "integrity": "sha512-wiXutNjDUlNEDWHcYH3jtZUhd3c4/VojassD8zHdHCY13xbZy2XbW+NKQwA0tWGBVzDA9qEzYwfoSsWmviidhw==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/eslint/node_modules/ansi-regex": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-2.1.1.tgz", - "integrity": "sha512-TIGnTpdo+E3+pCyAluZvtED5p5wCqLdezCyhPZzKPcxvFplEt4i+W7OONCKgeZFT3+y5NZZfOOS/Bdcanm1MYA==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, "node_modules/eslint/node_modules/ansi-styles": { "version": "2.2.1", "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-2.2.1.tgz", @@ -8777,17 +7932,6 @@ "node": ">=0.10.0" } }, - "node_modules/eslint/node_modules/brace-expansion": { - "version": "1.1.12", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.12.tgz", - "integrity": "sha512-9T9UjW3r0UW5c1Q7GTwllptXwhvYmEzFhzMfZ9H7FQWt+uZePjZPjBP/W1ZEyZ1twGWom5/56TF4lPcqjnDHcg==", - "dev": true, - "license": "MIT", - "dependencies": { - "balanced-match": "^1.0.0", - "concat-map": "0.0.1" - } - }, "node_modules/eslint/node_modules/chalk": { "version": "1.1.3", "resolved": "https://registry.npmjs.org/chalk/-/chalk-1.1.3.tgz", @@ -8805,26 +7949,6 @@ "node": ">=0.10.0" } }, - "node_modules/eslint/node_modules/cli-cursor": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/cli-cursor/-/cli-cursor-1.0.2.tgz", - "integrity": "sha512-25tABq090YNKkF6JH7lcwO0zFJTRke4Jcq9iX2nr/Sz0Cjjv4gckmwlW6Ty/aoyFd6z3ysR2hMGC2GFugmBo6A==", - "dev": true, - "license": "MIT", - "dependencies": { - "restore-cursor": "^1.0.1" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/eslint/node_modules/cli-width": { - "version": "2.2.1", - "resolved": "https://registry.npmjs.org/cli-width/-/cli-width-2.2.1.tgz", - "integrity": "sha512-GRMWDxpOB6Dgk2E5Uo+3eEBvtOOlimMmpbFiKuLFnQzYDavtLFY3K5ona41jgN/WdRZtG7utuVSVTL4HbZHGkw==", - "dev": true, - "license": "ISC" - }, "node_modules/eslint/node_modules/debug": { "version": "2.6.9", "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", @@ -8845,90 +7969,6 @@ "node": ">=4.0" } }, - "node_modules/eslint/node_modules/figures": { - "version": "1.7.0", - "resolved": "https://registry.npmjs.org/figures/-/figures-1.7.0.tgz", - "integrity": "sha512-UxKlfCRuCBxSXU4C6t9scbDyWZ4VlaFFdojKtzJuSkuOBQ5CNFum+zZXFwHjo+CxBC1t6zlYPgHIgFjL8ggoEQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "escape-string-regexp": "^1.0.5", - "object-assign": "^4.1.0" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/eslint/node_modules/glob": { - "version": "7.2.3", - "resolved": "https://registry.npmjs.org/glob/-/glob-7.2.3.tgz", - "integrity": "sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q==", - "deprecated": "Glob versions prior to v9 are no longer supported", - "dev": true, - "license": "ISC", - "dependencies": { - "fs.realpath": "^1.0.0", - "inflight": "^1.0.4", - "inherits": "2", - "minimatch": "^3.1.1", - "once": "^1.3.0", - "path-is-absolute": "^1.0.0" - }, - "engines": { - "node": "*" - }, - "funding": { - "url": "https://github.com/sponsors/isaacs" - } - }, - "node_modules/eslint/node_modules/inquirer": { - "version": "0.12.0", - "resolved": "https://registry.npmjs.org/inquirer/-/inquirer-0.12.0.tgz", - "integrity": "sha512-bOetEz5+/WpgaW4D1NYOk1aD+JCqRjqu/FwRFgnIfiP7FC/zinsrfyO1vlS3nyH/R7S0IH3BIHBu4DBIDSqiGQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "ansi-escapes": "^1.1.0", - "ansi-regex": "^2.0.0", - "chalk": "^1.0.0", - "cli-cursor": "^1.0.1", - "cli-width": "^2.0.0", - "figures": "^1.3.5", - "lodash": "^4.3.0", - "readline2": "^1.0.1", - "run-async": "^0.1.0", - "rx-lite": "^3.1.2", - "string-width": "^1.0.1", - "strip-ansi": "^3.0.0", - "through": "^2.3.6" - } - }, - "node_modules/eslint/node_modules/is-fullwidth-code-point": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-1.0.0.tgz", - "integrity": "sha512-1pqUqRjkhPJ9miNq9SwMfdvi6lBJcd6eFxvfaivQhaH3SgisfiuudvFntdKOmxuee/77l+FPjKrQjWvmPjWrRw==", - "dev": true, - "license": "MIT", - "dependencies": { - "number-is-nan": "^1.0.0" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/eslint/node_modules/minimatch": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", - "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", - "dev": true, - "license": "ISC", - "dependencies": { - "brace-expansion": "^1.1.7" - }, - "engines": { - "node": "*" - } - }, "node_modules/eslint/node_modules/ms": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", @@ -8936,55 +7976,6 @@ "dev": true, "license": "MIT" }, - "node_modules/eslint/node_modules/onetime": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/onetime/-/onetime-1.1.0.tgz", - "integrity": "sha512-GZ+g4jayMqzCRMgB2sol7GiCLjKfS1PINkjmx8spcKce1LiVqcbQreXwqs2YAFXC6R03VIG28ZS31t8M866v6A==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/eslint/node_modules/restore-cursor": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/restore-cursor/-/restore-cursor-1.0.1.tgz", - "integrity": "sha512-reSjH4HuiFlxlaBaFCiS6O76ZGG2ygKoSlCsipKdaZuKSPx/+bt9mULkn4l0asVzbEfQQmXRg6Wp6gv6m0wElw==", - "dev": true, - "license": "MIT", - "dependencies": { - "exit-hook": "^1.0.0", - "onetime": "^1.0.0" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/eslint/node_modules/run-async": { - "version": "0.1.0", - "resolved": "https://registry.npmjs.org/run-async/-/run-async-0.1.0.tgz", - "integrity": "sha512-qOX+w+IxFgpUpJfkv2oGN0+ExPs68F4sZHfaRRx4dDexAQkG83atugKVEylyT5ARees3HBbfmuvnjbrd8j9Wjw==", - "dev": true, - "license": "MIT", - "dependencies": { - "once": "^1.3.0" - } - }, - "node_modules/eslint/node_modules/string-width": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-1.0.2.tgz", - "integrity": "sha512-0XsVpQLnVCXHJfyEs8tC0zpTVIr5PKKsQtkT29IwupnPTjtPmQ3xT/4yCREF9hYkV/3M3kzcUTSAZT6a6h81tw==", - "dev": true, - "license": "MIT", - "dependencies": { - "code-point-at": "^1.0.0", - "is-fullwidth-code-point": "^1.0.0", - "strip-ansi": "^3.0.0" - }, - "engines": { - "node": ">=0.10.0" - } - }, "node_modules/eslint/node_modules/strip-ansi": { "version": "3.0.1", "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-3.0.1.tgz", @@ -9187,47 +8178,6 @@ "node": ">=0.10.0" } }, - "node_modules/expand-braces": { - "version": "0.1.2", - "resolved": "https://registry.npmjs.org/expand-braces/-/expand-braces-0.1.2.tgz", - "integrity": "sha512-zOOsEnAhvIxxd0esCNbYG2xerGf46niZ1egS43eV7Fu4t7VIScgPXMcMabCLaPrqkzwvwo6zZipDiX3t0ILF2w==", - "dev": true, - "license": "MIT", - "dependencies": { - "array-slice": "^0.2.3", - "array-unique": "^0.2.1", - "braces": "^0.1.2" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/expand-brackets": { - "version": "0.1.5", - "resolved": "https://registry.npmjs.org/expand-brackets/-/expand-brackets-0.1.5.tgz", - "integrity": "sha512-hxx03P2dJxss6ceIeri9cmYOT4SRs3Zk3afZwWpOsRqLqprhTR8u++SlC+sFGsQr7WGFPdMF7Gjc1njDLDK6UA==", - "dev": true, - "license": "MIT", - "dependencies": { - "is-posix-bracket": "^0.1.0" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/expand-range": { - "version": "0.1.1", - "resolved": "https://registry.npmjs.org/expand-range/-/expand-range-0.1.1.tgz", - "integrity": "sha512-busOHJ0t7t5UcutcyNDqmaDX+1cb0XlqsAUgTlmplVv0rIqBaMcBSZRLlkDm0nxtl8O3o/EvRRrdQ/WnyPERLQ==", - "dev": true, - "dependencies": { - "is-number": "^0.1.1", - "repeat-string": "^0.2.2" - }, - "engines": { - "node": ">=0.10.0" - } - }, "node_modules/expect": { "version": "29.7.0", "resolved": "https://registry.npmjs.org/expect/-/expect-29.7.0.tgz", @@ -9252,12 +8202,25 @@ "license": "Apache-2.0" }, "node_modules/exports-loader": { - "version": "0.6.4", - "resolved": "https://registry.npmjs.org/exports-loader/-/exports-loader-0.6.4.tgz", - "integrity": "sha512-koRSTJrocXi3l7MKXSJPbNKUmewV2CewsWCZW+5KYxgkiZBjlEo4Z+DJuHDq4WzOi19drlyuT1xY7ADmwln8zQ==", + "version": "0.7.0", + "resolved": "https://registry.npmjs.org/exports-loader/-/exports-loader-0.7.0.tgz", + "integrity": "sha512-RKwCrO4A6IiKm0pG3c9V46JxIHcDplwwGJn6+JJ1RcVnh/WSGJa0xkmk5cRVtgOPzCAtTMGj2F7nluh9L0vpSA==", + "license": "MIT", "dependencies": { - "loader-utils": "^1.0.2", - "source-map": "0.5.x" + "loader-utils": "^1.1.0", + "source-map": "0.5.0" + }, + "engines": { + "node": ">= 4" + } + }, + "node_modules/exports-loader/node_modules/source-map": { + "version": "0.5.0", + "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.5.0.tgz", + "integrity": "sha512-gjGnxNN0K+/Pr4Mi4fs/pOtda10dKB6Wn9QvjOrH6v5TWsI7ghHuJUHoIgyM6DkUL5kr2GtPFGererzKpMBWfA==", + "license": "BSD-3-Clause", + "engines": { + "node": ">=0.10.0" } }, "node_modules/ext": { @@ -9290,19 +8253,6 @@ "node": ">=0.10.0" } }, - "node_modules/extglob": { - "version": "0.3.2", - "resolved": "https://registry.npmjs.org/extglob/-/extglob-0.3.2.tgz", - "integrity": "sha512-1FOj1LOwn42TMrruOHGt18HemVnbwAmAak7krWk+wa93KXxGbK+2jpezm+ytJYDaBX0/SPLZFHKM7m+tKobWGg==", - "dev": true, - "license": "MIT", - "dependencies": { - "is-extglob": "^1.0.0" - }, - "engines": { - "node": ">=0.10.0" - } - }, "node_modules/fancy-log": { "version": "1.3.3", "resolved": "https://registry.npmjs.org/fancy-log/-/fancy-log-1.3.3.tgz", @@ -9341,42 +8291,6 @@ "node": ">=8.6.0" } }, - "node_modules/fast-glob/node_modules/glob-parent": { - "version": "5.1.2", - "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.2.tgz", - "integrity": "sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==", - "dev": true, - "license": "ISC", - "dependencies": { - "is-glob": "^4.0.1" - }, - "engines": { - "node": ">= 6" - } - }, - "node_modules/fast-glob/node_modules/is-extglob": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/is-extglob/-/is-extglob-2.1.1.tgz", - "integrity": "sha512-SbKbANkN603Vi4jEZv49LeVJMn4yGwsbzZworEoyEiutsN3nJYdbO36zfhGJ6QEDpOZIFkDtnq5JRxmvl3jsoQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/fast-glob/node_modules/is-glob": { - "version": "4.0.3", - "resolved": "https://registry.npmjs.org/is-glob/-/is-glob-4.0.3.tgz", - "integrity": "sha512-xelSayHH36ZgE7ZWhli7pW34hNbNl8Ojv5KVmkJD4hBdD3th8Tfk9vYasLM+mXWOZhFkgZfxhLSnrwRr4elSSg==", - "dev": true, - "license": "MIT", - "dependencies": { - "is-extglob": "^2.1.1" - }, - "engines": { - "node": ">=0.10.0" - } - }, "node_modules/fast-json-stable-stringify": { "version": "2.1.0", "resolved": "https://registry.npmjs.org/fast-json-stable-stringify/-/fast-json-stable-stringify-2.1.0.tgz", @@ -9436,6 +8350,20 @@ "bser": "2.1.1" } }, + "node_modules/figures": { + "version": "1.7.0", + "resolved": "https://registry.npmjs.org/figures/-/figures-1.7.0.tgz", + "integrity": "sha512-UxKlfCRuCBxSXU4C6t9scbDyWZ4VlaFFdojKtzJuSkuOBQ5CNFum+zZXFwHjo+CxBC1t6zlYPgHIgFjL8ggoEQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "escape-string-regexp": "^1.0.5", + "object-assign": "^4.1.0" + }, + "engines": { + "node": ">=0.10.0" + } + }, "node_modules/file-entry-cache": { "version": "1.3.1", "resolved": "https://registry.npmjs.org/file-entry-cache/-/file-entry-cache-1.3.1.tgz", @@ -9475,7 +8403,6 @@ "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==", "license": "MIT", - "peer": true, "dependencies": { "fast-deep-equal": "^3.1.1", "fast-json-stable-stringify": "^2.0.0", @@ -9534,114 +8461,35 @@ "url": "https://opencollective.com/webpack" } }, - "node_modules/file-uri-to-path": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/file-uri-to-path/-/file-uri-to-path-1.0.0.tgz", - "integrity": "sha512-0Zt+s3L7Vf1biwWZ29aARiVYLx7iMGnEUl9x33fbB/j3jR81u/O2LbqK+Bm1CDSNDKVtJ/YjwY7TUd5SkeLQLw==", - "dev": true, - "license": "MIT", - "optional": true - }, - "node_modules/filename-regex": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/filename-regex/-/filename-regex-2.0.1.tgz", - "integrity": "sha512-BTCqyBaWBTsauvnHiE8i562+EdJj+oUpkqWp2R1iCoR8f6oo8STRu3of7WJJ0TqWtxN50a5YFpzYK4Jj9esYfQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, "node_modules/fill-range": { - "version": "2.2.4", - "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-2.2.4.tgz", - "integrity": "sha512-cnrcCbj01+j2gTG921VZPnHbjmdAf8oQV/iGeV2kZxGSyfYjjTyY79ErsK1WJWMpw6DaApEX72binqJE+/d+5Q==", - "dev": true, + "version": "7.1.1", + "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.1.1.tgz", + "integrity": "sha512-YsGpe3WHLK8ZYi4tWDg2Jy3ebRz2rXowDxnld4bkQB00cc/1Zw9AWnC0i9ztDJitivtQvaI9KaLyKrc+hBW0yg==", "license": "MIT", "dependencies": { - "is-number": "^2.1.0", - "isobject": "^2.0.0", - "randomatic": "^3.0.0", - "repeat-element": "^1.1.2", - "repeat-string": "^1.5.2" + "to-regex-range": "^5.0.1" }, "engines": { - "node": ">=0.10.0" + "node": ">=8" } }, - "node_modules/fill-range/node_modules/is-number": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/is-number/-/is-number-2.1.0.tgz", - "integrity": "sha512-QUzH43Gfb9+5yckcrSA0VBDwEtDUchrk4F6tfJZQuNzDJbEDB9cZNzSfXGQ1jqmdDY/kl41lUOWM9syA8z8jlg==", + "node_modules/finalhandler": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/finalhandler/-/finalhandler-1.1.2.tgz", + "integrity": "sha512-aAWcW57uxVNrQZqFXjITpW3sIUQmHGG3qSb9mUah9MgMC4NeWhNOlNjXEYq3HjRAvL6arUviZGGJsBg6z0zsWA==", "dev": true, "license": "MIT", "dependencies": { - "kind-of": "^3.0.2" + "debug": "2.6.9", + "encodeurl": "~1.0.2", + "escape-html": "~1.0.3", + "on-finished": "~2.3.0", + "parseurl": "~1.3.3", + "statuses": "~1.5.0", + "unpipe": "~1.0.0" }, "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/fill-range/node_modules/isarray": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/isarray/-/isarray-1.0.0.tgz", - "integrity": "sha512-VLghIWNM6ELQzo7zwmcg0NmTVyWKYjvIeM83yjp0wRDTmUnrM678fQbcKBo6n2CJEF0szoG//ytg+TKla89ALQ==", - "dev": true, - "license": "MIT" - }, - "node_modules/fill-range/node_modules/isobject": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/isobject/-/isobject-2.1.0.tgz", - "integrity": "sha512-+OUdGJlgjOBZDfxnDjYYG6zp487z0JGNQq3cYQYg5f5hKR+syHMsaztzGeml/4kGG55CSpKSpWTY+jYGgsHLgA==", - "dev": true, - "license": "MIT", - "dependencies": { - "isarray": "1.0.0" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/fill-range/node_modules/kind-of": { - "version": "3.2.2", - "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-3.2.2.tgz", - "integrity": "sha512-NOW9QQXMoZGg/oqnVNoNTTIFEIid1627WCffUBJEdMxYApq7mNE7CpzucIPc+ZQg25Phej7IJSmX3hO+oblOtQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "is-buffer": "^1.1.5" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/fill-range/node_modules/repeat-string": { - "version": "1.6.1", - "resolved": "https://registry.npmjs.org/repeat-string/-/repeat-string-1.6.1.tgz", - "integrity": "sha512-PV0dzCYDNfRi1jCDbJzpW7jNNDRuCOG/jI5ctQcGKt/clZD+YcPS3yIlWuTJMmESC8aevCFmWJy5wjAFgNqN6w==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=0.10" - } - }, - "node_modules/finalhandler": { - "version": "1.1.2", - "resolved": "https://registry.npmjs.org/finalhandler/-/finalhandler-1.1.2.tgz", - "integrity": "sha512-aAWcW57uxVNrQZqFXjITpW3sIUQmHGG3qSb9mUah9MgMC4NeWhNOlNjXEYq3HjRAvL6arUviZGGJsBg6z0zsWA==", - "dev": true, - "license": "MIT", - "dependencies": { - "debug": "2.6.9", - "encodeurl": "~1.0.2", - "escape-html": "~1.0.3", - "on-finished": "~2.3.0", - "parseurl": "~1.3.3", - "statuses": "~1.5.0", - "unpipe": "~1.0.0" - }, - "engines": { - "node": ">= 0.8" + "node": ">= 0.8" } }, "node_modules/finalhandler/node_modules/debug": { @@ -9674,22 +8522,6 @@ "node": ">= 0.8" } }, - "node_modules/find-cache-dir": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/find-cache-dir/-/find-cache-dir-4.0.0.tgz", - "integrity": "sha512-9ZonPT4ZAK4a+1pUPVPZJapbi7O5qbbJPdYw/NOQWZZbVLdDTYM3A4R9z/DpAM08IDaFGsvPgiGZ82WEwUDWjg==", - "license": "MIT", - "dependencies": { - "common-path-prefix": "^3.0.0", - "pkg-dir": "^7.0.0" - }, - "engines": { - "node": ">=14.16" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, "node_modules/find-up": { "version": "4.1.0", "resolved": "https://registry.npmjs.org/find-up/-/find-up-4.1.0.tgz", @@ -9729,52 +8561,6 @@ "node": ">=0.10.0" } }, - "node_modules/flat-cache/node_modules/brace-expansion": { - "version": "1.1.12", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.12.tgz", - "integrity": "sha512-9T9UjW3r0UW5c1Q7GTwllptXwhvYmEzFhzMfZ9H7FQWt+uZePjZPjBP/W1ZEyZ1twGWom5/56TF4lPcqjnDHcg==", - "dev": true, - "license": "MIT", - "dependencies": { - "balanced-match": "^1.0.0", - "concat-map": "0.0.1" - } - }, - "node_modules/flat-cache/node_modules/glob": { - "version": "7.2.3", - "resolved": "https://registry.npmjs.org/glob/-/glob-7.2.3.tgz", - "integrity": "sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q==", - "deprecated": "Glob versions prior to v9 are no longer supported", - "dev": true, - "license": "ISC", - "dependencies": { - "fs.realpath": "^1.0.0", - "inflight": "^1.0.4", - "inherits": "2", - "minimatch": "^3.1.1", - "once": "^1.3.0", - "path-is-absolute": "^1.0.0" - }, - "engines": { - "node": "*" - }, - "funding": { - "url": "https://github.com/sponsors/isaacs" - } - }, - "node_modules/flat-cache/node_modules/minimatch": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", - "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", - "dev": true, - "license": "ISC", - "dependencies": { - "brace-expansion": "^1.1.7" - }, - "engines": { - "node": "*" - } - }, "node_modules/flat-cache/node_modules/rimraf": { "version": "2.6.3", "resolved": "https://registry.npmjs.org/rimraf/-/rimraf-2.6.3.tgz", @@ -9797,10 +8583,22 @@ "license": "ISC" }, "node_modules/focus-lock": { - "version": "0.6.8", - "resolved": "https://registry.npmjs.org/focus-lock/-/focus-lock-0.6.8.tgz", - "integrity": "sha512-vkHTluRCoq9FcsrldC0ulQHiyBYgVJB2CX53I8r0nTC6KnEij7Of0jpBspjt3/CuNb6fyoj3aOh9J2HgQUM0og==", - "license": "MIT" + "version": "1.3.6", + "resolved": "https://registry.npmjs.org/focus-lock/-/focus-lock-1.3.6.tgz", + "integrity": "sha512-Ik/6OCk9RQQ0T5Xw+hKNLWrjSMtv51dD4GRmJjbD5a58TIEpI5a5iXagKVl3Z5UuyslMCA8Xwnu76jQob62Yhg==", + "license": "MIT", + "dependencies": { + "tslib": "^2.0.3" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/focus-lock/node_modules/tslib": { + "version": "2.8.1", + "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.8.1.tgz", + "integrity": "sha512-oJFu94HQb+KVduSUQL7wnpmqnfmLsOA/nAh6b6EH0wCEoK0/mPeXU6c3wKDV83MkOuHPRHtSXKKU99IBazS/2w==", + "license": "0BSD" }, "node_modules/follow-redirects": { "version": "1.15.11", @@ -9847,57 +8645,6 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/for-in": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/for-in/-/for-in-1.0.2.tgz", - "integrity": "sha512-7EwmXrOjyL+ChxMhmG5lnW9MPt1aIeZEwKhQzoBUdTV0N3zuwWDZYVJatDvZ2OyzPUvdIAZDsCetk3coyMfcnQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/for-own": { - "version": "0.1.5", - "resolved": "https://registry.npmjs.org/for-own/-/for-own-0.1.5.tgz", - "integrity": "sha512-SKmowqGTJoPzLO1T0BBJpkfp3EMacCMOuH40hOUbrbzElVktk4DioXVM99QkLCyKoiuOmyjgcWMpVz2xjE7LZw==", - "dev": true, - "license": "MIT", - "dependencies": { - "for-in": "^1.0.1" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/foreground-child": { - "version": "3.3.1", - "resolved": "https://registry.npmjs.org/foreground-child/-/foreground-child-3.3.1.tgz", - "integrity": "sha512-gIXjKqtFuWEgzFRJA9WCQeSJLZDjgJUOMCMzxtvFq/37KojM1BFGufqsCy0r4qSQmYLsZYMeyRqzIWOMup03sw==", - "license": "ISC", - "dependencies": { - "cross-spawn": "^7.0.6", - "signal-exit": "^4.0.1" - }, - "engines": { - "node": ">=14" - }, - "funding": { - "url": "https://github.com/sponsors/isaacs" - } - }, - "node_modules/foreground-child/node_modules/signal-exit": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-4.1.0.tgz", - "integrity": "sha512-bzyZ1e88w9O1iNJbKnOlvYTrWPDl46O1bG0D3XInv+9tkPrxrN8jUUTiFlDkkmKWgn1M6CfIA13SuGqOa9Korw==", - "license": "ISC", - "engines": { - "node": ">=14" - }, - "funding": { - "url": "https://github.com/sponsors/isaacs" - } - }, "node_modules/form-data": { "version": "4.0.5", "resolved": "https://registry.npmjs.org/form-data/-/form-data-4.0.5.tgz", @@ -9923,19 +8670,6 @@ "samsam": "~1.1" } }, - "node_modules/fragment-cache": { - "version": "0.2.1", - "resolved": "https://registry.npmjs.org/fragment-cache/-/fragment-cache-0.2.1.tgz", - "integrity": "sha512-GMBAbW9antB8iZRHLoGw0b3HANt57diZYFO/HL1JGIC1MjKrdmhxvrJbupnVvpys0zsz7yBApXdQyfepKly2kA==", - "dev": true, - "license": "MIT", - "dependencies": { - "map-cache": "^0.2.2" - }, - "engines": { - "node": ">=0.10.0" - } - }, "node_modules/fs-extra": { "version": "0.30.0", "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-0.30.0.tgz", @@ -9950,16 +8684,18 @@ "rimraf": "^2.2.8" } }, - "node_modules/fs-minipass": { - "version": "3.0.3", - "resolved": "https://registry.npmjs.org/fs-minipass/-/fs-minipass-3.0.3.tgz", - "integrity": "sha512-XUBA9XClHbnJWSfBzjkm6RvPsyg3sryZt06BEQoXcF7EK/xpGaQYJgQKDJSUH5SGZ76Y7pFx1QBnXz09rU5Fbw==", + "node_modules/fs-extra/node_modules/rimraf": { + "version": "2.7.1", + "resolved": "https://registry.npmjs.org/rimraf/-/rimraf-2.7.1.tgz", + "integrity": "sha512-uWjbaKIK3T1OSVptzX7Nl6PvQ3qAGtKEtVRjRuazjfL3Bx5eI409VZSqgND+4UNnmzLVdPj9FqFJNPqBZFve4w==", + "deprecated": "Rimraf versions prior to v4 are no longer supported", + "dev": true, "license": "ISC", "dependencies": { - "minipass": "^7.0.3" + "glob": "^7.1.3" }, - "engines": { - "node": "^14.17.0 || ^16.13.0 || >=18.0.0" + "bin": { + "rimraf": "bin.js" } }, "node_modules/fs.realpath": { @@ -9970,10 +8706,9 @@ "license": "ISC" }, "node_modules/fsevents": { - "version": "1.2.13", - "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-1.2.13.tgz", - "integrity": "sha512-oWb1Z6mkHIskLzEJ/XWX0srkpkTQ7vaopMQkyaEIoq0fmtFVxOthb8cCxeT+p3ynTdkk/RZwbgG4brR5BeWECw==", - "deprecated": "Upgrade to fsevents v2 to mitigate potential security issues", + "version": "2.3.3", + "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.3.3.tgz", + "integrity": "sha512-5xoDfX+fL7faATnagmWPpbFtwh/R77WmMMqqHGS65C3vvB0YHrgF+B1YmZ3441tMj5n63k0212XNoJwzlhffQw==", "dev": true, "hasInstallScript": true, "license": "MIT", @@ -9981,12 +8716,8 @@ "os": [ "darwin" ], - "dependencies": { - "bindings": "^1.5.0", - "nan": "^2.12.1" - }, "engines": { - "node": ">= 4.0" + "node": "^8.16.0 || ^10.6.0 || >=11.0.0" } }, "node_modules/function-bind": { @@ -10174,38 +8905,39 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/get-value": { - "version": "2.0.6", - "resolved": "https://registry.npmjs.org/get-value/-/get-value-2.0.6.tgz", - "integrity": "sha512-Ln0UQDlxH1BapMu3GPtf7CuYNwRZf2gwCuPqbyG6pB8WfmFpzqcy4xtAaAMUhnNqjMKTiCPZG2oMT3YSx8U2NA==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/glob-base": { - "version": "0.3.0", - "resolved": "https://registry.npmjs.org/glob-base/-/glob-base-0.3.0.tgz", - "integrity": "sha512-ab1S1g1EbO7YzauaJLkgLp7DZVAqj9M/dvKlTt8DkXA2tiOIcSMrlVI2J1RZyB5iJVccEscjGn+kpOG9788MHA==", + "node_modules/glob": { + "version": "7.2.3", + "resolved": "https://registry.npmjs.org/glob/-/glob-7.2.3.tgz", + "integrity": "sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q==", + "deprecated": "Glob versions prior to v9 are no longer supported", "dev": true, - "license": "MIT", + "license": "ISC", "dependencies": { - "glob-parent": "^2.0.0", - "is-glob": "^2.0.0" + "fs.realpath": "^1.0.0", + "inflight": "^1.0.4", + "inherits": "2", + "minimatch": "^3.1.1", + "once": "^1.3.0", + "path-is-absolute": "^1.0.0" }, "engines": { - "node": ">=0.10.0" + "node": "*" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" } }, "node_modules/glob-parent": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-2.0.0.tgz", - "integrity": "sha512-JDYOvfxio/t42HKdxkAYaCiBN7oYiuxykOxKxdaUW5Qn0zaYN3gRQWolrwdnf0shM9/EP0ebuuTmyoXNr1cC5w==", + "version": "5.1.2", + "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.2.tgz", + "integrity": "sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==", "dev": true, "license": "ISC", "dependencies": { - "is-glob": "^2.0.0" + "is-glob": "^4.0.1" + }, + "engines": { + "node": ">= 6" } }, "node_modules/glob-to-regexp": { @@ -10286,6 +9018,7 @@ "integrity": "sha512-+A4Hq7m7Ze592k9gZRy4gJ27DrXRNnC1vPjxTt1qQxEY8RxagBkBxivkCwg7FxSTG0iLLEMaUx13oOr0R2/qcQ==", "dev": true, "license": "MIT", + "peer": true, "dependencies": { "@sindresorhus/merge-streams": "^4.0.0", "fast-glob": "^3.3.3", @@ -10307,6 +9040,7 @@ "integrity": "sha512-Hs59xBNfUIunMFgWAbGX5cq6893IbWg4KnrjbYwX3tx0ztorVgTDA6B2sxf8ejHJ4wz8BqGUMYlnzNBer5NvGg==", "dev": true, "license": "MIT", + "peer": true, "engines": { "node": ">= 4" } @@ -10317,6 +9051,7 @@ "integrity": "sha512-ZA6oR3T/pEyuqwMgAKT0/hAv8oAXckzbkmR0UkUosQ+Mc4RxGoJkRmwHgHufaenlyAgE1Mxgpdcrf75y6XcnDg==", "dev": true, "license": "MIT", + "peer": true, "engines": { "node": ">=14.16" }, @@ -10379,12 +9114,6 @@ "node": ">=8" } }, - "node_modules/gulp-shell/node_modules/tslib": { - "version": "1.14.1", - "resolved": "https://registry.npmjs.org/tslib/-/tslib-1.14.1.tgz", - "integrity": "sha512-Xni35NKzjgMrwevysHTCArtLDpPvye8zV/0E4EyYn43P7/7qvQwPh9BGkHewbMulVntbigmcT7rdX3BNo9wRJg==", - "license": "0BSD" - }, "node_modules/hard-rejection": { "version": "2.1.0", "resolved": "https://registry.npmjs.org/hard-rejection/-/hard-rejection-2.1.0.tgz", @@ -10407,15 +9136,6 @@ "node": ">=0.10.0" } }, - "node_modules/has-ansi/node_modules/ansi-regex": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-2.1.1.tgz", - "integrity": "sha512-TIGnTpdo+E3+pCyAluZvtED5p5wCqLdezCyhPZzKPcxvFplEt4i+W7OONCKgeZFT3+y5NZZfOOS/Bdcanm1MYA==", - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, "node_modules/has-bigints": { "version": "1.1.0", "resolved": "https://registry.npmjs.org/has-bigints/-/has-bigints-1.1.0.tgz", @@ -10428,23 +9148,6 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/has-binary": { - "version": "0.1.7", - "resolved": "https://registry.npmjs.org/has-binary/-/has-binary-0.1.7.tgz", - "integrity": "sha512-k1Umb4/jrBWZbtL+QKSji8qWeoZ7ZTkXdnDXt1wxwBKAFM0//u96wDj43mBIqCIas8rDQMYyrBEvcS8hdGd4Sg==", - "dev": true, - "license": "MIT", - "dependencies": { - "isarray": "0.0.1" - } - }, - "node_modules/has-cors": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/has-cors/-/has-cors-1.1.0.tgz", - "integrity": "sha512-g5VNKdkFuUuVCP9gYfDJHjK2nqdQJ7aDLTnycnc2+RvsOQbuLdF5pm7vuE5J76SEBIQjs4kQY/BWq74JUmjbXA==", - "dev": true, - "license": "MIT" - }, "node_modules/has-flag": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", @@ -10508,94 +9211,27 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/has-value": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/has-value/-/has-value-1.0.0.tgz", - "integrity": "sha512-IBXk4GTsLYdQ7Rvt+GRBrFSVEkmuOUy4re0Xjd9kJSUQpnTrWR4/y9RpfexN9vkAPMFuQoeWKwqzPozRTlasGw==", + "node_modules/hashery": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/hashery/-/hashery-1.4.0.tgz", + "integrity": "sha512-Wn2i1In6XFxl8Az55kkgnFRiAlIAushzh26PTjL2AKtQcEfXrcLa7Hn5QOWGZEf3LU057P9TwwZjFyxfS1VuvQ==", "dev": true, "license": "MIT", + "peer": true, "dependencies": { - "get-value": "^2.0.6", - "has-values": "^1.0.0", - "isobject": "^3.0.0" + "hookified": "^1.14.0" }, "engines": { - "node": ">=0.10.0" + "node": ">=20" } }, - "node_modules/has-values": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/has-values/-/has-values-1.0.0.tgz", - "integrity": "sha512-ODYZC64uqzmtfGMEAX/FvZiRyWLpAC3vYnNunURUnkGVTS+mI0smVsWaPydRBsE3g+ok7h960jChO8mFcWlHaQ==", - "dev": true, + "node_modules/hasown": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/hasown/-/hasown-2.0.2.tgz", + "integrity": "sha512-0hJU9SCPvmMzIBdZFqNPXWa6dqh7WdH0cII9y+CyS8rG3nL48Bclra9HmKhVVUHyPWNH5Y7xDwAB7bfgSjkUMQ==", "license": "MIT", "dependencies": { - "is-number": "^3.0.0", - "kind-of": "^4.0.0" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/has-values/node_modules/is-number": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/is-number/-/is-number-3.0.0.tgz", - "integrity": "sha512-4cboCqIpliH+mAvFNegjZQ4kgKc3ZUhQVr3HvWbSh5q3WH2v82ct+T2Y1hdU5Gdtorx/cLifQjqCbL7bpznLTg==", - "dev": true, - "license": "MIT", - "dependencies": { - "kind-of": "^3.0.2" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/has-values/node_modules/is-number/node_modules/kind-of": { - "version": "3.2.2", - "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-3.2.2.tgz", - "integrity": "sha512-NOW9QQXMoZGg/oqnVNoNTTIFEIid1627WCffUBJEdMxYApq7mNE7CpzucIPc+ZQg25Phej7IJSmX3hO+oblOtQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "is-buffer": "^1.1.5" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/has-values/node_modules/kind-of": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-4.0.0.tgz", - "integrity": "sha512-24XsCxmEbRwEDbz/qz3stgin8TTzZ1ESR56OMCN0ujYg+vRutNSiOj9bHH9u85DKgXguraugV5sFuvbD4FW/hw==", - "dev": true, - "license": "MIT", - "dependencies": { - "is-buffer": "^1.1.5" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/hashery": { - "version": "1.4.0", - "resolved": "https://registry.npmjs.org/hashery/-/hashery-1.4.0.tgz", - "integrity": "sha512-Wn2i1In6XFxl8Az55kkgnFRiAlIAushzh26PTjL2AKtQcEfXrcLa7Hn5QOWGZEf3LU057P9TwwZjFyxfS1VuvQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "hookified": "^1.14.0" - }, - "engines": { - "node": ">=20" - } - }, - "node_modules/hasown": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/hasown/-/hasown-2.0.2.tgz", - "integrity": "sha512-0hJU9SCPvmMzIBdZFqNPXWa6dqh7WdH0cII9y+CyS8rG3nL48Bclra9HmKhVVUHyPWNH5Y7xDwAB7bfgSjkUMQ==", - "license": "MIT", - "dependencies": { - "function-bind": "^1.1.2" + "function-bind": "^1.1.2" }, "engines": { "node": ">= 0.4" @@ -10637,11 +9273,12 @@ "license": "MIT" }, "node_modules/hookified": { - "version": "1.15.0", - "resolved": "https://registry.npmjs.org/hookified/-/hookified-1.15.0.tgz", - "integrity": "sha512-51w+ZZGt7Zw5q7rM3nC4t3aLn/xvKDETsXqMczndvwyVQhAHfUmUuFBRFcos8Iyebtk7OAE9dL26wFNzZVVOkw==", + "version": "1.15.1", + "resolved": "https://registry.npmjs.org/hookified/-/hookified-1.15.1.tgz", + "integrity": "sha512-MvG/clsADq1GPM2KGo2nyfaWVyn9naPiXrqIe4jYjXNZQt238kWyOGrsyc/DmRAQ+Re6yeo6yX/yoNCG5KAEVg==", "dev": true, - "license": "MIT" + "license": "MIT", + "peer": true }, "node_modules/hosted-git-info": { "version": "4.1.0", @@ -10701,6 +9338,7 @@ "integrity": "sha512-n6l5uca7/y5joxZ3LUePhzmBFUJ+U2YWzhMa8XUTecSeSlQiZdF5XAd/Q3/WUl0VsXgUwWi8I7CNIwdI5WN1SQ==", "dev": true, "license": "MIT", + "peer": true, "engines": { "node": ">=20.10" }, @@ -10742,11 +9380,12 @@ "string_decoder": "~0.10.x" } }, - "node_modules/http-cache-semantics": { - "version": "4.2.0", - "resolved": "https://registry.npmjs.org/http-cache-semantics/-/http-cache-semantics-4.2.0.tgz", - "integrity": "sha512-dTxcvPXqPvXBQpq5dUr6mEMJX4oIEFv6bwom3FDwKRDsuIjjJGANqhBuoAn9c1RQJIdAKav33ED65E2ys+87QQ==", - "license": "BSD-2-Clause" + "node_modules/htmlparser2/node_modules/string_decoder": { + "version": "0.10.31", + "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-0.10.31.tgz", + "integrity": "sha512-ev2QzSzWPYmy9GuqfIVildA4OdcGLeFZQrq5ys6RtiuF+RQQiZWr8TZNyAcuVXyQRYfEO+MsoB/1BuQVhOJuoQ==", + "dev": true, + "license": "MIT" }, "node_modules/http-errors": { "version": "2.0.1", @@ -10837,6 +9476,19 @@ "integrity": "sha512-WDC/ui2VVRrz3jOVi+XtjqkDjiVjTtFaAGiW37k6b+ohyQ5wYDOGkvCZa8+H0nx3gyvv0+BST9xuOgIyGQ00gw==", "license": "BSD-3-Clause" }, + "node_modules/iconv-lite": { + "version": "0.4.24", + "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.4.24.tgz", + "integrity": "sha512-v3MXnZAcvnywkTUEZomIActle7RXXeedOR31wwl7VlyoXO4Qi9arvSenNQWne1TcRwhCL1HwLI21bEqdpj8/rA==", + "dev": true, + "license": "MIT", + "dependencies": { + "safer-buffer": ">= 2.1.2 < 3" + }, + "engines": { + "node": ">=0.10.0" + } + }, "node_modules/icss-utils": { "version": "5.1.0", "resolved": "https://registry.npmjs.org/icss-utils/-/icss-utils-5.1.0.tgz", @@ -10864,9 +9516,9 @@ "license": "MIT" }, "node_modules/immutable": { - "version": "5.1.4", - "resolved": "https://registry.npmjs.org/immutable/-/immutable-5.1.4.tgz", - "integrity": "sha512-p6u1bG3YSnINT5RQmx/yRZBpenIl30kVxkTLDyHLIMk0gict704Q9n+thfDI7lTRm9vXdDYutVzXhzcThxTnXA==", + "version": "5.1.5", + "resolved": "https://registry.npmjs.org/immutable/-/immutable-5.1.5.tgz", + "integrity": "sha512-t7xcm2siw+hlUM68I+UEOK+z84RzmN59as9DZ7P1l0994DKUWV7UXBMQZVxaoMSRQ+PBZbHCOoBt7a2wxOMt+A==", "license": "MIT" }, "node_modules/import-fresh": { @@ -10945,6 +9597,7 @@ "integrity": "sha512-Iqv2fzaTQN28s/FwZAoFq0ZSs/7hMAHJVX+w8PZl3cY19Pxk6jFFalxQoIfW2826i/fDLXv8IiEZRIT0lDuWcg==", "dev": true, "license": "MIT", + "peer": true, "funding": { "type": "github", "url": "https://github.com/sponsors/wooorm" @@ -10976,6 +9629,7 @@ "version": "0.1.4", "resolved": "https://registry.npmjs.org/imurmurhash/-/imurmurhash-0.1.4.tgz", "integrity": "sha512-JmXMZ6wuvDmLiHEml9ykzqO6lwFbof0GG4IkcGaENdCRDDmMVnny7s5HsIgHCbaq0w2MyPhDqkhTUgS2LU2PHA==", + "dev": true, "license": "MIT", "engines": { "node": ">=0.8.19" @@ -10990,12 +9644,6 @@ "node": ">=8" } }, - "node_modules/indexof": { - "version": "0.0.1", - "resolved": "https://registry.npmjs.org/indexof/-/indexof-0.0.1.tgz", - "integrity": "sha512-i0G7hLJ1z0DE8dsqJa2rycj9dBmNKgXBvotXtZYXakU9oivfB9Uj2ZBC27qqef2U58/ZLwalxa1X/RDCdkHtVg==", - "dev": true - }, "node_modules/inflight": { "version": "1.0.6", "resolved": "https://registry.npmjs.org/inflight/-/inflight-1.0.6.tgz", @@ -11021,6 +9669,88 @@ "dev": true, "license": "ISC" }, + "node_modules/inquirer": { + "version": "0.12.0", + "resolved": "https://registry.npmjs.org/inquirer/-/inquirer-0.12.0.tgz", + "integrity": "sha512-bOetEz5+/WpgaW4D1NYOk1aD+JCqRjqu/FwRFgnIfiP7FC/zinsrfyO1vlS3nyH/R7S0IH3BIHBu4DBIDSqiGQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "ansi-escapes": "^1.1.0", + "ansi-regex": "^2.0.0", + "chalk": "^1.0.0", + "cli-cursor": "^1.0.1", + "cli-width": "^2.0.0", + "figures": "^1.3.5", + "lodash": "^4.3.0", + "readline2": "^1.0.1", + "run-async": "^0.1.0", + "rx-lite": "^3.1.2", + "string-width": "^1.0.1", + "strip-ansi": "^3.0.0", + "through": "^2.3.6" + } + }, + "node_modules/inquirer/node_modules/ansi-escapes": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/ansi-escapes/-/ansi-escapes-1.4.0.tgz", + "integrity": "sha512-wiXutNjDUlNEDWHcYH3jtZUhd3c4/VojassD8zHdHCY13xbZy2XbW+NKQwA0tWGBVzDA9qEzYwfoSsWmviidhw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/inquirer/node_modules/ansi-styles": { + "version": "2.2.1", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-2.2.1.tgz", + "integrity": "sha512-kmCevFghRiWM7HB5zTPULl4r9bVFSWjz62MhqizDGUrq2NWuNMQyuv4tHHoKJHs69M/MF64lEcHdYIocrdWQYA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/inquirer/node_modules/chalk": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-1.1.3.tgz", + "integrity": "sha512-U3lRVLMSlsCfjqYPbLyVv11M9CPW4I728d6TCKMAOJueEeB9/8o+eSsMnxPJD+Q+K909sdESg7C+tIkoH6on1A==", + "dev": true, + "license": "MIT", + "dependencies": { + "ansi-styles": "^2.2.1", + "escape-string-regexp": "^1.0.2", + "has-ansi": "^2.0.0", + "strip-ansi": "^3.0.0", + "supports-color": "^2.0.0" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/inquirer/node_modules/strip-ansi": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-3.0.1.tgz", + "integrity": "sha512-VhumSSbBqDTP8p2ZLKj40UjBCV4+v8bUSEpUb4KjRgWk9pbqGF4REFj6KEagidb2f/M6AzC0EmFyDNGaw9OCzg==", + "dev": true, + "license": "MIT", + "dependencies": { + "ansi-regex": "^2.0.0" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/inquirer/node_modules/supports-color": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-2.0.0.tgz", + "integrity": "sha512-KKNVtd6pCYgPIKU4cp2733HWYCpplQhddZLBUryaAHou723x+FRzQ5Df824Fj+IyyuiQTRoub4SnIFfIcrp70g==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.8.0" + } + }, "node_modules/internal-slot": { "version": "1.1.0", "resolved": "https://registry.npmjs.org/internal-slot/-/internal-slot-1.1.0.tgz", @@ -11054,15 +9784,6 @@ "loose-envify": "^1.0.0" } }, - "node_modules/ip-address": { - "version": "10.1.0", - "resolved": "https://registry.npmjs.org/ip-address/-/ip-address-10.1.0.tgz", - "integrity": "sha512-XXADHxXmvT9+CRxhXg56LJovE+bmWnEWB78LB83VZTprKTmaC5QfruXocxzTZ2Kl0DNwKuBdlIhjL8LeY8Sf8Q==", - "license": "MIT", - "engines": { - "node": ">= 12" - } - }, "node_modules/irregular-plurals": { "version": "3.5.0", "resolved": "https://registry.npmjs.org/irregular-plurals/-/irregular-plurals-3.5.0.tgz", @@ -11073,19 +9794,6 @@ "node": ">=8" } }, - "node_modules/is-accessor-descriptor": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/is-accessor-descriptor/-/is-accessor-descriptor-1.0.1.tgz", - "integrity": "sha512-YBUanLI8Yoihw923YeFUS5fs0fF2f5TSFTNiYAAzhhDscDa3lEqYuz1pDOEP5KvX94I9ey3vsqjJcLVFVU+3QA==", - "dev": true, - "license": "MIT", - "dependencies": { - "hasown": "^2.0.0" - }, - "engines": { - "node": ">= 0.10" - } - }, "node_modules/is-arguments": { "version": "1.2.0", "resolved": "https://registry.npmjs.org/is-arguments/-/is-arguments-1.2.0.tgz", @@ -11161,16 +9869,16 @@ } }, "node_modules/is-binary-path": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/is-binary-path/-/is-binary-path-1.0.1.tgz", - "integrity": "sha512-9fRVlXc0uCxEDj1nQzaWONSpbTfx0FmJfzHF7pwlI8DkWGoHBBea4Pg5Ky0ojwwxQmnSifgbKkI06Qv0Ljgj+Q==", + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/is-binary-path/-/is-binary-path-2.1.0.tgz", + "integrity": "sha512-ZMERYes6pDydyuGidse7OsHxtbI7WVeUEozgR/g7rd0xUimYNlvZRE/K2MgZTjWy725IfelLeVcEM97mmtRGXw==", "dev": true, "license": "MIT", "dependencies": { - "binary-extensions": "^1.0.0" + "binary-extensions": "^2.0.0" }, "engines": { - "node": ">=0.10.0" + "node": ">=8" } }, "node_modules/is-boolean-object": { @@ -11189,13 +9897,6 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/is-buffer": { - "version": "1.1.6", - "resolved": "https://registry.npmjs.org/is-buffer/-/is-buffer-1.1.6.tgz", - "integrity": "sha512-NcdALwpXkTm5Zvvbk7owOUSvVvBKDgKP5/ewfXEznmQFfs4ZRmanOeKBTjRVjka3QFoN6XJ+9F3USqfHqTaU5w==", - "dev": true, - "license": "MIT" - }, "node_modules/is-callable": { "version": "1.2.7", "resolved": "https://registry.npmjs.org/is-callable/-/is-callable-1.2.7.tgz", @@ -11223,19 +9924,6 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/is-data-descriptor": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/is-data-descriptor/-/is-data-descriptor-1.0.1.tgz", - "integrity": "sha512-bc4NlCDiCr28U4aEsQ3Qs2491gVq4V8G7MQyws968ImqjKuYtTJXrl7Vq7jsN7Ly/C3xj5KWFrY7sHNeDkAzXw==", - "dev": true, - "license": "MIT", - "dependencies": { - "hasown": "^2.0.0" - }, - "engines": { - "node": ">= 0.4" - } - }, "node_modules/is-data-view": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/is-data-view/-/is-data-view-1.0.2.tgz", @@ -11269,20 +9957,6 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/is-descriptor": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/is-descriptor/-/is-descriptor-1.0.3.tgz", - "integrity": "sha512-JCNNGbwWZEVaSPtS45mdtrneRWJFp07LLmykxeFV5F6oBvNF8vHSfJuJgoT472pSfk+Mf8VnlrspaFBHWM8JAw==", - "dev": true, - "license": "MIT", - "dependencies": { - "is-accessor-descriptor": "^1.0.1", - "is-data-descriptor": "^1.0.1" - }, - "engines": { - "node": ">= 0.4" - } - }, "node_modules/is-docker": { "version": "2.2.1", "resolved": "https://registry.npmjs.org/is-docker/-/is-docker-2.2.1.tgz", @@ -11299,29 +9973,6 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/is-dotfile": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/is-dotfile/-/is-dotfile-1.0.3.tgz", - "integrity": "sha512-9YclgOGtN/f8zx0Pr4FQYMdibBiTaH3sn52vjYip4ZSf6C4/6RfTEZ+MR4GvKhCxdPh21Bg42/WL55f6KSnKpg==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/is-equal-shallow": { - "version": "0.1.3", - "resolved": "https://registry.npmjs.org/is-equal-shallow/-/is-equal-shallow-0.1.3.tgz", - "integrity": "sha512-0EygVC5qPvIyb+gSz7zdD5/AAoS6Qrx1e//6N4yv4oNm30kqvdmG66oZFWVlQHUWe5OjP08FuTw2IdT0EOTcYA==", - "dev": true, - "license": "MIT", - "dependencies": { - "is-primitive": "^2.0.0" - }, - "engines": { - "node": ">=0.10.0" - } - }, "node_modules/is-extendable": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/is-extendable/-/is-extendable-1.0.1.tgz", @@ -11335,10 +9986,10 @@ } }, "node_modules/is-extglob": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/is-extglob/-/is-extglob-1.0.0.tgz", - "integrity": "sha512-7Q+VbVafe6x2T+Tu6NcOf6sRklazEPmBoB3IWk3WdGZM2iGUwU/Oe3Wtq5lSEkDTTlpp8yx+5t4pzO/i9Ty1ww==", - "dev": true, + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/is-extglob/-/is-extglob-2.1.1.tgz", + "integrity": "sha512-SbKbANkN603Vi4jEZv49LeVJMn4yGwsbzZworEoyEiutsN3nJYdbO36zfhGJ6QEDpOZIFkDtnq5JRxmvl3jsoQ==", + "devOptional": true, "license": "MIT", "engines": { "node": ">=0.10.0" @@ -11360,12 +10011,16 @@ } }, "node_modules/is-fullwidth-code-point": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz", - "integrity": "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==", + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-1.0.0.tgz", + "integrity": "sha512-1pqUqRjkhPJ9miNq9SwMfdvi6lBJcd6eFxvfaivQhaH3SgisfiuudvFntdKOmxuee/77l+FPjKrQjWvmPjWrRw==", + "dev": true, "license": "MIT", + "dependencies": { + "number-is-nan": "^1.0.0" + }, "engines": { - "node": ">=8" + "node": ">=0.10.0" } }, "node_modules/is-generator-fn": { @@ -11398,13 +10053,13 @@ } }, "node_modules/is-glob": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/is-glob/-/is-glob-2.0.1.tgz", - "integrity": "sha512-a1dBeB19NXsf/E0+FHqkagizel/LQw2DjSQpvQrj3zT+jYPpaUCryPnrQajXKFLCMuf4I6FhRpaGtw4lPrG6Eg==", - "dev": true, + "version": "4.0.3", + "resolved": "https://registry.npmjs.org/is-glob/-/is-glob-4.0.3.tgz", + "integrity": "sha512-xelSayHH36ZgE7ZWhli7pW34hNbNl8Ojv5KVmkJD4hBdD3th8Tfk9vYasLM+mXWOZhFkgZfxhLSnrwRr4elSSg==", + "devOptional": true, "license": "MIT", "dependencies": { - "is-extglob": "^1.0.0" + "is-extglob": "^2.1.1" }, "engines": { "node": ">=0.10.0" @@ -11456,12 +10111,12 @@ } }, "node_modules/is-number": { - "version": "0.1.1", - "resolved": "https://registry.npmjs.org/is-number/-/is-number-0.1.1.tgz", - "integrity": "sha512-la5kPULwIgkSSaZj9w7/A1uHqOBAgOhDUKQ5CkfL8LZ4Si6r4+2D0hI6b4o60MW4Uj2yNJARWIZUDPxlvOYQcw==", - "dev": true, + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz", + "integrity": "sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==", + "license": "MIT", "engines": { - "node": ">=0.10.0" + "node": ">=0.12.0" } }, "node_modules/is-number-object": { @@ -11486,6 +10141,7 @@ "integrity": "sha512-lJJV/5dYS+RcL8uQdBDW9c9uWFLLBNRyFhnAKXw5tVqLlKZ4RMGZKv+YQ/IA3OhD+RpbJa1LLFM1FQPGyIXvOA==", "dev": true, "license": "MIT", + "peer": true, "engines": { "node": ">=12" }, @@ -11515,32 +10171,12 @@ "node": ">=0.10.0" } }, - "node_modules/is-posix-bracket": { - "version": "0.1.1", - "resolved": "https://registry.npmjs.org/is-posix-bracket/-/is-posix-bracket-0.1.1.tgz", - "integrity": "sha512-Yu68oeXJ7LeWNmZ3Zov/xg/oDBnBK2RNxwYY1ilNJX+tKKZqgPK+qOn/Gs9jEu66KDY9Netf5XLKNGzas/vPfQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, "node_modules/is-potential-custom-element-name": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/is-potential-custom-element-name/-/is-potential-custom-element-name-1.0.1.tgz", "integrity": "sha512-bCYeRA2rVibKZd+s2625gGnGF/t7DSqDs4dP7CrLA1m7jKWz6pps0LpYLJN8Q64HtmPKJ1hrN3nzPNKFEKOUiQ==", "license": "MIT" }, - "node_modules/is-primitive": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/is-primitive/-/is-primitive-2.0.0.tgz", - "integrity": "sha512-N3w1tFaRfk3UrPfqeRyD+GYDASU3W5VinKhlORy8EWVf/sIdDL9GAcew85XmktCfH+ngG7SRXEVDoO18WMdB/Q==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, "node_modules/is-property": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/is-property/-/is-property-1.0.2.tgz", @@ -11661,6 +10297,19 @@ "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/is-unicode-supported": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/is-unicode-supported/-/is-unicode-supported-2.1.0.tgz", + "integrity": "sha512-mE00Gnza5EEB3Ds0HfMyllZzbBrmLOX3vfWoj9A9PEnTfratQ/BcaJOuMhnkhjXvb2+FkY3VuHqtAGpTPmglFQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/is-weakmap": { "version": "2.0.2", "resolved": "https://registry.npmjs.org/is-weakmap/-/is-weakmap-2.0.2.tgz", @@ -11704,16 +10353,6 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/is-windows": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/is-windows/-/is-windows-1.0.2.tgz", - "integrity": "sha512-eXK1UInq2bPmjyX6e3VHIzMLobc4J94i4AWn+Hpq3OU5KkrRC96OAcR3PRJ/pGu6m8TRnBHP9dkXQVsT/COVIA==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, "node_modules/is-wsl": { "version": "2.2.0", "resolved": "https://registry.npmjs.org/is-wsl/-/is-wsl-2.2.0.tgz", @@ -11734,22 +10373,23 @@ "license": "MIT" }, "node_modules/isbinaryfile": { - "version": "3.0.3", - "resolved": "https://registry.npmjs.org/isbinaryfile/-/isbinaryfile-3.0.3.tgz", - "integrity": "sha512-8cJBL5tTd2OS0dM4jz07wQd5g0dCCqIhUxPIGtZfa5L6hWlvV5MHTITy/DBAsF+Oe2LS1X3krBUhNwaGUWpWxw==", + "version": "4.0.10", + "resolved": "https://registry.npmjs.org/isbinaryfile/-/isbinaryfile-4.0.10.tgz", + "integrity": "sha512-iHrqe5shvBUcFbmZq9zOQHBoeOhZJu6RQGrDpBgenUm/Am+F3JM2MgQj+rK3Z601fzrL5gLZWtAPH2OBaSVcyw==", "dev": true, "license": "MIT", - "dependencies": { - "buffer-alloc": "^1.2.0" - }, "engines": { - "node": ">=0.6.0" + "node": ">= 8.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/gjtorikian/" } }, "node_modules/isexe": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/isexe/-/isexe-2.0.0.tgz", "integrity": "sha512-RHxMLp9lnKHGHRng9QFhRCMbYAcVpn69smSGcq3f36xjgVVWThj4qqLbTLlq7Ssj8B+fIQ1EuCEGI2lKsyQeIw==", + "dev": true, "license": "ISC" }, "node_modules/isobject": { @@ -11842,28 +10482,12 @@ "node": ">=8" } }, - "node_modules/jackspeak": { - "version": "3.4.3", - "resolved": "https://registry.npmjs.org/jackspeak/-/jackspeak-3.4.3.tgz", - "integrity": "sha512-OGlZQpz2yfahA/Rd1Y8Cd9SIEsqvXkLVoSw/cgwhnhFMDbsQFeZYoJJ7bIZBS9BcamUW96asq/npPWugM+RQBw==", - "license": "BlueOak-1.0.0", - "dependencies": { - "@isaacs/cliui": "^8.0.2" - }, - "funding": { - "url": "https://github.com/sponsors/isaacs" - }, - "optionalDependencies": { - "@pkgjs/parseargs": "^0.11.0" - } - }, "node_modules/jasmine-core": { - "version": "2.6.4", - "resolved": "https://registry.npmjs.org/jasmine-core/-/jasmine-core-2.6.4.tgz", - "integrity": "sha512-HUYBYi/hlSnCIr8QH9xuDBJUAzSHS0El3HxTomovIQcNxtbNhoOtKwpEZaB/jq3sfW/qyhqwW/VDUtoB2RZ4Tg==", + "version": "2.99.1", + "resolved": "https://registry.npmjs.org/jasmine-core/-/jasmine-core-2.99.1.tgz", + "integrity": "sha512-ra97U4qu3OCcIxvN6eg3kyy8bLrID/TgxafSGMMICg3SFx5C/sUfDPpiOh7yoIsHdtjrOVdtT9rieYhqOsh9Ww==", "dev": true, - "license": "MIT", - "peer": true + "license": "MIT" }, "node_modules/jasmine-jquery": { "version": "2.1.1", @@ -12074,52 +10698,6 @@ "url": "https://github.com/chalk/ansi-styles?sponsor=1" } }, - "node_modules/jest-config/node_modules/brace-expansion": { - "version": "1.1.12", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.12.tgz", - "integrity": "sha512-9T9UjW3r0UW5c1Q7GTwllptXwhvYmEzFhzMfZ9H7FQWt+uZePjZPjBP/W1ZEyZ1twGWom5/56TF4lPcqjnDHcg==", - "dev": true, - "license": "MIT", - "dependencies": { - "balanced-match": "^1.0.0", - "concat-map": "0.0.1" - } - }, - "node_modules/jest-config/node_modules/glob": { - "version": "7.2.3", - "resolved": "https://registry.npmjs.org/glob/-/glob-7.2.3.tgz", - "integrity": "sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q==", - "deprecated": "Glob versions prior to v9 are no longer supported", - "dev": true, - "license": "ISC", - "dependencies": { - "fs.realpath": "^1.0.0", - "inflight": "^1.0.4", - "inherits": "2", - "minimatch": "^3.1.1", - "once": "^1.3.0", - "path-is-absolute": "^1.0.0" - }, - "engines": { - "node": "*" - }, - "funding": { - "url": "https://github.com/sponsors/isaacs" - } - }, - "node_modules/jest-config/node_modules/minimatch": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", - "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", - "dev": true, - "license": "ISC", - "dependencies": { - "brace-expansion": "^1.1.7" - }, - "engines": { - "node": "*" - } - }, "node_modules/jest-config/node_modules/pretty-format": { "version": "29.7.0", "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-29.7.0.tgz", @@ -12339,21 +10917,6 @@ "fsevents": "^2.3.2" } }, - "node_modules/jest-haste-map/node_modules/fsevents": { - "version": "2.3.3", - "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.3.3.tgz", - "integrity": "sha512-5xoDfX+fL7faATnagmWPpbFtwh/R77WmMMqqHGS65C3vvB0YHrgF+B1YmZ3441tMj5n63k0212XNoJwzlhffQw==", - "dev": true, - "hasInstallScript": true, - "license": "MIT", - "optional": true, - "os": [ - "darwin" - ], - "engines": { - "node": "^8.16.0 || ^10.6.0 || >=11.0.0" - } - }, "node_modules/jest-leak-detector": { "version": "29.7.0", "resolved": "https://registry.npmjs.org/jest-leak-detector/-/jest-leak-detector-29.7.0.tgz", @@ -12650,52 +11213,6 @@ "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, - "node_modules/jest-runtime/node_modules/brace-expansion": { - "version": "1.1.12", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.12.tgz", - "integrity": "sha512-9T9UjW3r0UW5c1Q7GTwllptXwhvYmEzFhzMfZ9H7FQWt+uZePjZPjBP/W1ZEyZ1twGWom5/56TF4lPcqjnDHcg==", - "dev": true, - "license": "MIT", - "dependencies": { - "balanced-match": "^1.0.0", - "concat-map": "0.0.1" - } - }, - "node_modules/jest-runtime/node_modules/glob": { - "version": "7.2.3", - "resolved": "https://registry.npmjs.org/glob/-/glob-7.2.3.tgz", - "integrity": "sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q==", - "deprecated": "Glob versions prior to v9 are no longer supported", - "dev": true, - "license": "ISC", - "dependencies": { - "fs.realpath": "^1.0.0", - "inflight": "^1.0.4", - "inherits": "2", - "minimatch": "^3.1.1", - "once": "^1.3.0", - "path-is-absolute": "^1.0.0" - }, - "engines": { - "node": "*" - }, - "funding": { - "url": "https://github.com/sponsors/isaacs" - } - }, - "node_modules/jest-runtime/node_modules/minimatch": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", - "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", - "dev": true, - "license": "ISC", - "dependencies": { - "brace-expansion": "^1.1.7" - }, - "engines": { - "node": "*" - } - }, "node_modules/jest-snapshot": { "version": "29.7.0", "resolved": "https://registry.npmjs.org/jest-snapshot/-/jest-snapshot-29.7.0.tgz", @@ -12916,8 +11433,7 @@ "resolved": "https://registry.npmjs.org/jquery/-/jquery-2.2.4.tgz", "integrity": "sha512-lBHj60ezci2u1v2FqnZIraShGgEXq35qCzMv4lITyHGppTnA13rwR0MgwyNJh9TnDs3aXUvd1xjAotfraMHX/Q==", "deprecated": "This version is deprecated. Please upgrade to the latest version or find support at https://www.herodevs.com/support/jquery-nes.", - "license": "MIT", - "peer": true + "license": "MIT" }, "node_modules/jquery-migrate": { "version": "1.4.1", @@ -13040,17 +11556,6 @@ "jshint": "bin/jshint" } }, - "node_modules/jshint/node_modules/brace-expansion": { - "version": "1.1.12", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.12.tgz", - "integrity": "sha512-9T9UjW3r0UW5c1Q7GTwllptXwhvYmEzFhzMfZ9H7FQWt+uZePjZPjBP/W1ZEyZ1twGWom5/56TF4lPcqjnDHcg==", - "dev": true, - "license": "MIT", - "dependencies": { - "balanced-match": "^1.0.0", - "concat-map": "0.0.1" - } - }, "node_modules/jshint/node_modules/minimatch": { "version": "3.0.8", "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.0.8.tgz", @@ -13101,6 +11606,7 @@ "version": "2.3.1", "resolved": "https://registry.npmjs.org/json-parse-even-better-errors/-/json-parse-even-better-errors-2.3.1.tgz", "integrity": "sha512-xyFwyhro/JEof6Ghe2iz2NcXoj2sloNsWr/XsERDK/oiPCfaNhl5ONfp+jQdAZRQQ0IJWNzH9zIZF7li91kh2w==", + "dev": true, "license": "MIT" }, "node_modules/json-schema-traverse": { @@ -13145,13 +11651,6 @@ "string-convert": "^0.2.0" } }, - "node_modules/json3": { - "version": "3.3.2", - "resolved": "https://registry.npmjs.org/json3/-/json3-3.3.2.tgz", - "integrity": "sha512-I5YLeauH3rIaE99EE++UeH2M2gSYo8/2TqDac7oZEH6D/DSQ4Woa628Qrfj1X9/OY5Mk5VvIDQaKCDchXaKrmA==", - "deprecated": "Please use the native JSON object instead of JSON 3", - "dev": true - }, "node_modules/json5": { "version": "2.2.3", "resolved": "https://registry.npmjs.org/json5/-/json5-2.2.3.tgz", @@ -13207,46 +11706,6 @@ "setimmediate": "^1.0.5" } }, - "node_modules/jszip/node_modules/isarray": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/isarray/-/isarray-1.0.0.tgz", - "integrity": "sha512-VLghIWNM6ELQzo7zwmcg0NmTVyWKYjvIeM83yjp0wRDTmUnrM678fQbcKBo6n2CJEF0szoG//ytg+TKla89ALQ==", - "dev": true, - "license": "MIT" - }, - "node_modules/jszip/node_modules/readable-stream": { - "version": "2.3.8", - "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-2.3.8.tgz", - "integrity": "sha512-8p0AUk4XODgIewSi0l8Epjs+EVnWiK7NoDIEGU0HhE7+ZyY8D1IMY7odu5lRrFXGg71L15KG8QrPmum45RTtdA==", - "dev": true, - "license": "MIT", - "dependencies": { - "core-util-is": "~1.0.0", - "inherits": "~2.0.3", - "isarray": "~1.0.0", - "process-nextick-args": "~2.0.0", - "safe-buffer": "~5.1.1", - "string_decoder": "~1.1.1", - "util-deprecate": "~1.0.1" - } - }, - "node_modules/jszip/node_modules/safe-buffer": { - "version": "5.1.2", - "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.1.2.tgz", - "integrity": "sha512-Gd2UZBJDkXlY7GbJxfsE8/nvKkUEU1G38c1siN6QP6a9PT9MmHB8GnpscSmMJSoF8LOIrt8ud/wPtojys4G6+g==", - "dev": true, - "license": "MIT" - }, - "node_modules/jszip/node_modules/string_decoder": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.1.1.tgz", - "integrity": "sha512-n/ShnvDi6FHbbVfviro+WojiFzv+s8MPMHBczVePfUpDJLwoLT0ht1l4YwBCbi8pJAveEEdnkHyPyTP/mzRfwg==", - "dev": true, - "license": "MIT", - "dependencies": { - "safe-buffer": "~5.1.0" - } - }, "node_modules/just-extend": { "version": "6.2.0", "resolved": "https://registry.npmjs.org/just-extend/-/just-extend-6.2.0.tgz", @@ -13255,42 +11714,42 @@ "license": "MIT" }, "node_modules/karma": { - "version": "0.13.22", - "resolved": "https://registry.npmjs.org/karma/-/karma-0.13.22.tgz", - "integrity": "sha512-A9/7e/IzHUkTcfjnTy5Wzo2P5wPuf7+QZh1JzNdTpYA0AN/vSrxfFjPKtKC3jRYJFZMJ7S1I9L2LItaJS1XMSg==", + "version": "6.4.4", + "resolved": "https://registry.npmjs.org/karma/-/karma-6.4.4.tgz", + "integrity": "sha512-LrtUxbdvt1gOpo3gxG+VAJlJAEMhbWlM4YrFQgql98FwF7+K8K12LYO4hnDdUkNjeztYrOXEMqgTajSWgmtI/w==", "dev": true, "license": "MIT", - "peer": true, "dependencies": { - "batch": "^0.5.3", - "bluebird": "^2.9.27", - "body-parser": "^1.12.4", - "chokidar": "^1.4.1", - "colors": "^1.1.0", - "connect": "^3.3.5", - "core-js": "^2.1.0", + "@colors/colors": "1.5.0", + "body-parser": "^1.19.0", + "braces": "^3.0.2", + "chokidar": "^3.5.1", + "connect": "^3.7.0", "di": "^0.0.1", - "dom-serialize": "^2.2.0", - "expand-braces": "^0.1.1", - "glob": "^7.0.0", - "graceful-fs": "^4.1.2", - "http-proxy": "^1.13.0", - "isbinaryfile": "^3.0.0", - "lodash": "^3.8.0", - "log4js": "^0.6.31", - "mime": "^1.3.4", - "minimatch": "^3.0.0", - "optimist": "^0.6.1", - "rimraf": "^2.3.3", - "socket.io": "^1.4.5", - "source-map": "^0.5.3", - "useragent": "^2.1.6" + "dom-serialize": "^2.2.1", + "glob": "^7.1.7", + "graceful-fs": "^4.2.6", + "http-proxy": "^1.18.1", + "isbinaryfile": "^4.0.8", + "lodash": "^4.17.21", + "log4js": "^6.4.1", + "mime": "^2.5.2", + "minimatch": "^3.0.4", + "mkdirp": "^0.5.5", + "qjobs": "^1.2.0", + "range-parser": "^1.2.1", + "rimraf": "^3.0.2", + "socket.io": "^4.7.2", + "source-map": "^0.6.1", + "tmp": "^0.2.1", + "ua-parser-js": "^0.7.30", + "yargs": "^16.1.1" }, "bin": { "karma": "bin/karma" }, "engines": { - "node": "0.10 || 0.12 || 4 || 5" + "node": ">= 10" } }, "node_modules/karma-chrome-launcher": { @@ -13334,30 +11793,6 @@ "node": ">=10.0.0" } }, - "node_modules/karma-coverage/node_modules/brace-expansion": { - "version": "1.1.12", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.12.tgz", - "integrity": "sha512-9T9UjW3r0UW5c1Q7GTwllptXwhvYmEzFhzMfZ9H7FQWt+uZePjZPjBP/W1ZEyZ1twGWom5/56TF4lPcqjnDHcg==", - "dev": true, - "license": "MIT", - "dependencies": { - "balanced-match": "^1.0.0", - "concat-map": "0.0.1" - } - }, - "node_modules/karma-coverage/node_modules/minimatch": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", - "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", - "dev": true, - "license": "ISC", - "dependencies": { - "brace-expansion": "^1.1.7" - }, - "engines": { - "node": "*" - } - }, "node_modules/karma-firefox-launcher": { "version": "2.1.3", "resolved": "https://registry.npmjs.org/karma-firefox-launcher/-/karma-firefox-launcher-2.1.3.tgz", @@ -13386,13 +11821,17 @@ } }, "node_modules/karma-jasmine": { - "version": "0.3.8", - "resolved": "https://registry.npmjs.org/karma-jasmine/-/karma-jasmine-0.3.8.tgz", - "integrity": "sha512-EDNIM4f9FV17XXoF+Rzfw+6uPajd7tOAfEFwe7PIyNVQrM3l1V5OJj2167JDY9KmLDIK/MQZX7tKkK1jVYlfmw==", + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/karma-jasmine/-/karma-jasmine-1.1.2.tgz", + "integrity": "sha512-SENGE9DhlIIFTSZWiNq4eGeXL8G6z9cqHIOdkx9jh1qhhQqwEy3tAoLRyER0vOcHqdOlKmGpOuXk+HOipIy7sg==", "dev": true, "license": "MIT", + "engines": { + "node": ">= 4" + }, "peerDependencies": { - "jasmine-core": "*" + "jasmine-core": "*", + "karma": "*" } }, "node_modules/karma-jasmine-html-reporter": { @@ -13408,20 +11847,6 @@ "karma": ">=0.9" } }, - "node_modules/karma-jasmine-html-reporter/node_modules/karma-jasmine": { - "version": "1.1.2", - "resolved": "https://registry.npmjs.org/karma-jasmine/-/karma-jasmine-1.1.2.tgz", - "integrity": "sha512-SENGE9DhlIIFTSZWiNq4eGeXL8G6z9cqHIOdkx9jh1qhhQqwEy3tAoLRyER0vOcHqdOlKmGpOuXk+HOipIy7sg==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 4" - }, - "peerDependencies": { - "jasmine-core": "*", - "karma": "*" - } - }, "node_modules/karma-junit-reporter": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/karma-junit-reporter/-/karma-junit-reporter-2.0.1.tgz", @@ -13491,50 +11916,14 @@ "webpack": "^5.0.0" } }, - "node_modules/karma-webpack/node_modules/glob": { - "version": "7.2.3", - "resolved": "https://registry.npmjs.org/glob/-/glob-7.2.3.tgz", - "integrity": "sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q==", - "deprecated": "Glob versions prior to v9 are no longer supported", + "node_modules/karma-webpack/node_modules/brace-expansion": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.2.tgz", + "integrity": "sha512-Jt0vHyM+jmUBqojB7E1NIYadt0vI0Qxjxd2TErW94wDz+E2LAm5vKMXXwg6ZZBTHPuUlDgQHKXvjGBdfcF1ZDQ==", "dev": true, - "license": "ISC", + "license": "MIT", "dependencies": { - "fs.realpath": "^1.0.0", - "inflight": "^1.0.4", - "inherits": "2", - "minimatch": "^3.1.1", - "once": "^1.3.0", - "path-is-absolute": "^1.0.0" - }, - "engines": { - "node": "*" - }, - "funding": { - "url": "https://github.com/sponsors/isaacs" - } - }, - "node_modules/karma-webpack/node_modules/glob/node_modules/brace-expansion": { - "version": "1.1.12", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.12.tgz", - "integrity": "sha512-9T9UjW3r0UW5c1Q7GTwllptXwhvYmEzFhzMfZ9H7FQWt+uZePjZPjBP/W1ZEyZ1twGWom5/56TF4lPcqjnDHcg==", - "dev": true, - "license": "MIT", - "dependencies": { - "balanced-match": "^1.0.0", - "concat-map": "0.0.1" - } - }, - "node_modules/karma-webpack/node_modules/glob/node_modules/minimatch": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", - "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", - "dev": true, - "license": "ISC", - "dependencies": { - "brace-expansion": "^1.1.7" - }, - "engines": { - "node": "*" + "balanced-match": "^1.0.0" } }, "node_modules/karma-webpack/node_modules/minimatch": { @@ -13563,57 +11952,80 @@ "lodash": "^4.17.15" } }, - "node_modules/karma/node_modules/brace-expansion": { - "version": "1.1.12", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.12.tgz", - "integrity": "sha512-9T9UjW3r0UW5c1Q7GTwllptXwhvYmEzFhzMfZ9H7FQWt+uZePjZPjBP/W1ZEyZ1twGWom5/56TF4lPcqjnDHcg==", + "node_modules/karma/node_modules/cliui": { + "version": "7.0.4", + "resolved": "https://registry.npmjs.org/cliui/-/cliui-7.0.4.tgz", + "integrity": "sha512-OcRE68cOsVMXp1Yvonl/fzkQOyjLSu/8bhPDfQt0e0/Eb283TKP20Fs2MqoPsr9SwA595rRCA+QMzYc9nBP+JQ==", "dev": true, - "license": "MIT", + "license": "ISC", "dependencies": { - "balanced-match": "^1.0.0", - "concat-map": "0.0.1" + "string-width": "^4.2.0", + "strip-ansi": "^6.0.0", + "wrap-ansi": "^7.0.0" } }, - "node_modules/karma/node_modules/glob": { - "version": "7.2.3", - "resolved": "https://registry.npmjs.org/glob/-/glob-7.2.3.tgz", - "integrity": "sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q==", - "deprecated": "Glob versions prior to v9 are no longer supported", + "node_modules/karma/node_modules/is-fullwidth-code-point": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz", + "integrity": "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==", "dev": true, - "license": "ISC", + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/karma/node_modules/source-map": { + "version": "0.6.1", + "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", + "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", + "dev": true, + "license": "BSD-3-Clause", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/karma/node_modules/string-width": { + "version": "4.2.3", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", + "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", + "dev": true, + "license": "MIT", "dependencies": { - "fs.realpath": "^1.0.0", - "inflight": "^1.0.4", - "inherits": "2", - "minimatch": "^3.1.1", - "once": "^1.3.0", - "path-is-absolute": "^1.0.0" + "emoji-regex": "^8.0.0", + "is-fullwidth-code-point": "^3.0.0", + "strip-ansi": "^6.0.1" }, "engines": { - "node": "*" - }, - "funding": { - "url": "https://github.com/sponsors/isaacs" + "node": ">=8" } }, - "node_modules/karma/node_modules/lodash": { - "version": "3.10.1", - "resolved": "https://registry.npmjs.org/lodash/-/lodash-3.10.1.tgz", - "integrity": "sha512-9mDDwqVIma6OZX79ZlDACZl8sBm0TEnkf99zV3iMA4GzkIT/9hiqP5mY0HoT1iNLCrKc/R1HByV+yJfRWVJryQ==", + "node_modules/karma/node_modules/yargs": { + "version": "16.2.0", + "resolved": "https://registry.npmjs.org/yargs/-/yargs-16.2.0.tgz", + "integrity": "sha512-D1mvvtDG0L5ft/jGWkLpG1+m0eQxOfaBvTNELraWj22wSVUMWxZUvYgJYcKh6jGGIkJFhH4IZPQhR4TKpc8mBw==", "dev": true, - "license": "MIT" + "license": "MIT", + "dependencies": { + "cliui": "^7.0.2", + "escalade": "^3.1.1", + "get-caller-file": "^2.0.5", + "require-directory": "^2.1.1", + "string-width": "^4.2.0", + "y18n": "^5.0.5", + "yargs-parser": "^20.2.2" + }, + "engines": { + "node": ">=10" + } }, - "node_modules/karma/node_modules/minimatch": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", - "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", + "node_modules/karma/node_modules/yargs-parser": { + "version": "20.2.9", + "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-20.2.9.tgz", + "integrity": "sha512-y11nGElTIV+CT3Zv9t7VKl+Q3hTQoT9a1Qzezhhl6Rp21gJ/IVTW7Z3y9EWXhuUBC2Shnf+DX0antecpAwSP8w==", "dev": true, "license": "ISC", - "dependencies": { - "brace-expansion": "^1.1.7" - }, "engines": { - "node": "*" + "node": ">=10" } }, "node_modules/keyv": { @@ -13660,7 +12072,8 @@ "resolved": "https://registry.npmjs.org/known-css-properties/-/known-css-properties-0.37.0.tgz", "integrity": "sha512-JCDrsP4Z1Sb9JwG0aJ8Eo2r7k4Ou5MwmThS/6lcIe1ICyb7UBJKGRIUUdqc2ASdE/42lgz6zFUnzAIhtXnBVrQ==", "dev": true, - "license": "MIT" + "license": "MIT", + "peer": true }, "node_modules/leven": { "version": "3.1.0", @@ -13742,15 +12155,6 @@ "json5": "lib/cli.js" } }, - "node_modules/loader-utils/node_modules/minimist": { - "version": "1.2.8", - "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.8.tgz", - "integrity": "sha512-2yyAR8qBkN3YuheJanUpWC5U3bb5osDywNB8RzDVlDwDHbocAJveqqj1u8+SVD7jkWT4yvsHCpWqqWqAxb0zCA==", - "license": "MIT", - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, "node_modules/locate-path": { "version": "5.0.0", "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-5.0.0.tgz", @@ -13815,29 +12219,38 @@ "dev": true, "license": "MIT" }, - "node_modules/log4js": { - "version": "0.6.38", - "resolved": "https://registry.npmjs.org/log4js/-/log4js-0.6.38.tgz", - "integrity": "sha512-Cd+klbx7lkiaamEId9/0odHxv/PFHDz2E12kEfd6/CzIOZD084DzysASR/Dot4i1dYPBQKC3r2XIER+dfbLOmw==", - "deprecated": "0.x is no longer supported. Please upgrade to 6.x or higher.", + "node_modules/log-symbols": { + "version": "7.0.1", + "resolved": "https://registry.npmjs.org/log-symbols/-/log-symbols-7.0.1.tgz", + "integrity": "sha512-ja1E3yCr9i/0hmBVaM0bfwDjnGy8I/s6PP4DFp+yP+a+mrHO4Rm7DtmnqROTUkHIkqffC84YY7AeqX6oFk0WFg==", "dev": true, - "license": "Apache-2.0", + "license": "MIT", "dependencies": { - "readable-stream": "~1.0.2", - "semver": "~4.3.3" + "is-unicode-supported": "^2.0.0", + "yoctocolors": "^2.1.1" }, "engines": { - "node": ">=0.8" + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/log4js/node_modules/semver": { - "version": "4.3.6", - "resolved": "https://registry.npmjs.org/semver/-/semver-4.3.6.tgz", - "integrity": "sha512-IrpJ+yoG4EOH8DFWuVg+8H1kW1Oaof0Wxe7cPcXW3x9BjkN/eVo54F15LyqemnDIUYskQWr9qvl/RihmSy6+xQ==", + "node_modules/log4js": { + "version": "6.9.1", + "resolved": "https://registry.npmjs.org/log4js/-/log4js-6.9.1.tgz", + "integrity": "sha512-1somDdy9sChrr9/f4UlzhdaGfDR2c/SaD2a4T7qEkG4jTS57/B3qmnjLYePwQ8cqWnUHZI0iAKxMBpCZICiZ2g==", "dev": true, - "license": "ISC", - "bin": { - "semver": "bin/semver" + "license": "Apache-2.0", + "dependencies": { + "date-format": "^4.0.14", + "debug": "^4.3.4", + "flatted": "^3.2.7", + "rfdc": "^1.3.0", + "streamroller": "^3.1.5" + }, + "engines": { + "node": ">=8.0" } }, "node_modules/lolex": { @@ -13917,28 +12330,6 @@ "node": ">=10" } }, - "node_modules/make-fetch-happen": { - "version": "14.0.3", - "resolved": "https://registry.npmjs.org/make-fetch-happen/-/make-fetch-happen-14.0.3.tgz", - "integrity": "sha512-QMjGbFTP0blj97EeidG5hk/QhKQ3T4ICckQGLgz38QF7Vgbk6e6FTARN8KhKxyBbWn8R0HU+bnw8aSoFPD4qtQ==", - "license": "ISC", - "dependencies": { - "@npmcli/agent": "^3.0.0", - "cacache": "^19.0.1", - "http-cache-semantics": "^4.1.1", - "minipass": "^7.0.2", - "minipass-fetch": "^4.0.0", - "minipass-flush": "^1.0.5", - "minipass-pipeline": "^1.2.4", - "negotiator": "^1.0.0", - "proc-log": "^5.0.0", - "promise-retry": "^2.0.1", - "ssri": "^12.0.0" - }, - "engines": { - "node": "^18.17.0 || >=20.5.0" - } - }, "node_modules/makeerror": { "version": "1.0.12", "resolved": "https://registry.npmjs.org/makeerror/-/makeerror-1.0.12.tgz", @@ -13949,16 +12340,6 @@ "tmpl": "1.0.5" } }, - "node_modules/map-cache": { - "version": "0.2.2", - "resolved": "https://registry.npmjs.org/map-cache/-/map-cache-0.2.2.tgz", - "integrity": "sha512-8y/eV9QQZCiyn1SprXSrCmqJN0yNRATe+PO8ztwqrvrbdRLA3eYJF0yaR0YayLWkMbsQSKWS9N2gPcGEc4UsZg==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, "node_modules/map-obj": { "version": "4.3.0", "resolved": "https://registry.npmjs.org/map-obj/-/map-obj-4.3.0.tgz", @@ -13972,19 +12353,6 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/map-visit": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/map-visit/-/map-visit-1.0.0.tgz", - "integrity": "sha512-4y7uGv8bd2WdM9vpQsiQNo41Ln1NvhvDRuVt0k2JZQ+ezN2uaQes7lZeZ+QQUHOLQAtDaBJ+7wCbi+ab/KFs+w==", - "dev": true, - "license": "MIT", - "dependencies": { - "object-visit": "^1.0.0" - }, - "engines": { - "node": ">=0.10.0" - } - }, "node_modules/matchmediaquery": { "version": "0.3.1", "resolved": "https://registry.npmjs.org/matchmediaquery/-/matchmediaquery-0.3.1.tgz", @@ -14003,19 +12371,13 @@ "node": ">= 0.4" } }, - "node_modules/math-random": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/math-random/-/math-random-1.0.4.tgz", - "integrity": "sha512-rUxjysqif/BZQH2yhd5Aaq7vXMSx9NdEsQcyA07uEzIvxgI7zIr33gGsh+RU0/XjmQpCW7RsVof1vlkvQVCK5A==", - "dev": true, - "license": "MIT" - }, "node_modules/mathml-tag-names": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/mathml-tag-names/-/mathml-tag-names-4.0.0.tgz", "integrity": "sha512-aa6AU2Pcx0VP/XWnh8IGL0SYSgQHDT6Ucror2j2mXeFAlN3ahaNs8EZtG1YiticMkSLj3Gt6VPFfZogt7G5iFQ==", "dev": true, "license": "MIT", + "peer": true, "funding": { "type": "github", "url": "https://github.com/sponsors/wooorm" @@ -14026,7 +12388,8 @@ "resolved": "https://registry.npmjs.org/mdn-data/-/mdn-data-2.12.2.tgz", "integrity": "sha512-IEn+pegP1aManZuckezWCO+XZQDplx1366JoVhTpMpBB1sPey/SbveZQUosKiKiGYjg1wH4pMlNgXbCiYgihQA==", "dev": true, - "license": "CC0-1.0" + "license": "CC0-1.0", + "peer": true }, "node_modules/media-typer": { "version": "0.3.0", @@ -14044,6 +12407,7 @@ "integrity": "sha512-JhC3R1f6dbspVtmF3vKjAWz1EVIvwFrGGPLSdU6rK79xBwHWTuHoLnRX/t1/zHS1Ch1Y2UtIrih7DAHuH9JFJA==", "dev": true, "license": "MIT", + "peer": true, "engines": { "node": ">=20" }, @@ -14080,41 +12444,17 @@ "node": ">=8.6" } }, - "node_modules/micromatch/node_modules/braces": { - "version": "3.0.3", - "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.3.tgz", - "integrity": "sha512-yQbXgO/OSZVD2IsiLlro+7Hf6Q18EJrKSEsdoMzKePKXct3gvD8oLcOQdIzGupr5Fj+EDe8gO/lxc1BzfMpxvA==", - "license": "MIT", - "dependencies": { - "fill-range": "^7.1.1" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/micromatch/node_modules/fill-range": { - "version": "7.1.1", - "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.1.1.tgz", - "integrity": "sha512-YsGpe3WHLK8ZYi4tWDg2Jy3ebRz2rXowDxnld4bkQB00cc/1Zw9AWnC0i9ztDJitivtQvaI9KaLyKrc+hBW0yg==", - "license": "MIT", - "dependencies": { - "to-regex-range": "^5.0.1" - }, - "engines": { - "node": ">=8" - } - }, "node_modules/mime": { - "version": "1.6.0", - "resolved": "https://registry.npmjs.org/mime/-/mime-1.6.0.tgz", - "integrity": "sha512-x0Vn8spI+wuJ1O6S7gnbaQg8Pxh4NNHb7KSINmEWKiPE4RKOplvijn+NkmYmmRgP68mc70j2EbeTFRsrswaQeg==", + "version": "2.6.0", + "resolved": "https://registry.npmjs.org/mime/-/mime-2.6.0.tgz", + "integrity": "sha512-USPkMeET31rOMiarsBNIHZKLGgvKc/LrjofAnBlOttf5ajRvqiRA8QsenbcooctK6d6Ts6aqZXBA+XbkKthiQg==", "dev": true, "license": "MIT", "bin": { "mime": "cli.js" }, "engines": { - "node": ">=4" + "node": ">=4.0.0" } }, "node_modules/mime-db": { @@ -14177,12 +12517,27 @@ "webpack": "^5.0.0" } }, - "node_modules/minimist": { - "version": "0.0.10", - "resolved": "https://registry.npmjs.org/minimist/-/minimist-0.0.10.tgz", - "integrity": "sha512-iotkTvxc+TwOm5Ieim8VnSNvCDjCK9S8G3scJ50ZthspSxa7jx50jkhYduuAtAjvfDUwSgOwf8+If99AlOEhyw==", + "node_modules/minimatch": { + "version": "3.1.2", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", + "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", "dev": true, - "license": "MIT" + "license": "ISC", + "dependencies": { + "brace-expansion": "^1.1.7" + }, + "engines": { + "node": "*" + } + }, + "node_modules/minimist": { + "version": "1.2.8", + "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.8.tgz", + "integrity": "sha512-2yyAR8qBkN3YuheJanUpWC5U3bb5osDywNB8RzDVlDwDHbocAJveqqj1u8+SVD7jkWT4yvsHCpWqqWqAxb0zCA==", + "license": "MIT", + "funding": { + "url": "https://github.com/sponsors/ljharb" + } }, "node_modules/minimist-options": { "version": "4.1.0", @@ -14208,190 +12563,47 @@ "node": ">=16 || 14 >=14.17" } }, - "node_modules/minipass-collect": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/minipass-collect/-/minipass-collect-2.0.1.tgz", - "integrity": "sha512-D7V8PO9oaz7PWGLbCACuI1qEOsq7UKfLotx/C0Aet43fCUB/wfQ7DYeq2oR/svFJGYDHPr38SHATeaj/ZoKHKw==", - "license": "ISC", + "node_modules/minizlib": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/minizlib/-/minizlib-3.1.0.tgz", + "integrity": "sha512-KZxYo1BUkWD2TVFLr0MQoM8vUUigWD3LlD83a/75BqC+4qE0Hb1Vo5v1FgcfaNXvfXzr+5EhQ6ing/CaBijTlw==", + "license": "MIT", "dependencies": { - "minipass": "^7.0.3" + "minipass": "^7.1.2" }, "engines": { - "node": ">=16 || 14 >=14.17" + "node": ">= 18" } }, - "node_modules/minipass-fetch": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/minipass-fetch/-/minipass-fetch-4.0.1.tgz", - "integrity": "sha512-j7U11C5HXigVuutxebFadoYBbd7VSdZWggSe64NVdvWNBqGAiXPL2QVCehjmw7lY1oF9gOllYbORh+hiNgfPgQ==", + "node_modules/mkdirp": { + "version": "0.5.6", + "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-0.5.6.tgz", + "integrity": "sha512-FP+p8RB8OWpF3YZBCrP5gtADmtXApB5AMLn+vdyA+PyxCjrCs00mjyUozssO33cwDeT3wNGdLxJ5M//YqtHAJw==", + "dev": true, "license": "MIT", "dependencies": { - "minipass": "^7.0.3", - "minipass-sized": "^1.0.3", - "minizlib": "^3.0.1" - }, - "engines": { - "node": "^18.17.0 || >=20.5.0" + "minimist": "^1.2.6" }, - "optionalDependencies": { - "encoding": "^0.1.13" + "bin": { + "mkdirp": "bin/cmd.js" } }, - "node_modules/minipass-flush": { - "version": "1.0.5", - "resolved": "https://registry.npmjs.org/minipass-flush/-/minipass-flush-1.0.5.tgz", - "integrity": "sha512-JmQSYYpPUqX5Jyn1mXaRwOda1uQ8HP5KAT/oDSLCzt1BYRhQU0/hDtsB1ufZfEEzMZ9aAVmsBw8+FWsIXlClWw==", - "license": "ISC", - "dependencies": { - "minipass": "^3.0.0" - }, + "node_modules/moment": { + "version": "2.30.1", + "resolved": "https://registry.npmjs.org/moment/-/moment-2.30.1.tgz", + "integrity": "sha512-uEmtNhbDOrWPFS+hdjFCBfy9f2YoyzRpwcl+DqpC6taX21FzsTLQVbMV/W7PzNSX6x/bhC1zA3c2UQ5NzH6how==", + "license": "MIT", "engines": { - "node": ">= 8" + "node": "*" } }, - "node_modules/minipass-flush/node_modules/minipass": { - "version": "3.3.6", - "resolved": "https://registry.npmjs.org/minipass/-/minipass-3.3.6.tgz", - "integrity": "sha512-DxiNidxSEK+tHG6zOIklvNOwm3hvCrbUrdtzY74U6HKTJxvIDfOUL5W5P2Ghd3DTkhhKPYGqeNUIh5qcM4YBfw==", - "license": "ISC", + "node_modules/moment-timezone": { + "version": "0.6.2", + "resolved": "https://registry.npmjs.org/moment-timezone/-/moment-timezone-0.6.2.tgz", + "integrity": "sha512-lDsQv8FoGdBUdf0+TjGsq2orxKuXdwFlQ6Zw6TX3xIcTwTfEpCLyKqvEauvCHJ8iu3KBV8+uPhlv70YsNGdUBQ==", + "license": "MIT", "dependencies": { - "yallist": "^4.0.0" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/minipass-flush/node_modules/yallist": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", - "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", - "license": "ISC" - }, - "node_modules/minipass-pipeline": { - "version": "1.2.4", - "resolved": "https://registry.npmjs.org/minipass-pipeline/-/minipass-pipeline-1.2.4.tgz", - "integrity": "sha512-xuIq7cIOt09RPRJ19gdi4b+RiNvDFYe5JH+ggNvBqGqpQXcru3PcRmOZuHBKWK1Txf9+cQ+HMVN4d6z46LZP7A==", - "license": "ISC", - "dependencies": { - "minipass": "^3.0.0" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/minipass-pipeline/node_modules/minipass": { - "version": "3.3.6", - "resolved": "https://registry.npmjs.org/minipass/-/minipass-3.3.6.tgz", - "integrity": "sha512-DxiNidxSEK+tHG6zOIklvNOwm3hvCrbUrdtzY74U6HKTJxvIDfOUL5W5P2Ghd3DTkhhKPYGqeNUIh5qcM4YBfw==", - "license": "ISC", - "dependencies": { - "yallist": "^4.0.0" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/minipass-pipeline/node_modules/yallist": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", - "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", - "license": "ISC" - }, - "node_modules/minipass-sized": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/minipass-sized/-/minipass-sized-1.0.3.tgz", - "integrity": "sha512-MbkQQ2CTiBMlA2Dm/5cY+9SWFEN8pzzOXi6rlM5Xxq0Yqbda5ZQy9sU75a673FE9ZK0Zsbr6Y5iP6u9nktfg2g==", - "license": "ISC", - "dependencies": { - "minipass": "^3.0.0" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/minipass-sized/node_modules/minipass": { - "version": "3.3.6", - "resolved": "https://registry.npmjs.org/minipass/-/minipass-3.3.6.tgz", - "integrity": "sha512-DxiNidxSEK+tHG6zOIklvNOwm3hvCrbUrdtzY74U6HKTJxvIDfOUL5W5P2Ghd3DTkhhKPYGqeNUIh5qcM4YBfw==", - "license": "ISC", - "dependencies": { - "yallist": "^4.0.0" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/minipass-sized/node_modules/yallist": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", - "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", - "license": "ISC" - }, - "node_modules/minizlib": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/minizlib/-/minizlib-3.1.0.tgz", - "integrity": "sha512-KZxYo1BUkWD2TVFLr0MQoM8vUUigWD3LlD83a/75BqC+4qE0Hb1Vo5v1FgcfaNXvfXzr+5EhQ6ing/CaBijTlw==", - "license": "MIT", - "dependencies": { - "minipass": "^7.1.2" - }, - "engines": { - "node": ">= 18" - } - }, - "node_modules/mixin-deep": { - "version": "1.3.2", - "resolved": "https://registry.npmjs.org/mixin-deep/-/mixin-deep-1.3.2.tgz", - "integrity": "sha512-WRoDn//mXBiJ1H40rqa3vH0toePwSsGb45iInWlTySa+Uu4k3tYUSxa2v1KqAiLtvlrSzaExqS1gtk96A9zvEA==", - "dev": true, - "license": "MIT", - "dependencies": { - "for-in": "^1.0.2", - "is-extendable": "^1.0.1" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/mkdirp": { - "version": "0.5.6", - "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-0.5.6.tgz", - "integrity": "sha512-FP+p8RB8OWpF3YZBCrP5gtADmtXApB5AMLn+vdyA+PyxCjrCs00mjyUozssO33cwDeT3wNGdLxJ5M//YqtHAJw==", - "dev": true, - "license": "MIT", - "dependencies": { - "minimist": "^1.2.6" - }, - "bin": { - "mkdirp": "bin/cmd.js" - } - }, - "node_modules/mkdirp/node_modules/minimist": { - "version": "1.2.8", - "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.8.tgz", - "integrity": "sha512-2yyAR8qBkN3YuheJanUpWC5U3bb5osDywNB8RzDVlDwDHbocAJveqqj1u8+SVD7jkWT4yvsHCpWqqWqAxb0zCA==", - "dev": true, - "license": "MIT", - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/moment": { - "version": "2.30.1", - "resolved": "https://registry.npmjs.org/moment/-/moment-2.30.1.tgz", - "integrity": "sha512-uEmtNhbDOrWPFS+hdjFCBfy9f2YoyzRpwcl+DqpC6taX21FzsTLQVbMV/W7PzNSX6x/bhC1zA3c2UQ5NzH6how==", - "license": "MIT", - "engines": { - "node": "*" - } - }, - "node_modules/moment-timezone": { - "version": "0.5.48", - "resolved": "https://registry.npmjs.org/moment-timezone/-/moment-timezone-0.5.48.tgz", - "integrity": "sha512-f22b8LV1gbTO2ms2j2z13MuPogNoh5UzxL3nzNAYKGraILnbGc9NEE6dyiiiLv46DGRb8A4kg8UKWLjPthxBHw==", - "license": "MIT", - "dependencies": { - "moment": "^2.29.4" + "moment": "^2.29.4" }, "engines": { "node": "*" @@ -14403,13 +12615,12 @@ "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==", "license": "MIT" }, - "node_modules/nan": { - "version": "2.25.0", - "resolved": "https://registry.npmjs.org/nan/-/nan-2.25.0.tgz", - "integrity": "sha512-0M90Ag7Xn5KMLLZ7zliPWP3rT90P6PN+IzVFS0VqmnPktBk3700xUVv8Ikm9EUaUE5SDWdp/BIxdENzVznpm1g==", + "node_modules/mute-stream": { + "version": "0.0.5", + "resolved": "https://registry.npmjs.org/mute-stream/-/mute-stream-0.0.5.tgz", + "integrity": "sha512-EbrziT4s8cWPmzr47eYVW3wimS4HsvlnV5ri1xw1aR6JQo/OrJX5rkl32K/QQHdxeabJETtfeaROGhd8W7uBgg==", "dev": true, - "license": "MIT", - "optional": true + "license": "ISC" }, "node_modules/nanoid": { "version": "3.3.11", @@ -14429,39 +12640,6 @@ "node": "^10 || ^12 || ^13.7 || ^14 || >=15.0.1" } }, - "node_modules/nanomatch": { - "version": "1.2.13", - "resolved": "https://registry.npmjs.org/nanomatch/-/nanomatch-1.2.13.tgz", - "integrity": "sha512-fpoe2T0RbHwBTBUOftAfBPaDEi06ufaUai0mE6Yn1kacc3SnTErfb/h+X94VXzI64rKFHYImXSvdwGGCmwOqCA==", - "dev": true, - "license": "MIT", - "dependencies": { - "arr-diff": "^4.0.0", - "array-unique": "^0.3.2", - "define-property": "^2.0.2", - "extend-shallow": "^3.0.2", - "fragment-cache": "^0.2.1", - "is-windows": "^1.0.2", - "kind-of": "^6.0.2", - "object.pick": "^1.3.0", - "regex-not": "^1.0.0", - "snapdragon": "^0.8.1", - "to-regex": "^3.0.1" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/nanomatch/node_modules/array-unique": { - "version": "0.3.2", - "resolved": "https://registry.npmjs.org/array-unique/-/array-unique-0.3.2.tgz", - "integrity": "sha512-SleRWjh9JUud2wH1hPs9rZBZ33H6T9HOiL0uwGnGx9FpE6wKGyfWugmbkEOIs6qWrZhg0LWeLziLrEwQJhs5mQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, "node_modules/natural-compare": { "version": "1.4.0", "resolved": "https://registry.npmjs.org/natural-compare/-/natural-compare-1.4.0.tgz", @@ -14469,15 +12647,6 @@ "dev": true, "license": "MIT" }, - "node_modules/negotiator": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/negotiator/-/negotiator-1.0.0.tgz", - "integrity": "sha512-8Ofs/AUQh8MaEcrlq5xOX0CQ9ypTF5dl78mjlMNfOK08fzpgTHQRQPBxcPlEtIw0yRpws+Zo/3r+5WRby7u3Gg==", - "license": "MIT", - "engines": { - "node": ">= 0.6" - } - }, "node_modules/neo-async": { "version": "2.6.2", "resolved": "https://registry.npmjs.org/neo-async/-/neo-async-2.6.2.tgz", @@ -14534,42 +12703,51 @@ "optional": true }, "node_modules/node-gyp": { - "version": "11.5.0", - "resolved": "https://registry.npmjs.org/node-gyp/-/node-gyp-11.5.0.tgz", - "integrity": "sha512-ra7Kvlhxn5V9Slyus0ygMa2h+UqExPqUIkfk7Pc8QTLT956JLSy51uWFwHtIYy0vI8cB4BDhc/S03+880My/LQ==", + "version": "12.3.0", + "resolved": "https://registry.npmjs.org/node-gyp/-/node-gyp-12.3.0.tgz", + "integrity": "sha512-QNcUWM+HgJplcPzBvFBZ9VXacyGZ4+VTOb80PwWR+TlVzoHbRKULNEzpRsnaoxG3Wzr7Qh7BYxGDU3CbKib2Yg==", "license": "MIT", "dependencies": { "env-paths": "^2.2.0", "exponential-backoff": "^3.1.1", "graceful-fs": "^4.2.6", - "make-fetch-happen": "^14.0.3", - "nopt": "^8.0.0", - "proc-log": "^5.0.0", + "nopt": "^9.0.0", + "proc-log": "^6.0.0", "semver": "^7.3.5", - "tar": "^7.4.3", + "tar": "^7.5.4", "tinyglobby": "^0.2.12", - "which": "^5.0.0" + "undici": "^6.25.0", + "which": "^6.0.0" }, "bin": { "node-gyp": "bin/node-gyp.js" }, "engines": { - "node": "^18.17.0 || >=20.5.0" + "node": "^20.17.0 || >=22.9.0" } }, "node_modules/node-gyp/node_modules/isexe": { - "version": "3.1.1", - "resolved": "https://registry.npmjs.org/isexe/-/isexe-3.1.1.tgz", - "integrity": "sha512-LpB/54B+/2J5hqQ7imZHfdU31OlgQqx7ZicVlkm9kzg9/w8GKLEcFfJl/t7DCEDueOyBAD6zCCwTO6Fzs0NoEQ==", + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/isexe/-/isexe-4.0.0.tgz", + "integrity": "sha512-FFUtZMpoZ8RqHS3XeXEmHWLA4thH+ZxCv2lOiPIn1Xc7CxrqhWzNSDzD+/chS/zbYezmiwWLdQC09JdQKmthOw==", + "license": "BlueOak-1.0.0", + "engines": { + "node": ">=20" + } + }, + "node_modules/node-gyp/node_modules/proc-log": { + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/proc-log/-/proc-log-6.1.0.tgz", + "integrity": "sha512-iG+GYldRf2BQ0UDUAd6JQ/RwzaQy6mXmsk/IzlYyal4A4SNFw54MeH4/tLkF4I5WoWG9SQwuqWzS99jaFQHBuQ==", "license": "ISC", "engines": { - "node": ">=16" + "node": "^20.17.0 || >=22.9.0" } }, "node_modules/node-gyp/node_modules/semver": { - "version": "7.7.3", - "resolved": "https://registry.npmjs.org/semver/-/semver-7.7.3.tgz", - "integrity": "sha512-SdsKMrI9TdgjdweUSR9MweHA4EJ8YxHn8DFaDisvhVlUOe4BF1tLD7GAj0lIqWVl+dPb/rExr0Btby5loQm20Q==", + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.7.4.tgz", + "integrity": "sha512-vFKC2IEtQnVhpT78h1Yp8wzwrf8CM+MzKMHGJZfBtzhZNycRFnXsHk6E5TxIkkMsgNS7mdX3AGB7x2QM2di4lA==", "license": "ISC", "bin": { "semver": "bin/semver.js" @@ -14579,18 +12757,18 @@ } }, "node_modules/node-gyp/node_modules/which": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/which/-/which-5.0.0.tgz", - "integrity": "sha512-JEdGzHwwkrbWoGOlIHqQ5gtprKGOenpDHpxE9zVR1bWbOtYRyPPHMe9FaP6x61CmNaTThSkb0DAJte5jD+DmzQ==", + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/which/-/which-6.0.1.tgz", + "integrity": "sha512-oGLe46MIrCRqX7ytPUf66EAYvdeMIZYn3WaocqqKZAxrBpkqHfL/qvTyJ/bTk5+AqHCjXmrv3CEWgy368zhRUg==", "license": "ISC", "dependencies": { - "isexe": "^3.1.1" + "isexe": "^4.0.0" }, "bin": { "node-which": "bin/which.js" }, "engines": { - "node": "^18.17.0 || >=20.5.0" + "node": "^20.17.0 || >=22.9.0" } }, "node_modules/node-int64": { @@ -14607,18 +12785,18 @@ "license": "MIT" }, "node_modules/nopt": { - "version": "8.1.0", - "resolved": "https://registry.npmjs.org/nopt/-/nopt-8.1.0.tgz", - "integrity": "sha512-ieGu42u/Qsa4TFktmaKEwM6MQH0pOWnaB3htzh0JRtx84+Mebc0cbZYN5bC+6WTZ4+77xrL9Pn5m7CV6VIkV7A==", + "version": "9.0.0", + "resolved": "https://registry.npmjs.org/nopt/-/nopt-9.0.0.tgz", + "integrity": "sha512-Zhq3a+yFKrYwSBluL4H9XP3m3y5uvQkB/09CwDruCiRmR/UJYnn9W4R48ry0uGC70aeTPKLynBtscP9efFFcPw==", "license": "ISC", "dependencies": { - "abbrev": "^3.0.0" + "abbrev": "^4.0.0" }, "bin": { "nopt": "bin/nopt.js" }, "engines": { - "node": "^18.17.0 || >=20.5.0" + "node": "^20.17.0 || >=22.9.0" } }, "node_modules/normalize-package-data": { @@ -14698,67 +12876,6 @@ "node": ">=0.10.0" } }, - "node_modules/object-component": { - "version": "0.0.3", - "resolved": "https://registry.npmjs.org/object-component/-/object-component-0.0.3.tgz", - "integrity": "sha512-S0sN3agnVh2SZNEIGc0N1X4Z5K0JeFbGBrnuZpsxuUh5XLF0BnvWkMjRXo/zGKLd/eghvNIKcx1pQkmUjXIyrA==", - "dev": true - }, - "node_modules/object-copy": { - "version": "0.1.0", - "resolved": "https://registry.npmjs.org/object-copy/-/object-copy-0.1.0.tgz", - "integrity": "sha512-79LYn6VAb63zgtmAteVOWo9Vdj71ZVBy3Pbse+VqxDpEP83XuujMrGqHIwAXJ5I/aM0zU7dIyIAhifVTPrNItQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "copy-descriptor": "^0.1.0", - "define-property": "^0.2.5", - "kind-of": "^3.0.3" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/object-copy/node_modules/define-property": { - "version": "0.2.5", - "resolved": "https://registry.npmjs.org/define-property/-/define-property-0.2.5.tgz", - "integrity": "sha512-Rr7ADjQZenceVOAKop6ALkkRAmH1A4Gx9hV/7ZujPUN2rkATqFO0JZLZInbAjpZYoJ1gUx8MRMQVkYemcbMSTA==", - "dev": true, - "license": "MIT", - "dependencies": { - "is-descriptor": "^0.1.0" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/object-copy/node_modules/is-descriptor": { - "version": "0.1.7", - "resolved": "https://registry.npmjs.org/is-descriptor/-/is-descriptor-0.1.7.tgz", - "integrity": "sha512-C3grZTvObeN1xud4cRWl366OMXZTj0+HGyk4hvfpx4ZHt1Pb60ANSXqCK7pdOTeUQpRzECBSTphqvD7U+l22Eg==", - "dev": true, - "license": "MIT", - "dependencies": { - "is-accessor-descriptor": "^1.0.1", - "is-data-descriptor": "^1.0.1" - }, - "engines": { - "node": ">= 0.4" - } - }, - "node_modules/object-copy/node_modules/kind-of": { - "version": "3.2.2", - "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-3.2.2.tgz", - "integrity": "sha512-NOW9QQXMoZGg/oqnVNoNTTIFEIid1627WCffUBJEdMxYApq7mNE7CpzucIPc+ZQg25Phej7IJSmX3hO+oblOtQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "is-buffer": "^1.1.5" - }, - "engines": { - "node": ">=0.10.0" - } - }, "node_modules/object-filter": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/object-filter/-/object-filter-1.0.2.tgz", @@ -14802,19 +12919,6 @@ "node": ">= 0.4" } }, - "node_modules/object-visit": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/object-visit/-/object-visit-1.0.1.tgz", - "integrity": "sha512-GBaMwwAVK9qbQN3Scdo0OyvgPW7l3lnaVMj84uTOZlswkX0KpF6fyDBJhtTthf7pymztoN36/KEr1DyhF96zEA==", - "dev": true, - "license": "MIT", - "dependencies": { - "isobject": "^3.0.0" - }, - "engines": { - "node": ">=0.10.0" - } - }, "node_modules/object.assign": { "version": "4.1.7", "resolved": "https://registry.npmjs.org/object.assign/-/object.assign-4.1.7.tgz", @@ -14850,43 +12954,6 @@ "node": ">= 0.4" } }, - "node_modules/object.omit": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/object.omit/-/object.omit-2.0.1.tgz", - "integrity": "sha512-UiAM5mhmIuKLsOvrL+B0U2d1hXHF3bFYWIuH1LMpuV2EJEHG1Ntz06PgLEHjm6VFd87NpH8rastvPoyv6UW2fA==", - "dev": true, - "license": "MIT", - "dependencies": { - "for-own": "^0.1.4", - "is-extendable": "^0.1.1" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/object.omit/node_modules/is-extendable": { - "version": "0.1.1", - "resolved": "https://registry.npmjs.org/is-extendable/-/is-extendable-0.1.1.tgz", - "integrity": "sha512-5BMULNob1vgFX6EjQw5izWDxrecWK9AM72rugNr0TFldMOi0fj6Jk+zeKIt0xGj4cEfQIJth4w3OKWOJ4f+AFw==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/object.pick": { - "version": "1.3.0", - "resolved": "https://registry.npmjs.org/object.pick/-/object.pick-1.3.0.tgz", - "integrity": "sha512-tqa/UMy/CCoYmj+H5qc07qvSL9dqcs/WZENZ1JbtWBlATP+iVOe778gE6MSijnyCnORzDuX6hU+LA4SZ09YjFQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "isobject": "^3.0.1" - }, - "engines": { - "node": ">=0.10.0" - } - }, "node_modules/on-finished": { "version": "2.4.1", "resolved": "https://registry.npmjs.org/on-finished/-/on-finished-2.4.1.tgz", @@ -14926,17 +12993,6 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/optimist": { - "version": "0.6.1", - "resolved": "https://registry.npmjs.org/optimist/-/optimist-0.6.1.tgz", - "integrity": "sha512-snN4O4TkigujZphWLN0E//nQmm7790RYaE53DdL7ZYwee2D8DDo9/EyYiKUfN3rneWUjhJnueija3G9I2i0h3g==", - "dev": true, - "license": "MIT/X11", - "dependencies": { - "minimist": "~0.0.1", - "wordwrap": "~0.0.2" - } - }, "node_modules/optionator": { "version": "0.8.3", "resolved": "https://registry.npmjs.org/optionator/-/optionator-0.8.3.tgz", @@ -14955,15 +13011,6 @@ "node": ">= 0.8.0" } }, - "node_modules/options": { - "version": "0.0.6", - "resolved": "https://registry.npmjs.org/options/-/options-0.0.6.tgz", - "integrity": "sha512-bOj3L1ypm++N+n7CEbbe473A414AB7z+amKYshRb//iuL3MpdDCLhPnw6aVTdKB9g5ZRVHIEp8eUln6L2NUStg==", - "dev": true, - "engines": { - "node": ">=0.4.0" - } - }, "node_modules/os-homedir": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/os-homedir/-/os-homedir-1.0.2.tgz", @@ -14974,16 +13021,6 @@ "node": ">=0.10.0" } }, - "node_modules/os-tmpdir": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/os-tmpdir/-/os-tmpdir-1.0.2.tgz", - "integrity": "sha512-D2FR03Vir7FIu45XBY20mTb+/ZSWB00sjU9jdQXt83gDrI4Ztz5Fs7/yy74g2N5SVQY4xY1qDr4rNddwYRVX0g==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, "node_modules/own-keys": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/own-keys/-/own-keys-1.0.1.tgz", @@ -15005,7 +13042,6 @@ "version": "3.1.0", "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-3.1.0.tgz", "integrity": "sha512-TYOanM3wGwNGsZN2cVTYPArw454xnXj5qmWF1bEoAc4+cU/ol7GVh7odevjp1FNHduHc3KZMcFduxU5Xc6uJRQ==", - "dev": true, "license": "MIT", "dependencies": { "yocto-queue": "^0.1.0" @@ -15046,34 +13082,16 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/p-map": { - "version": "7.0.4", - "resolved": "https://registry.npmjs.org/p-map/-/p-map-7.0.4.tgz", - "integrity": "sha512-tkAQEw8ysMzmkhgw8k+1U/iPhWNhykKnSk4Rd5zLoPJCuJaGRPo6YposrZgaxHKzDHdDWWZvE/Sk7hsL2X/CpQ==", - "license": "MIT", - "engines": { - "node": ">=18" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/p-try": { - "version": "2.2.0", - "resolved": "https://registry.npmjs.org/p-try/-/p-try-2.2.0.tgz", - "integrity": "sha512-R4nPAVTAU0B9D35/Gk3uJf/7XYbQcyohSKdvAxIRSNghFl4e71hVoGnBNQz9cWaXxO2I10KTC+3jMdvvoKw6dQ==", - "dev": true, + "node_modules/p-try": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/p-try/-/p-try-2.2.0.tgz", + "integrity": "sha512-R4nPAVTAU0B9D35/Gk3uJf/7XYbQcyohSKdvAxIRSNghFl4e71hVoGnBNQz9cWaXxO2I10KTC+3jMdvvoKw6dQ==", + "dev": true, "license": "MIT", "engines": { "node": ">=6" } }, - "node_modules/package-json-from-dist": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/package-json-from-dist/-/package-json-from-dist-1.0.1.tgz", - "integrity": "sha512-UEZIS3/by4OC8vL3P2dTXRETpebLI2NiI5vIrjaD/5UtrkFX/tNbwjTSRAGC/+7CAo2pIcBaRgWmcBBHcsaCIw==", - "license": "BlueOak-1.0.0" - }, "node_modules/pako": { "version": "1.0.11", "resolved": "https://registry.npmjs.org/pako/-/pako-1.0.11.tgz", @@ -15094,22 +13112,6 @@ "node": ">=6" } }, - "node_modules/parse-glob": { - "version": "3.0.4", - "resolved": "https://registry.npmjs.org/parse-glob/-/parse-glob-3.0.4.tgz", - "integrity": "sha512-FC5TeK0AwXzq3tUBFtH74naWkPQCEWs4K+xMxWZBlKDWu0bVHXGZa+KKqxKidd7xwhdZ19ZNuF2uO1M/r196HA==", - "dev": true, - "license": "MIT", - "dependencies": { - "glob-base": "^0.3.0", - "is-dotfile": "^1.0.0", - "is-extglob": "^1.0.0", - "is-glob": "^2.0.0" - }, - "engines": { - "node": ">=0.10.0" - } - }, "node_modules/parse-json": { "version": "5.2.0", "resolved": "https://registry.npmjs.org/parse-json/-/parse-json-5.2.0.tgz", @@ -15156,36 +13158,6 @@ "url": "https://github.com/inikulin/parse5?sponsor=1" } }, - "node_modules/parsejson": { - "version": "0.0.3", - "resolved": "https://registry.npmjs.org/parsejson/-/parsejson-0.0.3.tgz", - "integrity": "sha512-v38ZjVbinlZ2r1Rz06WUZEnGoSRcEGX+roMsiWjHeAe23s2qlQUyfmsPQZvh7d8l0E8AZzTIO/RkUr00LfkSiA==", - "dev": true, - "license": "MIT", - "dependencies": { - "better-assert": "~1.0.0" - } - }, - "node_modules/parseqs": { - "version": "0.0.5", - "resolved": "https://registry.npmjs.org/parseqs/-/parseqs-0.0.5.tgz", - "integrity": "sha512-B3Nrjw2aL7aI4TDujOzfA4NsEc4u1lVcIRE0xesutH8kjeWF70uk+W5cBlIQx04zUH9NTBvuN36Y9xLRPK6Jjw==", - "dev": true, - "license": "MIT", - "dependencies": { - "better-assert": "~1.0.0" - } - }, - "node_modules/parseuri": { - "version": "0.0.5", - "resolved": "https://registry.npmjs.org/parseuri/-/parseuri-0.0.5.tgz", - "integrity": "sha512-ijhdxJu6l5Ru12jF0JvzXVPvsC+VibqeaExlNoMhWN6VQ79PGjkmc7oA4W1lp00sFkNyj0fx6ivPLdV51/UMog==", - "dev": true, - "license": "MIT", - "dependencies": { - "better-assert": "~1.0.0" - } - }, "node_modules/parseurl": { "version": "1.3.3", "resolved": "https://registry.npmjs.org/parseurl/-/parseurl-1.3.3.tgz", @@ -15196,21 +13168,10 @@ "node": ">= 0.8" } }, - "node_modules/pascalcase": { - "version": "0.1.1", - "resolved": "https://registry.npmjs.org/pascalcase/-/pascalcase-0.1.1.tgz", - "integrity": "sha512-XHXfu/yOQRy9vYOtUDVMN60OEJjW013GoObG1o+xwQTpB9eYJX/BjXMsdW13ZDPruFhYYn0AG22w0xgQMwl3Nw==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, "node_modules/path-exists": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/path-exists/-/path-exists-4.0.0.tgz", "integrity": "sha512-ak9Qy5Q7jYb2Wwcey5Fpvg2KoAc/ZIhLSLOSBmRmygPsGwkVVt0fZa0qrtMz+m6tJTAHfZQ8FnmB4MG4LWy7/w==", - "dev": true, "license": "MIT", "engines": { "node": ">=8" @@ -15237,6 +13198,7 @@ "version": "3.1.1", "resolved": "https://registry.npmjs.org/path-key/-/path-key-3.1.1.tgz", "integrity": "sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q==", + "dev": true, "license": "MIT", "engines": { "node": ">=8" @@ -15248,28 +13210,6 @@ "integrity": "sha512-LDJzPVEEEPR+y48z93A0Ed0yXb8pAByGWo/k5YYdYgpY2/2EsOsksJrq7lOHxryrVOn1ejG6oAp8ahvOIQD8sw==", "license": "MIT" }, - "node_modules/path-scurry": { - "version": "1.11.1", - "resolved": "https://registry.npmjs.org/path-scurry/-/path-scurry-1.11.1.tgz", - "integrity": "sha512-Xa4Nw17FS9ApQFJ9umLiJS4orGjm7ZzwUrwamcGQuHSzDyth9boKDaycYdDcZDuqYATXw4HFXgaqWTctW/v1HA==", - "license": "BlueOak-1.0.0", - "dependencies": { - "lru-cache": "^10.2.0", - "minipass": "^5.0.0 || ^6.0.2 || ^7.0.0" - }, - "engines": { - "node": ">=16 || 14 >=14.18" - }, - "funding": { - "url": "https://github.com/sponsors/isaacs" - } - }, - "node_modules/path-scurry/node_modules/lru-cache": { - "version": "10.4.3", - "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-10.4.3.tgz", - "integrity": "sha512-JNAzZcXrCt42VGLuYz0zfAzDfAvJWW6AfYlDBQyDV5DClI2m5sAmK+OIO7s59XfsRsWHp02jAJrRadPRGTt6SQ==", - "license": "ISC" - }, "node_modules/path-to-regexp": { "version": "1.9.0", "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-1.9.0.tgz", @@ -15317,103 +13257,6 @@ "node": ">= 6" } }, - "node_modules/pkg-dir": { - "version": "7.0.0", - "resolved": "https://registry.npmjs.org/pkg-dir/-/pkg-dir-7.0.0.tgz", - "integrity": "sha512-Ie9z/WINcxxLp27BKOCHGde4ITq9UklYKDzVo1nhk5sqGEXU3FpkwP5GM2voTGJkGd9B3Otl+Q4uwSOeSUtOBA==", - "license": "MIT", - "dependencies": { - "find-up": "^6.3.0" - }, - "engines": { - "node": ">=14.16" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/pkg-dir/node_modules/find-up": { - "version": "6.3.0", - "resolved": "https://registry.npmjs.org/find-up/-/find-up-6.3.0.tgz", - "integrity": "sha512-v2ZsoEuVHYy8ZIlYqwPe/39Cy+cFDzp4dXPaxNvkEuouymu+2Jbz0PxpKarJHYJTmv2HWT3O382qY8l4jMWthw==", - "license": "MIT", - "dependencies": { - "locate-path": "^7.1.0", - "path-exists": "^5.0.0" - }, - "engines": { - "node": "^12.20.0 || ^14.13.1 || >=16.0.0" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/pkg-dir/node_modules/locate-path": { - "version": "7.2.0", - "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-7.2.0.tgz", - "integrity": "sha512-gvVijfZvn7R+2qyPX8mAuKcFGDf6Nc61GdvGafQsHL0sBIxfKzA+usWn4GFC/bk+QdwPUD4kWFJLhElipq+0VA==", - "license": "MIT", - "dependencies": { - "p-locate": "^6.0.0" - }, - "engines": { - "node": "^12.20.0 || ^14.13.1 || >=16.0.0" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/pkg-dir/node_modules/p-limit": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-4.0.0.tgz", - "integrity": "sha512-5b0R4txpzjPWVw/cXXUResoD4hb6U/x9BH08L7nw+GN1sezDzPdxeRvpc9c433fZhBan/wusjbCsqwqm4EIBIQ==", - "license": "MIT", - "dependencies": { - "yocto-queue": "^1.0.0" - }, - "engines": { - "node": "^12.20.0 || ^14.13.1 || >=16.0.0" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/pkg-dir/node_modules/p-locate": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-6.0.0.tgz", - "integrity": "sha512-wPrq66Llhl7/4AGC6I+cqxT07LhXvWL08LNXz1fENOw0Ap4sRZZ/gZpTTJ5jpurzzzfS2W/Ge9BY3LgLjCShcw==", - "license": "MIT", - "dependencies": { - "p-limit": "^4.0.0" - }, - "engines": { - "node": "^12.20.0 || ^14.13.1 || >=16.0.0" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/pkg-dir/node_modules/path-exists": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/path-exists/-/path-exists-5.0.0.tgz", - "integrity": "sha512-RjhtfwJOxzcFmNOi6ltcbcu4Iu+FL3zEj83dk4kAS+fVpTxXLO1b38RvJgT/0QwvV/L3aY9TAnyv0EOqW4GoMQ==", - "license": "MIT", - "engines": { - "node": "^12.20.0 || ^14.13.1 || >=16.0.0" - } - }, - "node_modules/pkg-dir/node_modules/yocto-queue": { - "version": "1.2.2", - "resolved": "https://registry.npmjs.org/yocto-queue/-/yocto-queue-1.2.2.tgz", - "integrity": "sha512-4LCcse/U2MHZ63HAJVE+v71o7yOdIe4cZ70Wpf8D/IyjDKYQLV5GD46B+hSTjJsvV5PztjvHoU580EftxjDZFQ==", - "license": "MIT", - "engines": { - "node": ">=12.20" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, "node_modules/plato": { "version": "1.7.0", "resolved": "https://registry.npmjs.org/plato/-/plato-1.7.0.tgz", @@ -15436,17 +13279,6 @@ "node": ">= 4.4.5" } }, - "node_modules/plato/node_modules/brace-expansion": { - "version": "1.1.12", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.12.tgz", - "integrity": "sha512-9T9UjW3r0UW5c1Q7GTwllptXwhvYmEzFhzMfZ9H7FQWt+uZePjZPjBP/W1ZEyZ1twGWom5/56TF4lPcqjnDHcg==", - "dev": true, - "license": "MIT", - "dependencies": { - "balanced-match": "^1.0.0", - "concat-map": "0.0.1" - } - }, "node_modules/plato/node_modules/glob": { "version": "7.0.6", "resolved": "https://registry.npmjs.org/glob/-/glob-7.0.6.tgz", @@ -15473,19 +13305,6 @@ "dev": true, "license": "MIT" }, - "node_modules/plato/node_modules/minimatch": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", - "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", - "dev": true, - "license": "ISC", - "dependencies": { - "brace-expansion": "^1.1.7" - }, - "engines": { - "node": "*" - } - }, "node_modules/plugin-error": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/plugin-error/-/plugin-error-1.0.1.tgz", @@ -15539,22 +13358,11 @@ "integrity": "sha512-Wb4p1J4zyFTbM+u6WuO4XstYx4Ky9Cewe4DWrel7B0w6VVICvPwdOpotjzcf6eD8TsckVnIMNONQyPIUFOUbCQ==", "deprecated": "You can find the new Popper v2 at @popperjs/core, this package is dedicated to the legacy v1", "license": "MIT", - "peer": true, "funding": { "type": "opencollective", "url": "https://opencollective.com/popperjs" } }, - "node_modules/posix-character-classes": { - "version": "0.1.1", - "resolved": "https://registry.npmjs.org/posix-character-classes/-/posix-character-classes-0.1.1.tgz", - "integrity": "sha512-xTgYBc3fuo7Yt7JbiuFxSYGToMoz8fLoE6TC9Wx1P/u+LfeThMOAqmuyECnlBaaJb+u1m9hHiXUEtwW4OzfUJg==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, "node_modules/posix-getopt": { "version": "1.2.1", "resolved": "https://registry.npmjs.org/posix-getopt/-/posix-getopt-1.2.1.tgz", @@ -15593,7 +13401,6 @@ } ], "license": "MIT", - "peer": true, "dependencies": { "nanoid": "^3.3.11", "picocolors": "^1.1.1", @@ -15696,6 +13503,7 @@ } ], "license": "MIT", + "peer": true, "engines": { "node": ">=18.0" }, @@ -15735,7 +13543,6 @@ "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", "license": "MIT", - "peer": true, "dependencies": { "cssesc": "^3.0.0", "util-deprecate": "^1.0.2" @@ -15759,16 +13566,6 @@ "node": ">= 0.8.0" } }, - "node_modules/preserve": { - "version": "0.2.0", - "resolved": "https://registry.npmjs.org/preserve/-/preserve-0.2.0.tgz", - "integrity": "sha512-s/46sYeylUfHNjI+sA/78FAHlmIuKqI9wNnzEOGehAlUUYeObv5C2mOinXBjyUyWmJ2SfcS2/ydApH4hTF4WXQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, "node_modules/pretty-format": { "version": "27.5.1", "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-27.5.1.tgz", @@ -15783,6 +13580,15 @@ "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" } }, + "node_modules/pretty-format/node_modules/ansi-regex": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz", + "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==", + "license": "MIT", + "engines": { + "node": ">=8" + } + }, "node_modules/pretty-format/node_modules/ansi-styles": { "version": "5.2.0", "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-5.2.0.tgz", @@ -15795,20 +13601,10 @@ "url": "https://github.com/chalk/ansi-styles?sponsor=1" } }, - "node_modules/proc-log": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/proc-log/-/proc-log-5.0.0.tgz", - "integrity": "sha512-Azwzvl90HaF0aCz1JrDdXQykFakSSNPaPoiZ9fm5qJIMHioDZEi7OAdRwSm6rSoPtY3Qutnm3L7ogmg3dc+wbQ==", - "license": "ISC", - "engines": { - "node": "^18.17.0 || >=20.5.0" - } - }, "node_modules/process-nextick-args": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/process-nextick-args/-/process-nextick-args-2.0.1.tgz", "integrity": "sha512-3ouUOpQhtgrbOa17J7+uxOTpITYWaGP7/AhoR3+A+/1e9skrzelGi/dXzEYyvbxubEF6Wn2ypscTKiKJFFn1ag==", - "dev": true, "license": "MIT" }, "node_modules/progress": { @@ -15820,19 +13616,6 @@ "node": ">=0.4.0" } }, - "node_modules/promise-retry": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/promise-retry/-/promise-retry-2.0.1.tgz", - "integrity": "sha512-y+WKFlBR8BGXnsNlIHFGPZmyDf3DFMoLhaflAnyZgV6rG6xu+JwesTo2Q9R6XwYmtmwAFCkAk3e35jEdoeh/3g==", - "license": "MIT", - "dependencies": { - "err-code": "^2.0.2", - "retry": "^0.12.0" - }, - "engines": { - "node": ">=10" - } - }, "node_modules/prompts": { "version": "2.4.2", "resolved": "https://registry.npmjs.org/prompts/-/prompts-2.4.2.tgz", @@ -15909,13 +13692,6 @@ "integrity": "sha512-24e6ynE2H+OKt4kqsOvNd8kBpV65zoxbA4BVsEOB3ARVWQki/DHzaUoC5KuON/BiccDaCCTZBuOcfZs70kR8bQ==", "license": "MIT" }, - "node_modules/pseudomap": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/pseudomap/-/pseudomap-1.0.2.tgz", - "integrity": "sha512-b/YwNhb8lk1Zz2+bXXpS/LK9OisiZZ1SNsSLxN1x2OXVEhW2Ckr/7mWE5vrC1ZTiJlD9g19jWszTmJsB+oEpFQ==", - "dev": true, - "license": "ISC" - }, "node_modules/psl": { "version": "1.15.0", "resolved": "https://registry.npmjs.org/psl/-/psl-1.15.0.tgz", @@ -15967,6 +13743,7 @@ "integrity": "sha512-tsSGN1x3h569ZSU1u6diwhltLyfUWDp3YbFHedapTmpBl0B3P6U3+Qptg7xu+v+1io1EwhdPyyRHYbEw0KN2FA==", "dev": true, "license": "MIT", + "peer": true, "dependencies": { "hookified": "^1.14.0" }, @@ -15974,6 +13751,16 @@ "node": ">=20" } }, + "node_modules/qjobs": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/qjobs/-/qjobs-1.2.0.tgz", + "integrity": "sha512-8YOJEHtxpySA3fFDyCRxA+UUV+fA+rTWnuWvylOK/NCjhY+b4ocCtmu8TtsWb+mYeU+GCHf/S66KZF/AsteKHg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.9" + } + }, "node_modules/qs": { "version": "6.14.1", "resolved": "https://registry.npmjs.org/qs/-/qs-6.14.1.tgz", @@ -16042,38 +13829,14 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/randomatic": { - "version": "3.1.1", - "resolved": "https://registry.npmjs.org/randomatic/-/randomatic-3.1.1.tgz", - "integrity": "sha512-TuDE5KxZ0J461RVjrJZCJc+J+zCkTb1MbH9AQUq68sMhOMcy9jLcb3BrZKgp9q9Ncltdg4QVqWrH02W2EFFVYw==", - "dev": true, - "license": "MIT", - "dependencies": { - "is-number": "^4.0.0", - "kind-of": "^6.0.0", - "math-random": "^1.0.1" - }, - "engines": { - "node": ">= 0.10.0" - } - }, - "node_modules/randomatic/node_modules/is-number": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/is-number/-/is-number-4.0.0.tgz", - "integrity": "sha512-rSklcAIlf1OmFdyAqbnWTLVelsQ58uvZ66S/ZyawjWqIviTWCjg2PzVGw8WUA+nNuPTqb4wgA+NszrJ+08LlgQ==", + "node_modules/range-parser": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/range-parser/-/range-parser-1.2.1.tgz", + "integrity": "sha512-Hrgsx+orqoygnmhFbKaHE6c296J+HTAQXoxEF6gNupROmmGJRoyzfG3ccAveqCBrwr/2yxQ5BVd/GTl5agOwSg==", "dev": true, "license": "MIT", "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/randombytes": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/randombytes/-/randombytes-2.1.0.tgz", - "integrity": "sha512-vYl3iOX+4CKUWuxGi9Ukhie6fsqXqS9FE2Zaic4tNFD2N2QQaXOMFbuKK4QmDHC0JO6B1Zp41J0LpT0oR68amQ==", - "license": "MIT", - "dependencies": { - "safe-buffer": "^5.1.0" + "node": ">= 0.6" } }, "node_modules/raw-body": { @@ -16092,19 +13855,6 @@ "node": ">= 0.8" } }, - "node_modules/raw-body/node_modules/iconv-lite": { - "version": "0.4.24", - "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.4.24.tgz", - "integrity": "sha512-v3MXnZAcvnywkTUEZomIActle7RXXeedOR31wwl7VlyoXO4Qi9arvSenNQWne1TcRwhCL1HwLI21bEqdpj8/rA==", - "dev": true, - "license": "MIT", - "dependencies": { - "safer-buffer": ">= 2.1.2 < 3" - }, - "engines": { - "node": ">=0.10.0" - } - }, "node_modules/raw-loader": { "version": "0.5.1", "resolved": "https://registry.npmjs.org/raw-loader/-/raw-loader-0.5.1.tgz", @@ -16121,7 +13871,6 @@ "resolved": "https://registry.npmjs.org/react/-/react-16.14.0.tgz", "integrity": "sha512-0X2CImDkJGApiAlcf0ODKIneSwBPhqJawOa5wCtKbu7ZECrmS26NvtSILynQ66cgkT/RJ4LidJOc3bUESwmU8g==", "license": "MIT", - "peer": true, "dependencies": { "loose-envify": "^1.1.0", "object-assign": "^4.1.1", @@ -16177,7 +13926,6 @@ "resolved": "https://registry.npmjs.org/react-dom/-/react-dom-16.14.0.tgz", "integrity": "sha512-1gCeQXDLoIqMgqD3IO2Ah9bnf0w9kzhwN5q4FGnHZ67hBm9yePzB5JJAIQCc8x3pFnNlwFq4RidZggNAAkzWWw==", "license": "MIT", - "peer": true, "dependencies": { "loose-envify": "^1.1.0", "object-assign": "^4.1.1", @@ -16195,18 +13943,26 @@ "license": "Apache-2.0" }, "node_modules/react-focus-lock": { - "version": "1.19.1", - "resolved": "https://registry.npmjs.org/react-focus-lock/-/react-focus-lock-1.19.1.tgz", - "integrity": "sha512-TPpfiack1/nF4uttySfpxPk4rGZTLXlaZl7ncZg/ELAk24Iq2B1UUaUioID8H8dneUXqznT83JTNDHDj+kwryw==", + "version": "2.13.7", + "resolved": "https://registry.npmjs.org/react-focus-lock/-/react-focus-lock-2.13.7.tgz", + "integrity": "sha512-20lpZHEQrXPb+pp1tzd4ULL6DyO5D2KnR0G69tTDdydrmNhU7pdFmbQUYVyHUgp+xN29IuFR0PVuhOmvaZL9Og==", "license": "MIT", "dependencies": { "@babel/runtime": "^7.0.0", - "focus-lock": "^0.6.3", + "focus-lock": "^1.3.6", "prop-types": "^15.6.2", - "react-clientside-effect": "^1.2.0" + "react-clientside-effect": "^1.2.7", + "use-callback-ref": "^1.3.3", + "use-sidecar": "^1.1.3" }, "peerDependencies": { - "react": "^15.0.0 || ^16.0.0" + "@types/react": "*", + "react": "^16.8.0 || ^17.0.0 || ^18.0.0 || ^19.0.0 || ^19.0.0-rc" + }, + "peerDependenciesMeta": { + "@types/react": { + "optional": true + } } }, "node_modules/react-focus-on": { @@ -16235,40 +13991,11 @@ } } }, - "node_modules/react-focus-on/node_modules/focus-lock": { - "version": "1.3.6", - "resolved": "https://registry.npmjs.org/focus-lock/-/focus-lock-1.3.6.tgz", - "integrity": "sha512-Ik/6OCk9RQQ0T5Xw+hKNLWrjSMtv51dD4GRmJjbD5a58TIEpI5a5iXagKVl3Z5UuyslMCA8Xwnu76jQob62Yhg==", - "license": "MIT", - "dependencies": { - "tslib": "^2.0.3" - }, - "engines": { - "node": ">=10" - } - }, - "node_modules/react-focus-on/node_modules/react-focus-lock": { - "version": "2.13.7", - "resolved": "https://registry.npmjs.org/react-focus-lock/-/react-focus-lock-2.13.7.tgz", - "integrity": "sha512-20lpZHEQrXPb+pp1tzd4ULL6DyO5D2KnR0G69tTDdydrmNhU7pdFmbQUYVyHUgp+xN29IuFR0PVuhOmvaZL9Og==", - "license": "MIT", - "dependencies": { - "@babel/runtime": "^7.0.0", - "focus-lock": "^1.3.6", - "prop-types": "^15.6.2", - "react-clientside-effect": "^1.2.7", - "use-callback-ref": "^1.3.3", - "use-sidecar": "^1.1.3" - }, - "peerDependencies": { - "@types/react": "*", - "react": "^16.8.0 || ^17.0.0 || ^18.0.0 || ^19.0.0 || ^19.0.0-rc" - }, - "peerDependenciesMeta": { - "@types/react": { - "optional": true - } - } + "node_modules/react-focus-on/node_modules/tslib": { + "version": "2.8.1", + "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.8.1.tgz", + "integrity": "sha512-oJFu94HQb+KVduSUQL7wnpmqnfmLsOA/nAh6b6EH0wCEoK0/mPeXU6c3wKDV83MkOuHPRHtSXKKU99IBazS/2w==", + "license": "0BSD" }, "node_modules/react-is": { "version": "17.0.2", @@ -16380,6 +14107,18 @@ } } }, + "node_modules/react-remove-scroll-bar/node_modules/tslib": { + "version": "2.8.1", + "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.8.1.tgz", + "integrity": "sha512-oJFu94HQb+KVduSUQL7wnpmqnfmLsOA/nAh6b6EH0wCEoK0/mPeXU6c3wKDV83MkOuHPRHtSXKKU99IBazS/2w==", + "license": "0BSD" + }, + "node_modules/react-remove-scroll/node_modules/tslib": { + "version": "2.8.1", + "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.8.1.tgz", + "integrity": "sha512-oJFu94HQb+KVduSUQL7wnpmqnfmLsOA/nAh6b6EH0wCEoK0/mPeXU6c3wKDV83MkOuHPRHtSXKKU99IBazS/2w==", + "license": "0BSD" + }, "node_modules/react-responsive": { "version": "6.1.2", "resolved": "https://registry.npmjs.org/react-responsive/-/react-responsive-6.1.2.tgz", @@ -16442,13 +14181,12 @@ "license": "MIT" }, "node_modules/react-slick": { - "version": "0.30.3", - "resolved": "https://registry.npmjs.org/react-slick/-/react-slick-0.30.3.tgz", - "integrity": "sha512-B4x0L9GhkEWUMApeHxr/Ezp2NncpGc+5174R02j+zFiWuYboaq98vmxwlpafZfMjZic1bjdIqqmwLDcQY0QaFA==", + "version": "0.31.0", + "resolved": "https://registry.npmjs.org/react-slick/-/react-slick-0.31.0.tgz", + "integrity": "sha512-zo6VLT8wuSBJffg/TFPbzrw2dEnfZ/cUKmYsKByh3AgatRv29m2LoFbq5vRMa3R3A4wp4d8gwbJKO2fWZFaI3g==", "license": "MIT", "dependencies": { "classnames": "^2.2.5", - "enquire.js": "^2.1.6", "json2mq": "^0.2.0", "lodash.debounce": "^4.0.8", "resize-observer-polyfill": "^1.5.0" @@ -16480,6 +14218,12 @@ } } }, + "node_modules/react-style-singleton/node_modules/tslib": { + "version": "2.8.1", + "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.8.1.tgz", + "integrity": "sha512-oJFu94HQb+KVduSUQL7wnpmqnfmLsOA/nAh6b6EH0wCEoK0/mPeXU6c3wKDV83MkOuHPRHtSXKKU99IBazS/2w==", + "license": "0BSD" + }, "node_modules/react-table": { "version": "7.8.0", "resolved": "https://registry.npmjs.org/react-table/-/react-table-7.8.0.tgz", @@ -16645,640 +14389,250 @@ } }, "node_modules/readable-stream": { - "version": "1.0.34", - "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-1.0.34.tgz", - "integrity": "sha512-ok1qVCJuRkNmvebYikljxJA/UEsKwLl2nI1OmaqAu4/UE+h0wKCHok4XkL/gvi39OacXvw59RJUOFUkDib2rHg==", - "dev": true, + "version": "2.3.8", + "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-2.3.8.tgz", + "integrity": "sha512-8p0AUk4XODgIewSi0l8Epjs+EVnWiK7NoDIEGU0HhE7+ZyY8D1IMY7odu5lRrFXGg71L15KG8QrPmum45RTtdA==", "license": "MIT", "dependencies": { "core-util-is": "~1.0.0", - "inherits": "~2.0.1", - "isarray": "0.0.1", - "string_decoder": "~0.10.x" + "inherits": "~2.0.3", + "isarray": "~1.0.0", + "process-nextick-args": "~2.0.0", + "safe-buffer": "~5.1.1", + "string_decoder": "~1.1.1", + "util-deprecate": "~1.0.1" } }, + "node_modules/readable-stream/node_modules/isarray": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/isarray/-/isarray-1.0.0.tgz", + "integrity": "sha512-VLghIWNM6ELQzo7zwmcg0NmTVyWKYjvIeM83yjp0wRDTmUnrM678fQbcKBo6n2CJEF0szoG//ytg+TKla89ALQ==", + "license": "MIT" + }, "node_modules/readdirp": { - "version": "2.2.1", - "resolved": "https://registry.npmjs.org/readdirp/-/readdirp-2.2.1.tgz", - "integrity": "sha512-1JU/8q+VgFZyxwrJ+SVIOsh+KywWGpds3NTqikiKpDMZWScmAYyKIgqkO+ARvNWJfXeXR1zxz7aHF4u4CyH6vQ==", + "version": "3.6.0", + "resolved": "https://registry.npmjs.org/readdirp/-/readdirp-3.6.0.tgz", + "integrity": "sha512-hOS089on8RduqdbhvQ5Z37A0ESjsqz6qnRcffsMU3495FuTdqSm+7bhJ29JvIOsBDEEnan5DPu9t3To9VRlMzA==", "dev": true, "license": "MIT", "dependencies": { - "graceful-fs": "^4.1.11", - "micromatch": "^3.1.10", - "readable-stream": "^2.0.2" + "picomatch": "^2.2.1" }, "engines": { - "node": ">=0.10" + "node": ">=8.10.0" } }, - "node_modules/readdirp/node_modules/array-unique": { - "version": "0.3.2", - "resolved": "https://registry.npmjs.org/array-unique/-/array-unique-0.3.2.tgz", - "integrity": "sha512-SleRWjh9JUud2wH1hPs9rZBZ33H6T9HOiL0uwGnGx9FpE6wKGyfWugmbkEOIs6qWrZhg0LWeLziLrEwQJhs5mQ==", + "node_modules/readline2": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/readline2/-/readline2-1.0.1.tgz", + "integrity": "sha512-8/td4MmwUB6PkZUbV25uKz7dfrmjYWxsW8DVfibWdlHRk/l/DfHKn4pU+dfcoGLFgWOdyGCzINRQD7jn+Bv+/g==", "dev": true, "license": "MIT", - "engines": { - "node": ">=0.10.0" + "dependencies": { + "code-point-at": "^1.0.0", + "is-fullwidth-code-point": "^1.0.0", + "mute-stream": "0.0.5" } }, - "node_modules/readdirp/node_modules/braces": { - "version": "2.3.2", - "resolved": "https://registry.npmjs.org/braces/-/braces-2.3.2.tgz", - "integrity": "sha512-aNdbnj9P8PjdXU4ybaWLK2IF3jc/EoDYbC7AazW6to3TRsfXxscC9UXOB5iDiEQrkyIbWp2SLQda4+QAa7nc3w==", + "node_modules/rechoir": { + "version": "0.8.0", + "resolved": "https://registry.npmjs.org/rechoir/-/rechoir-0.8.0.tgz", + "integrity": "sha512-/vxpCXddiX8NGfGO/mTafwjq4aFa/71pvamip0++IQk3zG8cbCj0fifNPrjjF1XMXUne91jL9OoxmdykoEtifQ==", "dev": true, "license": "MIT", "dependencies": { - "arr-flatten": "^1.1.0", - "array-unique": "^0.3.2", - "extend-shallow": "^2.0.1", - "fill-range": "^4.0.0", - "isobject": "^3.0.1", - "repeat-element": "^1.1.2", - "snapdragon": "^0.8.1", - "snapdragon-node": "^2.0.1", - "split-string": "^3.0.2", - "to-regex": "^3.0.1" + "resolve": "^1.20.0" }, "engines": { - "node": ">=0.10.0" + "node": ">= 10.13.0" } }, - "node_modules/readdirp/node_modules/braces/node_modules/extend-shallow": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/extend-shallow/-/extend-shallow-2.0.1.tgz", - "integrity": "sha512-zCnTtlxNoAiDc3gqY2aYAWFx7XWWiasuF2K8Me5WbN8otHKTUKBwjPtNpRs/rbUZm7KxWAaNj7P1a/p52GbVug==", - "dev": true, + "node_modules/redent": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/redent/-/redent-3.0.0.tgz", + "integrity": "sha512-6tDA8g98We0zd0GvVeMT9arEOnTw9qM03L9cJXaCjrip1OO764RDBLBfrB4cwzNGDj5OA5ioymC9GkizgWJDUg==", "license": "MIT", "dependencies": { - "is-extendable": "^0.1.0" + "indent-string": "^4.0.0", + "strip-indent": "^3.0.0" }, "engines": { - "node": ">=0.10.0" + "node": ">=8" } }, - "node_modules/readdirp/node_modules/debug": { - "version": "2.6.9", - "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", - "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", - "dev": true, + "node_modules/redux": { + "version": "3.7.2", + "resolved": "https://registry.npmjs.org/redux/-/redux-3.7.2.tgz", + "integrity": "sha512-pNqnf9q1hI5HHZRBkj3bAngGZW/JMCmexDlOxw4XagXY2o1327nHH54LoTjiPJ0gizoqPDRqWyX/00g0hD6w+A==", "license": "MIT", "dependencies": { - "ms": "2.0.0" + "lodash": "^4.2.1", + "lodash-es": "^4.2.1", + "loose-envify": "^1.1.0", + "symbol-observable": "^1.0.3" } }, - "node_modules/readdirp/node_modules/expand-brackets": { - "version": "2.1.4", - "resolved": "https://registry.npmjs.org/expand-brackets/-/expand-brackets-2.1.4.tgz", - "integrity": "sha512-w/ozOKR9Obk3qoWeY/WDi6MFta9AoMR+zud60mdnbniMcBxRuFJyDt2LdX/14A1UABeqk+Uk+LDfUpvoGKppZA==", - "dev": true, - "license": "MIT", - "dependencies": { - "debug": "^2.3.3", - "define-property": "^0.2.5", - "extend-shallow": "^2.0.1", - "posix-character-classes": "^0.1.0", - "regex-not": "^1.0.0", - "snapdragon": "^0.8.1", - "to-regex": "^3.0.1" - }, - "engines": { - "node": ">=0.10.0" - } + "node_modules/redux-thunk": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/redux-thunk/-/redux-thunk-2.2.0.tgz", + "integrity": "sha512-OOFWh9mt/7i94QPq4IAxhSIUyfIJJRnk6pe1IwgXethQik3kyg1wuxVZZlW9QOmL5rP/MrwzV+Cb+/HBKlvM8Q==", + "license": "MIT" }, - "node_modules/readdirp/node_modules/expand-brackets/node_modules/define-property": { - "version": "0.2.5", - "resolved": "https://registry.npmjs.org/define-property/-/define-property-0.2.5.tgz", - "integrity": "sha512-Rr7ADjQZenceVOAKop6ALkkRAmH1A4Gx9hV/7ZujPUN2rkATqFO0JZLZInbAjpZYoJ1gUx8MRMQVkYemcbMSTA==", - "dev": true, + "node_modules/reflect.getprototypeof": { + "version": "1.0.10", + "resolved": "https://registry.npmjs.org/reflect.getprototypeof/-/reflect.getprototypeof-1.0.10.tgz", + "integrity": "sha512-00o4I+DVrefhv+nX0ulyi3biSHCPDe+yLv5o/p6d/UVlirijB8E16FtfwSAi4g3tcqrQ4lRAqQSoFEZJehYEcw==", "license": "MIT", "dependencies": { - "is-descriptor": "^0.1.0" + "call-bind": "^1.0.8", + "define-properties": "^1.2.1", + "es-abstract": "^1.23.9", + "es-errors": "^1.3.0", + "es-object-atoms": "^1.0.0", + "get-intrinsic": "^1.2.7", + "get-proto": "^1.0.1", + "which-builtin-type": "^1.2.1" }, "engines": { - "node": ">=0.10.0" + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/readdirp/node_modules/expand-brackets/node_modules/extend-shallow": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/extend-shallow/-/extend-shallow-2.0.1.tgz", - "integrity": "sha512-zCnTtlxNoAiDc3gqY2aYAWFx7XWWiasuF2K8Me5WbN8otHKTUKBwjPtNpRs/rbUZm7KxWAaNj7P1a/p52GbVug==", - "dev": true, + "node_modules/regenerate": { + "version": "1.4.2", + "resolved": "https://registry.npmjs.org/regenerate/-/regenerate-1.4.2.tgz", + "integrity": "sha512-zrceR/XhGYU/d/opr2EKO7aRHUeiBI8qjtfHqADTwZd6Szfy16la6kqD0MIUs5z5hx6AaKa+PixpPrR289+I0A==", + "license": "MIT" + }, + "node_modules/regenerate-unicode-properties": { + "version": "10.2.2", + "resolved": "https://registry.npmjs.org/regenerate-unicode-properties/-/regenerate-unicode-properties-10.2.2.tgz", + "integrity": "sha512-m03P+zhBeQd1RGnYxrGyDAPpWX/epKirLrp8e3qevZdVkKtnCrjjWczIbYc8+xd6vcTStVlqfycTx1KR4LOr0g==", "license": "MIT", "dependencies": { - "is-extendable": "^0.1.0" + "regenerate": "^1.4.2" }, "engines": { - "node": ">=0.10.0" + "node": ">=4" } }, - "node_modules/readdirp/node_modules/expand-brackets/node_modules/is-descriptor": { - "version": "0.1.7", - "resolved": "https://registry.npmjs.org/is-descriptor/-/is-descriptor-0.1.7.tgz", - "integrity": "sha512-C3grZTvObeN1xud4cRWl366OMXZTj0+HGyk4hvfpx4ZHt1Pb60ANSXqCK7pdOTeUQpRzECBSTphqvD7U+l22Eg==", - "dev": true, + "node_modules/regenerator-runtime": { + "version": "0.10.5", + "resolved": "https://registry.npmjs.org/regenerator-runtime/-/regenerator-runtime-0.10.5.tgz", + "integrity": "sha512-02YopEIhAgiBHWeoTiA8aitHDt8z6w+rQqNuIftlM+ZtvSl/brTouaU7DW6GO/cHtvxJvS4Hwv2ibKdxIRi24w==", + "license": "MIT" + }, + "node_modules/regexp.prototype.flags": { + "version": "1.5.4", + "resolved": "https://registry.npmjs.org/regexp.prototype.flags/-/regexp.prototype.flags-1.5.4.tgz", + "integrity": "sha512-dYqgNSZbDwkaJ2ceRd9ojCGjBq+mOm9LmtXnAnEGyHhN/5R7iDW2TRw3h+o/jCFxus3P2LfWIIiwowAjANm7IA==", "license": "MIT", "dependencies": { - "is-accessor-descriptor": "^1.0.1", - "is-data-descriptor": "^1.0.1" + "call-bind": "^1.0.8", + "define-properties": "^1.2.1", + "es-errors": "^1.3.0", + "get-proto": "^1.0.1", + "gopd": "^1.2.0", + "set-function-name": "^2.0.2" }, "engines": { "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/readdirp/node_modules/extglob": { - "version": "2.0.4", - "resolved": "https://registry.npmjs.org/extglob/-/extglob-2.0.4.tgz", - "integrity": "sha512-Nmb6QXkELsuBr24CJSkilo6UHHgbekK5UiZgfE6UHD3Eb27YC6oD+bhcT+tJ6cl8dmsgdQxnWlcry8ksBIBLpw==", - "dev": true, + "node_modules/regexpu-core": { + "version": "6.4.0", + "resolved": "https://registry.npmjs.org/regexpu-core/-/regexpu-core-6.4.0.tgz", + "integrity": "sha512-0ghuzq67LI9bLXpOX/ISfve/Mq33a4aFRzoQYhnnok1JOFpmE/A2TBGkNVenOGEeSBCjIiWcc6MVOG5HEQv0sA==", "license": "MIT", "dependencies": { - "array-unique": "^0.3.2", - "define-property": "^1.0.0", - "expand-brackets": "^2.1.4", - "extend-shallow": "^2.0.1", - "fragment-cache": "^0.2.1", - "regex-not": "^1.0.0", - "snapdragon": "^0.8.1", - "to-regex": "^3.0.1" + "regenerate": "^1.4.2", + "regenerate-unicode-properties": "^10.2.2", + "regjsgen": "^0.8.0", + "regjsparser": "^0.13.0", + "unicode-match-property-ecmascript": "^2.0.0", + "unicode-match-property-value-ecmascript": "^2.2.1" }, "engines": { - "node": ">=0.10.0" + "node": ">=4" } }, - "node_modules/readdirp/node_modules/extglob/node_modules/define-property": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/define-property/-/define-property-1.0.0.tgz", - "integrity": "sha512-cZTYKFWspt9jZsMscWo8sc/5lbPC9Q0N5nBLgb+Yd915iL3udB1uFgS3B8YCx66UVHq018DAVFoee7x+gxggeA==", - "dev": true, - "license": "MIT", + "node_modules/regjsgen": { + "version": "0.8.0", + "resolved": "https://registry.npmjs.org/regjsgen/-/regjsgen-0.8.0.tgz", + "integrity": "sha512-RvwtGe3d7LvWiDQXeQw8p5asZUmfU1G/l6WbUXeHta7Y2PEIvBTwH6E2EfmYUK8pxcxEdEmaomqyp0vZZ7C+3Q==", + "license": "MIT" + }, + "node_modules/regjsparser": { + "version": "0.13.0", + "resolved": "https://registry.npmjs.org/regjsparser/-/regjsparser-0.13.0.tgz", + "integrity": "sha512-NZQZdC5wOE/H3UT28fVGL+ikOZcEzfMGk/c3iN9UGxzWHMa1op7274oyiUVrAG4B2EuFhus8SvkaYnhvW92p9Q==", + "license": "BSD-2-Clause", "dependencies": { - "is-descriptor": "^1.0.0" + "jsesc": "~3.1.0" }, - "engines": { - "node": ">=0.10.0" + "bin": { + "regjsparser": "bin/parser" } }, - "node_modules/readdirp/node_modules/extglob/node_modules/extend-shallow": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/extend-shallow/-/extend-shallow-2.0.1.tgz", - "integrity": "sha512-zCnTtlxNoAiDc3gqY2aYAWFx7XWWiasuF2K8Me5WbN8otHKTUKBwjPtNpRs/rbUZm7KxWAaNj7P1a/p52GbVug==", + "node_modules/require-directory": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/require-directory/-/require-directory-2.1.1.tgz", + "integrity": "sha512-fGxEI7+wsG9xrvdjsrlmL22OMTTiHRwAMroiEeMgq8gzoLC/PQr7RsRDSTLUg/bZAZtF+TVIkHc6/4RIKrui+Q==", "dev": true, "license": "MIT", - "dependencies": { - "is-extendable": "^0.1.0" - }, "engines": { "node": ">=0.10.0" } }, - "node_modules/readdirp/node_modules/fill-range": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-4.0.0.tgz", - "integrity": "sha512-VcpLTWqWDiTerugjj8e3+esbg+skS3M9e54UuR3iCeIDMXCLTsAH8hTSzDQU/X6/6t3eYkOKoZSef2PlU6U1XQ==", - "dev": true, + "node_modules/require-from-string": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/require-from-string/-/require-from-string-2.0.2.tgz", + "integrity": "sha512-Xf0nWe6RseziFMu+Ap9biiUbmplq6S9/p+7w7YXP/JBHhrUDDUhwa+vANyubuqfZWTveU//DYVGsDG7RKL/vEw==", "license": "MIT", - "dependencies": { - "extend-shallow": "^2.0.1", - "is-number": "^3.0.0", - "repeat-string": "^1.6.1", - "to-regex-range": "^2.1.0" - }, "engines": { "node": ">=0.10.0" } }, - "node_modules/readdirp/node_modules/fill-range/node_modules/extend-shallow": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/extend-shallow/-/extend-shallow-2.0.1.tgz", - "integrity": "sha512-zCnTtlxNoAiDc3gqY2aYAWFx7XWWiasuF2K8Me5WbN8otHKTUKBwjPtNpRs/rbUZm7KxWAaNj7P1a/p52GbVug==", + "node_modules/require-uncached": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/require-uncached/-/require-uncached-1.0.3.tgz", + "integrity": "sha512-Xct+41K3twrbBHdxAgMoOS+cNcoqIjfM2/VxBF4LL2hVph7YsF8VSKyQ3BDFZwEVbok9yeDl2le/qo0S77WG2w==", "dev": true, "license": "MIT", "dependencies": { - "is-extendable": "^0.1.0" + "caller-path": "^0.1.0", + "resolve-from": "^1.0.0" }, "engines": { "node": ">=0.10.0" } }, - "node_modules/readdirp/node_modules/is-extendable": { - "version": "0.1.1", - "resolved": "https://registry.npmjs.org/is-extendable/-/is-extendable-0.1.1.tgz", - "integrity": "sha512-5BMULNob1vgFX6EjQw5izWDxrecWK9AM72rugNr0TFldMOi0fj6Jk+zeKIt0xGj4cEfQIJth4w3OKWOJ4f+AFw==", + "node_modules/require-uncached/node_modules/resolve-from": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/resolve-from/-/resolve-from-1.0.1.tgz", + "integrity": "sha512-kT10v4dhrlLNcnO084hEjvXCI1wUG9qZLoz2RogxqDQQYy7IxjI/iMUkOtQTNEh6rzHxvdQWHsJyel1pKOVCxg==", "dev": true, "license": "MIT", "engines": { "node": ">=0.10.0" } }, - "node_modules/readdirp/node_modules/is-number": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/is-number/-/is-number-3.0.0.tgz", - "integrity": "sha512-4cboCqIpliH+mAvFNegjZQ4kgKc3ZUhQVr3HvWbSh5q3WH2v82ct+T2Y1hdU5Gdtorx/cLifQjqCbL7bpznLTg==", - "dev": true, + "node_modules/requirejs": { + "version": "2.3.8", + "resolved": "https://registry.npmjs.org/requirejs/-/requirejs-2.3.8.tgz", + "integrity": "sha512-7/cTSLOdYkNBNJcDMWf+luFvMriVm7eYxp4BcFCsAX0wF421Vyce5SXP17c+Jd5otXKGNehIonFlyQXSowL6Mw==", "license": "MIT", - "dependencies": { - "kind-of": "^3.0.2" + "bin": { + "r_js": "bin/r.js", + "r.js": "bin/r.js" }, "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/readdirp/node_modules/is-number/node_modules/kind-of": { - "version": "3.2.2", - "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-3.2.2.tgz", - "integrity": "sha512-NOW9QQXMoZGg/oqnVNoNTTIFEIid1627WCffUBJEdMxYApq7mNE7CpzucIPc+ZQg25Phej7IJSmX3hO+oblOtQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "is-buffer": "^1.1.5" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/readdirp/node_modules/isarray": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/isarray/-/isarray-1.0.0.tgz", - "integrity": "sha512-VLghIWNM6ELQzo7zwmcg0NmTVyWKYjvIeM83yjp0wRDTmUnrM678fQbcKBo6n2CJEF0szoG//ytg+TKla89ALQ==", - "dev": true, - "license": "MIT" - }, - "node_modules/readdirp/node_modules/micromatch": { - "version": "3.1.10", - "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-3.1.10.tgz", - "integrity": "sha512-MWikgl9n9M3w+bpsY3He8L+w9eF9338xRl8IAO5viDizwSzziFEyUzo2xrrloB64ADbTf8uA8vRqqttDTOmccg==", - "dev": true, - "license": "MIT", - "dependencies": { - "arr-diff": "^4.0.0", - "array-unique": "^0.3.2", - "braces": "^2.3.1", - "define-property": "^2.0.2", - "extend-shallow": "^3.0.2", - "extglob": "^2.0.4", - "fragment-cache": "^0.2.1", - "kind-of": "^6.0.2", - "nanomatch": "^1.2.9", - "object.pick": "^1.3.0", - "regex-not": "^1.0.0", - "snapdragon": "^0.8.1", - "to-regex": "^3.0.2" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/readdirp/node_modules/ms": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", - "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==", - "dev": true, - "license": "MIT" - }, - "node_modules/readdirp/node_modules/readable-stream": { - "version": "2.3.8", - "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-2.3.8.tgz", - "integrity": "sha512-8p0AUk4XODgIewSi0l8Epjs+EVnWiK7NoDIEGU0HhE7+ZyY8D1IMY7odu5lRrFXGg71L15KG8QrPmum45RTtdA==", - "dev": true, - "license": "MIT", - "dependencies": { - "core-util-is": "~1.0.0", - "inherits": "~2.0.3", - "isarray": "~1.0.0", - "process-nextick-args": "~2.0.0", - "safe-buffer": "~5.1.1", - "string_decoder": "~1.1.1", - "util-deprecate": "~1.0.1" - } - }, - "node_modules/readdirp/node_modules/repeat-string": { - "version": "1.6.1", - "resolved": "https://registry.npmjs.org/repeat-string/-/repeat-string-1.6.1.tgz", - "integrity": "sha512-PV0dzCYDNfRi1jCDbJzpW7jNNDRuCOG/jI5ctQcGKt/clZD+YcPS3yIlWuTJMmESC8aevCFmWJy5wjAFgNqN6w==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=0.10" - } - }, - "node_modules/readdirp/node_modules/safe-buffer": { - "version": "5.1.2", - "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.1.2.tgz", - "integrity": "sha512-Gd2UZBJDkXlY7GbJxfsE8/nvKkUEU1G38c1siN6QP6a9PT9MmHB8GnpscSmMJSoF8LOIrt8ud/wPtojys4G6+g==", - "dev": true, - "license": "MIT" - }, - "node_modules/readdirp/node_modules/string_decoder": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.1.1.tgz", - "integrity": "sha512-n/ShnvDi6FHbbVfviro+WojiFzv+s8MPMHBczVePfUpDJLwoLT0ht1l4YwBCbi8pJAveEEdnkHyPyTP/mzRfwg==", - "dev": true, - "license": "MIT", - "dependencies": { - "safe-buffer": "~5.1.0" - } - }, - "node_modules/readdirp/node_modules/to-regex-range": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-2.1.1.tgz", - "integrity": "sha512-ZZWNfCjUokXXDGXFpZehJIkZqq91BcULFq/Pi7M5i4JnxXdhMKAK682z8bCW3o8Hj1wuuzoKcW3DfVzaP6VuNg==", - "dev": true, - "license": "MIT", - "dependencies": { - "is-number": "^3.0.0", - "repeat-string": "^1.6.1" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/readline2": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/readline2/-/readline2-1.0.1.tgz", - "integrity": "sha512-8/td4MmwUB6PkZUbV25uKz7dfrmjYWxsW8DVfibWdlHRk/l/DfHKn4pU+dfcoGLFgWOdyGCzINRQD7jn+Bv+/g==", - "dev": true, - "license": "MIT", - "dependencies": { - "code-point-at": "^1.0.0", - "is-fullwidth-code-point": "^1.0.0", - "mute-stream": "0.0.5" - } - }, - "node_modules/readline2/node_modules/is-fullwidth-code-point": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-1.0.0.tgz", - "integrity": "sha512-1pqUqRjkhPJ9miNq9SwMfdvi6lBJcd6eFxvfaivQhaH3SgisfiuudvFntdKOmxuee/77l+FPjKrQjWvmPjWrRw==", - "dev": true, - "license": "MIT", - "dependencies": { - "number-is-nan": "^1.0.0" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/readline2/node_modules/mute-stream": { - "version": "0.0.5", - "resolved": "https://registry.npmjs.org/mute-stream/-/mute-stream-0.0.5.tgz", - "integrity": "sha512-EbrziT4s8cWPmzr47eYVW3wimS4HsvlnV5ri1xw1aR6JQo/OrJX5rkl32K/QQHdxeabJETtfeaROGhd8W7uBgg==", - "dev": true, - "license": "ISC" - }, - "node_modules/rechoir": { - "version": "0.8.0", - "resolved": "https://registry.npmjs.org/rechoir/-/rechoir-0.8.0.tgz", - "integrity": "sha512-/vxpCXddiX8NGfGO/mTafwjq4aFa/71pvamip0++IQk3zG8cbCj0fifNPrjjF1XMXUne91jL9OoxmdykoEtifQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "resolve": "^1.20.0" - }, - "engines": { - "node": ">= 10.13.0" - } - }, - "node_modules/redent": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/redent/-/redent-3.0.0.tgz", - "integrity": "sha512-6tDA8g98We0zd0GvVeMT9arEOnTw9qM03L9cJXaCjrip1OO764RDBLBfrB4cwzNGDj5OA5ioymC9GkizgWJDUg==", - "license": "MIT", - "dependencies": { - "indent-string": "^4.0.0", - "strip-indent": "^3.0.0" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/redux": { - "version": "3.7.2", - "resolved": "https://registry.npmjs.org/redux/-/redux-3.7.2.tgz", - "integrity": "sha512-pNqnf9q1hI5HHZRBkj3bAngGZW/JMCmexDlOxw4XagXY2o1327nHH54LoTjiPJ0gizoqPDRqWyX/00g0hD6w+A==", - "license": "MIT", - "peer": true, - "dependencies": { - "lodash": "^4.2.1", - "lodash-es": "^4.2.1", - "loose-envify": "^1.1.0", - "symbol-observable": "^1.0.3" - } - }, - "node_modules/redux-thunk": { - "version": "2.2.0", - "resolved": "https://registry.npmjs.org/redux-thunk/-/redux-thunk-2.2.0.tgz", - "integrity": "sha512-OOFWh9mt/7i94QPq4IAxhSIUyfIJJRnk6pe1IwgXethQik3kyg1wuxVZZlW9QOmL5rP/MrwzV+Cb+/HBKlvM8Q==", - "license": "MIT" - }, - "node_modules/reflect.getprototypeof": { - "version": "1.0.10", - "resolved": "https://registry.npmjs.org/reflect.getprototypeof/-/reflect.getprototypeof-1.0.10.tgz", - "integrity": "sha512-00o4I+DVrefhv+nX0ulyi3biSHCPDe+yLv5o/p6d/UVlirijB8E16FtfwSAi4g3tcqrQ4lRAqQSoFEZJehYEcw==", - "license": "MIT", - "dependencies": { - "call-bind": "^1.0.8", - "define-properties": "^1.2.1", - "es-abstract": "^1.23.9", - "es-errors": "^1.3.0", - "es-object-atoms": "^1.0.0", - "get-intrinsic": "^1.2.7", - "get-proto": "^1.0.1", - "which-builtin-type": "^1.2.1" - }, - "engines": { - "node": ">= 0.4" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/regenerate": { - "version": "1.4.2", - "resolved": "https://registry.npmjs.org/regenerate/-/regenerate-1.4.2.tgz", - "integrity": "sha512-zrceR/XhGYU/d/opr2EKO7aRHUeiBI8qjtfHqADTwZd6Szfy16la6kqD0MIUs5z5hx6AaKa+PixpPrR289+I0A==", - "license": "MIT" - }, - "node_modules/regenerate-unicode-properties": { - "version": "10.2.2", - "resolved": "https://registry.npmjs.org/regenerate-unicode-properties/-/regenerate-unicode-properties-10.2.2.tgz", - "integrity": "sha512-m03P+zhBeQd1RGnYxrGyDAPpWX/epKirLrp8e3qevZdVkKtnCrjjWczIbYc8+xd6vcTStVlqfycTx1KR4LOr0g==", - "license": "MIT", - "dependencies": { - "regenerate": "^1.4.2" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/regenerator-runtime": { - "version": "0.10.5", - "resolved": "https://registry.npmjs.org/regenerator-runtime/-/regenerator-runtime-0.10.5.tgz", - "integrity": "sha512-02YopEIhAgiBHWeoTiA8aitHDt8z6w+rQqNuIftlM+ZtvSl/brTouaU7DW6GO/cHtvxJvS4Hwv2ibKdxIRi24w==", - "license": "MIT" - }, - "node_modules/regex-cache": { - "version": "0.4.4", - "resolved": "https://registry.npmjs.org/regex-cache/-/regex-cache-0.4.4.tgz", - "integrity": "sha512-nVIZwtCjkC9YgvWkpM55B5rBhBYRZhAaJbgcFYXXsHnbZ9UZI9nnVWYZpBlCqv9ho2eZryPnWrZGsOdPwVWXWQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "is-equal-shallow": "^0.1.3" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/regex-not": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/regex-not/-/regex-not-1.0.2.tgz", - "integrity": "sha512-J6SDjUgDxQj5NusnOtdFxDwN/+HWykR8GELwctJ7mdqhcyy1xEc4SRFHUXvxTp661YaVKAjfRLZ9cCqS6tn32A==", - "dev": true, - "license": "MIT", - "dependencies": { - "extend-shallow": "^3.0.2", - "safe-regex": "^1.1.0" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/regexp.prototype.flags": { - "version": "1.5.4", - "resolved": "https://registry.npmjs.org/regexp.prototype.flags/-/regexp.prototype.flags-1.5.4.tgz", - "integrity": "sha512-dYqgNSZbDwkaJ2ceRd9ojCGjBq+mOm9LmtXnAnEGyHhN/5R7iDW2TRw3h+o/jCFxus3P2LfWIIiwowAjANm7IA==", - "license": "MIT", - "dependencies": { - "call-bind": "^1.0.8", - "define-properties": "^1.2.1", - "es-errors": "^1.3.0", - "get-proto": "^1.0.1", - "gopd": "^1.2.0", - "set-function-name": "^2.0.2" - }, - "engines": { - "node": ">= 0.4" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/regexpu-core": { - "version": "6.4.0", - "resolved": "https://registry.npmjs.org/regexpu-core/-/regexpu-core-6.4.0.tgz", - "integrity": "sha512-0ghuzq67LI9bLXpOX/ISfve/Mq33a4aFRzoQYhnnok1JOFpmE/A2TBGkNVenOGEeSBCjIiWcc6MVOG5HEQv0sA==", - "license": "MIT", - "dependencies": { - "regenerate": "^1.4.2", - "regenerate-unicode-properties": "^10.2.2", - "regjsgen": "^0.8.0", - "regjsparser": "^0.13.0", - "unicode-match-property-ecmascript": "^2.0.0", - "unicode-match-property-value-ecmascript": "^2.2.1" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/regjsgen": { - "version": "0.8.0", - "resolved": "https://registry.npmjs.org/regjsgen/-/regjsgen-0.8.0.tgz", - "integrity": "sha512-RvwtGe3d7LvWiDQXeQw8p5asZUmfU1G/l6WbUXeHta7Y2PEIvBTwH6E2EfmYUK8pxcxEdEmaomqyp0vZZ7C+3Q==", - "license": "MIT" - }, - "node_modules/regjsparser": { - "version": "0.13.0", - "resolved": "https://registry.npmjs.org/regjsparser/-/regjsparser-0.13.0.tgz", - "integrity": "sha512-NZQZdC5wOE/H3UT28fVGL+ikOZcEzfMGk/c3iN9UGxzWHMa1op7274oyiUVrAG4B2EuFhus8SvkaYnhvW92p9Q==", - "license": "BSD-2-Clause", - "dependencies": { - "jsesc": "~3.1.0" - }, - "bin": { - "regjsparser": "bin/parser" - } - }, - "node_modules/remove-trailing-separator": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/remove-trailing-separator/-/remove-trailing-separator-1.1.0.tgz", - "integrity": "sha512-/hS+Y0u3aOfIETiaiirUFwDBDzmXPvO+jAfKTitUngIPzdKc6Z0LoFjM/CK5PL4C+eKwHohlHAb6H0VFfmmUsw==", - "dev": true, - "license": "ISC" - }, - "node_modules/repeat-element": { - "version": "1.1.4", - "resolved": "https://registry.npmjs.org/repeat-element/-/repeat-element-1.1.4.tgz", - "integrity": "sha512-LFiNfRcSu7KK3evMyYOuCzv3L10TW7yC1G2/+StMjK8Y6Vqd2MG7r/Qjw4ghtuCOjFvlnms/iMmLqpvW/ES/WQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/repeat-string": { - "version": "0.2.2", - "resolved": "https://registry.npmjs.org/repeat-string/-/repeat-string-0.2.2.tgz", - "integrity": "sha512-yHeI3F9v20MY+8/5WAUgIWseMZwpLD+l9h5hGyzh6fQjhle2AwjjRDao1m5IozSDuVvMw09/mvE8AU1oDmZKpQ==", - "dev": true, - "engines": { - "node": ">=0.10" - } - }, - "node_modules/require-directory": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/require-directory/-/require-directory-2.1.1.tgz", - "integrity": "sha512-fGxEI7+wsG9xrvdjsrlmL22OMTTiHRwAMroiEeMgq8gzoLC/PQr7RsRDSTLUg/bZAZtF+TVIkHc6/4RIKrui+Q==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/require-from-string": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/require-from-string/-/require-from-string-2.0.2.tgz", - "integrity": "sha512-Xf0nWe6RseziFMu+Ap9biiUbmplq6S9/p+7w7YXP/JBHhrUDDUhwa+vANyubuqfZWTveU//DYVGsDG7RKL/vEw==", - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/require-uncached": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/require-uncached/-/require-uncached-1.0.3.tgz", - "integrity": "sha512-Xct+41K3twrbBHdxAgMoOS+cNcoqIjfM2/VxBF4LL2hVph7YsF8VSKyQ3BDFZwEVbok9yeDl2le/qo0S77WG2w==", - "dev": true, - "license": "MIT", - "dependencies": { - "caller-path": "^0.1.0", - "resolve-from": "^1.0.0" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/require-uncached/node_modules/resolve-from": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/resolve-from/-/resolve-from-1.0.1.tgz", - "integrity": "sha512-kT10v4dhrlLNcnO084hEjvXCI1wUG9qZLoz2RogxqDQQYy7IxjI/iMUkOtQTNEh6rzHxvdQWHsJyel1pKOVCxg==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/requirejs": { - "version": "2.3.8", - "resolved": "https://registry.npmjs.org/requirejs/-/requirejs-2.3.8.tgz", - "integrity": "sha512-7/cTSLOdYkNBNJcDMWf+luFvMriVm7eYxp4BcFCsAX0wF421Vyce5SXP17c+Jd5otXKGNehIonFlyQXSowL6Mw==", - "license": "MIT", - "peer": true, - "bin": { - "r_js": "bin/r.js", - "r.js": "bin/r.js" - }, - "engines": { - "node": ">=0.4.0" + "node": ">=0.4.0" } }, "node_modules/requirejs-text": { @@ -17348,14 +14702,6 @@ "integrity": "sha512-C7rARubxI8bXFNB/hqcp/4iUeIXJhJZvFPFPiSPRnhU5UPxzMFIl+2E6yY6c4k9giDJAhtV+enfA+G89N6Csng==", "license": "MIT" }, - "node_modules/resolve-url": { - "version": "0.2.1", - "resolved": "https://registry.npmjs.org/resolve-url/-/resolve-url-0.2.1.tgz", - "integrity": "sha512-ZuF55hVUQaaczgOIwqWzkEcEidmlD/xl44x1UZnhOXcYuFN2S6+rcxpG+C1N3So0wvNI3DmJICUFfu2SxhBmvg==", - "deprecated": "https://github.com/lydell/resolve-url#deprecated", - "dev": true, - "license": "MIT" - }, "node_modules/resolve.exports": { "version": "2.0.3", "resolved": "https://registry.npmjs.org/resolve.exports/-/resolve.exports-2.0.3.tgz", @@ -17366,23 +14712,28 @@ "node": ">=10" } }, - "node_modules/ret": { - "version": "0.1.15", - "resolved": "https://registry.npmjs.org/ret/-/ret-0.1.15.tgz", - "integrity": "sha512-TTlYpa+OL+vMMNG24xSlQGEJ3B/RzEfUlLct7b5G/ytav+wPrplCpVMFuwzXbkecJrb6IYo1iFb0S9v37754mg==", + "node_modules/restore-cursor": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/restore-cursor/-/restore-cursor-1.0.1.tgz", + "integrity": "sha512-reSjH4HuiFlxlaBaFCiS6O76ZGG2ygKoSlCsipKdaZuKSPx/+bt9mULkn4l0asVzbEfQQmXRg6Wp6gv6m0wElw==", "dev": true, "license": "MIT", + "dependencies": { + "exit-hook": "^1.0.0", + "onetime": "^1.0.0" + }, "engines": { - "node": ">=0.12" + "node": ">=0.10.0" } }, - "node_modules/retry": { - "version": "0.12.0", - "resolved": "https://registry.npmjs.org/retry/-/retry-0.12.0.tgz", - "integrity": "sha512-9LkiTwjUh6rT555DtE9rTX+BKByPfrMzEAtnlEtdEwr3Nkffwiihqe2bWADg+OQRjt9gl6ICdmB/ZFDCGAtSow==", + "node_modules/restore-cursor/node_modules/onetime": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/onetime/-/onetime-1.1.0.tgz", + "integrity": "sha512-GZ+g4jayMqzCRMgB2sol7GiCLjKfS1PINkjmx8spcKce1LiVqcbQreXwqs2YAFXC6R03VIG28ZS31t8M866v6A==", + "dev": true, "license": "MIT", "engines": { - "node": ">= 4" + "node": ">=0.10.0" } }, "node_modules/reusify": { @@ -17396,10 +14747,17 @@ "node": ">=0.10.0" } }, + "node_modules/rfdc": { + "version": "1.4.1", + "resolved": "https://registry.npmjs.org/rfdc/-/rfdc-1.4.1.tgz", + "integrity": "sha512-q1b3N5QkRUWUl7iyylaaj3kOpIT0N2i9MqIEQXP73GVsN9cw3fdx8X63cEmWhJGi2PPCF23Ijp7ktmd39rawIA==", + "dev": true, + "license": "MIT" + }, "node_modules/rimraf": { - "version": "2.7.1", - "resolved": "https://registry.npmjs.org/rimraf/-/rimraf-2.7.1.tgz", - "integrity": "sha512-uWjbaKIK3T1OSVptzX7Nl6PvQ3qAGtKEtVRjRuazjfL3Bx5eI409VZSqgND+4UNnmzLVdPj9FqFJNPqBZFve4w==", + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/rimraf/-/rimraf-3.0.2.tgz", + "integrity": "sha512-JZkJMZkAGFFPP2YqXZXPbMlMBgsxzE8ILs4lMIX/2o0L9UBw9O/Y3o6wFw/i9YLapcUJWwqbi3kdxIPdC62TIA==", "deprecated": "Rimraf versions prior to v4 are no longer supported", "dev": true, "license": "ISC", @@ -17408,54 +14766,11 @@ }, "bin": { "rimraf": "bin.js" - } - }, - "node_modules/rimraf/node_modules/brace-expansion": { - "version": "1.1.12", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.12.tgz", - "integrity": "sha512-9T9UjW3r0UW5c1Q7GTwllptXwhvYmEzFhzMfZ9H7FQWt+uZePjZPjBP/W1ZEyZ1twGWom5/56TF4lPcqjnDHcg==", - "dev": true, - "license": "MIT", - "dependencies": { - "balanced-match": "^1.0.0", - "concat-map": "0.0.1" - } - }, - "node_modules/rimraf/node_modules/glob": { - "version": "7.2.3", - "resolved": "https://registry.npmjs.org/glob/-/glob-7.2.3.tgz", - "integrity": "sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q==", - "deprecated": "Glob versions prior to v9 are no longer supported", - "dev": true, - "license": "ISC", - "dependencies": { - "fs.realpath": "^1.0.0", - "inflight": "^1.0.4", - "inherits": "2", - "minimatch": "^3.1.1", - "once": "^1.3.0", - "path-is-absolute": "^1.0.0" - }, - "engines": { - "node": "*" }, "funding": { "url": "https://github.com/sponsors/isaacs" } }, - "node_modules/rimraf/node_modules/minimatch": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", - "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", - "dev": true, - "license": "ISC", - "dependencies": { - "brace-expansion": "^1.1.7" - }, - "engines": { - "node": "*" - } - }, "node_modules/rtlcss": { "version": "4.3.0", "resolved": "https://registry.npmjs.org/rtlcss/-/rtlcss-4.3.0.tgz", @@ -17474,6 +14789,16 @@ "node": ">=12.0.0" } }, + "node_modules/run-async": { + "version": "0.1.0", + "resolved": "https://registry.npmjs.org/run-async/-/run-async-0.1.0.tgz", + "integrity": "sha512-qOX+w+IxFgpUpJfkv2oGN0+ExPs68F4sZHfaRRx4dDexAQkG83atugKVEylyT5ARees3HBbfmuvnjbrd8j9Wjw==", + "dev": true, + "license": "MIT", + "dependencies": { + "once": "^1.3.0" + } + }, "node_modules/run-parallel": { "version": "1.2.0", "resolved": "https://registry.npmjs.org/run-parallel/-/run-parallel-1.2.0.tgz", @@ -17530,23 +14855,9 @@ "license": "MIT" }, "node_modules/safe-buffer": { - "version": "5.2.1", - "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.2.1.tgz", - "integrity": "sha512-rp3So07KcdmmKbGvgaNxQSJr7bGVSVk5S9Eq1F+ppbRo70+YeaDxkw5Dd8NPN+GD6bjnYm2VuPuCXmpuYvmCXQ==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/feross" - }, - { - "type": "patreon", - "url": "https://www.patreon.com/feross" - }, - { - "type": "consulting", - "url": "https://feross.org/support" - } - ], + "version": "5.1.2", + "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.1.2.tgz", + "integrity": "sha512-Gd2UZBJDkXlY7GbJxfsE8/nvKkUEU1G38c1siN6QP6a9PT9MmHB8GnpscSmMJSoF8LOIrt8ud/wPtojys4G6+g==", "license": "MIT" }, "node_modules/safe-push-apply": { @@ -17571,16 +14882,6 @@ "integrity": "sha512-xHjhDr3cNBK0BzdUJSPXZntQUx/mwMS5Rw4A7lPJ90XGAO6ISP/ePDNuo0vhqOZU+UD5JoodwCAAoZQd3FeAKw==", "license": "MIT" }, - "node_modules/safe-regex": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/safe-regex/-/safe-regex-1.1.0.tgz", - "integrity": "sha512-aJXcif4xnaNUzvUuC5gcb46oTS7zvg4jpMTnuqtrEPlR3vFr4pxtdTwaF1Qs3Enjn9HK+ZlwQui+a7z0SywIzg==", - "dev": true, - "license": "MIT", - "dependencies": { - "ret": "~0.1.10" - } - }, "node_modules/safe-regex-test": { "version": "1.1.0", "resolved": "https://registry.npmjs.org/safe-regex-test/-/safe-regex-test-1.1.0.tgz", @@ -17761,13 +15062,13 @@ } }, "node_modules/sass": { - "version": "1.97.3", - "resolved": "https://registry.npmjs.org/sass/-/sass-1.97.3.tgz", - "integrity": "sha512-fDz1zJpd5GycprAbu4Q2PV/RprsRtKC/0z82z0JLgdytmcq0+ujJbJ/09bPGDxCLkKY3Np5cRAOcWiVkLXJURg==", + "version": "1.99.0", + "resolved": "https://registry.npmjs.org/sass/-/sass-1.99.0.tgz", + "integrity": "sha512-kgW13M54DUB7IsIRM5LvJkNlpH+WhMpooUcaWGFARkF1Tc82v9mIWkCbCYf+MBvpIUBSeSOTilpZjEPr2VYE6Q==", "license": "MIT", "dependencies": { "chokidar": "^4.0.0", - "immutable": "^5.0.2", + "immutable": "^5.1.5", "source-map-js": ">=0.6.2 <2.0.0" }, "bin": { @@ -17781,9 +15082,9 @@ } }, "node_modules/sass-loader": { - "version": "16.0.6", - "resolved": "https://registry.npmjs.org/sass-loader/-/sass-loader-16.0.6.tgz", - "integrity": "sha512-sglGzId5gmlfxNs4gK2U3h7HlVRfx278YK6Ono5lwzuvi1jxig80YiuHkaDBVsYIKFhx8wN7XSCI0M2IDS/3qA==", + "version": "16.0.7", + "resolved": "https://registry.npmjs.org/sass-loader/-/sass-loader-16.0.7.tgz", + "integrity": "sha512-w6q+fRHourZ+e+xA1kcsF27iGM6jdB8teexYCfdUw0sYgcDNeZESnDNT9sUmmPm3ooziwUJXGwZJSTF3kOdBfA==", "license": "MIT", "dependencies": { "neo-async": "^2.6.2" @@ -17796,7 +15097,7 @@ "url": "https://opencollective.com/webpack" }, "peerDependencies": { - "@rspack/core": "0.x || 1.x", + "@rspack/core": "0.x || ^1.0.0 || ^2.0.0-0", "node-sass": "^4.0.0 || ^5.0.0 || ^6.0.0 || ^7.0.0 || ^8.0.0 || ^9.0.0", "sass": "^1.3.0", "sass-embedded": "*", @@ -17896,9 +15197,9 @@ "license": "MIT" }, "node_modules/selenium-webdriver": { - "version": "4.40.0", - "resolved": "https://registry.npmjs.org/selenium-webdriver/-/selenium-webdriver-4.40.0.tgz", - "integrity": "sha512-dU0QbnVKdPmoNP8OtMCazRdtU2Ux6Wl4FEpG1iwUbDeajJK1dBAywBLrC1D7YFRtogHzN96AbXBgBAJaarcysw==", + "version": "4.43.0", + "resolved": "https://registry.npmjs.org/selenium-webdriver/-/selenium-webdriver-4.43.0.tgz", + "integrity": "sha512-dV4zBTT37or3Z3/8uD6rS8zvd4ZxPuG4EJVlqYIbZCGZCYttZm7xb9rlFLSk4rrsQHAeDYvudl7cquo0vWpHjg==", "dev": true, "funding": [ { @@ -17915,7 +15216,7 @@ "@bazel/runfiles": "^6.5.0", "jszip": "^3.10.1", "tmp": "^0.2.5", - "ws": "^8.18.3" + "ws": "^8.20.0" }, "engines": { "node": ">= 20.0.0" @@ -17930,15 +15231,6 @@ "semver": "bin/semver.js" } }, - "node_modules/serialize-javascript": { - "version": "6.0.2", - "resolved": "https://registry.npmjs.org/serialize-javascript/-/serialize-javascript-6.0.2.tgz", - "integrity": "sha512-Saa1xPByTTq2gdeFZYLLo+RFE35NHZkAbqZeWNd3BpzppeVisAqpDjcp8dyf6uIvEqJRd46jemmyA4iFIeVk8g==", - "license": "BSD-3-Clause", - "dependencies": { - "randombytes": "^2.1.0" - } - }, "node_modules/set-function-length": { "version": "1.2.2", "resolved": "https://registry.npmjs.org/set-function-length/-/set-function-length-1.2.2.tgz", @@ -17964,64 +15256,25 @@ "dependencies": { "define-data-property": "^1.1.4", "es-errors": "^1.3.0", - "functions-have-names": "^1.2.3", - "has-property-descriptors": "^1.0.2" - }, - "engines": { - "node": ">= 0.4" - } - }, - "node_modules/set-proto": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/set-proto/-/set-proto-1.0.0.tgz", - "integrity": "sha512-RJRdvCo6IAnPdsvP/7m6bsQqNnn1FCBX5ZNtFL98MmFF/4xAIJTIg1YbHW5DC2W5SKZanrC6i4HsJqlajw/dZw==", - "license": "MIT", - "dependencies": { - "dunder-proto": "^1.0.1", - "es-errors": "^1.3.0", - "es-object-atoms": "^1.0.0" - }, - "engines": { - "node": ">= 0.4" - } - }, - "node_modules/set-value": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/set-value/-/set-value-2.0.1.tgz", - "integrity": "sha512-JxHc1weCN68wRY0fhCoXpyK55m/XPHafOmK4UWD7m2CI14GMcFypt4w/0+NV5f/ZMby2F6S2wwA7fgynh9gWSw==", - "dev": true, - "license": "MIT", - "dependencies": { - "extend-shallow": "^2.0.1", - "is-extendable": "^0.1.1", - "is-plain-object": "^2.0.3", - "split-string": "^3.0.1" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/set-value/node_modules/extend-shallow": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/extend-shallow/-/extend-shallow-2.0.1.tgz", - "integrity": "sha512-zCnTtlxNoAiDc3gqY2aYAWFx7XWWiasuF2K8Me5WbN8otHKTUKBwjPtNpRs/rbUZm7KxWAaNj7P1a/p52GbVug==", - "dev": true, - "license": "MIT", - "dependencies": { - "is-extendable": "^0.1.0" + "functions-have-names": "^1.2.3", + "has-property-descriptors": "^1.0.2" }, "engines": { - "node": ">=0.10.0" + "node": ">= 0.4" } }, - "node_modules/set-value/node_modules/is-extendable": { - "version": "0.1.1", - "resolved": "https://registry.npmjs.org/is-extendable/-/is-extendable-0.1.1.tgz", - "integrity": "sha512-5BMULNob1vgFX6EjQw5izWDxrecWK9AM72rugNr0TFldMOi0fj6Jk+zeKIt0xGj4cEfQIJth4w3OKWOJ4f+AFw==", - "dev": true, + "node_modules/set-proto": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/set-proto/-/set-proto-1.0.0.tgz", + "integrity": "sha512-RJRdvCo6IAnPdsvP/7m6bsQqNnn1FCBX5ZNtFL98MmFF/4xAIJTIg1YbHW5DC2W5SKZanrC6i4HsJqlajw/dZw==", "license": "MIT", + "dependencies": { + "dunder-proto": "^1.0.1", + "es-errors": "^1.3.0", + "es-object-atoms": "^1.0.0" + }, "engines": { - "node": ">=0.10.0" + "node": ">= 0.4" } }, "node_modules/setimmediate": { @@ -18054,6 +15307,7 @@ "version": "2.0.0", "resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-2.0.0.tgz", "integrity": "sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA==", + "dev": true, "license": "MIT", "dependencies": { "shebang-regex": "^3.0.0" @@ -18066,6 +15320,7 @@ "version": "3.0.0", "resolved": "https://registry.npmjs.org/shebang-regex/-/shebang-regex-3.0.0.tgz", "integrity": "sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==", + "dev": true, "license": "MIT", "engines": { "node": ">=8" @@ -18224,344 +15479,70 @@ "node": ">=0.10.0" } }, - "node_modules/smart-buffer": { - "version": "4.2.0", - "resolved": "https://registry.npmjs.org/smart-buffer/-/smart-buffer-4.2.0.tgz", - "integrity": "sha512-94hK0Hh8rPqQl2xXc3HsaBoOXKV20MToPkcXvwbISWLEs+64sBq5kFgn2kJDHb1Pry9yrP0dxrCI9RRci7RXKg==", - "license": "MIT", - "engines": { - "node": ">= 6.0.0", - "npm": ">= 3.0.0" - } - }, - "node_modules/snapdragon": { - "version": "0.8.2", - "resolved": "https://registry.npmjs.org/snapdragon/-/snapdragon-0.8.2.tgz", - "integrity": "sha512-FtyOnWN/wCHTVXOMwvSv26d+ko5vWlIDD6zoUJ7LW8vh+ZBC8QdljveRP+crNrtBwioEUWy/4dMtbBjA4ioNlg==", - "dev": true, - "license": "MIT", - "dependencies": { - "base": "^0.11.1", - "debug": "^2.2.0", - "define-property": "^0.2.5", - "extend-shallow": "^2.0.1", - "map-cache": "^0.2.2", - "source-map": "^0.5.6", - "source-map-resolve": "^0.5.0", - "use": "^3.1.0" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/snapdragon-node": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/snapdragon-node/-/snapdragon-node-2.1.1.tgz", - "integrity": "sha512-O27l4xaMYt/RSQ5TR3vpWCAB5Kb/czIcqUFOM/C4fYcLnbZUc1PkjTAMjof2pBWaSTwOUd6qUHcFGVGj7aIwnw==", - "dev": true, - "license": "MIT", - "dependencies": { - "define-property": "^1.0.0", - "isobject": "^3.0.0", - "snapdragon-util": "^3.0.1" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/snapdragon-node/node_modules/define-property": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/define-property/-/define-property-1.0.0.tgz", - "integrity": "sha512-cZTYKFWspt9jZsMscWo8sc/5lbPC9Q0N5nBLgb+Yd915iL3udB1uFgS3B8YCx66UVHq018DAVFoee7x+gxggeA==", - "dev": true, - "license": "MIT", - "dependencies": { - "is-descriptor": "^1.0.0" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/snapdragon-util": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/snapdragon-util/-/snapdragon-util-3.0.1.tgz", - "integrity": "sha512-mbKkMdQKsjX4BAL4bRYTj21edOf8cN7XHdYUJEe+Zn99hVEYcMvKPct1IqNe7+AZPirn8BCDOQBHQZknqmKlZQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "kind-of": "^3.2.0" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/snapdragon-util/node_modules/kind-of": { - "version": "3.2.2", - "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-3.2.2.tgz", - "integrity": "sha512-NOW9QQXMoZGg/oqnVNoNTTIFEIid1627WCffUBJEdMxYApq7mNE7CpzucIPc+ZQg25Phej7IJSmX3hO+oblOtQ==", + "node_modules/socket.io": { + "version": "4.8.3", + "resolved": "https://registry.npmjs.org/socket.io/-/socket.io-4.8.3.tgz", + "integrity": "sha512-2Dd78bqzzjE6KPkD5fHZmDAKRNe3J15q+YHDrIsy9WEkqttc7GY+kT9OBLSMaPbQaEd0x1BjcmtMtXkfpc+T5A==", "dev": true, "license": "MIT", "dependencies": { - "is-buffer": "^1.1.5" + "accepts": "~1.3.4", + "base64id": "~2.0.0", + "cors": "~2.8.5", + "debug": "~4.4.1", + "engine.io": "~6.6.0", + "socket.io-adapter": "~2.5.2", + "socket.io-parser": "~4.2.4" }, "engines": { - "node": ">=0.10.0" + "node": ">=10.2.0" } }, - "node_modules/snapdragon/node_modules/debug": { - "version": "2.6.9", - "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", - "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", + "node_modules/socket.io-adapter": { + "version": "2.5.6", + "resolved": "https://registry.npmjs.org/socket.io-adapter/-/socket.io-adapter-2.5.6.tgz", + "integrity": "sha512-DkkO/dz7MGln0dHn5bmN3pPy+JmywNICWrJqVWiVOyvXjWQFIv9c2h24JrQLLFJ2aQVQf/Cvl1vblnd4r2apLQ==", "dev": true, "license": "MIT", "dependencies": { - "ms": "2.0.0" + "debug": "~4.4.1", + "ws": "~8.18.3" } }, - "node_modules/snapdragon/node_modules/define-property": { - "version": "0.2.5", - "resolved": "https://registry.npmjs.org/define-property/-/define-property-0.2.5.tgz", - "integrity": "sha512-Rr7ADjQZenceVOAKop6ALkkRAmH1A4Gx9hV/7ZujPUN2rkATqFO0JZLZInbAjpZYoJ1gUx8MRMQVkYemcbMSTA==", + "node_modules/socket.io-adapter/node_modules/ws": { + "version": "8.18.3", + "resolved": "https://registry.npmjs.org/ws/-/ws-8.18.3.tgz", + "integrity": "sha512-PEIGCY5tSlUt50cqyMXfCzX+oOPqN0vuGqWzbcJ2xvnkzkq46oOpz7dQaTDBdfICb4N14+GARUDw2XV2N4tvzg==", "dev": true, "license": "MIT", - "dependencies": { - "is-descriptor": "^0.1.0" - }, "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/snapdragon/node_modules/extend-shallow": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/extend-shallow/-/extend-shallow-2.0.1.tgz", - "integrity": "sha512-zCnTtlxNoAiDc3gqY2aYAWFx7XWWiasuF2K8Me5WbN8otHKTUKBwjPtNpRs/rbUZm7KxWAaNj7P1a/p52GbVug==", - "dev": true, - "license": "MIT", - "dependencies": { - "is-extendable": "^0.1.0" + "node": ">=10.0.0" }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/snapdragon/node_modules/is-descriptor": { - "version": "0.1.7", - "resolved": "https://registry.npmjs.org/is-descriptor/-/is-descriptor-0.1.7.tgz", - "integrity": "sha512-C3grZTvObeN1xud4cRWl366OMXZTj0+HGyk4hvfpx4ZHt1Pb60ANSXqCK7pdOTeUQpRzECBSTphqvD7U+l22Eg==", - "dev": true, - "license": "MIT", - "dependencies": { - "is-accessor-descriptor": "^1.0.1", - "is-data-descriptor": "^1.0.1" + "peerDependencies": { + "bufferutil": "^4.0.1", + "utf-8-validate": ">=5.0.2" }, - "engines": { - "node": ">= 0.4" - } - }, - "node_modules/snapdragon/node_modules/is-extendable": { - "version": "0.1.1", - "resolved": "https://registry.npmjs.org/is-extendable/-/is-extendable-0.1.1.tgz", - "integrity": "sha512-5BMULNob1vgFX6EjQw5izWDxrecWK9AM72rugNr0TFldMOi0fj6Jk+zeKIt0xGj4cEfQIJth4w3OKWOJ4f+AFw==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/snapdragon/node_modules/ms": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", - "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==", - "dev": true, - "license": "MIT" - }, - "node_modules/socket.io": { - "version": "1.7.4", - "resolved": "https://registry.npmjs.org/socket.io/-/socket.io-1.7.4.tgz", - "integrity": "sha512-rKMY/U7gBmbHjwrljcPHy+uEXZ5973WvO2DrooL643w1R24SZVzsmhvNmJFjYVhAL4y7wrZJJS/znUfp0VWfKw==", - "dev": true, - "license": "MIT", - "dependencies": { - "debug": "2.3.3", - "engine.io": "~1.8.4", - "has-binary": "0.1.7", - "object-assign": "4.1.0", - "socket.io-adapter": "0.5.0", - "socket.io-client": "1.7.4", - "socket.io-parser": "2.3.1" - } - }, - "node_modules/socket.io-adapter": { - "version": "0.5.0", - "resolved": "https://registry.npmjs.org/socket.io-adapter/-/socket.io-adapter-0.5.0.tgz", - "integrity": "sha512-zmYvlFJay9skt4yk1MffE9p93HKvQtyy0BLZ5dRM73bOXFJXNZWq8qZVdY456sLaxdK6fHGiZ7glxzqvzwGzkw==", - "dev": true, - "license": "MIT", - "dependencies": { - "debug": "2.3.3", - "socket.io-parser": "2.3.1" - } - }, - "node_modules/socket.io-adapter/node_modules/debug": { - "version": "2.3.3", - "resolved": "https://registry.npmjs.org/debug/-/debug-2.3.3.tgz", - "integrity": "sha512-dCHp4G+F11zb+RtEu7BE2U8R32AYmM/4bljQfut8LipH3PdwsVBVGh083MXvtKkB7HSQUzSwiXz53c4mzJvYfw==", - "dev": true, - "license": "MIT", - "dependencies": { - "ms": "0.7.2" - } - }, - "node_modules/socket.io-adapter/node_modules/ms": { - "version": "0.7.2", - "resolved": "https://registry.npmjs.org/ms/-/ms-0.7.2.tgz", - "integrity": "sha512-5NnE67nQSQDJHVahPJna1PQ/zCXMnQop3yUCxjKPNzCxuyPSKWTQ/5Gu5CZmjetwGLWRA+PzeF5thlbOdbQldA==", - "dev": true, - "license": "MIT" - }, - "node_modules/socket.io-client": { - "version": "1.7.4", - "resolved": "https://registry.npmjs.org/socket.io-client/-/socket.io-client-1.7.4.tgz", - "integrity": "sha512-vW9xr9XyTJejFS//7GNZmLTLkUSAcvOSxRXXhrojV+7wboTFB8CuvK1UBCW3NiB2kqyi0h9cTeyD7dXjdUd9jQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "backo2": "1.0.2", - "component-bind": "1.0.0", - "component-emitter": "1.2.1", - "debug": "2.3.3", - "engine.io-client": "~1.8.4", - "has-binary": "0.1.7", - "indexof": "0.0.1", - "object-component": "0.0.3", - "parseuri": "0.0.5", - "socket.io-parser": "2.3.1", - "to-array": "0.1.4" - } - }, - "node_modules/socket.io-client/node_modules/debug": { - "version": "2.3.3", - "resolved": "https://registry.npmjs.org/debug/-/debug-2.3.3.tgz", - "integrity": "sha512-dCHp4G+F11zb+RtEu7BE2U8R32AYmM/4bljQfut8LipH3PdwsVBVGh083MXvtKkB7HSQUzSwiXz53c4mzJvYfw==", - "dev": true, - "license": "MIT", - "dependencies": { - "ms": "0.7.2" + "peerDependenciesMeta": { + "bufferutil": { + "optional": true + }, + "utf-8-validate": { + "optional": true + } } }, - "node_modules/socket.io-client/node_modules/ms": { - "version": "0.7.2", - "resolved": "https://registry.npmjs.org/ms/-/ms-0.7.2.tgz", - "integrity": "sha512-5NnE67nQSQDJHVahPJna1PQ/zCXMnQop3yUCxjKPNzCxuyPSKWTQ/5Gu5CZmjetwGLWRA+PzeF5thlbOdbQldA==", - "dev": true, - "license": "MIT" - }, "node_modules/socket.io-parser": { - "version": "2.3.1", - "resolved": "https://registry.npmjs.org/socket.io-parser/-/socket.io-parser-2.3.1.tgz", - "integrity": "sha512-j6l4g/+yWQjmy1yByzg1DPFL4vxQw+NwCJatIxni/AE1wfm17FBtIKSWU4Ay+onrJwDxmC4eK4QS/04ZsqYwZQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "component-emitter": "1.1.2", - "debug": "2.2.0", - "isarray": "0.0.1", - "json3": "3.3.2" - } - }, - "node_modules/socket.io-parser/node_modules/component-emitter": { - "version": "1.1.2", - "resolved": "https://registry.npmjs.org/component-emitter/-/component-emitter-1.1.2.tgz", - "integrity": "sha512-YhIbp3PJiznERfjlIkK0ue4obZxt2S60+0W8z24ZymOHT8sHloOqWOqZRU2eN5OlY8U08VFsP02letcu26FilA==", - "dev": true - }, - "node_modules/socket.io-parser/node_modules/debug": { - "version": "2.2.0", - "resolved": "https://registry.npmjs.org/debug/-/debug-2.2.0.tgz", - "integrity": "sha512-X0rGvJcskG1c3TgSCPqHJ0XJgwlcvOC7elJ5Y0hYuKBZoVqWpAMfLOeIh2UI/DCQ5ruodIjvsugZtjUYUw2pUw==", - "dev": true, - "license": "MIT", - "dependencies": { - "ms": "0.7.1" - } - }, - "node_modules/socket.io-parser/node_modules/ms": { - "version": "0.7.1", - "resolved": "https://registry.npmjs.org/ms/-/ms-0.7.1.tgz", - "integrity": "sha512-lRLiIR9fSNpnP6TC4v8+4OU7oStC01esuNowdQ34L+Gk8e5Puoc88IqJ+XAY/B3Mn2ZKis8l8HX90oU8ivzUHg==", - "dev": true - }, - "node_modules/socket.io/node_modules/debug": { - "version": "2.3.3", - "resolved": "https://registry.npmjs.org/debug/-/debug-2.3.3.tgz", - "integrity": "sha512-dCHp4G+F11zb+RtEu7BE2U8R32AYmM/4bljQfut8LipH3PdwsVBVGh083MXvtKkB7HSQUzSwiXz53c4mzJvYfw==", - "dev": true, - "license": "MIT", - "dependencies": { - "ms": "0.7.2" - } - }, - "node_modules/socket.io/node_modules/ms": { - "version": "0.7.2", - "resolved": "https://registry.npmjs.org/ms/-/ms-0.7.2.tgz", - "integrity": "sha512-5NnE67nQSQDJHVahPJna1PQ/zCXMnQop3yUCxjKPNzCxuyPSKWTQ/5Gu5CZmjetwGLWRA+PzeF5thlbOdbQldA==", - "dev": true, - "license": "MIT" - }, - "node_modules/socket.io/node_modules/object-assign": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/object-assign/-/object-assign-4.1.0.tgz", - "integrity": "sha512-Lbc7GfN7XFaK30bzUN3cDYLOkT0dH05S0ax1QikylHUD9+Z9PRF3G1iYwX3kcz+6AlzTFGkUgMxz6l3aUwbwTA==", + "version": "4.2.5", + "resolved": "https://registry.npmjs.org/socket.io-parser/-/socket.io-parser-4.2.5.tgz", + "integrity": "sha512-bPMmpy/5WWKHea5Y/jYAP6k74A+hvmRCQaJuJB6I/ML5JZq/KfNieUVo/3Mh7SAqn7TyFdIo6wqYHInG1MU1bQ==", "dev": true, "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/socks": { - "version": "2.8.7", - "resolved": "https://registry.npmjs.org/socks/-/socks-2.8.7.tgz", - "integrity": "sha512-HLpt+uLy/pxB+bum/9DzAgiKS8CX1EvbWxI4zlmgGCExImLdiad2iCwXT5Z4c9c3Eq8rP2318mPW2c+QbtjK8A==", - "license": "MIT", "dependencies": { - "ip-address": "^10.0.1", - "smart-buffer": "^4.2.0" + "@socket.io/component-emitter": "~3.1.0", + "debug": "~4.4.1" }, "engines": { - "node": ">= 10.0.0", - "npm": ">= 3.0.0" - } - }, - "node_modules/socks-proxy-agent": { - "version": "8.0.5", - "resolved": "https://registry.npmjs.org/socks-proxy-agent/-/socks-proxy-agent-8.0.5.tgz", - "integrity": "sha512-HehCEsotFqbPW9sJ8WVYB6UbmIMv7kUUORIF2Nncq4VQvBfNBLibW9YZR5dlYCSUhwcD628pRllm7n+E+YTzJw==", - "license": "MIT", - "dependencies": { - "agent-base": "^7.1.2", - "debug": "^4.3.4", - "socks": "^2.8.3" - }, - "engines": { - "node": ">= 14" - } - }, - "node_modules/socks-proxy-agent/node_modules/agent-base": { - "version": "7.1.4", - "resolved": "https://registry.npmjs.org/agent-base/-/agent-base-7.1.4.tgz", - "integrity": "sha512-MnA+YT8fwfJPgBx3m60MNqakm30XOkyIoH1y6huTQvC0PwZG7ki8NacLBcrPbNoo8vEZy7Jpuk7+jMO+CUovTQ==", - "license": "MIT", - "engines": { - "node": ">= 14" - } - }, - "node_modules/source-map": { - "version": "0.5.7", - "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.5.7.tgz", - "integrity": "sha512-LbrmJOMUSdEVxIKvdcJzQC+nQhe8FUZQTXQy6+I75skNgn3OoQ0DZA8YnFa7gp8tqtL3KPf1kmo0R5DoApeSGQ==", - "license": "BSD-3-Clause", - "engines": { - "node": ">=0.10.0" + "node": ">=10.0.0" } }, "node_modules/source-map-js": { @@ -18573,21 +15554,6 @@ "node": ">=0.10.0" } }, - "node_modules/source-map-resolve": { - "version": "0.5.3", - "resolved": "https://registry.npmjs.org/source-map-resolve/-/source-map-resolve-0.5.3.tgz", - "integrity": "sha512-Htz+RnsXWk5+P2slx5Jh3Q66vhQj1Cllm0zvnaY98+NFx+Dv2CF/f5O/t8x+KaNdrdIAsruNzoh/KpialbqAnw==", - "deprecated": "See https://github.com/lydell/source-map-resolve#deprecated", - "dev": true, - "license": "MIT", - "dependencies": { - "atob": "^2.1.2", - "decode-uri-component": "^0.2.0", - "resolve-url": "^0.2.1", - "source-map-url": "^0.4.0", - "urix": "^0.1.0" - } - }, "node_modules/source-map-support": { "version": "0.5.13", "resolved": "https://registry.npmjs.org/source-map-support/-/source-map-support-0.5.13.tgz", @@ -18609,14 +15575,6 @@ "node": ">=0.10.0" } }, - "node_modules/source-map-url": { - "version": "0.4.1", - "resolved": "https://registry.npmjs.org/source-map-url/-/source-map-url-0.4.1.tgz", - "integrity": "sha512-cPiFOTLUKvJFIg4SKVScy4ilPPW6rFgMgfuZJPNoDuMs3nC1HbMUycBoJw77xFIp6z1UJQJOfx6C9GMH80DiTw==", - "deprecated": "See https://github.com/lydell/source-map-url#deprecated", - "dev": true, - "license": "MIT" - }, "node_modules/spdx-correct": { "version": "3.2.0", "resolved": "https://registry.npmjs.org/spdx-correct/-/spdx-correct-3.2.0.tgz", @@ -18653,19 +15611,6 @@ "dev": true, "license": "CC0-1.0" }, - "node_modules/split-string": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/split-string/-/split-string-3.1.0.tgz", - "integrity": "sha512-NzNVhJDYpwceVVii8/Hu6DKfD2G+NrQHlS/V/qgv763EYudVwEcMQNxd2lh+0VrUByXN/oJkl5grOhYWvQUYiw==", - "dev": true, - "license": "MIT", - "dependencies": { - "extend-shallow": "^3.0.0" - }, - "engines": { - "node": ">=0.10.0" - } - }, "node_modules/sprintf-js": { "version": "1.0.3", "resolved": "https://registry.npmjs.org/sprintf-js/-/sprintf-js-1.0.3.tgz", @@ -18679,78 +15624,25 @@ "integrity": "sha512-543P1IPQUUb7ty3hVruyOwpZWrkF8jUvNwJfxnqBxWDb6i+cbEcdQJWvQQnAm48nMcVdgVey/5xvRtbimN7ZWA==", "dev": true }, - "node_modules/ssri": { - "version": "12.0.0", - "resolved": "https://registry.npmjs.org/ssri/-/ssri-12.0.0.tgz", - "integrity": "sha512-S7iGNosepx9RadX82oimUkvr0Ct7IjJbEbs4mJcTxst8um95J3sDYU1RBEOvdu6oL1Wek2ODI5i4MAw+dZ6cAQ==", - "license": "ISC", - "dependencies": { - "minipass": "^7.0.3" - }, - "engines": { - "node": "^18.17.0 || >=20.5.0" - } - }, "node_modules/stack-utils": { "version": "2.0.6", "resolved": "https://registry.npmjs.org/stack-utils/-/stack-utils-2.0.6.tgz", "integrity": "sha512-XlkWvfIm6RmsWtNJx+uqtKLS8eqFbxUg0ZzLXqY0caEy9l7hruX8IpiDnjsLavoBgqCCR71TqWO8MaXYheJ3RQ==", "license": "MIT", "dependencies": { - "escape-string-regexp": "^2.0.0" - }, - "engines": { - "node": ">=10" - } - }, - "node_modules/stack-utils/node_modules/escape-string-regexp": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-2.0.0.tgz", - "integrity": "sha512-UpzcLCXolUWcNu5HtVMHYdXJjArjsF9C0aNnquZYY4uW/Vu0miy5YoWvbV345HauVvcAUnpRuhMMcqTcGOY2+w==", - "license": "MIT", - "engines": { - "node": ">=8" - } - }, - "node_modules/static-extend": { - "version": "0.1.2", - "resolved": "https://registry.npmjs.org/static-extend/-/static-extend-0.1.2.tgz", - "integrity": "sha512-72E9+uLc27Mt718pMHt9VMNiAL4LMsmDbBva8mxWUCkT07fSzEGMYUCk0XWY6lp0j6RBAG4cJ3mWuZv2OE3s0g==", - "dev": true, - "license": "MIT", - "dependencies": { - "define-property": "^0.2.5", - "object-copy": "^0.1.0" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/static-extend/node_modules/define-property": { - "version": "0.2.5", - "resolved": "https://registry.npmjs.org/define-property/-/define-property-0.2.5.tgz", - "integrity": "sha512-Rr7ADjQZenceVOAKop6ALkkRAmH1A4Gx9hV/7ZujPUN2rkATqFO0JZLZInbAjpZYoJ1gUx8MRMQVkYemcbMSTA==", - "dev": true, - "license": "MIT", - "dependencies": { - "is-descriptor": "^0.1.0" + "escape-string-regexp": "^2.0.0" }, "engines": { - "node": ">=0.10.0" + "node": ">=10" } }, - "node_modules/static-extend/node_modules/is-descriptor": { - "version": "0.1.7", - "resolved": "https://registry.npmjs.org/is-descriptor/-/is-descriptor-0.1.7.tgz", - "integrity": "sha512-C3grZTvObeN1xud4cRWl366OMXZTj0+HGyk4hvfpx4ZHt1Pb60ANSXqCK7pdOTeUQpRzECBSTphqvD7U+l22Eg==", - "dev": true, + "node_modules/stack-utils/node_modules/escape-string-regexp": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-2.0.0.tgz", + "integrity": "sha512-UpzcLCXolUWcNu5HtVMHYdXJjArjsF9C0aNnquZYY4uW/Vu0miy5YoWvbV345HauVvcAUnpRuhMMcqTcGOY2+w==", "license": "MIT", - "dependencies": { - "is-accessor-descriptor": "^1.0.1", - "is-data-descriptor": "^1.0.1" - }, "engines": { - "node": ">= 0.4" + "node": ">=8" } }, "node_modules/statuses": { @@ -18776,6 +15668,56 @@ "node": ">= 0.4" } }, + "node_modules/streamroller": { + "version": "3.1.5", + "resolved": "https://registry.npmjs.org/streamroller/-/streamroller-3.1.5.tgz", + "integrity": "sha512-KFxaM7XT+irxvdqSP1LGLgNWbYN7ay5owZ3r/8t77p+EtSUAfUgtl7be3xtqtOmGUl9K9YPO2ca8133RlTjvKw==", + "dev": true, + "license": "MIT", + "dependencies": { + "date-format": "^4.0.14", + "debug": "^4.3.4", + "fs-extra": "^8.1.0" + }, + "engines": { + "node": ">=8.0" + } + }, + "node_modules/streamroller/node_modules/fs-extra": { + "version": "8.1.0", + "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-8.1.0.tgz", + "integrity": "sha512-yhlQgA6mnOJUKOsRUFsgJdQCvkKhcz8tlZG5HBQfReYZy46OwLcY+Zia0mtdHsOo9y/hP+CxMN0TU9QxoOtG4g==", + "dev": true, + "license": "MIT", + "dependencies": { + "graceful-fs": "^4.2.0", + "jsonfile": "^4.0.0", + "universalify": "^0.1.0" + }, + "engines": { + "node": ">=6 <7 || >=8" + } + }, + "node_modules/streamroller/node_modules/jsonfile": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-4.0.0.tgz", + "integrity": "sha512-m6F1R3z8jjlf2imQHS2Qez5sjKWQzbuuhuJ/FKYFRZvPE3PuHcSMVZzfsLhGVOkfd20obL5SWEBew5ShlquNxg==", + "dev": true, + "license": "MIT", + "optionalDependencies": { + "graceful-fs": "^4.1.6" + } + }, + "node_modules/streamroller/node_modules/universalify": { + "version": "0.1.2", + "resolved": "https://registry.npmjs.org/universalify/-/universalify-0.1.2.tgz", + "integrity": "sha512-rBJeI5CXAlmy1pV+617WB9J63U6XcazHHF2f2dbJix4XzpUF0RS3Zbj0FGIOCAva5P/d/GBOYaACQ1w+0azUkg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 4.0.0" + } + }, "node_modules/strict-uri-encode": { "version": "1.1.0", "resolved": "https://registry.npmjs.org/strict-uri-encode/-/strict-uri-encode-1.1.0.tgz", @@ -18786,11 +15728,13 @@ } }, "node_modules/string_decoder": { - "version": "0.10.31", - "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-0.10.31.tgz", - "integrity": "sha512-ev2QzSzWPYmy9GuqfIVildA4OdcGLeFZQrq5ys6RtiuF+RQQiZWr8TZNyAcuVXyQRYfEO+MsoB/1BuQVhOJuoQ==", - "dev": true, - "license": "MIT" + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.1.1.tgz", + "integrity": "sha512-n/ShnvDi6FHbbVfviro+WojiFzv+s8MPMHBczVePfUpDJLwoLT0ht1l4YwBCbi8pJAveEEdnkHyPyTP/mzRfwg==", + "license": "MIT", + "dependencies": { + "safe-buffer": "~5.1.0" + } }, "node_modules/string-convert": { "version": "0.2.1", @@ -18829,32 +15773,31 @@ } }, "node_modules/string-width": { - "version": "4.2.3", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", - "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-1.0.2.tgz", + "integrity": "sha512-0XsVpQLnVCXHJfyEs8tC0zpTVIr5PKKsQtkT29IwupnPTjtPmQ3xT/4yCREF9hYkV/3M3kzcUTSAZT6a6h81tw==", + "dev": true, "license": "MIT", "dependencies": { - "emoji-regex": "^8.0.0", - "is-fullwidth-code-point": "^3.0.0", - "strip-ansi": "^6.0.1" + "code-point-at": "^1.0.0", + "is-fullwidth-code-point": "^1.0.0", + "strip-ansi": "^3.0.0" }, "engines": { - "node": ">=8" + "node": ">=0.10.0" } }, - "node_modules/string-width-cjs": { - "name": "string-width", - "version": "4.2.3", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", - "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", + "node_modules/string-width/node_modules/strip-ansi": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-3.0.1.tgz", + "integrity": "sha512-VhumSSbBqDTP8p2ZLKj40UjBCV4+v8bUSEpUb4KjRgWk9pbqGF4REFj6KEagidb2f/M6AzC0EmFyDNGaw9OCzg==", + "dev": true, "license": "MIT", "dependencies": { - "emoji-regex": "^8.0.0", - "is-fullwidth-code-point": "^3.0.0", - "strip-ansi": "^6.0.1" + "ansi-regex": "^2.0.0" }, "engines": { - "node": ">=8" + "node": ">=0.10.0" } }, "node_modules/string.prototype.trim": { @@ -18917,6 +15860,7 @@ "version": "6.0.1", "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz", "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==", + "dev": true, "license": "MIT", "dependencies": { "ansi-regex": "^5.0.1" @@ -18925,15 +15869,12 @@ "node": ">=8" } }, - "node_modules/strip-ansi-cjs": { - "name": "strip-ansi", - "version": "6.0.1", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz", - "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==", + "node_modules/strip-ansi/node_modules/ansi-regex": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz", + "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==", + "dev": true, "license": "MIT", - "dependencies": { - "ansi-regex": "^5.0.1" - }, "engines": { "node": ">=8" } @@ -19006,9 +15947,9 @@ "license": "ISC" }, "node_modules/stylelint": { - "version": "17.0.0", - "resolved": "https://registry.npmjs.org/stylelint/-/stylelint-17.0.0.tgz", - "integrity": "sha512-saMZ2mqdQre4AfouxcbTdpVglDRcROb4MIucKHvgsDb/0IX7ODhcaz+EOIyfxAsm8Zjl/7j4hJj6MgIYYM8Xwg==", + "version": "17.1.0", + "resolved": "https://registry.npmjs.org/stylelint/-/stylelint-17.1.0.tgz", + "integrity": "sha512-+cUX1FxkkbLX5qJRAPapUv/+v+YU3pGbWu+pHVqTXpiY0mYh3Dxfxa0bLBtVtYgOC8hIWIyX2H/3Y3LWlAevDg==", "dev": true, "funding": [ { @@ -19021,6 +15962,7 @@ } ], "license": "MIT", + "peer": true, "dependencies": { "@csstools/css-parser-algorithms": "^4.0.0", "@csstools/css-syntax-patches-for-csstree": "^1.0.25", @@ -19036,7 +15978,7 @@ "debug": "^4.4.3", "fast-glob": "^3.3.3", "fastest-levenshtein": "^1.0.16", - "file-entry-cache": "^11.1.1", + "file-entry-cache": "^11.1.2", "global-modules": "^2.0.0", "globby": "^16.1.0", "globjoin": "^0.1.4", @@ -19135,36 +16077,6 @@ "dev": true, "license": "MIT" }, - "node_modules/stylelint-formatter-pretty/node_modules/is-unicode-supported": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/is-unicode-supported/-/is-unicode-supported-2.1.0.tgz", - "integrity": "sha512-mE00Gnza5EEB3Ds0HfMyllZzbBrmLOX3vfWoj9A9PEnTfratQ/BcaJOuMhnkhjXvb2+FkY3VuHqtAGpTPmglFQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=18" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/stylelint-formatter-pretty/node_modules/log-symbols": { - "version": "7.0.1", - "resolved": "https://registry.npmjs.org/log-symbols/-/log-symbols-7.0.1.tgz", - "integrity": "sha512-ja1E3yCr9i/0hmBVaM0bfwDjnGy8I/s6PP4DFp+yP+a+mrHO4Rm7DtmnqROTUkHIkqffC84YY7AeqX6oFk0WFg==", - "dev": true, - "license": "MIT", - "dependencies": { - "is-unicode-supported": "^2.0.0", - "yoctocolors": "^2.1.1" - }, - "engines": { - "node": ">=18" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, "node_modules/stylelint-formatter-pretty/node_modules/string-width": { "version": "7.2.0", "resolved": "https://registry.npmjs.org/string-width/-/string-width-7.2.0.tgz", @@ -19222,6 +16134,7 @@ "integrity": "sha512-Bq3SmSpyFHaWjPk8If9yc6svM8c56dB5BAtW4Qbw5jHTwwXXcTLoRMkpDJp6VL0XzlWaCHTXrkFURMYmD0sLqg==", "dev": true, "license": "MIT", + "peer": true, "engines": { "node": ">=12" }, @@ -19235,6 +16148,7 @@ "integrity": "sha512-vjtV3hiLqYDNRoiAv0zC4QaGAMPomEoq83PRmYIofPswwZurCeWR5LByXm7SyoL0Zh5+2z0+HC7jG8gSZJUh0w==", "dev": true, "license": "MIT", + "peer": true, "engines": { "node": ">= 16" } @@ -19245,6 +16159,7 @@ "integrity": "sha512-N2WFfK12gmrK1c1GXOqiAJ1tc5YE+R53zvQ+t5P8S5XhnmKYVB5eZEiLNZKDSmoG8wqqbF9EXYBBW/nef19log==", "dev": true, "license": "MIT", + "peer": true, "dependencies": { "flat-cache": "^6.1.20" } @@ -19255,6 +16170,7 @@ "integrity": "sha512-AhHYqwvN62NVLp4lObVXGVluiABTHapoB57EyegZVmazN+hhGhLTn3uZbOofoTw4DSDvVCadzzyChXhOAvy8uQ==", "dev": true, "license": "MIT", + "peer": true, "dependencies": { "cacheable": "^2.3.2", "flatted": "^3.3.3", @@ -19267,16 +16183,29 @@ "integrity": "sha512-Hs59xBNfUIunMFgWAbGX5cq6893IbWg4KnrjbYwX3tx0ztorVgTDA6B2sxf8ejHJ4wz8BqGUMYlnzNBer5NvGg==", "dev": true, "license": "MIT", + "peer": true, "engines": { "node": ">= 4" } }, + "node_modules/stylelint/node_modules/is-fullwidth-code-point": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz", + "integrity": "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==", + "dev": true, + "license": "MIT", + "peer": true, + "engines": { + "node": ">=8" + } + }, "node_modules/stylelint/node_modules/is-plain-object": { "version": "5.0.0", "resolved": "https://registry.npmjs.org/is-plain-object/-/is-plain-object-5.0.0.tgz", "integrity": "sha512-VRSzKkbMm5jMDoKLbltAkFQ5Qr7VDiTFGXxYFXXowVj387GeGNOCsOH6Msy00SGZ3Fp84b1Naa1psqgcCIEP5Q==", "dev": true, "license": "MIT", + "peer": true, "engines": { "node": ">=0.10.0" } @@ -19287,6 +16216,7 @@ "integrity": "sha512-bzyZ1e88w9O1iNJbKnOlvYTrWPDl46O1bG0D3XInv+9tkPrxrN8jUUTiFlDkkmKWgn1M6CfIA13SuGqOa9Korw==", "dev": true, "license": "ISC", + "peer": true, "engines": { "node": ">=14" }, @@ -19300,6 +16230,7 @@ "integrity": "sha512-qMCMfhY040cVHT43K9BFygqYbUPFZKHOg7K73mtTWJRb8pyP3fzf4Ixd5SzdEJQ6MRUg/WBnOLxghZtKKurENQ==", "dev": true, "license": "MIT", + "peer": true, "dependencies": { "ansi-styles": "^4.0.0", "astral-regex": "^2.0.0", @@ -19318,6 +16249,7 @@ "integrity": "sha512-KpqHIdDL9KwYk22wEOg/VIqYbrnLeSApsKT/bSj6Ez7pn3CftUiLAv2Lccpq1ALcpLV9UX1Ppn92npZWu2w/aw==", "dev": true, "license": "MIT", + "peer": true, "dependencies": { "get-east-asian-width": "^1.3.0", "strip-ansi": "^7.1.0" @@ -19335,6 +16267,7 @@ "integrity": "sha512-gmBGslpoQJtgnMAvOVqGZpEz9dyoKTCzy2nfz/n8aIFhN/jCE/rCmcxabB6jOOHV+0WNnylOxaxBQPSvcWklhA==", "dev": true, "license": "MIT", + "peer": true, "dependencies": { "ansi-regex": "^6.0.1" }, @@ -19351,6 +16284,7 @@ "integrity": "sha512-9kY+CygyYM6j02t5YFHbNz2FN5QmYGv9zAjVp4lCDjlCw7amdckXlEt/bjMhUIfj4ThGRE4gCUH5+yGnNuPo5A==", "dev": true, "license": "BSD-3-Clause", + "peer": true, "dependencies": { "ajv": "^8.0.1", "lodash.truncate": "^4.4.2", @@ -19368,6 +16302,7 @@ "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", "dev": true, "license": "MIT", + "peer": true, "dependencies": { "emoji-regex": "^8.0.0", "is-fullwidth-code-point": "^3.0.0", @@ -19383,6 +16318,7 @@ "integrity": "sha512-YnlPC6JqnZl6aO4uRc+dx5PHguiR9S6WeoLtpxNT9wIG+BDya7ZNE1q7KOjVgaA73hKhKLpVPgJ5QA9THQ5BRg==", "dev": true, "license": "ISC", + "peer": true, "dependencies": { "imurmurhash": "^0.1.4", "signal-exit": "^4.0.1" @@ -19409,6 +16345,7 @@ "integrity": "sha512-UKbpT93hN5Nr9go5UY7bopIB9YQlMz9nm/ct4IXt/irb5YRkn9WaqrOBJGZ5Pwvsd5FQzSVeYlGdXoCAPQZrPg==", "dev": true, "license": "MIT", + "peer": true, "dependencies": { "has-flag": "^5.0.1", "supports-color": "^10.2.2" @@ -19426,6 +16363,7 @@ "integrity": "sha512-CsNUt5x9LUdx6hnk/E2SZLsDyvfqANZSUq4+D3D8RzDJ2M+HDTIkF60ibS1vHaK55vzgiZw1bEPFG9yH7l33wA==", "dev": true, "license": "MIT", + "peer": true, "engines": { "node": ">=12" }, @@ -19439,6 +16377,7 @@ "integrity": "sha512-SS+jx45GF1QjgEXQx4NJZV9ImqmO2NPz5FNsIHrsDjh2YsHnawpan7SNQ1o8NuhrbHZy9AZhIoCUiCeaW/C80g==", "dev": true, "license": "MIT", + "peer": true, "engines": { "node": ">=18" }, @@ -19517,7 +16456,6 @@ "integrity": "sha512-I/bSHSNEcFFqXLf91nchoNB9D1Kie3QKcWdchYUaoIg1+1bdWDkdfdlvdIOJbi9U8xR0y+MWc5D+won9v95WlQ==", "dev": true, "license": "MIT", - "peer": true, "dependencies": { "co": "^4.6.0", "json-stable-stringify": "^1.0.1" @@ -19533,16 +16471,6 @@ "ajv": ">=4.10.0" } }, - "node_modules/table/node_modules/ansi-regex": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-2.1.1.tgz", - "integrity": "sha512-TIGnTpdo+E3+pCyAluZvtED5p5wCqLdezCyhPZzKPcxvFplEt4i+W7OONCKgeZFT3+y5NZZfOOS/Bdcanm1MYA==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, "node_modules/table/node_modules/ansi-styles": { "version": "2.2.1", "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-2.2.1.tgz", @@ -19641,9 +16569,9 @@ } }, "node_modules/tapable": { - "version": "2.3.0", - "resolved": "https://registry.npmjs.org/tapable/-/tapable-2.3.0.tgz", - "integrity": "sha512-g9ljZiwki/LfxmQADO3dEY1CbpmXT5Hm2fJ+QaGKwSXUylMybePR7/67YW7jOrrvjEgL1Fmz5kzyAjWVWLlucg==", + "version": "2.3.3", + "resolved": "https://registry.npmjs.org/tapable/-/tapable-2.3.3.tgz", + "integrity": "sha512-uxc/zpqFg6x7C8vOE7lh6Lbda8eEL9zmVm/PLeTPBRhh1xCgdWaQ+J1CUieGpIfm2HdtsUpRv+HshiasBMcc6A==", "license": "MIT", "engines": { "node": ">=6" @@ -19697,15 +16625,14 @@ } }, "node_modules/terser-webpack-plugin": { - "version": "5.3.16", - "resolved": "https://registry.npmjs.org/terser-webpack-plugin/-/terser-webpack-plugin-5.3.16.tgz", - "integrity": "sha512-h9oBFCWrq78NyWWVcSwZarJkZ01c2AyGrzs1crmHZO3QUg9D61Wu4NPjBy69n7JqylFF5y+CsUZYmYEIZ3mR+Q==", + "version": "5.5.0", + "resolved": "https://registry.npmjs.org/terser-webpack-plugin/-/terser-webpack-plugin-5.5.0.tgz", + "integrity": "sha512-UYhptBwhWvfIjKd/UuFo6D8uq9xpGLDK+z8EDsj/zWhrTaH34cKEbrkMKfV5YWqGBvAYA3tlzZbs2R+qYrbQJA==", "license": "MIT", "dependencies": { "@jridgewell/trace-mapping": "^0.3.25", "jest-worker": "^27.4.5", "schema-utils": "^4.3.0", - "serialize-javascript": "^6.0.2", "terser": "^5.31.1" }, "engines": { @@ -19793,52 +16720,6 @@ "node": ">=8" } }, - "node_modules/test-exclude/node_modules/brace-expansion": { - "version": "1.1.12", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.12.tgz", - "integrity": "sha512-9T9UjW3r0UW5c1Q7GTwllptXwhvYmEzFhzMfZ9H7FQWt+uZePjZPjBP/W1ZEyZ1twGWom5/56TF4lPcqjnDHcg==", - "dev": true, - "license": "MIT", - "dependencies": { - "balanced-match": "^1.0.0", - "concat-map": "0.0.1" - } - }, - "node_modules/test-exclude/node_modules/glob": { - "version": "7.2.3", - "resolved": "https://registry.npmjs.org/glob/-/glob-7.2.3.tgz", - "integrity": "sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q==", - "deprecated": "Glob versions prior to v9 are no longer supported", - "dev": true, - "license": "ISC", - "dependencies": { - "fs.realpath": "^1.0.0", - "inflight": "^1.0.4", - "inherits": "2", - "minimatch": "^3.1.1", - "once": "^1.3.0", - "path-is-absolute": "^1.0.0" - }, - "engines": { - "node": "*" - }, - "funding": { - "url": "https://github.com/sponsors/isaacs" - } - }, - "node_modules/test-exclude/node_modules/minimatch": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", - "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", - "dev": true, - "license": "ISC", - "dependencies": { - "brace-expansion": "^1.1.7" - }, - "engines": { - "node": "*" - } - }, "node_modules/text-table": { "version": "0.2.0", "resolved": "https://registry.npmjs.org/text-table/-/text-table-0.2.0.tgz", @@ -19863,29 +16744,6 @@ "readable-stream": "2 || 3" } }, - "node_modules/through2/node_modules/readable-stream": { - "version": "3.6.2", - "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-3.6.2.tgz", - "integrity": "sha512-9u/sniCrY3D5WdsERHzHE4G2YCXqoG5FTHUiCC4SIbr6XcLZBY05ya9EKjYek9O5xOAwjGq+1JdGBAS7Q9ScoA==", - "license": "MIT", - "dependencies": { - "inherits": "^2.0.3", - "string_decoder": "^1.1.1", - "util-deprecate": "^1.0.1" - }, - "engines": { - "node": ">= 6" - } - }, - "node_modules/through2/node_modules/string_decoder": { - "version": "1.3.0", - "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.3.0.tgz", - "integrity": "sha512-hkRX8U1WjJFd8LsDJ2yQ/wWWxaopEsABU1XfkM8A+j0+85JAGppt16cr1Whg6KIbb4okU6Mql6BOj+uup/wKeA==", - "license": "MIT", - "dependencies": { - "safe-buffer": "~5.2.0" - } - }, "node_modules/time-stamp": { "version": "1.1.0", "resolved": "https://registry.npmjs.org/time-stamp/-/time-stamp-1.1.0.tgz", @@ -19945,7 +16803,6 @@ "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-4.0.3.tgz", "integrity": "sha512-5gTmgEY/sqK6gFXLIsQNH19lWb4ebPDLA4SdLP7dsWkIXHWlG66oPuVvXSGFPppYZz8ZDZq0dYYrbHfBCVUb1Q==", "license": "MIT", - "peer": true, "engines": { "node": ">=12" }, @@ -19954,75 +16811,27 @@ } }, "node_modules/tmp": { - "version": "0.2.5", - "resolved": "https://registry.npmjs.org/tmp/-/tmp-0.2.5.tgz", - "integrity": "sha512-voyz6MApa1rQGUxT3E+BK7/ROe8itEx7vD8/HEvt4xwXucvQ5G5oeEiHkmHZJuBO21RpOf+YYm9MOivj709jow==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=14.14" - } - }, - "node_modules/tmpl": { - "version": "1.0.5", - "resolved": "https://registry.npmjs.org/tmpl/-/tmpl-1.0.5.tgz", - "integrity": "sha512-3f0uOEAQwIqGuWW2MVzYg8fV/QNnc/IpuJNG837rLuczAaLVHslWHZQj4IGiEl5Hs3kkbhwL9Ab7Hrsmuj+Smw==", - "dev": true, - "license": "BSD-3-Clause" - }, - "node_modules/to-array": { - "version": "0.1.4", - "resolved": "https://registry.npmjs.org/to-array/-/to-array-0.1.4.tgz", - "integrity": "sha512-LhVdShQD/4Mk4zXNroIQZJC+Ap3zgLcDuwEdcmLv9CCO73NWockQDwyUnW/m8VX/EElfL6FcYx7EeutN4HJA6A==", - "dev": true - }, - "node_modules/to-fast-properties": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/to-fast-properties/-/to-fast-properties-1.0.3.tgz", - "integrity": "sha512-lxrWP8ejsq+7E3nNjwYmUBMAgjMTZoTI+sdBOpvNyijeDLa29LUn9QaoXAHv4+Z578hbmHHJKZknzxVtvo77og==", - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/to-object-path": { - "version": "0.3.0", - "resolved": "https://registry.npmjs.org/to-object-path/-/to-object-path-0.3.0.tgz", - "integrity": "sha512-9mWHdnGRuh3onocaHzukyvCZhzvr6tiflAy/JRFXcJX0TjgfWA9pk9t8CMbzmBE4Jfw58pXbkngtBtqYxzNEyg==", - "dev": true, - "license": "MIT", - "dependencies": { - "kind-of": "^3.0.2" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/to-object-path/node_modules/kind-of": { - "version": "3.2.2", - "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-3.2.2.tgz", - "integrity": "sha512-NOW9QQXMoZGg/oqnVNoNTTIFEIid1627WCffUBJEdMxYApq7mNE7CpzucIPc+ZQg25Phej7IJSmX3hO+oblOtQ==", + "version": "0.2.5", + "resolved": "https://registry.npmjs.org/tmp/-/tmp-0.2.5.tgz", + "integrity": "sha512-voyz6MApa1rQGUxT3E+BK7/ROe8itEx7vD8/HEvt4xwXucvQ5G5oeEiHkmHZJuBO21RpOf+YYm9MOivj709jow==", "dev": true, "license": "MIT", - "dependencies": { - "is-buffer": "^1.1.5" - }, "engines": { - "node": ">=0.10.0" + "node": ">=14.14" } }, - "node_modules/to-regex": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/to-regex/-/to-regex-3.0.2.tgz", - "integrity": "sha512-FWtleNAtZ/Ki2qtqej2CXTOayOH9bHDQF+Q48VpWyDXjbYxA4Yz8iDB31zXOBUlOHHKidDbqGVrTUvQMPmBGBw==", + "node_modules/tmpl": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/tmpl/-/tmpl-1.0.5.tgz", + "integrity": "sha512-3f0uOEAQwIqGuWW2MVzYg8fV/QNnc/IpuJNG837rLuczAaLVHslWHZQj4IGiEl5Hs3kkbhwL9Ab7Hrsmuj+Smw==", "dev": true, + "license": "BSD-3-Clause" + }, + "node_modules/to-fast-properties": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/to-fast-properties/-/to-fast-properties-1.0.3.tgz", + "integrity": "sha512-lxrWP8ejsq+7E3nNjwYmUBMAgjMTZoTI+sdBOpvNyijeDLa29LUn9QaoXAHv4+Z578hbmHHJKZknzxVtvo77og==", "license": "MIT", - "dependencies": { - "define-property": "^2.0.2", - "extend-shallow": "^3.0.2", - "regex-not": "^1.0.2", - "safe-regex": "^1.1.0" - }, "engines": { "node": ">=0.10.0" } @@ -20039,15 +16848,6 @@ "node": ">=8.0" } }, - "node_modules/to-regex-range/node_modules/is-number": { - "version": "7.0.0", - "resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz", - "integrity": "sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==", - "license": "MIT", - "engines": { - "node": ">=0.12.0" - } - }, "node_modules/toidentifier": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/toidentifier/-/toidentifier-1.0.1.tgz", @@ -20117,9 +16917,9 @@ } }, "node_modules/tslib": { - "version": "2.8.1", - "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.8.1.tgz", - "integrity": "sha512-oJFu94HQb+KVduSUQL7wnpmqnfmLsOA/nAh6b6EH0wCEoK0/mPeXU6c3wKDV83MkOuHPRHtSXKKU99IBazS/2w==", + "version": "1.14.1", + "resolved": "https://registry.npmjs.org/tslib/-/tslib-1.14.1.tgz", + "integrity": "sha512-Xni35NKzjgMrwevysHTCArtLDpPvye8zV/0E4EyYn43P7/7qvQwPh9BGkHewbMulVntbigmcT7rdX3BNo9wRJg==", "license": "0BSD" }, "node_modules/type": { @@ -20319,6 +17119,33 @@ "dev": true, "license": "MPL-2.0" }, + "node_modules/ua-parser-js": { + "version": "0.7.41", + "resolved": "https://registry.npmjs.org/ua-parser-js/-/ua-parser-js-0.7.41.tgz", + "integrity": "sha512-O3oYyCMPYgNNHuO7Jjk3uacJWZF8loBgwrfd/5LE/HyZ3lUIOdniQ7DNXJcIgZbwioZxk0fLfI4EVnetdiX5jg==", + "dev": true, + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/ua-parser-js" + }, + { + "type": "paypal", + "url": "https://paypal.me/faisalman" + }, + { + "type": "github", + "url": "https://github.com/sponsors/faisalman" + } + ], + "license": "MIT", + "bin": { + "ua-parser-js": "script/cli.js" + }, + "engines": { + "node": "*" + } + }, "node_modules/uglify-js": { "version": "3.19.3", "resolved": "https://registry.npmjs.org/uglify-js/-/uglify-js-3.19.3.tgz", @@ -20331,13 +17158,6 @@ "node": ">=0.8.0" } }, - "node_modules/ultron": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/ultron/-/ultron-1.0.2.tgz", - "integrity": "sha512-QMpnpVtYaWEeY+MwKDN/UdKlE/LsFZXM5lO1u7GaZzNgmIbGixHEmVMIKT+vqYOALu3m5GYQy9kz4Xu4IVn7Ow==", - "dev": true, - "license": "MIT" - }, "node_modules/unbox-primitive": { "version": "1.1.0", "resolved": "https://registry.npmjs.org/unbox-primitive/-/unbox-primitive-1.1.0.tgz", @@ -20372,9 +17192,9 @@ } }, "node_modules/underscore": { - "version": "1.13.7", - "resolved": "https://registry.npmjs.org/underscore/-/underscore-1.13.7.tgz", - "integrity": "sha512-GMXzWtsc57XAtguZgaQViUOzs0KTkk8ojr3/xAxXLITqf/3EMwxC0inyETfDFjH/Krbhuep0HNbbjI9i/q3F3g==", + "version": "1.13.8", + "resolved": "https://registry.npmjs.org/underscore/-/underscore-1.13.8.tgz", + "integrity": "sha512-DXtD3ZtEQzc7M8m4cXotyHR+FAS18C64asBYY5vqZexfYryNNnDc02W4hKg3rdQuqOYas1jkseX0+nZXjTXnvQ==", "license": "MIT" }, "node_modules/underscore.string": { @@ -20396,6 +17216,15 @@ "integrity": "sha512-Oo+0REFV59/rz3gfJNKQiBlwfHaSESl1pcGyABQsnnIfWOFt6JNj5gCog2U6MLZ//IGYD+nA8nI+mTShREReaA==", "license": "BSD-3-Clause" }, + "node_modules/undici": { + "version": "6.25.0", + "resolved": "https://registry.npmjs.org/undici/-/undici-6.25.0.tgz", + "integrity": "sha512-ZgpWDC5gmNiuY9CnLVXEH8rl50xhRCuLNA97fAUnKi8RRuV4E6KG31pDTsLVUKnohJE0I3XDrTeEydAXRw47xg==", + "license": "MIT", + "engines": { + "node": ">=18.17" + } + }, "node_modules/undici-types": { "version": "7.16.0", "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-7.16.0.tgz", @@ -20448,6 +17277,7 @@ "integrity": "sha512-wH590V9VNgYH9g3lH9wWjTrUoKsjLF6sGLjhR4sH1LWpLmCOH0Zf7PukhDA8BiS7KHe4oPNkcTHqYkj7SOGUOw==", "dev": true, "license": "MIT", + "peer": true, "engines": { "node": ">=20" }, @@ -20455,56 +17285,6 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/union-value": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/union-value/-/union-value-1.0.1.tgz", - "integrity": "sha512-tJfXmxMeWYnczCVs7XAEvIV7ieppALdyepWMkHkwciRpZraG/xwT+s2JN8+pr1+8jCRf80FFzvr+MpQeeoF4Xg==", - "dev": true, - "license": "MIT", - "dependencies": { - "arr-union": "^3.1.0", - "get-value": "^2.0.6", - "is-extendable": "^0.1.1", - "set-value": "^2.0.1" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/union-value/node_modules/is-extendable": { - "version": "0.1.1", - "resolved": "https://registry.npmjs.org/is-extendable/-/is-extendable-0.1.1.tgz", - "integrity": "sha512-5BMULNob1vgFX6EjQw5izWDxrecWK9AM72rugNr0TFldMOi0fj6Jk+zeKIt0xGj4cEfQIJth4w3OKWOJ4f+AFw==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/unique-filename": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/unique-filename/-/unique-filename-4.0.0.tgz", - "integrity": "sha512-XSnEewXmQ+veP7xX2dS5Q4yZAvO40cBN2MWkJ7D/6sW4Dg6wYBNwM1Vrnz1FhH5AdeLIlUXRI9e28z1YZi71NQ==", - "license": "ISC", - "dependencies": { - "unique-slug": "^5.0.0" - }, - "engines": { - "node": "^18.17.0 || >=20.5.0" - } - }, - "node_modules/unique-slug": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/unique-slug/-/unique-slug-5.0.0.tgz", - "integrity": "sha512-9OdaqO5kwqR+1kVgHAhsp5vPNU0hnxRa26rBFNfNgM7M6pNtgzeBn3s/xbyCQL3dcjzOatcef6UUHpB/6MaETg==", - "license": "ISC", - "dependencies": { - "imurmurhash": "^0.1.4" - }, - "engines": { - "node": "^18.17.0 || >=20.5.0" - } - }, "node_modules/universal-cookie": { "version": "4.0.4", "resolved": "https://registry.npmjs.org/universal-cookie/-/universal-cookie-4.0.4.tgz", @@ -20543,65 +17323,6 @@ "node": ">= 0.8" } }, - "node_modules/unset-value": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/unset-value/-/unset-value-1.0.0.tgz", - "integrity": "sha512-PcA2tsuGSF9cnySLHTLSh2qrQiJ70mn+r+Glzxv2TWZblxsxCC52BDlZoPCsz7STd9pN7EZetkWZBAvk4cgZdQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "has-value": "^0.3.1", - "isobject": "^3.0.0" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/unset-value/node_modules/has-value": { - "version": "0.3.1", - "resolved": "https://registry.npmjs.org/has-value/-/has-value-0.3.1.tgz", - "integrity": "sha512-gpG936j8/MzaeID5Yif+577c17TxaDmhuyVgSwtnL/q8UUTySg8Mecb+8Cf1otgLoD7DDH75axp86ER7LFsf3Q==", - "dev": true, - "license": "MIT", - "dependencies": { - "get-value": "^2.0.3", - "has-values": "^0.1.4", - "isobject": "^2.0.0" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/unset-value/node_modules/has-value/node_modules/isobject": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/isobject/-/isobject-2.1.0.tgz", - "integrity": "sha512-+OUdGJlgjOBZDfxnDjYYG6zp487z0JGNQq3cYQYg5f5hKR+syHMsaztzGeml/4kGG55CSpKSpWTY+jYGgsHLgA==", - "dev": true, - "license": "MIT", - "dependencies": { - "isarray": "1.0.0" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/unset-value/node_modules/has-values": { - "version": "0.1.4", - "resolved": "https://registry.npmjs.org/has-values/-/has-values-0.1.4.tgz", - "integrity": "sha512-J8S0cEdWuQbqD9//tlZxiMuMNmxB8PlEwvYwuxsTmR1G5RXUePEX/SJn7aD0GMLieuZYSwNH0cQuJGwnYunXRQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/unset-value/node_modules/isarray": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/isarray/-/isarray-1.0.0.tgz", - "integrity": "sha512-VLghIWNM6ELQzo7zwmcg0NmTVyWKYjvIeM83yjp0wRDTmUnrM678fQbcKBo6n2CJEF0szoG//ytg+TKla89ALQ==", - "dev": true, - "license": "MIT" - }, "node_modules/update-browserslist-db": { "version": "1.2.3", "resolved": "https://registry.npmjs.org/update-browserslist-db/-/update-browserslist-db-1.2.3.tgz", @@ -20656,14 +17377,6 @@ "integrity": "sha512-HXgFDgDommxn5/bIv0cnQZsPhHDA90NPHD6+c/v21U5+Sx5hoP8+dP9IZXBU1gIfvdRfhG8cel9QNPeionfcCQ==", "license": "MIT" }, - "node_modules/urix": { - "version": "0.1.0", - "resolved": "https://registry.npmjs.org/urix/-/urix-0.1.0.tgz", - "integrity": "sha512-Am1ousAhSLBeB9cG/7k7r2R0zj50uDRlZHPGbazid5s9rlF1F/QKYObEKSIunSjIOkJZqwRRLpvewjEkM7pSqg==", - "deprecated": "Please see https://github.com/lydell/urix#deprecated", - "dev": true, - "license": "MIT" - }, "node_modules/url-parse": { "version": "1.5.10", "resolved": "https://registry.npmjs.org/url-parse/-/url-parse-1.5.10.tgz", @@ -20674,16 +17387,6 @@ "requires-port": "^1.0.0" } }, - "node_modules/use": { - "version": "3.1.1", - "resolved": "https://registry.npmjs.org/use/-/use-3.1.1.tgz", - "integrity": "sha512-cwESVXlO3url9YWlFW/TA9cshCEhtu7IKJ/p5soJ/gGpj7vbvFrAY/eIioQ6Dw23KjZhYgiIo8HOs1nQ2vr/oQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, "node_modules/use-callback-ref": { "version": "1.3.3", "resolved": "https://registry.npmjs.org/use-callback-ref/-/use-callback-ref-1.3.3.tgz", @@ -20705,6 +17408,12 @@ } } }, + "node_modules/use-callback-ref/node_modules/tslib": { + "version": "2.8.1", + "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.8.1.tgz", + "integrity": "sha512-oJFu94HQb+KVduSUQL7wnpmqnfmLsOA/nAh6b6EH0wCEoK0/mPeXU6c3wKDV83MkOuHPRHtSXKKU99IBazS/2w==", + "license": "0BSD" + }, "node_modules/use-sidecar": { "version": "1.1.3", "resolved": "https://registry.npmjs.org/use-sidecar/-/use-sidecar-1.1.3.tgz", @@ -20727,6 +17436,12 @@ } } }, + "node_modules/use-sidecar/node_modules/tslib": { + "version": "2.8.1", + "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.8.1.tgz", + "integrity": "sha512-oJFu94HQb+KVduSUQL7wnpmqnfmLsOA/nAh6b6EH0wCEoK0/mPeXU6c3wKDV83MkOuHPRHtSXKKU99IBazS/2w==", + "license": "0BSD" + }, "node_modules/user-home": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/user-home/-/user-home-2.0.0.tgz", @@ -20740,48 +17455,6 @@ "node": ">=0.10.0" } }, - "node_modules/useragent": { - "version": "2.3.0", - "resolved": "https://registry.npmjs.org/useragent/-/useragent-2.3.0.tgz", - "integrity": "sha512-4AoH4pxuSvHCjqLO04sU6U/uE65BYza8l/KKBS0b0hnUPWi+cQ2BpeTEwejCSx9SPV5/U03nniDTrWx5NrmKdw==", - "dev": true, - "license": "MIT", - "dependencies": { - "lru-cache": "4.1.x", - "tmp": "0.0.x" - } - }, - "node_modules/useragent/node_modules/lru-cache": { - "version": "4.1.5", - "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-4.1.5.tgz", - "integrity": "sha512-sWZlbEP2OsHNkXrMl5GYk/jKk70MBng6UU4YI/qGDYbgf6YbP4EvmqISbXCoJiRKs+1bSpFHVgQxvJ17F2li5g==", - "dev": true, - "license": "ISC", - "dependencies": { - "pseudomap": "^1.0.2", - "yallist": "^2.1.2" - } - }, - "node_modules/useragent/node_modules/tmp": { - "version": "0.0.33", - "resolved": "https://registry.npmjs.org/tmp/-/tmp-0.0.33.tgz", - "integrity": "sha512-jRCJlojKnZ3addtTOjdIqoRuPEKBvNXcGYqzO6zWZX8KfKEpnGY5jfggJQ3EjKuu8D4bJRr0y+cYJFmYbImXGw==", - "dev": true, - "license": "MIT", - "dependencies": { - "os-tmpdir": "~1.0.2" - }, - "engines": { - "node": ">=0.6.0" - } - }, - "node_modules/useragent/node_modules/yallist": { - "version": "2.1.2", - "resolved": "https://registry.npmjs.org/yallist/-/yallist-2.1.2.tgz", - "integrity": "sha512-ncTzHV7NvsQZkYe1DW7cbDLm0YpzHmZF5r/iyP3ZnQtMiJ+pjzisCiMNI+Sj+xQF5pXhSHxSB3uDbsBTzY/c2A==", - "dev": true, - "license": "ISC" - }, "node_modules/util": { "version": "0.12.5", "resolved": "https://registry.npmjs.org/util/-/util-0.12.5.tgz", @@ -20843,6 +17516,16 @@ "integrity": "sha512-NOJ6JZCAWr0zlxZt+xqCHNTEKOsrks2HQd4MqhP1qy4z1SkbEP467eNx6TgDKXMvUOb+OENfJCZwM+16n7fRfw==", "license": "MIT" }, + "node_modules/vary": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/vary/-/vary-1.1.2.tgz", + "integrity": "sha512-BNGbWLfd0eUPabhkXUVm0j8uuvREyTh5ovRa/dyow/BqAbZJyC+5fU+IzQOzmAKzYqYRAISoRhdQr3eIZ/PXqg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.8" + } + }, "node_modules/void-elements": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/void-elements/-/void-elements-2.0.1.tgz", @@ -20907,11 +17590,10 @@ } }, "node_modules/webpack": { - "version": "5.104.1", - "resolved": "https://registry.npmjs.org/webpack/-/webpack-5.104.1.tgz", - "integrity": "sha512-Qphch25abbMNtekmEGJmeRUhLDbe+QfiWTiqpKYkpCOWY64v9eyl+KRRLmqOFA2AvKPpc9DC6+u2n76tQLBoaA==", + "version": "5.106.2", + "resolved": "https://registry.npmjs.org/webpack/-/webpack-5.106.2.tgz", + "integrity": "sha512-wGN3qcrBQIFmQ/c0AiOAQBvrZ5lmY8vbbMv4Mxfgzqd/B6+9pXtLo73WuS1dSGXM5QYY3hZnIbvx+K1xxe6FyA==", "license": "MIT", - "peer": true, "dependencies": { "@types/eslint-scope": "^3.7.7", "@types/estree": "^1.0.8", @@ -20919,25 +17601,24 @@ "@webassemblyjs/ast": "^1.14.1", "@webassemblyjs/wasm-edit": "^1.14.1", "@webassemblyjs/wasm-parser": "^1.14.1", - "acorn": "^8.15.0", + "acorn": "^8.16.0", "acorn-import-phases": "^1.0.3", "browserslist": "^4.28.1", "chrome-trace-event": "^1.0.2", - "enhanced-resolve": "^5.17.4", + "enhanced-resolve": "^5.20.0", "es-module-lexer": "^2.0.0", "eslint-scope": "5.1.1", "events": "^3.2.0", "glob-to-regexp": "^0.4.1", "graceful-fs": "^4.2.11", - "json-parse-even-better-errors": "^2.3.1", "loader-runner": "^4.3.1", - "mime-types": "^2.1.27", + "mime-db": "^1.54.0", "neo-async": "^2.6.2", "schema-utils": "^4.3.3", "tapable": "^2.3.0", - "terser-webpack-plugin": "^5.3.16", - "watchpack": "^2.4.4", - "webpack-sources": "^3.3.3" + "terser-webpack-plugin": "^5.3.17", + "watchpack": "^2.5.1", + "webpack-sources": "^3.3.4" }, "bin": { "webpack": "bin/webpack.js" @@ -20970,7 +17651,6 @@ "integrity": "sha512-pIDJHIEI9LR0yxHXQ+Qh95k2EvXpWzZ5l+d+jIo+RdSm9MiHfzazIxwwni/p7+x4eJZuvG1AJwgC4TNQ7NRgsg==", "dev": true, "license": "MIT", - "peer": true, "dependencies": { "@discoveryjs/json-ext": "^0.5.0", "@webpack-cli/configtest": "^2.1.1", @@ -21051,14 +17731,23 @@ } }, "node_modules/webpack-sources": { - "version": "3.3.3", - "resolved": "https://registry.npmjs.org/webpack-sources/-/webpack-sources-3.3.3.tgz", - "integrity": "sha512-yd1RBzSGanHkitROoPFd6qsrxt+oFhg/129YzheDGqeustzX0vTZJZsSsQjVQC4yzBQ56K55XU8gaNCtIzOnTg==", + "version": "3.4.1", + "resolved": "https://registry.npmjs.org/webpack-sources/-/webpack-sources-3.4.1.tgz", + "integrity": "sha512-eACpxRN02yaawnt+uUNIF7Qje6A9zArxBbcAJjK1PK3S9Ycg5jIuJ8pW4q8EMnwNZCEGltcjkRx1QzOxOkKD8A==", "license": "MIT", "engines": { "node": ">=10.13.0" } }, + "node_modules/webpack/node_modules/mime-db": { + "version": "1.54.0", + "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.54.0.tgz", + "integrity": "sha512-aU5EJuIN2WDemCcAp2vFBfp/m4EAhWJnUNSSw0ixs7/kXbd6Pg64EmwJkNdFhB8aWt1sH2CTXrLxo/iAGV3oPQ==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, "node_modules/whatwg-encoding": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/whatwg-encoding/-/whatwg-encoding-2.0.0.tgz", @@ -21110,6 +17799,7 @@ "version": "2.0.2", "resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz", "integrity": "sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA==", + "dev": true, "license": "ISC", "dependencies": { "isexe": "^2.0.0" @@ -21238,21 +17928,11 @@ "node": ">=0.10.0" } }, - "node_modules/wordwrap": { - "version": "0.0.3", - "resolved": "https://registry.npmjs.org/wordwrap/-/wordwrap-0.0.3.tgz", - "integrity": "sha512-1tMA907+V4QmxV7dbRvb4/8MaRALK6q9Abid3ndMYnbyo8piisCmeONVqVSXqQA3KaP4SLt5b7ud6E2sqP8TFw==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=0.4.0" - } - }, - "node_modules/wrap-ansi-cjs": { - "name": "wrap-ansi", + "node_modules/wrap-ansi": { "version": "7.0.0", "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-7.0.0.tgz", "integrity": "sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q==", + "dev": true, "license": "MIT", "dependencies": { "ansi-styles": "^4.0.0", @@ -21266,6 +17946,31 @@ "url": "https://github.com/chalk/wrap-ansi?sponsor=1" } }, + "node_modules/wrap-ansi/node_modules/is-fullwidth-code-point": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz", + "integrity": "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/wrap-ansi/node_modules/string-width": { + "version": "4.2.3", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", + "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", + "dev": true, + "license": "MIT", + "dependencies": { + "emoji-regex": "^8.0.0", + "is-fullwidth-code-point": "^3.0.0", + "strip-ansi": "^6.0.1" + }, + "engines": { + "node": ">=8" + } + }, "node_modules/wrappy": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz", @@ -21301,9 +18006,9 @@ } }, "node_modules/ws": { - "version": "8.19.0", - "resolved": "https://registry.npmjs.org/ws/-/ws-8.19.0.tgz", - "integrity": "sha512-blAT2mjOEIi0ZzruJfIhb3nps74PRWTCz1IjglWEEpQl5XS/UNama6u2/rjFkDDouqr4L67ry+1aGIALViWjDg==", + "version": "8.20.0", + "resolved": "https://registry.npmjs.org/ws/-/ws-8.20.0.tgz", + "integrity": "sha512-sAt8BhgNbzCtgGbt2OxmpuryO63ZoDk/sqaB/znQm94T4fCEsy/yV+7CdC1kJhOU9lboAEU7R3kquuycDoibVA==", "license": "MIT", "engines": { "node": ">=10.0.0" @@ -21321,13 +18026,6 @@ } } }, - "node_modules/wtf-8": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/wtf-8/-/wtf-8-1.0.0.tgz", - "integrity": "sha512-qfR6ovmRRMxNHgUNYI9LRdVofApe/eYrv4ggNOvvCP+pPdEo9Ym93QN4jUceGD6PignBbp2zAzgoE7GibAdq2A==", - "dev": true, - "license": "MIT" - }, "node_modules/xml-name-validator": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/xml-name-validator/-/xml-name-validator-4.0.0.tgz", @@ -21353,15 +18051,6 @@ "integrity": "sha512-JZnDKK8B0RCDw84FNdDAIpZK+JuJw+s7Lz8nksI7SIuU3UXJJslUthsi+uWBUYOwPFwW7W7PRLRfUKpxjtjFCw==", "license": "MIT" }, - "node_modules/xmlhttprequest-ssl": { - "version": "1.6.3", - "resolved": "https://registry.npmjs.org/xmlhttprequest-ssl/-/xmlhttprequest-ssl-1.6.3.tgz", - "integrity": "sha512-3XfeQE/wNkvrIktn2Kf0869fC0BN6UpydVasGIeSm2B1Llihf7/0UfZM+eCkOw3P7bP4+qPgqhm7ZoxuJtFU0Q==", - "dev": true, - "engines": { - "node": ">=0.4.0" - } - }, "node_modules/xtend": { "version": "4.0.2", "resolved": "https://registry.npmjs.org/xtend/-/xtend-4.0.2.tgz", @@ -21417,18 +18106,35 @@ "node": ">=12" } }, - "node_modules/yeast": { - "version": "0.1.2", - "resolved": "https://registry.npmjs.org/yeast/-/yeast-0.1.2.tgz", - "integrity": "sha512-8HFIh676uyGYP6wP13R/j6OJ/1HwJ46snpvzE7aHAN3Ryqh2yX6Xox2B4CUmTwwOIzlG3Bs7ocsP5dZH/R1Qbg==", + "node_modules/yargs/node_modules/is-fullwidth-code-point": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz", + "integrity": "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==", "dev": true, - "license": "MIT" + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/yargs/node_modules/string-width": { + "version": "4.2.3", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", + "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", + "dev": true, + "license": "MIT", + "dependencies": { + "emoji-regex": "^8.0.0", + "is-fullwidth-code-point": "^3.0.0", + "strip-ansi": "^6.0.1" + }, + "engines": { + "node": ">=8" + } }, "node_modules/yocto-queue": { "version": "0.1.0", "resolved": "https://registry.npmjs.org/yocto-queue/-/yocto-queue-0.1.0.tgz", "integrity": "sha512-rVksvsnNCdJ/ohGc6xgPwyN8eheCxsiLM8mxuE/t/mOVqJewPuO1miLpTHQiRgTKCLexL4MeAFVagts7HmNZ2Q==", - "dev": true, "license": "MIT", "engines": { "node": ">=10" diff --git a/package.json b/package.json index 7f6e08f3c7b2..986878113351 100644 --- a/package.json +++ b/package.json @@ -47,7 +47,7 @@ "@testing-library/jest-dom": "^6", "@testing-library/react": "^12", "@testing-library/user-event": "^12", - "babel-loader": "^9", + "babel-loader": "^10.0.0", "babel-plugin-transform-class-properties": "^6", "babel-polyfill": "^6", "backbone": "^1", @@ -60,7 +60,7 @@ "datatables": "^1", "datatables.net-fixedcolumns": "^5", "edx-ui-toolkit": "^1", - "exports-loader": "^0.6", + "exports-loader": "^0.7.0", "file-loader": "^6", "font-awesome": "^4", "hls.js": "^1", @@ -71,17 +71,17 @@ "jquery.scrollto": "^2", "js-cookie": "^3", "moment": "^2", - "moment-timezone": "^0.5", - "node-gyp": "^11", + "moment-timezone": "^0.6.0", + "node-gyp": "^12.0.0", "popper.js": "^1", "prop-types": "^15", "raw-loader": "^0.5", "react": "^16", "react-dom": "^16", - "react-focus-lock": "^1", + "react-focus-lock": "^2.0.0", "react-redux": "^5", "react-router-dom": "^5", - "react-slick": "^0.30", + "react-slick": "^0.31.0", "redux": "3.7.2", "redux-thunk": "2.2.0", "requirejs": "^2", @@ -102,14 +102,14 @@ "devDependencies": { "@edx/stylelint-config-edx": "^2", "babel-jest": "^29", - "jasmine-core": "2.6.4", + "jasmine-core": "2.99.1", "jasmine-jquery": "git+https://git@github.com/velesin/jasmine-jquery.git#ebad463d592d3fea00c69f26ea18a930e09c7b58", "jest": "^29", - "karma": "^0.13", + "karma": "^6.0.0", "karma-chrome-launcher": "^3", "karma-coverage": "^2", "karma-firefox-launcher": "^2", - "karma-jasmine": "^0.3", + "karma-jasmine": "^1", "karma-jasmine-html-reporter": "^0.2", "karma-junit-reporter": "^2", "karma-requirejs": "^1", diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 000000000000..44488938ec95 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,413 @@ +[build-system] +requires = ["setuptools>=61.0"] +build-backend = "setuptools.build_meta" + +[project] +name = "openedx-platform" +version = "0.13" +requires-python = ">=3.12" +dependencies = ["setuptools"] + +[tool.setuptools] +packages = ["cms", "common", "lms", "openedx", "xmodule"] + +[tool.setuptools.package-data] +xmodule = ["js/module/*"] + +[project.entry-points."xblock.v1"] +about = "xmodule.html_block:AboutBlock" +book = "xmodule.template_block:TranslateCustomTagBlock" +annotatable = "xmodule.annotatable_block:AnnotatableBlock" +chapter = "xmodule.seq_block:SectionBlock" +conditional = "xmodule.conditional_block:ConditionalBlock" +course = "xmodule.course_block:CourseBlock" +course_info = "xmodule.html_block:CourseInfoBlock" +customtag = "xmodule.template_block:CustomTagBlock" +custom_tag_template = "xmodule.template_block:CustomTagTemplateBlock" +discuss = "xmodule.template_block:TranslateCustomTagBlock" +discussion = "xmodule.discussion_block:DiscussionXBlock" +error = "xmodule.error_block:ErrorBlock" +hidden = "xmodule.hidden_block:HiddenBlock" +html = "xmodule.html_block:HtmlBlock" +itembank = "xmodule.item_bank_block:ItemBankBlock" +image = "xmodule.template_block:TranslateCustomTagBlock" +library = "xmodule.library_root_xblock:LibraryRoot" +library_content = "xmodule.library_content_block:LegacyLibraryContentBlock" +lti = "xmodule.lti_block:LTIBlock" +poll_question = "xmodule.poll_block:PollBlock" +problem = "xmodule.capa_block:ProblemBlock" +randomize = "xmodule.randomize_block:RandomizeBlock" +sequential = "xmodule.seq_block:SequenceBlock" +slides = "xmodule.template_block:TranslateCustomTagBlock" +split_test = "xmodule.split_test_block:SplitTestBlock" +static_tab = "xmodule.html_block:StaticTabBlock" +unit = "xmodule.unit_block:UnitBlock" +vertical = "xmodule.vertical_block:VerticalBlock" +video = "xmodule.video_block:VideoBlock" +videoalpha = "xmodule.video_block:VideoBlock" +videodev = "xmodule.template_block:TranslateCustomTagBlock" +word_cloud = "xmodule.word_cloud_block:WordCloudBlock" +wrapper = "xmodule.wrapper_block:WrapperBlock" + +[project.entry-points."xblock_asides.v1"] +tagging_aside = "cms.lib.xblock.tagging:StructuredTagsAside" + +[project.entry-points."openedx.course_tab"] +ccx = "lms.djangoapps.ccx.plugins:CcxCourseTab" +courseware = "lms.djangoapps.courseware.tabs:CoursewareTab" +dates = "lms.djangoapps.courseware.tabs:DatesTab" +discussion = "lms.djangoapps.discussion.plugins:DiscussionTab" +edxnotes = "lms.djangoapps.edxnotes.plugins:EdxNotesTab" +external_discussion = "lms.djangoapps.courseware.tabs:ExternalDiscussionCourseTab" +external_link = "lms.djangoapps.courseware.tabs:ExternalLinkCourseTab" +html_textbooks = "lms.djangoapps.courseware.tabs:HtmlTextbookTabs" +instructor = "lms.djangoapps.instructor.views.instructor_dashboard:InstructorDashboardTab" +lti_discussion = "openedx.features.lti_course_tab.tab:DiscussionLtiCourseTab" +lti_live = "openedx.core.djangoapps.course_live.tab:CourseLiveTab" +lti_tab = "openedx.features.lti_course_tab.tab:LtiCourseTab" +pdf_textbooks = "lms.djangoapps.courseware.tabs:PDFTextbookTabs" +progress = "lms.djangoapps.courseware.tabs:ProgressTab" +static_tab = "xmodule.tabs:StaticTab" +syllabus = "lms.djangoapps.courseware.tabs:SyllabusTab" +teams = "lms.djangoapps.teams.plugins:TeamsTab" +textbooks = "lms.djangoapps.courseware.tabs:TextbookTabs" +wiki = "lms.djangoapps.course_wiki.tab:WikiTab" + +[project.entry-points."openedx.course_app"] +calculator = "lms.djangoapps.courseware.plugins:CalculatorCourseApp" +custom_pages = "lms.djangoapps.courseware.plugins:CustomPagesCourseApp" +dates = "lms.djangoapps.courseware.plugins:DatesCourseApp" +discussion = "openedx.core.djangoapps.discussions.plugins:DiscussionCourseApp" +edxnotes = "lms.djangoapps.edxnotes.plugins:EdxNotesCourseApp" +live = "openedx.core.djangoapps.course_live.plugins:LiveCourseApp" +ora_settings = "lms.djangoapps.courseware.plugins:ORASettingsApp" +proctoring = "lms.djangoapps.courseware.plugins:ProctoringCourseApp" +progress = "lms.djangoapps.courseware.plugins:ProgressCourseApp" +teams = "lms.djangoapps.teams.plugins:TeamsCourseApp" +textbooks = "lms.djangoapps.courseware.plugins:TextbooksCourseApp" +wiki = "lms.djangoapps.course_wiki.plugins.course_app:WikiCourseApp" + +[project.entry-points."openedx.course_tool"] +calendar_sync_toggle = "openedx.features.calendar_sync.plugins:CalendarSyncToggleTool" +course_bookmarks = "openedx.features.course_bookmarks.plugins:CourseBookmarksTool" +course_updates = "openedx.features.course_experience.plugins:CourseUpdatesTool" +financial_assistance = "lms.djangoapps.courseware.course_tools:FinancialAssistanceTool" + +[project.entry-points."lms.djangoapp"] +ace_common = "openedx.core.djangoapps.ace_common.apps:AceCommonConfig" +content_libraries = "openedx.core.djangoapps.content_libraries.apps:ContentLibrariesConfig" +course_apps = "openedx.core.djangoapps.course_apps.apps:CourseAppsConfig" +course_live = "openedx.core.djangoapps.course_live.apps:CourseLiveConfig" +courseware_api = "openedx.core.djangoapps.courseware_api.apps:CoursewareAPIConfig" +credentials = "openedx.core.djangoapps.credentials.apps:CredentialsConfig" +discussion = "lms.djangoapps.discussion.apps:DiscussionConfig" +discussions = "openedx.core.djangoapps.discussions.apps:DiscussionsConfig" +grades = "lms.djangoapps.grades.apps:GradesConfig" +plugins = "openedx.core.djangoapps.plugins.apps:PluginsConfig" +theming = "openedx.core.djangoapps.theming.apps:ThemingConfig" +bookmarks = "openedx.core.djangoapps.bookmarks.apps:BookmarksConfig" +zendesk_proxy = "openedx.core.djangoapps.zendesk_proxy.apps:ZendeskProxyConfig" +instructor = "lms.djangoapps.instructor.apps:InstructorConfig" +password_policy = "openedx.core.djangoapps.password_policy.apps:PasswordPolicyConfig" +user_authn = "openedx.core.djangoapps.user_authn.apps:UserAuthnConfig" +program_enrollments = "lms.djangoapps.program_enrollments.apps:ProgramEnrollmentsConfig" + +[project.entry-points."cms.djangoapp"] +ace_common = "openedx.core.djangoapps.ace_common.apps:AceCommonConfig" +bookmarks = "openedx.core.djangoapps.bookmarks.apps:BookmarksConfig" +course_live = "openedx.core.djangoapps.course_live.apps:CourseLiveConfig" +content_libraries = "openedx.core.djangoapps.content_libraries.apps:ContentLibrariesConfig" +content_staging = "openedx.core.djangoapps.content_staging.apps:ContentStagingAppConfig" +course_apps = "openedx.core.djangoapps.course_apps.apps:CourseAppsConfig" +# Importing an LMS app into the Studio process is not a good practice. +# We're ignoring this for Discussions here because its placement in LMS +# is a historical artifact. The eventual goal is to consolidate the multiple +# discussions-related Django apps and either put them in the openedx/ dir, +# or in another repo entirely. +discussion = "lms.djangoapps.discussion.apps:DiscussionConfig" +discussions = "openedx.core.djangoapps.discussions.apps:DiscussionsConfig" +instructor = "lms.djangoapps.instructor.apps:InstructorConfig" +olx_rest_api = "openedx.core.djangoapps.olx_rest_api.apps:OlxRestApiAppConfig" +password_policy = "openedx.core.djangoapps.password_policy.apps:PasswordPolicyConfig" +plugins = "openedx.core.djangoapps.plugins.apps:PluginsConfig" +theming = "openedx.core.djangoapps.theming.apps:ThemingConfig" +user_authn = "openedx.core.djangoapps.user_authn.apps:UserAuthnConfig" +zendesk_proxy = "openedx.core.djangoapps.zendesk_proxy.apps:ZendeskProxyConfig" + +[project.entry-points."openedx.block_structure_transformer"] +library_content = "lms.djangoapps.course_blocks.transformers.library_content:ContentLibraryTransformer" +library_content_randomize = "lms.djangoapps.course_blocks.transformers.library_content:ContentLibraryOrderTransformer" +split_test = "lms.djangoapps.course_blocks.transformers.split_test:SplitTestTransformer" +start_date = "lms.djangoapps.course_blocks.transformers.start_date:StartDateTransformer" +user_partitions = "lms.djangoapps.course_blocks.transformers.user_partitions:UserPartitionTransformer" +visibility = "lms.djangoapps.course_blocks.transformers.visibility:VisibilityTransformer" +hidden_content = "lms.djangoapps.course_blocks.transformers.hidden_content:HiddenContentTransformer" +course_blocks_api = "lms.djangoapps.course_api.blocks.transformers.blocks_api:BlocksAPITransformer" +milestones = "lms.djangoapps.course_api.blocks.transformers.milestones:MilestonesAndSpecialExamsTransformer" +grades = "lms.djangoapps.grades.transformer:GradesTransformer" +completion = "lms.djangoapps.course_api.blocks.transformers.block_completion:BlockCompletionTransformer" +load_override_data = "lms.djangoapps.course_blocks.transformers.load_override_data:OverrideDataTransformer" +content_type_gate = "openedx.features.content_type_gating.block_transformers:ContentTypeGateTransformer" +access_denied_message_filter = "lms.djangoapps.course_blocks.transformers.access_denied_filter:AccessDeniedMessageFilterTransformer" +open_assessment_transformer = "lms.djangoapps.courseware.transformers:OpenAssessmentDateTransformer" +effort_estimation = "openedx.features.effort_estimation.api:EffortEstimationTransformer" +discussions_link = "openedx.core.djangoapps.discussions.transformers:DiscussionsTopicLinkTransformer" + +[project.entry-points."openedx.user_partition_scheme"] +cohort = "openedx.core.djangoapps.course_groups.partition_scheme:CohortPartitionScheme" +content_type_gate = "openedx.features.content_type_gating.partitions:ContentTypeGatingPartitionScheme" +enrollment_track = "openedx.core.djangoapps.verified_track_content.partition_scheme:EnrollmentTrackPartitionScheme" +random = "openedx.core.djangoapps.user_api.partition_schemes:RandomUserPartitionScheme" +team = "lms.djangoapps.teams.team_partition_scheme:TeamPartitionScheme" +verification = "openedx.core.djangoapps.user_api.partition_schemes:ReturnGroup1PartitionScheme" + +[project.entry-points."openedx.ace.policy"] +bulk_email_optout = "lms.djangoapps.bulk_email.policies:CourseEmailOptout" +course_push_notification_optout = "openedx.core.djangoapps.notifications.policies:CoursePushNotificationOptout" +disabled_user_optout = "openedx.core.djangoapps.ace_common.policies:DisableUserOptout" + +[project.entry-points."openedx.call_to_action"] +personalized_learner_schedules = "openedx.features.personalized_learner_schedules.call_to_action:PersonalizedLearnerScheduleCallToAction" + +[project.entry-points."openedx.learning_context"] +lib = "openedx.core.djangoapps.content_libraries.library_context:LibraryContextImpl" + +[project.entry-points."openedx.dynamic_partition_generator"] +content_type_gating = "openedx.features.content_type_gating.partitions:create_content_gating_partition" +enrollment_track = "xmodule.partitions.enrollment_track_partition_generator:create_enrollment_track_partition" +team = "openedx.core.lib.teams_config:create_team_set_partition" + +[tool.pytest.ini_options] +# Note: The first file of settings found is used, there is no combining, so +# this file is only used for tests that don't find a pytest.ini file first. +# Details at https://docs.pytest.org/en/latest/reference/customize.html +DJANGO_SETTINGS_MODULE = "lms.envs.test" +addopts = "--nomigrations --reuse-db --durations=20 --json-report --json-report-omit keywords streams collectors log traceback tests --json-report-file=none" +# Enable default handling for all warnings, including those that are ignored by default; +# but hide rate-limit warnings (because we deliberately don't throttle test user logins) +# and field_data deprecation warnings (because fixing them requires a major low-priority refactoring) +filterwarnings = [ + "default", + "ignore:No request passed to the backend, unable to rate-limit:UserWarning", + "ignore::xblock.exceptions.FieldDataDeprecationWarning", + # Remove default_app_config warning after updating Django to 4.2 + "ignore:.*You can remove default_app_config.*:PendingDeprecationWarning", + "ignore:Instead access HTTPResponse.headers directly.*:DeprecationWarning:elasticsearch", + # ABC deprecation Warning comes from libsass + "ignore:Using or importing the ABCs from 'collections' instead of from 'collections.abc' is deprecated.*:DeprecationWarning:sass", + "ignore:'etree' is deprecated. Use 'xml.etree.ElementTree' instead.:DeprecationWarning:wiki", + # We sometimes use DeprecationWarning to enourage `.id` instead of `.pk` since there are some cases where we cannot + # override the type of `.pk`, but we can always customize `.id` (e.g. using TypedBigAutoField). But we don't want to + # see those warnings when Django is using `.pk` internally, which is fine. + "ignore:Use \\.id instead:DeprecationWarning:django\\..*", +] +junit_family = "xunit2" +norecursedirs = ". .* *.egg build conf dist node_modules test_root cms/envs lms/envs openedx/envs" +python_classes = [] +python_files = ["tests.py", "test_*.py", "tests_*.py", "*_tests.py", "__init__.py"] + +[tool.ruff] +line-length = 120 +exclude = [ + "migrations", + "test_root/staticfiles", +] + +[tool.ruff.lint] +select = ["E", "W", "I", "F", "PT", "DJ", "UP", "B"] +ignore = [ + "E402", # module level import not at top of file + "E501", # line too long (pylint enforces this at 120 chars while ignoring trailing comments) + "E722", # do not use bare 'except' + "E731", # do not assign a lambda expression + "E741", # ambiguous variable name. TODO: fix the ~9 issues and re-enable this. + # The rules below were added in pycodestyle 2.9.x but we were pinned to 2.8.x, + # so they represent new findings. Keeping them ignored here to make this an + # equivalent swap; they can be cleaned up in a follow-up. + "E721", # use `isinstance()` for type comparisons +] + +[tool.importlinter] +root_packages = ["lms", "cms", "openedx", "openedx_content", "openedx_catalog"] +include_external_packages = true +# Our custom contract which checks that we're only importing from 'api.py' +# for participating packages. +contract_types = [ + "isolated_apps: openedx.testing.importlinter.isolated_apps_contract.IsolatedAppsContract", +] + +[[tool.importlinter.contracts]] +name = "lms and cms are independent" +type = "independence" +modules = ["lms", "cms"] +ignore_imports = [ + # lms side imports that we are ignoring for now + "lms.djangoapps.course_home_api.outline.tests.test_view -> cms.djangoapps.contentstore.outlines", + "lms.djangoapps.course_home_api.tests.utils -> cms.djangoapps.contentstore.outlines", + # lms.djangoapps.instructor.tests.test_api & lms.djangoapps.instructor.tests.test_tools + # -> openedx.core.djangoapps.course_date_signals.handlers + # -> cms.djangoapps.contentstore.config.waffle + "openedx.core.djangoapps.course_date_signals.handlers -> cms.djangoapps.contentstore.config.waffle", + # cms side imports that we are ignoring for now + "cms.djangoapps.contentstore.views.tests.test_block -> lms.djangoapps.lms_xblock.mixin", + "cms.djangoapps.contentstore.signals.handlers -> lms.djangoapps.grades.api", + "cms.djangoapps.contentstore.course_group_config -> lms.lib.utils", + "cms.djangoapps.contentstore.views.preview -> lms.djangoapps.lms_xblock.field_data", + # cms.envs.common + # -> openedx.envs.common + # -> lms.djangoapps.lms_xblock.mixin + "openedx.envs.common -> lms.djangoapps.lms_xblock.mixin", + # cms.djangoapps.contentstore.views.tests.test_group_configurations + # -> openedx.features.content_type_gating.helpers + # -> lms.djangoapps.courseware.masquerade + "openedx.features.content_type_gating.helpers -> lms.djangoapps.courseware.masquerade", + # cms.djangoapps.contentstore.utils + # -> openedx.core.djangoapps.django_comment_common.models + # -> openedx.core.djangoapps.course_groups.cohorts + # -> lms.djangoapps.courseware.courses + "openedx.core.djangoapps.course_groups.cohorts -> lms.djangoapps.courseware.courses", + # cms.djangoapps.contentstore.[various] + # -> openedx.features.content_type_gating.partitions + # -> lms.djangoapps.commerce.utils + "openedx.features.content_type_gating.partitions -> lms.djangoapps.commerce.utils", + # cms.djangoapps.contentstore.course_group_config + # -> openedx.core.djangoapps.course_groups.partition_scheme + # -> lms.djangoapps.courseware.masquerade + "openedx.core.djangoapps.course_groups.partition_scheme -> lms.djangoapps.courseware.masquerade", + # cms.djangoapps.export_course_metadata.tasks + # -> openedx.core.djangoapps.schedules.content_highlights + # -> lms.djangoapps.courseware.block_render & lms.djangoapps.courseware.model_data + "openedx.core.djangoapps.xblock.*.* -> lms.djangoapps.*.*", + # cms.djangoapps.contentstore.tasks -> openedx.core.djangoapps.content_libraries.[various] -> openedx.core.djangoapps.xblock.[various] + # -> lms.djangoapps.courseware & lms.djangoapps.courseware.grades + "openedx.core.djangoapps.schedules.content_highlights -> lms.djangoapps.courseware.*", + # cms.djangoapps.contentstore.[various] + # -> openedx.core.lib.gating.api + # -> lms.djangoapps.course_blocks.api & lms.djangoapps.courseware.access & lms.djangoapps.grades.api + "openedx.core.lib.gating.api -> lms.djangoapps.*.*", + # cms.djangoapps.contentstore.[various] + # -> openedx.features.content_type_gating.partitions + # -> openedx.features.discounts.utils + # -> lms.djangoapps.courseware.utils & lms.djangoapps.experiments.models + "openedx.features.discounts.utils -> lms.djangoapps.courseware.utils", + "openedx.features.discounts.utils -> lms.djangoapps.experiments.models", + # cms.djangoapps.contentstore.signals.handlers + # -> openedx.core.djangoapps.discussions.tasks + # -> openedx.core.djangoapps.discussions.utils + # -> lms.djangoapps.courseware.access + "openedx.core.djangoapps.discussions.utils -> lms.djangoapps.courseware.access", + # cms.djangoapps.contentstore.[various] + # -> openedx.features.content_type_gating.partitions + # -> openedx.features.discounts.utils + # -> openedx.features.discounts.applicability + # -> lms.djangoapps.courseware.toggles + # & lms.djangoapps.courseware.utils + # & lms.djangoapps.experiments.models + # & lms.djangoapps.experiments.stable_bucketing + "openedx.features.discounts.applicability -> lms.djangoapps.courseware.*", + "openedx.features.discounts.applicability -> lms.djangoapps.experiments.*", + # cms.djangoapps.contentstore.[various] + # -> openedx.core.djangoapps.content.learning_sequences.api + # -> openedx.core.djangoapps.content.learning_sequences.api.outlines + # -> openedx.core.djangoapps.content.learning_sequences.api.permissions + # -> lms.djangoapps.courseware.access + "openedx.core.djangoapps.content.learning_sequences.api.permissions -> lms.djangoapps.courseware.access", + # cms.djangoapps.contentstore.[various] + # -> openedx.features.content_type_gating.partitions + # -> openedx.features.discounts.utils + # -> openedx.features.discounts.applicability + # -> openedx.features.enterprise_support.utils + "openedx.features.enterprise_support.utils -> lms.djangoapps.branding.api", + "cms.djangoapps.contentstore.rest_api.v1.views.settings -> lms.djangoapps.certificates.api", + # We are ignoring this existing import until we can refactor contenstore/helpers. + # https://github.com/openedx/edx-platform/issues/37637 + "openedx.core.djangoapps.content_libraries.api.libraries -> cms.djangoapps.contentstore.helpers", + "openedx.core.djangoapps.content_libraries.api.blocks -> cms.djangoapps.contentstore.helpers", + "openedx.core.djangoapps.content_staging.serializers -> cms.djangoapps.contentstore.helpers", + # These imports will become OK once we move content_libraries into CMS + # https://github.com/openedx/edx-platform/issues/33428 + "openedx.core.djangoapps.content_libraries.permissions -> cms.djangoapps.course_creators.views", + "openedx.core.djangoapps.content_libraries.tasks -> cms.djangoapps.contentstore.storage", + # Outstanding arch issue: course_overviews is tangled up with LMS + # https://github.com/openedx/edx-platform/issues/37658 + "openedx.core.djangoapps.content.course_overviews.models -> lms.djangoapps.**", + # Outstanding arch issue: content_highlights uses courseware block_render + # https://github.com/openedx/edx-platform/issues/37659 + "openedx.core.djangoapps.schedules.content_highlights -> lms.djangoapps.courseware.block_render", +] + +[[tool.importlinter.contracts]] +name = "Do not depend on non-public API of isolated apps." +type = "isolated_apps" +isolated_apps = [ + "cms.djangoapps.modulestore_migrator", + "openedx.core.djangoapps.agreements", + "openedx.core.djangoapps.bookmarks", + "openedx.core.djangoapps.content_libraries", + "openedx.core.djangoapps.content_staging", + "openedx.core.djangoapps.olx_rest_api", + "openedx.core.djangoapps.xblock", + "openedx.core.lib.xblock_serializer", + "openedx_catalog", +] +allowed_modules = [ + # Only imports from api.py and data.py are allowed elsewhere in the code + # See https://open-edx-proposals.readthedocs.io/en/latest/best-practices/oep-0049-django-app-patterns.html#api-py + "api", + "models_api", + "data", + "tests", +] + +[[tool.importlinter.contracts]] +name = "Do not directly import internals of openedx_content (only import from openedx_content.api)." +type = "forbidden" +source_modules = ["cms", "lms", "openedx", "common", "xmodule"] +forbidden_modules = ["openedx_content.applets", "openedx_content.backcompat"] +allow_indirect_imports = true + +[[tool.importlinter.contracts]] +name = "Low-level apps should not depend on high-level apps" +type = "layers" +layers = [ + # Layers from high-level to low-level. Imports should only occur from higher to lower. + "cms.lib.xblock.upstream_sync | openedx.core.djangoapps.content.search | openedx.core.djangoapps.olx_rest_api", + "openedx.core.djangoapps.content_libraries", + "openedx.core.djangoapps.content_staging", + "openedx.core.djangoapps.xblock", + "openedx.core.lib.xblock_serializer", + "openedx.core.djangoapps.content_tagging", +] +ignore_imports = [ + # Test code can break these layering rules + "**.tests.** -> **", + # FIXME: the exceptions below are from before we added this import linting rule. Should refactor to eliminate them. + # In particular, the contentstore.helpers module is too big and has too many imports + # See https://github.com/openedx/edx-platform/issues/37637 + # The CSV export hard-codes support for courses and libraries. Refactor to do something like learning_context.get_children() + "openedx.core.djangoapps.content_tagging.helpers.objecttag_export_helpers -> openedx.core.djangoapps.content_libraries.api", + # The permissions checking code for tagging requires libraries model data to get all the orgs that a user is using: + "openedx.core.djangoapps.content_tagging.utils -> openedx.core.djangoapps.content_libraries.api", + # Content staging POST to clipboard API uses libraries APIs. We're working on moving this code to content_libraries + "openedx.core.djangoapps.content_staging.views -> openedx.core.djangoapps.content_libraries.api", + # content_staging.serializers imports contentstore.helpers which imports contentstore.utils which imports the libraries API. + "openedx.core.djangoapps.content_staging.serializers -> cms.djangoapps.contentstore.helpers", + # content_libraries.rest_api.libraries imports cms.djangoapps.contentstore.views.course which imports + # contentstore.toggles which imports djangoapps.content.search.api + "openedx.core.djangoapps.content_libraries.rest_api.libraries -> cms.djangoapps.contentstore.views.course", + # Content libraries imports contentstore.helpers which imports upstream_sync + "openedx.core.djangoapps.content_libraries.api.blocks -> cms.djangoapps.contentstore.helpers", + "openedx.core.djangoapps.content_libraries.api.libraries -> cms.djangoapps.contentstore.helpers", + # Outstanding arch issue: course_overviews is tangled up with LMS + # https://github.com/openedx/edx-platform/issues/37658 + "openedx.core.djangoapps.content.course_overviews.models -> lms.djangoapps.**", + # Outstanding arch issue: content_highlights uses courseware block_render + # https://github.com/openedx/edx-platform/issues/37659 + "openedx.core.djangoapps.schedules.content_highlights -> lms.djangoapps.courseware.block_render", + # This import happens only because grading signals are defined in LMS rather than openedx-events + # https://github.com/openedx/edx-platform/issues/37660 + "openedx.core.djangoapps.xblock.runtime.runtime -> lms.djangoapps.grades.api", + # These imports will become OK once we worked on the following issue: + # https://github.com/openedx/edx-platform/issues/33428 + "openedx.core.djangoapps.video_config.services -> openedx.core.djangoapps.content_libraries.api", +] diff --git a/requirements/constraints.txt b/requirements/constraints.txt index 5b0bb207a83a..66f992bbcc05 100644 --- a/requirements/constraints.txt +++ b/requirements/constraints.txt @@ -44,7 +44,7 @@ django-stubs<6 # The team that owns this package will manually bump this package rather than having it pulled in automatically. # This is to allow them to better control its deployment and to do it in a process that works better # for them. -edx-enterprise==6.6.3 +edx-enterprise==8.0.18 # Date: 2023-07-26 # Our legacy Sass code is incompatible with anything except this ancient libsass version. @@ -54,16 +54,17 @@ edx-enterprise==6.6.3 libsass==0.10.0 # Date: 2024-07-16 -# We need to upgrade the version of elasticsearch to atleast 7.15 before we can upgrade to Numpy 2.0.0 +# We need to upgrade the version of elasticsearch to at least 7.15 before we can upgrade to Numpy 2.0.0 # Otherwise we see a failure while running the following command: # export DJANGO_SETTINGS_MODULE=cms.envs.test; python manage.py cms check_reserved_keywords --override_file db_keyword_overrides.yml --report_path reports/reserved_keywords --report_file cms_reserved_keyword_report.csv # Issue for unpinning: https://github.com/openedx/edx-platform/issues/35126 numpy<2.0.0 # Date: 2023-09-18 -# pinning this version to avoid updates while the library is being developed +# Library is still in active development. Major versions require review +# from openedx-maintainers. Minor and patch versions can roll out automatically. # Issue for unpinning: https://github.com/openedx/edx-platform/issues/35269 -openedx-learning==0.31.0 +openedx-core<2 # Date: 2023-11-29 # Open AI version 1.0.0 dropped support for openai.ChatCompletion which is currently in use in enterprise. @@ -76,11 +77,6 @@ openai<=0.28.1 # Issue for unpinning: https://github.com/openedx/edx-platform/issues/35267 path<16.12.0 -# Date: 2022-08-03 -# pycodestyle==2.9.0 generates false positive error E275. -# Constraint can be removed once the issue https://github.com/PyCQA/pycodestyle/issues/1090 is fixed. -pycodestyle<2.9.0 - # Date: 2021-08-25 # At the time of writing this comment, we do not know whether py2neo>=2022 # will support our currently-deployed Neo4j version (3.5). @@ -128,17 +124,6 @@ xmlsec==1.3.14 # Pin this back to the previous version until that bug is fixed. django-debug-toolbar<6.0.0 -# Date 2025-10-07 -# Cryptography 46.0.0 conflicts with system dependencies needed for snowflake-connector-python -# snowflake-connector-python comes as a dependency of edx-enterprise so it can not be directly pinned here. -# See issue https://github.com/openedx/edx-platform/issues/37417 for details on this. -# This can be unpinned once snowflake-connector-python==4.0.0 is available (contains the fix). -# pact-python==3.0.0 also removes cffi dependency and is causing the upgrade build to fail -# This should also be removed together with cryptography constraint. -# Issue: https://github.com/openedx/edx-platform/issues/37435 -cryptography<46.0.0 -pact-python<3.0.0 - # Date 2026-01-13 # Sphinx-autoapi changed the version of astroid it needs # but the newer version is not compatible with the current pylint version @@ -147,3 +132,21 @@ pact-python<3.0.0 # https://github.com/openedx/edx-platform/issues/37880 sphinx-autoapi<3.6.1 +# Date 2026-03-02 +# setuptools 82.0.0 removed pkg_resources from its distribution, but fs (pyfilesystem2) +# still uses pkg_resources for namespace package declarations. This constraint can be +# removed once pyfilesystem2 drops its pkg_resources usage. +# https://github.com/PyFilesystem/pyfilesystem2/issues/577 +# Issue for unpinning: https://github.com/openedx/openedx-platform/issues/38068 +setuptools<82 + +# Date 2026-03-02 +# The latest version of pylint pins back astroid to an older version. +# This holdback is not caught in the docs requirements file and since both the docs +# and testing file are required in the development.in file, we fail to compile +# development.txt because of conflicting dependencies. +# +# Holding astroid back until pylint releases a new version that works with the latest +# version of astroid. +# https://github.com/openedx/openedx-platform/issues/38066 +astroid==4.0.4 diff --git a/requirements/edx-sandbox/README.rst b/requirements/edx-sandbox/README.rst index d4b1ab8199a1..96c90ee911f4 100644 --- a/requirements/edx-sandbox/README.rst +++ b/requirements/edx-sandbox/README.rst @@ -92,3 +92,18 @@ releases/ulmo.txt * SciPy is upgraded from 1.15.2 to 1.16.3 .. _SciPy changelog: https://docs.scipy.org/doc/scipy/release.html + +releases/verawood.txt +--------------------- + +* Frozen at the time of the Verawood release +* BREAKING CHANGE: Drops support for Python 3.11 +* Supports Python 3.12 +* NumPy is upgraded to 1.26.4 +* SciPy is upgraded to 1.17.1 +* Several other libraries (such as matplotlib, nltk, sympy) have also been updated + to newer versions. These upgrades continue improvements for Python 3.12 + compatibility and include minor dependency refreshes. + +.. _SciPy changelog: https://docs.scipy.org/doc/scipy/release.html +.. _NumPy changelog: https://numpy.org/doc/stable/release.html diff --git a/requirements/edx-sandbox/base.txt b/requirements/edx-sandbox/base.txt index 2f425ed943d6..65424f445469 100644 --- a/requirements/edx-sandbox/base.txt +++ b/requirements/edx-sandbox/base.txt @@ -1,5 +1,5 @@ # -# This file is autogenerated by pip-compile with Python 3.11 +# This file is autogenerated by pip-compile with Python 3.12 # by the following command: # # make upgrade @@ -8,23 +8,21 @@ cffi==2.0.0 # via cryptography chem==2.0.0 # via -r requirements/edx-sandbox/base.in -click==8.3.1 +click==8.4.1 # via nltk codejail-includes==2.0.0 # via -r requirements/edx-sandbox/base.in contourpy==1.3.3 # via matplotlib -cryptography==45.0.7 - # via - # -c requirements/constraints.txt - # -r requirements/edx-sandbox/base.in +cryptography==49.0.0 + # via -r requirements/edx-sandbox/base.in cycler==0.12.1 # via matplotlib -fonttools==4.61.1 +fonttools==4.63.0 # via matplotlib joblib==1.5.3 # via nltk -kiwisolver==1.4.9 +kiwisolver==1.5.0 # via matplotlib lxml[html-clean]==5.3.2 # via @@ -32,19 +30,19 @@ lxml[html-clean]==5.3.2 # -r requirements/edx-sandbox/base.in # lxml-html-clean # openedx-calc -lxml-html-clean==0.4.3 +lxml-html-clean==0.4.4 # via lxml markupsafe==3.0.3 # via # chem # openedx-calc -matplotlib==3.10.8 +matplotlib==3.11.0 # via -r requirements/edx-sandbox/base.in mpmath==1.3.0 # via sympy networkx==3.6.1 # via -r requirements/edx-sandbox/base.in -nltk==3.9.2 +nltk==3.9.4 # via # -r requirements/edx-sandbox/base.in # chem @@ -56,15 +54,15 @@ numpy==1.26.4 # matplotlib # openedx-calc # scipy -openedx-calc==4.0.3 +openedx-calc==5.0.0 # via -r requirements/edx-sandbox/base.in -packaging==25.0 +packaging==26.2 # via matplotlib -pillow==12.1.0 +pillow==12.2.0 # via matplotlib -pycparser==2.23 +pycparser==3.0 # via cffi -pyparsing==3.3.1 +pyparsing==3.3.2 # via # -r requirements/edx-sandbox/base.in # chem @@ -74,9 +72,9 @@ python-dateutil==2.9.0.post0 # via matplotlib random2==1.0.2 # via -r requirements/edx-sandbox/base.in -regex==2026.1.15 +regex==2026.5.9 # via nltk -scipy==1.17.0 +scipy==1.17.1 # via # -r requirements/edx-sandbox/base.in # chem @@ -86,5 +84,5 @@ sympy==1.14.0 # via # -r requirements/edx-sandbox/base.in # openedx-calc -tqdm==4.67.1 +tqdm==4.68.2 # via nltk diff --git a/requirements/edx-sandbox/releases/verawood.txt b/requirements/edx-sandbox/releases/verawood.txt new file mode 100644 index 000000000000..d3582beab566 --- /dev/null +++ b/requirements/edx-sandbox/releases/verawood.txt @@ -0,0 +1,88 @@ +# +# This file is autogenerated by pip-compile with Python 3.12 +# by the following command: +# +# make upgrade +# +cffi==2.0.0 + # via cryptography +chem==2.0.0 + # via -r requirements/edx-sandbox/base.in +click==8.3.3 + # via nltk +codejail-includes==2.0.0 + # via -r requirements/edx-sandbox/base.in +contourpy==1.3.3 + # via matplotlib +cryptography==47.0.0 + # via -r requirements/edx-sandbox/base.in +cycler==0.12.1 + # via matplotlib +fonttools==4.62.1 + # via matplotlib +joblib==1.5.3 + # via nltk +kiwisolver==1.5.0 + # via matplotlib +lxml[html-clean]==5.3.2 + # via + # -c requirements/constraints.txt + # -r requirements/edx-sandbox/base.in + # lxml-html-clean + # openedx-calc +lxml-html-clean==0.4.4 + # via lxml +markupsafe==3.0.3 + # via + # chem + # openedx-calc +matplotlib==3.10.9 + # via -r requirements/edx-sandbox/base.in +mpmath==1.3.0 + # via sympy +networkx==3.6.1 + # via -r requirements/edx-sandbox/base.in +nltk==3.9.4 + # via + # -r requirements/edx-sandbox/base.in + # chem +numpy==1.26.4 + # via + # -c requirements/constraints.txt + # chem + # contourpy + # matplotlib + # openedx-calc + # scipy +openedx-calc==5.0.0 + # via -r requirements/edx-sandbox/base.in +packaging==26.2 + # via matplotlib +pillow==12.2.0 + # via matplotlib +pycparser==3.0 + # via cffi +pyparsing==3.3.2 + # via + # -r requirements/edx-sandbox/base.in + # chem + # matplotlib + # openedx-calc +python-dateutil==2.9.0.post0 + # via matplotlib +random2==1.0.2 + # via -r requirements/edx-sandbox/base.in +regex==2026.4.4 + # via nltk +scipy==1.17.1 + # via + # -r requirements/edx-sandbox/base.in + # chem +six==1.17.0 + # via python-dateutil +sympy==1.14.0 + # via + # -r requirements/edx-sandbox/base.in + # openedx-calc +tqdm==4.67.3 + # via nltk diff --git a/requirements/edx/assets.txt b/requirements/edx/assets.txt index 6a9f78f0bad0..fdc80ce99af4 100644 --- a/requirements/edx/assets.txt +++ b/requirements/edx/assets.txt @@ -1,10 +1,10 @@ # -# This file is autogenerated by pip-compile with Python 3.11 +# This file is autogenerated by pip-compile with Python 3.12 # by the following command: # # make upgrade # -click==8.3.1 +click==8.4.1 # via -r requirements/edx/assets.in libsass==0.10.0 # via diff --git a/requirements/edx/base.txt b/requirements/edx/base.txt index 34b93fc2878d..67fd046da98e 100644 --- a/requirements/edx/base.txt +++ b/requirements/edx/base.txt @@ -1,14 +1,14 @@ # -# This file is autogenerated by pip-compile with Python 3.11 +# This file is autogenerated by pip-compile with Python 3.12 # by the following command: # # make upgrade # acid-xblock==0.4.1 # via -r requirements/edx/kernel.in -aiohappyeyeballs==2.6.1 +aiohappyeyeballs==2.6.2 # via aiohttp -aiohttp==3.13.3 +aiohttp==3.14.1 # via geoip2 aiosignal==1.4.0 # via aiohttp @@ -22,18 +22,18 @@ aniso8601==10.0.1 # tincan annotated-types==0.7.0 # via pydantic -anyio==4.12.1 +anyio==4.14.0 # via httpx appdirs==1.4.4 # via fs -asgiref==3.11.0 +asgiref==3.11.1 # via # django # django-cors-headers # django-countries asn1crypto==1.5.1 # via snowflake-connector-python -attrs==25.4.0 +attrs==26.1.0 # via # -r requirements/edx/kernel.in # aiohttp @@ -41,10 +41,10 @@ attrs==25.4.0 # jsonschema # lti-consumer-xblock # openedx-authz + # openedx-core # openedx-events - # openedx-learning # referencing -babel==2.17.0 +babel==2.18.0 # via # -r requirements/edx/kernel.in # enmerkar @@ -53,13 +53,14 @@ backoff==1.10.0 # via analytics-python bcrypt==5.0.0 # via paramiko -beautifulsoup4==4.14.3 +beautifulsoup4==4.15.0 # via # openedx-forum # pynliner + # xblocks-contrib billiard==4.2.4 # via celery -bleach[css]==6.3.0 +bleach[css]==6.4.0 # via # edx-enterprise # lti-consumer-xblock @@ -67,14 +68,14 @@ bleach[css]==6.3.0 # ora2 # xblock-drag-and-drop-v2 # xblock-poll -boto3==1.42.30 +boto3==1.43.30 # via # -r requirements/edx/kernel.in # django-ses # fs-s3fs # ora2 # snowflake-connector-python -botocore==1.42.30 +botocore==1.43.30 # via # -r requirements/edx/kernel.in # boto3 @@ -86,13 +87,13 @@ bridgekeeper==0.9 # via -r requirements/edx/kernel.in cachecontrol==0.14.4 # via firebase-admin -cachetools==6.2.4 +cachetools==7.1.4 # via edxval -camel-converter[pydantic]==5.0.0 +camel-converter[pydantic]==5.1.0 # via meilisearch casbin-django-orm-adapter==1.7.0 # via openedx-authz -celery==5.6.2 +celery==5.6.3 # via # -c requirements/constraints.txt # -r requirements/edx/kernel.in @@ -102,8 +103,8 @@ celery==5.6.2 # edx-enterprise # enterprise-integrated-channels # event-tracking - # openedx-learning -certifi==2026.1.4 + # openedx-core +certifi==2026.5.20 # via # elasticsearch # httpcore @@ -114,15 +115,19 @@ cffi==2.0.0 # via # cryptography # pynacl -chardet==5.2.0 - # via pysrt -charset-normalizer==3.4.4 +chardet==7.4.3 + # via + # encutils + # pysrt +charset-normalizer==3.4.7 # via # requests # snowflake-connector-python chem==2.0.0 - # via -r requirements/edx/kernel.in -click==8.3.1 + # via + # -r requirements/edx/kernel.in + # xblocks-contrib +click==8.4.1 # via # celery # click-didyoumean @@ -137,27 +142,28 @@ click-plugins==1.1.1.2 # via celery click-repl==0.3.0 # via celery -code-annotations==2.3.0 +code-annotations==3.0.0 # via # edx-enterprise # edx-toggles codejail-includes==2.0.0 # via -r requirements/edx/kernel.in -crowdsourcehinter-xblock==0.8 +crowdsourcehinter-xblock==1.0.1 # via -r requirements/edx/bundled.in -cryptography==45.0.7 +cryptography==49.0.0 # via - # -c requirements/constraints.txt # -r requirements/edx/kernel.in # django-fernet-fields-v2 # edx-enterprise + # google-auth # jwcrypto # paramiko # pgpy # pyjwt # pyopenssl # snowflake-connector-python -cssutils==2.11.1 + # social-auth-core +cssutils==2.15.0 # via pynliner defusedxml==0.7.1 # via @@ -166,7 +172,8 @@ defusedxml==0.7.1 # ora2 # python3-openid # social-auth-core -django==5.2.11 + # xblocks-contrib +django==5.2.15 # via # -c requirements/common_constraints.txt # -c requirements/constraints.txt @@ -231,20 +238,21 @@ django==5.2.11 # jsonfield # lti-consumer-xblock # openedx-authz + # openedx-core # openedx-django-pyfs # openedx-django-wiki # openedx-events # openedx-filters # openedx-forum - # openedx-learning # ora2 # social-auth-app-django # super-csv # xblock-google-drive + # xblocks-contrib # xss-utils django-appconf==1.2.0 # via django-statici18n -django-autocomplete-light==3.12.1 +django-autocomplete-light==4.0.1 # via -r requirements/edx/kernel.in django-cache-memoize==0.2.1 # via edx-enterprise @@ -252,7 +260,7 @@ django-celery-results==2.6.0 # via -r requirements/edx/kernel.in django-classy-tags==4.1.0 # via django-sekizai -django-config-models==2.9.0 +django-config-models==3.0.0 # via # -r requirements/edx/kernel.in # edx-enterprise @@ -260,7 +268,7 @@ django-config-models==2.9.0 # lti-consumer-xblock django-cors-headers==4.9.0 # via -r requirements/edx/kernel.in -django-countries==8.2.0 +django-countries==9.0.0 # via # -r requirements/edx/kernel.in # edx-enterprise @@ -272,6 +280,7 @@ django-crum==0.7.9 # edx-proctoring # edx-rbac # edx-toggles + # openedx-authz # super-csv django-fernet-fields-v2==0.9 # via @@ -287,7 +296,7 @@ django-ipware==7.0.1 # -r requirements/edx/kernel.in # edx-enterprise # edx-proctoring -django-js-asset==3.1.2 +django-js-asset==4.0.1 # via django-mptt django-method-override==1.0.4 # via -r requirements/edx/kernel.in @@ -323,7 +332,7 @@ django-oauth-toolkit==1.7.1 # -r requirements/edx/kernel.in # edx-enterprise # enterprise-integrated-channels -django-object-actions==5.0.0 +django-object-actions==5.1.2 # via # edx-enterprise # enterprise-integrated-channels @@ -337,7 +346,7 @@ django-sekizai==4.1.0 # via # -r requirements/edx/kernel.in # openedx-django-wiki -django-ses==4.6.0 +django-ses==4.7.2 # via -r requirements/edx/bundled.in django-simple-history==3.11.0 # via @@ -347,18 +356,17 @@ django-simple-history==3.11.0 # edx-proctoring # enterprise-integrated-channels # ora2 -django-statici18n==2.6.0 +django-statici18n==2.7.1 # via # -r requirements/edx/kernel.in # lti-consumer-xblock # xblock-drag-and-drop-v2 # xblock-poll - # xblocks-contrib django-storages==1.14.6 # via # -r requirements/edx/kernel.in # edxval -django-user-tasks==3.4.4 +django-user-tasks==4.0.0 # via -r requirements/edx/kernel.in django-waffle==5.0.0 # via @@ -368,11 +376,12 @@ django-waffle==5.0.0 # edx-enterprise # edx-proctoring # edx-toggles -django-webpack-loader==3.2.3 + # openedx-authz +django-webpack-loader==3.2.4 # via # -r requirements/edx/kernel.in # edx-proctoring -djangorestframework==3.16.1 +djangorestframework==3.17.1 # via # -r requirements/edx/kernel.in # django-config-models @@ -388,33 +397,33 @@ djangorestframework==3.16.1 # edx-proctoring # edx-submissions # openedx-authz + # openedx-core # openedx-forum - # openedx-learning # ora2 # super-csv djangorestframework-xml==2.0.0 # via edx-enterprise dnspython==2.8.0 # via pymongo -done-xblock==2.5.0 +done-xblock==3.0.0 # via -r requirements/edx/bundled.in drf-jwt==1.19.2 # via edx-drf-extensions drf-spectacular==0.29.0 # via -r requirements/edx/kernel.in -drf-yasg==1.21.14 +drf-yasg==1.21.15 # via # django-user-tasks # edx-api-doc-tools edx-ace==1.15.0 # via -r requirements/edx/kernel.in -edx-api-doc-tools==2.1.0 +edx-api-doc-tools==3.0.0 # via # -r requirements/edx/kernel.in # openedx-authz -edx-auth-backends==4.6.2 +edx-auth-backends==5.0.0 # via -r requirements/edx/kernel.in -edx-bulk-grades==1.2.0 +edx-bulk-grades==2.0.0 # via # -r requirements/edx/kernel.in # staff-graded-xblock @@ -422,21 +431,24 @@ edx-ccx-keys==2.0.2 # via # -r requirements/edx/kernel.in # lti-consumer-xblock + # openedx-authz # openedx-events -edx-celeryutils==1.4.0 +edx-celeryutils==2.0.0 # via # -r requirements/edx/kernel.in # super-csv edx-codejail==4.1.0 - # via -r requirements/edx/kernel.in -edx-completion==4.9 + # via + # -r requirements/edx/kernel.in + # xblocks-contrib +edx-completion==5.0.0 # via -r requirements/edx/kernel.in edx-django-release-util==1.5.0 # via # -r requirements/edx/kernel.in # edx-submissions # edxval -edx-django-sites-extensions==5.1.0 +edx-django-sites-extensions==6.0.0 # via -r requirements/edx/kernel.in edx-django-utils==8.0.1 # via @@ -457,6 +469,7 @@ edx-django-utils==8.0.1 # openedx-events # ora2 # super-csv + # xblocks-contrib edx-drf-extensions==10.6.0 # via # -r requirements/edx/kernel.in @@ -469,23 +482,22 @@ edx-drf-extensions==10.6.0 # edxval # enterprise-integrated-channels # openedx-authz - # openedx-learning -edx-enterprise==6.6.3 + # openedx-core +edx-enterprise==8.0.18 # via # -c requirements/constraints.txt # -r requirements/edx/kernel.in edx-event-bus-kafka==6.1.0 # via -r requirements/edx/kernel.in -edx-event-bus-redis==0.6.1 +edx-event-bus-redis==1.0.0 # via -r requirements/edx/kernel.in -edx-i18n-tools==1.9.0 +edx-i18n-tools==2.0.0 # via # -r requirements/edx/bundled.in # ora2 - # xblocks-contrib -edx-milestones==1.1.0 +edx-milestones==2.0.0 # via -r requirements/edx/kernel.in -edx-opaque-keys[django]==3.0.0 +edx-opaque-keys[django]==4.0.0 # via # -r requirements/edx/kernel.in # edx-bulk-grades @@ -503,34 +515,39 @@ edx-opaque-keys[django]==3.0.0 # openedx-events # openedx-filters # ora2 + # xblock # xblocks-contrib -edx-organizations==7.3.0 - # via -r requirements/edx/kernel.in +edx-organizations==8.0.0 + # via + # -r requirements/edx/kernel.in + # openedx-authz + # openedx-core edx-proctoring==5.2.0 # via -r requirements/edx/kernel.in -edx-rbac==2.1.0 +edx-rbac==3.0.0 # via # edx-enterprise # enterprise-integrated-channels -edx-rest-api-client==6.2.0 +edx-rest-api-client==7.0.0 # via # -r requirements/edx/kernel.in # edx-enterprise # edx-proctoring # enterprise-integrated-channels -edx-search==4.4.0 +edx-search==5.0.1 # via # -r requirements/edx/kernel.in # openedx-forum -edx-sga==0.27.0 +edx-sga==0.28.0 # via -r requirements/edx/bundled.in -edx-submissions==3.12.2 +edx-submissions==4.0.0 # via # -r requirements/edx/kernel.in # ora2 + # xblocks-contrib edx-tincan-py35==2.0.0 # via enterprise-integrated-channels -edx-toggles==5.4.1 +edx-toggles==6.0.0 # via # -r requirements/edx/kernel.in # edx-auth-backends @@ -542,35 +559,40 @@ edx-toggles==5.4.1 # edxval # event-tracking # ora2 -edx-when==3.1.0 + # xblocks-contrib +edx-when==4.0.0 # via # -r requirements/edx/kernel.in # edx-proctoring -edxval==3.2.0 - # via -r requirements/edx/kernel.in +edxval==4.0.1 + # via + # -r requirements/edx/kernel.in + # xblocks-contrib elasticsearch==7.9.1 # via # -c requirements/common_constraints.txt # -c requirements/constraints.txt # edx-search # openedx-forum +encutils==1.0.0 + # via cssutils enmerkar==0.7.1 # via enmerkar-underscore enmerkar-underscore==2.4.0 # via -r requirements/edx/kernel.in -enterprise-integrated-channels==0.1.38 +enterprise-integrated-channels==0.1.60 # via -r requirements/edx/bundled.in -event-tracking==3.3.0 +event-tracking==4.0.2 # via # -r requirements/edx/kernel.in # edx-completion # edx-proctoring # edx-search -fastavro==1.12.1 +fastavro==1.12.2 # via openedx-events -filelock==3.20.3 +filelock==3.29.4 # via snowflake-connector-python -firebase-admin==7.1.0 +firebase-admin==7.4.0 # via edx-ace frozenlist==1.8.0 # via @@ -582,6 +604,7 @@ fs==2.4.16 # fs-s3fs # openedx-django-pyfs # xblock + # xblocks-contrib fs-s3fs==1.1.1 # via # -r requirements/edx/kernel.in @@ -590,49 +613,50 @@ geoip2==5.2.0 # via -r requirements/edx/kernel.in glob2==0.7 # via -r requirements/edx/kernel.in -google-api-core[grpc]==2.29.0 +google-api-core[grpc]==2.31.0 # via # firebase-admin # google-cloud-core # google-cloud-firestore # google-cloud-storage -google-auth==2.47.0 +google-auth==2.55.0 # via # google-api-core # google-cloud-core # google-cloud-firestore # google-cloud-storage -google-cloud-core==2.5.0 +google-cloud-core==2.6.0 # via # google-cloud-firestore # google-cloud-storage -google-cloud-firestore==2.23.0 +google-cloud-firestore==2.27.0 # via firebase-admin -google-cloud-storage==3.8.0 +google-cloud-storage==3.12.0 # via firebase-admin google-crc32c==1.8.0 # via # google-cloud-storage # google-resumable-media -google-resumable-media==2.8.0 +google-resumable-media==2.10.0 # via google-cloud-storage -googleapis-common-protos==1.72.0 +googleapis-common-protos==1.75.0 # via # google-api-core # grpcio-status -grpcio==1.76.0 +grpcio==1.81.1 # via # google-api-core + # google-cloud-firestore # grpcio-status -grpcio-status==1.76.0 +grpcio-status==1.81.1 # via google-api-core -gunicorn==23.0.0 +gunicorn==26.0.0 # via -r requirements/edx/kernel.in h11==0.16.0 # via httpcore h2==4.3.0 # via httpx -help-tokens==3.2.0 +help-tokens==4.0.0 # via -r requirements/edx/kernel.in hpack==4.1.0 # via h2 @@ -640,15 +664,18 @@ html5lib==1.1 # via # -r requirements/edx/kernel.in # ora2 + # xblocks-contrib httpcore==1.0.9 # via httpx httpx[http2]==0.28.1 - # via firebase-admin + # via + # firebase-admin + # typesense hyperframe==6.1.0 # via h2 -icalendar==6.3.2 +icalendar==7.1.3 # via -r requirements/edx/kernel.in -idna==3.11 +idna==3.18 # via # anyio # httpx @@ -656,13 +683,13 @@ idna==3.11 # requests # snowflake-connector-python # yarl -importlib-metadata==8.7.1 +importlib-metadata==9.0.0 # via -r requirements/edx/kernel.in inflection==0.5.1 # via # drf-spectacular # drf-yasg -invoke==2.2.1 +invoke==3.0.3 # via paramiko ipaddress==1.0.23 # via -r requirements/edx/kernel.in @@ -670,7 +697,7 @@ isodate==0.7.2 # via python3-saml jinja2==3.1.6 # via code-annotations -jmespath==1.0.1 +jmespath==1.1.0 # via # boto3 # botocore @@ -694,7 +721,7 @@ jsonschema==4.26.0 # optimizely-sdk jsonschema-specifications==2025.9.1 # via jsonschema -jwcrypto==1.5.6 +jwcrypto==1.5.7 # via # django-oauth-toolkit # pylti1p3 @@ -708,14 +735,13 @@ lazy==1.6 # lti-consumer-xblock # ora2 # xblock -loremipsum==1.0.5 - # via ora2 -lti-consumer-xblock==9.14.3 +lti-consumer-xblock==11.3.1 # via -r requirements/edx/kernel.in lxml[html-clean]==5.3.2 # via # -c requirements/constraints.txt # -r requirements/edx/kernel.in + # edx-enterprise # edx-i18n-tools # edxval # lti-consumer-xblock @@ -725,19 +751,20 @@ lxml[html-clean]==5.3.2 # ora2 # python3-saml # xblock + # xblocks-contrib # xmlsec -lxml-html-clean==0.4.3 +lxml-html-clean==0.4.4 # via lxml mailsnake==1.6.4 # via -r requirements/edx/bundled.in -mako==1.3.10 +mako==1.3.12 # via # -r requirements/edx/kernel.in # acid-xblock # lti-consumer-xblock # xblock # xblock-utils -markdown==3.10 +markdown==3.10.2 # via # -r requirements/edx/kernel.in # openedx-django-wiki @@ -750,35 +777,36 @@ markupsafe==3.0.3 # mako # openedx-calc # xblock -maxminddb==3.0.0 + # xblocks-contrib +maxminddb==3.1.1 # via geoip2 -meilisearch==0.40.0 +meilisearch==0.41.0 # via # -r requirements/edx/kernel.in # edx-search -mongoengine==0.29.1 +mongoengine==0.29.3 # via -r requirements/edx/kernel.in monotonic==1.6 # via analytics-python -more-itertools==10.8.0 +more-itertools==11.1.0 # via cssutils mpmath==1.3.0 # via sympy -msgpack==1.1.2 +msgpack==1.2.0 # via cachecontrol -multidict==6.7.0 +multidict==6.7.1 # via # aiohttp # yarl -mysqlclient==2.2.7 +mysqlclient==2.2.8 # via # -r requirements/edx/kernel.in # openedx-forum -nh3==0.3.2 +nh3==0.3.5 # via # -r requirements/edx/kernel.in # xblocks-contrib -nltk==3.9.2 +nltk==3.9.4 # via chem nodeenv==1.10.0 # via -r requirements/edx/kernel.in @@ -789,6 +817,7 @@ numpy==1.26.4 # openedx-calc # scipy # shapely + # xblocks-contrib oauthlib==3.3.1 # via # -r requirements/edx/kernel.in @@ -806,49 +835,53 @@ openedx-atlas==0.7.0 # enterprise-integrated-channels # openedx-authz # openedx-forum -openedx-authz==0.20.0 - # via -r requirements/edx/kernel.in -openedx-calc==4.0.3 +openedx-authz==1.16.0 # via -r requirements/edx/kernel.in -openedx-django-pyfs==3.8.0 +openedx-calc==5.0.0 # via - # lti-consumer-xblock - # xblock + # -r requirements/edx/kernel.in # xblocks-contrib +openedx-core==1.1.0 + # via + # -c requirements/constraints.txt + # -r requirements/edx/kernel.in +openedx-django-pyfs==4.0.0 + # via xblock openedx-django-require==3.0.0 # via -r requirements/edx/kernel.in -openedx-django-wiki==3.1.1 +openedx-django-wiki==3.1.2 # via -r requirements/edx/kernel.in -openedx-events==10.5.0 +openedx-events==11.2.0 # via # -r requirements/edx/kernel.in # edx-enterprise # edx-event-bus-kafka # edx-event-bus-redis # event-tracking + # lti-consumer-xblock + # openedx-authz + # openedx-core # ora2 -openedx-filters==2.1.0 +openedx-filters==3.4.1 # via # -r requirements/edx/kernel.in + # edx-enterprise # lti-consumer-xblock # ora2 -openedx-forum==0.4.0 +openedx-forum==0.4.3 # via -r requirements/edx/kernel.in -openedx-learning==0.31.0 - # via - # -c requirements/constraints.txt - # -r requirements/edx/kernel.in -optimizely-sdk==5.4.0 +optimizely-sdk==5.5.0 # via -r requirements/edx/bundled.in -ora2==6.17.1 +ora2==7.0.0 # via -r requirements/edx/bundled.in -packaging==25.0 +packaging==26.2 # via # drf-yasg # gunicorn # kombu # snowflake-connector-python -paramiko==4.0.0 + # wheel +paramiko==5.0.0 # via edx-enterprise path==16.11.0 # via @@ -856,6 +889,7 @@ path==16.11.0 # -r requirements/edx/kernel.in # edx-i18n-tools # path-py + # xblocks-contrib path-py==12.5.0 # via # edx-enterprise @@ -865,62 +899,63 @@ pgpy==0.6.0 # via edx-enterprise piexif==1.1.3 # via -r requirements/edx/kernel.in -pillow==12.1.0 +pillow==12.2.0 # via # -r requirements/edx/kernel.in # edx-enterprise # edx-organizations # edxval -platformdirs==4.5.1 +platformdirs==4.10.0 # via snowflake-connector-python polib==1.2.0 # via edx-i18n-tools prompt-toolkit==3.0.52 # via click-repl -propcache==0.4.1 +propcache==0.5.2 # via # aiohttp # yarl -proto-plus==1.27.0 +proto-plus==1.28.0 # via # google-api-core # google-cloud-firestore -protobuf==6.33.4 +protobuf==7.35.1 # via # google-api-core # google-cloud-firestore # googleapis-common-protos # grpcio-status # proto-plus -psutil==7.2.1 +psutil==7.2.2 # via # -r requirements/edx/kernel.in # edx-django-utils -pyasn1==0.6.2 +psycopg2-binary==2.9.12 + # via -r requirements/edx/kernel.in +pyasn1==0.6.3 # via # pgpy # pyasn1-modules - # rsa pyasn1-modules==0.4.2 # via google-auth -pycasbin==2.7.1 +pycasbin==2.8.0 # via # casbin-django-orm-adapter # openedx-authz -pycountry==24.6.1 +pycountry==26.2.16 # via -r requirements/edx/kernel.in -pycparser==2.23 +pycparser==3.0 # via cffi pycryptodomex==3.23.0 # via # -r requirements/edx/kernel.in # edx-proctoring # lti-consumer-xblock -pydantic==2.12.5 +pydantic==2.13.4 # via camel-converter -pydantic-core==2.41.5 +pydantic-core==2.46.4 # via pydantic -pyjwt[crypto]==2.10.1 +pyjwt[crypto]==2.13.0 # via # -r requirements/edx/kernel.in # drf-jwt @@ -953,12 +988,13 @@ pynacl==1.6.2 # paramiko pynliner==0.8.0 # via -r requirements/edx/kernel.in -pyopenssl==25.3.0 +pyopenssl==26.3.0 # via snowflake-connector-python -pyparsing==3.3.1 +pyparsing==3.3.2 # via # chem # openedx-calc + # xblocks-contrib pyrsistent==0.20.0 # via optimizely-sdk pysrt==1.1.2 @@ -982,15 +1018,17 @@ python-ipware==3.0.0 # via django-ipware python-slugify==8.0.4 # via code-annotations -python-swiftclient==4.9.0 +python-swiftclient==4.10.0 # via ora2 python3-openid==3.2.0 ; python_version >= "3" # via # -r requirements/edx/kernel.in # social-auth-core python3-saml==1.16.0 - # via -r requirements/edx/kernel.in -pytz==2025.2 + # via + # -r requirements/edx/kernel.in + # edx-enterprise +pytz==2026.2 # via # -r requirements/edx/kernel.in # drf-yasg @@ -1006,6 +1044,7 @@ pytz==2025.2 # snowflake-connector-python # tincan # xblock + # xblocks-contrib pyuca==1.2 # via -r requirements/edx/kernel.in pyyaml==6.0.3 @@ -1019,10 +1058,12 @@ pyyaml==6.0.3 # jsondiff # xblock random2==1.0.2 - # via -r requirements/edx/kernel.in -recommender-xblock==3.1.0 + # via + # -r requirements/edx/kernel.in + # xblocks-contrib +recommender-xblock==5.0.0 # via -r requirements/edx/bundled.in -redis==7.1.0 +redis==8.0.0 # via # -r requirements/edx/kernel.in # walrus @@ -1030,9 +1071,9 @@ referencing==0.37.0 # via # jsonschema # jsonschema-specifications -regex==2026.1.15 +regex==2026.5.9 # via nltk -requests==2.32.5 +requests==2.34.2 # via # analytics-python # cachecontrol @@ -1057,41 +1098,43 @@ requests==2.32.5 # snowflake-connector-python # social-auth-core # xblock-google-drive + # xblocks-contrib requests-oauthlib==2.0.0 # via # -r requirements/edx/kernel.in # social-auth-core -rpds-py==0.30.0 +rpds-py==2026.5.1 # via # jsonschema # referencing -rsa==4.9.1 - # via google-auth rules==3.5 # via # -r requirements/edx/kernel.in # edx-enterprise # edx-proctoring - # openedx-learning -s3transfer==0.16.0 + # openedx-core +s3transfer==0.18.0 # via boto3 sailthru-client==2.2.3 # via edx-ace -scipy==1.17.0 +scipy==1.17.1 # via chem semantic-version==2.10.0 # via edx-drf-extensions shapely==2.1.2 - # via -r requirements/edx/kernel.in -simpleeval==1.0.3 + # via + # -r requirements/edx/kernel.in + # xblocks-contrib +simpleeval==1.0.7 # via pycasbin -simplejson==3.20.2 +simplejson==4.1.1 # via # -r requirements/edx/kernel.in # sailthru-client # super-csv # xblock # xblock-utils + # xblocks-contrib six==1.17.0 # via # -r requirements/edx/kernel.in @@ -1115,21 +1158,20 @@ slumber==0.7.1 # edx-bulk-grades # edx-enterprise # enterprise-integrated-channels -snowflake-connector-python==4.2.0 - # via - # edx-enterprise - # enterprise-integrated-channels +snowflake-connector-python==4.6.0 + # via enterprise-integrated-channels social-auth-app-django==5.4.1 # via # -c requirements/constraints.txt # -r requirements/edx/kernel.in # edx-auth-backends -social-auth-core==4.8.3 + # edx-enterprise +social-auth-core==4.9.1 # via # -r requirements/edx/kernel.in # edx-auth-backends # social-auth-app-django -sorl-thumbnail==12.11.0 +sorl-thumbnail==13.0.0 # via # -r requirements/edx/kernel.in # openedx-django-wiki @@ -1137,13 +1179,13 @@ sortedcontainers==2.4.0 # via # -r requirements/edx/kernel.in # snowflake-connector-python -soupsieve==2.8.3 +soupsieve==2.8.4 # via beautifulsoup4 sqlparse==0.5.5 # via django -staff-graded-xblock==3.1.0 +staff-graded-xblock==4.0.1 # via -r requirements/edx/bundled.in -stevedore==5.6.0 +stevedore==5.8.0 # via # -r requirements/edx/kernel.in # code-annotations @@ -1151,32 +1193,38 @@ stevedore==5.6.0 # edx-django-utils # edx-enterprise # edx-opaque-keys -super-csv==4.1.0 +super-csv==5.0.0 # via edx-bulk-grades sympy==1.14.0 # via openedx-calc -testfixtures==10.0.0 +testfixtures==12.1.0 # via edx-enterprise text-unidecode==1.3 # via python-slugify tincan==1.0.0 # via edx-enterprise -tinycss2==1.4.0 +tinycss2==1.5.1 # via bleach -tomlkit==0.14.0 +tomlkit==0.15.0 # via - # openedx-learning + # openedx-core # snowflake-connector-python -tqdm==4.67.1 +tqdm==4.68.2 # via nltk +typesense==2.0.0 + # via + # edx-search + # openedx-forum typing-extensions==4.15.0 # via + # aiohttp # aiosignal # anyio # beautifulsoup4 # django-countries # edx-opaque-keys # grpcio + # icalendar # jwcrypto # pydantic # pydantic-core @@ -1184,14 +1232,16 @@ typing-extensions==4.15.0 # pyopenssl # referencing # snowflake-connector-python + # testfixtures + # typesense # typing-inspection typing-inspection==0.4.2 # via pydantic -tzdata==2025.3 +tzdata==2026.2 # via # icalendar # kombu -tzlocal==5.3.1 +tzlocal==5.4 # via celery unicodecsv==0.14.1 # via @@ -1204,7 +1254,7 @@ uritemplate==4.2.0 # via # drf-spectacular # drf-yasg -urllib3==2.6.3 +urllib3==2.7.0 # via # botocore # elasticsearch @@ -1220,30 +1270,30 @@ walrus==0.9.8 # via edx-event-bus-redis wcmatch==10.1 # via pycasbin -wcwidth==0.2.14 +wcwidth==0.8.1 # via prompt-toolkit -web-fragments==3.1.0 +web-fragments==4.0.0 # via # -r requirements/edx/kernel.in - # crowdsourcehinter-xblock # edx-sga - # staff-graded-xblock - # xblock # xblock-utils webencodings==0.5.1 # via # bleach # html5lib # tinycss2 -webob==1.8.9 +webob==1.8.10 # via # -r requirements/edx/kernel.in # xblock -wheel==0.45.1 + # xblocks-contrib +wheel==0.47.0 # via django-pipeline -wrapt==2.0.1 - # via -r requirements/edx/kernel.in -xblock[django]==5.3.0 +wrapt==2.2.1 + # via + # -r requirements/edx/kernel.in + # xblocks-contrib +xblock[django]==6.3.0 # via # -r requirements/edx/kernel.in # acid-xblock @@ -1259,9 +1309,9 @@ xblock[django]==5.3.0 # xblock-google-drive # xblock-utils # xblocks-contrib -xblock-drag-and-drop-v2==5.0.3 +xblock-drag-and-drop-v2==5.0.6 # via -r requirements/edx/bundled.in -xblock-google-drive==0.8.1 +xblock-google-drive==0.8.2 # via -r requirements/edx/bundled.in xblock-poll==1.15.1 # via -r requirements/edx/bundled.in @@ -1269,17 +1319,17 @@ xblock-utils==4.0.0 # via # edx-sga # xblock-poll -xblocks-contrib==0.10.2 +xblocks-contrib==0.17.0 # via -r requirements/edx/bundled.in xmlsec==1.3.14 # via # -c requirements/constraints.txt # python3-saml -xss-utils==0.8.0 +xss-utils==1.0.0 # via -r requirements/edx/kernel.in -yarl==1.22.0 +yarl==1.24.2 # via aiohttp -zipp==3.23.0 +zipp==4.1.0 # via importlib-metadata # The following packages are considered to be unsafe in a requirements file: diff --git a/requirements/edx/coverage.txt b/requirements/edx/coverage.txt index 17188896e505..5d015e28de97 100644 --- a/requirements/edx/coverage.txt +++ b/requirements/edx/coverage.txt @@ -1,14 +1,14 @@ # -# This file is autogenerated by pip-compile with Python 3.11 +# This file is autogenerated by pip-compile with Python 3.12 # by the following command: # # make upgrade # -chardet==5.2.0 +chardet==7.4.3 # via diff-cover -coverage==7.13.1 +coverage==7.14.1 # via -r requirements/edx/coverage.in -diff-cover==10.2.0 +diff-cover==10.3.0 # via -r requirements/edx/coverage.in jinja2==3.1.6 # via diff-cover @@ -16,5 +16,5 @@ markupsafe==3.0.3 # via jinja2 pluggy==1.6.0 # via diff-cover -pygments==2.19.2 +pygments==2.20.0 # via diff-cover diff --git a/requirements/edx/development.in b/requirements/edx/development.in index 0de91b366f4c..972adf9aac49 100644 --- a/requirements/edx/development.in +++ b/requirements/edx/development.in @@ -21,5 +21,6 @@ django-stubs[compatible-mypy] # Typing stubs for Django, so it works w djangorestframework-stubs # Typing stubs for DRF mypy # static type checking pywatchman # More efficient checking for runserver reload trigger events +types-requests # Typing stubs for requests vulture # Detects possible dead/unused code, used in scripts/find-dead-code.sh watchdog # Used by `npm run watch` to auto-recompile when assets are changed diff --git a/requirements/edx/development.txt b/requirements/edx/development.txt index 9e4be4c4e967..d570bbc6e89d 100644 --- a/requirements/edx/development.txt +++ b/requirements/edx/development.txt @@ -1,5 +1,5 @@ # -# This file is autogenerated by pip-compile with Python 3.11 +# This file is autogenerated by pip-compile with Python 3.12 # by the following command: # # make upgrade @@ -12,12 +12,12 @@ acid-xblock==0.4.1 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt -aiohappyeyeballs==2.6.1 +aiohappyeyeballs==2.6.2 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # aiohttp -aiohttp==3.13.3 +aiohttp==3.14.1 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt @@ -46,27 +46,22 @@ aniso8601==10.0.1 # -r requirements/edx/testing.txt # edx-tincan-py35 # tincan -annotated-doc==0.0.4 - # via - # -r requirements/edx/testing.txt - # fastapi annotated-types==0.7.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # pydantic -anyio==4.12.1 +anyio==4.14.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # httpx - # starlette appdirs==1.4.4 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # fs -asgiref==3.11.0 +asgiref==3.11.1 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt @@ -78,14 +73,15 @@ asn1crypto==1.5.1 # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # snowflake-connector-python -astroid==4.0.3 +astroid==4.0.4 # via + # -c requirements/constraints.txt # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # pylint # pylint-celery # sphinx-autoapi -attrs==25.4.0 +attrs==26.1.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt @@ -94,10 +90,10 @@ attrs==25.4.0 # jsonschema # lti-consumer-xblock # openedx-authz + # openedx-core # openedx-events - # openedx-learning # referencing -babel==2.17.0 +babel==2.18.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt @@ -115,19 +111,20 @@ bcrypt==5.0.0 # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # paramiko -beautifulsoup4==4.14.3 +beautifulsoup4==4.15.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # openedx-forum # pydata-sphinx-theme # pynliner + # xblocks-contrib billiard==4.2.4 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # celery -bleach[css]==6.3.0 +bleach[css]==6.4.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt @@ -137,7 +134,7 @@ bleach[css]==6.3.0 # ora2 # xblock-drag-and-drop-v2 # xblock-poll -boto3==1.42.30 +boto3==1.43.30 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt @@ -145,7 +142,7 @@ boto3==1.42.30 # fs-s3fs # ora2 # snowflake-connector-python -botocore==1.42.30 +botocore==1.43.30 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt @@ -161,7 +158,7 @@ bridgekeeper==0.9 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt -build==1.4.0 +build==1.5.0 # via # -r requirements/pip-tools.txt # pip-tools @@ -170,13 +167,13 @@ cachecontrol==0.14.4 # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # firebase-admin -cachetools==6.2.4 +cachetools==7.1.4 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # edxval # tox -camel-converter[pydantic]==5.0.0 +camel-converter[pydantic]==5.1.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt @@ -186,7 +183,7 @@ casbin-django-orm-adapter==1.7.0 # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # openedx-authz -celery==5.6.2 +celery==5.6.3 # via # -c requirements/constraints.txt # -r requirements/edx/doc.txt @@ -197,8 +194,8 @@ celery==5.6.2 # edx-enterprise # enterprise-integrated-channels # event-tracking - # openedx-learning -certifi==2026.1.4 + # openedx-core +certifi==2026.5.20 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt @@ -212,15 +209,16 @@ cffi==2.0.0 # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # cryptography + # pact-python-ffi # pynacl -chardet==5.2.0 +chardet==7.4.3 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # diff-cover + # encutils # pysrt - # tox -charset-normalizer==3.4.4 +charset-normalizer==3.4.7 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt @@ -230,7 +228,8 @@ chem==2.0.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt -click==8.3.1 + # xblocks-contrib +click==8.4.1 # via # -r requirements/edx/assets.txt # -r requirements/edx/development.in @@ -247,9 +246,7 @@ click==8.3.1 # edx-lint # import-linter # nltk - # pact-python # pip-tools - # uvicorn click-didyoumean==0.3.1 # via # -r requirements/edx/doc.txt @@ -269,7 +266,7 @@ click-repl==0.3.0 # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # celery -code-annotations==2.3.0 +code-annotations==3.0.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt @@ -284,32 +281,33 @@ colorama==0.4.6 # via # -r requirements/edx/testing.txt # tox -coverage[toml]==7.13.1 +coverage[toml]==7.14.1 # via # -r requirements/edx/testing.txt # pytest-cov -crowdsourcehinter-xblock==0.8 +crowdsourcehinter-xblock==1.0.1 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt -cryptography==45.0.7 +cryptography==49.0.0 # via - # -c requirements/constraints.txt # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # django-fernet-fields-v2 # edx-enterprise + # google-auth # jwcrypto # paramiko # pgpy # pyjwt # pyopenssl # snowflake-connector-python -cssselect==1.3.0 + # social-auth-core +cssselect==1.4.0 # via # -r requirements/edx/testing.txt # pyquery -cssutils==2.11.1 +cssutils==2.15.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt @@ -328,17 +326,18 @@ defusedxml==0.7.1 # ora2 # python3-openid # social-auth-core -diff-cover==10.2.0 + # xblocks-contrib +diff-cover==10.3.0 # via -r requirements/edx/testing.txt dill==0.4.1 # via # -r requirements/edx/testing.txt # pylint -distlib==0.4.0 +distlib==0.4.3 # via # -r requirements/edx/testing.txt # virtualenv -django==5.2.11 +django==5.2.15 # via # -c requirements/common_constraints.txt # -c requirements/constraints.txt @@ -407,23 +406,24 @@ django==5.2.11 # jsonfield # lti-consumer-xblock # openedx-authz + # openedx-core # openedx-django-pyfs # openedx-django-wiki # openedx-events # openedx-filters # openedx-forum - # openedx-learning # ora2 # social-auth-app-django # super-csv # xblock-google-drive + # xblocks-contrib # xss-utils django-appconf==1.2.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # django-statici18n -django-autocomplete-light==3.12.1 +django-autocomplete-light==4.0.1 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt @@ -441,7 +441,7 @@ django-classy-tags==4.1.0 # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # django-sekizai -django-config-models==2.9.0 +django-config-models==3.0.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt @@ -452,7 +452,7 @@ django-cors-headers==4.9.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt -django-countries==8.2.0 +django-countries==9.0.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt @@ -466,6 +466,7 @@ django-crum==0.7.9 # edx-proctoring # edx-rbac # edx-toggles + # openedx-authz # super-csv django-debug-toolbar==5.2.0 # via @@ -489,7 +490,7 @@ django-ipware==7.0.1 # -r requirements/edx/testing.txt # edx-enterprise # edx-proctoring -django-js-asset==3.1.2 +django-js-asset==4.0.1 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt @@ -538,7 +539,7 @@ django-oauth-toolkit==1.7.1 # -r requirements/edx/testing.txt # edx-enterprise # enterprise-integrated-channels -django-object-actions==5.0.0 +django-object-actions==5.1.2 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt @@ -562,7 +563,7 @@ django-sekizai==4.1.0 # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # openedx-django-wiki -django-ses==4.6.0 +django-ses==4.7.2 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt @@ -575,27 +576,26 @@ django-simple-history==3.11.0 # edx-proctoring # enterprise-integrated-channels # ora2 -django-statici18n==2.6.0 +django-statici18n==2.7.1 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # lti-consumer-xblock # xblock-drag-and-drop-v2 # xblock-poll - # xblocks-contrib django-storages==1.14.6 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # edxval -django-stubs[compatible-mypy]==5.2.8 +django-stubs[compatible-mypy]==5.2.9 # via # -c requirements/constraints.txt # -r requirements/edx/development.in # djangorestframework-stubs -django-stubs-ext==5.2.8 +django-stubs-ext==6.0.5 # via django-stubs -django-user-tasks==3.4.4 +django-user-tasks==4.0.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt @@ -608,12 +608,13 @@ django-waffle==5.0.0 # edx-enterprise # edx-proctoring # edx-toggles -django-webpack-loader==3.2.3 + # openedx-authz +django-webpack-loader==3.2.4 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # edx-proctoring -djangorestframework==3.16.1 +djangorestframework==3.17.1 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt @@ -630,11 +631,11 @@ djangorestframework==3.16.1 # edx-proctoring # edx-submissions # openedx-authz + # openedx-core # openedx-forum - # openedx-learning # ora2 # super-csv -djangorestframework-stubs==3.16.7 +djangorestframework-stubs==3.16.9 # via -r requirements/edx/development.in djangorestframework-xml==2.0.0 # via @@ -652,7 +653,7 @@ docutils==0.22.4 # pydata-sphinx-theme # sphinx # sphinx-mdinclude -done-xblock==2.5.0 +done-xblock==3.0.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt @@ -665,7 +666,7 @@ drf-spectacular==0.29.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt -drf-yasg==1.21.14 +drf-yasg==1.21.15 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt @@ -675,16 +676,16 @@ edx-ace==1.15.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt -edx-api-doc-tools==2.1.0 +edx-api-doc-tools==3.0.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # openedx-authz -edx-auth-backends==4.6.2 +edx-auth-backends==5.0.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt -edx-bulk-grades==1.2.0 +edx-bulk-grades==2.0.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt @@ -694,8 +695,9 @@ edx-ccx-keys==2.0.2 # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # lti-consumer-xblock + # openedx-authz # openedx-events -edx-celeryutils==1.4.0 +edx-celeryutils==2.0.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt @@ -704,7 +706,8 @@ edx-codejail==4.1.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt -edx-completion==4.9 + # xblocks-contrib +edx-completion==5.0.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt @@ -714,7 +717,7 @@ edx-django-release-util==1.5.0 # -r requirements/edx/testing.txt # edx-submissions # edxval -edx-django-sites-extensions==5.1.0 +edx-django-sites-extensions==6.0.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt @@ -738,6 +741,7 @@ edx-django-utils==8.0.1 # openedx-events # ora2 # super-csv + # xblocks-contrib edx-drf-extensions==10.6.0 # via # -r requirements/edx/doc.txt @@ -751,8 +755,8 @@ edx-drf-extensions==10.6.0 # edxval # enterprise-integrated-channels # openedx-authz - # openedx-learning -edx-enterprise==6.6.3 + # openedx-core +edx-enterprise==8.0.18 # via # -c requirements/constraints.txt # -r requirements/edx/doc.txt @@ -761,23 +765,22 @@ edx-event-bus-kafka==6.1.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt -edx-event-bus-redis==0.6.1 +edx-event-bus-redis==1.0.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt -edx-i18n-tools==1.9.0 +edx-i18n-tools==2.0.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # ora2 - # xblocks-contrib -edx-lint==5.6.0 +edx-lint==6.1.0 # via -r requirements/edx/testing.txt -edx-milestones==1.1.0 +edx-milestones==2.0.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt -edx-opaque-keys[django]==3.0.0 +edx-opaque-keys[django]==4.0.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt @@ -796,48 +799,52 @@ edx-opaque-keys[django]==3.0.0 # openedx-events # openedx-filters # ora2 + # xblock # xblocks-contrib -edx-organizations==7.3.0 +edx-organizations==8.0.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt + # openedx-authz + # openedx-core edx-proctoring==5.2.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt -edx-rbac==2.1.0 +edx-rbac==3.0.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # edx-enterprise # enterprise-integrated-channels -edx-rest-api-client==6.2.0 +edx-rest-api-client==7.0.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # edx-enterprise # edx-proctoring # enterprise-integrated-channels -edx-search==4.4.0 +edx-search==5.0.1 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # openedx-forum -edx-sga==0.27.0 +edx-sga==0.28.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt -edx-submissions==3.12.2 +edx-submissions==4.0.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # ora2 + # xblocks-contrib edx-tincan-py35==2.0.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # enterprise-integrated-channels -edx-toggles==5.4.1 +edx-toggles==6.0.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt @@ -850,15 +857,17 @@ edx-toggles==5.4.1 # edxval # event-tracking # ora2 -edx-when==3.1.0 + # xblocks-contrib +edx-when==4.0.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # edx-proctoring -edxval==3.2.0 +edxval==4.0.1 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt + # xblocks-contrib elasticsearch==7.9.1 # via # -c requirements/common_constraints.txt @@ -867,6 +876,11 @@ elasticsearch==7.9.1 # -r requirements/edx/testing.txt # edx-search # openedx-forum +encutils==1.0.0 + # via + # -r requirements/edx/doc.txt + # -r requirements/edx/testing.txt + # cssutils enmerkar==0.7.1 # via # -r requirements/edx/doc.txt @@ -876,11 +890,11 @@ enmerkar-underscore==2.4.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt -enterprise-integrated-channels==0.1.38 +enterprise-integrated-channels==0.1.60 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt -event-tracking==3.3.0 +event-tracking==4.0.2 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt @@ -893,27 +907,24 @@ execnet==2.1.2 # pytest-xdist factory-boy==3.3.3 # via -r requirements/edx/testing.txt -faker==40.1.2 +faker==40.23.0 # via # -r requirements/edx/testing.txt # factory-boy -fastapi==0.128.0 - # via - # -r requirements/edx/testing.txt - # pact-python -fastavro==1.12.1 +fastavro==1.12.2 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # openedx-events -filelock==3.20.3 +filelock==3.29.4 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt + # python-discovery # snowflake-connector-python # tox # virtualenv -firebase-admin==7.1.0 +firebase-admin==7.4.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt @@ -933,6 +944,7 @@ fs==2.4.16 # fs-s3fs # openedx-django-pyfs # xblock + # xblocks-contrib fs-s3fs==1.1.1 # via # -r requirements/edx/doc.txt @@ -946,13 +958,13 @@ gitdb==4.0.12 # via # -r requirements/edx/doc.txt # gitpython -gitpython==3.1.46 +gitpython==3.1.50 # via -r requirements/edx/doc.txt glob2==0.7 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt -google-api-core[grpc]==2.29.0 +google-api-core[grpc]==2.31.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt @@ -960,7 +972,7 @@ google-api-core[grpc]==2.29.0 # google-cloud-core # google-cloud-firestore # google-cloud-storage -google-auth==2.47.0 +google-auth==2.55.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt @@ -968,18 +980,18 @@ google-auth==2.47.0 # google-cloud-core # google-cloud-firestore # google-cloud-storage -google-cloud-core==2.5.0 +google-cloud-core==2.6.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # google-cloud-firestore # google-cloud-storage -google-cloud-firestore==2.23.0 +google-cloud-firestore==2.27.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # firebase-admin -google-cloud-storage==3.8.0 +google-cloud-storage==3.12.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt @@ -990,12 +1002,12 @@ google-crc32c==1.8.0 # -r requirements/edx/testing.txt # google-cloud-storage # google-resumable-media -google-resumable-media==2.8.0 +google-resumable-media==2.10.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # google-cloud-storage -googleapis-common-protos==1.72.0 +googleapis-common-protos==1.75.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt @@ -1005,18 +1017,19 @@ grimp==3.14 # via # -r requirements/edx/testing.txt # import-linter -grpcio==1.76.0 +grpcio==1.81.1 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # google-api-core + # google-cloud-firestore # grpcio-status -grpcio-status==1.76.0 +grpcio-status==1.81.1 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # google-api-core -gunicorn==23.0.0 +gunicorn==26.0.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt @@ -1025,13 +1038,12 @@ h11==0.16.0 # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # httpcore - # uvicorn h2==4.3.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # httpx -help-tokens==3.2.0 +help-tokens==4.0.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt @@ -1045,6 +1057,7 @@ html5lib==1.1 # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # ora2 + # xblocks-contrib httpcore==1.0.9 # via # -r requirements/edx/doc.txt @@ -1057,16 +1070,17 @@ httpx[http2]==0.28.1 # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # firebase-admin + # typesense hyperframe==6.1.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # h2 -icalendar==6.3.2 +icalendar==7.1.3 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt -idna==3.11 +idna==3.18 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt @@ -1076,13 +1090,13 @@ idna==3.11 # requests # snowflake-connector-python # yarl -imagesize==1.4.1 +imagesize==2.0.0 # via # -r requirements/edx/doc.txt # sphinx -import-linter==2.9 +import-linter==2.11 # via -r requirements/edx/testing.txt -importlib-metadata==8.7.1 +importlib-metadata==9.0.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt @@ -1096,7 +1110,7 @@ iniconfig==2.3.0 # via # -r requirements/edx/testing.txt # pytest -invoke==2.2.1 +invoke==3.0.3 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt @@ -1110,7 +1124,7 @@ isodate==0.7.2 # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # python3-saml -isort==7.0.0 +isort==8.0.1 # via # -r requirements/edx/testing.txt # pylint @@ -1122,7 +1136,7 @@ jinja2==3.1.6 # diff-cover # sphinx # sphinx-autoapi -jmespath==1.0.1 +jmespath==1.1.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt @@ -1161,7 +1175,7 @@ jsonschema-specifications==2025.9.1 # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # jsonschema -jwcrypto==1.5.6 +jwcrypto==1.5.7 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt @@ -1184,18 +1198,13 @@ lazy==1.6 # lti-consumer-xblock # ora2 # xblock -librt==0.7.8 +librt==0.11.0 # via mypy libsass==0.10.0 # via # -c requirements/constraints.txt # -r requirements/edx/assets.txt -loremipsum==1.0.5 - # via - # -r requirements/edx/doc.txt - # -r requirements/edx/testing.txt - # ora2 -lti-consumer-xblock==9.14.3 +lti-consumer-xblock==11.3.1 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt @@ -1204,6 +1213,7 @@ lxml[html-clean]==5.3.2 # -c requirements/constraints.txt # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt + # edx-enterprise # edx-i18n-tools # edxval # lti-consumer-xblock @@ -1214,8 +1224,9 @@ lxml[html-clean]==5.3.2 # pyquery # python3-saml # xblock + # xblocks-contrib # xmlsec -lxml-html-clean==0.4.3 +lxml-html-clean==0.4.4 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt @@ -1224,7 +1235,7 @@ mailsnake==1.6.4 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt -mako==1.3.10 +mako==1.3.12 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt @@ -1232,14 +1243,14 @@ mako==1.3.10 # lti-consumer-xblock # xblock # xblock-utils -markdown==3.10 +markdown==3.10.2 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # openedx-django-wiki # staff-graded-xblock # xblock-poll -markdown-it-py==4.0.0 +markdown-it-py==4.2.0 # via # -r requirements/edx/testing.txt # rich @@ -1252,7 +1263,8 @@ markupsafe==3.0.3 # mako # openedx-calc # xblock -maxminddb==3.0.0 + # xblocks-contrib +maxminddb==3.1.1 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt @@ -1265,18 +1277,18 @@ mdurl==0.1.2 # via # -r requirements/edx/testing.txt # markdown-it-py -meilisearch==0.40.0 +meilisearch==0.41.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # edx-search -mistune==3.2.0 +mistune==3.2.1 # via # -r requirements/edx/doc.txt # sphinx-mdinclude mock==5.2.0 # via -r requirements/edx/testing.txt -mongoengine==0.29.1 +mongoengine==0.29.3 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt @@ -1285,7 +1297,7 @@ monotonic==1.6 # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # analytics-python -more-itertools==10.8.0 +more-itertools==11.1.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt @@ -1295,12 +1307,12 @@ mpmath==1.3.0 # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # sympy -msgpack==1.1.2 +msgpack==1.2.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # cachecontrol -multidict==6.7.0 +multidict==6.7.1 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt @@ -1312,17 +1324,17 @@ mypy==1.19.1 # django-stubs mypy-extensions==1.1.0 # via mypy -mysqlclient==2.2.7 +mysqlclient==2.2.8 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # openedx-forum -nh3==0.3.2 +nh3==0.3.5 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # xblocks-contrib -nltk==3.9.2 +nltk==3.9.4 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt @@ -1341,6 +1353,7 @@ numpy==1.26.4 # openedx-calc # scipy # shapely + # xblocks-contrib oauthlib==3.3.1 # via # -r requirements/edx/doc.txt @@ -1362,30 +1375,34 @@ openedx-atlas==0.7.0 # enterprise-integrated-channels # openedx-authz # openedx-forum -openedx-authz==0.20.0 +openedx-authz==1.16.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt -openedx-calc==4.0.3 +openedx-calc==5.0.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt -openedx-django-pyfs==3.8.0 + # xblocks-contrib +openedx-core==1.1.0 + # via + # -c requirements/constraints.txt + # -r requirements/edx/doc.txt + # -r requirements/edx/testing.txt +openedx-django-pyfs==4.0.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt - # lti-consumer-xblock # xblock - # xblocks-contrib openedx-django-require==3.0.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt -openedx-django-wiki==3.1.1 +openedx-django-wiki==3.1.2 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt -openedx-events==10.5.0 +openedx-events==11.2.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt @@ -1393,31 +1410,30 @@ openedx-events==10.5.0 # edx-event-bus-kafka # edx-event-bus-redis # event-tracking + # lti-consumer-xblock + # openedx-authz + # openedx-core # ora2 -openedx-filters==2.1.0 +openedx-filters==3.4.1 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt + # edx-enterprise # lti-consumer-xblock # ora2 -openedx-forum==0.4.0 +openedx-forum==0.4.3 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt -openedx-learning==0.31.0 +optimizely-sdk==5.5.0 # via - # -c requirements/constraints.txt # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt -optimizely-sdk==5.4.0 +ora2==7.0.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt -ora2==6.17.1 - # via - # -r requirements/edx/doc.txt - # -r requirements/edx/testing.txt -packaging==25.0 +packaging==26.2 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt @@ -1426,17 +1442,19 @@ packaging==25.0 # drf-yasg # gunicorn # kombu - # pydata-sphinx-theme # pyproject-api # pytest # snowflake-connector-python # sphinx # tox -pact-python==1.6.0 + # wheel +pact-python==3.4.0 + # via -r requirements/edx/testing.txt +pact-python-ffi==0.5.4.0 # via - # -c requirements/constraints.txt # -r requirements/edx/testing.txt -paramiko==4.0.0 + # pact-python +paramiko==5.0.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt @@ -1448,6 +1466,7 @@ path==16.11.0 # -r requirements/edx/testing.txt # edx-i18n-tools # path-py + # xblocks-contrib path-py==12.5.0 # via # -r requirements/edx/doc.txt @@ -1455,7 +1474,7 @@ path-py==12.5.0 # edx-enterprise # ora2 # staff-graded-xblock -pathspec==1.0.3 +pathspec==1.1.1 # via mypy pgpy==0.6.0 # via @@ -1470,20 +1489,21 @@ piexif==1.1.3 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt -pillow==12.1.0 +pillow==12.2.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # edx-enterprise # edx-organizations # edxval -pip-tools==7.5.2 +pip-tools==7.5.3 # via -r requirements/pip-tools.txt -platformdirs==4.5.1 +platformdirs==4.10.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # pylint + # python-discovery # snowflake-connector-python # tox # virtualenv @@ -1504,19 +1524,19 @@ prompt-toolkit==3.0.52 # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # click-repl -propcache==0.4.1 +propcache==0.5.2 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # aiohttp # yarl -proto-plus==1.27.0 +proto-plus==1.28.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # google-api-core # google-cloud-firestore -protobuf==6.33.4 +protobuf==7.35.1 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt @@ -1525,42 +1545,40 @@ protobuf==6.33.4 # googleapis-common-protos # grpcio-status # proto-plus -psutil==7.2.1 +psutil==7.2.2 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # edx-django-utils - # pact-python # pytest-xdist +psycopg2-binary==2.9.12 + # via + # -r requirements/edx/doc.txt + # -r requirements/edx/testing.txt py==1.11.0 # via -r requirements/edx/testing.txt -pyasn1==0.6.2 +pyasn1==0.6.3 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # pgpy # pyasn1-modules - # rsa pyasn1-modules==0.4.2 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # google-auth -pycasbin==2.7.1 +pycasbin==2.8.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # casbin-django-orm-adapter # openedx-authz -pycodestyle==2.8.0 - # via - # -c requirements/constraints.txt - # -r requirements/edx/testing.txt -pycountry==24.6.1 +pycountry==26.2.16 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt -pycparser==2.23 +pycparser==3.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt @@ -1571,22 +1589,21 @@ pycryptodomex==3.23.0 # -r requirements/edx/testing.txt # edx-proctoring # lti-consumer-xblock -pydantic==2.12.5 +pydantic==2.13.4 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # camel-converter - # fastapi -pydantic-core==2.41.5 +pydantic-core==2.46.4 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # pydantic -pydata-sphinx-theme==0.15.4 +pydata-sphinx-theme==0.16.1 # via # -r requirements/edx/doc.txt # sphinx-book-theme -pygments==2.19.2 +pygments==2.20.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt @@ -1596,7 +1613,7 @@ pygments==2.19.2 # rich # sphinx # sphinx-mdinclude -pyjwt[crypto]==2.10.1 +pyjwt[crypto]==2.13.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt @@ -1615,7 +1632,7 @@ pylatexenc==2.10 # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # olxcleaner -pylint==4.0.4 +pylint==4.0.6 # via # -r requirements/edx/testing.txt # edx-lint @@ -1665,18 +1682,19 @@ pynliner==0.8.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt -pyopenssl==25.3.0 +pyopenssl==26.3.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # snowflake-connector-python -pyparsing==3.3.1 +pyparsing==3.3.2 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # chem # openedx-calc -pyproject-api==1.10.0 + # xblocks-contrib +pyproject-api==1.10.1 # via # -r requirements/edx/testing.txt # tox @@ -1707,12 +1725,13 @@ pytest==8.2.0 # pytest-json-report # pytest-metadata # pytest-randomly + # pytest-reportlog # pytest-xdist pytest-attrib==0.1.3 # via -r requirements/edx/testing.txt -pytest-cov==7.0.0 +pytest-cov==7.1.0 # via -r requirements/edx/testing.txt -pytest-django==4.11.1 +pytest-django==4.12.0 # via -r requirements/edx/testing.txt pytest-json-report==1.5.0 # via -r requirements/edx/testing.txt @@ -1720,7 +1739,9 @@ pytest-metadata==3.1.1 # via # -r requirements/edx/testing.txt # pytest-json-report -pytest-randomly==4.0.1 +pytest-randomly==4.1.0 + # via -r requirements/edx/testing.txt +pytest-reportlog==1.0.0 # via -r requirements/edx/testing.txt pytest-xdist[psutil]==3.8.0 # via -r requirements/edx/testing.txt @@ -1739,6 +1760,11 @@ python-dateutil==2.9.0.post0 # olxcleaner # ora2 # xblock +python-discovery==1.4.2 + # via + # -r requirements/edx/testing.txt + # tox + # virtualenv python-ipware==3.0.0 # via # -r requirements/edx/doc.txt @@ -1749,7 +1775,7 @@ python-slugify==8.0.4 # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # code-annotations -python-swiftclient==4.9.0 +python-swiftclient==4.10.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt @@ -1763,7 +1789,8 @@ python3-saml==1.16.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt -pytz==2025.2 + # edx-enterprise +pytz==2026.2 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt @@ -1780,11 +1807,12 @@ pytz==2025.2 # snowflake-connector-python # tincan # xblock + # xblocks-contrib pyuca==1.2 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt -pywatchman==3.0.0 +pywatchman==4.0.0 # via -r requirements/edx/development.in pyyaml==6.0.3 # via @@ -1803,11 +1831,12 @@ random2==1.0.2 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt -recommender-xblock==3.1.0 + # xblocks-contrib +recommender-xblock==5.0.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt -redis==7.1.0 +redis==8.0.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt @@ -1818,12 +1847,12 @@ referencing==0.37.0 # -r requirements/edx/testing.txt # jsonschema # jsonschema-specifications -regex==2026.1.15 +regex==2026.5.9 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # nltk -requests==2.32.5 +requests==2.34.2 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt @@ -1842,7 +1871,6 @@ requests==2.32.5 # meilisearch # openedx-forum # optimizely-sdk - # pact-python # pylti1p3 # python-swiftclient # requests-oauthlib @@ -1852,12 +1880,13 @@ requests==2.32.5 # social-auth-core # sphinx # xblock-google-drive + # xblocks-contrib requests-oauthlib==2.0.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # social-auth-core -rich==14.2.0 +rich==15.0.0 # via # -r requirements/edx/testing.txt # import-linter @@ -1865,25 +1894,22 @@ roman-numerals==4.1.0 # via # -r requirements/edx/doc.txt # sphinx -rpds-py==0.30.0 +rpds-py==2026.5.1 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # jsonschema # referencing -rsa==4.9.1 - # via - # -r requirements/edx/doc.txt - # -r requirements/edx/testing.txt - # google-auth +ruff==0.15.17 + # via -r requirements/edx/testing.txt rules==3.5 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # edx-enterprise # edx-proctoring - # openedx-learning -s3transfer==0.16.0 + # openedx-core +s3transfer==0.18.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt @@ -1893,7 +1919,7 @@ sailthru-client==2.2.3 # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # edx-ace -scipy==1.17.0 +scipy==1.17.1 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt @@ -1907,12 +1933,13 @@ shapely==2.1.2 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt -simpleeval==1.0.3 + # xblocks-contrib +simpleeval==1.0.7 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # pycasbin -simplejson==3.20.2 +simplejson==4.1.1 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt @@ -1920,6 +1947,7 @@ simplejson==3.20.2 # super-csv # xblock # xblock-utils + # xblocks-contrib singledispatch==4.1.2 # via -r requirements/edx/testing.txt six==1.17.0 @@ -1942,9 +1970,7 @@ six==1.17.0 # fs-s3fs # html5lib # libsass - # pact-python # python-dateutil - # sphinxcontrib-httpdomain slumber==0.7.1 # via # -r requirements/edx/doc.txt @@ -1952,19 +1978,18 @@ slumber==0.7.1 # edx-bulk-grades # edx-enterprise # enterprise-integrated-channels -smmap==5.0.2 +smmap==5.0.3 # via # -r requirements/edx/doc.txt # gitdb -snowballstemmer==3.0.1 +snowballstemmer==3.1.1 # via # -r requirements/edx/doc.txt # sphinx -snowflake-connector-python==4.2.0 +snowflake-connector-python==4.6.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt - # edx-enterprise # enterprise-integrated-channels social-auth-app-django==5.4.1 # via @@ -1972,13 +1997,14 @@ social-auth-app-django==5.4.1 # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # edx-auth-backends -social-auth-core==4.8.3 + # edx-enterprise +social-auth-core==4.9.1 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # edx-auth-backends # social-auth-app-django -sorl-thumbnail==12.11.0 +sorl-thumbnail==13.0.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt @@ -1988,12 +2014,12 @@ sortedcontainers==2.4.0 # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # snowflake-connector-python -soupsieve==2.8.3 +soupsieve==2.8.4 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # beautifulsoup4 -sphinx==9.0.4 +sphinx==9.1.0 # via # -r requirements/edx/doc.txt # pydata-sphinx-theme @@ -2009,7 +2035,7 @@ sphinx-autoapi==3.6.0 # via # -c requirements/constraints.txt # -r requirements/edx/doc.txt -sphinx-book-theme==1.1.4 +sphinx-book-theme==1.2.0 # via -r requirements/edx/doc.txt sphinx-design==0.7.0 # via -r requirements/edx/doc.txt @@ -2031,7 +2057,7 @@ sphinxcontrib-htmlhelp==2.1.0 # via # -r requirements/edx/doc.txt # sphinx -sphinxcontrib-httpdomain==1.8.1 +sphinxcontrib-httpdomain==2.0.0 # via # -r requirements/edx/doc.txt # sphinxcontrib-openapi @@ -2039,7 +2065,7 @@ sphinxcontrib-jsmath==1.0.1 # via # -r requirements/edx/doc.txt # sphinx -sphinxcontrib-openapi==0.8.4 +sphinxcontrib-openapi==0.9.0 # via -r requirements/edx/doc.txt sphinxcontrib-qthelp==2.0.0 # via @@ -2057,15 +2083,11 @@ sqlparse==0.5.5 # -r requirements/edx/testing.txt # django # django-debug-toolbar -staff-graded-xblock==3.1.0 +staff-graded-xblock==4.0.1 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt -starlette==0.50.0 - # via - # -r requirements/edx/testing.txt - # fastapi -stevedore==5.6.0 +stevedore==5.8.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt @@ -2074,7 +2096,7 @@ stevedore==5.6.0 # edx-django-utils # edx-enterprise # edx-opaque-keys -super-csv==4.1.0 +super-csv==5.0.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt @@ -2084,7 +2106,7 @@ sympy==1.14.0 # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # openedx-calc -testfixtures==10.0.0 +testfixtures==12.1.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt @@ -2099,35 +2121,47 @@ tincan==1.0.0 # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # edx-enterprise -tinycss2==1.4.0 +tinycss2==1.5.1 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # bleach -tomlkit==0.14.0 +tomli-w==1.2.0 + # via + # -r requirements/edx/testing.txt + # tox +tomlkit==0.15.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt - # openedx-learning + # edx-lint + # openedx-core # pylint # snowflake-connector-python -tox==4.34.1 +tox==4.55.1 # via -r requirements/edx/testing.txt -tqdm==4.67.1 +tqdm==4.68.2 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # nltk -types-pyyaml==6.0.12.20250915 +types-pyyaml==6.0.12.20260518 # via # django-stubs # djangorestframework-stubs -types-requests==2.32.4.20260107 - # via djangorestframework-stubs +types-requests==2.33.0.20260518 + # via -r requirements/edx/development.in +typesense==2.0.0 + # via + # -r requirements/edx/doc.txt + # -r requirements/edx/testing.txt + # edx-search + # openedx-forum typing-extensions==4.15.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt + # aiohttp # aiosignal # anyio # beautifulsoup4 @@ -2136,12 +2170,13 @@ typing-extensions==4.15.0 # django-stubs-ext # djangorestframework-stubs # edx-opaque-keys - # fastapi # grimp # grpcio + # icalendar # import-linter # jwcrypto # mypy + # pact-python # pydantic # pydantic-core # pydata-sphinx-theme @@ -2149,20 +2184,21 @@ typing-extensions==4.15.0 # pyopenssl # referencing # snowflake-connector-python - # starlette + # testfixtures + # typesense # typing-inspection typing-inspection==0.4.2 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # pydantic -tzdata==2025.3 +tzdata==2026.2 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # icalendar # kombu -tzlocal==5.3.1 +tzlocal==5.4 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt @@ -2185,19 +2221,14 @@ uritemplate==4.2.0 # -r requirements/edx/testing.txt # drf-spectacular # drf-yasg -urllib3==2.6.3 +urllib3==2.7.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # botocore # elasticsearch - # pact-python # requests # types-requests -uvicorn==0.40.0 - # via - # -r requirements/edx/testing.txt - # pact-python vine==5.1.0 # via # -r requirements/edx/doc.txt @@ -2205,7 +2236,7 @@ vine==5.1.0 # amqp # celery # kombu -virtualenv==20.36.1 +virtualenv==21.5.0 # via # -r requirements/edx/testing.txt # tox @@ -2214,7 +2245,7 @@ voluptuous==0.16.0 # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # ora2 -vulture==2.14 +vulture==2.16 # via -r requirements/edx/development.in walrus==0.9.8 # via @@ -2228,19 +2259,16 @@ wcmatch==10.1 # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # pycasbin -wcwidth==0.2.14 +wcwidth==0.8.1 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # prompt-toolkit -web-fragments==3.1.0 +web-fragments==4.0.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt - # crowdsourcehinter-xblock # edx-sga - # staff-graded-xblock - # xblock # xblock-utils webencodings==0.5.1 # via @@ -2249,23 +2277,25 @@ webencodings==0.5.1 # bleach # html5lib # tinycss2 -webob==1.8.9 +webob==1.8.10 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # xblock -wheel==0.45.1 + # xblocks-contrib +wheel==0.47.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # -r requirements/pip-tools.txt # django-pipeline # pip-tools -wrapt==2.0.1 +wrapt==2.2.1 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt -xblock[django]==5.3.0 + # xblocks-contrib +xblock[django]==6.3.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt @@ -2282,11 +2312,11 @@ xblock[django]==5.3.0 # xblock-google-drive # xblock-utils # xblocks-contrib -xblock-drag-and-drop-v2==5.0.3 +xblock-drag-and-drop-v2==5.0.6 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt -xblock-google-drive==0.8.1 +xblock-google-drive==0.8.2 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt @@ -2300,7 +2330,7 @@ xblock-utils==4.0.0 # -r requirements/edx/testing.txt # edx-sga # xblock-poll -xblocks-contrib==0.10.2 +xblocks-contrib==0.17.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt @@ -2310,16 +2340,17 @@ xmlsec==1.3.14 # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # python3-saml -xss-utils==0.8.0 +xss-utils==1.0.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt -yarl==1.22.0 +yarl==1.24.2 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt # aiohttp -zipp==3.23.0 + # pact-python +zipp==4.1.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt diff --git a/requirements/edx/doc.txt b/requirements/edx/doc.txt index 6b8cbf58f849..6ba272a9e82c 100644 --- a/requirements/edx/doc.txt +++ b/requirements/edx/doc.txt @@ -1,5 +1,5 @@ # -# This file is autogenerated by pip-compile with Python 3.11 +# This file is autogenerated by pip-compile with Python 3.12 # by the following command: # # make upgrade @@ -8,11 +8,11 @@ accessible-pygments==0.0.5 # via pydata-sphinx-theme acid-xblock==0.4.1 # via -r requirements/edx/base.txt -aiohappyeyeballs==2.6.1 +aiohappyeyeballs==2.6.2 # via # -r requirements/edx/base.txt # aiohttp -aiohttp==3.13.3 +aiohttp==3.14.1 # via # -r requirements/edx/base.txt # geoip2 @@ -37,7 +37,7 @@ annotated-types==0.7.0 # via # -r requirements/edx/base.txt # pydantic -anyio==4.12.1 +anyio==4.14.0 # via # -r requirements/edx/base.txt # httpx @@ -45,7 +45,7 @@ appdirs==1.4.4 # via # -r requirements/edx/base.txt # fs -asgiref==3.11.0 +asgiref==3.11.1 # via # -r requirements/edx/base.txt # django @@ -55,9 +55,11 @@ asn1crypto==1.5.1 # via # -r requirements/edx/base.txt # snowflake-connector-python -astroid==4.0.3 - # via sphinx-autoapi -attrs==25.4.0 +astroid==4.0.4 + # via + # -c requirements/constraints.txt + # sphinx-autoapi +attrs==26.1.0 # via # -r requirements/edx/base.txt # aiohttp @@ -65,10 +67,10 @@ attrs==25.4.0 # jsonschema # lti-consumer-xblock # openedx-authz + # openedx-core # openedx-events - # openedx-learning # referencing -babel==2.17.0 +babel==2.18.0 # via # -r requirements/edx/base.txt # enmerkar @@ -83,17 +85,18 @@ bcrypt==5.0.0 # via # -r requirements/edx/base.txt # paramiko -beautifulsoup4==4.14.3 +beautifulsoup4==4.15.0 # via # -r requirements/edx/base.txt # openedx-forum # pydata-sphinx-theme # pynliner + # xblocks-contrib billiard==4.2.4 # via # -r requirements/edx/base.txt # celery -bleach[css]==6.3.0 +bleach[css]==6.4.0 # via # -r requirements/edx/base.txt # edx-enterprise @@ -102,14 +105,14 @@ bleach[css]==6.3.0 # ora2 # xblock-drag-and-drop-v2 # xblock-poll -boto3==1.42.30 +boto3==1.43.30 # via # -r requirements/edx/base.txt # django-ses # fs-s3fs # ora2 # snowflake-connector-python -botocore==1.42.30 +botocore==1.43.30 # via # -r requirements/edx/base.txt # boto3 @@ -125,11 +128,11 @@ cachecontrol==0.14.4 # via # -r requirements/edx/base.txt # firebase-admin -cachetools==6.2.4 +cachetools==7.1.4 # via # -r requirements/edx/base.txt # edxval -camel-converter[pydantic]==5.0.0 +camel-converter[pydantic]==5.1.0 # via # -r requirements/edx/base.txt # meilisearch @@ -137,7 +140,7 @@ casbin-django-orm-adapter==1.7.0 # via # -r requirements/edx/base.txt # openedx-authz -celery==5.6.2 +celery==5.6.3 # via # -c requirements/constraints.txt # -r requirements/edx/base.txt @@ -147,8 +150,8 @@ celery==5.6.2 # edx-enterprise # enterprise-integrated-channels # event-tracking - # openedx-learning -certifi==2026.1.4 + # openedx-core +certifi==2026.5.20 # via # -r requirements/edx/base.txt # elasticsearch @@ -161,18 +164,21 @@ cffi==2.0.0 # -r requirements/edx/base.txt # cryptography # pynacl -chardet==5.2.0 +chardet==7.4.3 # via # -r requirements/edx/base.txt + # encutils # pysrt -charset-normalizer==3.4.4 +charset-normalizer==3.4.7 # via # -r requirements/edx/base.txt # requests # snowflake-connector-python chem==2.0.0 - # via -r requirements/edx/base.txt -click==8.3.1 + # via + # -r requirements/edx/base.txt + # xblocks-contrib +click==8.4.1 # via # -r requirements/edx/base.txt # celery @@ -194,7 +200,7 @@ click-repl==0.3.0 # via # -r requirements/edx/base.txt # celery -code-annotations==2.3.0 +code-annotations==3.0.0 # via # -r requirements/edx/base.txt # -r requirements/edx/doc.in @@ -202,21 +208,22 @@ code-annotations==2.3.0 # edx-toggles codejail-includes==2.0.0 # via -r requirements/edx/base.txt -crowdsourcehinter-xblock==0.8 +crowdsourcehinter-xblock==1.0.1 # via -r requirements/edx/base.txt -cryptography==45.0.7 +cryptography==49.0.0 # via - # -c requirements/constraints.txt # -r requirements/edx/base.txt # django-fernet-fields-v2 # edx-enterprise + # google-auth # jwcrypto # paramiko # pgpy # pyjwt # pyopenssl # snowflake-connector-python -cssutils==2.11.1 + # social-auth-core +cssutils==2.15.0 # via # -r requirements/edx/base.txt # pynliner @@ -229,7 +236,8 @@ defusedxml==0.7.1 # ora2 # python3-openid # social-auth-core -django==5.2.11 + # xblocks-contrib +django==5.2.15 # via # -c requirements/common_constraints.txt # -c requirements/constraints.txt @@ -294,22 +302,23 @@ django==5.2.11 # jsonfield # lti-consumer-xblock # openedx-authz + # openedx-core # openedx-django-pyfs # openedx-django-wiki # openedx-events # openedx-filters # openedx-forum - # openedx-learning # ora2 # social-auth-app-django # super-csv # xblock-google-drive + # xblocks-contrib # xss-utils django-appconf==1.2.0 # via # -r requirements/edx/base.txt # django-statici18n -django-autocomplete-light==3.12.1 +django-autocomplete-light==4.0.1 # via -r requirements/edx/base.txt django-cache-memoize==0.2.1 # via @@ -321,7 +330,7 @@ django-classy-tags==4.1.0 # via # -r requirements/edx/base.txt # django-sekizai -django-config-models==2.9.0 +django-config-models==3.0.0 # via # -r requirements/edx/base.txt # edx-enterprise @@ -329,7 +338,7 @@ django-config-models==2.9.0 # lti-consumer-xblock django-cors-headers==4.9.0 # via -r requirements/edx/base.txt -django-countries==8.2.0 +django-countries==9.0.0 # via # -r requirements/edx/base.txt # edx-enterprise @@ -341,6 +350,7 @@ django-crum==0.7.9 # edx-proctoring # edx-rbac # edx-toggles + # openedx-authz # super-csv django-fernet-fields-v2==0.9 # via @@ -357,7 +367,7 @@ django-ipware==7.0.1 # -r requirements/edx/base.txt # edx-enterprise # edx-proctoring -django-js-asset==3.1.2 +django-js-asset==4.0.1 # via # -r requirements/edx/base.txt # django-mptt @@ -397,7 +407,7 @@ django-oauth-toolkit==1.7.1 # -r requirements/edx/base.txt # edx-enterprise # enterprise-integrated-channels -django-object-actions==5.0.0 +django-object-actions==5.1.2 # via # -r requirements/edx/base.txt # edx-enterprise @@ -414,7 +424,7 @@ django-sekizai==4.1.0 # via # -r requirements/edx/base.txt # openedx-django-wiki -django-ses==4.6.0 +django-ses==4.7.2 # via -r requirements/edx/base.txt django-simple-history==3.11.0 # via @@ -424,18 +434,17 @@ django-simple-history==3.11.0 # edx-proctoring # enterprise-integrated-channels # ora2 -django-statici18n==2.6.0 +django-statici18n==2.7.1 # via # -r requirements/edx/base.txt # lti-consumer-xblock # xblock-drag-and-drop-v2 # xblock-poll - # xblocks-contrib django-storages==1.14.6 # via # -r requirements/edx/base.txt # edxval -django-user-tasks==3.4.4 +django-user-tasks==4.0.0 # via -r requirements/edx/base.txt django-waffle==5.0.0 # via @@ -445,11 +454,12 @@ django-waffle==5.0.0 # edx-enterprise # edx-proctoring # edx-toggles -django-webpack-loader==3.2.3 + # openedx-authz +django-webpack-loader==3.2.4 # via # -r requirements/edx/base.txt # edx-proctoring -djangorestframework==3.16.1 +djangorestframework==3.17.1 # via # -r requirements/edx/base.txt # django-config-models @@ -465,8 +475,8 @@ djangorestframework==3.16.1 # edx-proctoring # edx-submissions # openedx-authz + # openedx-core # openedx-forum - # openedx-learning # ora2 # super-csv djangorestframework-xml==2.0.0 @@ -482,7 +492,7 @@ docutils==0.22.4 # pydata-sphinx-theme # sphinx # sphinx-mdinclude -done-xblock==2.5.0 +done-xblock==3.0.0 # via -r requirements/edx/base.txt drf-jwt==1.19.2 # via @@ -490,20 +500,20 @@ drf-jwt==1.19.2 # edx-drf-extensions drf-spectacular==0.29.0 # via -r requirements/edx/base.txt -drf-yasg==1.21.14 +drf-yasg==1.21.15 # via # -r requirements/edx/base.txt # django-user-tasks # edx-api-doc-tools edx-ace==1.15.0 # via -r requirements/edx/base.txt -edx-api-doc-tools==2.1.0 +edx-api-doc-tools==3.0.0 # via # -r requirements/edx/base.txt # openedx-authz -edx-auth-backends==4.6.2 +edx-auth-backends==5.0.0 # via -r requirements/edx/base.txt -edx-bulk-grades==1.2.0 +edx-bulk-grades==2.0.0 # via # -r requirements/edx/base.txt # staff-graded-xblock @@ -511,21 +521,24 @@ edx-ccx-keys==2.0.2 # via # -r requirements/edx/base.txt # lti-consumer-xblock + # openedx-authz # openedx-events -edx-celeryutils==1.4.0 +edx-celeryutils==2.0.0 # via # -r requirements/edx/base.txt # super-csv edx-codejail==4.1.0 - # via -r requirements/edx/base.txt -edx-completion==4.9 + # via + # -r requirements/edx/base.txt + # xblocks-contrib +edx-completion==5.0.0 # via -r requirements/edx/base.txt edx-django-release-util==1.5.0 # via # -r requirements/edx/base.txt # edx-submissions # edxval -edx-django-sites-extensions==5.1.0 +edx-django-sites-extensions==6.0.0 # via -r requirements/edx/base.txt edx-django-utils==8.0.1 # via @@ -546,6 +559,7 @@ edx-django-utils==8.0.1 # openedx-events # ora2 # super-csv + # xblocks-contrib edx-drf-extensions==10.6.0 # via # -r requirements/edx/base.txt @@ -558,23 +572,22 @@ edx-drf-extensions==10.6.0 # edxval # enterprise-integrated-channels # openedx-authz - # openedx-learning -edx-enterprise==6.6.3 + # openedx-core +edx-enterprise==8.0.18 # via # -c requirements/constraints.txt # -r requirements/edx/base.txt edx-event-bus-kafka==6.1.0 # via -r requirements/edx/base.txt -edx-event-bus-redis==0.6.1 +edx-event-bus-redis==1.0.0 # via -r requirements/edx/base.txt -edx-i18n-tools==1.9.0 +edx-i18n-tools==2.0.0 # via # -r requirements/edx/base.txt # ora2 - # xblocks-contrib -edx-milestones==1.1.0 +edx-milestones==2.0.0 # via -r requirements/edx/base.txt -edx-opaque-keys[django]==3.0.0 +edx-opaque-keys[django]==4.0.0 # via # -r requirements/edx/base.txt # edx-bulk-grades @@ -592,37 +605,42 @@ edx-opaque-keys[django]==3.0.0 # openedx-events # openedx-filters # ora2 + # xblock # xblocks-contrib -edx-organizations==7.3.0 - # via -r requirements/edx/base.txt +edx-organizations==8.0.0 + # via + # -r requirements/edx/base.txt + # openedx-authz + # openedx-core edx-proctoring==5.2.0 # via -r requirements/edx/base.txt -edx-rbac==2.1.0 +edx-rbac==3.0.0 # via # -r requirements/edx/base.txt # edx-enterprise # enterprise-integrated-channels -edx-rest-api-client==6.2.0 +edx-rest-api-client==7.0.0 # via # -r requirements/edx/base.txt # edx-enterprise # edx-proctoring # enterprise-integrated-channels -edx-search==4.4.0 +edx-search==5.0.1 # via # -r requirements/edx/base.txt # openedx-forum -edx-sga==0.27.0 +edx-sga==0.28.0 # via -r requirements/edx/base.txt -edx-submissions==3.12.2 +edx-submissions==4.0.0 # via # -r requirements/edx/base.txt # ora2 + # xblocks-contrib edx-tincan-py35==2.0.0 # via # -r requirements/edx/base.txt # enterprise-integrated-channels -edx-toggles==5.4.1 +edx-toggles==6.0.0 # via # -r requirements/edx/base.txt # edx-auth-backends @@ -634,12 +652,15 @@ edx-toggles==5.4.1 # edxval # event-tracking # ora2 -edx-when==3.1.0 + # xblocks-contrib +edx-when==4.0.0 # via # -r requirements/edx/base.txt # edx-proctoring -edxval==3.2.0 - # via -r requirements/edx/base.txt +edxval==4.0.1 + # via + # -r requirements/edx/base.txt + # xblocks-contrib elasticsearch==7.9.1 # via # -c requirements/common_constraints.txt @@ -647,29 +668,33 @@ elasticsearch==7.9.1 # -r requirements/edx/base.txt # edx-search # openedx-forum +encutils==1.0.0 + # via + # -r requirements/edx/base.txt + # cssutils enmerkar==0.7.1 # via # -r requirements/edx/base.txt # enmerkar-underscore enmerkar-underscore==2.4.0 # via -r requirements/edx/base.txt -enterprise-integrated-channels==0.1.38 +enterprise-integrated-channels==0.1.60 # via -r requirements/edx/base.txt -event-tracking==3.3.0 +event-tracking==4.0.2 # via # -r requirements/edx/base.txt # edx-completion # edx-proctoring # edx-search -fastavro==1.12.1 +fastavro==1.12.2 # via # -r requirements/edx/base.txt # openedx-events -filelock==3.20.3 +filelock==3.29.4 # via # -r requirements/edx/base.txt # snowflake-connector-python -firebase-admin==7.1.0 +firebase-admin==7.4.0 # via # -r requirements/edx/base.txt # edx-ace @@ -684,6 +709,7 @@ fs==2.4.16 # fs-s3fs # openedx-django-pyfs # xblock + # xblocks-contrib fs-s3fs==1.1.1 # via # -r requirements/edx/base.txt @@ -692,34 +718,34 @@ geoip2==5.2.0 # via -r requirements/edx/base.txt gitdb==4.0.12 # via gitpython -gitpython==3.1.46 +gitpython==3.1.50 # via -r requirements/edx/doc.in glob2==0.7 # via -r requirements/edx/base.txt -google-api-core[grpc]==2.29.0 +google-api-core[grpc]==2.31.0 # via # -r requirements/edx/base.txt # firebase-admin # google-cloud-core # google-cloud-firestore # google-cloud-storage -google-auth==2.47.0 +google-auth==2.55.0 # via # -r requirements/edx/base.txt # google-api-core # google-cloud-core # google-cloud-firestore # google-cloud-storage -google-cloud-core==2.5.0 +google-cloud-core==2.6.0 # via # -r requirements/edx/base.txt # google-cloud-firestore # google-cloud-storage -google-cloud-firestore==2.23.0 +google-cloud-firestore==2.27.0 # via # -r requirements/edx/base.txt # firebase-admin -google-cloud-storage==3.8.0 +google-cloud-storage==3.12.0 # via # -r requirements/edx/base.txt # firebase-admin @@ -728,25 +754,26 @@ google-crc32c==1.8.0 # -r requirements/edx/base.txt # google-cloud-storage # google-resumable-media -google-resumable-media==2.8.0 +google-resumable-media==2.10.0 # via # -r requirements/edx/base.txt # google-cloud-storage -googleapis-common-protos==1.72.0 +googleapis-common-protos==1.75.0 # via # -r requirements/edx/base.txt # google-api-core # grpcio-status -grpcio==1.76.0 +grpcio==1.81.1 # via # -r requirements/edx/base.txt # google-api-core + # google-cloud-firestore # grpcio-status -grpcio-status==1.76.0 +grpcio-status==1.81.1 # via # -r requirements/edx/base.txt # google-api-core -gunicorn==23.0.0 +gunicorn==26.0.0 # via -r requirements/edx/base.txt h11==0.16.0 # via @@ -756,7 +783,7 @@ h2==4.3.0 # via # -r requirements/edx/base.txt # httpx -help-tokens==3.2.0 +help-tokens==4.0.0 # via -r requirements/edx/base.txt hpack==4.1.0 # via @@ -766,6 +793,7 @@ html5lib==1.1 # via # -r requirements/edx/base.txt # ora2 + # xblocks-contrib httpcore==1.0.9 # via # -r requirements/edx/base.txt @@ -774,13 +802,14 @@ httpx[http2]==0.28.1 # via # -r requirements/edx/base.txt # firebase-admin + # typesense hyperframe==6.1.0 # via # -r requirements/edx/base.txt # h2 -icalendar==6.3.2 +icalendar==7.1.3 # via -r requirements/edx/base.txt -idna==3.11 +idna==3.18 # via # -r requirements/edx/base.txt # anyio @@ -789,16 +818,16 @@ idna==3.11 # requests # snowflake-connector-python # yarl -imagesize==1.4.1 +imagesize==2.0.0 # via sphinx -importlib-metadata==8.7.1 +importlib-metadata==9.0.0 # via -r requirements/edx/base.txt inflection==0.5.1 # via # -r requirements/edx/base.txt # drf-spectacular # drf-yasg -invoke==2.2.1 +invoke==3.0.3 # via # -r requirements/edx/base.txt # paramiko @@ -814,7 +843,7 @@ jinja2==3.1.6 # code-annotations # sphinx # sphinx-autoapi -jmespath==1.0.1 +jmespath==1.1.0 # via # -r requirements/edx/base.txt # boto3 @@ -847,7 +876,7 @@ jsonschema-specifications==2025.9.1 # via # -r requirements/edx/base.txt # jsonschema -jwcrypto==1.5.6 +jwcrypto==1.5.7 # via # -r requirements/edx/base.txt # django-oauth-toolkit @@ -865,16 +894,13 @@ lazy==1.6 # lti-consumer-xblock # ora2 # xblock -loremipsum==1.0.5 - # via - # -r requirements/edx/base.txt - # ora2 -lti-consumer-xblock==9.14.3 +lti-consumer-xblock==11.3.1 # via -r requirements/edx/base.txt lxml[html-clean]==5.3.2 # via # -c requirements/constraints.txt # -r requirements/edx/base.txt + # edx-enterprise # edx-i18n-tools # edxval # lti-consumer-xblock @@ -884,21 +910,22 @@ lxml[html-clean]==5.3.2 # ora2 # python3-saml # xblock + # xblocks-contrib # xmlsec -lxml-html-clean==0.4.3 +lxml-html-clean==0.4.4 # via # -r requirements/edx/base.txt # lxml mailsnake==1.6.4 # via -r requirements/edx/base.txt -mako==1.3.10 +mako==1.3.12 # via # -r requirements/edx/base.txt # acid-xblock # lti-consumer-xblock # xblock # xblock-utils -markdown==3.10 +markdown==3.10.2 # via # -r requirements/edx/base.txt # openedx-django-wiki @@ -912,23 +939,24 @@ markupsafe==3.0.3 # mako # openedx-calc # xblock -maxminddb==3.0.0 + # xblocks-contrib +maxminddb==3.1.1 # via # -r requirements/edx/base.txt # geoip2 -meilisearch==0.40.0 +meilisearch==0.41.0 # via # -r requirements/edx/base.txt # edx-search -mistune==3.2.0 +mistune==3.2.1 # via sphinx-mdinclude -mongoengine==0.29.1 +mongoengine==0.29.3 # via -r requirements/edx/base.txt monotonic==1.6 # via # -r requirements/edx/base.txt # analytics-python -more-itertools==10.8.0 +more-itertools==11.1.0 # via # -r requirements/edx/base.txt # cssutils @@ -936,24 +964,24 @@ mpmath==1.3.0 # via # -r requirements/edx/base.txt # sympy -msgpack==1.1.2 +msgpack==1.2.0 # via # -r requirements/edx/base.txt # cachecontrol -multidict==6.7.0 +multidict==6.7.1 # via # -r requirements/edx/base.txt # aiohttp # yarl -mysqlclient==2.2.7 +mysqlclient==2.2.8 # via # -r requirements/edx/base.txt # openedx-forum -nh3==0.3.2 +nh3==0.3.5 # via # -r requirements/edx/base.txt # xblocks-contrib -nltk==3.9.2 +nltk==3.9.4 # via # -r requirements/edx/base.txt # chem @@ -967,6 +995,7 @@ numpy==1.26.4 # openedx-calc # scipy # shapely + # xblocks-contrib oauthlib==3.3.1 # via # -r requirements/edx/base.txt @@ -984,53 +1013,57 @@ openedx-atlas==0.7.0 # enterprise-integrated-channels # openedx-authz # openedx-forum -openedx-authz==0.20.0 - # via -r requirements/edx/base.txt -openedx-calc==4.0.3 +openedx-authz==1.16.0 # via -r requirements/edx/base.txt -openedx-django-pyfs==3.8.0 +openedx-calc==5.0.0 # via # -r requirements/edx/base.txt - # lti-consumer-xblock - # xblock # xblocks-contrib +openedx-core==1.1.0 + # via + # -c requirements/constraints.txt + # -r requirements/edx/base.txt +openedx-django-pyfs==4.0.0 + # via + # -r requirements/edx/base.txt + # xblock openedx-django-require==3.0.0 # via -r requirements/edx/base.txt -openedx-django-wiki==3.1.1 +openedx-django-wiki==3.1.2 # via -r requirements/edx/base.txt -openedx-events==10.5.0 +openedx-events==11.2.0 # via # -r requirements/edx/base.txt # edx-enterprise # edx-event-bus-kafka # edx-event-bus-redis # event-tracking + # lti-consumer-xblock + # openedx-authz + # openedx-core # ora2 -openedx-filters==2.1.0 +openedx-filters==3.4.1 # via # -r requirements/edx/base.txt + # edx-enterprise # lti-consumer-xblock # ora2 -openedx-forum==0.4.0 +openedx-forum==0.4.3 # via -r requirements/edx/base.txt -openedx-learning==0.31.0 - # via - # -c requirements/constraints.txt - # -r requirements/edx/base.txt -optimizely-sdk==5.4.0 +optimizely-sdk==5.5.0 # via -r requirements/edx/base.txt -ora2==6.17.1 +ora2==7.0.0 # via -r requirements/edx/base.txt -packaging==25.0 +packaging==26.2 # via # -r requirements/edx/base.txt # drf-yasg # gunicorn # kombu - # pydata-sphinx-theme # snowflake-connector-python # sphinx -paramiko==4.0.0 + # wheel +paramiko==5.0.0 # via # -r requirements/edx/base.txt # edx-enterprise @@ -1040,6 +1073,7 @@ path==16.11.0 # -r requirements/edx/base.txt # edx-i18n-tools # path-py + # xblocks-contrib path-py==12.5.0 # via # -r requirements/edx/base.txt @@ -1054,13 +1088,13 @@ picobox==4.0.0 # via sphinxcontrib-openapi piexif==1.1.3 # via -r requirements/edx/base.txt -pillow==12.1.0 +pillow==12.2.0 # via # -r requirements/edx/base.txt # edx-enterprise # edx-organizations # edxval -platformdirs==4.5.1 +platformdirs==4.10.0 # via # -r requirements/edx/base.txt # snowflake-connector-python @@ -1072,17 +1106,17 @@ prompt-toolkit==3.0.52 # via # -r requirements/edx/base.txt # click-repl -propcache==0.4.1 +propcache==0.5.2 # via # -r requirements/edx/base.txt # aiohttp # yarl -proto-plus==1.27.0 +proto-plus==1.28.0 # via # -r requirements/edx/base.txt # google-api-core # google-cloud-firestore -protobuf==6.33.4 +protobuf==7.35.1 # via # -r requirements/edx/base.txt # google-api-core @@ -1090,28 +1124,29 @@ protobuf==6.33.4 # googleapis-common-protos # grpcio-status # proto-plus -psutil==7.2.1 +psutil==7.2.2 # via # -r requirements/edx/base.txt # edx-django-utils -pyasn1==0.6.2 +psycopg2-binary==2.9.12 + # via -r requirements/edx/base.txt +pyasn1==0.6.3 # via # -r requirements/edx/base.txt # pgpy # pyasn1-modules - # rsa pyasn1-modules==0.4.2 # via # -r requirements/edx/base.txt # google-auth -pycasbin==2.7.1 +pycasbin==2.8.0 # via # -r requirements/edx/base.txt # casbin-django-orm-adapter # openedx-authz -pycountry==24.6.1 +pycountry==26.2.16 # via -r requirements/edx/base.txt -pycparser==2.23 +pycparser==3.0 # via # -r requirements/edx/base.txt # cffi @@ -1120,23 +1155,23 @@ pycryptodomex==3.23.0 # -r requirements/edx/base.txt # edx-proctoring # lti-consumer-xblock -pydantic==2.12.5 +pydantic==2.13.4 # via # -r requirements/edx/base.txt # camel-converter -pydantic-core==2.41.5 +pydantic-core==2.46.4 # via # -r requirements/edx/base.txt # pydantic -pydata-sphinx-theme==0.15.4 +pydata-sphinx-theme==0.16.1 # via sphinx-book-theme -pygments==2.19.2 +pygments==2.20.0 # via # accessible-pygments # pydata-sphinx-theme # sphinx # sphinx-mdinclude -pyjwt[crypto]==2.10.1 +pyjwt[crypto]==2.13.0 # via # -r requirements/edx/base.txt # drf-jwt @@ -1172,15 +1207,16 @@ pynacl==1.6.2 # paramiko pynliner==0.8.0 # via -r requirements/edx/base.txt -pyopenssl==25.3.0 +pyopenssl==26.3.0 # via # -r requirements/edx/base.txt # snowflake-connector-python -pyparsing==3.3.1 +pyparsing==3.3.2 # via # -r requirements/edx/base.txt # chem # openedx-calc + # xblocks-contrib pyrsistent==0.20.0 # via # -r requirements/edx/base.txt @@ -1210,7 +1246,7 @@ python-slugify==8.0.4 # via # -r requirements/edx/base.txt # code-annotations -python-swiftclient==4.9.0 +python-swiftclient==4.10.0 # via # -r requirements/edx/base.txt # ora2 @@ -1219,8 +1255,10 @@ python3-openid==3.2.0 ; python_version >= "3" # -r requirements/edx/base.txt # social-auth-core python3-saml==1.16.0 - # via -r requirements/edx/base.txt -pytz==2025.2 + # via + # -r requirements/edx/base.txt + # edx-enterprise +pytz==2026.2 # via # -r requirements/edx/base.txt # drf-yasg @@ -1236,6 +1274,7 @@ pytz==2025.2 # snowflake-connector-python # tincan # xblock + # xblocks-contrib pyuca==1.2 # via -r requirements/edx/base.txt pyyaml==6.0.3 @@ -1251,10 +1290,12 @@ pyyaml==6.0.3 # sphinxcontrib-openapi # xblock random2==1.0.2 + # via + # -r requirements/edx/base.txt + # xblocks-contrib +recommender-xblock==5.0.0 # via -r requirements/edx/base.txt -recommender-xblock==3.1.0 - # via -r requirements/edx/base.txt -redis==7.1.0 +redis==8.0.0 # via # -r requirements/edx/base.txt # walrus @@ -1263,11 +1304,11 @@ referencing==0.37.0 # -r requirements/edx/base.txt # jsonschema # jsonschema-specifications -regex==2026.1.15 +regex==2026.5.9 # via # -r requirements/edx/base.txt # nltk -requests==2.32.5 +requests==2.34.2 # via # -r requirements/edx/base.txt # analytics-python @@ -1294,28 +1335,25 @@ requests==2.32.5 # social-auth-core # sphinx # xblock-google-drive + # xblocks-contrib requests-oauthlib==2.0.0 # via # -r requirements/edx/base.txt # social-auth-core roman-numerals==4.1.0 # via sphinx -rpds-py==0.30.0 +rpds-py==2026.5.1 # via # -r requirements/edx/base.txt # jsonschema # referencing -rsa==4.9.1 - # via - # -r requirements/edx/base.txt - # google-auth rules==3.5 # via # -r requirements/edx/base.txt # edx-enterprise # edx-proctoring - # openedx-learning -s3transfer==0.16.0 + # openedx-core +s3transfer==0.18.0 # via # -r requirements/edx/base.txt # boto3 @@ -1323,7 +1361,7 @@ sailthru-client==2.2.3 # via # -r requirements/edx/base.txt # edx-ace -scipy==1.17.0 +scipy==1.17.1 # via # -r requirements/edx/base.txt # chem @@ -1332,18 +1370,21 @@ semantic-version==2.10.0 # -r requirements/edx/base.txt # edx-drf-extensions shapely==2.1.2 - # via -r requirements/edx/base.txt -simpleeval==1.0.3 + # via + # -r requirements/edx/base.txt + # xblocks-contrib +simpleeval==1.0.7 # via # -r requirements/edx/base.txt # pycasbin -simplejson==3.20.2 +simplejson==4.1.1 # via # -r requirements/edx/base.txt # sailthru-client # super-csv # xblock # xblock-utils + # xblocks-contrib six==1.17.0 # via # -r requirements/edx/base.txt @@ -1361,33 +1402,32 @@ six==1.17.0 # fs-s3fs # html5lib # python-dateutil - # sphinxcontrib-httpdomain slumber==0.7.1 # via # -r requirements/edx/base.txt # edx-bulk-grades # edx-enterprise # enterprise-integrated-channels -smmap==5.0.2 +smmap==5.0.3 # via gitdb -snowballstemmer==3.0.1 +snowballstemmer==3.1.1 # via sphinx -snowflake-connector-python==4.2.0 +snowflake-connector-python==4.6.0 # via # -r requirements/edx/base.txt - # edx-enterprise # enterprise-integrated-channels social-auth-app-django==5.4.1 # via # -c requirements/constraints.txt # -r requirements/edx/base.txt # edx-auth-backends -social-auth-core==4.8.3 + # edx-enterprise +social-auth-core==4.9.1 # via # -r requirements/edx/base.txt # edx-auth-backends # social-auth-app-django -sorl-thumbnail==12.11.0 +sorl-thumbnail==13.0.0 # via # -r requirements/edx/base.txt # openedx-django-wiki @@ -1395,11 +1435,11 @@ sortedcontainers==2.4.0 # via # -r requirements/edx/base.txt # snowflake-connector-python -soupsieve==2.8.3 +soupsieve==2.8.4 # via # -r requirements/edx/base.txt # beautifulsoup4 -sphinx==9.0.4 +sphinx==9.1.0 # via # -r requirements/edx/doc.in # pydata-sphinx-theme @@ -1415,7 +1455,7 @@ sphinx-autoapi==3.6.0 # via # -c requirements/constraints.txt # -r requirements/edx/doc.in -sphinx-book-theme==1.1.4 +sphinx-book-theme==1.2.0 # via -r requirements/edx/doc.in sphinx-design==0.7.0 # via -r requirements/edx/doc.in @@ -1429,11 +1469,11 @@ sphinxcontrib-devhelp==2.0.0 # via sphinx sphinxcontrib-htmlhelp==2.1.0 # via sphinx -sphinxcontrib-httpdomain==1.8.1 +sphinxcontrib-httpdomain==2.0.0 # via sphinxcontrib-openapi sphinxcontrib-jsmath==1.0.1 # via sphinx -sphinxcontrib-openapi==0.8.4 +sphinxcontrib-openapi==0.9.0 # via -r requirements/edx/doc.in sphinxcontrib-qthelp==2.0.0 # via sphinx @@ -1445,9 +1485,9 @@ sqlparse==0.5.5 # via # -r requirements/edx/base.txt # django -staff-graded-xblock==3.1.0 +staff-graded-xblock==4.0.1 # via -r requirements/edx/base.txt -stevedore==5.6.0 +stevedore==5.8.0 # via # -r requirements/edx/base.txt # code-annotations @@ -1455,7 +1495,7 @@ stevedore==5.6.0 # edx-django-utils # edx-enterprise # edx-opaque-keys -super-csv==4.1.0 +super-csv==5.0.0 # via # -r requirements/edx/base.txt # edx-bulk-grades @@ -1463,7 +1503,7 @@ sympy==1.14.0 # via # -r requirements/edx/base.txt # openedx-calc -testfixtures==10.0.0 +testfixtures==12.1.0 # via # -r requirements/edx/base.txt # edx-enterprise @@ -1475,28 +1515,35 @@ tincan==1.0.0 # via # -r requirements/edx/base.txt # edx-enterprise -tinycss2==1.4.0 +tinycss2==1.5.1 # via # -r requirements/edx/base.txt # bleach -tomlkit==0.14.0 +tomlkit==0.15.0 # via # -r requirements/edx/base.txt - # openedx-learning + # openedx-core # snowflake-connector-python -tqdm==4.67.1 +tqdm==4.68.2 # via # -r requirements/edx/base.txt # nltk +typesense==2.0.0 + # via + # -r requirements/edx/base.txt + # edx-search + # openedx-forum typing-extensions==4.15.0 # via # -r requirements/edx/base.txt + # aiohttp # aiosignal # anyio # beautifulsoup4 # django-countries # edx-opaque-keys # grpcio + # icalendar # jwcrypto # pydantic # pydantic-core @@ -1505,17 +1552,19 @@ typing-extensions==4.15.0 # pyopenssl # referencing # snowflake-connector-python + # testfixtures + # typesense # typing-inspection typing-inspection==0.4.2 # via # -r requirements/edx/base.txt # pydantic -tzdata==2025.3 +tzdata==2026.2 # via # -r requirements/edx/base.txt # icalendar # kombu -tzlocal==5.3.1 +tzlocal==5.4 # via # -r requirements/edx/base.txt # celery @@ -1531,7 +1580,7 @@ uritemplate==4.2.0 # -r requirements/edx/base.txt # drf-spectacular # drf-yasg -urllib3==2.6.3 +urllib3==2.7.0 # via # -r requirements/edx/base.txt # botocore @@ -1555,17 +1604,14 @@ wcmatch==10.1 # via # -r requirements/edx/base.txt # pycasbin -wcwidth==0.2.14 +wcwidth==0.8.1 # via # -r requirements/edx/base.txt # prompt-toolkit -web-fragments==3.1.0 +web-fragments==4.0.0 # via # -r requirements/edx/base.txt - # crowdsourcehinter-xblock # edx-sga - # staff-graded-xblock - # xblock # xblock-utils webencodings==0.5.1 # via @@ -1573,17 +1619,20 @@ webencodings==0.5.1 # bleach # html5lib # tinycss2 -webob==1.8.9 +webob==1.8.10 # via # -r requirements/edx/base.txt # xblock -wheel==0.45.1 + # xblocks-contrib +wheel==0.47.0 # via # -r requirements/edx/base.txt # django-pipeline -wrapt==2.0.1 - # via -r requirements/edx/base.txt -xblock[django]==5.3.0 +wrapt==2.2.1 + # via + # -r requirements/edx/base.txt + # xblocks-contrib +xblock[django]==6.3.0 # via # -r requirements/edx/base.txt # acid-xblock @@ -1599,9 +1648,9 @@ xblock[django]==5.3.0 # xblock-google-drive # xblock-utils # xblocks-contrib -xblock-drag-and-drop-v2==5.0.3 +xblock-drag-and-drop-v2==5.0.6 # via -r requirements/edx/base.txt -xblock-google-drive==0.8.1 +xblock-google-drive==0.8.2 # via -r requirements/edx/base.txt xblock-poll==1.15.1 # via -r requirements/edx/base.txt @@ -1610,20 +1659,20 @@ xblock-utils==4.0.0 # -r requirements/edx/base.txt # edx-sga # xblock-poll -xblocks-contrib==0.10.2 +xblocks-contrib==0.17.0 # via -r requirements/edx/base.txt xmlsec==1.3.14 # via # -c requirements/constraints.txt # -r requirements/edx/base.txt # python3-saml -xss-utils==0.8.0 +xss-utils==1.0.0 # via -r requirements/edx/base.txt -yarl==1.22.0 +yarl==1.24.2 # via # -r requirements/edx/base.txt # aiohttp -zipp==3.23.0 +zipp==4.1.0 # via # -r requirements/edx/base.txt # importlib-metadata diff --git a/requirements/edx/github.in b/requirements/edx/github.in index 3c01759768c9..7fdb2c051ce8 100644 --- a/requirements/edx/github.in +++ b/requirements/edx/github.in @@ -57,19 +57,21 @@ # # * DIST-NAME is the distribution name, the same name you'd use in a # "pip install" command. It might be different than REPO-NAME. It must -# be the same as the `name="DIST-NAME"` value in the repo's setup.py. +# be the same as the package name defined in the repo's pyproject.toml +# (or setup.py for older packages). # # * VERSION might not be the same as TAG-OR-SHA, but if the tag names the # version, please make it match the VERSION, but with a "v" prefix. -# VERSION must be the same as the `version="VERSION"` value in the repo's -# setup.py. An alternative is to use 0.0 as VERSION: this forces pip to -# re-install the package each time, and can be useful when working with two -# repos before picking a version number. Don't use 0.0 on master, only for -# tight-loop work in progress. +# VERSION must be the same as the version defined in the repo's pyproject.toml +# (or setup.py for older packages). An alternative is to use 0.0 as VERSION: +# this forces pip to re-install the package each time, and can be useful when +# working with two repos before picking a version number. Don't use 0.0 on +# master, only for tight-loop work in progress. # # * Don't prefix the URL with "-e". That would install the package in "editable" -# mode A.K.A "development" mode, which takes longer and does not -# fully respect setup.py, making the transition back to PyPI more complex. +# mode A.K.A "development" mode, which takes longer and does not fully respect +# the package's build configuration, making the transition back to PyPI more +# complex. # # * Organize the URL into one of the two categories below: diff --git a/requirements/edx/kernel.in b/requirements/edx/kernel.in index 9225711459ed..8abecd6ea77a 100644 --- a/requirements/edx/kernel.in +++ b/requirements/edx/kernel.in @@ -101,7 +101,7 @@ jsonfield # Django model field for validated JSON; use laboratory # Library for testing that code refactors/infrastructure changes produce identical results importlib_metadata # Used to access entry_points in i18n_api plugin lxml[html_clean] # XML parser -lti-consumer-xblock>=9.14.2 +lti-consumer-xblock>=11.0.0 mako # Primary template language used for server-side page rendering Markdown # Convert text markup to HTML; used in capa problems, forums, and course wikis meilisearch # Library to access Meilisearch search engine (will replace ElasticSearch) @@ -113,11 +113,11 @@ oauthlib # OAuth specification support for authentica olxcleaner openedx-atlas # CLI tool to manage translations openedx-calc # Library supporting mathematical calculations for Open edX +openedx-core openedx-django-require openedx-events # Open edX Events from Hooks Extension Framework (OEP-50) openedx-filters # Open edX Filters from Hooks Extension Framework (OEP-50) openedx-forum # Open edX forum v2 application -openedx-learning # Open edX Learning core (experimental) openedx-django-wiki path piexif # Exif image metadata manipulation, used in the profile_images app @@ -158,4 +158,5 @@ wrapt # Better functools.wrapped. TODO: functools XBlock[django] # Courseware component architecture xss-utils # https://github.com/openedx/edx-platform/pull/20633 Fix XSS via Translations unicodeit # Converts mathjax equation to plain text by using unicode symbols +psycopg2-binary openedx-authz # Authorization Framework for the Open edX Ecosystem diff --git a/requirements/edx/semgrep.txt b/requirements/edx/semgrep.txt index 6834996337bf..f1399ba335fe 100644 --- a/requirements/edx/semgrep.txt +++ b/requirements/edx/semgrep.txt @@ -1,18 +1,18 @@ # -# This file is autogenerated by pip-compile with Python 3.11 +# This file is autogenerated by pip-compile with Python 3.12 # by the following command: # # make upgrade # annotated-types==0.7.0 # via pydantic -anyio==4.12.1 +anyio==4.14.0 # via # httpx # mcp # sse-starlette # starlette -attrs==25.4.0 +attrs==26.1.0 # via # glom # jsonschema @@ -25,14 +25,14 @@ boltons==21.0.0 # semgrep bracex==2.6 # via wcmatch -certifi==2026.1.4 +certifi==2026.5.20 # via # httpcore # httpx # requests cffi==2.0.0 # via cryptography -charset-normalizer==3.4.4 +charset-normalizer==3.4.7 # via requests click==8.1.8 # via @@ -43,17 +43,15 @@ click-option-group==0.5.9 # via semgrep colorama==0.4.6 # via semgrep -cryptography==45.0.7 - # via - # -c requirements/constraints.txt - # pyjwt +cryptography==49.0.0 + # via pyjwt exceptiongroup==1.2.2 # via semgrep -face==24.0.0 +face==26.0.0 # via glom -glom==22.1.0 +glom==25.12.0 # via semgrep -googleapis-common-protos==1.72.0 +googleapis-common-protos==1.75.0 # via opentelemetry-exporter-otlp-proto-http h11==0.16.0 # via @@ -65,7 +63,7 @@ httpx==0.28.1 # via mcp httpx-sse==0.4.3 # via mcp -idna==3.11 +idna==3.18 # via # anyio # httpx @@ -78,7 +76,7 @@ jsonschema==4.25.1 # semgrep jsonschema-specifications==2025.9.1 # via jsonschema -markdown-it-py==4.0.0 +markdown-it-py==4.2.0 # via rich mcp==1.23.3 # via semgrep @@ -120,61 +118,65 @@ opentelemetry-semantic-conventions==0.58b0 # opentelemetry-sdk opentelemetry-util-http==0.58b0 # via opentelemetry-instrumentation-requests -packaging==25.0 +packaging==26.2 # via # opentelemetry-instrumentation # semgrep peewee==3.19.0 # via semgrep -protobuf==6.33.4 +protobuf==6.33.6 # via # googleapis-common-protos # opentelemetry-proto -pycparser==2.23 +pycparser==3.0 # via cffi -pydantic==2.12.5 +pydantic==2.13.4 # via # mcp # pydantic-settings -pydantic-core==2.41.5 +pydantic-core==2.46.4 # via pydantic -pydantic-settings==2.12.0 +pydantic-settings==2.14.1 # via mcp -pygments==2.19.2 +pygments==2.20.0 # via rich -pyjwt[crypto]==2.10.1 - # via mcp -python-dotenv==1.2.1 +pyjwt[crypto]==2.13.0 + # via + # mcp + # semgrep +python-dotenv==1.2.2 # via pydantic-settings -python-multipart==0.0.21 +python-multipart==0.0.32 # via mcp referencing==0.37.0 # via # jsonschema # jsonschema-specifications -requests==2.32.5 +requests==2.34.2 # via # opentelemetry-exporter-otlp-proto-http # semgrep -rich==13.5.3 +rich==15.0.0 # via semgrep -rpds-py==0.30.0 +rpds-py==2026.5.1 # via # jsonschema # referencing ruamel-yaml==0.19.1 # via semgrep -ruamel-yaml-clib==0.2.14 +ruamel-yaml-clib==0.2.15 + # via semgrep +semantic-version==2.10.0 # via semgrep -semgrep==1.148.0 +semgrep==1.166.0 # via -r requirements/edx/semgrep.in -sse-starlette==3.2.0 +sse-starlette==3.4.4 # via mcp -starlette==0.52.1 +starlette==1.3.1 # via # mcp # sse-starlette -tomli==2.0.2 +tomli==2.4.1 # via semgrep typing-extensions==4.15.0 # via @@ -195,11 +197,11 @@ typing-inspection==0.4.2 # mcp # pydantic # pydantic-settings -urllib3==2.6.3 +urllib3==2.7.0 # via # requests # semgrep -uvicorn==0.40.0 +uvicorn==0.49.0 # via mcp wcmatch==8.5.2 # via semgrep @@ -207,5 +209,5 @@ wrapt==1.17.3 # via # opentelemetry-instrumentation # opentelemetry-instrumentation-threading -zipp==3.23.0 +zipp==4.1.0 # via importlib-metadata diff --git a/requirements/edx/testing.in b/requirements/edx/testing.in index 14a0c781da82..b84fd39e3cab 100644 --- a/requirements/edx/testing.in +++ b/requirements/edx/testing.in @@ -27,9 +27,8 @@ factory-boy # Library for creating test fixtures, used in many tes freezegun # Allows tests to mock the output of assorted datetime module functions httpretty # Library for mocking HTTP requests, used in many tests import-linter # Tool for making assertions about which modules can import which others -isort # For checking and fixing the order of imports mock # Deprecated alias to standard library `unittest.mock` -pycodestyle # Checker for compliance with the Python style guide (PEP 8) +ruff # Fast Python linter and formatter polib # Library for manipulating gettext translation files, used to test paver i18n commands pyquery # jQuery-like API for retrieving fragments of HTML and XML files in tests pytest # Testing framework @@ -39,6 +38,7 @@ pytest-django # Django support for pytest pytest-json-report # Output json formatted warnings after running pytest pytest-metadata # To prevent 'make upgrade' failure, dependency of pytest-json-report pytest-randomly # pytest plugin to randomly order tests +pytest-reportlog # Per-test timing data including setup/teardown (used for shard rebalancing) pytest-xdist[psutil] # Parallel execution of tests on multiple CPU cores or hosts singledispatch # Backport of functools.singledispatch from Python 3.4+, used in tests of XBlock rendering testfixtures # Provides a LogCapture utility used by several tests diff --git a/requirements/edx/testing.txt b/requirements/edx/testing.txt index db4497c94a16..997a9d0704f2 100644 --- a/requirements/edx/testing.txt +++ b/requirements/edx/testing.txt @@ -1,16 +1,16 @@ # -# This file is autogenerated by pip-compile with Python 3.11 +# This file is autogenerated by pip-compile with Python 3.12 # by the following command: # # make upgrade # acid-xblock==0.4.1 # via -r requirements/edx/base.txt -aiohappyeyeballs==2.6.1 +aiohappyeyeballs==2.6.2 # via # -r requirements/edx/base.txt # aiohttp -aiohttp==3.13.3 +aiohttp==3.14.1 # via # -r requirements/edx/base.txt # geoip2 @@ -29,22 +29,19 @@ aniso8601==10.0.1 # -r requirements/edx/base.txt # edx-tincan-py35 # tincan -annotated-doc==0.0.4 - # via fastapi annotated-types==0.7.0 # via # -r requirements/edx/base.txt # pydantic -anyio==4.12.1 +anyio==4.14.0 # via # -r requirements/edx/base.txt # httpx - # starlette appdirs==1.4.4 # via # -r requirements/edx/base.txt # fs -asgiref==3.11.0 +asgiref==3.11.1 # via # -r requirements/edx/base.txt # django @@ -54,11 +51,12 @@ asn1crypto==1.5.1 # via # -r requirements/edx/base.txt # snowflake-connector-python -astroid==4.0.3 +astroid==4.0.4 # via + # -c requirements/constraints.txt # pylint # pylint-celery -attrs==25.4.0 +attrs==26.1.0 # via # -r requirements/edx/base.txt # aiohttp @@ -66,10 +64,10 @@ attrs==25.4.0 # jsonschema # lti-consumer-xblock # openedx-authz + # openedx-core # openedx-events - # openedx-learning # referencing -babel==2.17.0 +babel==2.18.0 # via # -r requirements/edx/base.txt # enmerkar @@ -82,17 +80,18 @@ bcrypt==5.0.0 # via # -r requirements/edx/base.txt # paramiko -beautifulsoup4==4.14.3 +beautifulsoup4==4.15.0 # via # -r requirements/edx/base.txt # -r requirements/edx/testing.in # openedx-forum # pynliner + # xblocks-contrib billiard==4.2.4 # via # -r requirements/edx/base.txt # celery -bleach[css]==6.3.0 +bleach[css]==6.4.0 # via # -r requirements/edx/base.txt # edx-enterprise @@ -101,14 +100,14 @@ bleach[css]==6.3.0 # ora2 # xblock-drag-and-drop-v2 # xblock-poll -boto3==1.42.30 +boto3==1.43.30 # via # -r requirements/edx/base.txt # django-ses # fs-s3fs # ora2 # snowflake-connector-python -botocore==1.42.30 +botocore==1.43.30 # via # -r requirements/edx/base.txt # boto3 @@ -124,12 +123,12 @@ cachecontrol==0.14.4 # via # -r requirements/edx/base.txt # firebase-admin -cachetools==6.2.4 +cachetools==7.1.4 # via # -r requirements/edx/base.txt # edxval # tox -camel-converter[pydantic]==5.0.0 +camel-converter[pydantic]==5.1.0 # via # -r requirements/edx/base.txt # meilisearch @@ -137,7 +136,7 @@ casbin-django-orm-adapter==1.7.0 # via # -r requirements/edx/base.txt # openedx-authz -celery==5.6.2 +celery==5.6.3 # via # -c requirements/constraints.txt # -r requirements/edx/base.txt @@ -147,8 +146,8 @@ celery==5.6.2 # edx-enterprise # enterprise-integrated-channels # event-tracking - # openedx-learning -certifi==2026.1.4 + # openedx-core +certifi==2026.5.20 # via # -r requirements/edx/base.txt # elasticsearch @@ -160,22 +159,25 @@ cffi==2.0.0 # via # -r requirements/edx/base.txt # cryptography + # pact-python-ffi # pynacl -chardet==5.2.0 +chardet==7.4.3 # via # -r requirements/edx/base.txt # -r requirements/edx/coverage.txt # diff-cover + # encutils # pysrt - # tox -charset-normalizer==3.4.4 +charset-normalizer==3.4.7 # via # -r requirements/edx/base.txt # requests # snowflake-connector-python chem==2.0.0 - # via -r requirements/edx/base.txt -click==8.3.1 + # via + # -r requirements/edx/base.txt + # xblocks-contrib +click==8.4.1 # via # -r requirements/edx/base.txt # celery @@ -188,8 +190,6 @@ click==8.3.1 # edx-lint # import-linter # nltk - # pact-python - # uvicorn click-didyoumean==0.3.1 # via # -r requirements/edx/base.txt @@ -204,7 +204,7 @@ click-repl==0.3.0 # via # -r requirements/edx/base.txt # celery -code-annotations==2.3.0 +code-annotations==3.0.0 # via # -r requirements/edx/base.txt # -r requirements/edx/testing.in @@ -215,29 +215,30 @@ codejail-includes==2.0.0 # via -r requirements/edx/base.txt colorama==0.4.6 # via tox -coverage[toml]==7.13.1 +coverage[toml]==7.14.1 # via # -r requirements/edx/coverage.txt # pytest-cov -crowdsourcehinter-xblock==0.8 +crowdsourcehinter-xblock==1.0.1 # via -r requirements/edx/base.txt -cryptography==45.0.7 +cryptography==49.0.0 # via - # -c requirements/constraints.txt # -r requirements/edx/base.txt # django-fernet-fields-v2 # edx-enterprise + # google-auth # jwcrypto # paramiko # pgpy # pyjwt # pyopenssl # snowflake-connector-python -cssselect==1.3.0 + # social-auth-core +cssselect==1.4.0 # via # -r requirements/edx/testing.in # pyquery -cssutils==2.11.1 +cssutils==2.15.0 # via # -r requirements/edx/base.txt # pynliner @@ -250,13 +251,14 @@ defusedxml==0.7.1 # ora2 # python3-openid # social-auth-core -diff-cover==10.2.0 + # xblocks-contrib +diff-cover==10.3.0 # via -r requirements/edx/coverage.txt dill==0.4.1 # via pylint -distlib==0.4.0 +distlib==0.4.3 # via virtualenv -django==5.2.11 +django==5.2.15 # via # -c requirements/common_constraints.txt # -c requirements/constraints.txt @@ -321,22 +323,23 @@ django==5.2.11 # jsonfield # lti-consumer-xblock # openedx-authz + # openedx-core # openedx-django-pyfs # openedx-django-wiki # openedx-events # openedx-filters # openedx-forum - # openedx-learning # ora2 # social-auth-app-django # super-csv # xblock-google-drive + # xblocks-contrib # xss-utils django-appconf==1.2.0 # via # -r requirements/edx/base.txt # django-statici18n -django-autocomplete-light==3.12.1 +django-autocomplete-light==4.0.1 # via -r requirements/edx/base.txt django-cache-memoize==0.2.1 # via @@ -348,7 +351,7 @@ django-classy-tags==4.1.0 # via # -r requirements/edx/base.txt # django-sekizai -django-config-models==2.9.0 +django-config-models==3.0.0 # via # -r requirements/edx/base.txt # edx-enterprise @@ -356,7 +359,7 @@ django-config-models==2.9.0 # lti-consumer-xblock django-cors-headers==4.9.0 # via -r requirements/edx/base.txt -django-countries==8.2.0 +django-countries==9.0.0 # via # -r requirements/edx/base.txt # edx-enterprise @@ -368,6 +371,7 @@ django-crum==0.7.9 # edx-proctoring # edx-rbac # edx-toggles + # openedx-authz # super-csv django-fernet-fields-v2==0.9 # via @@ -384,7 +388,7 @@ django-ipware==7.0.1 # -r requirements/edx/base.txt # edx-enterprise # edx-proctoring -django-js-asset==3.1.2 +django-js-asset==4.0.1 # via # -r requirements/edx/base.txt # django-mptt @@ -424,7 +428,7 @@ django-oauth-toolkit==1.7.1 # -r requirements/edx/base.txt # edx-enterprise # enterprise-integrated-channels -django-object-actions==5.0.0 +django-object-actions==5.1.2 # via # -r requirements/edx/base.txt # edx-enterprise @@ -441,7 +445,7 @@ django-sekizai==4.1.0 # via # -r requirements/edx/base.txt # openedx-django-wiki -django-ses==4.6.0 +django-ses==4.7.2 # via -r requirements/edx/base.txt django-simple-history==3.11.0 # via @@ -451,18 +455,17 @@ django-simple-history==3.11.0 # edx-proctoring # enterprise-integrated-channels # ora2 -django-statici18n==2.6.0 +django-statici18n==2.7.1 # via # -r requirements/edx/base.txt # lti-consumer-xblock # xblock-drag-and-drop-v2 # xblock-poll - # xblocks-contrib django-storages==1.14.6 # via # -r requirements/edx/base.txt # edxval -django-user-tasks==3.4.4 +django-user-tasks==4.0.0 # via -r requirements/edx/base.txt django-waffle==5.0.0 # via @@ -472,11 +475,12 @@ django-waffle==5.0.0 # edx-enterprise # edx-proctoring # edx-toggles -django-webpack-loader==3.2.3 + # openedx-authz +django-webpack-loader==3.2.4 # via # -r requirements/edx/base.txt # edx-proctoring -djangorestframework==3.16.1 +djangorestframework==3.17.1 # via # -r requirements/edx/base.txt # django-config-models @@ -492,8 +496,8 @@ djangorestframework==3.16.1 # edx-proctoring # edx-submissions # openedx-authz + # openedx-core # openedx-forum - # openedx-learning # ora2 # super-csv djangorestframework-xml==2.0.0 @@ -504,7 +508,7 @@ dnspython==2.8.0 # via # -r requirements/edx/base.txt # pymongo -done-xblock==2.5.0 +done-xblock==3.0.0 # via -r requirements/edx/base.txt drf-jwt==1.19.2 # via @@ -512,20 +516,20 @@ drf-jwt==1.19.2 # edx-drf-extensions drf-spectacular==0.29.0 # via -r requirements/edx/base.txt -drf-yasg==1.21.14 +drf-yasg==1.21.15 # via # -r requirements/edx/base.txt # django-user-tasks # edx-api-doc-tools edx-ace==1.15.0 # via -r requirements/edx/base.txt -edx-api-doc-tools==2.1.0 +edx-api-doc-tools==3.0.0 # via # -r requirements/edx/base.txt # openedx-authz -edx-auth-backends==4.6.2 +edx-auth-backends==5.0.0 # via -r requirements/edx/base.txt -edx-bulk-grades==1.2.0 +edx-bulk-grades==2.0.0 # via # -r requirements/edx/base.txt # staff-graded-xblock @@ -533,21 +537,24 @@ edx-ccx-keys==2.0.2 # via # -r requirements/edx/base.txt # lti-consumer-xblock + # openedx-authz # openedx-events -edx-celeryutils==1.4.0 +edx-celeryutils==2.0.0 # via # -r requirements/edx/base.txt # super-csv edx-codejail==4.1.0 - # via -r requirements/edx/base.txt -edx-completion==4.9 + # via + # -r requirements/edx/base.txt + # xblocks-contrib +edx-completion==5.0.0 # via -r requirements/edx/base.txt edx-django-release-util==1.5.0 # via # -r requirements/edx/base.txt # edx-submissions # edxval -edx-django-sites-extensions==5.1.0 +edx-django-sites-extensions==6.0.0 # via -r requirements/edx/base.txt edx-django-utils==8.0.1 # via @@ -568,6 +575,7 @@ edx-django-utils==8.0.1 # openedx-events # ora2 # super-csv + # xblocks-contrib edx-drf-extensions==10.6.0 # via # -r requirements/edx/base.txt @@ -580,25 +588,24 @@ edx-drf-extensions==10.6.0 # edxval # enterprise-integrated-channels # openedx-authz - # openedx-learning -edx-enterprise==6.6.3 + # openedx-core +edx-enterprise==8.0.18 # via # -c requirements/constraints.txt # -r requirements/edx/base.txt edx-event-bus-kafka==6.1.0 # via -r requirements/edx/base.txt -edx-event-bus-redis==0.6.1 +edx-event-bus-redis==1.0.0 # via -r requirements/edx/base.txt -edx-i18n-tools==1.9.0 +edx-i18n-tools==2.0.0 # via # -r requirements/edx/base.txt # ora2 - # xblocks-contrib -edx-lint==5.6.0 +edx-lint==6.1.0 # via -r requirements/edx/testing.in -edx-milestones==1.1.0 +edx-milestones==2.0.0 # via -r requirements/edx/base.txt -edx-opaque-keys[django]==3.0.0 +edx-opaque-keys[django]==4.0.0 # via # -r requirements/edx/base.txt # edx-bulk-grades @@ -616,37 +623,42 @@ edx-opaque-keys[django]==3.0.0 # openedx-events # openedx-filters # ora2 + # xblock # xblocks-contrib -edx-organizations==7.3.0 - # via -r requirements/edx/base.txt +edx-organizations==8.0.0 + # via + # -r requirements/edx/base.txt + # openedx-authz + # openedx-core edx-proctoring==5.2.0 # via -r requirements/edx/base.txt -edx-rbac==2.1.0 +edx-rbac==3.0.0 # via # -r requirements/edx/base.txt # edx-enterprise # enterprise-integrated-channels -edx-rest-api-client==6.2.0 +edx-rest-api-client==7.0.0 # via # -r requirements/edx/base.txt # edx-enterprise # edx-proctoring # enterprise-integrated-channels -edx-search==4.4.0 +edx-search==5.0.1 # via # -r requirements/edx/base.txt # openedx-forum -edx-sga==0.27.0 +edx-sga==0.28.0 # via -r requirements/edx/base.txt -edx-submissions==3.12.2 +edx-submissions==4.0.0 # via # -r requirements/edx/base.txt # ora2 + # xblocks-contrib edx-tincan-py35==2.0.0 # via # -r requirements/edx/base.txt # enterprise-integrated-channels -edx-toggles==5.4.1 +edx-toggles==6.0.0 # via # -r requirements/edx/base.txt # edx-auth-backends @@ -658,12 +670,15 @@ edx-toggles==5.4.1 # edxval # event-tracking # ora2 -edx-when==3.1.0 + # xblocks-contrib +edx-when==4.0.0 # via # -r requirements/edx/base.txt # edx-proctoring -edxval==3.2.0 - # via -r requirements/edx/base.txt +edxval==4.0.1 + # via + # -r requirements/edx/base.txt + # xblocks-contrib elasticsearch==7.9.1 # via # -c requirements/common_constraints.txt @@ -671,15 +686,19 @@ elasticsearch==7.9.1 # -r requirements/edx/base.txt # edx-search # openedx-forum +encutils==1.0.0 + # via + # -r requirements/edx/base.txt + # cssutils enmerkar==0.7.1 # via # -r requirements/edx/base.txt # enmerkar-underscore enmerkar-underscore==2.4.0 # via -r requirements/edx/base.txt -enterprise-integrated-channels==0.1.38 +enterprise-integrated-channels==0.1.60 # via -r requirements/edx/base.txt -event-tracking==3.3.0 +event-tracking==4.0.2 # via # -r requirements/edx/base.txt # edx-completion @@ -689,21 +708,20 @@ execnet==2.1.2 # via pytest-xdist factory-boy==3.3.3 # via -r requirements/edx/testing.in -faker==40.1.2 +faker==40.23.0 # via factory-boy -fastapi==0.128.0 - # via pact-python -fastavro==1.12.1 +fastavro==1.12.2 # via # -r requirements/edx/base.txt # openedx-events -filelock==3.20.3 +filelock==3.29.4 # via # -r requirements/edx/base.txt + # python-discovery # snowflake-connector-python # tox # virtualenv -firebase-admin==7.1.0 +firebase-admin==7.4.0 # via # -r requirements/edx/base.txt # edx-ace @@ -720,6 +738,7 @@ fs==2.4.16 # fs-s3fs # openedx-django-pyfs # xblock + # xblocks-contrib fs-s3fs==1.1.1 # via # -r requirements/edx/base.txt @@ -728,30 +747,30 @@ geoip2==5.2.0 # via -r requirements/edx/base.txt glob2==0.7 # via -r requirements/edx/base.txt -google-api-core[grpc]==2.29.0 +google-api-core[grpc]==2.31.0 # via # -r requirements/edx/base.txt # firebase-admin # google-cloud-core # google-cloud-firestore # google-cloud-storage -google-auth==2.47.0 +google-auth==2.55.0 # via # -r requirements/edx/base.txt # google-api-core # google-cloud-core # google-cloud-firestore # google-cloud-storage -google-cloud-core==2.5.0 +google-cloud-core==2.6.0 # via # -r requirements/edx/base.txt # google-cloud-firestore # google-cloud-storage -google-cloud-firestore==2.23.0 +google-cloud-firestore==2.27.0 # via # -r requirements/edx/base.txt # firebase-admin -google-cloud-storage==3.8.0 +google-cloud-storage==3.12.0 # via # -r requirements/edx/base.txt # firebase-admin @@ -760,38 +779,38 @@ google-crc32c==1.8.0 # -r requirements/edx/base.txt # google-cloud-storage # google-resumable-media -google-resumable-media==2.8.0 +google-resumable-media==2.10.0 # via # -r requirements/edx/base.txt # google-cloud-storage -googleapis-common-protos==1.72.0 +googleapis-common-protos==1.75.0 # via # -r requirements/edx/base.txt # google-api-core # grpcio-status grimp==3.14 # via import-linter -grpcio==1.76.0 +grpcio==1.81.1 # via # -r requirements/edx/base.txt # google-api-core + # google-cloud-firestore # grpcio-status -grpcio-status==1.76.0 +grpcio-status==1.81.1 # via # -r requirements/edx/base.txt # google-api-core -gunicorn==23.0.0 +gunicorn==26.0.0 # via -r requirements/edx/base.txt h11==0.16.0 # via # -r requirements/edx/base.txt # httpcore - # uvicorn h2==4.3.0 # via # -r requirements/edx/base.txt # httpx -help-tokens==3.2.0 +help-tokens==4.0.0 # via -r requirements/edx/base.txt hpack==4.1.0 # via @@ -801,6 +820,7 @@ html5lib==1.1 # via # -r requirements/edx/base.txt # ora2 + # xblocks-contrib httpcore==1.0.9 # via # -r requirements/edx/base.txt @@ -811,13 +831,14 @@ httpx[http2]==0.28.1 # via # -r requirements/edx/base.txt # firebase-admin + # typesense hyperframe==6.1.0 # via # -r requirements/edx/base.txt # h2 -icalendar==6.3.2 +icalendar==7.1.3 # via -r requirements/edx/base.txt -idna==3.11 +idna==3.18 # via # -r requirements/edx/base.txt # anyio @@ -826,9 +847,9 @@ idna==3.11 # requests # snowflake-connector-python # yarl -import-linter==2.9 +import-linter==2.11 # via -r requirements/edx/testing.in -importlib-metadata==8.7.1 +importlib-metadata==9.0.0 # via -r requirements/edx/base.txt inflection==0.5.1 # via @@ -837,7 +858,7 @@ inflection==0.5.1 # drf-yasg iniconfig==2.3.0 # via pytest -invoke==2.2.1 +invoke==3.0.3 # via # -r requirements/edx/base.txt # paramiko @@ -847,17 +868,15 @@ isodate==0.7.2 # via # -r requirements/edx/base.txt # python3-saml -isort==7.0.0 - # via - # -r requirements/edx/testing.in - # pylint +isort==8.0.1 + # via pylint jinja2==3.1.6 # via # -r requirements/edx/base.txt # -r requirements/edx/coverage.txt # code-annotations # diff-cover -jmespath==1.0.1 +jmespath==1.1.0 # via # -r requirements/edx/base.txt # boto3 @@ -889,7 +908,7 @@ jsonschema-specifications==2025.9.1 # via # -r requirements/edx/base.txt # jsonschema -jwcrypto==1.5.6 +jwcrypto==1.5.7 # via # -r requirements/edx/base.txt # django-oauth-toolkit @@ -907,16 +926,13 @@ lazy==1.6 # lti-consumer-xblock # ora2 # xblock -loremipsum==1.0.5 - # via - # -r requirements/edx/base.txt - # ora2 -lti-consumer-xblock==9.14.3 +lti-consumer-xblock==11.3.1 # via -r requirements/edx/base.txt lxml[html-clean]==5.3.2 # via # -c requirements/constraints.txt # -r requirements/edx/base.txt + # edx-enterprise # edx-i18n-tools # edxval # lti-consumer-xblock @@ -927,27 +943,28 @@ lxml[html-clean]==5.3.2 # pyquery # python3-saml # xblock + # xblocks-contrib # xmlsec -lxml-html-clean==0.4.3 +lxml-html-clean==0.4.4 # via # -r requirements/edx/base.txt # lxml mailsnake==1.6.4 # via -r requirements/edx/base.txt -mako==1.3.10 +mako==1.3.12 # via # -r requirements/edx/base.txt # acid-xblock # lti-consumer-xblock # xblock # xblock-utils -markdown==3.10 +markdown==3.10.2 # via # -r requirements/edx/base.txt # openedx-django-wiki # staff-graded-xblock # xblock-poll -markdown-it-py==4.0.0 +markdown-it-py==4.2.0 # via rich markupsafe==3.0.3 # via @@ -958,7 +975,8 @@ markupsafe==3.0.3 # mako # openedx-calc # xblock -maxminddb==3.0.0 + # xblocks-contrib +maxminddb==3.1.1 # via # -r requirements/edx/base.txt # geoip2 @@ -966,19 +984,19 @@ mccabe==0.7.0 # via pylint mdurl==0.1.2 # via markdown-it-py -meilisearch==0.40.0 +meilisearch==0.41.0 # via # -r requirements/edx/base.txt # edx-search mock==5.2.0 # via -r requirements/edx/testing.in -mongoengine==0.29.1 +mongoengine==0.29.3 # via -r requirements/edx/base.txt monotonic==1.6 # via # -r requirements/edx/base.txt # analytics-python -more-itertools==10.8.0 +more-itertools==11.1.0 # via # -r requirements/edx/base.txt # cssutils @@ -986,24 +1004,24 @@ mpmath==1.3.0 # via # -r requirements/edx/base.txt # sympy -msgpack==1.1.2 +msgpack==1.2.0 # via # -r requirements/edx/base.txt # cachecontrol -multidict==6.7.0 +multidict==6.7.1 # via # -r requirements/edx/base.txt # aiohttp # yarl -mysqlclient==2.2.7 +mysqlclient==2.2.8 # via # -r requirements/edx/base.txt # openedx-forum -nh3==0.3.2 +nh3==0.3.5 # via # -r requirements/edx/base.txt # xblocks-contrib -nltk==3.9.2 +nltk==3.9.4 # via # -r requirements/edx/base.txt # chem @@ -1017,6 +1035,7 @@ numpy==1.26.4 # openedx-calc # scipy # shapely + # xblocks-contrib oauthlib==3.3.1 # via # -r requirements/edx/base.txt @@ -1034,44 +1053,48 @@ openedx-atlas==0.7.0 # enterprise-integrated-channels # openedx-authz # openedx-forum -openedx-authz==0.20.0 +openedx-authz==1.16.0 # via -r requirements/edx/base.txt -openedx-calc==4.0.3 - # via -r requirements/edx/base.txt -openedx-django-pyfs==3.8.0 +openedx-calc==5.0.0 # via # -r requirements/edx/base.txt - # lti-consumer-xblock - # xblock # xblocks-contrib +openedx-core==1.1.0 + # via + # -c requirements/constraints.txt + # -r requirements/edx/base.txt +openedx-django-pyfs==4.0.0 + # via + # -r requirements/edx/base.txt + # xblock openedx-django-require==3.0.0 # via -r requirements/edx/base.txt -openedx-django-wiki==3.1.1 +openedx-django-wiki==3.1.2 # via -r requirements/edx/base.txt -openedx-events==10.5.0 +openedx-events==11.2.0 # via # -r requirements/edx/base.txt # edx-enterprise # edx-event-bus-kafka # edx-event-bus-redis # event-tracking + # lti-consumer-xblock + # openedx-authz + # openedx-core # ora2 -openedx-filters==2.1.0 +openedx-filters==3.4.1 # via # -r requirements/edx/base.txt + # edx-enterprise # lti-consumer-xblock # ora2 -openedx-forum==0.4.0 +openedx-forum==0.4.3 # via -r requirements/edx/base.txt -openedx-learning==0.31.0 - # via - # -c requirements/constraints.txt - # -r requirements/edx/base.txt -optimizely-sdk==5.4.0 +optimizely-sdk==5.5.0 # via -r requirements/edx/base.txt -ora2==6.17.1 +ora2==7.0.0 # via -r requirements/edx/base.txt -packaging==25.0 +packaging==26.2 # via # -r requirements/edx/base.txt # drf-yasg @@ -1081,11 +1104,12 @@ packaging==25.0 # pytest # snowflake-connector-python # tox -pact-python==1.6.0 - # via - # -c requirements/constraints.txt - # -r requirements/edx/testing.in -paramiko==4.0.0 + # wheel +pact-python==3.4.0 + # via -r requirements/edx/testing.in +pact-python-ffi==0.5.4.0 + # via pact-python +paramiko==5.0.0 # via # -r requirements/edx/base.txt # edx-enterprise @@ -1095,6 +1119,7 @@ path==16.11.0 # -r requirements/edx/base.txt # edx-i18n-tools # path-py + # xblocks-contrib path-py==12.5.0 # via # -r requirements/edx/base.txt @@ -1107,16 +1132,17 @@ pgpy==0.6.0 # edx-enterprise piexif==1.1.3 # via -r requirements/edx/base.txt -pillow==12.1.0 +pillow==12.2.0 # via # -r requirements/edx/base.txt # edx-enterprise # edx-organizations # edxval -platformdirs==4.5.1 +platformdirs==4.10.0 # via # -r requirements/edx/base.txt # pylint + # python-discovery # snowflake-connector-python # tox # virtualenv @@ -1136,17 +1162,17 @@ prompt-toolkit==3.0.52 # via # -r requirements/edx/base.txt # click-repl -propcache==0.4.1 +propcache==0.5.2 # via # -r requirements/edx/base.txt # aiohttp # yarl -proto-plus==1.27.0 +proto-plus==1.28.0 # via # -r requirements/edx/base.txt # google-api-core # google-cloud-firestore -protobuf==6.33.4 +protobuf==7.35.1 # via # -r requirements/edx/base.txt # google-api-core @@ -1154,36 +1180,32 @@ protobuf==6.33.4 # googleapis-common-protos # grpcio-status # proto-plus -psutil==7.2.1 +psutil==7.2.2 # via # -r requirements/edx/base.txt # edx-django-utils - # pact-python # pytest-xdist +psycopg2-binary==2.9.12 + # via -r requirements/edx/base.txt py==1.11.0 # via -r requirements/edx/testing.in -pyasn1==0.6.2 +pyasn1==0.6.3 # via # -r requirements/edx/base.txt # pgpy # pyasn1-modules - # rsa pyasn1-modules==0.4.2 # via # -r requirements/edx/base.txt # google-auth -pycasbin==2.7.1 +pycasbin==2.8.0 # via # -r requirements/edx/base.txt # casbin-django-orm-adapter # openedx-authz -pycodestyle==2.8.0 - # via - # -c requirements/constraints.txt - # -r requirements/edx/testing.in -pycountry==24.6.1 +pycountry==26.2.16 # via -r requirements/edx/base.txt -pycparser==2.23 +pycparser==3.0 # via # -r requirements/edx/base.txt # cffi @@ -1192,21 +1214,20 @@ pycryptodomex==3.23.0 # -r requirements/edx/base.txt # edx-proctoring # lti-consumer-xblock -pydantic==2.12.5 +pydantic==2.13.4 # via # -r requirements/edx/base.txt # camel-converter - # fastapi -pydantic-core==2.41.5 +pydantic-core==2.46.4 # via # -r requirements/edx/base.txt # pydantic -pygments==2.19.2 +pygments==2.20.0 # via # -r requirements/edx/coverage.txt # diff-cover # rich -pyjwt[crypto]==2.10.1 +pyjwt[crypto]==2.13.0 # via # -r requirements/edx/base.txt # drf-jwt @@ -1223,7 +1244,7 @@ pylatexenc==2.10 # via # -r requirements/edx/base.txt # olxcleaner -pylint==4.0.4 +pylint==4.0.6 # via # edx-lint # pylint-celery @@ -1259,16 +1280,17 @@ pynacl==1.6.2 # paramiko pynliner==0.8.0 # via -r requirements/edx/base.txt -pyopenssl==25.3.0 +pyopenssl==26.3.0 # via # -r requirements/edx/base.txt # snowflake-connector-python -pyparsing==3.3.1 +pyparsing==3.3.2 # via # -r requirements/edx/base.txt # chem # openedx-calc -pyproject-api==1.10.0 + # xblocks-contrib +pyproject-api==1.10.1 # via tox pyquery==2.0.1 # via -r requirements/edx/testing.in @@ -1290,12 +1312,13 @@ pytest==8.2.0 # pytest-json-report # pytest-metadata # pytest-randomly + # pytest-reportlog # pytest-xdist pytest-attrib==0.1.3 # via -r requirements/edx/testing.in -pytest-cov==7.0.0 +pytest-cov==7.1.0 # via -r requirements/edx/testing.in -pytest-django==4.11.1 +pytest-django==4.12.0 # via -r requirements/edx/testing.in pytest-json-report==1.5.0 # via -r requirements/edx/testing.in @@ -1303,7 +1326,9 @@ pytest-metadata==3.1.1 # via # -r requirements/edx/testing.in # pytest-json-report -pytest-randomly==4.0.1 +pytest-randomly==4.1.0 + # via -r requirements/edx/testing.in +pytest-reportlog==1.0.0 # via -r requirements/edx/testing.in pytest-xdist[psutil]==3.8.0 # via -r requirements/edx/testing.in @@ -1321,6 +1346,10 @@ python-dateutil==2.9.0.post0 # olxcleaner # ora2 # xblock +python-discovery==1.4.2 + # via + # tox + # virtualenv python-ipware==3.0.0 # via # -r requirements/edx/base.txt @@ -1329,7 +1358,7 @@ python-slugify==8.0.4 # via # -r requirements/edx/base.txt # code-annotations -python-swiftclient==4.9.0 +python-swiftclient==4.10.0 # via # -r requirements/edx/base.txt # ora2 @@ -1338,8 +1367,10 @@ python3-openid==3.2.0 ; python_version >= "3" # -r requirements/edx/base.txt # social-auth-core python3-saml==1.16.0 - # via -r requirements/edx/base.txt -pytz==2025.2 + # via + # -r requirements/edx/base.txt + # edx-enterprise +pytz==2026.2 # via # -r requirements/edx/base.txt # drf-yasg @@ -1355,6 +1386,7 @@ pytz==2025.2 # snowflake-connector-python # tincan # xblock + # xblocks-contrib pyuca==1.2 # via -r requirements/edx/base.txt pyyaml==6.0.3 @@ -1368,10 +1400,12 @@ pyyaml==6.0.3 # jsondiff # xblock random2==1.0.2 + # via + # -r requirements/edx/base.txt + # xblocks-contrib +recommender-xblock==5.0.0 # via -r requirements/edx/base.txt -recommender-xblock==3.1.0 - # via -r requirements/edx/base.txt -redis==7.1.0 +redis==8.0.0 # via # -r requirements/edx/base.txt # walrus @@ -1380,11 +1414,11 @@ referencing==0.37.0 # -r requirements/edx/base.txt # jsonschema # jsonschema-specifications -regex==2026.1.15 +regex==2026.5.9 # via # -r requirements/edx/base.txt # nltk -requests==2.32.5 +requests==2.34.2 # via # -r requirements/edx/base.txt # analytics-python @@ -1402,7 +1436,6 @@ requests==2.32.5 # meilisearch # openedx-forum # optimizely-sdk - # pact-python # pylti1p3 # python-swiftclient # requests-oauthlib @@ -1411,28 +1444,27 @@ requests==2.32.5 # snowflake-connector-python # social-auth-core # xblock-google-drive + # xblocks-contrib requests-oauthlib==2.0.0 # via # -r requirements/edx/base.txt # social-auth-core -rich==14.2.0 +rich==15.0.0 # via import-linter -rpds-py==0.30.0 +rpds-py==2026.5.1 # via # -r requirements/edx/base.txt # jsonschema # referencing -rsa==4.9.1 - # via - # -r requirements/edx/base.txt - # google-auth +ruff==0.15.17 + # via -r requirements/edx/testing.in rules==3.5 # via # -r requirements/edx/base.txt # edx-enterprise # edx-proctoring - # openedx-learning -s3transfer==0.16.0 + # openedx-core +s3transfer==0.18.0 # via # -r requirements/edx/base.txt # boto3 @@ -1440,7 +1472,7 @@ sailthru-client==2.2.3 # via # -r requirements/edx/base.txt # edx-ace -scipy==1.17.0 +scipy==1.17.1 # via # -r requirements/edx/base.txt # chem @@ -1449,18 +1481,21 @@ semantic-version==2.10.0 # -r requirements/edx/base.txt # edx-drf-extensions shapely==2.1.2 - # via -r requirements/edx/base.txt -simpleeval==1.0.3 + # via + # -r requirements/edx/base.txt + # xblocks-contrib +simpleeval==1.0.7 # via # -r requirements/edx/base.txt # pycasbin -simplejson==3.20.2 +simplejson==4.1.1 # via # -r requirements/edx/base.txt # sailthru-client # super-csv # xblock # xblock-utils + # xblocks-contrib singledispatch==4.1.2 # via -r requirements/edx/testing.in six==1.17.0 @@ -1480,7 +1515,6 @@ six==1.17.0 # fs # fs-s3fs # html5lib - # pact-python # python-dateutil slumber==0.7.1 # via @@ -1488,22 +1522,22 @@ slumber==0.7.1 # edx-bulk-grades # edx-enterprise # enterprise-integrated-channels -snowflake-connector-python==4.2.0 +snowflake-connector-python==4.6.0 # via # -r requirements/edx/base.txt - # edx-enterprise # enterprise-integrated-channels social-auth-app-django==5.4.1 # via # -c requirements/constraints.txt # -r requirements/edx/base.txt # edx-auth-backends -social-auth-core==4.8.3 + # edx-enterprise +social-auth-core==4.9.1 # via # -r requirements/edx/base.txt # edx-auth-backends # social-auth-app-django -sorl-thumbnail==12.11.0 +sorl-thumbnail==13.0.0 # via # -r requirements/edx/base.txt # openedx-django-wiki @@ -1511,7 +1545,7 @@ sortedcontainers==2.4.0 # via # -r requirements/edx/base.txt # snowflake-connector-python -soupsieve==2.8.3 +soupsieve==2.8.4 # via # -r requirements/edx/base.txt # beautifulsoup4 @@ -1519,11 +1553,9 @@ sqlparse==0.5.5 # via # -r requirements/edx/base.txt # django -staff-graded-xblock==3.1.0 +staff-graded-xblock==4.0.1 # via -r requirements/edx/base.txt -starlette==0.50.0 - # via fastapi -stevedore==5.6.0 +stevedore==5.8.0 # via # -r requirements/edx/base.txt # code-annotations @@ -1531,7 +1563,7 @@ stevedore==5.6.0 # edx-django-utils # edx-enterprise # edx-opaque-keys -super-csv==4.1.0 +super-csv==5.0.0 # via # -r requirements/edx/base.txt # edx-bulk-grades @@ -1539,7 +1571,7 @@ sympy==1.14.0 # via # -r requirements/edx/base.txt # openedx-calc -testfixtures==10.0.0 +testfixtures==12.1.0 # via # -r requirements/edx/base.txt # -r requirements/edx/testing.in @@ -1552,53 +1584,64 @@ tincan==1.0.0 # via # -r requirements/edx/base.txt # edx-enterprise -tinycss2==1.4.0 +tinycss2==1.5.1 # via # -r requirements/edx/base.txt # bleach -tomlkit==0.14.0 +tomli-w==1.2.0 + # via tox +tomlkit==0.15.0 # via # -r requirements/edx/base.txt - # openedx-learning + # edx-lint + # openedx-core # pylint # snowflake-connector-python -tox==4.34.1 +tox==4.55.1 # via -r requirements/edx/testing.in -tqdm==4.67.1 +tqdm==4.68.2 # via # -r requirements/edx/base.txt # nltk +typesense==2.0.0 + # via + # -r requirements/edx/base.txt + # edx-search + # openedx-forum typing-extensions==4.15.0 # via # -r requirements/edx/base.txt + # aiohttp # aiosignal # anyio # beautifulsoup4 # django-countries # edx-opaque-keys - # fastapi # grimp # grpcio + # icalendar # import-linter # jwcrypto + # pact-python # pydantic # pydantic-core # pylti1p3 # pyopenssl # referencing # snowflake-connector-python - # starlette + # testfixtures + # typesense # typing-inspection typing-inspection==0.4.2 # via # -r requirements/edx/base.txt # pydantic -tzdata==2025.3 +tzdata==2026.2 # via # -r requirements/edx/base.txt # icalendar # kombu -tzlocal==5.3.1 +tzlocal==5.4 # via # -r requirements/edx/base.txt # celery @@ -1616,22 +1659,19 @@ uritemplate==4.2.0 # -r requirements/edx/base.txt # drf-spectacular # drf-yasg -urllib3==2.6.3 +urllib3==2.7.0 # via # -r requirements/edx/base.txt # botocore # elasticsearch - # pact-python # requests -uvicorn==0.40.0 - # via pact-python vine==5.1.0 # via # -r requirements/edx/base.txt # amqp # celery # kombu -virtualenv==20.36.1 +virtualenv==21.5.0 # via tox voluptuous==0.16.0 # via @@ -1645,17 +1685,14 @@ wcmatch==10.1 # via # -r requirements/edx/base.txt # pycasbin -wcwidth==0.2.14 +wcwidth==0.8.1 # via # -r requirements/edx/base.txt # prompt-toolkit -web-fragments==3.1.0 +web-fragments==4.0.0 # via # -r requirements/edx/base.txt - # crowdsourcehinter-xblock # edx-sga - # staff-graded-xblock - # xblock # xblock-utils webencodings==0.5.1 # via @@ -1663,17 +1700,20 @@ webencodings==0.5.1 # bleach # html5lib # tinycss2 -webob==1.8.9 +webob==1.8.10 # via # -r requirements/edx/base.txt # xblock -wheel==0.45.1 + # xblocks-contrib +wheel==0.47.0 # via # -r requirements/edx/base.txt # django-pipeline -wrapt==2.0.1 - # via -r requirements/edx/base.txt -xblock[django]==5.3.0 +wrapt==2.2.1 + # via + # -r requirements/edx/base.txt + # xblocks-contrib +xblock[django]==6.3.0 # via # -r requirements/edx/base.txt # acid-xblock @@ -1689,9 +1729,9 @@ xblock[django]==5.3.0 # xblock-google-drive # xblock-utils # xblocks-contrib -xblock-drag-and-drop-v2==5.0.3 +xblock-drag-and-drop-v2==5.0.6 # via -r requirements/edx/base.txt -xblock-google-drive==0.8.1 +xblock-google-drive==0.8.2 # via -r requirements/edx/base.txt xblock-poll==1.15.1 # via -r requirements/edx/base.txt @@ -1700,20 +1740,21 @@ xblock-utils==4.0.0 # -r requirements/edx/base.txt # edx-sga # xblock-poll -xblocks-contrib==0.10.2 +xblocks-contrib==0.17.0 # via -r requirements/edx/base.txt xmlsec==1.3.14 # via # -c requirements/constraints.txt # -r requirements/edx/base.txt # python3-saml -xss-utils==0.8.0 +xss-utils==1.0.0 # via -r requirements/edx/base.txt -yarl==1.22.0 +yarl==1.24.2 # via # -r requirements/edx/base.txt # aiohttp -zipp==3.23.0 + # pact-python +zipp==4.1.0 # via # -r requirements/edx/base.txt # importlib-metadata diff --git a/requirements/pip-tools.txt b/requirements/pip-tools.txt index f8b99699aeef..56ff83513ea3 100644 --- a/requirements/pip-tools.txt +++ b/requirements/pip-tools.txt @@ -1,26 +1,30 @@ # -# This file is autogenerated by pip-compile with Python 3.11 +# This file is autogenerated by pip-compile with Python 3.12 # by the following command: # # make upgrade # -build==1.4.0 +build==1.5.0 # via pip-tools -click==8.3.1 +click==8.4.1 # via pip-tools -packaging==25.0 - # via build -pip-tools==7.5.2 +packaging==26.2 + # via + # build + # wheel +pip-tools==7.5.3 # via -r requirements/pip-tools.in pyproject-hooks==1.2.0 # via # build # pip-tools -wheel==0.45.1 +wheel==0.47.0 # via pip-tools # The following packages are considered to be unsafe in a requirements file: -pip==25.3 - # via pip-tools -setuptools==80.9.0 +pip==26.1.2 # via pip-tools +setuptools==81.0.0 + # via + # -c requirements/constraints.txt + # pip-tools diff --git a/scripts/compile_sass.py b/scripts/compile_sass.py index 70d49d21cce8..72d17edd22b1 100755 --- a/scripts/compile_sass.py +++ b/scripts/compile_sass.py @@ -49,7 +49,6 @@ import click - # Accept both long- and short-forms of these words, but normalize to long form. # We accept both because edx-platform asset build scripts historically use the short form, # but NODE_ENV uses the long form, so to make them integrate more seamlessly we accept both. @@ -215,15 +214,15 @@ def compile_sass_dir( click.secho(f" Target: {target_root}") if not source_root.is_dir(): if tolerate_missing: - click.secho(f" Skipped because source directory does not exist.", fg="yellow") + click.secho(f" Skipped because source directory does not exist.", fg="yellow") # noqa: F541 return else: raise FileNotFoundError(f"missing Sass source dir: {source_root}") - click.echo(f" Include paths:") + click.echo(f" Include paths:") # noqa: F541 for include in includes: click.echo(f" {include}") - click.echo(f" Files:") + click.echo(f" Files:") # noqa: F541 for dirpath, _, filenames in os.walk(str(source_root)): for filename in filenames: if filename.startswith('_'): @@ -254,7 +253,7 @@ def compile_sass_dir( with open(target, 'w', encoding="utf-8") as target_file: target_file.write(output_text) - click.secho(f" Done.", fg="green") + click.secho(f" Done.", fg="green") # noqa: F541 # For Sass files without explicit RTL versions, generate # an RTL version of the CSS using the rtlcss library. for sass_path in glob.glob(str(source_root) + "/**/*.scss"): @@ -281,7 +280,7 @@ def compile_sass_dir( # Information click.secho(f"USING ENV: {NORMALIZED_ENVS[env]}", fg="blue") if dry: - click.secho(f"DRY RUN: Will print compile steps, but will not compile anything.", fg="blue") + click.secho(f"DRY RUN: Will print compile steps, but will not compile anything.", fg="blue") # noqa: F541 click.echo() # Warnings @@ -330,7 +329,7 @@ def compile_sass_dir( ] if not skip_default: - click.secho(f"Compiling default Sass...", fg="cyan", bold=True) + click.secho(f"Compiling default Sass...", fg="cyan", bold=True) # noqa: F541 if not skip_lms: compile_sass_dir( "Compiling default LMS Sass", @@ -364,7 +363,7 @@ def compile_sass_dir( repo / "cms" / "static" / "sass", ], ) - click.secho(f"Done compiling default Sass!", fg="cyan", bold=True) + click.secho(f"Done compiling default Sass!", fg="cyan", bold=True) # noqa: F541 click.echo() for theme in theme_paths: @@ -442,9 +441,9 @@ def compile_sass_dir( for theme in theme_paths: click.secho(f" - {theme}", fg="green") if skip_lms: - click.secho(f"(skipped LMS)", fg="yellow") + click.secho(f"(skipped LMS)", fg="yellow") # noqa: F541 if skip_cms: - click.secho(f"(skipped CMS)", fg="yellow") + click.secho(f"(skipped CMS)", fg="yellow") # noqa: F541 if __name__ == "__main__": diff --git a/scripts/gha_unit_tests_collector.py b/scripts/gha_unit_tests_collector.py index b72257049e05..87fa26fa4d91 100644 --- a/scripts/gha_unit_tests_collector.py +++ b/scripts/gha_unit_tests_collector.py @@ -24,7 +24,7 @@ def update_unit_test_modules(module_name, shard_config, unit_test_modules): def get_unit_test_modules(module_name="lms"): unit_test_modules = set() all_unit_test_shards = get_all_unit_test_shards() - for shard_name, shard_config in all_unit_test_shards.items(): + for shard_name, shard_config in all_unit_test_shards.items(): # noqa: B007 unit_test_modules = update_unit_test_modules(module_name, shard_config, unit_test_modules) return unit_test_modules diff --git a/scripts/jwk-precompute-params.py b/scripts/jwk-precompute-params.py index c75d86f6c739..20e427cb8ae7 100755 --- a/scripts/jwk-precompute-params.py +++ b/scripts/jwk-precompute-params.py @@ -14,7 +14,6 @@ from jwt.algorithms import RSAAlgorithm - print("Paste the key's JSON, followed by a new line and Ctrl-D:\n", file=sys.stderr) old_jwk_data = json.loads(sys.stdin.read()) diff --git a/scripts/show_events.py b/scripts/show_events.py index d1bf34d593bb..ec935d6b2c31 100644 --- a/scripts/show_events.py +++ b/scripts/show_events.py @@ -1,4 +1,4 @@ -# lint-amnesty, pylint: disable=django-not-configured +# pylint: disable=django-not-configured """ Show Event outputs. """ @@ -11,7 +11,7 @@ try: import dateutil.parser except ImportError: - def date_string(ds, fmt=''): # lint-amnesty, pylint: disable=unused-argument + def date_string(ds, fmt=''): # pylint: disable=unused-argument return ds else: def date_string(ds, fmt='%Y-%m-%d %H:%M:%S.%f'): @@ -19,7 +19,7 @@ def date_string(ds, fmt='%Y-%m-%d %H:%M:%S.%f'): return d.strftime(fmt) -def display(message): # lint-amnesty, pylint: disable=missing-function-docstring +def display(message): # pylint: disable=missing-function-docstring print('{} - {}'.format(date_string(message['time']), message['event_type'])) if message.get('event'): event = json.loads(message['event']) @@ -34,6 +34,6 @@ def display(message): # lint-amnesty, pylint: disable=missing-function-docstrin try: obj = json.loads(line) display(obj) - except Exception: # lint-amnesty, pylint: disable=broad-except + except Exception: # pylint: disable=broad-except traceback.print_exc() continue diff --git a/scripts/stable_bucketer b/scripts/stable_bucketer index 58fbc4386b0e..b2c9853b54cb 100755 --- a/scripts/stable_bucketer +++ b/scripts/stable_bucketer @@ -5,6 +5,7 @@ import hashlib import random import re import string + ##### diff --git a/scripts/structures_pruning/README.rst b/scripts/structures_pruning/README.rst index 77bc6bfbf0c8..9939a09747e1 100644 --- a/scripts/structures_pruning/README.rst +++ b/scripts/structures_pruning/README.rst @@ -1,7 +1,7 @@ Structures Pruning Scripts ========================== -`This `_ directory contains mongo db structures pruning script that is migrated from the +`This `_ directory contains mongo db structures pruning script that is migrated from the `tubular `_ repository. @@ -29,11 +29,11 @@ To download the scripts, you can perform a partial clone of the edx-platform rep Create Python Virtual Environment --------------------------------- -Create a Python virtual environment using Python 3.11: +Create a Python virtual environment using Python 3.12: .. code-block:: bash - python3.11 -m venv ../venv + python3.12 -m venv ../venv source ../venv/bin/activate Install Pip Packages diff --git a/scripts/structures_pruning/requirements/base.txt b/scripts/structures_pruning/requirements/base.txt index c6a16b5c75c6..43fbe263fd1c 100644 --- a/scripts/structures_pruning/requirements/base.txt +++ b/scripts/structures_pruning/requirements/base.txt @@ -1,10 +1,10 @@ # -# This file is autogenerated by pip-compile with Python 3.11 +# This file is autogenerated by pip-compile with Python 3.12 # by the following command: # # make upgrade # -click==8.3.1 +click==8.4.1 # via # -r scripts/structures_pruning/requirements/base.in # click-log @@ -12,14 +12,14 @@ click-log==0.4.0 # via -r scripts/structures_pruning/requirements/base.in dnspython==2.8.0 # via pymongo -edx-opaque-keys==3.0.0 +edx-opaque-keys==4.0.0 # via -r scripts/structures_pruning/requirements/base.in pymongo==4.4.0 # via # -c requirements/constraints.txt # -r scripts/structures_pruning/requirements/base.in # edx-opaque-keys -stevedore==5.6.0 +stevedore==5.8.0 # via edx-opaque-keys typing-extensions==4.15.0 # via edx-opaque-keys diff --git a/scripts/structures_pruning/requirements/testing.txt b/scripts/structures_pruning/requirements/testing.txt index a9b2ac78d832..1fd6e5024650 100644 --- a/scripts/structures_pruning/requirements/testing.txt +++ b/scripts/structures_pruning/requirements/testing.txt @@ -1,10 +1,10 @@ # -# This file is autogenerated by pip-compile with Python 3.11 +# This file is autogenerated by pip-compile with Python 3.12 # by the following command: # # make upgrade # -click==8.3.1 +click==8.4.1 # via # -r scripts/structures_pruning/requirements/base.txt # click-log @@ -16,23 +16,23 @@ dnspython==2.8.0 # via # -r scripts/structures_pruning/requirements/base.txt # pymongo -edx-opaque-keys==3.0.0 +edx-opaque-keys==4.0.0 # via -r scripts/structures_pruning/requirements/base.txt iniconfig==2.3.0 # via pytest -packaging==25.0 +packaging==26.2 # via pytest pluggy==1.6.0 # via pytest -pygments==2.19.2 +pygments==2.20.0 # via pytest pymongo==4.4.0 # via # -r scripts/structures_pruning/requirements/base.txt # edx-opaque-keys -pytest==9.0.2 +pytest==9.1.0 # via -r scripts/structures_pruning/requirements/testing.in -stevedore==5.6.0 +stevedore==5.8.0 # via # -r scripts/structures_pruning/requirements/base.txt # edx-opaque-keys diff --git a/scripts/structures_pruning/structures.py b/scripts/structures_pruning/structures.py index 6b3f99182f78..d54d685db40d 100644 --- a/scripts/structures_pruning/structures.py +++ b/scripts/structures_pruning/structures.py @@ -6,8 +6,8 @@ """ import logging -from os import path import sys +from os import path import click import click_log @@ -15,7 +15,7 @@ # Add top-level project path to sys.path before importing scripts code sys.path.append(path.abspath(path.join(path.dirname(__file__), '../..'))) -from scripts.structures_pruning.utils.splitmongo import SplitMongoBackend, ChangePlan +from scripts.structures_pruning.utils.splitmongo import ChangePlan, SplitMongoBackend # Add top-level module path to sys.path before importing tubular code. # sys.path.append(os.path.dirname(os.path.dirname(os.path.abspath(__file__)))) @@ -187,7 +187,7 @@ def prune(ctx, plan_file, delay, batch_size, start): change_plan = ChangePlan.load(plan_file) if start is not None and start not in change_plan.delete: raise click.BadParameter( - "{} is not in the Change Plan {}".format( + "{} is not in the Change Plan {}".format( # noqa: UP032 start, click.format_filename(plan_file.name) ), param_hint='--start' diff --git a/scripts/structures_pruning/tests/test_splitmongo.py b/scripts/structures_pruning/tests/test_splitmongo.py index 706afd800778..03bde213d073 100644 --- a/scripts/structures_pruning/tests/test_splitmongo.py +++ b/scripts/structures_pruning/tests/test_splitmongo.py @@ -23,7 +23,11 @@ sys.path.append(path.abspath(path.join(path.dirname(__file__), '../..'))) from scripts.structures_pruning.utils.splitmongo import ( - ActiveVersionBranch, ChangePlan, Structure, SplitMongoBackend, StructuresGraph + ActiveVersionBranch, + ChangePlan, + SplitMongoBackend, + Structure, + StructuresGraph, ) @@ -38,7 +42,7 @@ def create_test_graph(*version_histories): all_structures = {} all_active_version_branches = [] - active_id_pool = ("A{:023x}".format(i) for i in itertools.count(1)) + active_id_pool = ("A{:023x}".format(i) for i in itertools.count(1)) # noqa: UP032 course_key_pool = ( CourseLocator('edx', 'splitmongo', str(i)) for i in itertools.count(1) ) @@ -53,7 +57,7 @@ def create_test_graph(*version_histories): history = [Structure(original_id, original_id, None)] # Create all other Structures (if any) - for previous_id, current_id in zip(structure_ids, structure_ids[1:]): + for previous_id, current_id in zip(structure_ids, structure_ids[1:]): # noqa: B905 history.append(Structure(current_id, original_id, previous_id)) # Add to our overall Structures dict (overwrites should be identical or @@ -91,18 +95,18 @@ def test_simple(self): # Preserve no intermediate structures -- prune the middle structures. plan_no_intermediate = ChangePlan.create(graph, 0, False, False) - self.assertEqual(plan_no_intermediate.delete, ["2", "3"]) - self.assertEqual(plan_no_intermediate.update_parents, [("4", "1")]) + self.assertEqual(plan_no_intermediate.delete, ["2", "3"]) # noqa: PT009 + self.assertEqual(plan_no_intermediate.update_parents, [("4", "1")]) # noqa: PT009 # Preserve one intermediate structure plan_1_intermediate = ChangePlan.create(graph, 1, False, False) - self.assertEqual(plan_1_intermediate.delete, ["2"]) - self.assertEqual(plan_1_intermediate.update_parents, [("3", "1")]) + self.assertEqual(plan_1_intermediate.delete, ["2"]) # noqa: PT009 + self.assertEqual(plan_1_intermediate.update_parents, [("3", "1")]) # noqa: PT009 # Preserve two intermediate structures -- Do nothing plan_2_intermediate = ChangePlan.create(graph, 2, False, False) - self.assertEqual(plan_2_intermediate.delete, []) - self.assertEqual(plan_2_intermediate.update_parents, []) + self.assertEqual(plan_2_intermediate.delete, []) # noqa: PT009 + self.assertEqual(plan_2_intermediate.update_parents, []) # noqa: PT009 @ddt.data( create_test_graph(["1"]), # Original (is also Active) @@ -112,9 +116,9 @@ def test_no_changes(self, graph): """These scenarios should result in no Changes.""" plan_1 = ChangePlan.create(graph, 0, False, False) plan_2 = ChangePlan.create(graph, 2, False, False) - self.assertEqual(plan_1, plan_2) - self.assertEqual(plan_1.delete, []) - self.assertEqual(plan_1.update_parents, []) + self.assertEqual(plan_1, plan_2) # noqa: PT009 + self.assertEqual(plan_1.delete, []) # noqa: PT009 + self.assertEqual(plan_1.update_parents, []) # noqa: PT009 def test_overlapping_shared_history(self): """Test multiple branches that overlap in what history to preserve.""" @@ -141,8 +145,8 @@ def test_overlapping_shared_history(self): # "8" is marked for deletion by the fourth branch. # "9" is preserved by the fourth branch. # "10" is the Active Structure for the fourth branch. - self.assertEqual(plan.delete, ["7", "8"]) - self.assertEqual(plan.update_parents, [("9", "1")]) + self.assertEqual(plan.delete, ["7", "8"]) # noqa: PT009 + self.assertEqual(plan.update_parents, [("9", "1")]) # noqa: PT009 def test_non_overlapping_shared_history(self): """Test shared history, preserved intermediate set doesn't overlap.""" @@ -151,16 +155,16 @@ def test_non_overlapping_shared_history(self): ["1", "2", "3", "4", "5", "6"], ) plan = ChangePlan.create(graph, 0, False, False) - self.assertEqual(plan.delete, ["2", "4", "5"]) - self.assertEqual(plan.update_parents, [("3", "1"), ("6", "1")]) + self.assertEqual(plan.delete, ["2", "4", "5"]) # noqa: PT009 + self.assertEqual(plan.update_parents, [("3", "1"), ("6", "1")]) # noqa: PT009 graph_save_1 = create_test_graph( ["1", "2", "3", "4"], ["1", "2", "3", "4", "5", "6", "7"], ) plan_save_1 = ChangePlan.create(graph_save_1, 1, False, False) - self.assertEqual(plan_save_1.delete, ["2", "5"]) - self.assertEqual(plan_save_1.update_parents, [("3", "1"), ("6", "1")]) + self.assertEqual(plan_save_1.delete, ["2", "5"]) # noqa: PT009 + self.assertEqual(plan_save_1.update_parents, [("3", "1"), ("6", "1")]) # noqa: PT009 def test_details_output(self): """Test our details file output.""" @@ -200,8 +204,8 @@ def test_details_output(self): """ ).lstrip() # pylint: enable=line-too-long - self.assertEqual(expected_output, details_txt) - self.assertEqual( + self.assertEqual(expected_output, details_txt) # noqa: PT009 + self.assertEqual( # noqa: PT009 plan, ChangePlan( delete=["5"], @@ -227,11 +231,11 @@ def test_parse_structure_doc(self): 'extra_data': "This is ignored" } ) - self.assertEqual( + self.assertEqual( # noqa: PT009 original_structure, Structure(id=str_id(1), original_id=str_id(1), previous_id=None) ) - self.assertTrue(original_structure.is_original()) + self.assertTrue(original_structure.is_original()) # noqa: PT009 other_structure = SplitMongoBackend.parse_structure_doc( { @@ -241,27 +245,27 @@ def test_parse_structure_doc(self): 'extra_data': "This is ignored" } ) - self.assertEqual( + self.assertEqual( # noqa: PT009 other_structure, Structure(id=str_id(2), original_id=str_id(1), previous_id=str_id(1)) ) - self.assertFalse(other_structure.is_original()) + self.assertFalse(other_structure.is_original()) # noqa: PT009 def test_batch(self): """Test the batch helper that breaks up iterables for DB operations.""" - self.assertEqual( + self.assertEqual( # noqa: PT009 list(SplitMongoBackend.batch([], 1)), [] ) - self.assertEqual( + self.assertEqual( # noqa: PT009 list(SplitMongoBackend.batch([1, 2, 3], 1)), [[1], [2], [3]] ) - self.assertEqual( + self.assertEqual( # noqa: PT009 list(SplitMongoBackend.batch([1, 2, 3], 2)), [[1, 2], [3]] ) - self.assertEqual( + self.assertEqual( # noqa: PT009 list(SplitMongoBackend.batch([1, 2, 3, 4], 2)), [[1, 2], [3, 4]] ) @@ -269,23 +273,23 @@ def test_batch(self): def test_iter_from_start(self): """Test what we use to resume deletion from a given Structure ID.""" all_ids = [1, 2, 3] - self.assertEqual( + self.assertEqual( # noqa: PT009 list(SplitMongoBackend.iter_from_start(all_ids, None)), all_ids ) - self.assertEqual( + self.assertEqual( # noqa: PT009 list(SplitMongoBackend.iter_from_start(all_ids, 1)), all_ids ) - self.assertEqual( + self.assertEqual( # noqa: PT009 list(SplitMongoBackend.iter_from_start(all_ids, 2)), [2, 3] ) - self.assertEqual( + self.assertEqual( # noqa: PT009 list(SplitMongoBackend.iter_from_start(all_ids, 3)), [3] ) - self.assertEqual( + self.assertEqual( # noqa: PT009 list(SplitMongoBackend.iter_from_start(all_ids, 4)), [] ) @@ -378,7 +382,7 @@ def seed_data(self): def test_structures_graph(self): """Test pulling a full graph out.""" graph = self.backend.structures_graph(0, 100) - self.assertEqual( + self.assertEqual( # noqa: PT009 graph.branches, [ ActiveVersionBranch( @@ -404,7 +408,7 @@ def test_structures_graph(self): ), ] ) - self.assertEqual( + self.assertEqual( # noqa: PT009 list(graph.structures.keys()), [str_id(i) for i in [1, 2, 3, 4, 10, 11, 20]] ) @@ -419,11 +423,11 @@ def test_update(self): delay=0 ) graph = self.backend.structures_graph(0, 100) - self.assertEqual( + self.assertEqual( # noqa: PT009 list(graph.structures.keys()), [str_id(i) for i in [1, 4, 10, 11, 20]] ) - self.assertEqual( + self.assertEqual( # noqa: PT009 graph.structures, { str_id(1): Structure(id=str_id(1), original_id=str_id(1), previous_id=None), @@ -482,19 +486,19 @@ def add_structures(backend, delay, batch_size): with patch.object(SplitMongoBackend, '_all_structures', autospec=True) as all_structures_mock: all_structures_mock.side_effect = add_structures graph = self.backend.structures_graph(0, 100) - self.assertEqual(len(graph.structures), 10) - self.assertEqual(len(graph.branches), 4) + self.assertEqual(len(graph.structures), 10) # noqa: PT009 + self.assertEqual(len(graph.branches), 4) # noqa: PT009 plan = ChangePlan.create(graph, 0, False, False) - self.assertNotIn(str_id(5), plan.delete) # Active updated to this for our course. - self.assertNotIn(str_id(7), plan.delete) # Active for our new Library - self.assertIn(str_id(4), plan.delete) # Was our Active before - self.assertIn(str_id(6), plan.delete) # Intermediate structure to new Library + self.assertNotIn(str_id(5), plan.delete) # Active updated to this for our course. # noqa: PT009 + self.assertNotIn(str_id(7), plan.delete) # Active for our new Library # noqa: PT009 + self.assertIn(str_id(4), plan.delete) # Was our Active before # noqa: PT009 + self.assertIn(str_id(6), plan.delete) # Intermediate structure to new Library # noqa: PT009 def str_id(int_id): """Return the string version of Object IDs that PyMongo will accept.""" - return "{:024}".format(int_id) + return "{:024}".format(int_id) # noqa: UP032 def obj_id(int_id): diff --git a/scripts/structures_pruning/utils/splitmongo.py b/scripts/structures_pruning/utils/splitmongo.py index 69e1caf29185..8b79c31233f5 100644 --- a/scripts/structures_pruning/utils/splitmongo.py +++ b/scripts/structures_pruning/utils/splitmongo.py @@ -39,17 +39,17 @@ means that it will work for databases with up to about 10 million Structures before RAM usage starts to become a problem. """ -from collections import deque, namedtuple -from itertools import count, takewhile import json import logging import os import sys import time +from collections import deque, namedtuple +from itertools import count, takewhile from bson.objectid import ObjectId -from pymongo import MongoClient, UpdateOne from opaque_keys.edx.locator import CourseLocator, LibraryLocator +from pymongo import MongoClient, UpdateOne LOG = logging.getLogger('structures') @@ -367,18 +367,18 @@ def text_for(s_id): if notes: return "{} {} {}".format(action, s_id, " ".join(notes)) - return "{} {}".format(action, s_id) + return "{} {}".format(action, s_id) # noqa: UP032 print("== Summary ==", file=details_file) - print("Active Version Branches: {}".format(len(branches)), file=details_file) - print("Total Structures: {}".format(len(structures)), file=details_file) - print("Structures to Save: {}".format(len(structure_ids_to_save)), file=details_file) - print("Structures to Delete: {}".format(len(structures) - len(structure_ids_to_save)), file=details_file) - print("Structures to Rewrite Parent Link: {}".format(len(set_parent_to_original)), file=details_file) + print("Active Version Branches: {}".format(len(branches)), file=details_file) # noqa: UP032 + print("Total Structures: {}".format(len(structures)), file=details_file) # noqa: UP032 + print("Structures to Save: {}".format(len(structure_ids_to_save)), file=details_file) # noqa: UP032 + print("Structures to Delete: {}".format(len(structures) - len(structure_ids_to_save)), file=details_file) # noqa: UP032 + print("Structures to Rewrite Parent Link: {}".format(len(set_parent_to_original)), file=details_file) # noqa: UP032 print("\n== Active Versions ==", file=details_file) for branch in branches: - print("{}".format(branch), file=details_file) + print("{}".format(branch), file=details_file) # noqa: UP032 for structure_id in structures_graph.traverse_ids(branch.structure_id, include_start=True): print(text_for(structure_id), file=details_file) print("", file=details_file) diff --git a/scripts/user_retirement/README.rst b/scripts/user_retirement/README.rst index 380a2489108b..806305dcf86b 100644 --- a/scripts/user_retirement/README.rst +++ b/scripts/user_retirement/README.rst @@ -28,11 +28,11 @@ To download the scripts, you can perform a partial clone of the edx-platform rep Create Python Virtual Environment --------------------------------- -Create a Python virtual environment using Python 3.11: +Create a Python virtual environment using Python 3.12: .. code-block:: bash - python3.11 -m venv ../venv + python3.12 -m venv ../venv source ../venv/bin/activate Install Pip Packages diff --git a/scripts/user_retirement/docs/driver_setup.rst b/scripts/user_retirement/docs/driver_setup.rst index 334b99ba68d9..f419405f466e 100644 --- a/scripts/user_retirement/docs/driver_setup.rst +++ b/scripts/user_retirement/docs/driver_setup.rst @@ -55,14 +55,15 @@ of execution for each environment. Each item is a list in the form of: #. Start state name #. End state name -#. IDA to call against (LMS, ECOMMERCE, or CREDENTIALS currently) +#. Service key to call against (for example, LMS or LICENSE_MANAGER) #. Method name to call in `edx_api.py `_ -For example: ``['RETIRING_CREDENTIALS', 'CREDENTIALS_COMPLETE', 'CREDENTIALS', -'retire_learner']`` will set the user's state to ``RETIRING_CREDENTIALS``, call -a pre-instantiated ``retire_learner`` method in the ``CredentialsApi``, then set -the user's state to ``CREDENTIALS_COMPLETE``. +For example: ``['RETIRING_ENROLLMENTS', 'ENROLLMENTS_COMPLETE', 'LMS', +'retirement_unenroll']`` will set the user's state to +``RETIRING_ENROLLMENTS``, call a pre-instantiated ``retirement_unenroll`` +method in the ``LmsApi``, then set the user's state to +``ENROLLMENTS_COMPLETE``. Examples ******** diff --git a/scripts/user_retirement/get_learners_to_retire.py b/scripts/user_retirement/get_learners_to_retire.py index 6c02196e4412..0b8d4e1cddd3 100755 --- a/scripts/user_retirement/get_learners_to_retire.py +++ b/scripts/user_retirement/get_learners_to_retire.py @@ -63,7 +63,7 @@ def get_learners_to_retire(config_file, click.echo('A config file is required.') sys.exit(-1) - with io.open(config_file, 'r') as config: + with io.open(config_file, 'r') as config: # noqa: UP020 config_yaml = yaml.safe_load(config) user_count_error_threshold = int(user_count_error_threshold) @@ -86,7 +86,7 @@ def get_learners_to_retire(config_file, if learners_to_retire_cnt > user_count_error_threshold: click.echo( - 'Too many learners to retire! Expected {} or fewer, got {}!'.format( + 'Too many learners to retire! Expected {} or fewer, got {}!'.format( # noqa: UP032 user_count_error_threshold, learners_to_retire_cnt ) diff --git a/scripts/user_retirement/replace_usernames.py b/scripts/user_retirement/replace_usernames.py index 2034fce0e6a3..ee2abadb31be 100644 --- a/scripts/user_retirement/replace_usernames.py +++ b/scripts/user_retirement/replace_usernames.py @@ -25,7 +25,7 @@ CredentialsApi, DiscoveryApi, EcommerceApi, - LmsApi + LmsApi, ) logging.basicConfig(stream=sys.stdout, level=logging.DEBUG) @@ -79,10 +79,10 @@ def replace_usernames(config_file, username_replacement_csv): click.echo('A username replacement CSV file is required') sys.exit(-1) - with io.open(config_file, 'r') as config: + with io.open(config_file, 'r') as config: # noqa: UP020 config_yaml = yaml.safe_load(config) - with io.open(username_replacement_csv, 'r') as replacement_file: + with io.open(username_replacement_csv, 'r') as replacement_file: # noqa: UP020 csv_reader = csv.reader(replacement_file) lms_username_mappings = [ {current_username: desired_username} diff --git a/scripts/user_retirement/requirements/base.txt b/scripts/user_retirement/requirements/base.txt index eed40e95d26e..cd9f7cae32dc 100644 --- a/scripts/user_retirement/requirements/base.txt +++ b/scripts/user_retirement/requirements/base.txt @@ -1,38 +1,38 @@ # -# This file is autogenerated by pip-compile with Python 3.11 +# This file is autogenerated by pip-compile with Python 3.12 # by the following command: # # make upgrade # -asgiref==3.11.0 +asgiref==3.11.1 # via django -attrs==25.4.0 +attrs==26.1.0 # via zeep backoff==2.2.1 # via -r scripts/user_retirement/requirements/base.in -boto3==1.42.30 +boto3==1.43.30 # via -r scripts/user_retirement/requirements/base.in -botocore==1.42.30 +botocore==1.43.30 # via # boto3 # s3transfer -certifi==2026.1.4 +certifi==2026.5.20 # via requests cffi==2.0.0 # via # cryptography # pynacl -charset-normalizer==3.4.4 +charset-normalizer==3.4.7 # via requests -click==8.3.1 +click==8.4.1 # via # -r scripts/user_retirement/requirements/base.in # edx-django-utils -cryptography==45.0.7 +cryptography==49.0.0 # via - # -c requirements/constraints.txt + # google-auth # pyjwt -django==5.2.11 +django==5.2.15 # via # -c requirements/common_constraints.txt # -c requirements/constraints.txt @@ -45,32 +45,32 @@ django-waffle==5.0.0 # via edx-django-utils edx-django-utils==8.0.1 # via edx-rest-api-client -edx-rest-api-client==6.2.0 +edx-rest-api-client==7.0.0 # via -r scripts/user_retirement/requirements/base.in -google-api-core==2.29.0 +google-api-core==2.31.0 # via google-api-python-client -google-api-python-client==2.188.0 +google-api-python-client==2.197.0 # via -r scripts/user_retirement/requirements/base.in -google-auth==2.47.0 +google-auth==2.55.0 # via # google-api-core # google-api-python-client # google-auth-httplib2 -google-auth-httplib2==0.3.0 +google-auth-httplib2==0.4.0 # via google-api-python-client -googleapis-common-protos==1.72.0 +googleapis-common-protos==1.75.0 # via google-api-core -httplib2==0.31.1 +httplib2==0.31.2 # via # google-api-python-client # google-auth-httplib2 -idna==3.11 +idna==3.18 # via requests isodate==0.7.2 # via zeep -jenkinsapi==0.3.17 +jenkinsapi==0.3.23 # via -r scripts/user_retirement/requirements/base.in -jmespath==1.0.1 +jmespath==1.1.0 # via # boto3 # botocore @@ -78,44 +78,42 @@ lxml==5.3.2 # via # -c requirements/constraints.txt # zeep -more-itertools==10.8.0 +more-itertools==11.1.0 # via simple-salesforce -platformdirs==4.5.1 +platformdirs==4.10.0 # via zeep -proto-plus==1.27.0 +proto-plus==1.28.0 # via google-api-core -protobuf==6.33.4 +protobuf==7.35.1 # via # google-api-core # googleapis-common-protos # proto-plus -psutil==7.2.1 +psutil==7.2.2 # via edx-django-utils -pyasn1==0.6.2 - # via - # pyasn1-modules - # rsa +pyasn1==0.6.3 + # via pyasn1-modules pyasn1-modules==0.4.2 # via google-auth -pycparser==2.23 +pycparser==3.0 # via cffi -pyjwt[crypto]==2.10.1 +pyjwt[crypto]==2.13.0 # via # edx-rest-api-client # simple-salesforce pynacl==1.6.2 # via edx-django-utils -pyparsing==3.3.1 +pyparsing==3.3.2 # via httplib2 python-dateutil==2.9.0.post0 # via botocore -pytz==2025.2 +pytz==2026.2 # via # jenkinsapi # zeep pyyaml==6.0.3 # via -r scripts/user_retirement/requirements/base.in -requests==2.32.5 +requests==2.34.2 # via # -r scripts/user_retirement/requirements/base.in # edx-rest-api-client @@ -129,19 +127,17 @@ requests-file==3.0.1 # via zeep requests-toolbelt==1.0.0 # via zeep -rsa==4.9.1 - # via google-auth -s3transfer==0.16.0 +s3transfer==0.18.0 # via boto3 simple-salesforce==1.12.9 # via -r scripts/user_retirement/requirements/base.in -simplejson==3.20.2 +simplejson==4.1.1 # via -r scripts/user_retirement/requirements/base.in six==1.17.0 # via python-dateutil sqlparse==0.5.5 # via django -stevedore==5.6.0 +stevedore==5.8.0 # via edx-django-utils typing-extensions==4.15.0 # via simple-salesforce @@ -149,7 +145,7 @@ unicodecsv==0.14.1 # via -r scripts/user_retirement/requirements/base.in uritemplate==4.2.0 # via google-api-python-client -urllib3==2.6.3 +urllib3==2.7.0 # via # botocore # requests diff --git a/scripts/user_retirement/requirements/testing.txt b/scripts/user_retirement/requirements/testing.txt index 6014557c01da..b7a14e0de024 100644 --- a/scripts/user_retirement/requirements/testing.txt +++ b/scripts/user_retirement/requirements/testing.txt @@ -1,30 +1,30 @@ # -# This file is autogenerated by pip-compile with Python 3.11 +# This file is autogenerated by pip-compile with Python 3.12 # by the following command: # # make upgrade # -asgiref==3.11.0 +asgiref==3.11.1 # via # -r scripts/user_retirement/requirements/base.txt # django -attrs==25.4.0 +attrs==26.1.0 # via # -r scripts/user_retirement/requirements/base.txt # zeep backoff==2.2.1 # via -r scripts/user_retirement/requirements/base.txt -boto3==1.42.30 +boto3==1.43.30 # via # -r scripts/user_retirement/requirements/base.txt # moto -botocore==1.42.30 +botocore==1.43.30 # via # -r scripts/user_retirement/requirements/base.txt # boto3 # moto # s3transfer -certifi==2026.1.4 +certifi==2026.5.20 # via # -r scripts/user_retirement/requirements/base.txt # requests @@ -33,22 +33,23 @@ cffi==2.0.0 # -r scripts/user_retirement/requirements/base.txt # cryptography # pynacl -charset-normalizer==3.4.4 +charset-normalizer==3.4.7 # via # -r scripts/user_retirement/requirements/base.txt # requests -click==8.3.1 +click==8.4.1 # via # -r scripts/user_retirement/requirements/base.txt # edx-django-utils -cryptography==45.0.7 +cryptography==49.0.0 # via # -r scripts/user_retirement/requirements/base.txt + # google-auth # moto # pyjwt ddt==1.7.2 # via -r scripts/user_retirement/requirements/testing.in -django==5.2.11 +django==5.2.15 # via # -r scripts/user_retirement/requirements/base.txt # django-crum @@ -66,34 +67,34 @@ edx-django-utils==8.0.1 # via # -r scripts/user_retirement/requirements/base.txt # edx-rest-api-client -edx-rest-api-client==6.2.0 +edx-rest-api-client==7.0.0 # via -r scripts/user_retirement/requirements/base.txt -google-api-core==2.29.0 +google-api-core==2.31.0 # via # -r scripts/user_retirement/requirements/base.txt # google-api-python-client -google-api-python-client==2.188.0 +google-api-python-client==2.197.0 # via -r scripts/user_retirement/requirements/base.txt -google-auth==2.47.0 +google-auth==2.55.0 # via # -r scripts/user_retirement/requirements/base.txt # google-api-core # google-api-python-client # google-auth-httplib2 -google-auth-httplib2==0.3.0 +google-auth-httplib2==0.4.0 # via # -r scripts/user_retirement/requirements/base.txt # google-api-python-client -googleapis-common-protos==1.72.0 +googleapis-common-protos==1.75.0 # via # -r scripts/user_retirement/requirements/base.txt # google-api-core -httplib2==0.31.1 +httplib2==0.31.2 # via # -r scripts/user_retirement/requirements/base.txt # google-api-python-client # google-auth-httplib2 -idna==3.11 +idna==3.18 # via # -r scripts/user_retirement/requirements/base.txt # requests @@ -103,11 +104,9 @@ isodate==0.7.2 # via # -r scripts/user_retirement/requirements/base.txt # zeep -jenkinsapi==0.3.17 +jenkinsapi==0.3.23 # via -r scripts/user_retirement/requirements/base.txt -jinja2==3.1.6 - # via moto -jmespath==1.0.1 +jmespath==1.1.0 # via # -r scripts/user_retirement/requirements/base.txt # boto3 @@ -117,55 +116,52 @@ lxml==5.3.2 # -r scripts/user_retirement/requirements/base.txt # zeep markupsafe==3.0.3 - # via - # jinja2 - # werkzeug + # via werkzeug mock==5.2.0 # via -r scripts/user_retirement/requirements/testing.in -more-itertools==10.8.0 +more-itertools==11.1.0 # via # -r scripts/user_retirement/requirements/base.txt # simple-salesforce -moto==5.1.20 +moto==5.2.2 # via -r scripts/user_retirement/requirements/testing.in -packaging==25.0 +packaging==26.2 # via pytest -platformdirs==4.5.1 +platformdirs==4.10.0 # via # -r scripts/user_retirement/requirements/base.txt # zeep pluggy==1.6.0 # via pytest -proto-plus==1.27.0 +proto-plus==1.28.0 # via # -r scripts/user_retirement/requirements/base.txt # google-api-core -protobuf==6.33.4 +protobuf==7.35.1 # via # -r scripts/user_retirement/requirements/base.txt # google-api-core # googleapis-common-protos # proto-plus -psutil==7.2.1 +psutil==7.2.2 # via # -r scripts/user_retirement/requirements/base.txt # edx-django-utils -pyasn1==0.6.2 +pyasn1==0.6.3 # via # -r scripts/user_retirement/requirements/base.txt # pyasn1-modules - # rsa pyasn1-modules==0.4.2 # via # -r scripts/user_retirement/requirements/base.txt # google-auth -pycparser==2.23 +pycparser==3.0 # via # -r scripts/user_retirement/requirements/base.txt # cffi -pygments==2.19.2 +pygments==2.20.0 # via pytest -pyjwt[crypto]==2.10.1 +pyjwt[crypto]==2.13.0 # via # -r scripts/user_retirement/requirements/base.txt # edx-rest-api-client @@ -174,18 +170,17 @@ pynacl==1.6.2 # via # -r scripts/user_retirement/requirements/base.txt # edx-django-utils -pyparsing==3.3.1 +pyparsing==3.3.2 # via # -r scripts/user_retirement/requirements/base.txt # httplib2 -pytest==9.0.2 +pytest==9.1.0 # via -r scripts/user_retirement/requirements/testing.in python-dateutil==2.9.0.post0 # via # -r scripts/user_retirement/requirements/base.txt # botocore - # moto -pytz==2025.2 +pytz==2026.2 # via # -r scripts/user_retirement/requirements/base.txt # jenkinsapi @@ -194,7 +189,7 @@ pyyaml==6.0.3 # via # -r scripts/user_retirement/requirements/base.txt # responses -requests==2.32.5 +requests==2.34.2 # via # -r scripts/user_retirement/requirements/base.txt # edx-rest-api-client @@ -217,21 +212,17 @@ requests-toolbelt==1.0.0 # via # -r scripts/user_retirement/requirements/base.txt # zeep -responses==0.25.8 +responses==0.26.1 # via # -r scripts/user_retirement/requirements/testing.in # moto -rsa==4.9.1 - # via - # -r scripts/user_retirement/requirements/base.txt - # google-auth -s3transfer==0.16.0 +s3transfer==0.18.0 # via # -r scripts/user_retirement/requirements/base.txt # boto3 simple-salesforce==1.12.9 # via -r scripts/user_retirement/requirements/base.txt -simplejson==3.20.2 +simplejson==4.1.1 # via -r scripts/user_retirement/requirements/base.txt six==1.17.0 # via @@ -241,7 +232,7 @@ sqlparse==0.5.5 # via # -r scripts/user_retirement/requirements/base.txt # django -stevedore==5.6.0 +stevedore==5.8.0 # via # -r scripts/user_retirement/requirements/base.txt # edx-django-utils @@ -255,16 +246,16 @@ uritemplate==4.2.0 # via # -r scripts/user_retirement/requirements/base.txt # google-api-python-client -urllib3==2.6.3 +urllib3==2.7.0 # via # -r scripts/user_retirement/requirements/base.txt # -r scripts/user_retirement/requirements/testing.in # botocore # requests # responses -werkzeug==3.1.5 +werkzeug==3.1.8 # via moto -xmltodict==1.0.2 +xmltodict==1.0.4 # via moto zeep==4.3.2 # via diff --git a/scripts/user_retirement/retire_one_learner.py b/scripts/user_retirement/retire_one_learner.py index b8c40364e643..5b0bfae32633 100755 --- a/scripts/user_retirement/retire_one_learner.py +++ b/scripts/user_retirement/retire_one_learner.py @@ -11,8 +11,6 @@ ecommerce: http://localhost:18130/ credentials: http://localhost:18150/ retirement_pipeline: - - ['RETIRING_CREDENTIALS', 'CREDENTIALS_COMPLETE', 'CREDENTIALS', 'retire_learner'] - - ['RETIRING_ECOM', 'ECOM_COMPLETE', 'ECOMMERCE', 'retire_learner'] - ['RETIRING_LICENSE_MANAGER', 'LICENSE_MANAGER_COMPLETE', 'LICENSE_MANAGER', 'retire_learner'] - ['RETIRING_FORUMS', 'FORUMS_COMPLETE', 'LMS', 'retirement_retire_forum'] - ['RETIRING_EMAIL_LISTS', 'EMAIL_LISTS_COMPLETE', 'LMS', 'retirement_retire_mailings'] @@ -32,6 +30,7 @@ sys.path.append(path.abspath(path.join(path.dirname(__file__), '../..'))) from scripts.user_retirement.utils.exception import HttpDoesNotExistException + # pylint: disable=wrong-import-position from scripts.user_retirement.utils.helpers import ( _config_or_exit, @@ -39,7 +38,7 @@ _fail_exception, _get_error_str_from_exception, _log, - _setup_all_apis_or_exit + _setup_all_apis_or_exit, ) # Return codes for various fail cases @@ -81,16 +80,16 @@ def _get_learner_state_index_or_exit(learner, config): learner_state_index = config['all_states'].index(learner_state) if learner_state in END_STATES: - FAIL(ERR_USER_AT_END_STATE, 'User already in end state: {}'.format(learner_state)) + FAIL(ERR_USER_AT_END_STATE, 'User already in end state: {}'.format(learner_state)) # noqa: UP032 if learner_state in config['working_states']: - FAIL(ERR_USER_IN_WORKING_STATE, 'User is already in a working state! {}'.format(learner_state)) + FAIL(ERR_USER_IN_WORKING_STATE, 'User is already in a working state! {}'.format(learner_state)) # noqa: UP032 return learner_state_index except KeyError: - FAIL(ERR_BAD_LEARNER, 'Bad learner response missing current_state or state_name: {}'.format(learner)) + FAIL(ERR_BAD_LEARNER, 'Bad learner response missing current_state or state_name: {}'.format(learner)) # noqa: UP032 except ValueError: - FAIL(ERR_UNKNOWN_STATE, 'Unknown learner retirement state for learner: {}'.format(learner)) + FAIL(ERR_UNKNOWN_STATE, 'Unknown learner retirement state for learner: {}'.format(learner)) # noqa: UP032 def _config_retirement_pipeline(config): @@ -121,28 +120,13 @@ def _get_learner_and_state_index_or_exit(config, username): learner_state_index = _get_learner_state_index_or_exit(learner, config) return learner, learner_state_index except HttpDoesNotExistException: - FAIL(ERR_BAD_LEARNER, 'Learner {} not found. Please check that the learner is present in ' + FAIL(ERR_BAD_LEARNER, 'Learner {} not found. Please check that the learner is present in ' # noqa: UP032 'UserRetirementStatus, is not already retired, ' 'and is in an appropriate state to be acted upon.'.format(username)) except Exception as exc: # pylint: disable=broad-except FAIL_EXCEPTION(ERR_SETUP_FAILED, 'Unexpected error fetching user state!', str(exc)) -def _get_ecom_segment_id(config, learner): - """ - Calls Ecommerce to get the ecom-specific Segment tracking id that we need to retire. - This is only available from Ecommerce, unfortunately, and makes more sense to handle - here than to pass all of the config down to SegmentApi. - """ - try: - return config['ECOMMERCE'].get_tracking_key(learner) - except HttpDoesNotExistException: - LOG('Learner {} not found in Ecommerce. Setting Ecommerce Segment ID to None'.format(learner)) - return None - except Exception as exc: # pylint: disable=broad-except - FAIL_EXCEPTION(ERR_SETUP_FAILED, 'Unexpected error fetching Ecommerce tracking id!', str(exc)) - - @click.command("retire_learner") @click.option( '--username', @@ -160,7 +144,7 @@ def retire_learner( Retrieves a JWT token as the retirement service learner, then performs the retirement process as defined in WORKING_STATE_ORDER """ - LOG('Starting learner retirement for {} using config file {}'.format(username, config_file)) + LOG('Starting learner retirement for {} using config file {}'.format(username, config_file)) # noqa: UP032 if not config_file: FAIL(ERR_BAD_CONFIG, 'No config file passed in.') @@ -171,50 +155,47 @@ def retire_learner( learner, learner_state_index = _get_learner_and_state_index_or_exit(config, username) - if config.get('fetch_ecommerce_segment_id', False): - learner['ecommerce_segment_id'] = _get_ecom_segment_id(config, learner) - start_state = None try: for start_state, end_state, service, method in config['retirement_pipeline']: # Skip anything that has already been done if config['all_states'].index(start_state) < learner_state_index: - LOG('State {} completed in previous run, skipping'.format(start_state)) + LOG('State {} completed in previous run, skipping'.format(start_state)) # noqa: UP032 continue - LOG('Starting state {}'.format(start_state)) + LOG('Starting state {}'.format(start_state)) # noqa: UP032 - config['LMS'].update_learner_retirement_state(username, start_state, 'Starting: {}'.format(start_state)) + config['LMS'].update_learner_retirement_state(username, start_state, 'Starting: {}'.format(start_state)) # noqa: UP032 # This does the actual API call start_time = time() response = getattr(config[service], method)(learner) end_time = time() - LOG('State {} completed in {} seconds'.format(start_state, end_time - start_time)) + LOG('State {} completed in {} seconds'.format(start_state, end_time - start_time)) # noqa: UP032 config['LMS'].update_learner_retirement_state( username, end_state, - 'Ending: {} with response:\n{}'.format(end_state, response) + 'Ending: {} with response:\n{}'.format(end_state, response) # noqa: UP032 ) learner_state_index += 1 - LOG('Progressing to state {}'.format(end_state)) + LOG('Progressing to state {}'.format(end_state)) # noqa: UP032 config['LMS'].update_learner_retirement_state(username, COMPLETE_STATE, 'Learner retirement complete.') - LOG('Retirement complete for learner {}'.format(username)) + LOG('Retirement complete for learner {}'.format(username)) # noqa: UP032 except Exception as exc: # pylint: disable=broad-except exc_msg = _get_error_str_from_exception(exc) try: - LOG('Error in retirement state {}: {}'.format(start_state, exc_msg)) + LOG('Error in retirement state {}: {}'.format(start_state, exc_msg)) # noqa: UP032 config['LMS'].update_learner_retirement_state(username, ERROR_STATE, exc_msg) except Exception as update_exc: # pylint: disable=broad-except - LOG('Critical error attempting to change learner state to ERRORED: {}'.format(update_exc)) + LOG('Critical error attempting to change learner state to ERRORED: {}'.format(update_exc)) # noqa: UP032 - FAIL_EXCEPTION(ERR_WHILE_RETIRING, 'Error encountered in state "{}"'.format(start_state), exc) + FAIL_EXCEPTION(ERR_WHILE_RETIRING, 'Error encountered in state "{}"'.format(start_state), exc) # noqa: UP032 if __name__ == '__main__': diff --git a/scripts/user_retirement/retirement_archive_and_cleanup.py b/scripts/user_retirement/retirement_archive_and_cleanup.py index d44a5e9fa8c9..e7211101b813 100644 --- a/scripts/user_retirement/retirement_archive_and_cleanup.py +++ b/scripts/user_retirement/retirement_archive_and_cleanup.py @@ -51,10 +51,10 @@ def _fetch_learners_to_archive_or_exit(config, start_date, end_date, initial_sta """ Makes the call to fetch learners to be cleaned up, returns the list of learners or exits. """ - LOG('Fetching users in state {} created from {} to {}'.format(initial_state, start_date, end_date)) + LOG('Fetching users in state {} created from {} to {}'.format(initial_state, start_date, end_date)) # noqa: UP032 try: learners = config['LMS'].get_learners_by_date_and_status(initial_state, start_date, end_date) - LOG('Successfully fetched {} learners'.format(str(len(learners)))) + LOG('Successfully fetched {} learners'.format(str(len(learners)))) # noqa: UP032 return learners except Exception as exc: # pylint: disable=broad-except FAIL_EXCEPTION(ERR_FETCHING, 'Unexpected error occurred fetching users to update!', exc) @@ -109,11 +109,11 @@ def _upload_to_s3(config, filename, dry_run=False): bucket = s3.Bucket(bucket_name) key = 'raw/' + datestr + filename if dry_run: - LOG('Dry run. Skipping the step to upload data to {}'.format(key)) + LOG('Dry run. Skipping the step to upload data to {}'.format(key)) # noqa: UP032 return else: bucket.upload_file(filename, key) - LOG('Successfully uploaded retirement data to {}'.format(key)) + LOG('Successfully uploaded retirement data to {}'.format(key)) # noqa: UP032 except Exception as exc: LOG(text_type(exc)) raise @@ -168,7 +168,7 @@ def _archive_retirements_or_exit(config, learners, dry_run=False): try: now = _get_utc_now() filename = 'retirement_archive_{}.json.gz'.format(now.strftime('%Y_%d_%m_%H_%M_%S')) - LOG('Creating retirement archive file {}'.format(filename)) + LOG('Creating retirement archive file {}'.format(filename)) # noqa: UP032 # The file format is one JSON object per line with the newline as a separator. This allows for # easy queries via AWS Athena if we need to confirm learner deletion. @@ -187,7 +187,7 @@ def _archive_retirements_or_exit(config, learners, dry_run=False): json.dump(user, out) out.write("\n") if dry_run: - LOG('Dry run. Logging the contents of {} for debugging'.format(filename)) + LOG('Dry run. Logging the contents of {} for debugging'.format(filename)) # noqa: UP032 with gzip.open(filename, 'r') as archive_file: for line in archive_file.readlines(): LOG(line) @@ -196,16 +196,19 @@ def _archive_retirements_or_exit(config, learners, dry_run=False): FAIL_EXCEPTION(ERR_ARCHIVING, 'Unexpected error occurred archiving retirements!', exc) -def _cleanup_retirements_or_exit(config, learners): +def _cleanup_retirements_or_exit(config, learners, redacted_username='redacted', + redacted_email='redacted', redacted_name='redacted'): """ - Bulk deletes the retirements for this run + Bulk deletes the retirements for this run after redacting PII fields """ - LOG('Cleaning up retirements for {} learners'.format(len(learners))) + LOG('Cleaning up retirements for {} learners'.format(len(learners))) # noqa: UP032 try: usernames = [l['original_username'] for l in learners] - config['LMS'].bulk_cleanup_retirements(usernames) + config['LMS'].bulk_cleanup_retirements( + usernames, redacted_username, redacted_email, redacted_name + ) except Exception as exc: # pylint: disable=broad-except - FAIL_EXCEPTION(ERR_DELETING, 'Unexpected error occurred deleting retirements!', exc) + FAIL_EXCEPTION(ERR_DELETING, 'Unexpected error occurred redacting/deleting retirements!', exc) def _get_utc_now(): @@ -259,7 +262,26 @@ def _get_utc_now(): help='Number of user retirements to process', type=int ) -def archive_and_cleanup(config_file, cool_off_days, dry_run, start_date, end_date, batch_size): +@click.option( + '--redacted_username', + help='Value to use for redacted username field', + type=str, + default='redacted' +) +@click.option( + '--redacted_email', + help='Value to use for redacted email field', + type=str, + default='redacted' +) +@click.option( + '--redacted_name', + help='Value to use for redacted name field', + type=str, + default='redacted' +) +def archive_and_cleanup(config_file, cool_off_days, dry_run, start_date, end_date, batch_size, + redacted_username, redacted_email, redacted_name): """ Cleans up UserRetirementStatus rows in LMS by: 1- Getting all rows currently in COMPLETE that were created --cool_off_days ago or more, @@ -268,7 +290,7 @@ def archive_and_cleanup(config_file, cool_off_days, dry_run, start_date, end_dat 3- Deleting them from LMS (by username) """ try: - LOG('Starting bulk update script: Config: {}'.format(config_file)) + LOG('Starting bulk update script: Config: {}'.format(config_file)) # noqa: UP032 if not config_file: FAIL(ERR_NO_CONFIG, 'No config file passed in.') @@ -290,7 +312,7 @@ def archive_and_cleanup(config_file, cool_off_days, dry_run, start_date, end_dat FAIL(ERR_BAD_CLI_PARAM, 'Conflicting start and end dates passed on CLI') LOG( - 'Fetching retirements for learners that have a COMPLETE status and were created ' + 'Fetching retirements for learners that have a COMPLETE status and were created ' # noqa: UP032 'between {} and {}.'.format( start_date, end_date ) @@ -305,7 +327,7 @@ def archive_and_cleanup(config_file, cool_off_days, dry_run, start_date, end_dat if learners_to_process: for index, batch in enumerate(learners_to_process): LOG( - 'Processing batch {} out of {} of user retirement requests'.format( + 'Processing batch {} out of {} of user retirement requests'.format( # noqa: UP032 str(index + 1), str(num_batches) ) ) @@ -314,8 +336,10 @@ def archive_and_cleanup(config_file, cool_off_days, dry_run, start_date, end_dat if dry_run: LOG('This is a dry-run. Exiting before any retirements are cleaned up') else: - _cleanup_retirements_or_exit(config, batch) - LOG('Archive and cleanup complete for batch #{}'.format(str(index + 1))) + _cleanup_retirements_or_exit( + config, batch, redacted_username, redacted_email, redacted_name + ) + LOG('Archive and cleanup complete for batch #{}'.format(str(index + 1))) # noqa: UP032 time.sleep(DELAY) else: LOG('No learners found!') diff --git a/scripts/user_retirement/retirement_bulk_status_update.py b/scripts/user_retirement/retirement_bulk_status_update.py index da8b05879373..20eaef519f35 100755 --- a/scripts/user_retirement/retirement_bulk_status_update.py +++ b/scripts/user_retirement/retirement_bulk_status_update.py @@ -50,7 +50,7 @@ def validate_dates(_, __, value): raise ValueError() return date except ValueError: - raise click.BadParameter('Dates need to be in the format of YYYY-MM-DD and today or earlier.') + raise click.BadParameter('Dates need to be in the format of YYYY-MM-DD and today or earlier.') # noqa: B904 def _fetch_learners_to_update_or_exit(config, start_date, end_date, initial_state): @@ -58,7 +58,7 @@ def _fetch_learners_to_update_or_exit(config, start_date, end_date, initial_stat Makes the call to fetch learners to be bulk updated, returns the list of learners or exits. """ - LOG('Fetching users in state {} created from {} to {}'.format(initial_state, start_date, end_date)) + LOG('Fetching users in state {} created from {} to {}'.format(initial_state, start_date, end_date)) # noqa: UP032 try: return config['LMS'].get_learners_by_date_and_status(initial_state, start_date, end_date) except Exception as exc: # pylint: disable=broad-except @@ -73,7 +73,7 @@ def _update_learners_or_exit(config, learners, new_state=None, rewind_state=Fals """ if (not new_state and not rewind_state) or (rewind_state and new_state): FAIL(ERR_BAD_CONFIG, "You must specify either the boolean rewind_state or a new state to set learners to.") - LOG('Updating {} learners to {}'.format(len(learners), new_state)) + LOG('Updating {} learners to {}'.format(len(learners), new_state)) # noqa: UP032 try: for learner in learners: if rewind_state: @@ -124,7 +124,7 @@ def update_statuses(config_file, initial_state, new_state, start_date, end_date, requested between a start date and end date. """ try: - LOG('Starting bulk update script: Config: {}'.format(config_file)) + LOG('Starting bulk update script: Config: {}'.format(config_file)) # noqa: UP032 if not config_file: FAIL(ERR_NO_CONFIG, 'No config file passed in.') diff --git a/scripts/user_retirement/retirement_partner_report.py b/scripts/user_retirement/retirement_partner_report.py index 53bcfa685660..905595366430 100755 --- a/scripts/user_retirement/retirement_partner_report.py +++ b/scripts/user_retirement/retirement_partner_report.py @@ -1,5 +1,5 @@ #! /usr/bin/env python3 -# coding=utf-8 +# coding=utf-8 # noqa: UP009 """ Command-line script to drive the partner reporting part of the retirement process @@ -20,15 +20,15 @@ # Add top-level project path to sys.path before importing scripts code sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), '../..'))) -from scripts.user_retirement.utils.thirdparty_apis.google_api import DriveApi # pylint: disable=wrong-import-position # pylint: disable=wrong-import-position from scripts.user_retirement.utils.helpers import ( _config_with_drive_or_exit, _fail, _fail_exception, _log, - _setup_lms_api_or_exit + _setup_lms_api_or_exit, ) +from scripts.user_retirement.utils.thirdparty_apis.google_api import DriveApi # pylint: disable=wrong-import-position # Return codes for various fail cases ERR_SETUP_FAILED = -1 @@ -101,7 +101,7 @@ def _check_all_learner_orgs_or_exit(config, learners): if mismatched_orgs: FAIL( ERR_UNKNOWN_ORG, - 'Partners for organizations {} do not exist in configuration.'.format(text_type(mismatched_orgs)) + 'Partners for organizations {} do not exist in configuration.'.format(text_type(mismatched_orgs)) # noqa: UP032 ) @@ -114,7 +114,7 @@ def _get_orgs_and_learners_or_exit(config): try: LOG('Retrieving all learners on which to report from the LMS.') learners = config['LMS'].retirement_partner_report() - LOG('Retrieved {} learners from the LMS.'.format(len(learners))) + LOG('Retrieved {} learners from the LMS.'.format(len(learners))) # noqa: UP032 _check_all_learner_orgs_or_exit(config, learners) @@ -185,9 +185,9 @@ def _generate_report_files_or_exit(config, report_data, output_dir): outfile = _generate_report_file_or_exit(config, output_dir, partner_name, partner_headings, partner_learners) partner_filenames[partner_name] = outfile - LOG('Report complete for partner {}'.format(partner_name)) + LOG('Report complete for partner {}'.format(partner_name)) # noqa: UP032 except Exception as exc: # pylint: disable=broad-except - FAIL_EXCEPTION(ERR_REPORTING, 'Error reporting retirement for partner {}'.format(partner_name), exc) + FAIL_EXCEPTION(ERR_REPORTING, 'Error reporting retirement for partner {}'.format(partner_name), exc) # noqa: UP032 return partner_filenames @@ -196,7 +196,7 @@ def _generate_report_file_or_exit(config, output_dir, partner, field_headings, f """ Create a CSV file for the partner """ - LOG('Starting report for partner {}: {} learners to add. Field headings are {}'.format( + LOG('Starting report for partner {}: {} learners to add. Field headings are {}'.format( # noqa: UP032 partner, len(field_values), field_headings @@ -263,7 +263,7 @@ def _push_files_to_google(config, partner_filenames): failed_partners.append(partner) if failed_partners: - FAIL(ERR_BAD_CONFIG, 'These partners have retiring learners, but no Drive folder: {}'.format(failed_partners)) + FAIL(ERR_BAD_CONFIG, 'These partners have retiring learners, but no Drive folder: {}'.format(failed_partners)) # noqa: UP032 file_ids = {} drive = DriveApi(config['google_secrets_file']) @@ -274,10 +274,10 @@ def _push_files_to_google(config, partner_filenames): with open(partner_filenames[partner], 'rb') as f: try: drive_filename = os.path.basename(partner_filenames[partner]) - LOG('Attempting to upload {} to {} Drive folder.'.format(drive_filename, partner)) + LOG('Attempting to upload {} to {} Drive folder.'.format(drive_filename, partner)) # noqa: UP032 file_id = drive.create_file_in_folder(folder_id, drive_filename, f, "text/csv") except Exception as exc: # pylint: disable=broad-except - FAIL_EXCEPTION(ERR_DRIVE_UPLOAD, 'Drive upload failed for: {}'.format(drive_filename), exc) + FAIL_EXCEPTION(ERR_DRIVE_UPLOAD, 'Drive upload failed for: {}'.format(drive_filename), exc) # noqa: UP032 file_ids[partner] = file_id return file_ids @@ -319,7 +319,7 @@ def _add_comments_to_files(config, file_ids): for partner in file_ids: if not external_emails[partner]: LOG( - 'WARNING: could not find a POC for the following partner: "{}". ' + 'WARNING: could not find a POC for the following partner: "{}". ' # noqa: UP032 'Double check the partner folder permissions in Google Drive.' .format(partner) ) @@ -333,7 +333,7 @@ def _add_comments_to_files(config, file_ids): drive.create_comments_for_files(file_ids_and_comments) except Exception as exc: # pylint: disable=broad-except # do not fail the script here, since comment errors are non-critical - LOG('WARNING: there was an error adding Google Drive comments to the csv files: {}'.format(exc)) + LOG('WARNING: there was an error adding Google Drive comments to the csv files: {}'.format(exc)) # noqa: UP032 @click.command("generate_report") @@ -364,7 +364,7 @@ def generate_report(config_file, google_secrets_file, output_dir, comments): - Pushes the reports to Google Drive - On success tells LMS to remove the users who succeeded from the reporting queue """ - LOG('Starting partner report using config file {} and Google config {}'.format(config_file, google_secrets_file)) + LOG('Starting partner report using config file {} and Google config {}'.format(config_file, google_secrets_file)) # noqa: UP032 try: if not config_file: diff --git a/scripts/user_retirement/tests/retirement_helpers.py b/scripts/user_retirement/tests/retirement_helpers.py index 1347743e0c4c..8c7ce06ccf64 100644 --- a/scripts/user_retirement/tests/retirement_helpers.py +++ b/scripts/user_retirement/tests/retirement_helpers.py @@ -1,4 +1,4 @@ -# coding=utf-8 +# coding=utf-8 # noqa: UP009 """ Common functionality for retirement related tests @@ -32,7 +32,7 @@ FAKE_ORGS = { # Make sure unicode names, as they should come in from the yaml config, work - 'org1': [unicodedata.normalize('NFKC', u'TéstX')], + 'org1': [unicodedata.normalize('NFKC', u'TéstX')], # noqa: UP025 'org2': ['Org2X'], 'org3': ['Org3X', 'Org4X'], } @@ -53,7 +53,7 @@ def flatten_partner_list(partner_list): return [partner for sublist in partner_list for partner in sublist] -def fake_config_file(f, orgs=None, fetch_ecom_segment_id=False): +def fake_config_file(f, orgs=None): """ Create a config file for a single test. Combined with CliRunner.isolated_filesystem() to ensure the file lifetime is limited to the test. See _call_script for usage. @@ -85,9 +85,6 @@ def fake_config_file(f, orgs=None, fetch_ecom_segment_id=False): 'segment_auth_token': 'fakeauthtoken', } - if fetch_ecom_segment_id: - config['fetch_ecommerce_segment_id'] = True - yaml.safe_dump(config, f) diff --git a/scripts/user_retirement/tests/test_get_learners_to_retire.py b/scripts/user_retirement/tests/test_get_learners_to_retire.py index 557398a2720f..42d823bb10af 100644 --- a/scripts/user_retirement/tests/test_get_learners_to_retire.py +++ b/scripts/user_retirement/tests/test_get_learners_to_retire.py @@ -1,9 +1,8 @@ """ Test the get_learners_to_retire.py script """ -from unittest.mock import DEFAULT, patch - import os +from unittest.mock import DEFAULT, patch from click.testing import CliRunner from requests.exceptions import HTTPError diff --git a/scripts/user_retirement/tests/test_retire_one_learner.py b/scripts/user_retirement/tests/test_retire_one_learner.py index 844325ea3ed0..3f45e82ea5cc 100644 --- a/scripts/user_retirement/tests/test_retire_one_learner.py +++ b/scripts/user_retirement/tests/test_retire_one_learner.py @@ -13,13 +13,13 @@ ERR_UNKNOWN_STATE, ERR_USER_AT_END_STATE, ERR_USER_IN_WORKING_STATE, - retire_learner + retire_learner, ) from scripts.user_retirement.tests.retirement_helpers import fake_config_file, get_fake_user_retirement from scripts.user_retirement.utils.exception import HttpDoesNotExistException -def _call_script(username, fetch_ecom_segment_id=False): +def _call_script(username): """ Call the retired learner script with the given username and a generic, temporary config file. Returns the CliRunner.invoke results @@ -27,7 +27,7 @@ def _call_script(username, fetch_ecom_segment_id=False): runner = CliRunner() with runner.isolated_filesystem(): with open('test_config.yml', 'w') as f: - fake_config_file(f, fetch_ecom_segment_id=fetch_ecom_segment_id) + fake_config_file(f) result = runner.invoke(retire_learner, args=['--username', username, '--config_file', 'test_config.yml']) print(result) print(result.output) @@ -35,7 +35,6 @@ def _call_script(username, fetch_ecom_segment_id=False): @patch('scripts.user_retirement.utils.edx_api.BaseApiClient.get_access_token') -@patch('scripts.user_retirement.utils.edx_api.EcommerceApi.get_tracking_key') @patch.multiple( 'scripts.user_retirement.utils.edx_api.LmsApi', get_learner_retirement_state=DEFAULT, @@ -48,7 +47,7 @@ def _call_script(username, fetch_ecom_segment_id=False): def test_successful_retirement(*args, **kwargs): username = 'test_username' - mock_get_access_token = args[1] + mock_get_access_token = args[0] mock_get_retirement_state = kwargs['get_learner_retirement_state'] mock_update_learner_state = kwargs['update_learner_retirement_state'] mock_retire_forum = kwargs['retirement_retire_forum'] @@ -59,7 +58,7 @@ def test_successful_retirement(*args, **kwargs): mock_get_access_token.return_value = ('THIS_IS_A_JWT', None) mock_get_retirement_state.return_value = get_fake_user_retirement(original_username=username) - result = _call_script(username, fetch_ecom_segment_id=True) + result = _call_script(username) # Called once per API we instantiate (LMS, ECommerce, Credentials) assert mock_get_access_token.call_count == 3 @@ -297,116 +296,3 @@ def test_skipping_states(*args, **kwargs): assert required_output in result.output -@patch('scripts.user_retirement.utils.edx_api.BaseApiClient.get_access_token') -@patch('scripts.user_retirement.utils.edx_api.EcommerceApi.get_tracking_key') -@patch.multiple( - 'scripts.user_retirement.utils.edx_api.LmsApi', - get_learner_retirement_state=DEFAULT, - update_learner_retirement_state=DEFAULT, - retirement_retire_forum=DEFAULT, - retirement_retire_mailings=DEFAULT, - retirement_unenroll=DEFAULT, - retirement_lms_retire=DEFAULT -) -def test_get_segment_id_success(*args, **kwargs): - username = 'test_username' - - mock_get_tracking_key = args[0] - mock_get_access_token = args[1] - mock_get_retirement_state = kwargs['get_learner_retirement_state'] - mock_retirement_retire_forum = kwargs['retirement_retire_forum'] - - mock_get_access_token.return_value = ('THIS_IS_A_JWT', None) - mock_get_tracking_key.return_value = {'id': 1, 'ecommerce_tracking_id': 'ecommerce-1'} - - # The learner starts off with these values, 'ecommerce_segment_id' is added during script - # startup - mock_get_retirement_state.return_value = get_fake_user_retirement( - original_username=username, - ) - - _call_script(username, fetch_ecom_segment_id=True) - mock_get_tracking_key.assert_called_once_with(mock_get_retirement_state.return_value) - - config_after_get_segment_id = mock_get_retirement_state.return_value - config_after_get_segment_id['ecommerce_segment_id'] = 'ecommerce-1' - - mock_retirement_retire_forum.assert_called_once_with(config_after_get_segment_id) - - -@patch('scripts.user_retirement.utils.edx_api.BaseApiClient.get_access_token') -@patch('scripts.user_retirement.utils.edx_api.EcommerceApi.get_tracking_key') -@patch.multiple( - 'scripts.user_retirement.utils.edx_api.LmsApi', - get_learner_retirement_state=DEFAULT, - update_learner_retirement_state=DEFAULT, - retirement_retire_forum=DEFAULT, - retirement_retire_mailings=DEFAULT, - retirement_unenroll=DEFAULT, - retirement_lms_retire=DEFAULT -) -def test_get_segment_id_not_found(*args, **kwargs): - username = 'test_username' - - mock_get_tracking_key = args[0] - mock_get_access_token = args[1] - mock_get_retirement_state = kwargs['get_learner_retirement_state'] - - mock_get_access_token.return_value = ('THIS_IS_A_JWT', None) - mock_get_tracking_key.side_effect = HttpDoesNotExistException('{} not found'.format(username)) - - mock_get_retirement_state.return_value = get_fake_user_retirement( - original_username=username, - ) - - result = _call_script(username, fetch_ecom_segment_id=True) - mock_get_tracking_key.assert_called_once_with(mock_get_retirement_state.return_value) - assert 'Setting Ecommerce Segment ID to None' in result.output - - # Reset our call counts for the next test - mock_get_access_token.reset_mock() - mock_get_retirement_state.reset_mock() - - -@patch('scripts.user_retirement.utils.edx_api.BaseApiClient.get_access_token') -@patch('scripts.user_retirement.utils.edx_api.EcommerceApi.get_tracking_key') -@patch.multiple( - 'scripts.user_retirement.utils.edx_api.LmsApi', - get_learner_retirement_state=DEFAULT, - update_learner_retirement_state=DEFAULT, - retirement_retire_forum=DEFAULT, - retirement_retire_mailings=DEFAULT, - retirement_unenroll=DEFAULT, - retirement_lms_retire=DEFAULT -) -def test_get_segment_id_error(*args, **kwargs): - username = 'test_username' - - mock_get_tracking_key = args[0] - mock_get_access_token = args[1] - mock_get_retirement_state = kwargs['get_learner_retirement_state'] - mock_update_learner_state = kwargs['update_learner_retirement_state'] - - mock_get_access_token.return_value = ('THIS_IS_A_JWT', None) - - test_exception_message = 'Test Exception!' - mock_get_tracking_key.side_effect = Exception(test_exception_message) - - mock_get_retirement_state.return_value = get_fake_user_retirement( - original_username=username, - ) - - mock_get_retirement_state.return_value = { - 'original_username': username, - 'current_state': { - 'state_name': 'PENDING' - } - } - - result = _call_script(username, fetch_ecom_segment_id=True) - mock_get_tracking_key.assert_called_once_with(mock_get_retirement_state.return_value) - mock_update_learner_state.assert_not_called() - - assert result.exit_code == ERR_SETUP_FAILED - assert 'Unexpected error fetching Ecommerce tracking id!' in result.output - assert test_exception_message in result.output diff --git a/scripts/user_retirement/tests/test_retirement_archive_and_cleanup.py b/scripts/user_retirement/tests/test_retirement_archive_and_cleanup.py index 12c48dda9ff1..59439de681f1 100644 --- a/scripts/user_retirement/tests/test_retirement_archive_and_cleanup.py +++ b/scripts/user_retirement/tests/test_retirement_archive_and_cleanup.py @@ -21,14 +21,15 @@ ERR_NO_CONFIG, ERR_SETUP_FAILED, _upload_to_s3, - archive_and_cleanup + archive_and_cleanup, ) from scripts.user_retirement.tests.retirement_helpers import fake_config_file, get_fake_user_retirement FAKE_BUCKET_NAME = "fake_test_bucket" -def _call_script(cool_off_days=37, batch_size=None, dry_run=None, start_date=None, end_date=None): +def _call_script(cool_off_days=37, batch_size=None, dry_run=None, start_date=None, end_date=None, + redacted_username=None, redacted_email=None, redacted_name=None): """ Call the archive script with the given params and a generic config file. Returns the CliRunner.invoke results @@ -50,6 +51,12 @@ def _call_script(cool_off_days=37, batch_size=None, dry_run=None, start_date=Non base_args += ['--start_date', start_date] if end_date: base_args += ['--end_date', end_date] + if redacted_username: + base_args += ['--redacted_username', redacted_username] + if redacted_email: + base_args += ['--redacted_email', redacted_email] + if redacted_name: + base_args += ['--redacted_name', redacted_name] result = runner.invoke(archive_and_cleanup, args=base_args) print(result) @@ -63,11 +70,11 @@ def _fake_learner(ordinal): """ return get_fake_user_retirement( user_id=ordinal, - original_username='test{}'.format(ordinal), - original_email='test{}@edx.invalid'.format(ordinal), - original_name='test {}'.format(ordinal), - retired_username='retired_{}'.format(ordinal), - retired_email='retired_test{}@edx.invalid'.format(ordinal), + original_username='test{}'.format(ordinal), # noqa: UP032 + original_email='test{}@edx.invalid'.format(ordinal), # noqa: UP032 + original_name='test {}'.format(ordinal), # noqa: UP032 + retired_username='retired_{}'.format(ordinal), # noqa: UP032 + retired_email='retired_test{}@edx.invalid'.format(ordinal), # noqa: UP032 last_state_name='COMPLETE' ) @@ -106,7 +113,7 @@ def test_successful(*args, **kwargs): assert mock_get_access_token.call_count == 1 mock_get_learners.assert_called_once() mock_bulk_cleanup_retirements.assert_called_once_with( - ['test1', 'test2', 'test3']) + ['test1', 'test2', 'test3'], 'redacted', 'redacted', 'redacted') assert result.exit_code == 0 assert 'Archive and cleanup complete' in result.output @@ -134,7 +141,8 @@ def test_successful_with_batching(*args, **kwargs): # Called once to get the LMS token assert mock_get_access_token.call_count == 1 mock_get_learners.assert_called_once() - get_learner_calls = [call(['test1', 'test2']), call(['test3'])] + get_learner_calls = [call(['test1', 'test2'], 'redacted', 'redacted', 'redacted'), + call(['test3'], 'redacted', 'redacted', 'redacted')] mock_bulk_cleanup_retirements.assert_has_calls(get_learner_calls) assert result.exit_code == 0 @@ -142,6 +150,39 @@ def test_successful_with_batching(*args, **kwargs): assert 'Archive and cleanup complete for batch #2' in result.output +@patch('scripts.user_retirement.utils.edx_api.BaseApiClient.get_access_token', return_value=('THIS_IS_A_JWT', None)) +@patch.multiple( + 'scripts.user_retirement.utils.edx_api.LmsApi', + get_learners_by_date_and_status=DEFAULT, + bulk_cleanup_retirements=DEFAULT +) +@mock_aws +def test_successful_with_custom_redaction_values(*args, **kwargs): + conn = boto3.resource('s3') + conn.create_bucket(Bucket=FAKE_BUCKET_NAME) + + mock_get_access_token = args[0] + mock_get_learners = kwargs['get_learners_by_date_and_status'] + mock_bulk_cleanup_retirements = kwargs['bulk_cleanup_retirements'] + + mock_get_learners.return_value = fake_learners_to_retire() + + result = _call_script( + redacted_username='custom_user', + redacted_email='custom@example.com', + redacted_name='Custom Name' + ) + + # Called once to get the LMS token + assert mock_get_access_token.call_count == 1 + mock_get_learners.assert_called_once() + mock_bulk_cleanup_retirements.assert_called_once_with( + ['test1', 'test2', 'test3'], 'custom_user', 'custom@example.com', 'Custom Name') + + assert result.exit_code == 0 + assert 'Archive and cleanup complete' in result.output + + @patch('scripts.user_retirement.utils.edx_api.BaseApiClient.get_access_token', return_value=('THIS_IS_A_JWT', None)) @patch.multiple( 'scripts.user_retirement.utils.edx_api.LmsApi', @@ -216,7 +257,7 @@ def test_bad_fetch(*_): def test_bad_lms_deletion(*_): result = _call_script() assert result.exit_code == ERR_DELETING - assert 'Unexpected error occurred deleting retirements!' in result.output + assert 'Unexpected error occurred redacting/deleting retirements!' in result.output @patch('scripts.user_retirement.utils.edx_api.BaseApiClient.get_access_token', return_value=('THIS_IS_A_JWT', None)) @@ -264,7 +305,7 @@ def test_s3_upload_data(): key = 'raw/' + datetime.datetime.now().strftime('%Y/%m/') + filename # first try dry run without uploading. Try to get object should raise error - with pytest.raises(ClientError) as exc_info: + with pytest.raises(ClientError) as exc_info: # noqa: PT012 _upload_to_s3(config, filename, True) s3.get_object(Bucket=FAKE_BUCKET_NAME, Key=key) assert exc_info.value.response['Error']['Code'] == 'NoSuchKey' diff --git a/scripts/user_retirement/tests/test_retirement_bulk_status_update.py b/scripts/user_retirement/tests/test_retirement_bulk_status_update.py index 0cfbeeef3d7a..409a66a38fef 100644 --- a/scripts/user_retirement/tests/test_retirement_bulk_status_update.py +++ b/scripts/user_retirement/tests/test_retirement_bulk_status_update.py @@ -11,7 +11,7 @@ ERR_NO_CONFIG, ERR_SETUP_FAILED, ERR_UPDATING, - update_statuses + update_statuses, ) from scripts.user_retirement.tests.retirement_helpers import fake_config_file, get_fake_user_retirement diff --git a/scripts/user_retirement/tests/test_retirement_partner_report.py b/scripts/user_retirement/tests/test_retirement_partner_report.py index 886f2d9e4073..146f7f9d2b2c 100644 --- a/scripts/user_retirement/tests/test_retirement_partner_report.py +++ b/scripts/user_retirement/tests/test_retirement_partner_report.py @@ -1,4 +1,4 @@ -# coding=utf-8 +# coding=utf-8 # noqa: UP009 """ Test the retire_one_learner.py script """ @@ -13,10 +13,6 @@ from click.testing import CliRunner from six import PY2, itervalues -from scripts.user_retirement.retirement_partner_report import \ - _generate_report_files_or_exit # pylint: disable=protected-access -from scripts.user_retirement.retirement_partner_report import \ - _get_orgs_and_learners_or_exit # pylint: disable=protected-access from scripts.user_retirement.retirement_partner_report import ( DEFAULT_FIELD_HEADINGS, ERR_BAD_CONFIG, @@ -39,14 +35,16 @@ ORGS_KEY, REPORTING_FILENAME_PREFIX, SETUP_LMS_OR_EXIT, - generate_report + _generate_report_files_or_exit, # pylint: disable=protected-access + _get_orgs_and_learners_or_exit, # pylint: disable=protected-access + generate_report, ) from scripts.user_retirement.tests.retirement_helpers import ( FAKE_ORGS, TEST_PLATFORM_NAME, fake_config_file, fake_google_secrets_file, - flatten_partner_list + flatten_partner_list, ) TEST_CONFIG_YML_NAME = 'test_config.yml' @@ -124,11 +122,11 @@ def _call_script(expect_success=True, expected_num_rows=10, config_orgs=None, ex config_org_vals = [unicodedata.normalize('NFKC', org) for org in config_org_vals] for org in config_org_vals: - outfile = os.path.join(tmp_output_dir, '{}_{}_{}_{}.csv'.format( + outfile = os.path.join(tmp_output_dir, '{}_{}_{}_{}.csv'.format( # noqa: UP032 REPORTING_FILENAME_PREFIX, TEST_PLATFORM_NAME, org, date.today().isoformat() )) - with open(outfile, 'r') as csvfile: + with open(outfile, 'r') as csvfile: # noqa: UP015 reader = csv.DictReader(csvfile) rows = [] for row in reader: @@ -153,9 +151,9 @@ def _fake_retirement_report_user(seed_val, user_orgs=None, user_orgs_config=None """ user_info = { 'user_id': USER_ID, - LEARNER_ORIGINAL_USERNAME_KEY: 'username_{}'.format(seed_val), - 'original_email': 'user_{}@foo.invalid'.format(seed_val), - 'original_name': '{} {}'.format(UNICODE_NAME_CONSTANT, seed_val), + LEARNER_ORIGINAL_USERNAME_KEY: 'username_{}'.format(seed_val), # noqa: UP032 + 'original_email': 'user_{}@foo.invalid'.format(seed_val), # noqa: UP032 + 'original_name': '{} {}'.format(UNICODE_NAME_CONSTANT, seed_val), # noqa: UP032 LEARNER_CREATED_KEY: DELETION_TIME, } @@ -201,7 +199,7 @@ def test_report_generation_multiple_partners(*args, **kwargs): SETUP_LMS_OR_EXIT(config) orgs, usernames = _get_orgs_and_learners_or_exit(config) - assert usernames == [{'original_username': 'username_{}'.format(username)} for username in range(1, 5)] + assert usernames == [{'original_username': 'username_{}'.format(username)} for username in range(1, 5)] # noqa: UP032 def _get_learner_usernames(org_data): return [learner['original_username'] for learner in org_data['learners']] @@ -276,7 +274,7 @@ def test_successful_report(*args, **kwargs): # Make sure we tried to add comments to the files assert mock_create_comments.call_count == 1 # First [0] returns all positional args, second [0] gets the first positional arg. - create_comments_file_ids, create_comments_messages = zip(*mock_create_comments.call_args[0][0]) + create_comments_file_ids, create_comments_messages = zip(*mock_create_comments.call_args[0][0]) # noqa: B905 assert set(create_comments_file_ids).issubset(set(['foo', 'bar', 'baz', 'qux'])) assert len(create_comments_file_ids) == 2 # only two comments created, the third didn't have a POC. assert all('+some.contact@example.com' in msg for msg in create_comments_messages) @@ -713,17 +711,17 @@ def test_google_unicode_folder_names(*args, **kwargs): {'emailAddress': 'another.contact@edx.org'}, ] for partner in [ - unicodedata.normalize('NFKC', u'TéstX'), - unicodedata.normalize('NFKC', u'TéstX2'), - unicodedata.normalize('NFKC', u'TéstX3'), + unicodedata.normalize('NFKC', u'TéstX'), # noqa: UP025 + unicodedata.normalize('NFKC', u'TéstX2'), # noqa: UP025 + unicodedata.normalize('NFKC', u'TéstX3'), # noqa: UP025 ] } mock_walk_files.return_value = [ {'name': partner, 'id': 'folder' + partner} for partner in [ - unicodedata.normalize('NFKC', u'TéstX'), - unicodedata.normalize('NFKC', u'TéstX2'), - unicodedata.normalize('NFKC', u'TéstX3'), + unicodedata.normalize('NFKC', u'TéstX'), # noqa: UP025 + unicodedata.normalize('NFKC', u'TéstX2'), # noqa: UP025 + unicodedata.normalize('NFKC', u'TéstX3'), # noqa: UP025 ] ] mock_create_files.side_effect = ['foo', 'bar', 'baz'] @@ -731,9 +729,9 @@ def test_google_unicode_folder_names(*args, **kwargs): mock_retirement_report.return_value = _fake_retirement_report(user_orgs=list(FAKE_ORGS.keys())) config_orgs = { - 'org1': [unicodedata.normalize('NFKC', u'TéstX')], - 'org2': [unicodedata.normalize('NFD', u'TéstX2')], - 'org3': [unicodedata.normalize('NFKD', u'TéstX3')], + 'org1': [unicodedata.normalize('NFKC', u'TéstX')], # noqa: UP025 + 'org2': [unicodedata.normalize('NFD', u'TéstX2')], # noqa: UP025 + 'org3': [unicodedata.normalize('NFKD', u'TéstX3')], # noqa: UP025 } result = _call_script(config_orgs=config_orgs) @@ -750,7 +748,7 @@ def test_google_unicode_folder_names(*args, **kwargs): # Make sure we tried to add comments to the files assert mock_create_comments.call_count == 1 # First [0] returns all positional args, second [0] gets the first positional arg. - create_comments_file_ids, create_comments_messages = zip(*mock_create_comments.call_args[0][0]) + create_comments_file_ids, create_comments_messages = zip(*mock_create_comments.call_args[0][0]) # noqa: B905 assert set(create_comments_file_ids) == set(['foo', 'bar', 'baz']) assert all('+some.contact@example.com' in msg for msg in create_comments_messages) assert all('+another.contact@edx.org' not in msg for msg in create_comments_messages) diff --git a/scripts/user_retirement/tests/utils/test_edx_api.py b/scripts/user_retirement/tests/utils/test_edx_api.py index eb826cd1a4fd..cdddc389c974 100644 --- a/scripts/user_retirement/tests/utils/test_edx_api.py +++ b/scripts/user_retirement/tests/utils/test_edx_api.py @@ -305,7 +305,7 @@ def test_retrieve_learner_queue_backoff( ) mock_learners_to_retire.side_effect = HTTPError(response=response) - with self.assertRaises(BackoffTriedException): + with self.assertRaises(BackoffTriedException): # noqa: PT027 self.lms_api.learners_to_retire( TEST_RETIREMENT_QUEUE_STATES, cool_off_days=365) @@ -325,7 +325,7 @@ def test_retirement_partner_cleanup_backoff_on_connection_error( mock_retirement_partner_cleanup.retirement_partner_cleanup.side_effect = ConnectionError( response=response ) - with self.assertRaises(BackoffTriedException): + with self.assertRaises(BackoffTriedException): # noqa: PT027 self.lms_api.retirement_partner_cleanup([{'original_username': 'test'}]) @@ -351,39 +351,6 @@ def tearDown(self): super().tearDown() responses.reset() - @patch.object(edx_api.EcommerceApi, 'retire_learner') - def test_retirement_partner_report(self, mock_method): - json_data = { - 'username': FAKE_ORIGINAL_USERNAME, - } - responses.add( - POST, - urljoin(self.lms_base_url, 'api/v2/user/retire/'), - match=[matchers.json_params_matcher(json_data)] - ) - self.ecommerce_api.retire_learner( - learner=get_fake_user_retirement(original_username=FAKE_ORIGINAL_USERNAME) - ) - mock_method.assert_called_once_with( - learner=get_fake_user_retirement(original_username=FAKE_ORIGINAL_USERNAME) - ) - - @patch.object(edx_api.EcommerceApi, 'retire_learner') - def get_tracking_key(self, mock_method): - original_username = { - 'original_username': get_fake_user_retirement(original_username=FAKE_ORIGINAL_USERNAME) - } - responses.add( - GET, - urljoin(self.lms_base_url, f"api/v2/retirement/tracking_id/{original_username}/"), - ) - self.ecommerce_api.get_tracking_key( - learner=get_fake_user_retirement(original_username=FAKE_ORIGINAL_USERNAME) - ) - mock_method.assert_called_once_with( - learner=get_fake_user_retirement(original_username=FAKE_ORIGINAL_USERNAME) - ) - @patch.object(edx_api.EcommerceApi, 'replace_usernames') def test_replace_usernames(self, mock_method): json_data = { @@ -424,23 +391,6 @@ def tearDown(self): super().tearDown() responses.reset() - @patch.object(edx_api.CredentialsApi, 'retire_learner') - def test_retire_learner(self, mock_method): - json_data = { - 'username': FAKE_ORIGINAL_USERNAME - } - responses.add( - POST, - urljoin(self.credentials_base_url, 'user/retire/'), - match=[matchers.json_params_matcher(json_data)] - ) - self.credentials_api.retire_learner( - learner=get_fake_user_retirement(original_username=FAKE_ORIGINAL_USERNAME) - ) - mock_method.assert_called_once_with( - learner=get_fake_user_retirement(original_username=FAKE_ORIGINAL_USERNAME) - ) - @patch.object(edx_api.CredentialsApi, 'replace_usernames') def test_replace_usernames(self, mock_method): json_data = { diff --git a/scripts/user_retirement/tests/utils/test_jenkins.py b/scripts/user_retirement/tests/utils/test_jenkins.py index bd51c0f5d779..f6b5b655ea1a 100644 --- a/scripts/user_retirement/tests/utils/test_jenkins.py +++ b/scripts/user_retirement/tests/utils/test_jenkins.py @@ -15,15 +15,15 @@ import scripts.user_retirement.utils.jenkins as jenkins from scripts.user_retirement.utils.exception import BackendError -BASE_URL = u'https://test-jenkins' -USER_ID = u'foo' -USER_TOKEN = u'12345678901234567890123456789012' -JOB = u'test-job' -TOKEN = u'asdf' +BASE_URL = u'https://test-jenkins' # noqa: UP025 +USER_ID = u'foo' # noqa: UP025 +USER_TOKEN = u'12345678901234567890123456789012' # noqa: UP025 +JOB = u'test-job' # noqa: UP025 +TOKEN = u'asdf' # noqa: UP025 BUILD_NUM = 456 -JOBS_URL = u'{}/job/{}/'.format(BASE_URL, JOB) -JOB_URL = u'{}{}'.format(JOBS_URL, BUILD_NUM) -MOCK_BUILD = {u'number': BUILD_NUM, u'url': JOB_URL} +JOBS_URL = u'{}/job/{}/'.format(BASE_URL, JOB) # noqa: UP025, UP032 +JOB_URL = u'{}{}'.format(JOBS_URL, BUILD_NUM) # noqa: UP025, UP032 +MOCK_BUILD = {u'number': BUILD_NUM, u'url': JOB_URL} # noqa: UP025 MOCK_JENKINS_DATA = {'jobs': [{'name': JOB, 'url': JOBS_URL, 'color': 'blue'}]} MOCK_BUILDS_DATA = { 'actions': [ @@ -71,18 +71,18 @@ def test_properties_files(self): jenkins._recreate_directory = Mock() # pylint: disable=protected-access jenkins.export_learner_job_properties(learners, "tmpdir") jenkins._recreate_directory.assert_called_once() # pylint: disable=protected-access - self.assertIn(call('tmpdir/learner_retire_learnera', 'w'), open_mocker.call_args_list) - self.assertIn(call('tmpdir/learner_retire_learnerb', 'w'), open_mocker.call_args_list) + self.assertIn(call('tmpdir/learner_retire_learnera', 'w'), open_mocker.call_args_list) # noqa: PT009 + self.assertIn(call('tmpdir/learner_retire_learnerb', 'w'), open_mocker.call_args_list) # noqa: PT009 handle = open_mocker() - self.assertIn(call('RETIREMENT_USERNAME=learnerA\n'), handle.write.call_args_list) - self.assertIn(call('RETIREMENT_USERNAME=learnerB\n'), handle.write.call_args_list) + self.assertIn(call('RETIREMENT_USERNAME=learnerA\n'), handle.write.call_args_list) # noqa: PT009 + self.assertIn(call('RETIREMENT_USERNAME=learnerB\n'), handle.write.call_args_list) # noqa: PT009 @ddt.ddt class TestBackoff(unittest.TestCase): u""" Test of custom backoff code (wait time generator and max_tries) - """ + """ # noqa: UP025 @ddt.data( (2, 1, 1, 2, [1]), @@ -97,13 +97,13 @@ class TestBackoff(unittest.TestCase): def test_max_timeout(self, base, factor, timeout, expected_max_tries, expected_waits): # pylint: disable=protected-access wait_gen, max_tries = jenkins._backoff_timeout(timeout, base, factor) - self.assertEqual(expected_max_tries, max_tries) + self.assertEqual(expected_max_tries, max_tries) # noqa: PT009 # Use max_tries-1, because we only wait that many times waits = list(islice(wait_gen(), max_tries - 1)) - self.assertEqual(expected_waits, waits) + self.assertEqual(expected_waits, waits) # noqa: PT009 - self.assertEqual(timeout, sum(waits)) + self.assertEqual(timeout, sum(waits)) # noqa: PT009 def test_backoff_call(self): # pylint: disable=protected-access @@ -119,7 +119,7 @@ def test_backoff_call(self): count_retries() - self.assertEqual(always_false.call_count, 13) + self.assertEqual(always_false.call_count, 13) # noqa: PT009 @ddt.ddt @@ -138,38 +138,38 @@ def test_failure(self, mock): re.compile(".*"), status_code=404, ) - with self.assertRaises(BackendError): + with self.assertRaises(BackendError): # noqa: PT027 jenkins.trigger_build(BASE_URL, USER_ID, USER_TOKEN, JOB, TOKEN, None, ()) @ddt.data( (None, ()), ('my cause', ()), - (None, ((u'FOO', u'bar'),)), - (None, ((u'FOO', u'bar'), (u'BAZ', u'biz'))), - ('my cause', ((u'FOO', u'bar'),)), + (None, ((u'FOO', u'bar'),)), # noqa: UP025 + (None, ((u'FOO', u'bar'), (u'BAZ', u'biz'))), # noqa: UP025 + ('my cause', ((u'FOO', u'bar'),)), # noqa: UP025 ) @ddt.unpack @requests_mock.Mocker() def test_success(self, cause, param, mock): u""" Test triggering a jenkins job - """ + """ # noqa: UP025 def text_callback(request, context): - u""" What to return from the mock. """ + u""" What to return from the mock. """ # noqa: UP025 # This is the initial call that jenkinsapi uses to # establish connectivity to Jenkins # https://test-jenkins/api/python?tree=jobs[name,color,url] context.status_code = 200 - if request.url.startswith(u'https://test-jenkins/api/python'): + if request.url.startswith(u'https://test-jenkins/api/python'): # noqa: UP025 return json.dumps(MOCK_JENKINS_DATA) - elif request.url.startswith(u'https://test-jenkins/job/test-job/456'): + elif request.url.startswith(u'https://test-jenkins/job/test-job/456'): # noqa: UP025 return json.dumps(MOCK_BUILD_DATA) - elif request.url.startswith(u'https://test-jenkins/job/test-job'): + elif request.url.startswith(u'https://test-jenkins/job/test-job'): # noqa: UP025 return json.dumps(MOCK_BUILDS_DATA) - elif request.url.startswith(u'https://test-jenkins/queue/item/123/api/python'): + elif request.url.startswith(u'https://test-jenkins/queue/item/123/api/python'): # noqa: UP025 return json.dumps(MOCK_QUEUE_DATA) - elif request.url.startswith(u'https://test-jenkins/crumbIssuer/api/python'): + elif request.url.startswith(u'https://test-jenkins/crumbIssuer/api/python'): # noqa: UP025 return json.dumps(MOCK_CRUMB_DATA) else: # We should never get here, unless the jenkinsapi implementation changes. @@ -183,11 +183,11 @@ def text_callback(request, context): text=text_callback ) mock.post( - '{}/job/test-job/buildWithParameters'.format(BASE_URL), + '{}/job/test-job/buildWithParameters'.format(BASE_URL), # noqa: UP032 status_code=201, # Jenkins responds with a 201 Created on success - headers={'location': '{}/queue/item/123'.format(BASE_URL)} + headers={'location': '{}/queue/item/123'.format(BASE_URL)} # noqa: UP032 ) # Make the call to the Jenkins API result = jenkins.trigger_build(BASE_URL, USER_ID, USER_TOKEN, JOB, TOKEN, cause, param) - self.assertEqual(result, 'SUCCESS') + self.assertEqual(result, 'SUCCESS') # noqa: PT009 diff --git a/scripts/user_retirement/tests/utils/thirdparty_apis/test_amplitude.py b/scripts/user_retirement/tests/utils/thirdparty_apis/test_amplitude.py index 253834e19cb8..59481428bee6 100644 --- a/scripts/user_retirement/tests/utils/thirdparty_apis/test_amplitude.py +++ b/scripts/user_retirement/tests/utils/thirdparty_apis/test_amplitude.py @@ -13,7 +13,7 @@ from scripts.user_retirement.utils.thirdparty_apis.amplitude_api import ( AmplitudeApi, AmplitudeException, - AmplitudeRecoverableException + AmplitudeRecoverableException, ) @@ -51,11 +51,11 @@ def test_delete_happy_path(self, req_mock): with mock.patch.object(logger, "info") as mock_info: self.amplitude.delete_user(self.user) - self.assertEqual(mock_info.call_args, [("Amplitude user deletion succeeded",)]) + self.assertEqual(mock_info.call_args, [("Amplitude user deletion succeeded",)]) # noqa: PT009 - self.assertEqual(len(req_mock.request_history), 1) + self.assertEqual(len(req_mock.request_history), 1) # noqa: PT009 request = req_mock.request_history[0] - self.assertEqual(request.json(), + self.assertEqual(request.json(), # noqa: PT009 {"user_ids": ["1234"], 'ignore_invalid_id': 'true', "requester": "user-retirement-pipeline"}) def test_delete_fatal_error(self, req_mock): @@ -67,11 +67,11 @@ def test_delete_fatal_error(self, req_mock): message = None logger = logging.getLogger("scripts.user_retirement.utils.thirdparty_apis.amplitude_api") with mock.patch.object(logger, "error") as mock_error: - with self.assertRaises(AmplitudeException) as exc: + with self.assertRaises(AmplitudeException) as exc: # noqa: PT027 self.amplitude.delete_user(self.user) - error = "Amplitude user deletion failed due to {message}".format(message=message) - self.assertEqual(mock_error.call_args, [(error,)]) - self.assertEqual(str(exc.exception), error) + error = "Amplitude user deletion failed due to {message}".format(message=message) # noqa: UP032 + self.assertEqual(mock_error.call_args, [(error,)]) # noqa: PT009 + self.assertEqual(str(exc.exception), error) # noqa: PT009 @ddt.data(429, 500) def test_delete_recoverable_error(self, status_code, req_mock): @@ -81,6 +81,6 @@ def test_delete_recoverable_error(self, status_code, req_mock): """ self._mock_delete(req_mock, status_code) - with self.assertRaises(AmplitudeRecoverableException): + with self.assertRaises(AmplitudeRecoverableException): # noqa: PT027 self.amplitude.delete_user(self.user) - self.assertEqual(len(req_mock.request_history), MAX_ATTEMPTS) + self.assertEqual(len(req_mock.request_history), MAX_ATTEMPTS) # noqa: PT009 diff --git a/scripts/user_retirement/tests/utils/thirdparty_apis/test_braze.py b/scripts/user_retirement/tests/utils/thirdparty_apis/test_braze.py index 57ca77929fa7..e1e6c621e404 100644 --- a/scripts/user_retirement/tests/utils/thirdparty_apis/test_braze.py +++ b/scripts/user_retirement/tests/utils/thirdparty_apis/test_braze.py @@ -38,29 +38,29 @@ def test_delete_happy_path(self, req_mock): with mock.patch.object(logger, 'info') as mock_info: self.braze.delete_user(self.learner) - self.assertEqual(mock_info.call_args, [('Braze user deletion succeeded',)]) + self.assertEqual(mock_info.call_args, [('Braze user deletion succeeded',)]) # noqa: PT009 - self.assertEqual(len(req_mock.request_history), 1) + self.assertEqual(len(req_mock.request_history), 1) # noqa: PT009 request = req_mock.request_history[0] - self.assertEqual(request.json(), {'external_ids': [1234]}) + self.assertEqual(request.json(), {'external_ids': [1234]}) # noqa: PT009 def test_delete_fatal_error(self, req_mock): self._mock_delete(req_mock, 404, message='Test Error Message') logger = logging.getLogger('scripts.user_retirement.utils.thirdparty_apis.braze_api') with mock.patch.object(logger, 'error') as mock_error: - with self.assertRaises(BrazeException) as exc: + with self.assertRaises(BrazeException) as exc: # noqa: PT027 self.braze.delete_user(self.learner) error = 'Braze user deletion failed due to Test Error Message' - self.assertEqual(mock_error.call_args, [(error,)]) - self.assertEqual(str(exc.exception), error) + self.assertEqual(mock_error.call_args, [(error,)]) # noqa: PT009 + self.assertEqual(str(exc.exception), error) # noqa: PT009 @ddt.data(429, 500) def test_delete_recoverable_error(self, status_code, req_mock): self._mock_delete(req_mock, status_code) - with self.assertRaises(BrazeRecoverableException): + with self.assertRaises(BrazeRecoverableException): # noqa: PT027 self.braze.delete_user(self.learner) - self.assertEqual(len(req_mock.request_history), 5) + self.assertEqual(len(req_mock.request_history), 5) # noqa: PT009 diff --git a/scripts/user_retirement/tests/utils/thirdparty_apis/test_hubspot.py b/scripts/user_retirement/tests/utils/thirdparty_apis/test_hubspot.py index 85e58b3d953e..c7676c6ba4bd 100644 --- a/scripts/user_retirement/tests/utils/thirdparty_apis/test_hubspot.py +++ b/scripts/user_retirement/tests/utils/thirdparty_apis/test_hubspot.py @@ -11,6 +11,7 @@ # This module is imported separately solely so it can be re-loaded below. from scripts.user_retirement.utils.thirdparty_apis import hubspot_api + # This HubspotAPI class will be used without being re-loaded. from scripts.user_retirement.utils.thirdparty_apis.hubspot_api import HubspotAPI @@ -28,7 +29,7 @@ class TestHubspot(unittest.TestCase): """ def setUp(self): - super(TestHubspot, self).setUp() + super(TestHubspot, self).setUp() # noqa: UP008 self.test_learner = {'original_email': 'foo@bar.com'} self.api_key = 'example_key' self.test_vid = 12345 @@ -55,14 +56,14 @@ def _mock_delete(self, req_mock, status_code): ) def test_delete_no_email(self, req_mock, mock_alert): # pylint: disable=unused-argument - with self.assertRaises(TypeError) as exc: + with self.assertRaises(TypeError) as exc: # noqa: PT027 HubspotAPI( self.api_key, self.test_region, self.from_address, self.alert_email ).delete_user({}) - self.assertIn('Expected an email address for user to delete, but received None.', str(exc)) + self.assertIn('Expected an email address for user to delete, but received None.', str(exc)) # noqa: PT009 mock_alert.assert_not_called() def test_delete_success(self, req_mock, mock_alert): @@ -95,65 +96,65 @@ def test_delete_email_does_not_exist(self, req_mock, mock_alert): def test_delete_server_failure_on_user_retrieval(self, req_mock, mock_alert): self._mock_get_vid(req_mock, 500) - with self.assertRaises(hubspot_api.HubspotException) as exc: + with self.assertRaises(hubspot_api.HubspotException) as exc: # noqa: PT027 HubspotAPI( self.api_key, self.test_region, self.from_address, self.alert_email ).delete_user(self.test_learner) - self.assertIn("Error attempted to get user_vid from Hubspot", str(exc)) + self.assertIn("Error attempted to get user_vid from Hubspot", str(exc)) # noqa: PT009 mock_alert.assert_not_called() def test_delete_unauthorized_deletion(self, req_mock, mock_alert): self._mock_get_vid(req_mock, 200) self._mock_delete(req_mock, 401) - with self.assertRaises(hubspot_api.HubspotException) as exc: + with self.assertRaises(hubspot_api.HubspotException) as exc: # noqa: PT027 HubspotAPI( self.api_key, self.test_region, self.from_address, self.alert_email ).delete_user(self.test_learner) - self.assertIn("Hubspot user deletion failed due to authorized API call", str(exc)) + self.assertIn("Hubspot user deletion failed due to authorized API call", str(exc)) # noqa: PT009 mock_alert.assert_not_called() def test_delete_vid_not_found(self, req_mock, mock_alert): self._mock_get_vid(req_mock, 200) self._mock_delete(req_mock, 404) - with self.assertRaises(hubspot_api.HubspotException) as exc: + with self.assertRaises(hubspot_api.HubspotException) as exc: # noqa: PT027 HubspotAPI( self.api_key, self.test_region, self.from_address, self.alert_email ).delete_user(self.test_learner) - self.assertIn("Hubspot user deletion failed because vid doesn't match user", str(exc)) + self.assertIn("Hubspot user deletion failed because vid doesn't match user", str(exc)) # noqa: PT009 mock_alert.assert_not_called() def test_delete_server_failure_on_deletion(self, req_mock, mock_alert): self._mock_get_vid(req_mock, 200) self._mock_delete(req_mock, 500) - with self.assertRaises(hubspot_api.HubspotException) as exc: + with self.assertRaises(hubspot_api.HubspotException) as exc: # noqa: PT027 HubspotAPI( self.api_key, self.test_region, self.from_address, self.alert_email ).delete_user(self.test_learner) - self.assertIn("Hubspot user deletion failed due to server-side (Hubspot) issues", str(exc)) + self.assertIn("Hubspot user deletion failed due to server-side (Hubspot) issues", str(exc)) # noqa: PT009 mock_alert.assert_not_called() def test_delete_catch_all_on_deletion(self, req_mock, mock_alert): self._mock_get_vid(req_mock, 200) # Testing 403 as it's not a response type per the Hubspot API docs, so it doesn't have it's own error. self._mock_delete(req_mock, 403) - with self.assertRaises(hubspot_api.HubspotException) as exc: + with self.assertRaises(hubspot_api.HubspotException) as exc: # noqa: PT027 HubspotAPI( self.api_key, self.test_region, self.from_address, self.alert_email ).delete_user(self.test_learner) - self.assertIn("Hubspot user deletion failed due to unknown reasons", str(exc)) + self.assertIn("Hubspot user deletion failed due to unknown reasons", str(exc)) # noqa: PT009 mock_alert.assert_not_called() diff --git a/scripts/user_retirement/tests/utils/thirdparty_apis/test_salesforce.py b/scripts/user_retirement/tests/utils/thirdparty_apis/test_salesforce.py index 2267f38369b9..affeceea3060 100644 --- a/scripts/user_retirement/tests/utils/thirdparty_apis/test_salesforce.py +++ b/scripts/user_retirement/tests/utils/thirdparty_apis/test_salesforce.py @@ -41,7 +41,7 @@ def test_no_assignee_email(): ) as getuser: getuser.return_value = None with mock.patch('scripts.user_retirement.utils.thirdparty_apis.salesforce_api.Salesforce'): - with pytest.raises(Exception) as exc: + with pytest.raises(Exception) as exc: # noqa: PT011 make_api() print(str(exc)) assert 'Could not find Salesforce user with username user' in str(exc) @@ -108,7 +108,7 @@ def test_retire_task_error(test_learner, caplog): # pylint: disable=redefined-o api._sf.query.return_value = mock_query_response # pylint: disable=protected-access mock_task_response = {'success': False, 'errors': ["This is an error!"]} api._sf.Task.create.return_value = mock_task_response # pylint: disable=protected-access - with pytest.raises(Exception) as exc: + with pytest.raises(Exception) as exc: # noqa: PT011 api.retire_learner(test_learner) assert "Errors while creating task:" in caplog.text assert "This is an error!" in caplog.text diff --git a/scripts/user_retirement/tests/utils/thirdparty_apis/test_segment_api.py b/scripts/user_retirement/tests/utils/thirdparty_apis/test_segment_api.py index c52a5c5074b1..9f556955dd11 100644 --- a/scripts/user_retirement/tests/utils/thirdparty_apis/test_segment_api.py +++ b/scripts/user_retirement/tests/utils/thirdparty_apis/test_segment_api.py @@ -18,7 +18,7 @@ 'fake_base_url': 'https://segment.invalid/', 'fake_auth_token': FAKE_AUTH_TOKEN, 'fake_workspace': 'FakeEdx', - 'headers': {"Authorization": "Bearer {}".format(FAKE_AUTH_TOKEN), "Content-Type": "application/json"} + 'headers': {"Authorization": "Bearer {}".format(FAKE_AUTH_TOKEN), "Content-Type": "application/json"} # noqa: UP032 } @@ -110,7 +110,7 @@ def test_bulk_delete_error(setup_regulation_api, caplog): # pylint: disable=red mock_post.return_value = FakeErrorResponse() learner = TEST_SEGMENT_CONFIG['learner'] - with pytest.raises(Exception): + with pytest.raises(Exception): # noqa: B017, PT011 segment.delete_and_suppress_learners(learner, 1000) assert mock_post.call_count == 4 @@ -158,7 +158,7 @@ def test_bulk_unsuppress_error(setup_regulation_api, caplog): # pylint: disable mock_post.return_value = FakeErrorResponse() learner = TEST_SEGMENT_CONFIG['learner'] - with pytest.raises(Exception): + with pytest.raises(Exception): # noqa: B017, PT011 segment.unsuppress_learners_by_key('original_username', learner, 100) assert mock_post.call_count == 4 diff --git a/scripts/user_retirement/utils/edx_api.py b/scripts/user_retirement/utils/edx_api.py index e891f04019a9..f068b8416e6a 100644 --- a/scripts/user_retirement/utils/edx_api.py +++ b/scripts/user_retirement/utils/edx_api.py @@ -68,16 +68,16 @@ def _request(self, method, url, log_404_as_error=True, **kwargs): if status_code == 404 and not log_404_as_error: # Immediately raise the error so that a 404 isn't logged as an API error in this case. - raise HttpDoesNotExistException(str(exc)) + raise HttpDoesNotExistException(str(exc)) # noqa: B904 LOG.error(f"API Error: {str(exc)} with status code: {status_code}") if status_code == 504: # Differentiate gateway errors so different backoff can be used. - raise EdxGatewayTimeoutError(str(exc)) + raise EdxGatewayTimeoutError(str(exc)) # noqa: B904 if status_code == 404: - raise HttpDoesNotExistException(str(exc)) + raise HttpDoesNotExistException(str(exc)) # noqa: B904 raise except Timeout: @@ -352,11 +352,19 @@ def retirement_retire_proctoring_backend_data(self, learner): return self._request("POST", api_url) @_retry_lms_api() - def bulk_cleanup_retirements(self, usernames): - """ - Deletes the retirements for all given usernames - """ - data = {"usernames": usernames} + def bulk_cleanup_retirements(self, usernames, redacted_username=None, + redacted_email=None, redacted_name=None): + """ + Redacts and then deletes the retirements for all given usernames. + Optionally pass caller-defined redacted values for each PII field before deletion. + """ + data = {'usernames': usernames} + if redacted_username is not None: + data['redacted_username'] = redacted_username + if redacted_email is not None: + data['redacted_email'] = redacted_email + if redacted_name is not None: + data['redacted_name'] = redacted_name api_url = self.get_api_url("api/user/v1/accounts/retirement_cleanup") return self._request("POST", api_url, json=data) @@ -390,24 +398,6 @@ class EcommerceApi(BaseApiClient): Ecommerce API client with convenience methods for making API calls. """ - @_retry_lms_api() - def retire_learner(self, learner): - """ - Performs the learner retirement step for Ecommerce - """ - data = {"username": learner["original_username"]} - api_url = self.get_api_url("api/v2/user/retire") - return self._request("POST", api_url, json=data) - - @_retry_lms_api() - def get_tracking_key(self, learner): - """ - Fetches the ecommerce tracking id used for Segment tracking when - ecommerce doesn't have access to the LMS user id. - """ - api_url = self.get_api_url(f"api/v2/retirement/tracking_id/{learner['original_username']}") - return self._request("GET", api_url)["ecommerce_tracking_id"] - def replace_usernames(self, username_mappings): """ Calls the ecommerce API to replace usernames. @@ -426,15 +416,6 @@ class CredentialsApi(BaseApiClient): Credentials API client with convenience methods for making API calls. """ - @_retry_lms_api() - def retire_learner(self, learner): - """ - Performs the learner retirement step for Credentials - """ - data = {"username": learner["original_username"]} - api_url = self.get_api_url("user/retire") - return self._request("POST", api_url, json=data) - def replace_usernames(self, username_mappings): """ Calls the credentials API to replace usernames. diff --git a/scripts/user_retirement/utils/helpers.py b/scripts/user_retirement/utils/helpers.py index 804852833436..e31c845a3870 100644 --- a/scripts/user_retirement/utils/helpers.py +++ b/scripts/user_retirement/utils/helpers.py @@ -17,24 +17,32 @@ import yaml from six import text_type -from scripts.user_retirement.utils.edx_api import LmsApi # pylint: disable=wrong-import-position -from scripts.user_retirement.utils.edx_api import CredentialsApi, EcommerceApi, LicenseManagerApi -from scripts.user_retirement.utils.thirdparty_apis.amplitude_api import \ - AmplitudeApi # pylint: disable=wrong-import-position +from scripts.user_retirement.utils.edx_api import ( + CredentialsApi, + EcommerceApi, + LicenseManagerApi, + LmsApi, # pylint: disable=wrong-import-position +) +from scripts.user_retirement.utils.thirdparty_apis.amplitude_api import ( + AmplitudeApi, # pylint: disable=wrong-import-position +) from scripts.user_retirement.utils.thirdparty_apis.braze_api import BrazeApi # pylint: disable=wrong-import-position -from scripts.user_retirement.utils.thirdparty_apis.hubspot_api import \ - HubspotAPI # pylint: disable=wrong-import-position -from scripts.user_retirement.utils.thirdparty_apis.salesforce_api import \ - SalesforceApi # pylint: disable=wrong-import-position -from scripts.user_retirement.utils.thirdparty_apis.segment_api import \ - SegmentApi # pylint: disable=wrong-import-position +from scripts.user_retirement.utils.thirdparty_apis.hubspot_api import ( + HubspotAPI, # pylint: disable=wrong-import-position +) +from scripts.user_retirement.utils.thirdparty_apis.salesforce_api import ( + SalesforceApi, # pylint: disable=wrong-import-position +) +from scripts.user_retirement.utils.thirdparty_apis.segment_api import ( + SegmentApi, # pylint: disable=wrong-import-position +) def _log(kind, message): """ Convenience method to log text. Prepended "kind" text makes finding log entries easier. """ - print(u'{}: {}'.format(kind, message).encode('utf-8')) # See note at the top of this file. + print(u'{}: {}'.format(kind, message).encode('utf-8')) # See note at the top of this file. # noqa: UP025, UP032 def _fail(kind, code, message): @@ -80,12 +88,12 @@ def _config_or_exit(fail_func, fail_code, config_file): Returns the config values from the given file, allows overriding of passed in values. """ try: - with io.open(config_file, 'r') as config: + with io.open(config_file, 'r') as config: # noqa: UP020 config = yaml.safe_load(config) return config except Exception as exc: # pylint: disable=broad-except - fail_func(fail_code, 'Failed to read config file {}'.format(config_file), exc) + fail_func(fail_code, 'Failed to read config file {}'.format(config_file), exc) # noqa: UP032 def _config_with_drive_or_exit(fail_func, config_fail_code, google_fail_code, config_file, google_secrets_file): @@ -93,33 +101,33 @@ def _config_with_drive_or_exit(fail_func, config_fail_code, google_fail_code, co Returns the config values from the given file, allows overriding of passed in values. """ try: - with io.open(config_file, 'r') as config: + with io.open(config_file, 'r') as config: # noqa: UP020 config = yaml.safe_load(config) # Check required values for var in ('org_partner_mapping', 'drive_partners_folder'): if var not in config or not config[var]: - fail_func(config_fail_code, 'No {} in config, or it is empty!'.format(var), ValueError()) + fail_func(config_fail_code, 'No {} in config, or it is empty!'.format(var), ValueError()) # noqa: UP032 # Force the partner names into NFKC here and when we get the folders to ensure # they are using the same characters. Otherwise accented characters will not match. for org in config['org_partner_mapping']: - partner = config['org_partner_mapping'][org] + partner = config['org_partner_mapping'][org] # noqa: F841 config['org_partner_mapping'][org] = [unicodedata.normalize('NFKC', text_type(partner)) for partner in config['org_partner_mapping'][org]] except Exception as exc: # pylint: disable=broad-except - fail_func(config_fail_code, 'Failed to read config file {}'.format(config_file), exc) + fail_func(config_fail_code, 'Failed to read config file {}'.format(config_file), exc) # noqa: UP032 try: # Just load and parse the file to make sure it's legit JSON before doing # all of the work to get the users. - with open(google_secrets_file, 'r') as secrets_f: + with open(google_secrets_file, 'r') as secrets_f: # noqa: UP015 json.load(secrets_f) config['google_secrets_file'] = google_secrets_file return config except Exception as exc: # pylint: disable=broad-except - fail_func(google_fail_code, 'Failed to read secrets file {}'.format(google_secrets_file), exc) + fail_func(google_fail_code, 'Failed to read secrets file {}'.format(google_secrets_file), exc) # noqa: UP032 def _setup_lms_api_or_exit(fail_func, fail_code, config): @@ -177,7 +185,7 @@ def _setup_all_apis_or_exit(fail_func, fail_code, config): ('HUBSPOT', hubspot_api_key), ): if state[2] == service and service_url is None: - fail_func(fail_code, 'Service URL is not configured, but required for state {}'.format(state)) + fail_func(fail_code, 'Service URL is not configured, but required for state {}'.format(state)) # noqa: UP032 config['LMS'] = LmsApi(lms_base_url, lms_base_url, client_id, client_secret) diff --git a/scripts/user_retirement/utils/jenkins.py b/scripts/user_retirement/utils/jenkins.py index 0870af9f5d5b..4c911cd08775 100644 --- a/scripts/user_retirement/utils/jenkins.py +++ b/scripts/user_retirement/utils/jenkins.py @@ -42,18 +42,18 @@ def export_learner_job_properties(learners, directory): for learner in learners: learner_name = learner['original_username'].lower() - filename = os.path.join(directory, 'learner_retire_{}'.format(learner_name)) + filename = os.path.join(directory, 'learner_retire_{}'.format(learner_name)) # noqa: UP032 with open(filename, 'w') as learner_prop_file: learner_prop_file.write('RETIREMENT_USERNAME={}\n'.format(learner['original_username'])) def _poll_giveup(data): - u""" Raise an error when the polling tries are exceeded.""" - orig_args = data.get(u'args') + u""" Raise an error when the polling tries are exceeded.""" # noqa: UP025 + orig_args = data.get(u'args') # noqa: UP025 # The Build object was the only parameter to the original method call, # and so it's the first and only item in the args. build = orig_args[0] - msg = u'Timed out waiting for build {} to finish.'.format(build.name) + msg = u'Timed out waiting for build {} to finish.'.format(build.name) # noqa: UP025, UP032 raise BackendError(msg) @@ -76,7 +76,7 @@ def _backoff_timeout(timeout, base=2, factor=1): | | |128, 256, 512, 1024, | | | |1553 | - """ + """ # noqa: UP025 # Total duration of sum(factor * base ** n for n in range(K)) = factor*(base**K - 1)/(base - 1), # where K is the number of retries, or max_tries - 1 (since the first try doesn't require a wait) # @@ -89,7 +89,7 @@ def _backoff_timeout(timeout, base=2, factor=1): remainder = timeout - (factor * (base ** tries - 1)) / (base - 1) def expo(): - u"""Compute an exponential backoff wait period, but capped to an expected max timeout""" + u"""Compute an exponential backoff wait period, but capped to an expected max timeout""" # noqa: UP025 # pylint: disable=invalid-name n = 0 while True: @@ -133,7 +133,7 @@ def trigger_build(base_url, user_name, user_token, job_name, job_token, Raises: BackendError: if the Jenkins job could not be triggered successfully - """ + """ # noqa: UP025 @backoff.on_predicate( backoff.constant, @@ -148,7 +148,7 @@ def poll_build_for_result(build): Poll for the build running, with exponential backoff, capped to ``timeout`` seconds. The on_predicate decorator is used to retry when the return value of the target function is True. - """ + """ # noqa: UP025 return not build.is_running() # Create a dict with key/value pairs from the job_params @@ -170,25 +170,25 @@ def poll_build_for_result(build): requester=crumb_requester ) except (JenkinsAPIException, HTTPError) as err: - raise BackendError(str(err)) + raise BackendError(str(err)) # noqa: B904 if not jenkins.has_job(job_name): - msg = u'Job not found: {}.'.format(job_name) - msg += u' Verify that you have permissions for the job and double check the spelling of its name.' + msg = u'Job not found: {}.'.format(job_name) # noqa: UP025, UP032 + msg += u' Verify that you have permissions for the job and double check the spelling of its name.' # noqa: UP025 raise BackendError(msg) # This will start the job and will return a QueueItem object which can be used to get build results job = jenkins[job_name] queue_item = job.invoke(securitytoken=job_token, build_params=request_params, cause=job_cause) - LOG.info(u'Added item to jenkins. Server: {} Job: {} '.format( + LOG.info(u'Added item to jenkins. Server: {} Job: {} '.format( # noqa: UP025, UP032 jenkins.base_server_url(), queue_item )) # Block this script until we are through the queue and the job has begun to build. queue_item.block_until_building() build = queue_item.get_build() - LOG.info(u'Created build {}'.format(build)) - LOG.info(u'See {}'.format(build.baseurl)) + LOG.info(u'Created build {}'.format(build)) # noqa: UP025, UP032 + LOG.info(u'See {}'.format(build.baseurl)) # noqa: UP025, UP032 # Now block until you get a result back from the build. poll_build_for_result(build) @@ -197,5 +197,5 @@ def poll_build_for_result(build): build.poll() status = build.get_status() - LOG.info(u'Build status: {status}'.format(status=status)) + LOG.info(u'Build status: {status}'.format(status=status)) # noqa: UP025, UP032 return status diff --git a/scripts/user_retirement/utils/thirdparty_apis/amplitude_api.py b/scripts/user_retirement/utils/thirdparty_apis/amplitude_api.py index ef930f602f0b..7653e34fd476 100644 --- a/scripts/user_retirement/utils/thirdparty_apis/amplitude_api.py +++ b/scripts/user_retirement/utils/thirdparty_apis/amplitude_api.py @@ -81,7 +81,7 @@ def delete_user(self, user): return # We have some sort of error. Parse it, log it, and retry as needed. - error_msg = "Amplitude user deletion failed due to {reason}".format(reason=response.reason) + error_msg = "Amplitude user deletion failed due to {reason}".format(reason=response.reason) # noqa: UP032 logger.error(error_msg) # Status 429 is returned when there are too many requests and can be resolved in retrying sending # request. diff --git a/scripts/user_retirement/utils/thirdparty_apis/braze_api.py b/scripts/user_retirement/utils/thirdparty_apis/braze_api.py index 247ceccc6f17..851ff6acebea 100644 --- a/scripts/user_retirement/utils/thirdparty_apis/braze_api.py +++ b/scripts/user_retirement/utils/thirdparty_apis/braze_api.py @@ -28,7 +28,7 @@ def __init__(self, braze_api_key, braze_instance): self.api_key = braze_api_key # https://www.braze.com/docs/api/basics/#endpoints - self.base_url = 'https://rest.{instance}.braze.com'.format(instance=braze_instance) + self.base_url = 'https://rest.{instance}.braze.com'.format(instance=braze_instance) # noqa: UP032 def auth_headers(self): """Returns authorization headers suitable for passing to the requests library""" @@ -52,11 +52,11 @@ def get_error_message(response): def process_response(self, response, action): """Log response status and raise an error as needed""" if response.ok: - LOG.info('Braze {action} succeeded'.format(action=action)) + LOG.info('Braze {action} succeeded'.format(action=action)) # noqa: UP032 return # We have some sort of error. Parse it, log it, and retry as needed. - error_msg = 'Braze {action} failed due to {msg}'.format(action=action, msg=self.get_error_message(response)) + error_msg = 'Braze {action} failed due to {msg}'.format(action=action, msg=self.get_error_message(response)) # noqa: UP032 LOG.error(error_msg) if response.status_code == 429 or 500 <= response.status_code < 600: diff --git a/scripts/user_retirement/utils/thirdparty_apis/google_api.py b/scripts/user_retirement/utils/thirdparty_apis/google_api.py index e43670c01caf..f6087e3b2316 100644 --- a/scripts/user_retirement/utils/thirdparty_apis/google_api.py +++ b/scripts/user_retirement/utils/thirdparty_apis/google_api.py @@ -19,6 +19,7 @@ from google.oauth2.credentials import Credentials from googleapiclient.discovery import build from googleapiclient.errors import HttpError + # I'm not super happy about this since the function is protected with a leading # underscore, but the next best thing is literally copying this ~40 line # function verbatim. @@ -123,7 +124,7 @@ def _batch_with_retry(self, requests): # Generate arbitrary (but unique in this batch request) IDs for each request, so that we can recall the # corresponding response within a batch response. - request_object_to_request_id = dict(zip( + request_object_to_request_id = dict(zip( # noqa: B905 requests, (text_type(n) for n in count()), )) @@ -137,16 +138,16 @@ def batch_callback(request_id, response, exception): # pylint: disable=unused-a request_object = request_id_to_request_object[request_id] if exception: if _should_retry_google_api(exception): - LOG.error(u'Request throttled, adding to the retry queue: {}'.format(exception).encode('utf-8')) + LOG.error(u'Request throttled, adding to the retry queue: {}'.format(exception).encode('utf-8')) # noqa: UP025, UP032 retry_requests.append(request_object) else: # In this case, probably nothing can be done, so we just give up on this particular request and # do not include it in the responses dict. - LOG.error(u'Error processing request {}'.format(request_object).encode('utf-8')) + LOG.error(u'Error processing request {}'.format(request_object).encode('utf-8')) # noqa: UP025, UP032 LOG.error(text_type(exception).encode('utf-8')) else: responses[request_object] = response - LOG.info(u'Successfully processed request {}.'.format(request_object).encode('utf-8')) + LOG.info(u'Successfully processed request {}.'.format(request_object).encode('utf-8')) # noqa: UP025, UP032 # Retry on API throttling at the HTTP request level. @backoff.on_exception( @@ -269,7 +270,7 @@ def create_file_in_folder(self, folder_id, filename, file_stream, mimetype): media_body=media, fields='id' ).execute() - LOG.info(u'File uploaded: ID="{}", name="{}"'.format(uploaded_file.get('id'), filename).encode('utf-8')) + LOG.info(u'File uploaded: ID="{}", name="{}"'.format(uploaded_file.get('id'), filename).encode('utf-8')) # noqa: UP025 return uploaded_file.get('id') # NOTE: Do not decorate this function with backoff since it already calls retryable methods. @@ -324,13 +325,13 @@ def delete_files_older_than(self, top_level, delete_before_dt, mimetype=None, pr all_files = self.walk_files( top_level, 'id, name, createdTime', mimetype ) - LOG.info("Files walked. {} files found before filtering.".format(len(all_files))) + LOG.info("Files walked. {} files found before filtering.".format(len(all_files))) # noqa: UP032 file_ids_to_delete = [] for file in all_files: if (not prefix or file['name'].startswith(prefix)) and parse(file['createdTime']) < delete_before_dt: file_ids_to_delete.append(file['id']) if file_ids_to_delete: - LOG.info("{} files remaining after filtering.".format(len(file_ids_to_delete))) + LOG.info("{} files remaining after filtering.".format(len(file_ids_to_delete))) # noqa: UP032 self.delete_files(file_ids_to_delete) @backoff.on_exception( @@ -376,17 +377,17 @@ def walk_files(self, top_folder_id, file_fields='id, name', mimetype=None, recur mimetype_clause = "" if mimetype: # Return both folders and the specified mimetype. - mimetype_clause = "( mimeType = '{}' or mimeType = '{}') and ".format(FOLDER_MIMETYPE, mimetype) + mimetype_clause = "( mimeType = '{}' or mimeType = '{}') and ".format(FOLDER_MIMETYPE, mimetype) # noqa: UP032 while folders_to_visit: current_folder = folders_to_visit.pop() - LOG.info("Current folder: {}".format(current_folder)) + LOG.info("Current folder: {}".format(current_folder)) # noqa: UP032 visited_folders.append(current_folder) extra_kwargs = {} while True: resp = self._client.files().list( # pylint: disable=no-member - q="{}'{}' in parents".format(mimetype_clause, current_folder), + q="{}'{}' in parents".format(mimetype_clause, current_folder), # noqa: UP032 fields='nextPageToken, files({})'.format( file_fields + ', mimeType, parents' ), @@ -398,7 +399,7 @@ def walk_files(self, top_folder_id, file_fields='id, name', mimetype=None, recur # Examine returned results to separate folders from non-folders. for result in page_results: - LOG.info(u"walk_files: Result: {}".format(result).encode('utf-8')) + LOG.info(u"walk_files: Result: {}".format(result).encode('utf-8')) # noqa: UP025, UP032 # Folders contain files - and get special treatment. if result['mimeType'] == FOLDER_MIMETYPE: if recurse and result['id'] not in visited_folders: @@ -442,7 +443,7 @@ def create_comments_for_files(self, file_ids_and_content, fields='id'): BatchRequestError: One or more files resulted in an error when adding comments. """ - file_ids, _ = zip(*file_ids_and_content) + file_ids, _ = zip(*file_ids_and_content) # noqa: B905 if len(set(file_ids)) != len(file_ids): raise ValueError('Duplicates detected in the file_ids_and_content list.') @@ -455,7 +456,7 @@ def create_comments_for_files(self, file_ids_and_content, fields='id'): for file_id, content in file_ids_and_content_batch: request_object = self._client.comments().create( # pylint: disable=no-member fileId=file_id, - body={u'content': content}, + body={u'content': content}, # noqa: UP025 fields=fields ) request_objects_to_file_id[request_object] = file_id @@ -507,7 +508,7 @@ def list_permissions_for_files(self, file_ids, fields='emailAddress, role'): for file_id in file_ids_batch: request_object = self._client.permissions().list( # pylint: disable=no-member fileId=file_id, - fields='permissions({})'.format(fields) + fields='permissions({})'.format(fields) # noqa: UP032 ) request_objects_to_file_id[request_object] = file_id diff --git a/scripts/user_retirement/utils/thirdparty_apis/hubspot_api.py b/scripts/user_retirement/utils/thirdparty_apis/hubspot_api.py index e357fd660264..461d8a68b248 100644 --- a/scripts/user_retirement/utils/thirdparty_apis/hubspot_api.py +++ b/scripts/user_retirement/utils/thirdparty_apis/hubspot_api.py @@ -102,7 +102,7 @@ def get_user_vid(self, email): LOG.info("No action taken because no user was found in Hubspot.") return else: - error_msg = "Error attempted to get user_vid from Hubspot. Error: {}".format( + error_msg = "Error attempted to get user_vid from Hubspot. Error: {}".format( # noqa: UP032 req.text ) LOG.error(error_msg) @@ -113,7 +113,7 @@ def send_marketing_alert(self, vid): Notify marketing with user's Hubspot `vid` upon successful deletion. """ subject = "Alert: Hubspot Deletion" - body = "Learner with the VID \"{}\" has been deleted from Hubspot.".format(vid) + body = "Learner with the VID \"{}\" has been deleted from Hubspot.".format(vid) # noqa: UP032 send_email( self.aws_region, self.from_address, diff --git a/scripts/user_retirement/utils/thirdparty_apis/salesforce_api.py b/scripts/user_retirement/utils/thirdparty_apis/salesforce_api.py index 354e723739c8..b8d59fb5cd0b 100644 --- a/scripts/user_retirement/utils/thirdparty_apis/salesforce_api.py +++ b/scripts/user_retirement/utils/thirdparty_apis/salesforce_api.py @@ -70,7 +70,7 @@ def get_lead_ids_by_email(self, email): else: ids = [record['Id'] for record in id_query['records']] if len(ids) > 1: - LOG.warning("Multiple Ids returned for Lead with email {}".format(email)) + LOG.warning("Multiple Ids returned for Lead with email {}".format(email)) # noqa: UP032 return ids @backoff.on_exception( @@ -110,7 +110,7 @@ def _create_retirement_task(self, email, lead_ids): if len(lead_ids) > 1: note = "\nNotice: Multiple leads were identified with the same email. Please retire all following leads:" for lead_id in lead_ids: - note += "\n{}".format(lead_id) + note += "\n{}".format(lead_id) # noqa: UP032 task_params['Description'] += note created_task = self._sf.Task.create(task_params) if created_task['success']: diff --git a/scripts/user_retirement/utils/thirdparty_apis/segment_api.py b/scripts/user_retirement/utils/thirdparty_apis/segment_api.py index 09df5d069392..e69781082f1b 100644 --- a/scripts/user_retirement/utils/thirdparty_apis/segment_api.py +++ b/scripts/user_retirement/utils/thirdparty_apis/segment_api.py @@ -40,7 +40,7 @@ def _backoff_handler(details): try: LOG.error(traceback.format_exc()) exc = sys.exc_info()[1] - LOG.error("HTTPError code {}: {}".format(exc.response.status_code, exc.response.text)) + LOG.error("HTTPError code {}: {}".format(exc.response.status_code, exc.response.text)) # noqa: UP032 except Exception: # pylint: disable=broad-except pass @@ -108,7 +108,7 @@ def _call_segment_post(self, url, params): all others will bubble up. """ headers = { - "Authorization": "Bearer {}".format(self.auth_token), + "Authorization": "Bearer {}".format(self.auth_token), # noqa: UP032 "Content-Type": "application/json" } resp = requests.post(self.base_url + url, json=params, headers=headers) @@ -124,7 +124,7 @@ def _call_segment_get(self, url): all others will bubble up. """ headers = { - "Authorization": "Bearer {}".format(self.auth_token) + "Authorization": "Bearer {}".format(self.auth_token) # noqa: UP032 } resp = requests.get(self.base_url + url, headers=headers) resp.raise_for_status() @@ -154,7 +154,7 @@ def _send_regulation_request(self, params): try: resp_json = resp.json() bulk_user_delete_id = resp_json['regulate_id'] - LOG.info('Bulk user regulation queued. Id: {}'.format(bulk_user_delete_id)) + LOG.info('Bulk user regulation queued. Id: {}'.format(bulk_user_delete_id)) # noqa: UP032 except JSONDecodeError: resp_json = resp.text raise @@ -164,13 +164,13 @@ def _send_regulation_request(self, params): # eat the TypeError / KeyError since they won't be relevant. except (TypeError, KeyError, requests.exceptions.HTTPError, JSONDecodeError) as exc: LOG.exception(exc) - err = u'Error was encountered for params: {} \n\n Response: {}'.format( + err = u'Error was encountered for params: {} \n\n Response: {}'.format( # noqa: UP025, UP032 params, text_type(resp_json) ).encode('utf-8') LOG.error(err) - raise Exception(err) + raise Exception(err) # noqa: B904 def delete_and_suppress_learner(self, learner): """ diff --git a/scripts/verify-dunder-init.sh b/scripts/verify-dunder-init.sh index 3c94785c06b9..2972be98ffb4 100755 --- a/scripts/verify-dunder-init.sh +++ b/scripts/verify-dunder-init.sh @@ -27,7 +27,6 @@ exclude='' exclude+='^\.$' # Exclude test data that includes Python (do NOT exclude unit test source code, though). -exclude+='|^xmodule/capa/safe_exec/tests/test_files/?.*$' exclude+='|^common/test/data/?.*$' # xmodule data folder diff --git a/scripts/xblock/requirements.txt b/scripts/xblock/requirements.txt index bda90491ec9a..73d80314197b 100644 --- a/scripts/xblock/requirements.txt +++ b/scripts/xblock/requirements.txt @@ -1,16 +1,16 @@ # -# This file is autogenerated by pip-compile with Python 3.11 +# This file is autogenerated by pip-compile with Python 3.12 # by the following command: # # make upgrade # -certifi==2026.1.4 +certifi==2026.5.20 # via requests -charset-normalizer==3.4.4 +charset-normalizer==3.4.7 # via requests -idna==3.11 +idna==3.18 # via requests -requests==2.32.5 +requests==2.34.2 # via -r scripts/xblock/requirements.in -urllib3==2.6.3 +urllib3==2.7.0 # via requests diff --git a/scripts/xblock/xblock_counts.py b/scripts/xblock/xblock_counts.py index 64a4acc207a4..bcde55da7d41 100644 --- a/scripts/xblock/xblock_counts.py +++ b/scripts/xblock/xblock_counts.py @@ -103,7 +103,7 @@ def _get_course_data_summary(auth_token, months_restriction, xblock_type_set, ap # print to update the screen for status sys.stdout.write('.') sys.stdout.flush() - print('Processed %d courses' % total_courses) + print('Processed %d courses' % total_courses) # noqa: UP031 return course_summary_data @@ -158,14 +158,14 @@ def _get_block_types_from_json_file(xblock_json_file): set: A set of strings for all the types that are available in the configuration file """ if not os.path.isfile(xblock_json_file): - print('xBlock configuration file does not exist: %s' % xblock_json_file) + print('xBlock configuration file does not exist: %s' % xblock_json_file) # noqa: UP031 sys.exit(2) with open(xblock_json_file) as json_file: type_set = set() try: json_data = json.loads(json_file.read()) except ValueError as e: - print('xBlock configuration file does not match the expected layout and is ' + print('xBlock configuration file does not match the expected layout and is ' # noqa: UP031 'missing "data" list: %s' % xblock_json_file) sys.exit(str(e)) if 'data' in json_data: @@ -174,7 +174,7 @@ def _get_block_types_from_json_file(xblock_json_file): type_set.add(xblock['name']) return type_set else: - print('xBlock configuration file does not match the expected layout and is ' + print('xBlock configuration file does not match the expected layout and is ' # noqa: UP031 'missing "data" list: %s' % xblock_json_file) sys.exit(2) @@ -373,7 +373,7 @@ def get_access_token(username, password, oauth2_client_id, api_root): # Get User access token token = get_access_token(username, password, oauth2_client_id, api_root) if token is None: - print('Failed to retrieve user token for user: %s ' % username) + print('Failed to retrieve user token for user: %s ' % username) # noqa: UP031 sys.exit(2) # Collect course data and write CSV reports diff --git a/scripts/xsslint/tests/templates/test.py b/scripts/xsslint/tests/templates/test.py index 4fb183391f4d..11a37e8e4f3a 100644 --- a/scripts/xsslint/tests/templates/test.py +++ b/scripts/xsslint/tests/templates/test.py @@ -1,4 +1,4 @@ #!/usr/bin/python # Testing encoding on second line does not cause violation message = "" -x = "{}          ".format(message) +x = "{}          ".format(message) # noqa: UP032 diff --git a/scripts/xsslint/tests/test_linters.py b/scripts/xsslint/tests/test_linters.py index 2aba52ed78d7..8641958f6646 100644 --- a/scripts/xsslint/tests/test_linters.py +++ b/scripts/xsslint/tests/test_linters.py @@ -7,11 +7,12 @@ from unittest import TestCase from ddt import data, ddt - from xsslint.linters import ( - JavaScriptLinter, MakoTemplateLinter, - PythonLinter, UnderscoreTemplateLinter, - DjangoTemplateLinter + DjangoTemplateLinter, + JavaScriptLinter, + MakoTemplateLinter, + PythonLinter, + UnderscoreTemplateLinter, ) from xsslint.reporting import FileResults from xsslint.utils import ParseString @@ -70,7 +71,7 @@ def _validate_data_rules(self, data, results): print(f"Found violation: {violation.rule}") assert len(results.violations) == len(rules) - for violation, rule in zip(results.violations, rules): + for violation, rule in zip(results.violations, rules): # noqa: B905 assert violation.rule == rule @@ -1420,7 +1421,7 @@ def test_parse_string(self, data): """ Test _parse_string helper """ - linter = _build_mako_linter() + linter = _build_mako_linter() # noqa: F841 parse_string = ParseString(data['template'], data['result']['start_index'], len(data['template'])) string_dict = { @@ -1429,7 +1430,7 @@ def test_parse_string(self, data): 'quote_length': parse_string.quote_length, } - self.assertDictEqual(string_dict, data['result']) + self.assertDictEqual(string_dict, data['result']) # noqa: PT009 if parse_string.end_index is not None: assert data['template'][parse_string.start_index:parse_string.end_index] == parse_string.string start_inner_index = parse_string.start_index + parse_string.quote_length diff --git a/scripts/xsslint/tests/test_main.py b/scripts/xsslint/tests/test_main.py index 050eb3bdd56e..282c079f8ee1 100644 --- a/scripts/xsslint/tests/test_main.py +++ b/scripts/xsslint/tests/test_main.py @@ -6,9 +6,7 @@ import json import re from io import StringIO -from unittest import TestCase - -from unittest import mock +from unittest import TestCase, mock from xsslint.linters import JavaScriptLinter, MakoTemplateLinter, PythonLinter, UnderscoreTemplateLinter from xsslint.main import _build_ruleset, _lint @@ -93,9 +91,9 @@ def test_lint_defaults(self): assert re.search(f'test\\.py.*{self.ruleset.python_parse_error.rule_id}', output) is None assert re.search(f'test\\.py.*{self.ruleset.python_wrap_html.rule_id}', output) is not None # Assert no rule totals. - assert re.search('{}:\\s*{} violations'.format(self.ruleset.python_parse_error.rule_id, 0), output) is None + assert re.search('{}:\\s*{} violations'.format(self.ruleset.python_parse_error.rule_id, 0), output) is None # noqa: UP032 # Assert final total - assert re.search('{} violations total'.format(5), output) is not None + assert re.search('{} violations total'.format(5), output) is not None # noqa: UP032 def test_lint_with_verbose(self): """ @@ -126,9 +124,9 @@ def test_lint_with_verbose(self): assert lines_with_rule >= 1 assert lines_without_rule >= 1 # Assert no rule totals. - assert re.search('{}:\\s*{} violations'.format(self.ruleset.python_parse_error.rule_id, 0), output) is None + assert re.search('{}:\\s*{} violations'.format(self.ruleset.python_parse_error.rule_id, 0), output) is None # noqa: UP032 # Assert final total - assert re.search('{} violations total'.format(5), output) is not None + assert re.search('{} violations total'.format(5), output) is not None # noqa: UP032 def test_lint_with_rule_totals(self): """ @@ -152,9 +150,9 @@ def test_lint_with_rule_totals(self): assert re.search(f'test\\.py.*{self.ruleset.python_wrap_html.rule_id}', output) is not None # Assert totals output. - assert re.search('{}:\\s*{} violations'.format(self.ruleset.python_parse_error.rule_id, 0), output) is not None - assert re.search('{}:\\s*{} violations'.format(self.ruleset.python_wrap_html.rule_id, 1), output) is not None - assert re.search('{} violations total'.format(5), output) is not None + assert re.search('{}:\\s*{} violations'.format(self.ruleset.python_parse_error.rule_id, 0), output) is not None # noqa: UP032 + assert re.search('{}:\\s*{} violations'.format(self.ruleset.python_wrap_html.rule_id, 1), output) is not None # noqa: UP032 + assert re.search('{} violations total'.format(5), output) is not None # noqa: UP032 def test_lint_with_json_output(self): """ @@ -211,5 +209,5 @@ def test_lint_with_list_files(self): assert re.search('test\\.py', output) is not None # Assert no totals. - assert re.search('{}:\\s*{} violations'.format(self.ruleset.python_parse_error.rule_id, 0), output) is None - assert re.search('{} violations total'.format(7), output) is None + assert re.search('{}:\\s*{} violations'.format(self.ruleset.python_parse_error.rule_id, 0), output) is None # noqa: UP032 + assert re.search('{} violations total'.format(7), output) is None # noqa: UP032 diff --git a/scripts/xsslint/tests/test_utils.py b/scripts/xsslint/tests/test_utils.py index bbf2badcb5a1..842355832cf6 100644 --- a/scripts/xsslint/tests/test_utils.py +++ b/scripts/xsslint/tests/test_utils.py @@ -1,7 +1,6 @@ from unittest import TestCase from ddt import data, ddt - from xsslint.utils import StringLines diff --git a/scripts/xsslint/xss_linter.py b/scripts/xsslint/xss_linter.py index 76de199f0962..ebfa1a090978 100755 --- a/scripts/xsslint/xss_linter.py +++ b/scripts/xsslint/xss_linter.py @@ -10,9 +10,9 @@ import os import re import sys - from functools import reduce from io import StringIO + from xsslint.reporting import SummaryResults from xsslint.rules import RuleSet from xsslint.utils import is_skip_dir @@ -68,7 +68,7 @@ def _process_file(full_path, template_linters, options, summary_results, out): out: output file """ - num_violations = 0 + num_violations = 0 # noqa: F841 directory = os.path.dirname(full_path) file_name = os.path.basename(full_path) try: @@ -155,7 +155,7 @@ def _check_violations(options, results): try: thresholds_option = options['thresholds'] # Read the JSON file - with open(thresholds_option, 'r') as file: + with open(thresholds_option, 'r') as file: # noqa: UP015 violation_thresholds = json.load(file) except ValueError: @@ -163,7 +163,7 @@ def _check_violations(options, results): if isinstance(violation_thresholds, dict) is False or \ any(key not in ("total", "rules") for key in violation_thresholds.keys()): print('xsslint') - fail_quality("""FAILURE: Thresholds option "{thresholds_option}" was not supplied using proper format.\n""" + fail_quality("""FAILURE: Thresholds option "{thresholds_option}" was not supplied using proper format.\n""" # noqa: UP032 """Here is a properly formatted example, '{{"total":100,"rules":{{"javascript-escape":0}}}}' """ """with property names in double-quotes.""".format(thresholds_option=thresholds_option)) @@ -181,7 +181,7 @@ def _check_violations(options, results): ) except TypeError: print('xsslint') - fail_quality("FAILURE: Number of {xsslint_script} violations could not be found".format( + fail_quality("FAILURE: Number of {xsslint_script} violations could not be found".format( # noqa: UP032 xsslint_script=xsslint_script )) @@ -198,7 +198,7 @@ def _check_violations(options, results): threshold_keys = sorted(violation_thresholds['rules'].keys()) for threshold_key in threshold_keys: if threshold_key not in results['rules']: - error_message += ( + error_message += ( # noqa: UP032 "\nNumber of {xsslint_script} violations for {rule} could not be found" ).format( xsslint_script=xsslint_script, rule=threshold_key @@ -212,7 +212,7 @@ def _check_violations(options, results): if error_message: print('xsslint') - fail_quality("FAILURE: XSSLinter Failed.\n{error_message}\n" + fail_quality("FAILURE: XSSLinter Failed.\n{error_message}\n" # noqa: UP032 "run the following command to hone in on the problem:\n" "./scripts/xss-commit-linter.sh -h".format(error_message=error_message)) else: diff --git a/scripts/xsslint/xsslint/default_config.py b/scripts/xsslint/xsslint/default_config.py index e5075785e157..52ffb1ebd0fc 100644 --- a/scripts/xsslint/xsslint/default_config.py +++ b/scripts/xsslint/xsslint/default_config.py @@ -2,9 +2,11 @@ from xsslint.linters import ( - JavaScriptLinter, MakoTemplateLinter, - PythonLinter, UnderscoreTemplateLinter, - DjangoTemplateLinter + DjangoTemplateLinter, + JavaScriptLinter, + MakoTemplateLinter, + PythonLinter, + UnderscoreTemplateLinter, ) # Define the directories that should be ignored by the script. diff --git a/scripts/xsslint/xsslint/django_linter.py b/scripts/xsslint/xsslint/django_linter.py index ea909a612819..5e683b71900f 100644 --- a/scripts/xsslint/xsslint/django_linter.py +++ b/scripts/xsslint/xsslint/django_linter.py @@ -2,8 +2,9 @@ Classes for Django Template Linting. """ import re -from xsslint.utils import Expression, StringLines + from xsslint.reporting import ExpressionRuleViolation +from xsslint.utils import Expression, StringLines class TransExpression(Expression): diff --git a/scripts/xsslint/xsslint/linters.py b/scripts/xsslint/xsslint/linters.py index 541abd5811b6..a0e0136ff5ad 100644 --- a/scripts/xsslint/xsslint/linters.py +++ b/scripts/xsslint/xsslint/linters.py @@ -4,16 +4,16 @@ import ast -import io +import io # noqa: F401 import os import re import textwrap from xsslint import visitors +from xsslint.django_linter import BlockTransExpression, HtmlInterpolateExpression, TransExpression from xsslint.reporting import ExpressionRuleViolation, FileResults, RuleViolation from xsslint.rules import RuleSet from xsslint.utils import Expression, ParseString, StringLines, is_skip_dir -from xsslint.django_linter import TransExpression, BlockTransExpression, HtmlInterpolateExpression class BaseLinter: @@ -652,7 +652,7 @@ def _check_concat_with_html(self, file_contents, rule, results): ) # Match quoted HTML strings next to a '+'. regex_concat_with_html = re.compile( - r"(\+\s*{string_with_html}|{string_with_html}\s*\+)".format( + r"(\+\s*{string_with_html}|{string_with_html}\s*\+)".format( # noqa: UP032 string_with_html=regex_string_with_html, ), re.VERBOSE diff --git a/scripts/xsslint/xsslint/reporting.py b/scripts/xsslint/xsslint/reporting.py index 8d85de76c562..72ef418d62f5 100644 --- a/scripts/xsslint/xsslint/reporting.py +++ b/scripts/xsslint/xsslint/reporting.py @@ -7,7 +7,6 @@ import os import re - from xsslint.utils import StringLines @@ -225,7 +224,7 @@ def print_results(self, options, out): column = 1 rule_id = " " * (len(self.rule.rule_id) + 1) line = self.lines[line_number - self.start_line].encode(encoding='utf-8') - print("{}: {}:{}: {} {}".format( + print("{}: {}:{}: {} {}".format( # noqa: UP032 self.full_path, line_number, column, diff --git a/scripts/xsslint_config.py b/scripts/xsslint_config.py index 2f463a49dffb..905005cc33b4 100644 --- a/scripts/xsslint_config.py +++ b/scripts/xsslint_config.py @@ -1,4 +1,4 @@ -# lint-amnesty, pylint: disable=django-not-configured, missing-module-docstring +# pylint: disable=django-not-configured, missing-module-docstring # xsslint config module for edx-platform @@ -11,9 +11,11 @@ sys.path.append(os.path.join(scripts_dir, 'xsslint')) # pylint: disable=import-error,wrong-import-position from xsslint.linters import ( - JavaScriptLinter, MakoTemplateLinter, - PythonLinter, UnderscoreTemplateLinter, - DjangoTemplateLinter + DjangoTemplateLinter, + JavaScriptLinter, + MakoTemplateLinter, + PythonLinter, + UnderscoreTemplateLinter, ) # Define the directories that should be ignored by the script. diff --git a/setup.cfg b/setup.cfg deleted file mode 100644 index ac0907b667c3..000000000000 --- a/setup.cfg +++ /dev/null @@ -1,250 +0,0 @@ -[tool:pytest] -# Note: The first file of settings found is used, there is no combining, so -# this file is only used for tests that don't find a pytest.ini file first. -# Details at https://docs.pytest.org/en/latest/reference/customize.html - -DJANGO_SETTINGS_MODULE = lms.envs.test -addopts = --nomigrations --reuse-db --durations=20 --json-report --json-report-omit keywords streams collectors log traceback tests --json-report-file=none -# Enable default handling for all warnings, including those that are ignored by default; -# but hide rate-limit warnings (because we deliberately don't throttle test user logins) -# and field_data deprecation warnings (because fixing them requires a major low-priority refactoring) -filterwarnings = - default - ignore:No request passed to the backend, unable to rate-limit:UserWarning - ignore::xblock.exceptions.FieldDataDeprecationWarning - # Remove default_app_config warning after updating Django to 4.2 - ignore:.*You can remove default_app_config.*:PendingDeprecationWarning - ignore:Instead access HTTPResponse.headers directly.*:DeprecationWarning:elasticsearch - # ABC deprecation Warning comes from libsass - ignore:Using or importing the ABCs from 'collections' instead of from 'collections.abc' is deprecated.*:DeprecationWarning:sass - ignore:'etree' is deprecated. Use 'xml.etree.ElementTree' instead.:DeprecationWarning:wiki - -junit_family = xunit2 -norecursedirs = .* *.egg build conf dist node_modules test_root cms/envs lms/envs openedx/envs -python_classes = -python_files = tests.py test_*.py tests_*.py *_tests.py __init__.py - -[pycodestyle] -# error codes: https://pycodestyle.readthedocs.io/en/latest/intro.html#error-codes -# E501: line too long -# E265: block comment should start with '# ' -# We ignore this because pep8 used to erroneously lump E266 into it also. -# We should probably fix these now. -# E266: too many leading '#' for block comment -# We have lots of comments that look like "##### HEADING #####" which violate -# this rule, because they don't have a space after the first #. However, -# they're still perfectly reasonable comments, so we disable this rule. -# W602: deprecated form of raising exception -# We do this in a few places to modify the exception message while preserving -# the traceback. See this blog post for more info: -# http://nedbatchelder.com/blog/200711/rethrowing_exceptions_in_python.html -# It's a little unusual, but we have good reasons for doing so, so we disable -# this rule. -# E203: whitespace before ':' -# We ignore this because of black formatter defaults -# E305,E402,E722,E731,E741,E743,W503,W504: errors and warnings added since pep8/pycodestyle -# 1.5.7 that we haven't cleaned up yet -ignore=E203,E265,E266,E305,E402,E501,E722,E731,E741,E743,W503,W504,W602 -exclude=migrations,.git,.pycharm_helpers,.tox,test_root/staticfiles,node_modules - -[isort] -indent=' ' -line_length=120 -multi_line_output=3 -skip= - envs - migrations - -[importlinter] -root_packages = - lms - cms - openedx - openedx_learning -include_external_packages = True -contract_types = - # Our custom contract which checks that we're only importing from 'api.py' - # for participating packages. - isolated_apps: openedx.testing.importlinter.isolated_apps_contract.IsolatedAppsContract - -[importlinter:contract:1] -name = lms and cms are independent -type = independence -modules = - lms - cms -ignore_imports = - ############################################################################ - # lms side imports that we are ignoring for now - lms.djangoapps.course_home_api.outline.tests.test_view -> cms.djangoapps.contentstore.outlines - lms.djangoapps.course_home_api.tests.utils -> cms.djangoapps.contentstore.outlines - # lms.djangoapps.instructor.tests.test_api & lms.djangoapps.instructor.tests.test_tools - # -> openedx.core.djangoapps.course_date_signals.handlers - # -> cms.djangoapps.contentstore.config.waffle - openedx.core.djangoapps.course_date_signals.handlers -> cms.djangoapps.contentstore.config.waffle - ############################################################################ - # cms side imports that we are ignoring for now - cms.djangoapps.contentstore.views.tests.test_block -> lms.djangoapps.lms_xblock.mixin - cms.djangoapps.contentstore.signals.handlers -> lms.djangoapps.grades.api - cms.djangoapps.contentstore.course_group_config -> lms.lib.utils - cms.djangoapps.contentstore.views.preview -> lms.djangoapps.lms_xblock.field_data - # cms.envs.common - # -> openedx.envs.common - # -> lms.djangoapps.lms_xblock.mixin - openedx.envs.common -> lms.djangoapps.lms_xblock.mixin - # cms.djangoapps.contentstore.views.tests.test_group_configurations - # -> openedx.features.content_type_gating.helpers - # -> lms.djangoapps.courseware.masquerade - openedx.features.content_type_gating.helpers -> lms.djangoapps.courseware.masquerade - # cms.djangoapps.contentstore.utils - # -> openedx.core.djangoapps.django_comment_common.models - # -> openedx.core.djangoapps.course_groups.cohorts - # -> lms.djangoapps.courseware.courses - openedx.core.djangoapps.course_groups.cohorts -> lms.djangoapps.courseware.courses - # cms.djangoapps.contentstore.[various] - # -> openedx.features.content_type_gating.partitions - # -> lms.djangoapps.commerce.utils - openedx.features.content_type_gating.partitions -> lms.djangoapps.commerce.utils - # cms.djangoapps.contentstore.course_group_config - # -> openedx.core.djangoapps.course_groups.partition_scheme - # -> lms.djangoapps.courseware.masquerade - openedx.core.djangoapps.course_groups.partition_scheme -> lms.djangoapps.courseware.masquerade - # cms.djangoapps.export_course_metadata.tasks - # -> openedx.core.djangoapps.schedules.content_highlights - # -> lms.djangoapps.courseware.block_render & lms.djangoapps.courseware.model_data - openedx.core.djangoapps.content_libraries.* -> lms.djangoapps.*.* - # cms.djangoapps.contentstore.tasks -> openedx.core.djangoapps.content_libraries.[various] - # -> lms.djangoapps.grades.api - openedx.core.djangoapps.xblock.*.* -> lms.djangoapps.*.* - # cms.djangoapps.contentstore.tasks -> openedx.core.djangoapps.content_libraries.[various] -> openedx.core.djangoapps.xblock.[various] - # -> lms.djangoapps.courseware & lms.djangoapps.courseware.grades - openedx.core.djangoapps.schedules.content_highlights -> lms.djangoapps.courseware.* - # cms.djangoapps.contentstore.[various] - # -> openedx.core.lib.gating.api - # -> lms.djangoapps.course_blocks.api & lms.djangoapps.courseware.access & lms.djangoapps.grades.api - openedx.core.lib.gating.api -> lms.djangoapps.*.* - # cms.djangoapps.contentstore.[various] - # -> openedx.features.content_type_gating.partitions - # -> openedx.features.discounts.utils - # -> lms.djangoapps.courseware.utils & lms.djangoapps.experiments.models - openedx.features.discounts.utils -> lms.djangoapps.courseware.utils - openedx.features.discounts.utils -> lms.djangoapps.experiments.models - # cms.djangoapps.contentstore.signals.handlers - # -> openedx.core.djangoapps.discussions.tasks - # -> openedx.core.djangoapps.discussions.utils - # -> lms.djangoapps.courseware.access - openedx.core.djangoapps.discussions.utils -> lms.djangoapps.courseware.access - # cms.djangoapps.contentstore.[various] - # -> openedx.features.content_type_gating.partitions - # -> openedx.features.discounts.utils - # -> openedx.features.discounts.applicability - # -> lms.djangoapps.courseware.toggles - # & lms.djangoapps.courseware.utils - # & lms.djangoapps.experiments.models - # & lms.djangoapps.experiments.stable_bucketing - openedx.features.discounts.applicability -> lms.djangoapps.courseware.* - openedx.features.discounts.applicability -> lms.djangoapps.experiments.* - # cms.djangoapps.contentstore.[various] - # -> openedx.core.djangoapps.content.learning_sequences.api - # -> openedx.core.djangoapps.content.learning_sequences.api.outlines - # -> openedx.core.djangoapps.content.learning_sequences.api.permissions - # -> lms.djangoapps.courseware.access - openedx.core.djangoapps.content.learning_sequences.api.permissions -> lms.djangoapps.courseware.access - # cms.djangoapps.contentstore.[various] - # -> openedx.features.content_type_gating.partitions - # -> openedx.features.discounts.utils - # -> openedx.features.discounts.applicability - # -> openedx.features.enterprise_support.utils - openedx.features.enterprise_support.utils -> lms.djangoapps.branding.api - cms.djangoapps.contentstore.rest_api.v1.views.settings -> lms.djangoapps.certificates.api - # We are ignoring this existing import until we can refactor contenstore/helpers. - # https://github.com/openedx/edx-platform/issues/37637 - openedx.core.djangoapps.content_libraries.api.libraries -> cms.djangoapps.contentstore.helpers - openedx.core.djangoapps.content_libraries.api.blocks -> cms.djangoapps.contentstore.helpers - openedx.core.djangoapps.content_staging.serializers -> cms.djangoapps.contentstore.helpers - # These imports will become OK once we move content_libraries into CMS - # https://github.com/openedx/edx-platform/issues/33428 - openedx.core.djangoapps.content_libraries.permissions -> cms.djangoapps.course_creators.views - openedx.core.djangoapps.content_libraries.tasks -> cms.djangoapps.contentstore.storage - # Outstanding arch issue: course_overviews is tangled up with LMS - # https://github.com/openedx/edx-platform/issues/37658 - openedx.core.djangoapps.content.course_overviews.models -> lms.djangoapps.** - # Outstanding arch issue: content_highlights uses courseware block_render - # https://github.com/openedx/edx-platform/issues/37659 - openedx.core.djangoapps.schedules.content_highlights -> lms.djangoapps.courseware.block_render - -[importlinter:contract:2] -name = Do not depend on non-public API of isolated apps. -type = isolated_apps -isolated_apps = - cms.djangoapps.modulestore_migrator - openedx.core.djangoapps.agreements - openedx.core.djangoapps.bookmarks - openedx.core.djangoapps.content_libraries - openedx.core.djangoapps.content_staging - openedx.core.djangoapps.olx_rest_api - openedx.core.djangoapps.xblock - openedx.core.lib.xblock_serializer -allowed_modules = - # Only imports from api.py and data.py are allowed elsewhere in the code - # See https://open-edx-proposals.readthedocs.io/en/latest/best-practices/oep-0049-django-app-patterns.html#api-py - api - data - tests - -[importlinter:contract:3] -name = Do not import apps from openedx-learning (only import from openedx_learning.api.* and openedx_learning.lib.*). -type = forbidden -source_modules = - cms - lms - openedx -forbidden_modules = - openedx_learning.apps -allow_indirect_imports = True - -[importlinter:contract:4] -name = Low-level apps should not depend on high-level apps -type = layers -layers = - # Layers from high-level to low-level. Imports should only occur from higher to lower. - cms.lib.xblock.upstream_sync | openedx.core.djangoapps.content.search | openedx.core.djangoapps.olx_rest_api - openedx.core.djangoapps.content_libraries - openedx.core.djangoapps.content_staging - openedx.core.djangoapps.xblock - openedx.core.lib.xblock_serializer - openedx.core.djangoapps.content_tagging -ignore_imports = - # Test code can break these layering rules - **.tests.** -> ** - - # FIXME: the exceptions below are from before we added this import linting rule. Should refactor to eliminate them. - # In particular, the contentstore.helpers module is too big and has too many imports - # See https://github.com/openedx/edx-platform/issues/37637 - - # The CSV export hard-codes support for courses and libraries. Refactor to do something like learning_context.get_children() - openedx.core.djangoapps.content_tagging.helpers.objecttag_export_helpers -> openedx.core.djangoapps.content_libraries.api - # The permissions checking code for tagging requires libraries model data to get all the orgs that a user is using: - openedx.core.djangoapps.content_tagging.utils -> openedx.core.djangoapps.content_libraries.api - # Content staging POST to clipboard API uses libraries APIs. We're working on moving this code to content_libraries - openedx.core.djangoapps.content_staging.views -> openedx.core.djangoapps.content_libraries.api - # content_staging.serializers imports contentstore.helpers which imports contentstore.utils which imports the libraries API. - openedx.core.djangoapps.content_staging.serializers -> cms.djangoapps.contentstore.helpers - # content_libraries.rest_api.libraries imports cms.djangoapps.contentstore.views.course which imports - # contentstore.toggles which imports djangoapps.content.search.api - openedx.core.djangoapps.content_libraries.rest_api.libraries -> cms.djangoapps.contentstore.views.course - # Content libraries imports contentstore.helpers which imports upstream_sync - openedx.core.djangoapps.content_libraries.api.blocks -> cms.djangoapps.contentstore.helpers - openedx.core.djangoapps.content_libraries.api.libraries -> cms.djangoapps.contentstore.helpers - # Outstanding arch issue: course_overviews is tangled up with LMS - # https://github.com/openedx/edx-platform/issues/37658 - openedx.core.djangoapps.content.course_overviews.models -> lms.djangoapps.** - # Outstanding arch issue: content_highlights uses courseware block_render - # https://github.com/openedx/edx-platform/issues/37659 - openedx.core.djangoapps.schedules.content_highlights -> lms.djangoapps.courseware.block_render - # This import happens only because grading signals are defined in LMS rather than openedx-events - # https://github.com/openedx/edx-platform/issues/37660 - openedx.core.djangoapps.xblock.runtime.runtime -> lms.djangoapps.grades.api - # These imports will become OK once we worked on the following issue: - # https://github.com/openedx/edx-platform/issues/33428 - openedx.core.djangoapps.video_config.services -> openedx.core.djangoapps.content_libraries.api diff --git a/setup.py b/setup.py deleted file mode 100644 index eeb7b79f534d..000000000000 --- a/setup.py +++ /dev/null @@ -1,195 +0,0 @@ -""" # lint-amnesty, pylint: disable=django-not-configured -Setup script for the Open edX package. -""" - -from setuptools import setup - -XBLOCKS = [ - "about = xmodule.html_block:AboutBlock", - "book = xmodule.template_block:TranslateCustomTagBlock", - "annotatable = xmodule.annotatable_block:AnnotatableBlock", - "chapter = xmodule.seq_block:SectionBlock", - "conditional = xmodule.conditional_block:ConditionalBlock", - "course = xmodule.course_block:CourseBlock", - "course_info = xmodule.html_block:CourseInfoBlock", - "customtag = xmodule.template_block:CustomTagBlock", - "custom_tag_template = xmodule.template_block:CustomTagTemplateBlock", - "discuss = xmodule.template_block:TranslateCustomTagBlock", - "discussion = xmodule.discussion_block:DiscussionXBlock", - "error = xmodule.error_block:ErrorBlock", - "hidden = xmodule.hidden_block:HiddenBlock", - "html = xmodule.html_block:HtmlBlock", - "itembank = xmodule.item_bank_block:ItemBankBlock", - "image = xmodule.template_block:TranslateCustomTagBlock", - "library = xmodule.library_root_xblock:LibraryRoot", - "library_content = xmodule.library_content_block:LegacyLibraryContentBlock", - "lti = xmodule.lti_block:LTIBlock", - "poll_question = xmodule.poll_block:PollBlock", - "problem = xmodule.capa_block:ProblemBlock", - "randomize = xmodule.randomize_block:RandomizeBlock", - "sequential = xmodule.seq_block:SequenceBlock", - "slides = xmodule.template_block:TranslateCustomTagBlock", - "split_test = xmodule.split_test_block:SplitTestBlock", - "static_tab = xmodule.html_block:StaticTabBlock", - "unit = xmodule.unit_block:UnitBlock", - "vertical = xmodule.vertical_block:VerticalBlock", - "video = xmodule.video_block:VideoBlock", - "videoalpha = xmodule.video_block:VideoBlock", - "videodev = xmodule.template_block:TranslateCustomTagBlock", - "word_cloud = xmodule.word_cloud_block:WordCloudBlock", - "wrapper = xmodule.wrapper_block:WrapperBlock", -] -XBLOCKS_ASIDES = [ - 'tagging_aside = cms.lib.xblock.tagging:StructuredTagsAside', -] - - -setup( - name="Open edX", - version='0.13', - install_requires=["setuptools"], - requires=[], - # NOTE: These are not the names we should be installing. This tree should - # be reorganized to be a more conventional Python tree. - packages=[ - "cms", - "common", - "lms", - "openedx", - "xmodule", - ], - package_data={ - 'xmodule': ['js/module/*'], - }, - entry_points={ - "openedx.course_tab": [ - "ccx = lms.djangoapps.ccx.plugins:CcxCourseTab", - "courseware = lms.djangoapps.courseware.tabs:CoursewareTab", - "dates = lms.djangoapps.courseware.tabs:DatesTab", - "discussion = lms.djangoapps.discussion.plugins:DiscussionTab", - "edxnotes = lms.djangoapps.edxnotes.plugins:EdxNotesTab", - "external_discussion = lms.djangoapps.courseware.tabs:ExternalDiscussionCourseTab", - "external_link = lms.djangoapps.courseware.tabs:ExternalLinkCourseTab", - "html_textbooks = lms.djangoapps.courseware.tabs:HtmlTextbookTabs", - "instructor = lms.djangoapps.instructor.views.instructor_dashboard:InstructorDashboardTab", - "lti_discussion = openedx.features.lti_course_tab.tab:DiscussionLtiCourseTab", - "lti_live = openedx.core.djangoapps.course_live.tab:CourseLiveTab", - "lti_tab = openedx.features.lti_course_tab.tab:LtiCourseTab", - "pdf_textbooks = lms.djangoapps.courseware.tabs:PDFTextbookTabs", - "progress = lms.djangoapps.courseware.tabs:ProgressTab", - "static_tab = xmodule.tabs:StaticTab", - "syllabus = lms.djangoapps.courseware.tabs:SyllabusTab", - "teams = lms.djangoapps.teams.plugins:TeamsTab", - "textbooks = lms.djangoapps.courseware.tabs:TextbookTabs", - "wiki = lms.djangoapps.course_wiki.tab:WikiTab", - ], - "openedx.course_app": [ - "calculator = lms.djangoapps.courseware.plugins:CalculatorCourseApp", - "custom_pages = lms.djangoapps.courseware.plugins:CustomPagesCourseApp", - "discussion = openedx.core.djangoapps.discussions.plugins:DiscussionCourseApp", - "edxnotes = lms.djangoapps.edxnotes.plugins:EdxNotesCourseApp", - "live = openedx.core.djangoapps.course_live.plugins:LiveCourseApp", - "ora_settings = lms.djangoapps.courseware.plugins:ORASettingsApp", - "proctoring = lms.djangoapps.courseware.plugins:ProctoringCourseApp", - "progress = lms.djangoapps.courseware.plugins:ProgressCourseApp", - "teams = lms.djangoapps.teams.plugins:TeamsCourseApp", - "textbooks = lms.djangoapps.courseware.plugins:TextbooksCourseApp", - "wiki = lms.djangoapps.course_wiki.plugins.course_app:WikiCourseApp", - ], - "openedx.course_tool": [ - "calendar_sync_toggle = openedx.features.calendar_sync.plugins:CalendarSyncToggleTool", - "course_bookmarks = openedx.features.course_bookmarks.plugins:CourseBookmarksTool", - "course_updates = openedx.features.course_experience.plugins:CourseUpdatesTool", - "financial_assistance = lms.djangoapps.courseware.course_tools:FinancialAssistanceTool", - ], - "openedx.user_partition_scheme": [ - "cohort = openedx.core.djangoapps.course_groups.partition_scheme:CohortPartitionScheme", - "content_type_gate = openedx.features.content_type_gating.partitions:ContentTypeGatingPartitionScheme", - "enrollment_track = openedx.core.djangoapps.verified_track_content.partition_scheme:EnrollmentTrackPartitionScheme", # lint-amnesty, pylint: disable=line-too-long - "random = openedx.core.djangoapps.user_api.partition_schemes:RandomUserPartitionScheme", - "team = lms.djangoapps.teams.team_partition_scheme:TeamPartitionScheme", - "verification = openedx.core.djangoapps.user_api.partition_schemes:ReturnGroup1PartitionScheme", - ], - "openedx.block_structure_transformer": [ - "library_content = lms.djangoapps.course_blocks.transformers.library_content:ContentLibraryTransformer", - "library_content_randomize = lms.djangoapps.course_blocks.transformers.library_content:ContentLibraryOrderTransformer", # lint-amnesty, pylint: disable=line-too-long - "split_test = lms.djangoapps.course_blocks.transformers.split_test:SplitTestTransformer", - "start_date = lms.djangoapps.course_blocks.transformers.start_date:StartDateTransformer", - "user_partitions = lms.djangoapps.course_blocks.transformers.user_partitions:UserPartitionTransformer", - "visibility = lms.djangoapps.course_blocks.transformers.visibility:VisibilityTransformer", - "hidden_content = lms.djangoapps.course_blocks.transformers.hidden_content:HiddenContentTransformer", - "course_blocks_api = lms.djangoapps.course_api.blocks.transformers.blocks_api:BlocksAPITransformer", - "milestones = lms.djangoapps.course_api.blocks.transformers.milestones:MilestonesAndSpecialExamsTransformer", # lint-amnesty, pylint: disable=line-too-long - "grades = lms.djangoapps.grades.transformer:GradesTransformer", - "completion = lms.djangoapps.course_api.blocks.transformers.block_completion:BlockCompletionTransformer", - "load_override_data = lms.djangoapps.course_blocks.transformers.load_override_data:OverrideDataTransformer", - "content_type_gate = openedx.features.content_type_gating.block_transformers:ContentTypeGateTransformer", - "access_denied_message_filter = lms.djangoapps.course_blocks.transformers.access_denied_filter:AccessDeniedMessageFilterTransformer", # lint-amnesty, pylint: disable=line-too-long - "open_assessment_transformer = lms.djangoapps.courseware.transformers:OpenAssessmentDateTransformer", - 'effort_estimation = openedx.features.effort_estimation.api:EffortEstimationTransformer', - 'discussions_link = openedx.core.djangoapps.discussions.transformers:DiscussionsTopicLinkTransformer', - ], - "openedx.ace.policy": [ - "bulk_email_optout = lms.djangoapps.bulk_email.policies:CourseEmailOptout", - "course_push_notification_optout = openedx.core.djangoapps.notifications.policies:CoursePushNotificationOptout", # lint-amnesty, pylint: disable=line-too-long - "disabled_user_optout = openedx.core.djangoapps.ace_common.policies:DisableUserOptout", - ], - "openedx.call_to_action": [ - "personalized_learner_schedules = openedx.features.personalized_learner_schedules.call_to_action:PersonalizedLearnerScheduleCallToAction" # lint-amnesty, pylint: disable=line-too-long - ], - "lms.djangoapp": [ - "ace_common = openedx.core.djangoapps.ace_common.apps:AceCommonConfig", - "content_libraries = openedx.core.djangoapps.content_libraries.apps:ContentLibrariesConfig", - "course_apps = openedx.core.djangoapps.course_apps.apps:CourseAppsConfig", - "course_live = openedx.core.djangoapps.course_live.apps:CourseLiveConfig", - "courseware_api = openedx.core.djangoapps.courseware_api.apps:CoursewareAPIConfig", - "credentials = openedx.core.djangoapps.credentials.apps:CredentialsConfig", - "discussion = lms.djangoapps.discussion.apps:DiscussionConfig", - "discussions = openedx.core.djangoapps.discussions.apps:DiscussionsConfig", - "grades = lms.djangoapps.grades.apps:GradesConfig", - "plugins = openedx.core.djangoapps.plugins.apps:PluginsConfig", - "theming = openedx.core.djangoapps.theming.apps:ThemingConfig", - "bookmarks = openedx.core.djangoapps.bookmarks.apps:BookmarksConfig", - "zendesk_proxy = openedx.core.djangoapps.zendesk_proxy.apps:ZendeskProxyConfig", - "instructor = lms.djangoapps.instructor.apps:InstructorConfig", - "password_policy = openedx.core.djangoapps.password_policy.apps:PasswordPolicyConfig", - "user_authn = openedx.core.djangoapps.user_authn.apps:UserAuthnConfig", - "program_enrollments = lms.djangoapps.program_enrollments.apps:ProgramEnrollmentsConfig", - ], - "cms.djangoapp": [ - "ace_common = openedx.core.djangoapps.ace_common.apps:AceCommonConfig", - "bookmarks = openedx.core.djangoapps.bookmarks.apps:BookmarksConfig", - "course_live = openedx.core.djangoapps.course_live.apps:CourseLiveConfig", - "content_libraries = openedx.core.djangoapps.content_libraries.apps:ContentLibrariesConfig", - "content_staging = openedx.core.djangoapps.content_staging.apps:ContentStagingAppConfig", - "course_apps = openedx.core.djangoapps.course_apps.apps:CourseAppsConfig", - # Importing an LMS app into the Studio process is not a good - # practice. We're ignoring this for Discussions here because its - # placement in LMS is a historical artifact. The eventual goal is to - # consolidate the multiple discussions-related Django apps and - # either put them in the openedx/ dir, or in another repo entirely. - "discussion = lms.djangoapps.discussion.apps:DiscussionConfig", - "discussions = openedx.core.djangoapps.discussions.apps:DiscussionsConfig", - "instructor = lms.djangoapps.instructor.apps:InstructorConfig", - "olx_rest_api = openedx.core.djangoapps.olx_rest_api.apps:OlxRestApiAppConfig", - "password_policy = openedx.core.djangoapps.password_policy.apps:PasswordPolicyConfig", - "plugins = openedx.core.djangoapps.plugins.apps:PluginsConfig", - "theming = openedx.core.djangoapps.theming.apps:ThemingConfig", - "user_authn = openedx.core.djangoapps.user_authn.apps:UserAuthnConfig", - "zendesk_proxy = openedx.core.djangoapps.zendesk_proxy.apps:ZendeskProxyConfig", - ], - 'openedx.learning_context': [ - 'lib = openedx.core.djangoapps.content_libraries.library_context:LibraryContextImpl', - ], - 'openedx.dynamic_partition_generator': [ - 'content_type_gating = openedx.features.content_type_gating.partitions:create_content_gating_partition', - 'enrollment_track = xmodule.partitions.enrollment_track_partition_generator:create_enrollment_track_partition', # lint-amnesty, pylint: disable=line-too-long - 'team = openedx.core.lib.teams_config:create_team_set_partition', - ], - 'xblock.v1': XBLOCKS, - 'xblock_asides.v1': XBLOCKS_ASIDES, - 'console_scripts': [ - 'xmodule_assets = xmodule.static_content:main', - ], - } -) diff --git a/tox.ini b/tox.ini index e5df7f0fbd2f..2284f57356b9 100644 --- a/tox.ini +++ b/tox.ini @@ -1,8 +1,8 @@ [tox] -envlist = py{311} quality +envlist = py{312} quality # This is needed to prevent the lms, cms, and openedx packages inside the "Open -# edX" package (defined in setup.py) from getting installed into site-packages +# edX" package (defined in pyproject.toml) from getting installed into site-packages # where they can get imported, which is bad because those won't even contain # most of the source code since we don't explicitly add anything to the source # distribution. diff --git a/webpack-config/file-lists.js b/webpack-config/file-lists.js index 1ca653ba3ef2..f92664881395 100644 --- a/webpack-config/file-lists.js +++ b/webpack-config/file-lists.js @@ -24,19 +24,13 @@ module.exports = { path.resolve(__dirname, '../cms/static/js/certificates/views/certificate_preview.js'), path.resolve(__dirname, '../cms/static/js/certificates/views/signatory_details.js'), path.resolve(__dirname, '../cms/static/js/certificates/views/signatory_editor.js'), - path.resolve(__dirname, '../cms/static/js/views/active_video_upload_list.js'), path.resolve(__dirname, '../cms/static/js/views/assets.js'), - path.resolve(__dirname, '../cms/static/js/views/course_video_settings.js'), path.resolve(__dirname, '../cms/static/js/views/experiment_group_edit.js'), path.resolve(__dirname, '../cms/static/js/views/license.js'), path.resolve(__dirname, '../cms/static/js/views/modals/move_xblock_modal.js'), path.resolve(__dirname, '../cms/static/js/views/move_xblock_breadcrumb.js'), path.resolve(__dirname, '../cms/static/js/views/move_xblock_list.js'), path.resolve(__dirname, '../cms/static/js/views/paging_header.js'), - path.resolve(__dirname, '../cms/static/js/views/previous_video_upload_list.js'), - path.resolve(__dirname, '../cms/static/js/views/previous_video_upload.js'), - path.resolve(__dirname, '../cms/static/js/views/video_thumbnail.js'), - path.resolve(__dirname, '../cms/static/js/views/video_transcripts.js'), path.resolve(__dirname, '../common/static/common/js/components/views/feedback.js'), path.resolve(__dirname, '../common/static/common/js/components/views/paginated_view.js'), path.resolve(__dirname, '../common/static/common/js/components/views/paging_footer.js'), diff --git a/xmodule/README.rst b/xmodule/README.rst index 8bbae713b7a4..cb2f0ea99027 100644 --- a/xmodule/README.rst +++ b/xmodule/README.rst @@ -41,16 +41,16 @@ Direction Currently, this directory contains a lot of mission-critical functionality, so continued maintenance and simplification of it is important. Still, we aim to eventually dissolve the directory in favor of more focused & decoupled subsystems: -* ModuleStore is superseded by the `Learning Core`_ storage backend. -* Learning Core-backend content is rendered by a new, simplified `edx-platform XBlock runtime`_. -* Navigation, partitioning, and composition of learning content is being re-architected in the `openedx-learning`_ library. +* ModuleStore is superseded by the `openedx_content`_ storage backend. +* Content within ``openedx_content`` is rendered by a new, simplified `openedx-platform XBlock runtime`_. +* Navigation, partitioning, and composition of learning content is being re-architected in the `openedx-core`_ library, + which includes the implementations of ``openedx_content`` and ``openedx_tagging``. * All new XBlocks are implemented in separate repositories, such as `xblock-drag-and-drop-v2`_. To help with this direction, please **do not add new functionality to this directory**. If you feel that you need to add code to this directory, reach out on `the forums`_; it's likely that someone can help you find a different way to implement your change that will be more robust and architecturally sound! -.. _Learning Core: https://github.com/openedx/openedx-learning/ -.. _edx-platform XBlock runtime: https://github.com/openedx/edx-platform/tree/master/openedx/core/djangoapps/xblock -.. _openedx-learning: https://github.com/openedx/openedx-learning +.. _openedx_content: https://github.com/openedx/openedx-core/tree/main/src/openedx_content +.. _openedx-platform XBlock runtime: https://github.com/openedx/openedx-platform/tree/master/openedx/core/djangoapps/xblock +.. _openedx-core: https://github.com/openedx/openedx-core .. _xblock-drag-and-drop-v2: https://github.com/openedx/xblock-drag-and-drop-v2 .. _the forums: https://discuss.openedx.org - diff --git a/xmodule/annotatable_block.py b/xmodule/annotatable_block.py index 9883f6d7bd4e..2d2347d851a4 100644 --- a/xmodule/annotatable_block.py +++ b/xmodule/annotatable_block.py @@ -1,7 +1,8 @@ -# lint-amnesty, pylint: disable=missing-module-docstring +# pylint: disable=missing-module-docstring import logging import textwrap +import warnings from django.conf import settings from lxml import etree @@ -13,13 +14,8 @@ from openedx.core.djangolib.markup import HTML, Text from xmodule.editing_block import EditingMixin from xmodule.raw_block import RawMixin -from xmodule.util.builtin_assets import add_webpack_js_to_fragment, add_css_to_fragment -from xmodule.x_module import ( - ResourceTemplates, - shim_xmodule_js, - XModuleMixin, - XModuleToXBlockMixin, -) +from xmodule.util.builtin_assets import add_css_to_fragment, add_webpack_js_to_fragment +from xmodule.x_module import ResourceTemplates, XModuleMixin, XModuleToXBlockMixin, shim_xmodule_js from xmodule.xml_block import XmlMixin log = logging.getLogger(__name__) @@ -40,6 +36,10 @@ class _BuiltInAnnotatableBlock( ): """ Annotatable XBlock. + + .. deprecated:: 2026-03 + This built-in annotatable block is deprecated. Please use the extracted ``AnnotatableBlock`` + from ``xblocks_contrib.annotatable`` instead. """ is_extracted = False @@ -82,7 +82,7 @@ class _BuiltInAnnotatableBlock( HIGHLIGHT_COLORS = ['yellow', 'orange', 'purple', 'blue', 'green'] - def _get_annotation_class_attr(self, index, el): # lint-amnesty, pylint: disable=unused-argument + def _get_annotation_class_attr(self, index, el): # pylint: disable=unused-argument """ Returns a dict with the CSS class attribute to set on the annotation and an XML key to delete from the element. """ @@ -100,7 +100,7 @@ def _get_annotation_class_attr(self, index, el): # lint-amnesty, pylint: disabl return {'class': attr} - def _get_annotation_data_attr(self, index, el): # lint-amnesty, pylint: disable=unused-argument + def _get_annotation_data_attr(self, index, el): # pylint: disable=unused-argument """ Returns a dict in which the keys are the HTML data attributes to set on the annotation element. Each data attribute has a corresponding 'value' and (optional) '_delete' key to specify @@ -114,7 +114,7 @@ def _get_annotation_data_attr(self, index, el): # lint-amnesty, pylint: disable 'problem': 'data-problem-id' } - for xml_key in attrs_map.keys(): # lint-amnesty, pylint: disable=consider-iterating-dictionary + for xml_key in attrs_map.keys(): # pylint: disable=consider-iterating-dictionary if xml_key in el.attrib: value = el.get(xml_key, '') html_key = attrs_map[xml_key] @@ -130,7 +130,7 @@ def _render_annotation(self, index, el): el.tag = 'span' - for key in attr.keys(): # lint-amnesty, pylint: disable=consider-iterating-dictionary + for key in attr.keys(): # pylint: disable=consider-iterating-dictionary el.set(key, attr[key]['value']) if '_delete' in attr[key] and attr[key]['_delete'] is not None: delete_key = attr[key]['_delete'] @@ -177,7 +177,7 @@ def get_html(self): return self.runtime.service(self, 'mako').render_lms_template('annotatable.html', context) - def student_view(self, context): # lint-amnesty, pylint: disable=unused-argument + def student_view(self, context): # pylint: disable=unused-argument """ Renders the output that a student will see. """ @@ -216,3 +216,14 @@ def reset_class(): reset_class() AnnotatableBlock.__name__ = "AnnotatableBlock" + +if not settings.USE_EXTRACTED_ANNOTATABLE_BLOCK: + warnings.warn( + "The built-in `xmodule.annotatable_block` AnnotatableBlock implementation is deprecated. " + "To fix this warning, enable `USE_EXTRACTED_ANNOTATABLE_BLOCK` (set it to True) to use " + "`xblocks_contrib.annotatable.AnnotatableBlock` instead. " + "Support for the built-in implementation, and the `USE_EXTRACTED_ANNOTATABLE_BLOCK` setting, " + "will be removed in Willow.", + DeprecationWarning, + stacklevel=2, + ) diff --git a/xmodule/annotator_mixin.py b/xmodule/annotator_mixin.py index b3aaefa31c3b..b0b1b350aa07 100644 --- a/xmodule/annotator_mixin.py +++ b/xmodule/annotator_mixin.py @@ -30,7 +30,7 @@ def get_extension(srcurl): return 'video/' + file_ext.replace('.', '') -class MLStripper(HTMLParser): # lint-amnesty, pylint: disable=abstract-method +class MLStripper(HTMLParser): # pylint: disable=abstract-method "helper function for html_to_text below" def __init__(self): HTMLParser.__init__(self) @@ -50,7 +50,7 @@ def handle_data(self, data): def handle_entityref(self, name): """appends the reference to the body""" - self.fed.append('&%s;' % name) + self.fed.append('&%s;' % name) # noqa: UP031 def get_data(self): """joins together the seperate chunks into one cohesive string""" diff --git a/xmodule/assetstore/__init__.py b/xmodule/assetstore/__init__.py index 82e4a2163e6c..14708d8f02eb 100644 --- a/xmodule/assetstore/__init__.py +++ b/xmodule/assetstore/__init__.py @@ -9,7 +9,7 @@ import dateutil.parser from lxml import etree -from opaque_keys.edx.keys import AssetKey, CourseKey +from opaque_keys.edx.keys import AssetKey, CourseKey # noqa: F401 class AssetMetadata: @@ -177,7 +177,7 @@ def from_xml(self, node): continue elif tag == 'locked': # Boolean. - value = True if value == "true" else False # lint-amnesty, pylint: disable=simplifiable-if-expression + value = True if value == "true" else False # pylint: disable=simplifiable-if-expression elif value == 'None': # None. value = None diff --git a/xmodule/assetstore/tests/test_asset_xml.py b/xmodule/assetstore/tests/test_asset_xml.py index dc6089af34ed..5b08ffed5c70 100644 --- a/xmodule/assetstore/tests/test_asset_xml.py +++ b/xmodule/assetstore/tests/test_asset_xml.py @@ -27,7 +27,7 @@ def setUp(self): self.course_assets = [] for asset in AssetStoreTestData.all_asset_data: - asset_dict = dict(list(zip(AssetStoreTestData.asset_fields[1:], asset[1:]))) + asset_dict = dict(list(zip(AssetStoreTestData.asset_fields[1:], asset[1:]))) # noqa: B905 asset_md = AssetMetadata(self.course_id.make_asset_key('asset', asset[0]), **asset_dict) self.course_assets.append(asset_md) diff --git a/xmodule/block_metadata_utils.py b/xmodule/block_metadata_utils.py index 329c53f8c536..2bb3e50a353a 100644 --- a/xmodule/block_metadata_utils.py +++ b/xmodule/block_metadata_utils.py @@ -8,24 +8,13 @@ from datetime import datetime from logging import getLogger -from markupsafe import Markup from dateutil.tz import tzlocal +from markupsafe import Markup logger = getLogger(__name__) # pylint: disable=invalid-name -def url_name_for_block(block): - """ - Given a block, returns the block's URL name. - - Arguments: - block (XModuleMixin|CourseOverview|BlockStructureBlockData): - Block that is being accessed - """ - return block.location.block_id - - def display_name_with_default(block): """ Calculates the display name for a block. @@ -50,7 +39,7 @@ def display_name_with_default(block): """ return ( block.display_name if block.display_name is not None - else url_name_for_block(block).replace('_', ' ') + else block.usage_key.block_id.replace('_', ' ') ) diff --git a/xmodule/capa/capa_problem.py b/xmodule/capa/capa_problem.py deleted file mode 100644 index ecfca33e4a05..000000000000 --- a/xmodule/capa/capa_problem.py +++ /dev/null @@ -1,1228 +0,0 @@ -# pylint: disable=too-many-lines -# -# File: capa/capa_problem.py -# -# Nomenclature: -# -# A capa Problem is a collection of text and capa Response questions. -# Each Response may have one or more Input entry fields. -# The capa problem may include a solution. -# -""" -Main module which shows problems (of "capa" type). - -This is used by capa_block. -""" - - -import logging -import os.path -import re -from collections import OrderedDict -from copy import deepcopy -from datetime import datetime -from typing import Optional -from xml.sax.saxutils import unescape -from zoneinfo import ZoneInfo - -from django.conf import settings -from lxml import etree - -from openedx.core.djangolib.markup import HTML, Text -from openedx.core.lib.safe_lxml.xmlparser import XML -from xmodule.capa import customrender, inputtypes, responsetypes, xqueue_interface -from xmodule.capa.correctmap import CorrectMap -from xmodule.capa.safe_exec import safe_exec -from xmodule.capa.util import contextualize_text, convert_files_to_filenames, get_course_id_from_capa_block -from xmodule.stringify import stringify_children - -# extra things displayed after "show answers" is pressed -solution_tags = ["solution"] - -# fully accessible capa input types -ACCESSIBLE_CAPA_INPUT_TYPES = [ - "checkboxgroup", - "radiogroup", - "choicegroup", - "optioninput", - "textline", - "formulaequationinput", - "textbox", -] - -# these get captured as student responses -response_properties = ["codeparam", "responseparam", "answer", "openendedparam"] - -# special problem tags which should be turned into innocuous HTML -html_transforms = { - "problem": {"tag": "div"}, - "text": {"tag": "span"}, - "math": {"tag": "span"}, -} - -# These should be removed from HTML output, including all subelements -html_problem_semantics = [ - "additional_answer", - "codeparam", - "responseparam", - "answer", - "script", - "hintgroup", - "openendedparam", - "openendedrubric", -] - -log = logging.getLogger(__name__) - -# ----------------------------------------------------------------------------- -# main class for this module - - -class LoncapaSystem: # pylint: disable=too-few-public-methods,too-many-instance-attributes - """ - An encapsulation of resources needed from the outside. - - These interfaces are collected here so that a caller of LoncapaProblem - can provide these resources however make sense for their environment, and - this code can remain independent. - - Attributes: - i18n: an object implementing the `gettext.Translations` interface so - that we can use `.ugettext` to localize strings. - - See :class:`ModuleStoreRuntime` for documentation of other attributes. - - """ - - def __init__( # pylint: disable=too-many-positional-arguments,too-many-arguments - self, - ajax_url, - anonymous_student_id, - cache, - can_execute_unsafe_code, - get_python_lib_zip, - DEBUG, # pylint: disable=invalid-name - i18n, - render_template, - resources_fs, - seed, # Why do we do this if we have self.seed? - xqueue, - matlab_api_key=None, - ): - self.ajax_url = ajax_url - self.anonymous_student_id = anonymous_student_id - self.cache = cache - self.can_execute_unsafe_code = can_execute_unsafe_code - self.get_python_lib_zip = get_python_lib_zip - self.DEBUG = DEBUG # pylint: disable=invalid-name - self.i18n = i18n - self.render_template = render_template - self.resources_fs = resources_fs - self.seed = seed # Why do we do this if we have self.seed? - self.STATIC_URL = settings.STATIC_URL # pylint: disable=invalid-name - self.xqueue = xqueue - self.matlab_api_key = matlab_api_key - - -class LoncapaProblem: # pylint: disable=too-many-public-methods,too-many-instance-attributes - """ - Main class for capa Problems. - """ - - def __init__( # pylint: disable=too-many-positional-arguments,too-many-arguments - self, - problem_text, - id, # pylint: disable=redefined-builtin - capa_system, - capa_block, - state=None, - seed=None, - minimal_init=False, - extract_tree=True, - ): - """ - Initializes capa Problem. - - Arguments: - - problem_text (string): xml defining the problem. - id (string): identifier for this problem, often a filename (no spaces). - capa_system (LoncapaSystem): LoncapaSystem instance which provides OS, - rendering, user context, and other resources. - capa_block: instance needed to access runtime/logging - state (dict): containing the following keys: - - `seed` (int) random number generator seed - - `student_answers` (dict) maps input id to the stored answer for that input - - 'has_saved_answers' (Boolean) True if the answer has been saved since last submit. - - `correct_map` (CorrectMap) a map of each input to their 'correctness' - - `done` (bool) indicates whether or not this problem is considered done - - `input_state` (dict) maps input_id to a dictionary that holds the state for that input - seed (int): random number generator seed. - minimal_init (bool): whether to skip pre-processing student answers - extract_tree (bool): whether to parse the problem XML and store the HTML - - """ - - # Initialize class variables from state - self.do_reset() - self.problem_id = id - self.capa_system = capa_system - self.capa_block = capa_block - - state = state or {} - - # Set seed according to the following priority: - # 1. Contained in problem's state - # 2. Passed into capa_problem via constructor - self.seed = state.get("seed", seed) - assert self.seed is not None, "Seed must be provided for LoncapaProblem." - - self.student_answers = state.get("student_answers", {}) - self.has_saved_answers = state.get("has_saved_answers", False) - if "correct_map" in state: - self.correct_map.set_dict(state["correct_map"]) - self.correct_map_history = [] - for cmap in state.get("correct_map_history", []): - correct_map = CorrectMap() - correct_map.set_dict(cmap) - self.correct_map_history.append(correct_map) - - self.done = state.get("done", False) - self.input_state = state.get("input_state", {}) - - # Convert startouttext and endouttext to proper - problem_text = re.sub(r"startouttext\s*/", "text", problem_text) - problem_text = re.sub(r"endouttext\s*/", "/text", problem_text) - self.problem_text = problem_text - - # parse problem XML file into an element tree - if isinstance(problem_text, str): - # etree chokes on Unicode XML with an encoding declaration - problem_text = problem_text.encode("utf-8") - self.tree = XML(problem_text) - - try: - self.make_xml_compatible(self.tree) - except Exception: - capa_block = self.capa_block - log.exception( - "CAPAProblemError: %s, id:%s, data: %s", capa_block.display_name, self.problem_id, capa_block.data - ) - raise - - # handle any tags - self._process_includes() - - # construct script processor context (eg for customresponse problems) - if minimal_init: - self.context = {} - else: - self.context = self._extract_context(self.tree) - - # Pre-parse the XML tree: modifies it to add ID's and perform some in-place - # transformations. This also creates the dict (self.responders) of Response - # instances for each question in the problem. The dict has keys = xml subtree of - # Response, values = Response instance - self.problem_data = self._preprocess_problem(self.tree, minimal_init) - - if not minimal_init: - if not self.student_answers: # True when student_answers is an empty dict - self.set_initial_display() - - # dictionary of InputType objects associated with this problem - # input_id string -> InputType object - self.inputs = {} - - # Run response late_transforms last (see MultipleChoiceResponse) - # Sort the responses to be in *_1 *_2 ... order. - responses = list(self.responders.values()) - responses = sorted(responses, key=lambda resp: int(resp.id[resp.id.rindex("_") + 1 :])) - for response in responses: - if hasattr(response, "late_transforms"): - response.late_transforms(self) - - if extract_tree: - self.extracted_tree = self._extract_html(self.tree) - - def make_xml_compatible(self, tree): - """ - Adjust tree xml in-place for compatibility before creating - a problem from it. - The idea here is to provide a central point for XML translation, - for example, supporting an old XML format. At present, there just two translations. - - 1. compatibility translation: - old: ANSWER - convert to - new: OPTIONAL-HINT - - 2. compatibility translation: - optioninput works like this internally: - - With extended hints there is a new - This translation takes in the new format and synthesizes the old option= attribute - so all downstream logic works unchanged with the new