Yaml plugin troubleshooting

Hi -

I made a SAML SSO yaml plugin that was working great. I upgraded tutor to 3.11.7 and now it doesn’t seem to be taking effect. My plugin is named “saml” and when I do a

tutor plugins enable saml

I get no errors and it says to do a

tutor config save

so I do that and get no errors but when I run a

grep -r saml "$(tutor config printroot)/env/apps/openedx/settings/"

It doesn’t find anything and if I do a

tutor local quickstart

it also doesn’t seem that the plugin is working. If I disable, save, quickstart, enable, save, quickstart it also doesn’t seem to work.

How do I see where things are going wrong?


Hi @pdebruic!

  1. Does your plugin appear in the list when you run tutor plugins list?
  2. Can you share the (eventually obfuscated) content of your plugin?

Hi -

It does appear in the list as enabled.

The plugin content is the same as I posted in this other thread

name: saml
version: 0.1.0
 common-env-features: |

 openedx-lms-common-settings: |
    # saml special settings
    THIRD_PARTY_AUTH_BACKENDS = "third_party_auth.saml.SAMLAuthBackend"

  openedx-auth: |
    "SOCIAL_AUTH_SAML_SP_PRIVATE_KEY" : "secret key"
    "SOCIAL_AUTH_SAML_SP_PUBLIC_CERT" : "public cert"

Since posting this I’ve found that if I remove all whitespace & comments, rename the plugin ( to e.g. saml2), and bump the version number ( to 0.1.1) it loads fine. Not sure why that “fixes” it.

The indentation in your saml plugin is wrong. This might be causing the fact that patches are incorrectly loaded. I encourage you to try to rename your saml2 plugin to “saml” and decrement the version to check whether it still works.

I have the same problem. Could you solve it somehow?
My .yml

name: myplugin
version: 0.1.1
openedx-common-settings: |