Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: populate encrypted client id and secret 2/4 #2216

Merged
merged 3 commits into from
Aug 29, 2024

Conversation

sameeramin
Copy link
Member

@sameeramin sameeramin commented Aug 27, 2024

  • add migration to populate encrypted client id and secret in CanvasEnterpriseCustomerConfiguration
  • removes references to old client id and secret in CanvasEnterpriseCustomerConfiguration

Merge checklist:

  • Any new requirements are in the right place (do not manually modify the requirements/*.txt files)
    • base.in if needed in production but edx-platform doesn't install it
    • test-master.in if edx-platform pins it, with a matching version
    • make upgrade && make requirements have been run to regenerate requirements
  • make static has been run to update webpack bundling if any static content was updated
  • ./manage.py makemigrations has been run
    • Checkout the Database Migration Confluence page for helpful tips on creating migrations.
    • Note: This must be run if you modified any models.
      • It may or may not make a migration depending on exactly what you modified, but it should still be run.
    • This should be run from either a venv with all the lms/edx-enterprise requirements installed or if you checked out edx-enterprise into the src directory used by lms, you can run this command through an lms shell.
      • It would be ./manage.py lms makemigrations in the shell.
  • Version bumped
  • Changelog record added
  • Translations updated (see docs/internationalization.rst but also this isn't blocking for merge atm)

Post merge:

  • Tag pushed and a new version released
    • Note: Assets will be added automatically. You just need to provide a tag (should match your version number) and title and description.
  • After versioned build finishes in GitHub Actions, verify version has been pushed to PyPI
    • Each step in the release build has a condition flag that checks if the rest of the steps are done and if so will deploy to PyPi.
      (so basically once your build finishes, after maybe a minute you should see the new version in PyPi automatically (on refresh))
  • PR created in edx-platform to upgrade dependencies (including edx-enterprise)
    • Trigger the 'Upgrade one Python dependency' action against master in edx-platform with new version number to generate version bump PR
    • This must be done after the version is visible in PyPi as make upgrade in edx-platform will look for the latest version in PyPi.
    • Note: the edx-enterprise constraint in edx-platform must also be bumped to the latest version in PyPi.

* add migration to populate encrypted client id and secret in CanvasEnterpriseCustomerConfiguration
* removes references to old client id and secret in CanvasEnterpriseCustomerConfiguration
@sameeramin sameeramin force-pushed the sameeramin/ENT-8971 branch 3 times, most recently from 4c7232f to a612c90 Compare August 28, 2024 11:57
Copy link
Member

@sameenfatima78 sameenfatima78 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left one question. Also, have we tried to test locally by creating a canvas config using django admin form to see it's creating a config correctly and encrypting values at rest?

@sameeramin
Copy link
Member Author

sameeramin commented Aug 29, 2024

Left one question. Also, have we tried to test locally by creating a canvas config using django admin form to see it's creating a config correctly and encrypting values at rest?

Yes @sameenfatima78, I have tested locally by creating a Canvas config instance via Django admin form and it's working as expected.

@sameeramin sameeramin merged commit eac8dc5 into master Aug 29, 2024
9 checks passed
@sameeramin sameeramin deleted the sameeramin/ENT-8971 branch August 29, 2024 13:42
Copy link
Contributor

@MueezKhan246 MueezKhan246 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@sameeramin sameeramin changed the title feat: populate encrypted client id and secret feat: populate encrypted client id and secret 2/4 Sep 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants